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 jira: Add a jira:ticket protocol to Org-mode" org-jira
)
728 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
729 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
730 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
731 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
732 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
733 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
734 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
735 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
736 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
737 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
738 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
739 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
740 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
741 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
742 (const :tag
"C track: Keep up with Org-mode development" org-track
)
743 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
744 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
745 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
746 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
747 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
749 (defvar org-export-registered-backends
) ; From ox.el.
750 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
751 (declare-function org-export-backend-name
"ox" (backend))
752 (defcustom org-export-backends
'(ascii html icalendar latex
)
753 "List of export back-ends that should be always available.
755 If a description starts with <C>, the file is not part of Emacs
756 and loading it will require that you have downloaded and properly
757 installed the Org mode distribution.
759 Unlike to `org-modules', libraries in this list will not be
760 loaded along with Org, but only once the export framework is
763 This variable needs to be set before org.el is loaded. If you
764 need to make a change while Emacs is running, use the customize
765 interface or run the following code, where VAL stands for the new
766 value of the variable, after updating it:
769 \(setq org-export-registered-backends
772 \(let ((name (org-export-backend-name backend)))
776 \(and (org-export-derived-backend-p b name)
777 \(throw 'parentp t)))))))
778 org-export-registered-backends))
779 \(let ((new-list (mapcar #'org-export-backend-name
780 org-export-registered-backends)))
781 \(dolist (backend val)
783 \((not (load (format \"ox-%s\" backend) t t))
784 \(message \"Problems while trying to load export back-end `%s'\"
786 \((not (memq backend new-list)) (push backend new-list))))
787 \(set-default 'org-export-backends new-list)))
789 Adding a back-end to this list will also pull the back-end it
794 :package-version
'(Org .
"8.0")
795 :initialize
'custom-initialize-set
796 :set
(lambda (var val
)
797 (if (not (featurep 'ox
)) (set-default var val
)
798 ;; Any back-end not required anymore (not present in VAL and not
799 ;; a parent of any back-end in the new value) is removed from the
800 ;; list of registered back-ends.
801 (setq org-export-registered-backends
804 (let ((name (org-export-backend-name backend
)))
808 (and (org-export-derived-backend-p b name
)
809 (throw 'parentp t
)))))))
810 org-export-registered-backends
))
811 ;; Now build NEW-LIST of both new back-ends and required
813 (let ((new-list (mapcar #'org-export-backend-name
814 org-export-registered-backends
)))
815 (dolist (backend val
)
817 ((not (load (format "ox-%s" backend
) t t
))
818 (message "Problems while trying to load export back-end `%s'"
820 ((not (memq backend new-list
)) (push backend new-list
))))
821 ;; Set VAR to that list with fixed dependencies.
822 (set-default var new-list
))))
823 :type
'(set :greedy t
824 (const :tag
" ascii Export buffer to ASCII format" ascii
)
825 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
826 (const :tag
" html Export buffer to HTML format" html
)
827 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
828 (const :tag
" latex Export buffer to LaTeX format" latex
)
829 (const :tag
" man Export buffer to MAN format" man
)
830 (const :tag
" md Export buffer to Markdown format" md
)
831 (const :tag
" odt Export buffer to ODT format" odt
)
832 (const :tag
" org Export buffer to Org format" org
)
833 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
834 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
835 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
836 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
837 (const :tag
"C groff Export buffer to Groff format" groff
)
838 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
839 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
840 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
841 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
846 (condition-case nil
(require (intern (format "ox-%s" backend
)))
847 (error (message "Problems while trying to load export back-end `%s'"
849 org-export-backends
))
851 (defcustom org-support-shift-select nil
852 "Non-nil means make shift-cursor commands select text when possible.
854 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
855 start selecting a region, or enlarge regions started in this way.
856 In Org-mode, in special contexts, these same keys are used for
857 other purposes, important enough to compete with shift selection.
858 Org tries to balance these needs by supporting `shift-select-mode'
859 outside these special contexts, under control of this variable.
861 The default of this variable is nil, to avoid confusing behavior. Shifted
862 cursor keys will then execute Org commands in the following contexts:
863 - on a headline, changing TODO state (left/right) and priority (up/down)
864 - on a time stamp, changing the time
865 - in a plain list item, changing the bullet type
866 - in a property definition line, switching between allowed values
867 - in the BEGIN line of a clock table (changing the time block).
868 Outside these contexts, the commands will throw an error.
870 When this variable is t and the cursor is not in a special
871 context, Org-mode will support shift-selection for making and
872 enlarging regions. To make this more effective, the bullet
873 cycling will no longer happen anywhere in an item line, but only
874 if the cursor is exactly on the bullet.
876 If you set this variable to the symbol `always', then the keys
877 will not be special in headlines, property lines, and item lines,
878 to make shift selection work there as well. If this is what you
879 want, you can use the following alternative commands: `C-c C-t'
880 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
881 can be used to switch TODO sets, `C-c -' to cycle item bullet
882 types, and properties can be edited by hand or in column view.
884 However, when the cursor is on a timestamp, shift-cursor commands
885 will still edit the time stamp - this is just too good to give up.
887 XEmacs user should have this variable set to nil, because
888 `shift-select-mode' is in Emacs 23 or later only."
891 (const :tag
"Never" nil
)
892 (const :tag
"When outside special context" t
)
893 (const :tag
"Everywhere except timestamps" always
)))
895 (defcustom org-loop-over-headlines-in-active-region nil
896 "Shall some commands act upon headlines in the active region?
898 When set to `t', some commands will be performed in all headlines
899 within the active region.
901 When set to `start-level', some commands will be performed in all
902 headlines within the active region, provided that these headlines
903 are of the same level than the first one.
905 When set to a string, those commands will be performed on the
906 matching headlines within the active region. Such string must be
907 a tags/property/todo match as it is used in the agenda tags view.
909 The list of commands is: `org-schedule', `org-deadline',
910 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
911 `org-archive-to-archive-sibling'. The archiving commands skip
912 already archived entries."
913 :type
'(choice (const :tag
"Don't loop" nil
)
914 (const :tag
"All headlines in active region" t
)
915 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
916 (string :tag
"Tags/Property/Todo matcher"))
921 (defgroup org-startup nil
922 "Options concerning startup of Org-mode."
926 (defcustom org-startup-folded t
927 "Non-nil means entering Org-mode will switch to OVERVIEW.
928 This can also be configured on a per-file basis by adding one of
929 the following lines anywhere in the buffer:
931 #+STARTUP: fold (or `overview', this is equivalent)
932 #+STARTUP: nofold (or `showall', this is equivalent)
934 #+STARTUP: showeverything
936 By default, this option is ignored when Org opens agenda files
937 for the first time. If you want the agenda to honor the startup
938 option, set `org-agenda-inhibit-startup' to nil."
941 (const :tag
"nofold: show all" nil
)
942 (const :tag
"fold: overview" t
)
943 (const :tag
"content: all headlines" content
)
944 (const :tag
"show everything, even drawers" showeverything
)))
946 (defcustom org-startup-truncated t
947 "Non-nil means entering Org-mode will set `truncate-lines'.
948 This is useful since some lines containing links can be very long and
949 uninteresting. Also tables look terrible when wrapped."
953 (defcustom org-startup-indented nil
954 "Non-nil means turn on `org-indent-mode' on startup.
955 This can also be configured on a per-file basis by adding one of
956 the following lines anywhere in the buffer:
960 :group
'org-structure
962 (const :tag
"Not" nil
)
963 (const :tag
"Globally (slow on startup in large files)" t
)))
965 (defcustom org-use-sub-superscripts t
966 "Non-nil means interpret \"_\" and \"^\" for display.
968 If you want to control how Org exports those characters, see
969 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
970 used to be an alias for `org-export-with-sub-superscripts' in
971 Org <8.0, it is not anymore.
973 When this option is turned on, you can use TeX-like syntax for
974 sub- and superscripts within the buffer. Several characters after
975 \"_\" or \"^\" will be considered as a single item - so grouping
976 with {} is normally not needed. For example, the following things
977 will be parsed as single sub- or superscripts:
979 10^24 or 10^tau several digits will be considered 1 item.
980 10^-12 or 10^-tau a leading sign with digits or a word
981 x^2-y^3 will be read as x^2 - y^3, because items are
982 terminated by almost any nonword/nondigit char.
983 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
985 Still, ambiguity is possible. So when in doubt, use {} to enclose
986 the sub/superscript. If you set this variable to the symbol `{}',
987 the braces are *required* in order to trigger interpretations as
988 sub/superscript. This can be helpful in documents that need \"_\"
989 frequently in plain text."
992 :package-version
'(Org .
"8.0")
994 (const :tag
"Always interpret" t
)
995 (const :tag
"Only with braces" {})
996 (const :tag
"Never interpret" nil
)))
998 (defcustom org-startup-with-beamer-mode nil
999 "Non-nil means turn on `org-beamer-mode' on startup.
1000 This can also be configured on a per-file basis by adding one of
1001 the following lines anywhere in the buffer:
1008 (defcustom org-startup-align-all-tables nil
1009 "Non-nil means align all tables when visiting a file.
1010 This is useful when the column width in tables is forced with <N> cookies
1011 in table fields. Such tables will look correct only after the first re-align.
1012 This can also be configured on a per-file basis by adding one of
1013 the following lines anywhere in the buffer:
1019 (defcustom org-startup-with-inline-images nil
1020 "Non-nil means show inline images when loading a new Org file.
1021 This can also be configured on a per-file basis by adding one of
1022 the following lines anywhere in the buffer:
1023 #+STARTUP: inlineimages
1024 #+STARTUP: noinlineimages"
1029 (defcustom org-startup-with-latex-preview nil
1030 "Non-nil means preview LaTeX fragments when loading a new Org file.
1032 This can also be configured on a per-file basis by adding one of
1033 the following lines anywhere in the buffer:
1034 #+STARTUP: latexpreview
1035 #+STARTUP: nolatexpreview"
1038 :package-version
'(Org .
"8.0")
1041 (defcustom org-insert-mode-line-in-empty-file nil
1042 "Non-nil means insert the first line setting Org-mode in empty files.
1043 When the function `org-mode' is called interactively in an empty file, this
1044 normally means that the file name does not automatically trigger Org-mode.
1045 To ensure that the file will always be in Org-mode in the future, a
1046 line enforcing Org-mode will be inserted into the buffer, if this option
1051 (defcustom org-replace-disputed-keys nil
1052 "Non-nil means use alternative key bindings for some keys.
1053 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1054 These keys are also used by other packages like shift-selection-mode'
1055 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1056 If you want to use Org-mode together with one of these other modes,
1057 or more generally if you would like to move some Org-mode commands to
1058 other keys, set this variable and configure the keys with the variable
1059 `org-disputed-keys'.
1061 This option is only relevant at load-time of Org-mode, and must be set
1062 *before* org.el is loaded. Changing it requires a restart of Emacs to
1067 (defcustom org-use-extra-keys nil
1068 "Non-nil means use extra key sequence definitions for certain commands.
1069 This happens automatically if you run XEmacs or if `window-system'
1070 is nil. This variable lets you do the same manually. You must
1071 set it before loading org.
1073 Example: on Carbon Emacs 22 running graphically, with an external
1074 keyboard on a Powerbook, the default way of setting M-left might
1075 not work for either Alt or ESC. Setting this variable will make
1080 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1082 (defcustom org-disputed-keys
1083 '(([(shift up
)] .
[(meta p
)])
1084 ([(shift down
)] .
[(meta n
)])
1085 ([(shift left
)] .
[(meta -
)])
1086 ([(shift right
)] .
[(meta +)])
1087 ([(control shift right
)] .
[(meta shift
+)])
1088 ([(control shift left
)] .
[(meta shift -
)]))
1089 "Keys for which Org-mode and other modes compete.
1090 This is an alist, cars are the default keys, second element specifies
1091 the alternative to use when `org-replace-disputed-keys' is t.
1093 Keys can be specified in any syntax supported by `define-key'.
1094 The value of this option takes effect only at Org-mode's startup,
1095 therefore you'll have to restart Emacs to apply it after changing."
1099 (defun org-key (key)
1100 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1101 Or return the original if not disputed.
1102 Also apply the translations defined in `org-xemacs-key-equivalents'."
1103 (when org-replace-disputed-keys
1104 (let* ((nkey (key-description key
))
1105 (x (org-find-if (lambda (x)
1106 (equal (key-description (car x
)) nkey
))
1107 org-disputed-keys
)))
1108 (setq key
(if x
(cdr x
) key
))))
1109 (when (featurep 'xemacs
)
1110 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1113 (defun org-find-if (predicate seq
)
1116 (if (funcall predicate
(car seq
))
1117 (throw 'exit
(car seq
))
1120 (defun org-defkey (keymap key def
)
1121 "Define a key, possibly translated, as returned by `org-key'."
1122 (define-key keymap
(org-key key
) def
))
1124 (defcustom org-ellipsis nil
1125 "The ellipsis to use in the Org-mode outline.
1126 When nil, just use the standard three dots.
1127 When a string, use that string instead.
1128 When a face, use the standard 3 dots, but with the specified face.
1129 The change affects only Org-mode (which will then use its own display table).
1130 Changing this requires executing \\[org-mode] in a buffer to become
1133 :type
'(choice (const :tag
"Default" nil
)
1134 (face :tag
"Face" :value org-warning
)
1135 (string :tag
"String" :value
"...#")))
1137 (defvar org-display-table nil
1138 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1140 (defgroup org-keywords nil
1141 "Keywords in Org-mode."
1145 (defcustom org-closed-keep-when-no-todo nil
1146 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1148 :group
'org-keywords
1150 :package-version
'(Org .
"8.0")
1153 (defgroup org-structure nil
1154 "Options concerning the general structure of Org-mode files."
1155 :tag
"Org Structure"
1158 (defgroup org-reveal-location nil
1159 "Options about how to make context of a location visible."
1160 :tag
"Org Reveal Location"
1161 :group
'org-structure
)
1163 (defcustom org-show-context-detail
'((isearch . lineage
)
1164 (bookmark-jump . lineage
)
1165 (default . ancestors
))
1166 "Alist between context and visibility span when revealing a location.
1168 \\<org-mode-map>Some actions may move point into invisible
1169 locations. As a consequence, Org always expose a neighborhood
1170 around point. How much is shown depends on the initial action,
1171 or context. Valid contexts are
1173 agenda when exposing an entry from the agenda
1174 org-goto when using the command `org-goto' (\\[org-goto])
1175 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1176 tags-tree when constructing a sparse tree based on tags matches
1177 link-search when exposing search matches associated with a link
1178 mark-goto when exposing the jump goal of a mark
1179 bookmark-jump when exposing a bookmark location
1180 isearch when exiting from an incremental search
1181 default default for all contexts not set explicitly
1183 Allowed visibility spans are
1185 minimal show current headline; if point is not on headline,
1188 local show current headline, entry and next headline
1190 ancestors show current headline and its direct ancestors; if
1191 point is not on headline, also show entry
1193 lineage show current headline, its direct ancestors and all
1194 their children; if point is not on headline, also show
1195 entry and first child
1197 tree show current headline, its direct ancestors and all
1198 their children; if point is not on headline, also show
1199 entry and all children
1201 canonical show current headline, its direct ancestors along with
1202 their entries and children; if point is not located on
1203 the headline, also show current entry and all children
1205 As special cases, a nil or t value means show all contexts in
1206 `minimal' or `canonical' view, respectively.
1208 Some views can make displayed information very compact, but also
1209 make it harder to edit the location of the match. In such
1210 a case, use the command `org-reveal' (\\[org-reveal]) to show
1212 :group
'org-reveal-location
1214 :package-version
'(Org .
"8.3")
1216 (const :tag
"Canonical" t
)
1217 (const :tag
"Minimal" nil
)
1218 (repeat :greedy t
:tag
"Individual contexts"
1220 (choice :tag
"Context"
1227 (const bookmark-jump
)
1230 (choice :tag
"Detail level"
1236 (const canonical
))))))
1238 (defcustom org-indirect-buffer-display
'other-window
1239 "How should indirect tree buffers be displayed?
1240 This applies to indirect buffers created with the commands
1241 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1243 current-window Display in the current window
1244 other-window Just display in another window.
1245 dedicated-frame Create one new frame, and re-use it each time.
1246 new-frame Make a new frame each time. Note that in this case
1247 previously-made indirect buffers are kept, and you need to
1248 kill these buffers yourself."
1249 :group
'org-structure
1250 :group
'org-agenda-windows
1252 (const :tag
"In current window" current-window
)
1253 (const :tag
"In current frame, other window" other-window
)
1254 (const :tag
"Each time a new frame" new-frame
)
1255 (const :tag
"One dedicated frame" dedicated-frame
)))
1257 (defcustom org-use-speed-commands nil
1258 "Non-nil means activate single letter commands at beginning of a headline.
1259 This may also be a function to test for appropriate locations where speed
1260 commands should be active.
1262 For example, to activate speed commands when the point is on any
1263 star at the beginning of the headline, you can do this:
1265 (setq org-use-speed-commands
1266 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1267 :group
'org-structure
1269 (const :tag
"Never" nil
)
1270 (const :tag
"At beginning of headline stars" t
)
1273 (defcustom org-speed-commands-user nil
1274 "Alist of additional speed commands.
1275 This list will be checked before `org-speed-commands-default'
1276 when the variable `org-use-speed-commands' is non-nil
1277 and when the cursor is at the beginning of a headline.
1278 The car if each entry is a string with a single letter, which must
1279 be assigned to `self-insert-command' in the global map.
1280 The cdr is either a command to be called interactively, a function
1281 to be called, or a form to be evaluated.
1282 An entry that is just a list with a single string will be interpreted
1283 as a descriptive headline that will be added when listing the speed
1284 commands in the Help buffer using the `?' speed command."
1285 :group
'org-structure
1286 :type
'(repeat :value
("k" . ignore
)
1287 (choice :value
("k" . ignore
)
1288 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1289 (cons :tag
"Letter and Command"
1290 (string :tag
"Command letter")
1295 (defcustom org-bookmark-names-plist
1296 '(:last-capture
"org-capture-last-stored"
1297 :last-refile
"org-refile-last-stored"
1298 :last-capture-marker
"org-capture-last-stored-marker")
1299 "Names for bookmarks automatically set by some Org commands.
1300 This can provide strings as names for a number of bookmarks Org sets
1301 automatically. The following keys are currently implemented:
1303 :last-capture-marker
1305 When a key does not show up in the property list, the corresponding bookmark
1307 :group
'org-structure
1310 (defgroup org-cycle nil
1311 "Options concerning visibility cycling in Org-mode."
1313 :group
'org-structure
)
1315 (defcustom org-cycle-skip-children-state-if-no-children t
1316 "Non-nil means skip CHILDREN state in entries that don't have any."
1320 (defcustom org-cycle-max-level nil
1321 "Maximum level which should still be subject to visibility cycling.
1322 Levels higher than this will, for cycling, be treated as text, not a headline.
1323 When `org-odd-levels-only' is set, a value of N in this variable actually
1324 means 2N-1 stars as the limiting headline.
1325 When nil, cycle all levels.
1326 Note that the limiting level of cycling is also influenced by
1327 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1328 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1332 (const :tag
"No limit" nil
)
1333 (integer :tag
"Maximum level")))
1335 (defcustom org-hide-block-startup nil
1336 "Non-nil means entering Org-mode will fold all blocks.
1337 This can also be set in on a per-file basis with
1339 #+STARTUP: hideblocks
1340 #+STARTUP: showblocks"
1345 (defcustom org-cycle-global-at-bob nil
1346 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1347 This makes it possible to do global cycling without having to use S-TAB or
1348 \\[universal-argument] TAB. For this special case to work, the first line
1349 of the buffer must not be a headline -- it may be empty or some other text.
1350 When used in this way, `org-cycle-hook' is disabled temporarily to make
1351 sure the cursor stays at the beginning of the buffer. When this option is
1352 nil, don't do anything special at the beginning of the buffer."
1356 (defcustom org-cycle-level-after-item
/entry-creation t
1357 "Non-nil means cycle entry level or item indentation in new empty entries.
1359 When the cursor is at the end of an empty headline, i.e., with only stars
1360 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1361 and then all possible ancestor states, before returning to the original state.
1362 This makes data entry extremely fast: M-RET to create a new headline,
1363 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1365 When the cursor is at the end of an empty plain list item, one TAB will
1366 make it a subitem, two or more tabs will back up to make this an item
1367 higher up in the item hierarchy."
1371 (defcustom org-cycle-emulate-tab t
1372 "Where should `org-cycle' emulate TAB.
1374 white Only in completely white lines
1375 whitestart Only at the beginning of lines, before the first non-white char
1376 t Everywhere except in headlines
1377 exc-hl-bol Everywhere except at the start of a headline
1378 If TAB is used in a place where it does not emulate TAB, the current subtree
1379 visibility is cycled."
1381 :type
'(choice (const :tag
"Never" nil
)
1382 (const :tag
"Only in completely white lines" white
)
1383 (const :tag
"Before first char in a line" whitestart
)
1384 (const :tag
"Everywhere except in headlines" t
)
1385 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1387 (defcustom org-cycle-separator-lines
2
1388 "Number of empty lines needed to keep an empty line between collapsed trees.
1389 If you leave an empty line between the end of a subtree and the following
1390 headline, this empty line is hidden when the subtree is folded.
1391 Org-mode will leave (exactly) one empty line visible if the number of
1392 empty lines is equal or larger to the number given in this variable.
1393 So the default 2 means at least 2 empty lines after the end of a subtree
1394 are needed to produce free space between a collapsed subtree and the
1397 If the number is negative, and the number of empty lines is at least -N,
1398 all empty lines are shown.
1400 Special case: when 0, never leave empty lines in collapsed view."
1403 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1405 (defcustom org-pre-cycle-hook nil
1406 "Hook that is run before visibility cycling is happening.
1407 The function(s) in this hook must accept a single argument which indicates
1408 the new state that will be set right after running this hook. The
1409 argument is a symbol. Before a global state change, it can have the values
1410 `overview', `content', or `all'. Before a local state change, it can have
1411 the values `folded', `children', or `subtree'."
1415 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1416 org-cycle-hide-drawers
1417 org-cycle-show-empty-lines
1418 org-optimize-window-after-visibility-change
)
1419 "Hook that is run after `org-cycle' has changed the buffer visibility.
1420 The function(s) in this hook must accept a single argument which indicates
1421 the new state that was set by the most recent `org-cycle' command. The
1422 argument is a symbol. After a global state change, it can have the values
1423 `overview', `contents', or `all'. After a local state change, it can have
1424 the values `folded', `children', or `subtree'."
1428 :package-version
'(Org .
"8.3"))
1430 (defgroup org-edit-structure nil
1431 "Options concerning structure editing in Org-mode."
1432 :tag
"Org Edit Structure"
1433 :group
'org-structure
)
1435 (defcustom org-odd-levels-only nil
1436 "Non-nil means skip even levels and only use odd levels for the outline.
1437 This has the effect that two stars are being added/taken away in
1438 promotion/demotion commands. It also influences how levels are
1439 handled by the exporters.
1440 Changing it requires restart of `font-lock-mode' to become effective
1441 for fontification also in regions already fontified.
1442 You may also set this on a per-file basis by adding one of the following
1443 lines to the buffer:
1447 :group
'org-edit-structure
1448 :group
'org-appearance
1451 (defcustom org-adapt-indentation t
1452 "Non-nil means adapt indentation to outline node level.
1454 When this variable is set, Org assumes that you write outlines by
1455 indenting text in each node to align with the headline (after the
1456 stars). The following issues are influenced by this variable:
1458 - The indentation is increased by one space in a demotion
1459 command, and decreased by one in a promotion command. However,
1460 in the latter case, if shifting some line in the entry body
1461 would alter document structure (e.g., insert a new headline),
1462 indentation is not changed at all.
1464 - Property drawers and planning information is inserted indented
1465 when this variable is set. When nil, they will not be indented.
1467 - TAB indents a line relative to current level. The lines below
1468 a headline will be indented when this variable is set.
1470 Note that this is all about true indentation, by adding and
1471 removing space characters. See also `org-indent.el' which does
1472 level-dependent indentation in a virtual way, i.e. at display
1474 :group
'org-edit-structure
1477 (defcustom org-special-ctrl-a
/e nil
1478 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1480 When t, `C-a' will bring back the cursor to the beginning of the
1481 headline text, i.e. after the stars and after a possible TODO
1482 keyword. In an item, this will be the position after bullet and
1483 check-box, if any. When the cursor is already at that position,
1484 another `C-a' will bring it to the beginning of the line.
1486 `C-e' will jump to the end of the headline, ignoring the presence
1487 of tags in the headline. A second `C-e' will then jump to the
1488 true end of the line, after any tags. This also means that, when
1489 this variable is non-nil, `C-e' also will never jump beyond the
1490 end of the heading of a folded section, i.e. not after the
1493 When set to the symbol `reversed', the first `C-a' or `C-e' works
1494 normally, going to the true line boundary first. Only a directly
1495 following, identical keypress will bring the cursor to the
1498 This may also be a cons cell where the behavior for `C-a' and
1499 `C-e' is set separately."
1500 :group
'org-edit-structure
1502 (const :tag
"off" nil
)
1503 (const :tag
"on: after stars/bullet and before tags first" t
)
1504 (const :tag
"reversed: true line boundary first" reversed
)
1505 (cons :tag
"Set C-a and C-e separately"
1506 (choice :tag
"Special C-a"
1507 (const :tag
"off" nil
)
1508 (const :tag
"on: after stars/bullet first" t
)
1509 (const :tag
"reversed: before stars/bullet first" reversed
))
1510 (choice :tag
"Special C-e"
1511 (const :tag
"off" nil
)
1512 (const :tag
"on: before tags first" t
)
1513 (const :tag
"reversed: after tags first" reversed
)))))
1514 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1516 (defcustom org-special-ctrl-k nil
1517 "Non-nil means `C-k' will behave specially in headlines.
1518 When nil, `C-k' will call the default `kill-line' command.
1519 When t, the following will happen while the cursor is in the headline:
1521 - When the cursor is at the beginning of a headline, kill the entire
1522 line and possible the folded subtree below the line.
1523 - When in the middle of the headline text, kill the headline up to the tags.
1524 - When after the headline text, kill the tags."
1525 :group
'org-edit-structure
1528 (defcustom org-ctrl-k-protect-subtree nil
1529 "Non-nil means, do not delete a hidden subtree with C-k.
1530 When set to the symbol `error', simply throw an error when C-k is
1531 used to kill (part-of) a headline that has hidden text behind it.
1532 Any other non-nil value will result in a query to the user, if it is
1533 OK to kill that hidden subtree. When nil, kill without remorse."
1534 :group
'org-edit-structure
1537 (const :tag
"Do not protect hidden subtrees" nil
)
1538 (const :tag
"Protect hidden subtrees with a security query" t
)
1539 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1541 (defcustom org-special-ctrl-o t
1542 "Non-nil means, make `C-o' insert a row in tables."
1543 :group
'org-edit-structure
1546 (defcustom org-catch-invisible-edits nil
1547 "Check if in invisible region before inserting or deleting a character.
1550 nil Do not check, so just do invisible edits.
1551 error Throw an error and do nothing.
1552 show Make point visible, and do the requested edit.
1553 show-and-error Make point visible, then throw an error and abort the edit.
1554 smart Make point visible, and do insertion/deletion if it is
1555 adjacent to visible text and the change feels predictable.
1556 Never delete a previously invisible character or add in the
1557 middle or right after an invisible region. Basically, this
1558 allows insertion and backward-delete right before ellipses.
1559 FIXME: maybe in this case we should not even show?"
1560 :group
'org-edit-structure
1563 (const :tag
"Do not check" nil
)
1564 (const :tag
"Throw error when trying to edit" error
)
1565 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1566 (const :tag
"Show invisible part and do the edit" show
)
1567 (const :tag
"Be smart and do the right thing" smart
)))
1569 (defcustom org-yank-folded-subtrees t
1570 "Non-nil means when yanking subtrees, fold them.
1571 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1572 it starts with a heading and all other headings in it are either children
1573 or siblings, then fold all the subtrees. However, do this only if no
1574 text after the yank would be swallowed into a folded tree by this action."
1575 :group
'org-edit-structure
1578 (defcustom org-yank-adjusted-subtrees nil
1579 "Non-nil means when yanking subtrees, adjust the level.
1580 With this setting, `org-paste-subtree' is used to insert the subtree, see
1581 this function for details."
1582 :group
'org-edit-structure
1585 (defcustom org-M-RET-may-split-line
'((default . t
))
1586 "Non-nil means M-RET will split the line at the cursor position.
1587 When nil, it will go to the end of the line before making a
1589 You may also set this option in a different way for different
1590 contexts. Valid contexts are:
1592 headline when creating a new headline
1593 item when creating a new item
1594 table in a table field
1595 default the value to be used for all contexts not explicitly
1597 :group
'org-structure
1600 (const :tag
"Always" t
)
1601 (const :tag
"Never" nil
)
1602 (repeat :greedy t
:tag
"Individual contexts"
1604 (choice :tag
"Context"
1612 (defcustom org-insert-heading-respect-content nil
1613 "Non-nil means insert new headings after the current subtree.
1614 When nil, the new heading is created directly after the current line.
1615 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1616 this variable on for the duration of the command."
1617 :group
'org-structure
1620 (defcustom org-blank-before-new-entry
'((heading . auto
)
1621 (plain-list-item . auto
))
1622 "Should `org-insert-heading' leave a blank line before new heading/item?
1623 The value is an alist, with `heading' and `plain-list-item' as CAR,
1624 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1625 which case Org will look at the surrounding headings/items and try to
1626 make an intelligent decision whether to insert a blank line or not.
1628 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1629 the setting here is ignored and no empty line is inserted to avoid breaking
1630 the list structure."
1631 :group
'org-edit-structure
1633 (cons (const heading
)
1634 (choice (const :tag
"Never" nil
)
1635 (const :tag
"Always" t
)
1636 (const :tag
"Auto" auto
)))
1637 (cons (const plain-list-item
)
1638 (choice (const :tag
"Never" nil
)
1639 (const :tag
"Always" t
)
1640 (const :tag
"Auto" auto
)))))
1642 (defcustom org-insert-heading-hook nil
1643 "Hook being run after inserting a new heading."
1644 :group
'org-edit-structure
1647 (defcustom org-enable-fixed-width-editor t
1648 "Non-nil means lines starting with \":\" are treated as fixed-width.
1649 This currently only means they are never auto-wrapped.
1650 When nil, such lines will be treated like ordinary lines."
1651 :group
'org-edit-structure
1654 (defcustom org-goto-auto-isearch t
1655 "Non-nil means typing characters in `org-goto' starts incremental search.
1656 When nil, you can use these keybindings to navigate the buffer:
1658 q Quit the org-goto interface
1659 n Go to the next visible heading
1660 p Go to the previous visible heading
1661 f Go one heading forward on same level
1662 b Go one heading backward on same level
1663 u Go one heading up"
1664 :group
'org-edit-structure
1667 (defgroup org-sparse-trees nil
1668 "Options concerning sparse trees in Org-mode."
1669 :tag
"Org Sparse Trees"
1670 :group
'org-structure
)
1672 (defcustom org-highlight-sparse-tree-matches t
1673 "Non-nil means highlight all matches that define a sparse tree.
1674 The highlights will automatically disappear the next time the buffer is
1675 changed by an edit command."
1676 :group
'org-sparse-trees
1679 (defcustom org-remove-highlights-with-change t
1680 "Non-nil means any change to the buffer will remove temporary highlights.
1681 Such highlights are created by `org-occur' and `org-clock-display'.
1682 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1683 The highlights created by `org-toggle-latex-fragment' always need
1684 `C-c C-x C-l' to be removed."
1685 :group
'org-sparse-trees
1690 (defcustom org-occur-hook
'(org-first-headline-recenter)
1691 "Hook that is run after `org-occur' has constructed a sparse tree.
1692 This can be used to recenter the window to show as much of the structure
1694 :group
'org-sparse-trees
1697 (defgroup org-imenu-and-speedbar nil
1698 "Options concerning imenu and speedbar in Org-mode."
1699 :tag
"Org Imenu and Speedbar"
1700 :group
'org-structure
)
1702 (defcustom org-imenu-depth
2
1703 "The maximum level for Imenu access to Org-mode headlines.
1704 This also applied for speedbar access."
1705 :group
'org-imenu-and-speedbar
1708 (defgroup org-table nil
1709 "Options concerning tables in Org-mode."
1713 (defcustom org-enable-table-editor
'optimized
1714 "Non-nil means lines starting with \"|\" are handled by the table editor.
1715 When nil, such lines will be treated like ordinary lines.
1717 When equal to the symbol `optimized', the table editor will be optimized to
1719 - Automatic overwrite mode in front of whitespace in table fields.
1720 This makes the structure of the table stay in tact as long as the edited
1721 field does not exceed the column width.
1722 - Minimize the number of realigns. Normally, the table is aligned each time
1723 TAB or RET are pressed to move to another field. With optimization this
1724 happens only if changes to a field might have changed the column width.
1725 Optimization requires replacing the functions `self-insert-command',
1726 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1727 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1728 very good at guessing when a re-align will be necessary, but you can always
1729 force one with \\[org-ctrl-c-ctrl-c].
1731 If you would like to use the optimized version in Org-mode, but the
1732 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1734 This variable can be used to turn on and off the table editor during a session,
1735 but in order to toggle optimization, a restart is required.
1737 See also the variable `org-table-auto-blank-field'."
1740 (const :tag
"off" nil
)
1742 (const :tag
"on, optimized" optimized
)))
1744 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1745 (version<= emacs-version
"24.1"))
1746 "Non-nil means cluster self-insert commands for undo when possible.
1747 If this is set, then, like in the Emacs command loop, 20 consecutive
1748 characters will be undone together.
1749 This is configurable, because there is some impact on typing performance."
1753 (defcustom org-table-tab-recognizes-table.el t
1754 "Non-nil means TAB will automatically notice a table.el table.
1755 When it sees such a table, it moves point into it and - if necessary -
1756 calls `table-recognize-table'."
1757 :group
'org-table-editing
1760 (defgroup org-link nil
1761 "Options concerning links in Org-mode."
1765 (defvar org-link-abbrev-alist-local nil
1766 "Buffer-local version of `org-link-abbrev-alist', which see.
1767 The value of this is taken from the #+LINK lines.")
1768 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1770 (defcustom org-link-abbrev-alist nil
1771 "Alist of link abbreviations.
1772 The car of each element is a string, to be replaced at the start of a link.
1773 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1774 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1776 [[linkkey:tag][description]]
1778 The 'linkkey' must be a word word, starting with a letter, followed
1779 by letters, numbers, '-' or '_'.
1781 If REPLACE is a string, the tag will simply be appended to create the link.
1782 If the string contains \"%s\", the tag will be inserted there. If the string
1783 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1784 at that point (see the function `url-hexify-string'). If the string contains
1785 the specifier \"%(my-function)\", then the custom function `my-function' will
1786 be invoked: this function takes the tag as its only argument and must return
1789 REPLACE may also be a function that will be called with the tag as the
1790 only argument to create the link, which should be returned as a string.
1792 See the manual for examples."
1796 (string :tag
"Protocol")
1798 (string :tag
"Format")
1801 (defcustom org-descriptive-links t
1802 "Non-nil means Org will display descriptive links.
1803 E.g. [[http://orgmode.org][Org website]] will be displayed as
1804 \"Org Website\", hiding the link itself and just displaying its
1805 description. When set to `nil', Org will display the full links
1808 You can interactively set the value of this variable by calling
1809 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1813 (defcustom org-link-file-path-type
'adaptive
1814 "How the path name in file links should be stored.
1817 relative Relative to the current directory, i.e. the directory of the file
1818 into which the link is being inserted.
1819 absolute Absolute path, if possible with ~ for home directory.
1820 noabbrev Absolute path, no abbreviation of home directory.
1821 adaptive Use relative path for files in the current directory and sub-
1822 directories of it. For other files, use an absolute path."
1830 (defvaralias 'org-activate-links
'org-highlight-links
)
1831 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1832 "Types of links that should be highlighted in Org-mode files.
1834 This is a list of symbols, each one of them leading to the
1835 highlighting of a certain link type.
1837 You can still open links that are not highlighted.
1839 In principle, it does not hurt to turn on highlighting for all
1840 link types. There may be a small gain when turning off unused
1841 link types. The types are:
1843 bracket The recommended [[link][description]] or [[link]] links with hiding.
1844 angle Links in angular brackets that may contain whitespace like
1845 <bbdb:Carsten Dominik>.
1846 plain Plain links in normal text, no whitespace, like http://google.com.
1847 radio Text that is matched by a radio target, see manual for details.
1848 tag Tag settings in a headline (link to tag search).
1849 date Time stamps (link to calendar).
1850 footnote Footnote labels.
1852 If you set this variable during an Emacs session, use `org-mode-restart'
1853 in the Org buffer so that the change takes effect."
1855 :group
'org-appearance
1856 :type
'(set :greedy t
1857 (const :tag
"Double bracket links" bracket
)
1858 (const :tag
"Angular bracket links" angle
)
1859 (const :tag
"Plain text links" plain
)
1860 (const :tag
"Radio target matches" radio
)
1861 (const :tag
"Tags" tag
)
1862 (const :tag
"Timestamps" date
)
1863 (const :tag
"Footnotes" footnote
)))
1865 (defcustom org-make-link-description-function nil
1866 "Function to use for generating link descriptions from links.
1867 When nil, the link location will be used. This function must take
1868 two parameters: the first one is the link, the second one is the
1869 description generated by `org-insert-link'. The function should
1870 return the description to use."
1872 :type
'(choice (const nil
) (function)))
1874 (defgroup org-link-store nil
1875 "Options concerning storing links in Org-mode."
1876 :tag
"Org Store Link"
1879 (defcustom org-url-hexify-p t
1880 "When non-nil, hexify URL when creating a link."
1883 :group
'org-link-store
)
1885 (defcustom org-email-link-description-format
"Email %c: %.30s"
1886 "Format of the description part of a link to an email or usenet message.
1887 The following %-escapes will be replaced by corresponding information:
1889 %F full \"From\" field
1890 %f name, taken from \"From\" field, address if no name
1891 %T full \"To\" field
1892 %t first name in \"To\" field, address if no name
1893 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1894 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1899 You may use normal field width specification between the % and the letter.
1900 This is for example useful to limit the length of the subject.
1902 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1903 :group
'org-link-store
1906 (defcustom org-from-is-user-regexp
1908 (when (and user-mail-address
(not (string= user-mail-address
"")))
1909 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1910 (when (and user-full-name
(not (string= user-full-name
"")))
1911 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1912 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1913 "Regexp matched against the \"From:\" header of an email or usenet message.
1914 It should match if the message is from the user him/herself."
1915 :group
'org-link-store
1918 (defcustom org-context-in-file-links t
1919 "Non-nil means file links from `org-store-link' contain context.
1920 A search string will be added to the file name with :: as separator and
1921 used to find the context when the link is activated by the command
1922 `org-open-at-point'. When this option is t, the entire active region
1923 will be placed in the search string of the file link. If set to a
1924 positive integer, only the first n lines of context will be stored.
1926 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1927 negates this setting for the duration of the command."
1928 :group
'org-link-store
1929 :type
'(choice boolean integer
))
1931 (defcustom org-keep-stored-link-after-insertion nil
1932 "Non-nil means keep link in list for entire session.
1934 The command `org-store-link' adds a link pointing to the current
1935 location to an internal list. These links accumulate during a session.
1936 The command `org-insert-link' can be used to insert links into any
1937 Org-mode file (offering completion for all stored links). When this
1938 option is nil, every link which has been inserted once using \\[org-insert-link]
1939 will be removed from the list, to make completing the unused links
1941 :group
'org-link-store
1944 (defgroup org-link-follow nil
1945 "Options concerning following links in Org-mode."
1946 :tag
"Org Follow Link"
1949 (defcustom org-link-translation-function nil
1950 "Function to translate links with different syntax to Org syntax.
1951 This can be used to translate links created for example by the Planner
1952 or emacs-wiki packages to Org syntax.
1953 The function must accept two parameters, a TYPE containing the link
1954 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1955 which is everything after the link protocol. It should return a cons
1956 with possibly modified values of type and path.
1957 Org contains a function for this, so if you set this variable to
1958 `org-translate-link-from-planner', you should be able follow many
1959 links created by planner."
1960 :group
'org-link-follow
1961 :type
'(choice (const nil
) (function)))
1963 (defcustom org-follow-link-hook nil
1964 "Hook that is run after a link has been followed."
1965 :group
'org-link-follow
1968 (defcustom org-tab-follows-link nil
1969 "Non-nil means on links TAB will follow the link.
1970 Needs to be set before org.el is loaded.
1971 This really should not be used, it does not make sense, and the
1972 implementation is bad."
1973 :group
'org-link-follow
1976 (defcustom org-return-follows-link nil
1977 "Non-nil means on links RET will follow the link.
1978 In tables, the special behavior of RET has precedence."
1979 :group
'org-link-follow
1982 (defcustom org-mouse-1-follows-link
1983 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1984 "Non-nil means mouse-1 on a link will follow the link.
1985 A longer mouse click will still set point. Does not work on XEmacs.
1986 Needs to be set before org.el is loaded."
1987 :group
'org-link-follow
1989 :package-version
'(Org .
"8.3")
1991 (const :tag
"A double click follows the link" double
)
1992 (const :tag
"Unconditionally follow the link with mouse-1" t
)
1993 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
1995 (defcustom org-mark-ring-length
4
1996 "Number of different positions to be recorded in the ring.
1997 Changing this requires a restart of Emacs to work correctly."
1998 :group
'org-link-follow
2001 (defcustom org-link-search-must-match-exact-headline
'query-to-create
2002 "Non-nil means internal links in Org files must exactly match a headline.
2003 When nil, the link search tries to match a phrase with all words
2004 in the search text."
2005 :group
'org-link-follow
2008 (const :tag
"Use fuzzy text search" nil
)
2009 (const :tag
"Match only exact headline" t
)
2010 (const :tag
"Match exact headline or query to create it"
2013 (defcustom org-link-frame-setup
2014 '((vm . vm-visit-folder-other-frame
)
2015 (vm-imap . vm-visit-imap-folder-other-frame
)
2016 (gnus . org-gnus-no-new-news
)
2017 (file . find-file-other-window
)
2018 (wl . wl-other-frame
))
2019 "Setup the frame configuration for following links.
2020 When following a link with Emacs, it may often be useful to display
2021 this link in another window or frame. This variable can be used to
2022 set this up for the different types of links.
2025 `vm-visit-folder-other-window'
2026 `vm-visit-folder-other-frame'
2027 For Gnus, use any of
2030 `org-gnus-no-new-news'
2031 For FILE, use any of
2033 `find-file-other-window'
2034 `find-file-other-frame'
2035 For Wanderlust use any of
2038 For the calendar, use the variable `calendar-setup'.
2039 For BBDB, it is currently only possible to display the matches in
2041 :group
'org-link-follow
2045 (const vm-visit-folder
)
2046 (const vm-visit-folder-other-window
)
2047 (const vm-visit-folder-other-frame
)))
2048 (cons (const vm-imap
)
2050 (const vm-visit-imap-folder
)
2051 (const vm-visit-imap-folder-other-window
)
2052 (const vm-visit-imap-folder-other-frame
)))
2056 (const gnus-other-frame
)
2057 (const org-gnus-no-new-news
)))
2061 (const find-file-other-window
)
2062 (const find-file-other-frame
)))
2066 (const wl-other-frame
)))))
2068 (defcustom org-display-internal-link-with-indirect-buffer nil
2069 "Non-nil means use indirect buffer to display infile links.
2070 Activating internal links (from one location in a file to another location
2071 in the same file) normally just jumps to the location. When the link is
2072 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2074 another window. When this option is set, the other window actually displays
2075 an indirect buffer clone of the current buffer, to avoid any visibility
2076 changes to the current buffer."
2077 :group
'org-link-follow
2080 (defcustom org-open-non-existing-files nil
2081 "Non-nil means `org-open-file' will open non-existing files.
2082 When nil, an error will be generated.
2083 This variable applies only to external applications because they
2084 might choke on non-existing files. If the link is to a file that
2085 will be opened in Emacs, the variable is ignored."
2086 :group
'org-link-follow
2089 (defcustom org-open-directory-means-index-dot-org nil
2090 "Non-nil means a link to a directory really means to index.org.
2091 When nil, following a directory link will run dired or open a finder/explorer
2092 window on that directory."
2093 :group
'org-link-follow
2096 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2097 "Non-nil means ask for confirmation before executing shell links.
2098 Shell links can be dangerous: just think about a link
2100 [[shell:rm -rf ~/*][Google Search]]
2102 This link would show up in your Org-mode document as \"Google Search\",
2103 but really it would remove your entire home directory.
2104 Therefore we advise against setting this variable to nil.
2105 Just change it to `y-or-n-p' if you want to confirm with a
2106 single keystroke rather than having to type \"yes\"."
2107 :group
'org-link-follow
2109 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2110 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2111 (const :tag
"no confirmation (dangerous)" nil
)))
2112 (put 'org-confirm-shell-link-function
2113 'safe-local-variable
2114 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2116 (defcustom org-confirm-shell-link-not-regexp
""
2117 "A regexp to skip confirmation for shell links."
2118 :group
'org-link-follow
2122 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2123 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2124 Elisp links can be dangerous: just think about a link
2126 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2128 This link would show up in your Org-mode document as \"Google Search\",
2129 but really it would remove your entire home directory.
2130 Therefore we advise against setting this variable to nil.
2131 Just change it to `y-or-n-p' if you want to confirm with a
2132 single keystroke rather than having to type \"yes\"."
2133 :group
'org-link-follow
2135 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2136 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2137 (const :tag
"no confirmation (dangerous)" nil
)))
2138 (put 'org-confirm-shell-link-function
2139 'safe-local-variable
2140 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2142 (defcustom org-confirm-elisp-link-not-regexp
""
2143 "A regexp to skip confirmation for Elisp links."
2144 :group
'org-link-follow
2148 (defconst org-file-apps-defaults-gnu
2152 "Default file applications on a UNIX or GNU/Linux system.
2153 See `org-file-apps'.")
2155 (defconst org-file-apps-defaults-macosx
2158 (system .
"open %s")
2160 ("eps.gz" .
"gv %s")
2162 ("fig" .
"xfig %s"))
2163 "Default file applications on a MacOS X system.
2164 The system \"open\" is known as a default, but we use X11 applications
2165 for some files for which the OS does not have a good default.
2166 See `org-file-apps'.")
2168 (defconst org-file-apps-defaults-windowsnt
2172 (list (if (featurep 'xemacs
)
2173 'mswindows-shell-execute
2177 (list (if (featurep 'xemacs
)
2178 'mswindows-shell-execute
2181 "Default file applications on a Windows NT system.
2182 The system \"open\" is used for most files.
2183 See `org-file-apps'.")
2185 (defcustom org-file-apps
2186 '((auto-mode . emacs
)
2187 ("\\.mm\\'" . default
)
2188 ("\\.x?html?\\'" . default
)
2189 ("\\.pdf\\'" . default
))
2190 "External applications for opening `file:path' items in a document.
2191 Org-mode uses system defaults for different file types, but
2192 you can use this variable to set the application for a given file
2193 extension. The entries in this list are cons cells where the car identifies
2194 files and the cdr the corresponding command. Possible values for the
2196 \"string\" A string as a file identifier can be interpreted in different
2197 ways, depending on its contents:
2199 - Alphanumeric characters only:
2200 Match links with this file extension.
2201 Example: (\"pdf\" . \"evince %s\")
2202 to open PDFs with evince.
2204 - Regular expression: Match links where the
2205 filename matches the regexp. If you want to
2206 use groups here, use shy groups.
2208 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2209 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2210 to open *.html and *.xhtml with firefox.
2212 - Regular expression which contains (non-shy) groups:
2213 Match links where the whole link, including \"::\", and
2214 anything after that, matches the regexp.
2215 In a custom command string, %1, %2, etc. are replaced with
2216 the parts of the link that were matched by the groups.
2217 For backwards compatibility, if a command string is given
2218 that does not use any of the group matches, this case is
2219 handled identically to the second one (i.e. match against
2221 In a custom lisp form, you can access the group matches with
2222 (match-string n link).
2224 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2225 to open [[file:document.pdf::5]] with evince at page 5.
2227 `directory' Matches a directory
2228 `remote' Matches a remote file, accessible through tramp or efs.
2229 Remote files most likely should be visited through Emacs
2230 because external applications cannot handle such paths.
2231 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2232 so all files Emacs knows how to handle. Using this with
2233 command `emacs' will open most files in Emacs. Beware that this
2234 will also open html files inside Emacs, unless you add
2235 (\"html\" . default) to the list as well.
2236 t Default for files not matched by any of the other options.
2237 `system' The system command to open files, like `open' on Windows
2238 and Mac OS X, and mailcap under GNU/Linux. This is the command
2239 that will be selected if you call `C-c C-o' with a double
2240 \\[universal-argument] \\[universal-argument] prefix.
2242 Possible values for the command are:
2243 `emacs' The file will be visited by the current Emacs process.
2244 `default' Use the default application for this file type, which is the
2245 association for t in the list, most likely in the system-specific
2247 This can be used to overrule an unwanted setting in the
2248 system-specific variable.
2249 `system' Use the system command for opening files, like \"open\".
2250 This command is specified by the entry whose car is `system'.
2251 Most likely, the system-specific version of this variable
2252 does define this command, but you can overrule/replace it
2254 string A command to be executed by a shell; %s will be replaced
2255 by the path to the file.
2256 sexp A Lisp form which will be evaluated. The file path will
2257 be available in the Lisp variable `file'.
2258 For more examples, see the system specific constants
2259 `org-file-apps-defaults-macosx'
2260 `org-file-apps-defaults-windowsnt'
2261 `org-file-apps-defaults-gnu'."
2262 :group
'org-link-follow
2264 (cons (choice :value
""
2265 (string :tag
"Extension")
2266 (const :tag
"System command to open files" system
)
2267 (const :tag
"Default for unrecognized files" t
)
2268 (const :tag
"Remote file" remote
)
2269 (const :tag
"Links to a directory" directory
)
2270 (const :tag
"Any files that have Emacs modes"
2273 (const :tag
"Visit with Emacs" emacs
)
2274 (const :tag
"Use default" default
)
2275 (const :tag
"Use the system command" system
)
2276 (string :tag
"Command")
2277 (sexp :tag
"Lisp form")))))
2279 (defcustom org-doi-server-url
"http://dx.doi.org/"
2280 "The URL of the DOI server."
2283 :group
'org-link-follow
)
2285 (defgroup org-refile nil
2286 "Options concerning refiling entries in Org-mode."
2290 (defcustom org-directory
"~/org"
2291 "Directory with org files.
2292 This is just a default location to look for Org files. There is no need
2293 at all to put your files into this directory. It is only used in the
2294 following situations:
2296 1. When a capture template specifies a target file that is not an
2297 absolute path. The path will then be interpreted relative to
2299 2. When a capture note is filed away in an interactive way (when exiting the
2300 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2301 with `org-directory' as the default path."
2306 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2307 "Default target for storing notes.
2308 Used as a fall back file for org-capture.el, for templates that
2309 do not specify a target file."
2314 (defcustom org-goto-interface
'outline
2315 "The default interface to be used for `org-goto'.
2317 outline The interface shows an outline of the relevant file
2318 and the correct heading is found by moving through
2319 the outline or by searching with incremental search.
2320 outline-path-completion Headlines in the current buffer are offered via
2321 completion. This is the interface also used by
2322 the refile command."
2325 (const :tag
"Outline" outline
)
2326 (const :tag
"Outline-path-completion" outline-path-completion
)))
2328 (defcustom org-goto-max-level
5
2329 "Maximum target level when running `org-goto' with refile interface."
2333 (defcustom org-reverse-note-order nil
2334 "Non-nil means store new notes at the beginning of a file or entry.
2335 When nil, new notes will be filed to the end of a file or entry.
2336 This can also be a list with cons cells of regular expressions that
2337 are matched against file names, and values."
2341 (const :tag
"Reverse always" t
)
2342 (const :tag
"Reverse never" nil
)
2343 (repeat :tag
"By file name regexp"
2344 (cons regexp boolean
))))
2346 (defcustom org-log-refile nil
2347 "Information to record when a task is refiled.
2349 Possible values are:
2351 nil Don't add anything
2352 time Add a time stamp to the task
2353 note Prompt for a note and add it with template `org-log-note-headings'
2355 This option can also be set with on a per-file-basis with
2357 #+STARTUP: nologrefile
2358 #+STARTUP: logrefile
2359 #+STARTUP: lognoterefile
2361 You can have local logging settings for a subtree by setting the LOGGING
2362 property to one or more of these keywords.
2364 When bulk-refiling from the agenda, the value `note' is forbidden and
2365 will temporarily be changed to `time'."
2367 :group
'org-progress
2370 (const :tag
"No logging" nil
)
2371 (const :tag
"Record timestamp" time
)
2372 (const :tag
"Record timestamp with note." note
)))
2374 (defcustom org-refile-targets nil
2375 "Targets for refiling entries with \\[org-refile].
2376 This is a list of cons cells. Each cell contains:
2377 - a specification of the files to be considered, either a list of files,
2378 or a symbol whose function or variable value will be used to retrieve
2379 a file name or a list of file names. If you use `org-agenda-files' for
2380 that, all agenda files will be scanned for targets. Nil means consider
2381 headings in the current buffer.
2382 - A specification of how to find candidate refile targets. This may be
2384 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2385 This tag has to be present in all target headlines, inheritance will
2387 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2389 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2390 headlines that are refiling targets.
2391 - a cons cell (:level . N). Any headline of level N is considered a target.
2392 Note that, when `org-odd-levels-only' is set, level corresponds to
2393 order in hierarchy, not to the number of stars.
2394 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2395 Note that, when `org-odd-levels-only' is set, level corresponds to
2396 order in hierarchy, not to the number of stars.
2398 Each element of this list generates a set of possible targets.
2399 The union of these sets is presented (with completion) to
2400 the user by `org-refile'.
2402 You can set the variable `org-refile-target-verify-function' to a function
2403 to verify each headline found by the simple criteria above.
2405 When this variable is nil, all top-level headlines in the current buffer
2406 are used, equivalent to the value `((nil . (:level . 1))'."
2410 (choice :value org-agenda-files
2411 (const :tag
"All agenda files" org-agenda-files
)
2412 (const :tag
"Current buffer" nil
)
2413 (function) (variable) (file))
2414 (choice :tag
"Identify target headline by"
2415 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2416 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2417 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2418 (cons :tag
"Level number" (const :value
:level
) (integer))
2419 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2421 (defcustom org-refile-target-verify-function nil
2422 "Function to verify if the headline at point should be a refile target.
2423 The function will be called without arguments, with point at the
2424 beginning of the headline. It should return t and leave point
2425 where it is if the headline is a valid target for refiling.
2427 If the target should not be selected, the function must return nil.
2428 In addition to this, it may move point to a place from where the search
2429 should be continued. For example, the function may decide that the entire
2430 subtree of the current entry should be excluded and move point to the end
2437 (defcustom org-refile-use-cache nil
2438 "Non-nil means cache refile targets to speed up the process.
2439 The cache for a particular file will be updated automatically when
2440 the buffer has been killed, or when any of the marker used for flagging
2441 refile targets no longer points at a live buffer.
2442 If you have added new entries to a buffer that might themselves be targets,
2443 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2444 find that easier, `C-u C-u C-u C-c C-w'."
2449 (defcustom org-refile-use-outline-path nil
2450 "Non-nil means provide refile targets as paths.
2451 So a level 3 headline will be available as level1/level2/level3.
2453 When the value is `file', also include the file name (without directory)
2454 into the path. In this case, you can also stop the completion after
2455 the file name, to get entries inserted as top level in the file.
2457 When `full-file-path', include the full file path."
2460 (const :tag
"Not" nil
)
2461 (const :tag
"Yes" t
)
2462 (const :tag
"Start with file name" file
)
2463 (const :tag
"Start with full file path" full-file-path
)))
2465 (defcustom org-outline-path-complete-in-steps t
2466 "Non-nil means complete the outline path in hierarchical steps.
2467 When Org-mode uses the refile interface to select an outline path
2468 \(see variable `org-refile-use-outline-path'), the completion of
2469 the path can be done in a single go, or it can be done in steps down
2470 the headline hierarchy. Going in steps is probably the best if you
2471 do not use a special completion package like `ido' or `icicles'.
2472 However, when using these packages, going in one step can be very
2473 fast, while still showing the whole path to the entry."
2477 (defcustom org-refile-allow-creating-parent-nodes nil
2478 "Non-nil means allow to create new nodes as refile targets.
2479 New nodes are then created by adding \"/new node name\" to the completion
2480 of an existing node. When the value of this variable is `confirm',
2481 new node creation must be confirmed by the user (recommended).
2482 When nil, the completion must match an existing entry.
2484 Note that, if the new heading is not seen by the criteria
2485 listed in `org-refile-targets', multiple instances of the same
2486 heading would be created by trying again to file under the new
2490 (const :tag
"Never" nil
)
2491 (const :tag
"Always" t
)
2492 (const :tag
"Prompt for confirmation" confirm
)))
2494 (defcustom org-refile-active-region-within-subtree nil
2495 "Non-nil means also refile active region within a subtree.
2497 By default `org-refile' doesn't allow refiling regions if they
2498 don't contain a set of subtrees, but it might be convenient to
2499 do so sometimes: in that case, the first line of the region is
2500 converted to a headline before refiling."
2505 (defgroup org-todo nil
2506 "Options concerning TODO items in Org-mode."
2510 (defgroup org-progress nil
2511 "Options concerning Progress logging in Org-mode."
2515 (defvar org-todo-interpretation-widgets
2516 '((:tag
"Sequence (cycling hits every state)" sequence
)
2517 (:tag
"Type (cycling directly to DONE)" type
))
2518 "The available interpretation symbols for customizing `org-todo-keywords'.
2519 Interested libraries should add to this list.")
2521 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2522 "List of TODO entry keyword sequences and their interpretation.
2523 \\<org-mode-map>This is a list of sequences.
2525 Each sequence starts with a symbol, either `sequence' or `type',
2526 indicating if the keywords should be interpreted as a sequence of
2527 action steps, or as different types of TODO items. The first
2528 keywords are states requiring action - these states will select a headline
2529 for inclusion into the global TODO list Org-mode produces. If one of
2530 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2531 signify that no further action is necessary. If \"|\" is not found,
2532 the last keyword is treated as the only DONE state of the sequence.
2534 The command \\[org-todo] cycles an entry through these states, and one
2535 additional state where no keyword is present. For details about this
2536 cycling, see the manual.
2538 TODO keywords and interpretation can also be set on a per-file basis with
2539 the special #+SEQ_TODO and #+TYP_TODO lines.
2541 Each keyword can optionally specify a character for fast state selection
2542 \(in combination with the variable `org-use-fast-todo-selection')
2543 and specifiers for state change logging, using the same syntax that
2544 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2545 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2546 indicates to record a time stamp each time this state is selected.
2548 Each keyword may also specify if a timestamp or a note should be
2549 recorded when entering or leaving the state, by adding additional
2550 characters in the parenthesis after the keyword. This looks like this:
2551 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2552 record only the time of the state change. With X and Y being either
2553 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2554 Y when leaving the state if and only if the *target* state does not
2555 define X. You may omit any of the fast-selection key or X or /Y,
2556 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2558 For backward compatibility, this variable may also be just a list
2559 of keywords. In this case the interpretation (sequence or type) will be
2560 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2562 :group
'org-keywords
2564 (repeat :tag
"Old syntax, just keywords"
2565 (string :tag
"Keyword"))
2566 (repeat :tag
"New syntax"
2569 :tag
"Interpretation"
2570 ;;Quick and dirty way to see
2571 ;;`org-todo-interpretations'. This takes the
2572 ;;place of item arguments
2580 org-todo-interpretation-widgets
))
2583 (string :tag
"Keyword"))))))
2585 (defvar org-todo-keywords-1 nil
2586 "All TODO and DONE keywords active in a buffer.")
2587 (make-variable-buffer-local 'org-todo-keywords-1
)
2588 (defvar org-todo-keywords-for-agenda nil
)
2589 (defvar org-done-keywords-for-agenda nil
)
2590 (defvar org-todo-keyword-alist-for-agenda nil
)
2591 (defvar org-tag-alist-for-agenda nil
2592 "Alist of all tags from all agenda files.")
2593 (defvar org-tag-groups-alist-for-agenda nil
2594 "Alist of all groups tags from all current agenda files.")
2595 (defvar org-tag-groups-alist nil
)
2596 (make-variable-buffer-local 'org-tag-groups-alist
)
2597 (defvar org-agenda-contributing-files nil
)
2598 (defvar org-not-done-keywords nil
)
2599 (make-variable-buffer-local 'org-not-done-keywords
)
2600 (defvar org-done-keywords nil
)
2601 (make-variable-buffer-local 'org-done-keywords
)
2602 (defvar org-todo-heads nil
)
2603 (make-variable-buffer-local 'org-todo-heads
)
2604 (defvar org-todo-sets nil
)
2605 (make-variable-buffer-local 'org-todo-sets
)
2606 (defvar org-todo-log-states nil
)
2607 (make-variable-buffer-local 'org-todo-log-states
)
2608 (defvar org-todo-kwd-alist nil
)
2609 (make-variable-buffer-local 'org-todo-kwd-alist
)
2610 (defvar org-todo-key-alist nil
)
2611 (make-variable-buffer-local 'org-todo-key-alist
)
2612 (defvar org-todo-key-trigger nil
)
2613 (make-variable-buffer-local 'org-todo-key-trigger
)
2615 (defcustom org-todo-interpretation
'sequence
2616 "Controls how TODO keywords are interpreted.
2617 This variable is in principle obsolete and is only used for
2618 backward compatibility, if the interpretation of todo keywords is
2619 not given already in `org-todo-keywords'. See that variable for
2622 :group
'org-keywords
2623 :type
'(choice (const sequence
)
2626 (defcustom org-use-fast-todo-selection t
2627 "Non-nil means use the fast todo selection scheme with C-c C-t.
2628 This variable describes if and under what circumstances the cycling
2629 mechanism for TODO keywords will be replaced by a single-key, direct
2632 When nil, fast selection is never used.
2634 When the symbol `prefix', it will be used when `org-todo' is called
2635 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2636 `C-u t' in an agenda buffer.
2638 When t, fast selection is used by default. In this case, the prefix
2639 argument forces cycling instead.
2641 In all cases, the special interface is only used if access keys have
2642 actually been assigned by the user, i.e. if keywords in the configuration
2643 are followed by a letter in parenthesis, like TODO(t)."
2646 (const :tag
"Never" nil
)
2647 (const :tag
"By default" t
)
2648 (const :tag
"Only with C-u C-c C-t" prefix
)))
2650 (defcustom org-provide-todo-statistics t
2651 "Non-nil means update todo statistics after insert and toggle.
2652 ALL-HEADLINES means update todo statistics by including headlines
2653 with no TODO keyword as well, counting them as not done.
2654 A list of TODO keywords means the same, but skip keywords that are
2656 When set to a list of two lists, the first list contains keywords
2657 to consider as TODO keywords, the second list contains keywords
2658 to consider as DONE keywords.
2660 When this is set, todo statistics is updated in the parent of the
2661 current entry each time a todo state is changed."
2664 (const :tag
"Yes, only for TODO entries" t
)
2665 (const :tag
"Yes, including all entries" all-headlines
)
2666 (repeat :tag
"Yes, for TODOs in this list"
2667 (string :tag
"TODO keyword"))
2668 (list :tag
"Yes, for TODOs and DONEs in these lists"
2669 (repeat (string :tag
"TODO keyword"))
2670 (repeat (string :tag
"DONE keyword")))
2671 (other :tag
"No TODO statistics" nil
)))
2673 (defcustom org-hierarchical-todo-statistics t
2674 "Non-nil means TODO statistics covers just direct children.
2675 When nil, all entries in the subtree are considered.
2676 This has only an effect if `org-provide-todo-statistics' is set.
2677 To set this to nil for only a single subtree, use a COOKIE_DATA
2678 property and include the word \"recursive\" into the value."
2682 (defcustom org-after-todo-state-change-hook nil
2683 "Hook which is run after the state of a TODO item was changed.
2684 The new state (a string with a TODO keyword, or nil) is available in the
2685 Lisp variable `org-state'."
2689 (defvar org-blocker-hook nil
2690 "Hook for functions that are allowed to block a state change.
2692 Functions in this hook should not modify the buffer.
2693 Each function gets as its single argument a property list,
2694 see `org-trigger-hook' for more information about this list.
2696 If any of the functions in this hook returns nil, the state change
2699 (defvar org-trigger-hook nil
2700 "Hook for functions that are triggered by a state change.
2702 Each function gets as its single argument a property list with at
2703 least the following elements:
2705 (:type type-of-change :position pos-at-entry-start
2706 :from old-state :to new-state)
2708 Depending on the type, more properties may be present.
2710 This mechanism is currently implemented for:
2714 :type todo-state-change
2715 :from previous state (keyword as a string), or nil, or a symbol
2716 'todo' or 'done', to indicate the general type of state.
2717 :to new state, like in :from")
2719 (defcustom org-enforce-todo-dependencies nil
2720 "Non-nil means undone TODO entries will block switching the parent to DONE.
2721 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2722 be blocked if any prior sibling is not yet done.
2723 Finally, if the parent is blocked because of ordered siblings of its own,
2724 the child will also be blocked."
2725 :set
(lambda (var val
)
2728 (add-hook 'org-blocker-hook
2729 'org-block-todo-from-children-or-siblings-or-parent
)
2730 (remove-hook 'org-blocker-hook
2731 'org-block-todo-from-children-or-siblings-or-parent
)))
2735 (defcustom org-enforce-todo-checkbox-dependencies nil
2736 "Non-nil means unchecked boxes will block switching the parent to DONE.
2737 When this is nil, checkboxes have no influence on switching TODO states.
2738 When non-nil, you first need to check off all check boxes before the TODO
2739 entry can be switched to DONE.
2740 This variable needs to be set before org.el is loaded, and you need to
2741 restart Emacs after a change to make the change effective. The only way
2742 to change is while Emacs is running is through the customize interface."
2743 :set
(lambda (var val
)
2746 (add-hook 'org-blocker-hook
2747 'org-block-todo-from-checkboxes
)
2748 (remove-hook 'org-blocker-hook
2749 'org-block-todo-from-checkboxes
)))
2753 (defcustom org-treat-insert-todo-heading-as-state-change nil
2754 "Non-nil means inserting a TODO heading is treated as state change.
2755 So when the command \\[org-insert-todo-heading] is used, state change
2756 logging will apply if appropriate. When nil, the new TODO item will
2757 be inserted directly, and no logging will take place."
2761 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2762 "Non-nil means switching TODO states with S-cursor counts as state change.
2763 This is the default behavior. However, setting this to nil allows a
2764 convenient way to select a TODO state and bypass any logging associated
2769 (defcustom org-todo-state-tags-triggers nil
2770 "Tag changes that should be triggered by TODO state changes.
2771 This is a list. Each entry is
2773 (state-change (tag . flag) .......)
2775 State-change can be a string with a state, and empty string to indicate the
2776 state that has no TODO keyword, or it can be one of the symbols `todo'
2777 or `done', meaning any not-done or done state, respectively."
2781 (cons (choice :tag
"When changing to"
2782 (const :tag
"Not-done state" todo
)
2783 (const :tag
"Done state" done
)
2784 (string :tag
"State"))
2786 (cons :tag
"Tag action"
2788 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2790 (defcustom org-log-done nil
2791 "Information to record when a task moves to the DONE state.
2793 Possible values are:
2795 nil Don't add anything, just change the keyword
2796 time Add a time stamp to the task
2797 note Prompt for a note and add it with template `org-log-note-headings'
2799 This option can also be set with on a per-file-basis with
2801 #+STARTUP: nologdone
2803 #+STARTUP: lognotedone
2805 You can have local logging settings for a subtree by setting the LOGGING
2806 property to one or more of these keywords."
2808 :group
'org-progress
2810 (const :tag
"No logging" nil
)
2811 (const :tag
"Record CLOSED timestamp" time
)
2812 (const :tag
"Record CLOSED timestamp with note." note
)))
2814 ;; Normalize old uses of org-log-done.
2816 ((eq org-log-done t
) (setq org-log-done
'time
))
2817 ((and (listp org-log-done
) (memq 'done org-log-done
))
2818 (setq org-log-done
'note
)))
2820 (defcustom org-log-reschedule nil
2821 "Information to record when the scheduling date of a tasks is modified.
2823 Possible values are:
2825 nil Don't add anything, just change the date
2826 time Add a time stamp to the task
2827 note Prompt for a note and add it with template `org-log-note-headings'
2829 This option can also be set with on a per-file-basis with
2831 #+STARTUP: nologreschedule
2832 #+STARTUP: logreschedule
2833 #+STARTUP: lognotereschedule"
2835 :group
'org-progress
2837 (const :tag
"No logging" nil
)
2838 (const :tag
"Record timestamp" time
)
2839 (const :tag
"Record timestamp with note." note
)))
2841 (defcustom org-log-redeadline nil
2842 "Information to record when the deadline date of a tasks is modified.
2844 Possible values are:
2846 nil Don't add anything, just change the date
2847 time Add a time stamp to the task
2848 note Prompt for a note and add it with template `org-log-note-headings'
2850 This option can also be set with on a per-file-basis with
2852 #+STARTUP: nologredeadline
2853 #+STARTUP: logredeadline
2854 #+STARTUP: lognoteredeadline
2856 You can have local logging settings for a subtree by setting the LOGGING
2857 property to one or more of these keywords."
2859 :group
'org-progress
2861 (const :tag
"No logging" nil
)
2862 (const :tag
"Record timestamp" time
)
2863 (const :tag
"Record timestamp with note." note
)))
2865 (defcustom org-log-note-clock-out nil
2866 "Non-nil means record a note when clocking out of an item.
2867 This can also be configured on a per-file basis by adding one of
2868 the following lines anywhere in the buffer:
2870 #+STARTUP: lognoteclock-out
2871 #+STARTUP: nolognoteclock-out"
2873 :group
'org-progress
2876 (defcustom org-log-done-with-time t
2877 "Non-nil means the CLOSED time stamp will contain date and time.
2878 When nil, only the date will be recorded."
2879 :group
'org-progress
2882 (defcustom org-log-note-headings
2883 '((done .
"CLOSING NOTE %t")
2884 (state .
"State %-12s from %-12S %t")
2885 (note .
"Note taken on %t")
2886 (reschedule .
"Rescheduled from %S on %t")
2887 (delschedule .
"Not scheduled, was %S on %t")
2888 (redeadline .
"New deadline from %S on %t")
2889 (deldeadline .
"Removed deadline, was %S on %t")
2890 (refile .
"Refiled on %t")
2892 "Headings for notes added to entries.
2894 The value is an alist, with the car being a symbol indicating the
2895 note context, and the cdr is the heading to be used. The heading
2896 may also be the empty string. The following placeholders can be
2900 %T an active time stamp instead the default inactive one
2901 %d a short-format time stamp.
2902 %D an active short-format time stamp.
2903 %s the new TODO state or time stamp (inactive), in double quotes.
2904 %S the old TODO state or time stamp (inactive), in double quotes.
2908 In fact, it is not a good idea to change the `state' entry,
2909 because Agenda Log mode depends on the format of these entries."
2911 :group
'org-progress
2912 :type
'(list :greedy t
2913 (cons (const :tag
"Heading when closing an item" done
) string
)
2915 "Heading when changing todo state (todo sequence only)"
2917 (cons (const :tag
"Heading when just taking a note" note
) string
)
2918 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2919 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2920 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2921 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2922 (cons (const :tag
"Heading when refiling" refile
) string
)
2923 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2925 (unless (assq 'note org-log-note-headings
)
2926 (push '(note .
"%t") org-log-note-headings
))
2928 (defcustom org-log-into-drawer nil
2929 "Non-nil means insert state change notes and time stamps into a drawer.
2930 When nil, state changes notes will be inserted after the headline and
2931 any scheduling and clock lines, but not inside a drawer.
2933 The value of this variable should be the name of the drawer to use.
2934 LOGBOOK is proposed as the default drawer for this purpose, you can
2935 also set this to a string to define the drawer of your choice.
2937 A value of t is also allowed, representing \"LOGBOOK\".
2939 A value of t or nil can also be set with on a per-file-basis with
2941 #+STARTUP: logdrawer
2942 #+STARTUP: nologdrawer
2944 If this variable is set, `org-log-state-notes-insert-after-drawers'
2947 You can set the property LOG_INTO_DRAWER to overrule this setting for
2950 Do not check directly this variable in a Lisp program. Call
2951 function `org-log-into-drawer' instead."
2953 :group
'org-progress
2955 (const :tag
"Not into a drawer" nil
)
2956 (const :tag
"LOGBOOK" t
)
2957 (string :tag
"Other")))
2959 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2961 (defun org-log-into-drawer ()
2962 "Name of the log drawer, as a string, or nil.
2963 This is the value of `org-log-into-drawer'. However, if the
2964 current entry has or inherits a LOG_INTO_DRAWER property, it will
2965 be used instead of the default value."
2966 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2967 (cond ((equal p
"nil") nil
)
2968 ((equal p
"t") "LOGBOOK")
2971 ((stringp org-log-into-drawer
) org-log-into-drawer
)
2972 (org-log-into-drawer "LOGBOOK"))))
2974 (defcustom org-log-state-notes-insert-after-drawers nil
2975 "Non-nil means insert state change notes after any drawers in entry.
2976 Only the drawers that *immediately* follow the headline and the
2977 deadline/scheduled line are skipped.
2978 When nil, insert notes right after the heading and perhaps the line
2979 with deadline/scheduling if present.
2981 This variable will have no effect if `org-log-into-drawer' is
2984 :group
'org-progress
2987 (defcustom org-log-states-order-reversed t
2988 "Non-nil means the latest state note will be directly after heading.
2989 When nil, the state change notes will be ordered according to time.
2991 This option can also be set with on a per-file-basis with
2993 #+STARTUP: logstatesreversed
2994 #+STARTUP: nologstatesreversed"
2996 :group
'org-progress
2999 (defcustom org-todo-repeat-to-state nil
3000 "The TODO state to which a repeater should return the repeating task.
3001 By default this is the first task in a TODO sequence, or the previous state
3002 in a TODO_TYP set. But you can specify another task here.
3003 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3006 :type
'(choice (const :tag
"Head of sequence" nil
)
3007 (string :tag
"Specific state")))
3009 (defcustom org-log-repeat
'time
3010 "Non-nil means record moving through the DONE state when triggering repeat.
3011 An auto-repeating task is immediately switched back to TODO when
3012 marked DONE. If you are not logging state changes (by adding \"@\"
3013 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3014 record a closing note, there will be no record of the task moving
3015 through DONE. This variable forces taking a note anyway.
3017 nil Don't force a record
3018 time Record a time stamp
3019 note Prompt for a note and add it with template `org-log-note-headings'
3021 This option can also be set with on a per-file-basis with
3023 #+STARTUP: nologrepeat
3024 #+STARTUP: logrepeat
3025 #+STARTUP: lognoterepeat
3027 You can have local logging settings for a subtree by setting the LOGGING
3028 property to one or more of these keywords."
3030 :group
'org-progress
3032 (const :tag
"Don't force a record" nil
)
3033 (const :tag
"Force recording the DONE state" time
)
3034 (const :tag
"Force recording a note with the DONE state" note
)))
3037 (defgroup org-priorities nil
3038 "Priorities in Org-mode."
3039 :tag
"Org Priorities"
3042 (defcustom org-enable-priority-commands t
3043 "Non-nil means priority commands are active.
3044 When nil, these commands will be disabled, so that you never accidentally
3046 :group
'org-priorities
3049 (defcustom org-highest-priority ?A
3050 "The highest priority of TODO items. A character like ?A, ?B etc.
3051 Must have a smaller ASCII number than `org-lowest-priority'."
3052 :group
'org-priorities
3055 (defcustom org-lowest-priority ?C
3056 "The lowest priority of TODO items. A character like ?A, ?B etc.
3057 Must have a larger ASCII number than `org-highest-priority'."
3058 :group
'org-priorities
3061 (defcustom org-default-priority ?B
3062 "The default priority of TODO items.
3063 This is the priority an item gets if no explicit priority is given.
3064 When starting to cycle on an empty priority the first step in the cycle
3065 depends on `org-priority-start-cycle-with-default'. The resulting first
3066 step priority must not exceed the range from `org-highest-priority' to
3067 `org-lowest-priority' which means that `org-default-priority' has to be
3068 in this range exclusive or inclusive the range boundaries. Else the
3069 first step refuses to set the default and the second will fall back
3070 to (depending on the command used) the highest or lowest priority."
3071 :group
'org-priorities
3074 (defcustom org-priority-start-cycle-with-default t
3075 "Non-nil means start with default priority when starting to cycle.
3076 When this is nil, the first step in the cycle will be (depending on the
3077 command used) one higher or lower than the default priority.
3078 See also `org-default-priority'."
3079 :group
'org-priorities
3082 (defcustom org-get-priority-function nil
3083 "Function to extract the priority from a string.
3084 The string is normally the headline. If this is nil Org computes the
3085 priority from the priority cookie like [#A] in the headline. It returns
3086 an integer, increasing by 1000 for each priority level.
3087 The user can set a different function here, which should take a string
3088 as an argument and return the numeric priority."
3089 :group
'org-priorities
3095 (defgroup org-time nil
3096 "Options concerning time stamps and deadlines in Org-mode."
3100 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3101 "Number of minutes to round time stamps to.
3102 These are two values, the first applies when first creating a time stamp.
3103 The second applies when changing it with the commands `S-up' and `S-down'.
3104 When changing the time stamp, this means that it will change in steps
3105 of N minutes, as given by the second value.
3107 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3108 numbers should be factors of 60, so for example 5, 10, 15.
3110 When this is larger than 1, you can still force an exact time stamp by using
3111 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3112 and by using a prefix arg to `S-up/down' to specify the exact number
3113 of minutes to shift."
3115 :get
(lambda (var) ; Make sure both elements are there
3116 (if (integerp (default-value var
))
3117 (list (default-value var
) 5)
3118 (default-value var
)))
3120 (integer :tag
"when inserting times")
3121 (integer :tag
"when modifying times")))
3123 ;; Normalize old customizations of this variable.
3124 (when (integerp org-time-stamp-rounding-minutes
)
3125 (setq org-time-stamp-rounding-minutes
3126 (list org-time-stamp-rounding-minutes
3127 org-time-stamp-rounding-minutes
)))
3129 (defcustom org-display-custom-times nil
3130 "Non-nil means overlay custom formats over all time stamps.
3131 The formats are defined through the variable `org-time-stamp-custom-formats'.
3132 To turn this on on a per-file basis, insert anywhere in the file:
3133 #+STARTUP: customtime"
3137 (make-variable-buffer-local 'org-display-custom-times
)
3139 (defcustom org-time-stamp-custom-formats
3140 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3141 "Custom formats for time stamps. See `format-time-string' for the syntax.
3142 These are overlaid over the default ISO format if the variable
3143 `org-display-custom-times' is set. Time like %H:%M should be at the
3144 end of the second format. The custom formats are also honored by export
3145 commands, if custom time display is turned on at the time of export."
3149 (defun org-time-stamp-format (&optional long inactive
)
3150 "Get the right format for a time string."
3151 (let ((f (if long
(cdr org-time-stamp-formats
)
3152 (car org-time-stamp-formats
))))
3154 (concat "[" (substring f
1 -
1) "]")
3157 (defcustom org-time-clocksum-format
3158 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3159 "The format string used when creating CLOCKSUM lines.
3160 This is also used when Org mode generates a time duration.
3162 The value can be a single format string containing two
3163 %-sequences, which will be filled with the number of hours and
3164 minutes in that order.
3166 Alternatively, the value can be a plist associating any of the
3167 keys :years, :months, :weeks, :days, :hours or :minutes with
3168 format strings. The time duration is formatted using only the
3169 time components that are needed and concatenating the results.
3170 If a time unit in absent, it falls back to the next smallest
3173 The keys :require-years, :require-months, :require-days,
3174 :require-weeks, :require-hours, :require-minutes are also
3175 meaningful. A non-nil value for these keys indicates that the
3176 corresponding time component should always be included, even if
3182 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3185 means durations longer than a day will be expressed in days,
3186 hours and minutes, and durations less than a day will always be
3187 expressed in hours and minutes (even for durations less than an
3192 \(:days \"%dd\" :minutes \"%dm\")
3194 means durations longer than a day will be expressed in days and
3195 minutes, and durations less than a day will be expressed entirely
3196 in minutes (even for durations longer than an hour)."
3200 :package-version
'(Org .
"8.0")
3201 :type
'(choice (string :tag
"Format string")
3203 (group :inline t
(const :tag
"Years" :years
)
3204 (string :tag
"Format string"))
3206 (const :tag
"Always show years" :require-years
)
3208 (group :inline t
(const :tag
"Months" :months
)
3209 (string :tag
"Format string"))
3211 (const :tag
"Always show months" :require-months
)
3213 (group :inline t
(const :tag
"Weeks" :weeks
)
3214 (string :tag
"Format string"))
3216 (const :tag
"Always show weeks" :require-weeks
)
3218 (group :inline t
(const :tag
"Days" :days
)
3219 (string :tag
"Format string"))
3221 (const :tag
"Always show days" :require-days
)
3223 (group :inline t
(const :tag
"Hours" :hours
)
3224 (string :tag
"Format string"))
3226 (const :tag
"Always show hours" :require-hours
)
3228 (group :inline t
(const :tag
"Minutes" :minutes
)
3229 (string :tag
"Format string"))
3231 (const :tag
"Always show minutes" :require-minutes
)
3234 (defcustom org-time-clocksum-use-fractional nil
3235 "When non-nil, \\[org-clock-display] uses fractional times.
3236 See `org-time-clocksum-format' for more on time clock formats."
3242 (defcustom org-time-clocksum-use-effort-durations nil
3243 "When non-nil, \\[org-clock-display] uses effort durations.
3244 E.g. by default, one day is considered to be a 8 hours effort,
3245 so a task that has been clocked for 16 hours will be displayed
3246 as during 2 days in the clock display or in the clocktable.
3248 See `org-effort-durations' on how to set effort durations
3249 and `org-time-clocksum-format' for more on time clock formats."
3253 :package-version
'(Org .
"8.0")
3256 (defcustom org-time-clocksum-fractional-format
"%.2f"
3257 "The format string used when creating CLOCKSUM lines,
3258 or when Org mode generates a time duration, if
3259 `org-time-clocksum-use-fractional' is enabled.
3261 The value can be a single format string containing one
3262 %-sequence, which will be filled with the number of hours as
3265 Alternatively, the value can be a plist associating any of the
3266 keys :years, :months, :weeks, :days, :hours or :minutes with
3267 a format string. The time duration is formatted using the
3268 largest time unit which gives a non-zero integer part. If all
3269 specified formats have zero integer part, the smallest time unit
3272 :type
'(choice (string :tag
"Format string")
3273 (set (group :inline t
(const :tag
"Years" :years
)
3274 (string :tag
"Format string"))
3275 (group :inline t
(const :tag
"Months" :months
)
3276 (string :tag
"Format string"))
3277 (group :inline t
(const :tag
"Weeks" :weeks
)
3278 (string :tag
"Format string"))
3279 (group :inline t
(const :tag
"Days" :days
)
3280 (string :tag
"Format string"))
3281 (group :inline t
(const :tag
"Hours" :hours
)
3282 (string :tag
"Format string"))
3283 (group :inline t
(const :tag
"Minutes" :minutes
)
3284 (string :tag
"Format string")))))
3286 (defcustom org-deadline-warning-days
14
3287 "Number of days before expiration during which a deadline becomes active.
3288 This variable governs the display in sparse trees and in the agenda.
3289 When 0 or negative, it means use this number (the absolute value of it)
3290 even if a deadline has a different individual lead time specified.
3292 Custom commands can set this variable in the options section."
3294 :group
'org-agenda-daily
/weekly
3297 (defcustom org-scheduled-delay-days
0
3298 "Number of days before a scheduled item becomes active.
3299 This variable governs the display in sparse trees and in the agenda.
3300 The default value (i.e. 0) means: don't delay scheduled item.
3301 When negative, it means use this number (the absolute value of it)
3302 even if a scheduled item has a different individual delay time
3305 Custom commands can set this variable in the options section."
3307 :group
'org-agenda-daily
/weekly
3309 :package-version
'(Org .
"8.0")
3312 (defcustom org-read-date-prefer-future t
3313 "Non-nil means assume future for incomplete date input from user.
3314 This affects the following situations:
3315 1. The user gives a month but not a year.
3316 For example, if it is April and you enter \"feb 2\", this will be read
3317 as Feb 2, *next* year. \"May 5\", however, will be this year.
3318 2. The user gives a day, but no month.
3319 For example, if today is the 15th, and you enter \"3\", Org-mode will
3320 read this as the third of *next* month. However, if you enter \"17\",
3321 it will be considered as *this* month.
3323 If you set this variable to the symbol `time', then also the following
3326 3. If the user gives a time.
3327 If the time is before now, it will be interpreted as tomorrow.
3329 Currently none of this works for ISO week specifications.
3331 When this option is nil, the current day, month and year will always be
3334 See also `org-agenda-jump-prefer-future'."
3337 (const :tag
"Never" nil
)
3338 (const :tag
"Check month and day" t
)
3339 (const :tag
"Check month, day, and time" time
)))
3341 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3342 "Should the agenda jump command prefer the future for incomplete dates?
3343 The default is to do the same as configured in `org-read-date-prefer-future'.
3344 But you can also set a deviating value here.
3345 This may t or nil, or the symbol `org-read-date-prefer-future'."
3350 (const :tag
"Use org-read-date-prefer-future"
3351 org-read-date-prefer-future
)
3352 (const :tag
"Never" nil
)
3353 (const :tag
"Always" t
)))
3355 (defcustom org-read-date-force-compatible-dates t
3356 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3358 Depending on the system Emacs is running on, certain dates cannot
3359 be represented with the type used internally to represent time.
3360 Dates between 1970-1-1 and 2038-1-1 can always be represented
3361 correctly. Some systems allow for earlier dates, some for later,
3362 some for both. One way to find out it to insert any date into an
3363 Org buffer, putting the cursor on the year and hitting S-up and
3364 S-down to test the range.
3366 When this variable is set to t, the date/time prompt will not let
3367 you specify dates outside the 1970-2037 range, so it is certain that
3368 these dates will work in whatever version of Emacs you are
3369 running, and also that you can move a file from one Emacs implementation
3370 to another. WHenever Org is forcing the year for you, it will display
3373 When this variable is nil, Org will check if the date is
3374 representable in the specific Emacs implementation you are using.
3375 If not, it will force a year, usually the current year, and beep
3376 to remind you. Currently this setting is not recommended because
3377 the likelihood that you will open your Org files in an Emacs that
3378 has limited date range is not negligible.
3380 A workaround for this problem is to use diary sexp dates for time
3381 stamps outside of this range."
3386 (defcustom org-read-date-display-live t
3387 "Non-nil means display current interpretation of date prompt live.
3388 This display will be in an overlay, in the minibuffer."
3392 (defcustom org-read-date-popup-calendar t
3393 "Non-nil means pop up a calendar when prompting for a date.
3394 In the calendar, the date can be selected with mouse-1. However, the
3395 minibuffer will also be active, and you can simply enter the date as well.
3396 When nil, only the minibuffer will be available."
3399 (org-defvaralias 'org-popup-calendar-for-date-prompt
3400 'org-read-date-popup-calendar
)
3402 (make-obsolete-variable
3403 'org-read-date-minibuffer-setup-hook
3404 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3405 (defcustom org-read-date-minibuffer-setup-hook nil
3406 "Hook to be used to set up keys for the date/time interface.
3407 Add key definitions to `minibuffer-local-map', which will be a
3410 WARNING: This option is obsolete, you should use
3411 `org-read-date-minibuffer-local-map' to set up keys."
3415 (defcustom org-extend-today-until
0
3416 "The hour when your day really ends. Must be an integer.
3417 This has influence for the following applications:
3418 - When switching the agenda to \"today\". It it is still earlier than
3419 the time given here, the day recognized as TODAY is actually yesterday.
3420 - When a date is read from the user and it is still before the time given
3421 here, the current date and time will be assumed to be yesterday, 23:59.
3422 Also, timestamps inserted in capture templates follow this rule.
3424 IMPORTANT: This is a feature whose implementation is and likely will
3425 remain incomplete. Really, it is only here because past midnight seems to
3426 be the favorite working time of John Wiegley :-)"
3430 (defcustom org-use-effective-time nil
3431 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3432 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3433 \"effective time\" of any timestamps between midnight and 8am will be
3434 23:59 of the previous day."
3439 (defcustom org-use-last-clock-out-time-as-effective-time nil
3440 "When non-nil, use the last clock out time for `org-todo'.
3441 Note that this option has precedence over the combined use of
3442 `org-use-effective-time' and `org-extend-today-until'."
3445 :package-version
'(Org .
"8.0")
3448 (defcustom org-edit-timestamp-down-means-later nil
3449 "Non-nil means S-down will increase the time in a time stamp.
3450 When nil, S-up will increase."
3454 (defcustom org-calendar-follow-timestamp-change t
3455 "Non-nil means make the calendar window follow timestamp changes.
3456 When a timestamp is modified and the calendar window is visible, it will be
3457 moved to the new date."
3461 (defgroup org-tags nil
3462 "Options concerning tags in Org-mode."
3466 (defcustom org-tag-alist nil
3467 "List of tags allowed in Org-mode files.
3468 When this list is nil, Org-mode will base TAG input on what is already in the
3470 The value of this variable is an alist, the car of each entry must be a
3471 keyword as a string, the cdr may be a character that is used to select
3472 that tag through the fast-tag-selection interface.
3473 See the manual for details."
3477 (cons (string :tag
"Tag name")
3478 (character :tag
"Access char"))
3479 (list :tag
"Start radio group"
3481 (option (string :tag
"Group description")))
3482 (list :tag
"Start tag group, non distinct"
3483 (const :startgrouptag
)
3484 (option (string :tag
"Group description")))
3485 (list :tag
"Group tags delimiter"
3487 (list :tag
"End radio group"
3489 (option (string :tag
"Group description")))
3490 (list :tag
"End tag group, non distinct"
3491 (const :endgrouptag
)
3492 (option (string :tag
"Group description")))
3493 (const :tag
"New line" (:newline
)))))
3495 (defcustom org-tag-persistent-alist nil
3496 "List of tags that will always appear in all Org-mode files.
3497 This is in addition to any in buffer settings or customizations
3499 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3500 The value of this variable is an alist, the car of each entry must be a
3501 keyword as a string, the cdr may be a character that is used to select
3502 that tag through the fast-tag-selection interface.
3503 See the manual for details.
3504 To disable these tags on a per-file basis, insert anywhere in the file:
3509 (cons (string :tag
"Tag name")
3510 (character :tag
"Access char"))
3511 (const :tag
"Start radio group" (:startgroup
))
3512 (const :tag
"Group tags delimiter" (:grouptags
))
3513 (const :tag
"End radio group" (:endgroup
))
3514 (const :tag
"New line" (:newline
)))))
3516 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3517 "If non-nil, always offer completion for all tags of all agenda files.
3518 Instead of customizing this variable directly, you might want to
3519 set it locally for capture buffers, because there no list of
3520 tags in that file can be created dynamically (there are none).
3522 (add-hook 'org-capture-mode-hook
3524 (set (make-local-variable
3525 'org-complete-tags-always-offer-all-agenda-tags)
3531 (defvar org-file-tags nil
3532 "List of tags that can be inherited by all entries in the file.
3533 The tags will be inherited if the variable `org-use-tag-inheritance'
3534 says they should be.
3535 This variable is populated from #+FILETAGS lines.")
3537 (defcustom org-use-fast-tag-selection
'auto
3538 "Non-nil means use fast tag selection scheme.
3539 This is a special interface to select and deselect tags with single keys.
3540 When nil, fast selection is never used.
3541 When the symbol `auto', fast selection is used if and only if selection
3542 characters for tags have been configured, either through the variable
3543 `org-tag-alist' or through a #+TAGS line in the buffer.
3544 When t, fast selection is always used and selection keys are assigned
3545 automatically if necessary."
3548 (const :tag
"Always" t
)
3549 (const :tag
"Never" nil
)
3550 (const :tag
"When selection characters are configured" auto
)))
3552 (defcustom org-fast-tag-selection-single-key nil
3553 "Non-nil means fast tag selection exits after first change.
3554 When nil, you have to press RET to exit it.
3555 During fast tag selection, you can toggle this flag with `C-c'.
3556 This variable can also have the value `expert'. In this case, the window
3557 displaying the tags menu is not even shown, until you press C-c again."
3560 (const :tag
"No" nil
)
3561 (const :tag
"Yes" t
)
3562 (const :tag
"Expert" expert
)))
3564 (defvar org-fast-tag-selection-include-todo nil
3565 "Non-nil means fast tags selection interface will also offer TODO states.
3566 This is an undocumented feature, you should not rely on it.")
3568 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3569 "The column to which tags should be indented in a headline.
3570 If this number is positive, it specifies the column. If it is negative,
3571 it means that the tags should be flushright to that column. For example,
3572 -80 works well for a normal 80 character screen.
3573 When 0, place tags directly after headline text, with only one space in
3578 (defcustom org-auto-align-tags t
3579 "Non-nil keeps tags aligned when modifying headlines.
3580 Some operations (i.e. demoting) change the length of a headline and
3581 therefore shift the tags around. With this option turned on, after
3582 each such operation the tags are again aligned to `org-tags-column'."
3586 (defcustom org-use-tag-inheritance t
3587 "Non-nil means tags in levels apply also for sublevels.
3588 When nil, only the tags directly given in a specific line apply there.
3589 This may also be a list of tags that should be inherited, or a regexp that
3590 matches tags that should be inherited. Additional control is possible
3591 with the variable `org-tags-exclude-from-inheritance' which gives an
3592 explicit list of tags to be excluded from inheritance, even if the value of
3593 `org-use-tag-inheritance' would select it for inheritance.
3595 If this option is t, a match early-on in a tree can lead to a large
3596 number of matches in the subtree when constructing the agenda or creating
3597 a sparse tree. If you only want to see the first match in a tree during
3598 a search, check out the variable `org-tags-match-list-sublevels'."
3601 (const :tag
"Not" nil
)
3602 (const :tag
"Always" t
)
3603 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3604 (regexp :tag
"Tags matched by regexp")))
3606 (defcustom org-tags-exclude-from-inheritance nil
3607 "List of tags that should never be inherited.
3608 This is a way to exclude a few tags from inheritance. For way to do
3609 the opposite, to actively allow inheritance for selected tags,
3610 see the variable `org-use-tag-inheritance'."
3612 :type
'(repeat (string :tag
"Tag")))
3614 (defun org-tag-inherit-p (tag)
3615 "Check if TAG is one that should be inherited."
3617 ((member tag org-tags-exclude-from-inheritance
) nil
)
3618 ((eq org-use-tag-inheritance t
) t
)
3619 ((not org-use-tag-inheritance
) nil
)
3620 ((stringp org-use-tag-inheritance
)
3621 (string-match org-use-tag-inheritance tag
))
3622 ((listp org-use-tag-inheritance
)
3623 (member tag org-use-tag-inheritance
))
3624 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3626 (defcustom org-tags-match-list-sublevels t
3627 "Non-nil means list also sublevels of headlines matching a search.
3628 This variable applies to tags/property searches, and also to stuck
3629 projects because this search is based on a tags match as well.
3631 When set to the symbol `indented', sublevels are indented with
3634 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3635 the sublevels of a headline matching a tag search often also match
3636 the same search. Listing all of them can create very long lists.
3637 Setting this variable to nil causes subtrees of a match to be skipped.
3639 This variable is semi-obsolete and probably should always be true. It
3640 is better to limit inheritance to certain tags using the variables
3641 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3644 (const :tag
"No, don't list them" nil
)
3645 (const :tag
"Yes, do list them" t
)
3646 (const :tag
"List them, indented with leading dots" indented
)))
3648 (defcustom org-tags-sort-function nil
3649 "When set, tags are sorted using this function as a comparator."
3652 (const :tag
"No sorting" nil
)
3653 (const :tag
"Alphabetical" string
<)
3654 (const :tag
"Reverse alphabetical" string
>)
3655 (function :tag
"Custom function" nil
)))
3657 (defvar org-tags-history nil
3658 "History of minibuffer reads for tags.")
3659 (defvar org-last-tags-completion-table nil
3660 "The last used completion table for tags.")
3661 (defvar org-after-tags-change-hook nil
3662 "Hook that is run after the tags in a line have changed.")
3664 (defgroup org-properties nil
3665 "Options concerning properties in Org-mode."
3666 :tag
"Org Properties"
3669 (defcustom org-property-format
"%-10s %s"
3670 "How property key/value pairs should be formatted by `indent-line'.
3671 When `indent-line' hits a property definition, it will format the line
3672 according to this format, mainly to make sure that the values are
3673 lined-up with respect to each other."
3674 :group
'org-properties
3677 (defcustom org-properties-postprocess-alist nil
3678 "Alist of properties and functions to adjust inserted values.
3679 Elements of this alist must be of the form
3681 ([string] [function])
3683 where [string] must be a property name and [function] must be a
3684 lambda expression: this lambda expression must take one argument,
3685 the value to adjust, and return the new value as a string.
3687 For example, this element will allow the property \"Remaining\"
3688 to be updated wrt the relation between the \"Effort\" property
3689 and the clock summary:
3691 ((\"Remaining\" (lambda(value)
3692 (let ((clocksum (org-clock-sum-current-item))
3693 (effort (org-duration-string-to-minutes
3694 (org-entry-get (point) \"Effort\"))))
3695 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3696 :group
'org-properties
3698 :type
'(alist :key-type
(string :tag
"Property")
3699 :value-type
(function :tag
"Function")))
3701 (defcustom org-use-property-inheritance nil
3702 "Non-nil means properties apply also for sublevels.
3704 This setting is chiefly used during property searches. Turning it on can
3705 cause significant overhead when doing a search, which is why it is not
3708 When nil, only the properties directly given in the current entry count.
3709 When t, every property is inherited. The value may also be a list of
3710 properties that should have inheritance, or a regular expression matching
3711 properties that should be inherited.
3713 However, note that some special properties use inheritance under special
3714 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3715 and the properties ending in \"_ALL\" when they are used as descriptor
3716 for valid values of a property.
3718 Note for programmers:
3719 When querying an entry with `org-entry-get', you can control if inheritance
3720 should be used. By default, `org-entry-get' looks only at the local
3721 properties. You can request inheritance by setting the inherit argument
3722 to t (to force inheritance) or to `selective' (to respect the setting
3724 :group
'org-properties
3726 (const :tag
"Not" nil
)
3727 (const :tag
"Always" t
)
3728 (repeat :tag
"Specific properties" (string :tag
"Property"))
3729 (regexp :tag
"Properties matched by regexp")))
3731 (defun org-property-inherit-p (property)
3732 "Check if PROPERTY is one that should be inherited."
3734 ((eq org-use-property-inheritance t
) t
)
3735 ((not org-use-property-inheritance
) nil
)
3736 ((stringp org-use-property-inheritance
)
3737 (string-match org-use-property-inheritance property
))
3738 ((listp org-use-property-inheritance
)
3739 (member property org-use-property-inheritance
))
3740 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3742 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3743 "The default column format, if no other format has been defined.
3744 This variable can be set on the per-file basis by inserting a line
3746 #+COLUMNS: %25ITEM ....."
3747 :group
'org-properties
3750 (defcustom org-columns-ellipses
".."
3751 "The ellipses to be used when a field in column view is truncated.
3752 When this is the empty string, as many characters as possible are shown,
3753 but then there will be no visual indication that the field has been truncated.
3754 When this is a string of length N, the last N characters of a truncated
3755 field are replaced by this string. If the column is narrower than the
3756 ellipses string, only part of the ellipses string will be shown."
3757 :group
'org-properties
3760 (defcustom org-columns-modify-value-for-display-function nil
3761 "Function that modifies values for display in column view.
3762 For example, it can be used to cut out a certain part from a time stamp.
3763 The function must take 2 arguments:
3765 column-title The title of the column (*not* the property name)
3766 value The value that should be modified.
3768 The function should return the value that should be displayed,
3769 or nil if the normal value should be used."
3770 :group
'org-properties
3771 :type
'(choice (const nil
) (function)))
3773 (defconst org-global-properties-fixed
3774 '(("VISIBILITY_ALL" .
"folded children content all")
3775 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3776 "List of property/value pairs that can be inherited by any entry.
3778 These are fixed values, for the preset properties. The user variable
3779 that can be used to add to this list is `org-global-properties'.
3781 The entries in this list are cons cells where the car is a property
3782 name and cdr is a string with the value. If the value represents
3783 multiple items like an \"_ALL\" property, separate the items by
3786 (defcustom org-global-properties nil
3787 "List of property/value pairs that can be inherited by any entry.
3789 This list will be combined with the constant `org-global-properties-fixed'.
3791 The entries in this list are cons cells where the car is a property
3792 name and cdr is a string with the value.
3794 You can set buffer-local values for the same purpose in the variable
3795 `org-file-properties' this by adding lines like
3797 #+PROPERTY: NAME VALUE"
3798 :group
'org-properties
3800 (cons (string :tag
"Property")
3801 (string :tag
"Value"))))
3803 (defvar org-file-properties nil
3804 "List of property/value pairs that can be inherited by any entry.
3805 Valid for the current buffer.
3806 This variable is populated from #+PROPERTY lines.")
3807 (make-variable-buffer-local 'org-file-properties
)
3809 (defgroup org-agenda nil
3810 "Options concerning agenda views in Org-mode."
3814 (defvar org-category nil
3815 "Variable used by org files to set a category for agenda display.
3816 Such files should use a file variable to set it, for example
3818 # -*- mode: org; org-category: \"ELisp\"
3820 or contain a special line
3824 If the file does not specify a category, then file's base name
3826 (make-variable-buffer-local 'org-category
)
3827 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3829 (defcustom org-agenda-files nil
3830 "The files to be used for agenda display.
3831 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3832 \\[org-remove-file]. You can also use customize to edit the list.
3834 If an entry is a directory, all files in that directory that are matched by
3835 `org-agenda-file-regexp' will be part of the file list.
3837 If the value of the variable is not a list but a single file name, then
3838 the list of agenda files is actually stored and maintained in that file, one
3839 agenda file per line. In this file paths can be given relative to
3840 `org-directory'. Tilde expansion and environment variable substitution
3844 (repeat :tag
"List of files and directories" file
)
3845 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3847 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3848 "Regular expression to match files for `org-agenda-files'.
3849 If any element in the list in that variable contains a directory instead
3850 of a normal file, all files in that directory that are matched by this
3851 regular expression will be included."
3855 (defcustom org-agenda-text-search-extra-files nil
3856 "List of extra files to be searched by text search commands.
3857 These files will be searched in addition to the agenda files by the
3858 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3859 Note that these files will only be searched for text search commands,
3860 not for the other agenda views like todo lists, tag searches or the weekly
3861 agenda. This variable is intended to list notes and possibly archive files
3862 that should also be searched by these two commands.
3863 In fact, if the first element in the list is the symbol `agenda-archives',
3864 then all archive files of all agenda files will be added to the search
3867 :type
'(set :greedy t
3868 (const :tag
"Agenda Archives" agenda-archives
)
3869 (repeat :inline t
(file))))
3871 (org-defvaralias 'org-agenda-multi-occur-extra-files
3872 'org-agenda-text-search-extra-files
)
3874 (defcustom org-agenda-skip-unavailable-files nil
3875 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3876 A nil value means to remove them, after a query, from the list."
3880 (defcustom org-calendar-to-agenda-key
[?c
]
3881 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3882 The command `org-calendar-goto-agenda' will be bound to this key. The
3883 default is the character `c' because then `c' can be used to switch back and
3884 forth between agenda and calendar."
3888 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3889 "The key to be installed in `calendar-mode-map' for adding diary entries.
3890 This option is irrelevant until `org-agenda-diary-file' has been configured
3891 to point to an Org-mode file. When that is the case, the command
3892 `org-agenda-diary-entry' will be bound to the key given here, by default
3893 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3894 if you want to continue doing this, you need to change this to a different
3899 (defcustom org-agenda-diary-file
'diary-file
3900 "File to which to add new entries with the `i' key in agenda and calendar.
3901 When this is the symbol `diary-file', the functionality in the Emacs
3902 calendar will be used to add entries to the `diary-file'. But when this
3903 points to a file, `org-agenda-diary-entry' will be used instead."
3906 (const :tag
"The standard Emacs diary file" diary-file
)
3907 (file :tag
"Special Org file diary entries")))
3909 (eval-after-load "calendar"
3911 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3912 'org-calendar-goto-agenda
)
3913 (add-hook 'calendar-mode-hook
3915 (unless (eq org-agenda-diary-file
'diary-file
)
3916 (define-key calendar-mode-map
3917 org-calendar-insert-diary-entry-key
3918 'org-agenda-diary-entry
))))))
3920 (defgroup org-latex nil
3921 "Options for embedding LaTeX code into Org-mode."
3925 (defcustom org-format-latex-options
3926 '(:foreground default
:background default
:scale
1.0
3927 :html-foreground
"Black" :html-background
"Transparent"
3928 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3929 "Options for creating images from LaTeX fragments.
3930 This is a property list with the following properties:
3931 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3932 `default' means use the foreground of the default face.
3933 `auto' means use the foreground from the text face.
3934 :background the background color, or \"Transparent\".
3935 `default' means use the background of the default face.
3936 `auto' means use the background from the text face.
3937 :scale a scaling factor for the size of the images, to get more pixels
3938 :html-foreground, :html-background, :html-scale
3939 the same numbers for HTML export.
3940 :matchers a list indicating which matchers should be used to
3941 find LaTeX fragments. Valid members of this list are:
3942 \"begin\" find environments
3943 \"$1\" find single characters surrounded by $.$
3944 \"$\" find math expressions surrounded by $...$
3945 \"$$\" find math expressions surrounded by $$....$$
3946 \"\\(\" find math expressions surrounded by \\(...\\)
3947 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3951 (defcustom org-format-latex-signal-error t
3952 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3953 When nil, just push out a message."
3958 (defcustom org-latex-to-mathml-jar-file nil
3959 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3960 Use this to specify additional executable file say a jar file.
3962 When using MathToWeb as the converter, specify the full-path to
3963 your mathtoweb.jar file."
3967 (const :tag
"None" nil
)
3968 (file :tag
"JAR file" :must-match t
)))
3970 (defcustom org-latex-to-mathml-convert-command nil
3971 "Command to convert LaTeX fragments to MathML.
3972 Replace format-specifiers in the command as noted below and use
3973 `shell-command' to convert LaTeX to MathML.
3974 %j: Executable file in fully expanded form as specified by
3975 `org-latex-to-mathml-jar-file'.
3976 %I: Input LaTeX file in fully expanded form.
3977 %i: The latex fragment to be converted.
3978 %o: Output MathML file.
3979 This command is used by `org-create-math-formula'.
3981 When using MathToWeb as the converter, set this to
3982 \"java -jar %j -unicode -force -df %o %I\".
3984 When using LaTeXML set this 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%%" (/ (* 100.0 (point)) (buffer-size))))
4553 (beginning-of-line 1)
4554 (when (and (looking-at org-table-line-regexp
)
4555 ;; Exclude tables in src/example/verbatim/clocktable blocks
4556 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4557 (save-excursion (funcall function
))
4558 (or (looking-at org-table-line-regexp
)
4560 (re-search-forward org-table-any-border-regexp nil
1))))
4561 (unless quietly
(message "Mapping tables: done")))
4563 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock" (beg end
))
4564 (declare-function org-clock-update-mode-line
"org-clock" ())
4565 (declare-function org-resolve-clocks
"org-clock"
4566 (&optional also-non-dangling-p prompt last-valid
))
4568 (defun org-at-TBLFM-p (&optional pos
)
4569 "Non-nil when point (or POS) is in #+TBLFM line."
4571 (goto-char (or pos
(point)))
4573 (and (let ((case-fold-search t
)) (looking-at org-TBLFM-regexp
))
4574 (eq (org-element-type (org-element-at-point)) 'table
))))
4576 (defvar org-clock-start-time
)
4577 (defvar org-clock-marker
(make-marker)
4578 "Marker recording the last clock-in.")
4579 (defvar org-clock-hd-marker
(make-marker)
4580 "Marker recording the last clock-in, but the headline position.")
4581 (defvar org-clock-heading
""
4582 "The heading of the current clock entry.")
4583 (defun org-clock-is-active ()
4584 "Return the buffer where the clock is currently running.
4585 Return nil if no clock is running."
4586 (marker-buffer org-clock-marker
))
4588 (defun org-check-running-clock ()
4589 "Check if the current buffer contains the running clock.
4590 If yes, offer to stop it and to save the buffer with the changes."
4591 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
4592 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4595 (when (y-or-n-p "Save changed buffer?")
4598 (defun org-clocktable-try-shift (dir n
)
4599 "Check if this line starts a clock table, if yes, shift the time block."
4600 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4601 (org-clocktable-shift dir n
)))
4604 (defun org-clock-persistence-insinuate ()
4605 "Set up hooks for clock persistence."
4606 (require 'org-clock
)
4607 (add-hook 'org-mode-hook
'org-clock-load
)
4608 (add-hook 'kill-emacs-hook
'org-clock-save
))
4610 (defgroup org-archive nil
4611 "Options concerning archiving in Org-mode."
4613 :group
'org-structure
)
4615 (defcustom org-archive-location
"%s_archive::"
4616 "The location where subtrees should be archived.
4618 The value of this variable is a string, consisting of two parts,
4619 separated by a double-colon. The first part is a filename and
4620 the second part is a headline.
4622 When the filename is omitted, archiving happens in the same file.
4623 %s in the filename will be replaced by the current file
4624 name (without the directory part). Archiving to a different file
4625 is useful to keep archived entries from contributing to the
4628 The archived entries will be filed as subtrees of the specified
4629 headline. When the headline is omitted, the subtrees are simply
4630 filed away at the end of the file, as top-level entries. Also in
4631 the heading you can use %s to represent the file name, this can be
4632 useful when using the same archive for a number of different files.
4634 Here are a few examples:
4636 If the current file is Projects.org, archive in file
4637 Projects.org_archive, as top-level trees. This is the default.
4639 \"::* Archived Tasks\"
4640 Archive in the current file, under the top-level headline
4641 \"* Archived Tasks\".
4643 \"~/org/archive.org::\"
4644 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4646 \"~/org/archive.org::* From %s\"
4647 Archive in file ~/org/archive.org (absolute path), under headlines
4648 \"From FILENAME\" where file name is the current file name.
4650 \"~/org/datetree.org::datetree/* Finished Tasks\"
4651 The \"datetree/\" string is special, signifying to archive
4652 items to the datetree. Items are placed in either the CLOSED
4653 date of the item, or the current date if there is no CLOSED date.
4654 The heading will be a subentry to the current date. There doesn't
4655 need to be a heading, but there always needs to be a slash after
4656 datetree. For example, to store archived items directly in the
4657 datetree, use \"~/org/datetree.org::datetree/\".
4659 \"basement::** Finished Tasks\"
4660 Archive in file ./basement (relative path), as level 3 trees
4661 below the level 2 heading \"** Finished Tasks\".
4663 You may set this option on a per-file basis by adding to the buffer a
4666 #+ARCHIVE: basement::** Finished Tasks
4668 You may also define it locally for a subtree by setting an ARCHIVE property
4669 in the entry. If such a property is found in an entry, or anywhere up
4670 the hierarchy, it will be used."
4674 (defcustom org-agenda-skip-archived-trees t
4675 "Non-nil means the agenda will skip any items located in archived trees.
4676 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4677 variable is no longer recommended, you should leave it at the value t.
4678 Instead, use the key `v' to cycle the archives-mode in the agenda."
4680 :group
'org-agenda-skip
4683 (defcustom org-columns-skip-archived-trees t
4684 "Non-nil means ignore archived trees when creating column view."
4686 :group
'org-properties
4689 (defcustom org-cycle-open-archived-trees nil
4690 "Non-nil means `org-cycle' will open archived trees.
4691 An archived tree is a tree marked with the tag ARCHIVE.
4692 When nil, archived trees will stay folded. You can still open them with
4693 normal outline commands like `show-all', but not with the cycling commands."
4698 (defcustom org-sparse-tree-open-archived-trees nil
4699 "Non-nil means sparse tree construction shows matches in archived trees.
4700 When nil, matches in these trees are highlighted, but the trees are kept in
4703 :group
'org-sparse-trees
4706 (defcustom org-sparse-tree-default-date-type nil
4707 "The default date type when building a sparse tree.
4708 When this is nil, a date is a scheduled or a deadline timestamp.
4709 Otherwise, these types are allowed:
4712 active: only active timestamps (<...>)
4713 inactive: only inactive timestamps ([...])
4714 scheduled: only scheduled timestamps
4715 deadline: only deadline timestamps"
4716 :type
'(choice (const :tag
"Scheduled or deadline" nil
)
4717 (const :tag
"All timestamps" all
)
4718 (const :tag
"Only active timestamps" active
)
4719 (const :tag
"Only inactive timestamps" inactive
)
4720 (const :tag
"Only scheduled timestamps" scheduled
)
4721 (const :tag
"Only deadline timestamps" deadline
)
4722 (const :tag
"Only closed timestamps" closed
))
4724 :package-version
'(Org .
"8.3")
4725 :group
'org-sparse-trees
)
4727 (defun org-cycle-hide-archived-subtrees (state)
4728 "Re-hide all archived subtrees after a visibility state change."
4729 (when (and (not org-cycle-open-archived-trees
)
4730 (not (memq state
'(overview folded
))))
4732 (let* ((globalp (memq state
'(contents all
)))
4733 (beg (if globalp
(point-min) (point)))
4734 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4735 (org-hide-archived-subtrees beg end
)
4737 (if (looking-at (concat ".*:" org-archive-tag
":"))
4738 (message "%s" (substitute-command-keys
4739 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4741 (defun org-force-cycle-archived ()
4742 "Cycle subtree even if it is archived."
4744 (setq this-command
'org-cycle
)
4745 (let ((org-cycle-open-archived-trees t
))
4746 (call-interactively 'org-cycle
)))
4748 (defun org-hide-archived-subtrees (beg end
)
4749 "Re-hide all archived subtrees after a visibility state change."
4750 (org-with-wide-buffer
4751 (let ((case-fold-search nil
)
4752 (re (concat org-outline-regexp-bol
".*:" org-archive-tag
":")))
4754 (while (and (< (point) end
) (re-search-forward re end t
))
4755 (when (member org-archive-tag
(org-get-tags))
4756 (org-flag-subtree t
)
4757 (org-end-of-subtree t
))))))
4759 (declare-function outline-end-of-heading
"outline" ())
4760 (declare-function outline-flag-region
"outline" (from to flag
))
4761 (defun org-flag-subtree (flag)
4763 (org-back-to-heading t
)
4764 (outline-end-of-heading)
4765 (outline-flag-region (point)
4766 (progn (org-end-of-subtree t
) (point))
4769 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4771 ;; Declare Column View Code
4773 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4774 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4775 (declare-function org-columns-compute
"org-colview" (property))
4779 (declare-function org-id-store-link
"org-id")
4780 (declare-function org-id-locations-load
"org-id")
4781 (declare-function org-id-locations-save
"org-id")
4782 (defvar org-id-track-globally
)
4784 ;;; Variables for pre-computed regular expressions, all buffer local
4786 (defvar org-todo-regexp nil
4787 "Matches any of the TODO state keywords.")
4788 (make-variable-buffer-local 'org-todo-regexp
)
4789 (defvar org-not-done-regexp nil
4790 "Matches any of the TODO state keywords except the last one.")
4791 (make-variable-buffer-local 'org-not-done-regexp
)
4792 (defvar org-not-done-heading-regexp nil
4793 "Matches a TODO headline that is not done.")
4794 (make-variable-buffer-local 'org-not-done-heading-regexp
)
4795 (defvar org-todo-line-regexp nil
4796 "Matches a headline and puts TODO state into group 2 if present.")
4797 (make-variable-buffer-local 'org-todo-line-regexp
)
4798 (defvar org-complex-heading-regexp nil
4799 "Matches a headline and puts everything into groups:
4801 group 2: The todo keyword, maybe
4802 group 3: Priority cookie
4803 group 4: True headline
4805 (make-variable-buffer-local 'org-complex-heading-regexp
)
4806 (defvar org-complex-heading-regexp-format nil
4807 "Printf format to make regexp to match an exact headline.
4808 This regexp will match the headline of any node which has the
4809 exact headline text that is put into the format, but may have any
4810 TODO state, priority and tags.")
4811 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4812 (defvar org-todo-line-tags-regexp nil
4813 "Matches a headline and puts TODO state into group 2 if present.
4814 Also put tags into group 4 if tags are present.")
4815 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4817 (defconst org-plain-time-of-day-regexp
4820 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4823 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4825 "Regular expression to match a plain time or time range.
4826 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4827 groups carry important information:
4829 1 the first time, range or not
4830 8 the second time, if it is a range.")
4832 (defconst org-plain-time-extension-regexp
4835 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4836 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4837 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4838 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4839 groups carry important information:
4842 9 minutes of duration")
4844 (defconst org-stamp-time-of-day-regexp
4846 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4847 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4849 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4850 "Regular expression to match a timestamp time or time range.
4851 After a match, the following groups carry important information:
4853 1 date plus weekday, for back referencing to make sure both times are on the same day
4854 2 the first time, range or not
4855 4 the second time, if it is a range.")
4857 (defconst org-startup-options
4858 '(("fold" org-startup-folded t
)
4859 ("overview" org-startup-folded t
)
4860 ("nofold" org-startup-folded nil
)
4861 ("showall" org-startup-folded nil
)
4862 ("showeverything" org-startup-folded showeverything
)
4863 ("content" org-startup-folded content
)
4864 ("indent" org-startup-indented t
)
4865 ("noindent" org-startup-indented nil
)
4866 ("hidestars" org-hide-leading-stars t
)
4867 ("showstars" org-hide-leading-stars nil
)
4868 ("odd" org-odd-levels-only t
)
4869 ("oddeven" org-odd-levels-only nil
)
4870 ("align" org-startup-align-all-tables t
)
4871 ("noalign" org-startup-align-all-tables nil
)
4872 ("inlineimages" org-startup-with-inline-images t
)
4873 ("noinlineimages" org-startup-with-inline-images nil
)
4874 ("latexpreview" org-startup-with-latex-preview t
)
4875 ("nolatexpreview" org-startup-with-latex-preview nil
)
4876 ("customtime" org-display-custom-times t
)
4877 ("logdone" org-log-done time
)
4878 ("lognotedone" org-log-done note
)
4879 ("nologdone" org-log-done nil
)
4880 ("lognoteclock-out" org-log-note-clock-out t
)
4881 ("nolognoteclock-out" org-log-note-clock-out nil
)
4882 ("logrepeat" org-log-repeat state
)
4883 ("lognoterepeat" org-log-repeat note
)
4884 ("logdrawer" org-log-into-drawer t
)
4885 ("nologdrawer" org-log-into-drawer nil
)
4886 ("logstatesreversed" org-log-states-order-reversed t
)
4887 ("nologstatesreversed" org-log-states-order-reversed nil
)
4888 ("nologrepeat" org-log-repeat nil
)
4889 ("logreschedule" org-log-reschedule time
)
4890 ("lognotereschedule" org-log-reschedule note
)
4891 ("nologreschedule" org-log-reschedule nil
)
4892 ("logredeadline" org-log-redeadline time
)
4893 ("lognoteredeadline" org-log-redeadline note
)
4894 ("nologredeadline" org-log-redeadline nil
)
4895 ("logrefile" org-log-refile time
)
4896 ("lognoterefile" org-log-refile note
)
4897 ("nologrefile" org-log-refile nil
)
4898 ("fninline" org-footnote-define-inline t
)
4899 ("nofninline" org-footnote-define-inline nil
)
4900 ("fnlocal" org-footnote-section nil
)
4901 ("fnauto" org-footnote-auto-label t
)
4902 ("fnprompt" org-footnote-auto-label nil
)
4903 ("fnconfirm" org-footnote-auto-label confirm
)
4904 ("fnplain" org-footnote-auto-label plain
)
4905 ("fnadjust" org-footnote-auto-adjust t
)
4906 ("nofnadjust" org-footnote-auto-adjust nil
)
4907 ("constcgs" constants-unit-system cgs
)
4908 ("constSI" constants-unit-system SI
)
4909 ("noptag" org-tag-persistent-alist nil
)
4910 ("hideblocks" org-hide-block-startup t
)
4911 ("nohideblocks" org-hide-block-startup nil
)
4912 ("beamer" org-startup-with-beamer-mode t
)
4913 ("entitiespretty" org-pretty-entities t
)
4914 ("entitiesplain" org-pretty-entities nil
))
4915 "Variable associated with STARTUP options for org-mode.
4916 Each element is a list of three items: the startup options (as written
4917 in the #+STARTUP line), the corresponding variable, and the value to set
4918 this variable to if the option is found. An optional forth element PUSH
4919 means to push this value onto the list in the variable.")
4921 (defcustom org-group-tags t
4922 "When non-nil (the default), use group tags.
4923 This can be turned on/off through `org-toggle-tags-groups'."
4928 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4930 (defun org-toggle-tags-groups ()
4931 "Toggle support for group tags.
4932 Support for group tags is controlled by the option
4933 `org-group-tags', which is non-nil by default."
4935 (setq org-group-tags
(not org-group-tags
))
4936 (cond ((and (derived-mode-p 'org-agenda-mode
)
4939 ((derived-mode-p 'org-mode
)
4940 (let ((org-inhibit-startup t
)) (org-mode))))
4941 (message "Groups tags support has been turned %s"
4942 (if org-group-tags
"on" "off")))
4944 (defun org-set-regexps-and-options (&optional tags-only
)
4945 "Precompute regular expressions used in the current buffer.
4946 When optional argument TAGS-ONLY is non-nil, only compute tags
4947 related expressions."
4948 (when (derived-mode-p 'org-mode
)
4949 (let ((alist (org--setup-collect-keywords
4950 (org-make-options-regexp
4951 (append '("FILETAGS" "TAGS" "SETUPFILE")
4952 (and (not tags-only
)
4953 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4954 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4955 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4956 (org--setup-process-tags
4957 (cdr (assq 'tags alist
)) (cdr (assq 'filetags alist
)))
4960 (org-set-local 'org-file-properties
(cdr (assq 'property alist
)))
4961 ;; Archive location.
4962 (let ((archive (cdr (assq 'archive alist
))))
4963 (when archive
(org-set-local 'org-archive-location archive
)))
4965 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
4967 (org-set-local 'org-category
(intern cat
))
4968 (org-set-local 'org-file-properties
4969 (org--update-property-plist
4970 "CATEGORY" cat org-file-properties
))))
4972 (let ((column (cdr (assq 'columns alist
))))
4973 (when column
(org-set-local 'org-columns-default-format column
)))
4975 (setq org-table-formula-constants-local
(cdr (assq 'constants alist
)))
4976 ;; Link abbreviations.
4977 (let ((links (cdr (assq 'link alist
))))
4978 (when links
(setq org-link-abbrev-alist-local
(nreverse links
))))
4980 (let ((priorities (cdr (assq 'priorities alist
))))
4982 (org-set-local 'org-highest-priority
(nth 0 priorities
))
4983 (org-set-local 'org-lowest-priority
(nth 1 priorities
))
4984 (org-set-local 'org-default-priority
(nth 2 priorities
))))
4986 (let ((scripts (assq 'scripts alist
)))
4988 (org-set-local 'org-use-sub-superscripts
(cdr scripts
))))
4990 (let ((startup (cdr (assq 'startup alist
))))
4991 (dolist (option startup
)
4992 (let ((entry (assoc-string option org-startup-options t
)))
4994 (let ((var (nth 1 entry
))
4995 (val (nth 2 entry
)))
4996 (if (not (nth 3 entry
)) (org-set-local var val
)
4997 (unless (listp (symbol-value var
))
4998 (org-set-local var nil
))
4999 (add-to-list var val
)))))))
5001 (org-set-local 'org-todo-kwd-alist nil
)
5002 (org-set-local 'org-todo-key-alist nil
)
5003 (org-set-local 'org-todo-key-trigger nil
)
5004 (org-set-local 'org-todo-keywords-1 nil
)
5005 (org-set-local 'org-done-keywords nil
)
5006 (org-set-local 'org-todo-heads nil
)
5007 (org-set-local 'org-todo-sets nil
)
5008 (org-set-local 'org-todo-log-states nil
)
5009 (let ((todo-sequences
5010 (or (nreverse (cdr (assq 'todo alist
)))
5011 (let ((d (default-value 'org-todo-keywords
)))
5012 (if (not (stringp (car d
))) d
5013 ;; XXX: Backward compatibility code.
5014 (list (cons org-todo-interpretation d
)))))))
5015 (dolist (sequence todo-sequences
)
5016 (let* ((sequence (or (run-hook-with-args-until-success
5017 'org-todo-setup-filter-hook sequence
)
5019 (sequence-type (car sequence
))
5020 (keywords (cdr sequence
))
5021 (sep (member "|" keywords
))
5023 (dolist (k (remove "|" keywords
))
5024 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5026 (error "Invalid TODO keyword %s" k
))
5027 (let ((name (match-string 1 k
))
5028 (key (match-string 2 k
))
5029 (log (org-extract-log-state-settings k
)))
5031 (push (cons name
(and key
(string-to-char key
))) alist
)
5032 (when log
(push log org-todo-log-states
))))
5033 (let* ((names (nreverse names
))
5034 (done (if sep
(org-remove-keyword-keys (cdr sep
))
5037 (tail (list sequence-type head
(car done
) (org-last done
))))
5038 (add-to-list 'org-todo-heads head
'append
)
5039 (push names org-todo-sets
)
5040 (setq org-done-keywords
(append org-done-keywords done nil
))
5041 (setq org-todo-keywords-1
(append org-todo-keywords-1 names nil
))
5042 (setq org-todo-key-alist
5043 (append org-todo-key-alist
5045 (append '((:startgroup
))
5048 (dolist (k names
) (push (cons k tail
) org-todo-kwd-alist
))))))
5049 (setq org-todo-sets
(nreverse org-todo-sets
)
5050 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5051 org-todo-key-trigger
(delq nil
(mapcar #'cdr org-todo-key-alist
))
5052 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
))
5053 ;; Compute the regular expressions and other local variables.
5054 ;; Using `org-outline-regexp-bol' would complicate them much,
5055 ;; because of the fixed white space at the end of that string.
5056 (if (not org-done-keywords
)
5057 (setq org-done-keywords
5058 (and org-todo-keywords-1
(last org-todo-keywords-1
))))
5059 (setq org-not-done-keywords
5060 (org-delete-all org-done-keywords
5061 (copy-sequence org-todo-keywords-1
))
5062 org-todo-regexp
(regexp-opt org-todo-keywords-1 t
)
5063 org-not-done-regexp
(regexp-opt org-not-done-keywords t
)
5064 org-not-done-heading-regexp
5065 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5066 org-todo-line-regexp
5067 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5068 org-complex-heading-regexp
5069 (concat "^\\(\\*+\\)"
5070 "\\(?: +" org-todo-regexp
"\\)?"
5071 "\\(?: +\\(\\[#.\\]\\)\\)?"
5072 "\\(?: +\\(.*?\\)\\)??"
5073 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5075 org-complex-heading-regexp-format
5076 (concat "^\\(\\*+\\)"
5077 "\\(?: +" org-todo-regexp
"\\)?"
5078 "\\(?: +\\(\\[#.\\]\\)\\)?"
5080 ;; Stats cookies can be stuck to body.
5081 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5083 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5085 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5087 org-todo-line-tags-regexp
5088 (concat "^\\(\\*+\\)"
5089 "\\(?: +" org-todo-regexp
"\\)?"
5090 "\\(?: +\\(.*?\\)\\)??"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5093 (org-compute-latex-and-related-regexp)))))
5095 (defun org--setup-collect-keywords (regexp &optional files alist
)
5096 "Return setup keywords values as an alist.
5098 REGEXP matches a subset of setup keywords. FILES is a list of
5099 file names already visited. It is used to avoid circular setup
5100 files. ALIST, when non-nil, is the alist computed so far.
5102 Return value contains the following keys: `archive', `category',
5103 `columns', `constants', `filetags', `link', `priorities',
5104 `property', `scripts', `startup', `tags' and `todo'."
5105 (org-with-wide-buffer
5106 (goto-char (point-min))
5107 (let ((case-fold-search t
))
5108 (while (re-search-forward regexp nil t
)
5109 (let ((element (org-element-at-point)))
5110 (when (eq (org-element-type element
) 'keyword
)
5111 (let ((key (org-element-property :key element
))
5112 (value (org-element-property :value element
)))
5114 ((equal key
"ARCHIVE")
5115 (when (org-string-nw-p value
)
5116 (push (cons 'archive value
) alist
)))
5117 ((equal key
"CATEGORY") (push (cons 'category value
) alist
))
5118 ((equal key
"COLUMNS") (push (cons 'columns value
) alist
))
5119 ((equal key
"CONSTANTS")
5120 (let* ((constants (assq 'constants alist
))
5121 (store (cdr constants
)))
5122 (dolist (pair (org-split-string value
))
5123 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5125 (let* ((name (match-string 1 pair
))
5126 (value (match-string 2 pair
))
5127 (old (assoc name store
)))
5128 (if old
(setcdr old value
)
5129 (push (cons name value
) store
)))))
5130 (if constants
(setcdr constants store
)
5131 (push (cons 'constants store
) alist
))))
5132 ((equal key
"FILETAGS")
5133 (when (org-string-nw-p value
)
5134 (let ((old (assq 'filetags alist
))
5136 (mapcar (lambda (x) (org-split-string x
":"))
5137 (org-split-string value
)))))
5138 (if old
(setcdr old
(append new
(cdr old
)))
5139 (push (cons 'filetags new
) alist
)))))
5141 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5142 (let ((links (assq 'link alist
))
5143 (pair (cons (org-match-string-no-properties 1 value
)
5144 (org-match-string-no-properties 2 value
))))
5145 (if links
(push pair
(cdr links
))
5146 (push (list 'link pair
) alist
)))))
5147 ((equal key
"OPTIONS")
5148 (when (and (org-string-nw-p value
)
5149 (string-match "\\^:\\(t\\|nil\\|{}\\)" value
))
5150 (push (cons 'scripts
(read (match-string 1 value
))) alist
)))
5151 ((equal key
"PRIORITIES")
5152 (push (cons 'priorities
5153 (let ((prio (org-split-string value
)))
5154 (if (< (length prio
) 3) '(?A ?C ?B
)
5155 (mapcar #'string-to-char prio
))))
5157 ((equal key
"PROPERTY")
5158 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value
)
5159 (let* ((property (assq 'property alist
))
5160 (value (org--update-property-plist
5161 (org-match-string-no-properties 1 value
)
5162 (org-match-string-no-properties 2 value
)
5164 (if property
(setcdr property value
)
5165 (push (cons 'property value
) alist
)))))
5166 ((equal key
"STARTUP")
5167 (let ((startup (assq 'startup alist
)))
5170 (append (cdr startup
) (org-split-string value
)))
5171 (push (cons 'startup
(org-split-string value
)) alist
))))
5173 (let ((tag-cell (assq 'tags alist
)))
5176 (append (cdr tag-cell
)
5178 (org-split-string value
)))
5179 (push (cons 'tags
(org-split-string value
)) alist
))))
5180 ((member key
'("TODO" "SEQ_TODO" "TYP_TODO"))
5181 (let ((todo (assq 'todo alist
))
5182 (value (cons (if (equal key
"TYP_TODO") 'type
'sequence
)
5183 (org-split-string value
))))
5184 (if todo
(push value
(cdr todo
))
5185 (push (list 'todo value
) alist
))))
5186 ((equal key
"SETUPFILE")
5187 (unless buffer-read-only
; Do not check in Gnus messages.
5188 (let ((f (and (org-string-nw-p value
)
5190 (org-remove-double-quotes value
)))))
5191 (when (and f
(file-readable-p f
) (not (member f files
)))
5193 (insert-file-contents f
)
5195 ;; Fake Org mode to benefit from cache
5196 ;; without recurring needlessly.
5197 (let ((major-mode 'org-mode
))
5198 (org--setup-collect-keywords
5199 regexp
(cons f files
) alist
)))))))))))))))
5202 (defun org--setup-process-tags (tags filetags
)
5203 "Precompute variables used for tags.
5204 TAGS is a list of tags and tag group symbols, as strings.
5205 FILETAGS is a list of tags, as strings."
5206 ;; Process the file tags.
5207 (org-set-local 'org-file-tags
5208 (mapcar #'org-add-prop-inherited filetags
))
5209 ;; Provide default tags if no local tags are found.
5210 (when (and (not tags
) org-tag-alist
)
5212 (mapcar (lambda (tag)
5216 (:startgrouptag
"[")
5220 (otherwise (concat (car tag
)
5221 (and (characterp (cdr tag
))
5222 (format "(%c)" (cdr tag
)))))))
5224 ;; Process the tags.
5225 (org-set-local 'org-tag-groups-alist nil
)
5226 (org-set-local 'org-tag-alist nil
)
5229 (let ((e (car tags
)))
5230 (setq tags
(cdr tags
))
5233 (push '(:startgroup
) org-tag-alist
)
5234 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5236 (push '(:endgroup
) org-tag-alist
)
5237 (setq group-flag nil
))
5239 (push '(:startgrouptag
) org-tag-alist
)
5240 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5242 (push '(:endgrouptag
) org-tag-alist
)
5243 (setq group-flag nil
))
5245 (push '(:grouptags
) org-tag-alist
)
5246 (setq group-flag
'append
))
5247 ((equal e
"\\n") (push '(:newline
) org-tag-alist
))
5249 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5250 "\\|{.+?}\\)" ; regular expression
5251 "\\(?:(\\(.\\))\\)?\\'")) e
)
5252 (let ((tag (match-string 1 e
))
5253 (key (and (match-beginning 2)
5254 (string-to-char (match-string 2 e
)))))
5255 (cond ((eq group-flag
'append
)
5256 (setcar org-tag-groups-alist
5257 (append (car org-tag-groups-alist
) (list tag
))))
5258 (group-flag (push (list tag
) org-tag-groups-alist
)))
5259 ;; Push all tags in groups, no matter if they already exist.
5260 (unless (and (not group-flag
) (assoc tag org-tag-alist
))
5261 (push (cons tag key
) org-tag-alist
))))))))
5262 (setq org-tag-alist
(nreverse org-tag-alist
)))
5264 (defun org-file-contents (file &optional noerror
)
5265 "Return the contents of FILE, as a string."
5266 (if (and file
(file-readable-p file
))
5268 (insert-file-contents file
)
5270 (funcall (if noerror
'message
'error
)
5271 "Cannot read file \"%s\"%s"
5273 (let ((from (buffer-file-name (buffer-base-buffer))))
5274 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5276 (defun org-extract-log-state-settings (x)
5277 "Extract the log state setting from a TODO keyword string.
5278 This will extract info from a string like \"WAIT(w@/!)\"."
5279 (let (kw key log1 log2
)
5280 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5281 (setq kw
(match-string 1 x
)
5282 key
(and (match-end 2) (match-string 2 x
))
5283 log1
(and (match-end 3) (match-string 3 x
))
5284 log2
(and (match-end 4) (match-string 4 x
)))
5287 (and log1
(if (equal log1
"!") 'time
'note
))
5288 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5290 (defun org-remove-keyword-keys (list)
5291 "Remove a pair of parenthesis at the end of each string in LIST."
5293 (if (string-match "(.*)$" x
)
5294 (substring x
0 (match-beginning 0))
5298 (defun org-assign-fast-keys (alist)
5299 "Assign fast keys to a keyword-key alist.
5300 Respect keys that are already there."
5301 (let (new e
(alt ?
0))
5302 (while (setq e
(pop alist
))
5303 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5304 (cdr e
)) ;; Key already assigned.
5306 (let ((clist (string-to-list (downcase (car e
))))
5307 (used (append new alist
)))
5308 (when (= (car clist
) ?
@)
5310 (while (and clist
(rassoc (car clist
) used
))
5313 (while (rassoc alt used
)
5315 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5318 ;;; Some variables used in various places
5320 (defvar org-window-configuration nil
5321 "Used in various places to store a window configuration.")
5322 (defvar org-selected-window nil
5323 "Used in various places to store a window configuration.")
5324 (defvar org-finish-function nil
5325 "Function to be called when `C-c C-c' is used.
5326 This is for getting out of special buffers like capture.")
5329 ;; FIXME: Occasionally check by commenting these, to make sure
5330 ;; no other functions uses these, forgetting to let-bind them.
5331 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5332 (defvar org-last-state
)
5333 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5335 ;; Defined somewhere in this file, but used before definition.
5336 (defvar org-entities
) ;; defined in org-entities.el
5337 (defvar org-struct-menu
)
5338 (defvar org-org-menu
)
5339 (defvar org-tbl-menu
)
5341 ;;;; Define the Org-mode
5343 ;; We use a before-change function to check if a table might need
5345 (defvar org-table-may-need-update t
5346 "Indicates that a table might need an update.
5347 This variable is set by `org-before-change-function'.
5348 `org-table-align' sets it back to nil.")
5349 (defun org-before-change-function (beg end
)
5350 "Every change indicates that a table might need an update."
5351 (setq org-table-may-need-update t
))
5352 (defvar org-mode-map
)
5353 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5354 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5355 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5356 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5357 (defvar org-table-buffer-is-an nil
)
5359 (defvar bidi-paragraph-direction
)
5360 (defvar buffer-face-mode-face
)
5363 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5364 (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"))
5365 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5367 ;; Other stuff we need.
5368 (require 'time-date
)
5369 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5371 (autoload 'easy-menu-add
"easymenu")
5374 ;; (require 'org-macs) moved higher up in the file before it is first used
5375 (require 'org-entities
)
5376 ;; (require 'org-compat) moved higher up in the file before it is first used
5377 (require 'org-faces
)
5379 (require 'org-pcomplete
)
5381 (require 'org-footnote
)
5382 (require 'org-macro
)
5388 (define-derived-mode org-mode outline-mode
"Org"
5389 "Outline-based notes management and organizer, alias
5390 \"Carsten's outline-mode for keeping track of everything.\"
5392 Org-mode develops organizational tasks around a NOTES file which
5393 contains information about projects as plain text. Org-mode is
5394 implemented on top of outline-mode, which is ideal to keep the content
5395 of large files well structured. It supports ToDo items, deadlines and
5396 time stamps, which magically appear in the diary listing of the Emacs
5397 calendar. Tables are easily created with a built-in table editor.
5398 Plain text URL-like links connect to websites, emails (VM), Usenet
5399 messages (Gnus), BBDB entries, and any files related to the project.
5400 For printing and sharing of notes, an Org-mode file (or a part of it)
5401 can be exported as a structured ASCII or HTML file.
5403 The following commands are available:
5407 ;; Get rid of Outline menus, they are not needed
5408 ;; Need to do this here because define-derived-mode sets up
5409 ;; the keymap so late. Still, it is a waste to call this each time
5410 ;; we switch another buffer into org-mode.
5411 (if (featurep 'xemacs
)
5412 (when (boundp 'outline-mode-menu-heading
)
5413 ;; Assume this is Greg's port, it uses easymenu
5414 (easy-menu-remove outline-mode-menu-heading
)
5415 (easy-menu-remove outline-mode-menu-show
)
5416 (easy-menu-remove outline-mode-menu-hide
))
5417 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5418 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5419 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5421 (org-load-modules-maybe)
5422 (easy-menu-add org-org-menu
)
5423 (easy-menu-add org-tbl-menu
)
5424 (org-install-agenda-files-menu)
5425 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5426 (add-to-invisibility-spec '(org-cwidth))
5427 (add-to-invisibility-spec '(org-hide-block . t
))
5428 (when (featurep 'xemacs
)
5429 (org-set-local 'line-move-ignore-invisible t
))
5430 (org-set-local 'outline-regexp org-outline-regexp
)
5431 (org-set-local 'outline-level
'org-outline-level
)
5432 (setq bidi-paragraph-direction
'left-to-right
)
5433 (when (and org-ellipsis
5434 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5435 (fboundp 'make-glyph-code
))
5436 (unless org-display-table
5437 (setq org-display-table
(make-display-table)))
5438 (set-display-table-slot
5441 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5443 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5444 (setq buffer-display-table org-display-table
))
5445 (org-set-regexps-and-options)
5446 (org-set-font-lock-defaults)
5447 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5448 ;; tag faces set outside customize.... force initialization.
5449 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5451 (org-set-local 'calc-embedded-open-mode
"# ")
5452 ;; Modify a few syntax entries
5453 (modify-syntax-entry ?
@ "w")
5454 (modify-syntax-entry ?
\" "\"")
5455 (modify-syntax-entry ?
\\ "_")
5456 (modify-syntax-entry ?~
"_")
5457 (if org-startup-truncated
(setq truncate-lines t
))
5458 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5459 (org-set-local 'font-lock-unfontify-region-function
5460 'org-unfontify-region
)
5461 ;; Activate before-change-function
5462 (org-set-local 'org-table-may-need-update t
)
5463 (org-add-hook 'before-change-functions
'org-before-change-function nil
5465 ;; Check for running clock before killing a buffer
5466 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5467 ;; Initialize macros templates.
5468 (org-macro-initialize-templates)
5469 ;; Initialize radio targets.
5470 (org-update-radio-target-regexp)
5472 (org-set-local 'indent-line-function
'org-indent-line
)
5473 (org-set-local 'indent-region-function
'org-indent-region
)
5474 ;; Filling and auto-filling.
5477 (org-setup-comments-handling)
5478 ;; Initialize cache.
5479 (org-element-cache-reset)
5480 ;; Beginning/end of defun
5481 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5482 (org-set-local 'end-of-defun-function
5484 (if (not (org-at-heading-p))
5485 (org-forward-element)
5486 (org-forward-element)
5487 (forward-char -
1))))
5488 ;; Next error for sparse trees
5489 (org-set-local 'next-error-function
'org-occur-next-match
)
5490 ;; Make sure dependence stuff works reliably, even for users who set it
5492 (if org-enforce-todo-dependencies
5493 (add-hook 'org-blocker-hook
5494 'org-block-todo-from-children-or-siblings-or-parent
)
5495 (remove-hook 'org-blocker-hook
5496 'org-block-todo-from-children-or-siblings-or-parent
))
5497 (if org-enforce-todo-checkbox-dependencies
5498 (add-hook 'org-blocker-hook
5499 'org-block-todo-from-checkboxes
)
5500 (remove-hook 'org-blocker-hook
5501 'org-block-todo-from-checkboxes
))
5503 ;; Align options lines
5505 'align-mode-rules-list
5506 '((org-in-buffer-settings
5507 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5508 (modes .
'(org-mode)))))
5511 (org-set-local 'imenu-create-index-function
5512 'org-imenu-get-tree
)
5514 ;; Make isearch reveal context
5515 (if (or (featurep 'xemacs
)
5516 (not (boundp 'outline-isearch-open-invisible-function
)))
5517 ;; Emacs 21 and XEmacs make use of the hook
5518 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5519 ;; Emacs 22 deals with this through a special variable
5520 (org-set-local 'outline-isearch-open-invisible-function
5521 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5523 ;; Setup the pcomplete hooks
5524 (set (make-local-variable 'pcomplete-command-completion-function
)
5525 'org-pcomplete-initial
)
5526 (set (make-local-variable 'pcomplete-command-name-function
)
5527 'org-command-at-point
)
5528 (set (make-local-variable 'pcomplete-default-completion-function
)
5530 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5531 'org-parse-arguments
)
5532 (set (make-local-variable 'pcomplete-termination-string
) "")
5533 (when (>= emacs-major-version
23)
5534 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5536 ;; If empty file that did not turn on org-mode automatically, make it to.
5537 (if (and org-insert-mode-line-in-empty-file
5538 (org-called-interactively-p 'any
)
5539 (= (point-min) (point-max)))
5540 (insert "# -*- mode: org -*-\n\n"))
5541 (unless org-inhibit-startup
5543 (and org-startup-with-beamer-mode
(org-beamer-mode))
5544 (when org-startup-align-all-tables
5545 (org-table-map-tables 'org-table-align
'quietly
))
5546 (when org-startup-with-inline-images
5547 (org-display-inline-images))
5548 (when org-startup-with-latex-preview
5549 (org-toggle-latex-fragment))
5550 (unless org-inhibit-startup-visibility-stuff
5551 (org-set-startup-visibility))
5552 (org-refresh-effort-properties)))
5553 ;; Try to set org-hide correctly
5554 (let ((foreground (org-find-invisible-foreground)))
5556 (set-face-foreground 'org-hide foreground
))))
5558 ;; Update `customize-package-emacs-version-alist'
5559 (add-to-list 'customize-package-emacs-version-alist
5560 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5561 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5562 ("8.2.6" .
"24.4") ("8.3" .
"25.1")))
5564 (defvar org-mode-transpose-word-syntax-table
5565 (let ((st (make-syntax-table text-mode-syntax-table
)))
5566 (mapc (lambda(c) (modify-syntax-entry
5567 (string-to-char (car c
)) "w p" st
))
5571 (when (fboundp 'abbrev-table-put
)
5572 (abbrev-table-put org-mode-abbrev-table
5573 :parents
(list text-mode-abbrev-table
)))
5575 (defun org-find-invisible-foreground ()
5576 (let ((candidates (remove
5579 (list (face-background 'default
)
5580 (face-background 'org-default
))
5583 (when (boundp alist
)
5584 (cdr (assoc 'background-color
(symbol-value alist
)))))
5585 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5586 (list (face-foreground 'org-hide
))))))
5587 (car (remove nil candidates
))))
5589 (defun org-current-time (&optional rounding-minutes past
)
5590 "Current time, possibly rounded to ROUNDING-MINUTES.
5591 When ROUNDING-MINUTES is not an integer, fall back on the car of
5592 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5593 the rounding returns a past time."
5594 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5595 (car org-time-stamp-rounding-minutes
)))
5596 (time (decode-time)) res
)
5601 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5603 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5604 (seconds-to-time (- (org-float-time res
) (* r
60)))
5608 "Return today date, considering `org-extend-today-until'."
5610 (time-subtract (current-time)
5611 (list 0 (* 3600 org-extend-today-until
) 0))))
5613 ;;;; Font-Lock stuff, including the activators
5615 (defvar org-mouse-map
(make-sparse-keymap))
5616 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5617 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5618 (when org-mouse-1-follows-link
5619 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5620 (when org-tab-follows-link
5621 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5622 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5624 (require 'font-lock
)
5626 (defconst org-non-link-chars
"]\t\n\r<>")
5627 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5628 "file+sys" "news" "shell" "elisp" "doi" "message"
5630 (defvar org-link-types-re nil
5631 "Matches a link that has a url-like prefix like \"http:\"")
5632 (defvar org-link-re-with-space nil
5633 "Matches a link with spaces, optional angular brackets around it.")
5634 (defvar org-link-re-with-space2 nil
5635 "Matches a link with spaces, optional angular brackets around it.")
5636 (defvar org-link-re-with-space3 nil
5637 "Matches a link with spaces, only for internal part in bracket links.")
5638 (defvar org-angle-link-re nil
5639 "Matches link with angular brackets, spaces are allowed.")
5640 (defvar org-plain-link-re nil
5641 "Matches plain link, without spaces.")
5642 (defvar org-bracket-link-regexp nil
5643 "Matches a link in double brackets.")
5644 (defvar org-bracket-link-analytic-regexp nil
5645 "Regular expression used to analyze links.
5646 Here is what the match groups contain after a match:
5652 (defvar org-bracket-link-analytic-regexp
++ nil
5653 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5654 (defvar org-any-link-re nil
5655 "Regular expression matching any link.")
5657 (defconst org-match-sexp-depth
3
5658 "Number of stacked braces for sub/superscript matching.")
5660 (defun org-create-multibrace-regexp (left right n
)
5661 "Create a regular expression which will match a balanced sexp.
5662 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5663 as single character strings.
5664 The regexp returned will match the entire expression including the
5665 delimiters. It will also define a single group which contains the
5666 match except for the outermost delimiters. The maximum depth of
5667 stacked delimiters is N. Escaping delimiters is not possible."
5668 (let* ((nothing (concat "[^" left right
"]*?"))
5671 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5674 re
(concat re or next
)
5675 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5676 (concat left
"\\(" re
"\\)" right
)))
5678 (defconst org-match-substring-regexp
5680 "\\(\\S-\\)\\([_^]\\)\\("
5681 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5683 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5685 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5686 "The regular expression matching a sub- or superscript.")
5688 (defconst org-match-substring-with-braces-regexp
5690 "\\(\\S-\\)\\([_^]\\)"
5691 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5692 "The regular expression matching a sub- or superscript, forcing braces.")
5694 (defun org-make-link-regexps ()
5695 "Update the link regular expressions.
5696 This should be called after the variable `org-link-types' has changed."
5697 (let ((types-re (regexp-opt org-link-types t
)))
5698 (setq org-link-types-re
5699 (concat "\\`" types-re
":")
5700 org-link-re-with-space
5701 (concat "<?" types-re
":"
5702 "\\([^" org-non-link-chars
" ]"
5703 "[^" org-non-link-chars
"]*"
5704 "[^" org-non-link-chars
" ]\\)>?")
5705 org-link-re-with-space2
5706 (concat "<?" types-re
":"
5707 "\\([^" org-non-link-chars
" ]"
5709 "[^" org-non-link-chars
" ]\\)>?")
5710 org-link-re-with-space3
5711 (concat "<?" types-re
":"
5712 "\\([^" org-non-link-chars
" ]"
5715 (concat "<" types-re
":"
5716 "\\([^" org-non-link-chars
" ]"
5717 "[^" org-non-link-chars
"]*"
5722 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5723 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5724 org-bracket-link-regexp
5725 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5726 org-bracket-link-analytic-regexp
5729 "\\(" types-re
":\\)?"
5732 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5734 org-bracket-link-analytic-regexp
++
5737 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5740 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5743 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5744 org-angle-link-re
"\\)\\|\\("
5745 org-plain-link-re
"\\)"))))
5747 (org-make-link-regexps)
5749 (defvar org-emph-face nil
)
5751 (defun org-do-emphasis-faces (limit)
5752 "Run through the buffer and emphasize strings."
5754 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5755 (let* ((border (char-after (match-beginning 3)))
5756 (bre (regexp-quote (char-to-string border
))))
5757 (if (and (not (= border
(char-after (match-beginning 4))))
5758 (not (save-match-data
5759 (string-match (concat bre
".*" bre
)
5760 (replace-regexp-in-string
5762 (substring (match-string 2) 1 -
1))))))
5765 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5766 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5770 (org-remove-flyspell-overlays-in
5771 (match-beginning 0) (match-end 0)))
5772 (add-text-properties (match-beginning 2) (match-end 2)
5773 '(font-lock-multiline t org-emphasis t
))
5774 (when org-hide-emphasis-markers
5775 (add-text-properties (match-end 4) (match-beginning 5)
5776 '(invisible org-link
))
5777 (add-text-properties (match-beginning 3) (match-end 3)
5778 '(invisible org-link
))))))
5779 (goto-char (1+ (match-beginning 0))))
5782 (defun org-emphasize (&optional char
)
5783 "Insert or change an emphasis, i.e. a font like bold or italic.
5784 If there is an active region, change that region to a new emphasis.
5785 If there is no region, just insert the marker characters and position
5786 the cursor between them.
5787 CHAR should be the marker character. If it is a space, it means to
5788 remove the emphasis of the selected region.
5789 If CHAR is not given (for example in an interactive call) it will be
5792 (let ((erc org-emphasis-regexp-components
)
5794 (string "") beg end move c s
)
5795 (if (org-region-active-p)
5796 (setq beg
(region-beginning) end
(region-end)
5797 string
(buffer-substring beg end
))
5801 (message "Emphasis marker or tag: [%s]"
5802 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5803 (setq char
(read-char-exclusive)))
5804 (if (equal char ?\
)
5805 (setq s
"" move nil
)
5806 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5807 (user-error "No such emphasis marker: \"%c\"" char
))
5808 (setq s
(char-to-string char
)))
5809 (while (and (> (length string
) 1)
5810 (equal (substring string
0 1) (substring string -
1))
5811 (assoc (substring string
0 1) org-emphasis-alist
))
5812 (setq string
(substring string
1 -
1)))
5813 (setq string
(concat s string s
))
5814 (if beg
(delete-region beg end
))
5816 (string-match (concat "[" (nth 0 erc
) "\n]")
5817 (char-to-string (char-before (point)))))
5820 (string-match (concat "[" (nth 1 erc
) "\n]")
5821 (char-to-string (char-after (point)))))
5822 (insert " ") (backward-char 1))
5824 (and move
(backward-char 1))))
5826 (defconst org-nonsticky-props
5827 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5829 (defsubst org-rear-nonsticky-at
(pos)
5830 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5832 (defun org-activate-plain-links (limit)
5833 "Add link properties for plain links."
5835 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5836 (not (member 'org-tag
5837 (get-text-property (1- (match-beginning 0)) 'face
)))
5838 (not (org-in-src-block-p)))
5839 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5840 (setq f
(get-text-property (match-beginning 0) 'face
))
5841 (setq hl
(org-match-string-no-properties 0))
5842 (if (or (eq f
'org-tag
)
5843 (and (listp f
) (memq 'org-tag f
)))
5845 (add-text-properties (match-beginning 0) (match-end 0)
5846 (list 'mouse-face
'highlight
5848 'htmlize-link
`(:uri
,hl
)
5849 'keymap org-mouse-map
))
5850 (org-rear-nonsticky-at (match-end 0)))
5853 (defun org-activate-code (limit)
5854 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5856 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5857 (remove-text-properties (match-beginning 0) (match-end 0)
5858 '(display t invisible t intangible t
))
5861 (defcustom org-src-fontify-natively t
5862 "When non-nil, fontify code in code blocks."
5865 :package-version
'(Org .
"8.3")
5866 :group
'org-appearance
5869 (defcustom org-allow-promoting-top-level-subtree nil
5870 "When non-nil, allow promoting a top level subtree.
5871 The leading star of the top level headline will be replaced
5875 :group
'org-appearance
)
5877 (defun org-fontify-meta-lines-and-blocks (limit)
5879 (org-fontify-meta-lines-and-blocks-1 limit
)
5880 (error (message "org-mode fontification error"))))
5882 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5883 "Fontify #+ lines and blocks."
5884 (let ((case-fold-search t
))
5885 (if (re-search-forward
5886 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5888 (let ((beg (match-beginning 0))
5889 (block-start (match-end 0))
5891 (lang (match-string 7))
5892 (beg1 (line-beginning-position 2))
5893 (dc1 (downcase (match-string 2)))
5894 (dc3 (downcase (match-string 3)))
5895 end end1 quoting block-type ovl
)
5897 ((and (match-end 4) (equal dc3
"+begin"))
5899 (setq block-type
(downcase (match-string 5))
5900 quoting
(member block-type org-protecting-blocks
))
5901 (when (re-search-forward
5902 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5903 nil t
) ;; on purpose, we look further than LIMIT
5904 (setq end
(min (point-max) (match-end 0))
5905 end1
(min (point-max) (1- (match-beginning 0))))
5906 (setq block-end
(match-beginning 0))
5908 (org-remove-flyspell-overlays-in beg1 end1
)
5909 (remove-text-properties beg end
5910 '(display t invisible t intangible t
)))
5911 (add-text-properties
5912 beg end
'(font-lock-fontified t font-lock-multiline t
))
5913 (add-text-properties beg beg1
'(face org-meta-line
))
5914 (org-remove-flyspell-overlays-in beg beg1
)
5915 (add-text-properties ; For end_src
5916 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5917 (org-remove-flyspell-overlays-in end1 end
)
5919 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5920 (org-src-font-lock-fontify-block lang block-start block-end
)
5921 (add-text-properties beg1 block-end
'(src-block t
)))
5923 (add-text-properties beg1
(min (point-max) (1+ end1
))
5924 '(face org-block
))) ; end of source block
5925 ((not org-fontify-quote-and-verse-blocks
))
5926 ((string= block-type
"quote")
5927 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5928 ((string= block-type
"verse")
5929 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5930 (add-text-properties beg beg1
'(face org-block-begin-line
))
5931 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5932 '(face org-block-end-line
))
5934 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5935 (org-remove-flyspell-overlays-in
5937 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5938 (add-text-properties
5940 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5941 '(font-lock-fontified t invisible t
)
5942 '(font-lock-fontified t face org-document-info-keyword
)))
5943 (add-text-properties
5944 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5945 (if (string-equal dc1
"+title:")
5946 '(font-lock-fontified t face org-document-title
)
5947 '(font-lock-fontified t face org-document-info
))))
5948 ((equal dc1
"+caption:")
5949 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5950 (remove-text-properties (match-beginning 0) (match-end 0)
5951 '(display t invisible t intangible t
))
5952 (add-text-properties (match-beginning 1) (match-end 3)
5953 '(font-lock-fontified t face org-meta-line
))
5954 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5955 '(font-lock-fontified t face org-block
))
5957 ((member dc3
'(" " ""))
5958 (org-remove-flyspell-overlays-in beg
(match-end 0))
5959 (add-text-properties
5961 '(font-lock-fontified t face font-lock-comment-face
)))
5962 (t ;; just any other in-buffer setting, but not indented
5963 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5964 (remove-text-properties (match-beginning 0) (match-end 0)
5965 '(display t invisible t intangible t
))
5966 (add-text-properties beg
(match-end 0)
5967 '(font-lock-fontified t face org-meta-line
))
5970 (defun org-fontify-drawers (limit)
5972 (when (re-search-forward org-drawer-regexp limit t
)
5973 (add-text-properties
5974 (match-beginning 0) (match-end 0)
5975 '(font-lock-fontified t face org-special-keyword
))
5976 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5979 (defun org-fontify-macros (limit)
5981 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
5982 (add-text-properties
5983 (match-beginning 0) (match-end 0)
5984 '(font-lock-fontified t face org-macro
))
5985 (when org-hide-macro-markers
5986 (add-text-properties (match-end 2) (match-beginning 2)
5988 (add-text-properties (match-beginning 1) (match-end 1)
5990 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5993 (defun org-activate-angle-links (limit)
5994 "Add text properties for angle links."
5995 (if (and (re-search-forward org-angle-link-re limit t
)
5996 (not (org-in-src-block-p)))
5998 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5999 (add-text-properties (match-beginning 0) (match-end 0)
6000 (list 'mouse-face
'highlight
6001 'keymap org-mouse-map
))
6002 (org-rear-nonsticky-at (match-end 0))
6005 (defun org-activate-footnote-links (limit)
6006 "Add text properties for footnotes."
6007 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6009 (let* ((beg (nth 1 fn
))
6012 (referencep (/= (line-beginning-position) beg
)))
6013 (when (and referencep
(nth 3 fn
))
6016 (search-forward (or label
"fn:"))
6017 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6018 (add-text-properties beg end
6019 (list 'mouse-face
'highlight
6020 'keymap org-mouse-map
6022 (if referencep
"Footnote reference"
6023 "Footnote definition")
6024 'font-lock-fontified t
6025 'font-lock-multiline t
6026 'face
'org-footnote
))))))
6028 (defun org-activate-bracket-links (limit)
6029 "Add text properties for bracketed links."
6030 (if (and (re-search-forward org-bracket-link-regexp limit t
)
6031 (not (org-in-src-block-p)))
6032 (let* ((hl (org-match-string-no-properties 1))
6033 (help (concat "LINK: " (save-match-data (org-link-unescape hl
))))
6034 (ip (org-maybe-intangible
6035 (list 'invisible
'org-link
6036 'keymap org-mouse-map
'mouse-face
'highlight
6037 'font-lock-multiline t
'help-echo help
6038 'htmlize-link
`(:uri
,hl
))))
6039 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
6040 'font-lock-multiline t
'help-echo help
6041 'htmlize-link
`(:uri
,hl
))))
6042 ;; We need to remove the invisible property here. Table narrowing
6043 ;; may have made some of this invisible.
6044 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6045 (remove-text-properties (match-beginning 0) (match-end 0)
6049 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6050 (org-rear-nonsticky-at (match-beginning 3))
6051 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6052 (org-rear-nonsticky-at (match-end 3))
6053 (add-text-properties (match-end 3) (match-end 0) ip
)
6054 (org-rear-nonsticky-at (match-end 0)))
6055 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6056 (org-rear-nonsticky-at (match-beginning 1))
6057 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6058 (org-rear-nonsticky-at (match-end 1))
6059 (add-text-properties (match-end 1) (match-end 0) ip
)
6060 (org-rear-nonsticky-at (match-end 0)))
6063 (defun org-activate-dates (limit)
6064 "Add text properties for dates."
6065 (if (and (re-search-forward org-tsr-regexp-both limit t
)
6066 (not (equal (char-before (match-beginning 0)) 91)))
6068 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6069 (add-text-properties (match-beginning 0) (match-end 0)
6070 (list 'mouse-face
'highlight
6071 'keymap org-mouse-map
))
6072 (org-rear-nonsticky-at (match-end 0))
6073 (when org-display-custom-times
6075 (org-display-custom-time (match-beginning 3) (match-end 3)))
6076 (org-display-custom-time (match-beginning 1) (match-end 1)))
6079 (defvar org-target-link-regexp nil
6080 "Regular expression matching radio targets in plain text.")
6081 (make-variable-buffer-local 'org-target-link-regexp
)
6083 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6084 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6085 border border border
))
6086 "Regular expression matching a link target.")
6088 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6089 "Regular expression matching a radio target.")
6091 (defconst org-any-target-regexp
6092 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6093 "Regular expression matching any target.")
6095 (defun org-activate-target-links (limit)
6096 "Add text properties for target matches."
6097 (when org-target-link-regexp
6098 (let ((case-fold-search t
))
6099 (if (re-search-forward org-target-link-regexp limit t
)
6101 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6102 (add-text-properties (match-beginning 1) (match-end 1)
6103 (list 'mouse-face
'highlight
6104 'keymap org-mouse-map
6105 'help-echo
"Radio target link"
6106 'org-linked-text t
))
6107 (org-rear-nonsticky-at (match-end 1))
6110 (defun org-update-radio-target-regexp ()
6111 "Find all radio targets in this file and update the regular expression.
6112 Also refresh fontification if needed."
6114 (let ((old-regexp org-target-link-regexp
)
6115 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6116 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6118 (org-with-wide-buffer
6119 (goto-char (point-min))
6121 (while (re-search-forward org-radio-target-regexp nil t
)
6122 ;; Make sure point is really within the object.
6124 (let ((obj (org-element-context)))
6125 (when (eq (org-element-type obj
) 'radio-target
)
6126 (add-to-list 'rtn
(org-element-property :value obj
)))))
6128 (setq org-target-link-regexp
6133 (replace-regexp-in-string
6134 " +" "\\s-+" (regexp-quote x
) t t
))
6138 (unless (equal old-regexp org-target-link-regexp
)
6140 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6141 ((not org-target-link-regexp
) old-regexp
)
6146 (substring re
(length before-re
)
6147 (- (length after-re
))))
6148 (list old-regexp org-target-link-regexp
)
6151 (org-with-wide-buffer
6152 (goto-char (point-min))
6153 (while (re-search-forward regexp nil t
)
6154 (org-element-cache-refresh (match-beginning 1)))))
6155 ;; Re fontify buffer.
6156 (when (memq 'radio org-highlight-links
)
6157 (org-restart-font-lock)))))
6159 (defun org-hide-wide-columns (limit)
6161 (setq s
(text-property-any (point) (or limit
(point-max))
6164 (setq e
(next-single-property-change s
'org-cwidth
))
6165 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
6169 (defvar org-latex-and-related-regexp nil
6170 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6172 (defun org-compute-latex-and-related-regexp ()
6173 "Compute regular expression for LaTeX, entities and sub/superscript.
6174 Result depends on variable `org-highlight-latex-and-related'."
6176 'org-latex-and-related-regexp
6178 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6179 ((eq org-use-sub-superscripts
'{})
6180 (list org-match-substring-with-braces-regexp
))
6181 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6183 (when (memq 'latex org-highlight-latex-and-related
)
6184 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6187 (and (member (car x
) matchers
) (nth 1 x
)))
6188 org-latex-regexps
)))))
6190 (when (memq 'entities org-highlight-latex-and-related
)
6191 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6192 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6194 (defun org-do-latex-and-related (limit)
6195 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6196 LIMIT bounds the search for syntax to highlight. Stop at first
6197 highlighted object, if any. Return t if some highlighting was
6198 done, nil otherwise."
6199 (when (org-string-nw-p org-latex-and-related-regexp
)
6201 (while (re-search-forward org-latex-and-related-regexp limit t
)
6202 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6204 '(org-code org-verbatim underline
))
6205 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6209 (font-lock-prepend-text-property
6210 (+ offset
(match-beginning 0)) (match-end 0)
6211 'face
'org-latex-and-related
)
6212 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6213 '(font-lock-multiline t
)))
6217 (defun org-restart-font-lock ()
6218 "Restart `font-lock-mode', to force refontification."
6219 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6221 (font-lock-mode 1)))
6223 (defun org-activate-tags (limit)
6224 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
6226 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6227 (add-text-properties (match-beginning 1) (match-end 1)
6228 (list 'mouse-face
'highlight
6229 'keymap org-mouse-map
))
6230 (org-rear-nonsticky-at (match-end 1))
6233 (defun org-outline-level ()
6234 "Compute the outline level of the heading at point.
6236 If this is called at a normal headline, the level is the number
6237 of stars. Use `org-reduced-level' to remove the effect of
6238 `org-odd-levels'. Unlike to `org-current-level', this function
6239 takes into consideration inlinetasks."
6240 (org-with-wide-buffer
6242 (if (re-search-backward org-outline-regexp-bol nil t
)
6243 (1- (- (match-end 0) (match-beginning 0)))
6246 (defvar org-font-lock-keywords nil
)
6248 (defsubst org-re-property
(property &optional literal allow-null value
)
6249 "Return a regexp matching a PROPERTY line.
6251 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6252 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6253 non-nil, match properties even without a value.
6255 Match group 3 is set to the value when it exists. If there is no
6256 value and ALLOW-NULL is non-nil, it is set to the empty string.
6258 With optional argument VALUE, match only property lines with
6259 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6260 unless LITERAL is non-nil."
6263 (format "\\(?1::\\(?2:%s\\):\\)"
6264 (if literal property
(regexp-quote property
)))
6266 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6267 (if literal value
(regexp-quote value
))))
6269 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6271 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6273 (defconst org-property-re
6274 (org-re-property "\\S-+" 'literal t
)
6275 "Regular expression matching a property line.
6276 There are four matching groups:
6277 1: :PROPKEY: including the leading and trailing colon,
6278 2: PROPKEY without the leading and trailing colon,
6279 3: PROPVAL without leading or trailing spaces,
6280 4: the indentation of the current line,
6281 5: trailing whitespace.")
6283 (defvar org-font-lock-hook nil
6284 "Functions to be called for special font lock stuff.")
6286 (defvar org-font-lock-set-keywords-hook nil
6287 "Functions that can manipulate `org-font-lock-extra-keywords'.
6288 This is called after `org-font-lock-extra-keywords' is defined, but before
6289 it is installed to be used by font lock. This can be useful if something
6290 needs to be inserted at a specific position in the font-lock sequence.")
6292 (defun org-font-lock-hook (limit)
6293 "Run `org-font-lock-hook' within LIMIT."
6294 (run-hook-with-args 'org-font-lock-hook limit
))
6296 (defun org-set-font-lock-defaults ()
6297 "Set font lock defaults for the current buffer."
6298 (let* ((em org-fontify-emphasized-text
)
6299 (lk org-highlight-links
)
6300 (org-font-lock-extra-keywords
6303 '(org-font-lock-hook)
6305 `(,(if org-fontify-whole-heading-line
6306 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6307 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6308 (1 (org-get-level-face 1))
6309 (2 (org-get-level-face 2))
6310 (3 (org-get-level-face 3)))
6312 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6315 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6316 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6317 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6318 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6320 '(org-fontify-drawers)
6322 (list org-property-re
6323 '(1 'org-special-keyword t
)
6324 '(3 'org-property-value t
))
6326 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6327 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6328 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6329 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6330 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6331 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6332 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6334 (list org-any-target-regexp
'(0 'org-target t
))
6336 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6338 '(org-fontify-macros)
6339 '(org-hide-wide-columns (0 nil append
))
6341 (list (format org-heading-keyword-regexp-format
6343 '(2 (org-get-todo-face 2) t
))
6345 (if org-fontify-done-headline
6346 (list (format org-heading-keyword-regexp-format
6349 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6351 '(2 'org-headline-done t
))
6354 '(org-font-lock-add-priority-faces)
6356 '(org-font-lock-add-tag-faces)
6358 (if (and org-group-tags org-tag-groups-alist
)
6359 (list (concat org-outline-regexp-bol
".+\\(:"
6360 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6362 '(1 'org-tag-group prepend
)))
6364 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6365 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6366 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6367 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6368 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6371 (if (featurep 'xemacs
)
6372 '(org-do-emphasis-faces (0 nil append
))
6373 '(org-do-emphasis-faces)))
6375 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6376 1 'org-checkbox prepend
)
6377 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6378 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6379 (0 (org-get-checkbox-statistics-face) t
)))
6380 ;; Description list items
6381 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6382 1 'org-list-dt prepend
)
6383 ;; ARCHIVEd headings
6385 org-outline-regexp-bol
6386 "\\(.*:" org-archive-tag
":.*\\)")
6387 '(1 'org-archived prepend
))
6389 '(org-do-latex-and-related)
6390 '(org-fontify-entities)
6391 '(org-raise-scripts)
6393 '(org-activate-code (1 'org-code t
))
6396 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6399 '(9 'org-special-keyword t
))
6400 ;; Blocks and meta lines
6401 '(org-fontify-meta-lines-and-blocks))))
6402 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6403 (run-hooks 'org-font-lock-set-keywords-hook
)
6404 ;; Now set the full font-lock-keywords
6405 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6406 (org-set-local 'font-lock-defaults
6407 '(org-font-lock-keywords t nil nil backward-paragraph
))
6408 (kill-local-variable 'font-lock-keywords
) nil
))
6410 (defun org-toggle-pretty-entities ()
6411 "Toggle the composition display of entities as UTF8 characters."
6413 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6414 (org-restart-font-lock)
6415 (if org-pretty-entities
6416 (message "Entities are now displayed as UTF8 characters")
6419 (org-decompose-region (point-min) (point-max))
6420 (message "Entities are now displayed as plain text"))))
6422 (defvar org-custom-properties-overlays nil
6423 "List of overlays used for custom properties.")
6424 (make-variable-buffer-local 'org-custom-properties-overlays
)
6426 (defun org-toggle-custom-properties-visibility ()
6427 "Display or hide properties in `org-custom-properties'."
6429 (if org-custom-properties-overlays
6430 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6431 (setq org-custom-properties-overlays nil
))
6432 (when org-custom-properties
6433 (org-with-wide-buffer
6434 (goto-char (point-min))
6435 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6436 (while (re-search-forward regexp nil t
)
6437 (let ((end (cdr (save-match-data (org-get-property-block)))))
6438 (when (and end
(< (point) end
))
6439 ;; Hide first custom property in current drawer.
6440 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6441 (overlay-put o
'invisible t
)
6442 (overlay-put o
'org-custom-property t
)
6443 (push o org-custom-properties-overlays
))
6444 ;; Hide additional custom properties in the same drawer.
6445 (while (re-search-forward regexp end t
)
6446 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6447 (overlay-put o
'invisible t
)
6448 (overlay-put o
'org-custom-property t
)
6449 (push o org-custom-properties-overlays
)))))
6450 ;; Each entry is limited to a single property drawer.
6451 (outline-next-heading)))))))
6453 (defun org-fontify-entities (limit)
6454 "Find an entity to fontify."
6456 (when org-pretty-entities
6458 ;; "\_ "-family is left out on purpose. Only the first one,
6459 ;; i.e., "\_ ", could be fontified anyway, and it would be
6460 ;; confusing when adding a second white space character.
6461 (while (re-search-forward
6462 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6464 (if (and (not (org-at-comment-p))
6465 (setq ee
(org-entity-get (match-string 1)))
6466 (= (length (nth 6 ee
)) 1))
6468 ((end (if (equal (match-string 2) "{}")
6471 (add-text-properties
6472 (match-beginning 0) end
6473 (list 'font-lock-fontified t
))
6474 (compose-region (match-beginning 0) end
6480 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6481 "Fontify string S like in Org-mode."
6484 (let ((org-odd-levels-only odd-levels
))
6492 (defun org-get-level-face (n)
6493 "Get the right face for match N in font-lock matching of headlines."
6494 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6495 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6496 (if org-cycle-level-faces
6497 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6498 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6500 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6502 (t (if org-level-color-stars-only nil org-f
))))
6505 (defun org-get-todo-face (kwd)
6506 "Get the right face for a TODO keyword KWD.
6507 If KWD is a number, get the corresponding match group."
6508 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6509 (or (org-face-from-face-or-color
6510 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6511 (and (member kwd org-done-keywords
) 'org-done
)
6514 (defun org-face-from-face-or-color (context inherit face-or-color
)
6515 "Create a face list that inherits INHERIT, but sets the foreground color.
6516 When FACE-OR-COLOR is not a string, just return it."
6517 (if (stringp face-or-color
)
6518 (list :inherit inherit
6519 (cdr (assoc context org-faces-easy-properties
))
6523 (defun org-font-lock-add-tag-faces (limit)
6524 "Add the special tag faces."
6525 (when (and org-tag-faces org-tags-special-faces-re
)
6526 (while (re-search-forward org-tags-special-faces-re limit t
)
6527 (add-text-properties (match-beginning 1) (match-end 1)
6528 (list 'face
(org-get-tag-face 1)
6529 'font-lock-fontified t
))
6530 (backward-char 1))))
6532 (defun org-font-lock-add-priority-faces (limit)
6533 "Add the special priority faces."
6534 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
6535 (when (save-match-data (org-at-heading-p))
6536 (add-text-properties
6537 (match-beginning 0) (match-end 0)
6538 (list 'face
(or (org-face-from-face-or-color
6539 'priority
'org-priority
6540 (cdr (assoc (char-after (match-beginning 1))
6541 org-priority-faces
)))
6543 'font-lock-fontified t
)))))
6545 (defun org-get-tag-face (kwd)
6546 "Get the right face for a TODO keyword KWD.
6547 If KWD is a number, get the corresponding match group."
6548 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6549 (or (org-face-from-face-or-color
6550 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
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 "^\\*+"))
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 (looking-back "^.*") (match-string-no-properties 0))))
8904 start beg end stars re re2
8906 ;; Find beginning and end of region to sort
8908 ((org-region-active-p)
8909 ;; we will sort the region
8910 (setq end (region-end)
8912 (goto-char (region-beginning))
8913 (if (not (org-at-heading-p)) (outline-next-heading))
8914 (setq start (point)))
8915 ((or (org-at-heading-p)
8916 (ignore-errors (progn (org-back-to-heading) t)))
8917 ;; we will sort the children of the current headline
8918 (org-back-to-heading)
8920 end (progn (org-end-of-subtree t t)
8921 (or (bolp) (insert "\n"))
8922 (when (>= (org-back-over-empty-lines) 1)
8928 (outline-next-heading))
8930 ;; we will sort the top-level entries in this file
8931 (goto-char (point-min))
8932 (or (org-at-heading-p) (outline-next-heading))
8933 (setq start (point))
8934 (goto-char (point-max))
8935 (beginning-of-line 1)
8936 (when (looking-at ".*?\\S-")
8937 ;; File ends in a non-white line
8940 (setq end (point-max))
8941 (setq what "top-level")
8946 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8948 (looking-at "\\(\\*+\\)")
8949 (setq stars (match-string 1)
8950 re (concat "^" (regexp-quote stars) " +")
8951 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8952 txt (buffer-substring beg end))
8953 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8954 (if (and (not (equal stars "*")) (string-match re2 txt))
8955 (user-error "Region to sort contains a level above the first entry"))
8957 (unless sorting-type
8959 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8960 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8961 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8963 (setq sorting-type (read-char-exclusive))
8966 (and (= (downcase sorting-type) ?f)
8968 (org-icompleting-read "Sort using function: "
8969 obarray 'fboundp t nil nil))
8970 (setq getkey-func (intern getkey-func))))
8972 (and (= (downcase sorting-type) ?r)
8975 (org-icompleting-read "Property: "
8976 (mapcar 'list (org-buffer-property-keys t))
8979 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8980 (message "Sorting entries...")
8983 (narrow-to-region start end)
8984 (let ((dcst (downcase sorting-type))
8985 (case-fold-search nil)
8986 (now (current-time)))
8988 (/= dcst sorting-type)
8989 ;; This function moves to the beginning character of the "record" to
8992 (if (re-search-forward re nil t)
8993 (goto-char (match-beginning 0))
8994 (goto-char (point-max))))
8995 ;; This function moves to the last character of the "record" being
9000 (outline-forward-same-level 1)
9002 (goto-char (point-max))))))
9003 ;; This function returns the value that gets sorted against.
9007 (if (looking-at org-complex-heading-regexp)
9008 (string-to-number (org-sort-remove-invisible (match-string 4)))
9011 (if (looking-at org-complex-heading-regexp)
9012 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9015 (or (get-text-property (point) :org-clock-minutes) 0))
9017 (let ((end (save-excursion (outline-next-heading) (point))))
9018 (if (or (re-search-forward org-ts-regexp end t)
9019 (re-search-forward org-ts-regexp-both end t))
9020 (org-time-string-to-seconds (match-string 0))
9021 (org-float-time now))))
9023 (let ((end (save-excursion (outline-next-heading) (point))))
9024 (if (re-search-forward
9025 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9027 (org-time-string-to-seconds (match-string 0))
9028 (org-float-time now))))
9030 (let ((end (save-excursion (outline-next-heading) (point))))
9031 (if (re-search-forward org-scheduled-time-regexp end t)
9032 (org-time-string-to-seconds (match-string 1))
9033 (org-float-time now))))
9035 (let ((end (save-excursion (outline-next-heading) (point))))
9036 (if (re-search-forward org-deadline-time-regexp end t)
9037 (org-time-string-to-seconds (match-string 1))
9038 (org-float-time now))))
9040 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9041 (string-to-char (match-string 2))
9042 org-default-priority))
9044 (or (org-entry-get nil property) ""))
9046 (if (looking-at org-complex-heading-regexp)
9047 (let* ((m (match-string 2))
9048 (s (if (member m org-done-keywords) '- '+)))
9049 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9053 (setq tmp (funcall getkey-func))
9054 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9056 (error "Invalid key function `%s'" getkey-func)))
9057 (t (error "Invalid sorting type `%c'" sorting-type))))
9060 ((= dcst ?a) 'string<)
9061 ((= dcst ?f) compare-func)
9062 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9063 (run-hooks 'org-after-sorting-entries-or-items-hook)
9064 ;; Reset the clock marker if needed
9068 (search-forward cmstr nil t)
9069 (move-marker org-clock-marker (point))))
9070 (message "Sorting entries...done")))
9072 ;;; The orgstruct minor mode
9074 ;; Define a minor mode which can be used in other modes in order to
9075 ;; integrate the org-mode structure editing commands.
9077 ;; This is really a hack, because the org-mode structure commands use
9078 ;; keys which normally belong to the major mode. Here is how it
9079 ;; works: The minor mode defines all the keys necessary to operate the
9080 ;; structure commands, but wraps the commands into a function which
9081 ;; tests if the cursor is currently at a headline or a plain list
9082 ;; item. If that is the case, the structure command is used,
9083 ;; temporarily setting many Org-mode variables like regular
9084 ;; expressions for filling etc. However, when any of those keys is
9085 ;; used at a different location, function uses `key-binding' to look
9086 ;; up if the key has an associated command in another currently active
9087 ;; keymap (minor modes, major mode, global), and executes that
9088 ;; command. There might be problems if any of the keys is otherwise
9089 ;; used as a prefix key.
9091 (defcustom orgstruct-heading-prefix-regexp ""
9092 "Regexp that matches the custom prefix of Org headlines in
9093 orgstruct(++)-mode."
9096 :package-version '(Org . "8.3")
9098 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9100 (defcustom orgstruct-setup-hook nil
9101 "Hook run after orgstruct-mode-map is filled."
9104 :package-version '(Org . "8.0")
9107 (defvar orgstruct-initialized nil)
9109 (defvar org-local-vars nil
9110 "List of local variables, for use by `orgstruct-mode'.")
9113 (define-minor-mode orgstruct-mode
9114 "Toggle the minor mode `orgstruct-mode'.
9115 This mode is for using Org-mode structure commands in other
9116 modes. The following keys behave as if Org-mode were active, if
9117 the cursor is on a headline, or on a plain list item (both as
9118 defined by Org-mode)."
9119 nil " OrgStruct" (make-sparse-keymap)
9120 (funcall (if orgstruct-mode
9121 'add-to-invisibility-spec
9122 'remove-from-invisibility-spec)
9124 (when orgstruct-mode
9125 (org-load-modules-maybe)
9126 (unless orgstruct-initialized
9128 (setq orgstruct-initialized t))))
9131 (defun turn-on-orgstruct ()
9132 "Unconditionally turn on `orgstruct-mode'."
9135 (defvar org-fb-vars nil)
9136 (make-variable-buffer-local 'org-fb-vars)
9137 (defun orgstruct++-mode (&optional arg)
9138 "Toggle `orgstruct-mode', the enhanced version of it.
9139 In addition to setting orgstruct-mode, this also exports all
9140 indentation and autofilling variables from org-mode into the
9141 buffer. It will also recognize item context in multiline items."
9143 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9145 (progn (orgstruct-mode -1)
9147 (org-set-local (car v)
9148 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9151 (setq org-fb-vars nil)
9152 (unless org-local-vars
9153 (setq org-local-vars (org-get-local-variables)))
9158 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9159 (symbol-name (car x)))
9160 (setq var (car x) val (nth 1 x))
9161 (push (list var `(quote ,(eval var))) org-fb-vars)
9162 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9164 (org-set-local 'orgstruct-is-++ t))))
9166 (defvar orgstruct-is-++ nil
9167 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9168 (make-variable-buffer-local 'orgstruct-is-++)
9171 (defun turn-on-orgstruct++ ()
9172 "Unconditionally turn on `orgstruct++-mode'."
9173 (orgstruct++-mode 1))
9175 (defun orgstruct-error ()
9176 "Error when there is no default binding for a structure key."
9178 (funcall (if (fboundp 'user-error)
9181 "This key has no function outside structure elements"))
9183 (defun orgstruct-setup ()
9184 "Setup orgstruct keymap."
9185 (dolist (cell '((org-demote . t)
9189 (org-shiftmetaleft . t)
9190 (org-shiftmetaright . t)
9191 org-backward-element
9192 org-backward-heading-same-level
9197 org-forward-heading-same-level
9199 org-insert-heading-respect-content
9200 org-kill-note-or-show-branches
9205 org-narrow-to-subtree
9220 outline-next-visible-heading
9221 outline-previous-visible-heading
9225 (let ((f (or (car-safe cell) cell))
9226 (disable-when-heading-prefix (cdr-safe cell)))
9228 (let ((new-bindings))
9229 (dolist (binding (nconc (where-is-internal f org-mode-map)
9230 (where-is-internal f outline-mode-map)))
9231 (push binding new-bindings)
9232 ;; TODO use local-function-key-map
9233 (dolist (rep '(("<tab>" . "TAB")
9234 ("<return>" . "RET")
9235 ("<escape>" . "ESC")
9236 ("<delete>" . "DEL")))
9237 (setq binding (read-kbd-macro
9238 (let ((case-fold-search))
9239 (replace-regexp-in-string
9240 (regexp-quote (cdr rep))
9242 (key-description binding)))))
9243 (pushnew binding new-bindings :test 'equal)))
9244 (dolist (binding new-bindings)
9245 (let ((key (lookup-key orgstruct-mode-map binding)))
9246 (when (or (not key) (numberp key))
9248 (org-defkey orgstruct-mode-map
9250 (orgstruct-make-binding
9251 f binding disable-when-heading-prefix))))))))))
9252 (run-hooks 'orgstruct-setup-hook))
9254 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9255 "Create a function for binding in the structure minor mode.
9256 FUN is the command to call inside a table. KEY is the key that
9257 should be checked in for a command to execute outside of tables.
9258 Non-nil `disable-when-heading-prefix' means to disable the command
9259 if `orgstruct-heading-prefix-regexp' is not empty."
9260 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9263 (while (fboundp (intern nname))
9264 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9265 (setq name (intern nname)))
9267 (let ((bindings '((org-heading-regexp
9269 orgstruct-heading-prefix-regexp
9270 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9272 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9273 (org-outline-regexp-bol
9274 (concat "^" org-outline-regexp))
9275 (outline-regexp org-outline-regexp)
9276 (outline-heading-end-regexp "\n")
9277 (outline-level 'org-outline-level)
9278 (outline-heading-alist))))
9280 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9281 "Outside of structure, run the binding of `"
9282 (key-description key) "'."
9283 (when disable-when-heading-prefix
9285 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9286 "back to the default binding due to limitations of Org's implementation of\n"
9287 "`" (symbol-name fun) "'.")))
9290 ,(and disable-when-heading-prefix
9291 '(not (string= orgstruct-heading-prefix-regexp ""))))
9296 (org-context-p 'headline 'item
9298 '(org-insert-heading
9299 org-insert-heading-respect-content
9301 '(when orgstruct-is-++
9304 (let* ((orgstruct-mode)
9311 ("<\\([^>]*\\)tab>" . "\\1TAB")
9312 ("<\\([^>]*\\)return>" . "\\1RET")
9313 ("<\\([^>]*\\)escape>" . "\\1ESC")
9314 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9317 (setq key (read-kbd-macro
9318 (let ((case-fold-search))
9319 (replace-regexp-in-string
9322 (key-description key))))))
9323 (when (key-binding key)
9324 (throw 'exit (key-binding key))))))))
9325 (if (keymapp binding)
9326 (org-set-transient-map binding)
9327 (let ((func (or binding
9329 'orgstruct-error))))
9331 (call-interactively func)))))
9332 (org-run-like-in-org-mode
9336 (call-interactively ',fun)))))))))
9339 (defun org-contextualize-keys (alist contexts)
9340 "Return valid elements in ALIST depending on CONTEXTS.
9342 `org-agenda-custom-commands' or `org-capture-templates' are the
9343 values used for ALIST, and `org-agenda-custom-commands-contexts'
9344 or `org-capture-templates-contexts' are the associated contexts
9347 ;; normalize contexts
9349 (lambda(c) (cond ((listp (cadr c))
9350 (list (car c) (car c) (cadr c)))
9351 ((string= "" (cadr c))
9352 (list (car c) (car c) (caddr c)))
9355 ;; loop over all commands or templates
9356 (while (setq c (pop a))
9359 ((not (assoc (car c) contexts))
9361 ((and (assoc (car c) contexts)
9362 (setq vrules (org-contextualize-validate-key
9365 (when (not (equal (car vr) (cadr vr)))
9366 (setq repl vr))) vrules)
9367 (if (not repl) (push c r)
9368 (push (cadr repl) s)
9371 (cdr (or (assoc (cadr repl) alist)
9372 (error "Undefined key `%s' as contextual replacement for `%s'"
9373 (cadr repl) (car c)))))
9375 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9380 (let ((tpl (car x)))
9384 (equal y tpl)) s))) x)))
9387 (defun org-contextualize-validate-key (key contexts)
9388 "Check CONTEXTS for agenda or capture KEY."
9390 (while (setq r (pop contexts))
9394 (and (equal key (car r))
9395 (if (functionp rr) (funcall rr)
9396 (or (and (eq (car rr) 'in-file)
9398 (string-match (cdr rr) (buffer-file-name)))
9399 (and (eq (car rr) 'in-mode)
9400 (string-match (cdr rr) (symbol-name major-mode)))
9401 (and (eq (car rr) 'in-buffer)
9402 (string-match (cdr rr) (buffer-name)))
9403 (when (and (eq (car rr) 'not-in-file)
9405 (not (string-match (cdr rr) (buffer-file-name))))
9406 (when (eq (car rr) 'not-in-mode)
9407 (not (string-match (cdr rr) (symbol-name major-mode))))
9408 (when (eq (car rr) 'not-in-buffer)
9409 (not (string-match (cdr rr) (buffer-name)))))))
9412 (delete-dups (delq nil res))))
9414 (defun org-context-p (&rest contexts)
9415 "Check if local context is any of CONTEXTS.
9416 Possible values in the list of contexts are `table', `headline', and `item'."
9417 (let ((pos (point)))
9418 (goto-char (point-at-bol))
9419 (prog1 (or (and (memq 'table contexts)
9420 (looking-at "[ \t]*|"))
9421 (and (memq 'headline contexts)
9422 (looking-at org-outline-regexp))
9423 (and (memq 'item contexts)
9424 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9425 (and (memq 'item-body contexts)
9429 (defun org-get-local-variables ()
9430 "Return a list of all local variables in an Org mode buffer."
9432 (with-current-buffer (get-buffer-create "*Org tmp*")
9435 (setq varlist (buffer-local-variables)))
9436 (kill-buffer "*Org tmp*")
9443 (list (car x) (cdr x))))
9444 (if (and (not (get (car x) 'org-state))
9446 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9447 (symbol-name (car x))))
9451 (defun org-clone-local-variables (from-buffer &optional regexp)
9452 "Clone local variables from FROM-BUFFER.
9453 Optional argument REGEXP selects variables to clone."
9456 (and (symbolp (car pair))
9458 (string-match regexp (symbol-name (car pair))))
9459 (set (make-local-variable (car pair))
9461 (buffer-local-variables from-buffer)))
9464 (defun org-run-like-in-org-mode (cmd)
9465 "Run a command, pretending that the current buffer is in Org-mode.
9466 This will temporarily bind local variables that are typically bound in
9467 Org-mode to the values they have in Org-mode, and then interactively
9469 (org-load-modules-maybe)
9470 (unless org-local-vars
9471 (setq org-local-vars (org-get-local-variables)))
9473 (dolist (var org-local-vars)
9474 (when (or (not (boundp (car var)))
9475 (eq (symbol-value (car var))
9476 (default-value (car var))))
9477 (push (list (car var) `(quote ,(cadr var))) binds)))
9479 (call-interactively (quote ,cmd))))))
9481 (defun org-get-category (&optional pos force-refresh)
9482 "Get the category applying to position POS."
9484 (if force-refresh (org-refresh-category-properties))
9485 (let ((pos (or pos (point))))
9486 (or (get-text-property pos 'org-category)
9487 (progn (org-refresh-category-properties)
9488 (get-text-property pos 'org-category))))))
9490 ;;; Refresh properties
9492 (defun org-refresh-properties (dprop tprop)
9493 "Refresh buffer text properties.
9494 DPROP is the drawer property and TPROP is either the
9495 corresponding text property to set, or an alist with each element
9496 being a text property (as a symbol) and a function to apply to
9497 the value of the drawer property."
9498 (let ((case-fold-search t)
9499 (inhibit-read-only t))
9500 (org-with-silent-modifications
9504 (goto-char (point-min))
9505 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9506 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9508 (defun org-refresh-property (tprop p)
9509 "Refresh the buffer text property TPROP from the drawer property P.
9510 The refresh happens only for the current tree (not subtree)."
9511 (unless (org-before-first-heading-p)
9513 (org-back-to-heading t)
9515 ;; TPROP is a text property symbol
9517 (point) (or (outline-next-heading) (point-max)) tprop p)
9518 ;; TPROP is an alist with (properties . function) elements
9522 (line-beginning-position) (or (outline-next-heading) (point-max))
9524 (funcall (cdr al) p))))))))
9526 (defun org-refresh-category-properties ()
9527 "Refresh category text properties in the buffer."
9528 (let ((case-fold-search t)
9529 (inhibit-read-only t)
9531 (cond ((null org-category)
9532 (if buffer-file-name
9533 (file-name-sans-extension
9534 (file-name-nondirectory buffer-file-name))
9536 ((symbolp org-category) (symbol-name org-category))
9538 (org-with-silent-modifications
9539 (org-with-wide-buffer
9540 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9541 ;; This is the default category for the buffer. If none is
9542 ;; found, fall-back to `org-category' or buffer file name.
9544 (point-min) (point-max)
9546 (catch 'buffer-category
9547 (goto-char (point-max))
9548 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9549 (let ((element (org-element-at-point)))
9550 (when (eq (org-element-type element) 'keyword)
9551 (throw 'buffer-category
9552 (org-element-property :value element)))))
9554 ;; Set sub-tree specific categories.
9555 (goto-char (point-min))
9556 (let ((regexp (org-re-property "CATEGORY")))
9557 (while (re-search-forward regexp nil t)
9558 (let ((value (org-match-string-no-properties 3)))
9559 (when (org-at-property-p)
9561 (save-excursion (org-back-to-heading t) (point))
9562 (save-excursion (org-end-of-subtree t t) (point))
9566 (defun org-refresh-stats-properties ()
9567 "Refresh stats text properties in the buffer."
9569 (org-with-silent-modifications
9573 (goto-char (point-min))
9574 (while (re-search-forward
9575 (concat org-outline-regexp-bol ".*"
9576 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9578 (setq stats (cond ((equal (match-string 3) "0") 0)
9580 (/ (* (string-to-number (match-string 2)) 100)
9581 (string-to-number (match-string 3))))
9582 (t (string-to-number (match-string 1)))))
9583 (org-back-to-heading t)
9584 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9585 'org-stats stats)))))))
9587 (defun org-refresh-effort-properties ()
9588 "Refresh effort properties"
9589 (org-refresh-properties
9591 '((effort . identity)
9592 (effort-minutes . org-duration-string-to-minutes))))
9596 ;;; Link abbreviations
9598 (defun org-link-expand-abbrev (link)
9599 "Apply replacements as defined in `org-link-abbrev-alist'."
9600 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9601 (let* ((key (match-string 1 link))
9602 (as (or (assoc key org-link-abbrev-alist-local)
9603 (assoc key org-link-abbrev-alist)))
9604 (tag (and (match-end 2) (match-string 3 link)))
9610 ((symbolp rpl) (funcall rpl tag))
9611 ((string-match "%(\\([^)]+\\))" rpl)
9614 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9615 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9616 ((string-match "%h" rpl)
9617 (replace-match (url-hexify-string (or tag "")) t t rpl))
9618 (t (concat rpl tag)))))
9621 ;;; Storing and inserting links
9623 (defvar org-insert-link-history nil
9624 "Minibuffer history for links inserted with `org-insert-link'.")
9626 (defvar org-stored-links nil
9627 "Contains the links stored with `org-store-link'.")
9629 (defvar org-store-link-plist nil
9630 "Plist with info about the most recently link created with `org-store-link'.")
9632 (defvar org-link-protocols nil
9633 "Link protocols added to Org-mode using `org-add-link-type'.")
9635 (defvar org-store-link-functions nil
9636 "List of functions that are called to create and store a link.
9637 Each function will be called in turn until one returns a non-nil
9638 value. Each function should check if it is responsible for creating
9639 this link (for example by looking at the major mode).
9640 If not, it must exit and return nil.
9641 If yes, it should return a non-nil value after a calling
9642 `org-store-link-props' with a list of properties and values.
9643 Special properties are:
9645 :type The link prefix, like \"http\". This must be given.
9646 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9647 This is obligatory as well.
9648 :description Optional default description for the second pair
9649 of brackets in an Org-mode link. The user can still change
9650 this when inserting this link into an Org-mode buffer.
9652 In addition to these, any additional properties can be specified
9653 and then used in capture templates.")
9655 (defun org-add-link-type (type &optional follow export)
9656 "Add TYPE to the list of `org-link-types'.
9657 Re-compute all regular expressions depending on `org-link-types'
9659 FOLLOW and EXPORT are two functions.
9661 FOLLOW should take the link path as the single argument and do whatever
9662 is necessary to follow the link, for example find a file or display
9665 EXPORT should format the link path for export to one of the export formats.
9666 It should be a function accepting three arguments:
9668 path the path of the link, the text after the prefix (like \"http:\")
9669 desc the description of the link, if any
9670 format the export format, a symbol like `html' or `latex' or `ascii'.
9672 The function may use the FORMAT information to return different values
9673 depending on the format. The return value will be put literally into
9674 the exported file. If the return value is nil, this means Org should
9675 do what it normally does with links which do not have EXPORT defined.
9677 Org mode has a built-in default for exporting links. If you are happy with
9678 this default, there is no need to define an export function for the link
9679 type. For a simple example of an export function, see `org-bbdb.el'."
9680 (add-to-list 'org-link-types type t)
9681 (org-make-link-regexps)
9682 (org-element-update-syntax)
9683 (if (assoc type org-link-protocols)
9684 (setcdr (assoc type org-link-protocols) (list follow export))
9685 (push (list type follow export) org-link-protocols)))
9687 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9688 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9691 (defun org-store-link (arg)
9692 "\\<org-mode-map>Store an org-link to the current location.
9693 This link is added to `org-stored-links' and can later be inserted
9694 into an Org buffer with \\[org-insert-link].
9696 For some link types, a prefix ARG is interpreted.
9697 For links to Usenet articles, ARG negates `org-gnus-prefer-web-links'.
9698 For file links, ARG negates `org-context-in-file-links'.
9700 A double prefix ARG force skipping storing functions that are not
9703 A triple prefix ARG force storing a link for each line in the
9706 (org-load-modules-maybe)
9707 (if (and (equal arg '(64)) (org-region-active-p))
9709 (let ((end (region-end)))
9710 (goto-char (region-beginning))
9712 (while (< (point-at-eol) end)
9713 (move-end-of-line 1) (activate-mark)
9714 (let (current-prefix-arg)
9715 (call-interactively 'org-store-link))
9716 (move-beginning-of-line 2)
9717 (set-mark (point)))))
9718 (org-with-limited-levels
9719 (setq org-store-link-plist nil)
9720 (let (link cpltxt desc description search
9721 txt custom-id agenda-link sfuns sfunsn)
9724 ;; Store a link using an external link type
9725 ((and (not (equal arg '(16)))
9728 nil (mapcar (lambda (f)
9729 (let (fs) (if (funcall f) (push f fs))))
9730 org-store-link-functions))
9731 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9732 (or (and (cdr sfuns)
9735 "Which function for creating the link? "
9736 sfunsn nil t (car sfunsn)))))
9737 (funcall (caar sfuns)))
9738 (setq link (plist-get org-store-link-plist :link)
9739 desc (or (plist-get org-store-link-plist
9740 :description) link))))
9742 ;; Store a link from a source code buffer.
9743 ((org-src-edit-buffer-p)
9747 (looking-at (concat (format org-coderef-label-format "\\(.*?\\)")
9749 (setq link (format "(%s)" (org-match-string-no-properties 1))))
9750 ((org-called-interactively-p 'any)
9752 (while (or (not label)
9753 (org-with-wide-buffer
9754 (goto-char (point-min))
9756 (regexp-quote (format org-coderef-label-format label))
9758 (when label (message "Label exists already") (sit-for 2))
9759 (setq label (read-string "Code line label: " label)))
9761 (setq link (format org-coderef-label-format label))
9762 (let ((gc (- 79 (length link))))
9763 (if (< (current-column) gc) (org-move-to-column gc t)
9766 (setq link (concat "(" label ")") desc nil)))
9767 (t (setq link nil))))
9769 ;; We are in the agenda, link to referenced location
9770 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9771 (let ((m (or (get-text-property (point) 'org-hd-marker)
9772 (get-text-property (point) 'org-marker))))
9774 (org-with-point-at m
9776 (if (org-called-interactively-p 'any)
9777 (call-interactively 'org-store-link)
9778 (org-store-link nil)))))))
9780 ((eq major-mode 'calendar-mode)
9781 (let ((cd (calendar-cursor-to-date)))
9784 (car org-time-stamp-formats)
9786 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9788 (org-store-link-props :type "calendar" :date cd)))
9790 ((eq major-mode 'help-mode)
9791 (setq link (concat "help:" (save-excursion
9792 (goto-char (point-min))
9793 (looking-at "^[^ ]+")
9795 (org-store-link-props :type "help"))
9797 ((eq major-mode 'w3-mode)
9798 (setq cpltxt (if (and (buffer-name)
9799 (not (string-match "Untitled" (buffer-name))))
9802 link (url-view-url t))
9803 (org-store-link-props :type "w3" :url (url-view-url t)))
9805 ((eq major-mode 'image-mode)
9806 (setq cpltxt (concat "file:"
9807 (abbreviate-file-name buffer-file-name))
9809 (org-store-link-props :type "image" :file buffer-file-name))
9811 ;; In dired, store a link to the file of the current line
9812 ((derived-mode-p 'dired-mode)
9813 (let ((file (dired-get-filename nil t)))
9815 (abbreviate-file-name
9816 (expand-file-name (dired-get-filename nil t)))
9817 ;; otherwise, no file so use current directory.
9819 (setq cpltxt (concat "file:" file)
9822 ((setq search (run-hook-with-args-until-success
9823 'org-create-file-search-functions))
9824 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9826 (setq cpltxt (or description link)))
9828 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9829 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9831 ;; Store a link using the target at point
9832 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9835 (abbreviate-file-name
9836 (buffer-file-name (buffer-base-buffer)))
9837 "::" (match-string 1))
9839 ((and (featurep 'org-id)
9840 (or (eq org-id-link-to-org-use-id t)
9841 (and (org-called-interactively-p 'any)
9842 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9843 (and (eq org-id-link-to-org-use-id
9844 'create-if-interactive-and-no-custom-id)
9846 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9847 ;; Store a link using the ID at point
9848 (setq link (condition-case nil
9849 (prog1 (org-id-store-link)
9850 (setq desc (or (plist-get org-store-link-plist
9854 ;; Probably before first headline, link only to file
9856 (abbreviate-file-name
9857 (buffer-file-name (buffer-base-buffer))))))))
9859 ;; Just link to current headline
9860 (setq cpltxt (concat "file:"
9861 (abbreviate-file-name
9862 (buffer-file-name (buffer-base-buffer)))))
9863 ;; Add a context search string
9864 (when (org-xor org-context-in-file-links arg)
9865 (let* ((ee (org-element-at-point))
9866 (et (org-element-type ee))
9867 (ev (plist-get (cadr ee) :value))
9868 (ek (plist-get (cadr ee) :key))
9869 (eok (and (stringp ek) (string-match "name" ek))))
9871 ((org-at-heading-p) nil)
9872 ((and (eq et 'keyword) eok) ev)
9873 ((org-region-active-p)
9874 (buffer-substring (region-beginning) (region-end)))))
9875 (when (or (null txt) (string-match "\\S-" txt))
9879 (org-make-org-heading-search-string txt)
9881 desc (or (and (eq et 'keyword) eok ev)
9882 (nth 4 (ignore-errors (org-heading-components)))
9884 (if (string-match "::\\'" cpltxt)
9885 (setq cpltxt (substring cpltxt 0 -2)))
9886 (setq link cpltxt))))
9888 ((buffer-file-name (buffer-base-buffer))
9889 ;; Just link to this file here.
9890 (setq cpltxt (concat "file:"
9891 (abbreviate-file-name
9892 (buffer-file-name (buffer-base-buffer)))))
9893 ;; Add a context string.
9894 (when (org-xor org-context-in-file-links arg)
9895 (setq txt (if (org-region-active-p)
9896 (buffer-substring (region-beginning) (region-end))
9897 (buffer-substring (point-at-bol) (point-at-eol))))
9898 ;; Only use search option if there is some text.
9899 (when (string-match "\\S-" txt)
9901 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9905 ((org-called-interactively-p 'interactive)
9906 (user-error "No method for storing a link from this buffer"))
9908 (t (setq link nil)))
9910 ;; We're done setting link and desc, clean up
9911 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9912 (setq link (or link cpltxt)
9913 desc (or desc cpltxt))
9914 (cond ((equal desc "NONE") (setq desc nil))
9915 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9916 (let ((d0 (match-string 3 desc))
9917 (p0 (match-string 5 desc)))
9919 (replace-regexp-in-string
9920 org-bracket-link-regexp
9922 (if (equal (length (match-string 0 desc))
9923 (length desc)) "*" "")) desc)))))
9926 (if (not (and (or (org-called-interactively-p 'any)
9927 executing-kbd-macro) link))
9928 (or agenda-link (and link (org-make-link-string link desc)))
9929 (push (list link desc) org-stored-links)
9930 (message "Stored: %s" (or desc link))
9932 (setq link (concat "file:" (abbreviate-file-name
9933 (buffer-file-name)) "::#" custom-id))
9934 (push (list link desc) org-stored-links))
9935 (car org-stored-links))))))
9937 (defun org-store-link-props (&rest plist)
9938 "Store link properties, extract names and addresses."
9940 (when (setq x (plist-get plist :from))
9941 (setq adr (mail-extract-address-components x))
9942 (setq plist (plist-put plist :fromname (car adr)))
9943 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9944 (when (setq x (plist-get plist :to))
9945 (setq adr (mail-extract-address-components x))
9946 (setq plist (plist-put plist :toname (car adr)))
9947 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9948 (let ((from (plist-get plist :from))
9949 (to (plist-get plist :to)))
9950 (when (and from to org-from-is-user-regexp)
9952 (plist-put plist :fromto
9953 (if (string-match org-from-is-user-regexp from)
9955 (concat "from %f"))))))
9956 (setq org-store-link-plist plist))
9958 (defun org-add-link-props (&rest plist)
9959 "Add these properties to the link property list."
9962 (setq key (pop plist) value (pop plist))
9963 (setq org-store-link-plist
9964 (plist-put org-store-link-plist key value)))))
9966 (defun org-email-link-description (&optional fmt)
9967 "Return the description part of an email link.
9968 This takes information from `org-store-link-plist' and formats it
9969 according to FMT (default from `org-email-link-description-format')."
9970 (setq fmt (or fmt org-email-link-description-format))
9971 (let* ((p org-store-link-plist)
9972 (to (plist-get p :toaddress))
9973 (from (plist-get p :fromaddress))
9976 (cons "%c" (plist-get p :fromto))
9977 (cons "%F" (plist-get p :from))
9978 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9979 (cons "%T" (plist-get p :to))
9980 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9981 (cons "%s" (plist-get p :subject))
9982 (cons "%d" (plist-get p :date))
9983 (cons "%m" (plist-get p :message-id)))))
9984 (when (string-match "%c" fmt)
9985 ;; Check if the user wrote this message
9986 (if (and org-from-is-user-regexp from to
9987 (save-match-data (string-match org-from-is-user-regexp from)))
9988 (setq fmt (replace-match "to %t" t t fmt))
9989 (setq fmt (replace-match "from %f" t t fmt))))
9990 (org-replace-escapes fmt table)))
9992 (defun org-make-org-heading-search-string (&optional string)
9993 "Make search string for the current headline or STRING."
9995 (and (derived-mode-p 'org-mode)
9997 (org-back-to-heading t)
9998 (org-element-property :raw-value (org-element-at-point))))))
9999 (lines org-context-in-file-links))
10000 (or string (setq s (concat "*" s))) ; Add * for headlines
10001 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10002 (when (and string (integerp lines) (> lines 0))
10003 (let ((slines (org-split-string s "\n")))
10004 (when (< lines (length slines))
10007 (reverse (nthcdr (- (length slines) lines)
10008 (reverse slines))) "\n")))))
10009 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10011 (defun org-make-link-string (link &optional description)
10012 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10013 (unless (org-string-nw-p link) (error "Empty link"))
10014 (let ((uri (cond ((string-match org-link-types-re link)
10015 (concat (match-string 1 link)
10016 (org-link-escape (substring link (match-end 1)))))
10017 ;; For readability, url-encode internal links only
10018 ;; when absolutely needed (i.e, when they contain
10019 ;; square brackets). File links however, are
10020 ;; encoded since, e.g., spaces are significant.
10021 ((or (file-name-absolute-p link)
10022 (org-string-match-p "\\`\\.\\.?/\\|[][]" link))
10023 (org-link-escape link))
10026 (and (org-string-nw-p description)
10027 ;; Remove brackets from description, as they are fatal.
10028 (replace-regexp-in-string
10029 "[][]" (lambda (m) (if (equal "[" m) "{" "}"))
10030 (org-trim description)))))
10033 (if description (format "[%s]" description) ""))))
10035 (defconst org-link-escape-chars
10038 "List of characters that should be escaped in a link when stored to Org.
10039 This is the list that is used for internal purposes.")
10041 (defconst org-link-escape-chars-browser
10044 "List of characters to be escaped before handing over to the browser.
10045 If you consider using this constant then you probably want to use
10046 the function `org-link-escape-browser' instead. See there why
10047 this constant is a candidate to be removed once Org drops support
10048 for Emacs 24.1 and 24.2.")
10050 (defun org-link-escape (text &optional table merge)
10051 "Return percent escaped representation of TEXT.
10052 TEXT is a string with the text to escape.
10053 Optional argument TABLE is a list with characters that should be
10054 escaped. When nil, `org-link-escape-chars' is used.
10055 If optional argument MERGE is set, merge TABLE into
10056 `org-link-escape-chars'."
10057 (let ((characters-to-encode
10058 (cond ((null table) org-link-escape-chars)
10059 (merge (append org-link-escape-chars table))
10063 (if (or (memq c characters-to-encode)
10064 (and org-url-hexify-p (or (< c 32) (> c 126))))
10065 (mapconcat (lambda (e) (format "%%%.2X" e))
10066 (or (encode-coding-char c 'utf-8)
10067 (error "Unable to percent escape character: %c" c))
10069 (char-to-string c)))
10072 (defun org-link-escape-browser (text)
10073 "Escape some characters before handing over to the browser.
10074 This function is a candidate to be removed together with the
10075 constant `org-link-escape-chars-browser' once Org drops support
10076 for Emacs 24.1 and 24.2. All calls to this function will have to
10077 be replaced with `url-encode-url' which is available since Emacs
10079 ;; Example with the Org link
10080 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10081 ;; to open the browser with +subject:"Release 8.2" filled into the
10082 ;; query field: In this case the variable TEXT contains the
10083 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10084 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10085 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10086 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10087 (if (fboundp 'url-encode-url)
10088 (url-encode-url text)
10089 (if (org-string-match-p
10090 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10092 (org-link-escape text org-link-escape-chars-browser)
10095 (defun org-link-unescape (str)
10096 "Unhex hexified Unicode parts in string STR.
10097 E.g. `%C3%B6' becomes the german o-Umlaut. This is the
10098 reciprocal of `org-link-escape', which see."
10099 (if (org-string-nw-p str)
10100 (replace-regexp-in-string
10101 "\\(%[0-9A-Za-z]\\{2\\}\\)+" #'org-link-unescape-compound str t t)
10104 (defun org-link-unescape-compound (hex)
10105 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10106 Note: this function also decodes single byte encodings like
10107 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10109 (let* ((bytes (cdr (split-string hex "%")))
10114 (let* ((val (string-to-number (pop bytes) 16))
10118 ((>= val 252) (cons 6 252))
10119 ((>= val 248) (cons 5 248))
10120 ((>= val 240) (cons 4 240))
10121 ((>= val 224) (cons 3 224))
10122 ((>= val 192) (cons 2 192))
10125 (if (>= val 192) (setq eat (car shift-xor)))
10126 (setq val (logxor val (cdr shift-xor)))
10127 (setq sum (+ (lsh sum (car shift-xor)) val))
10128 (if (> eat 0) (setq eat (- eat 1)))
10130 ((= 0 eat) ;multi byte
10131 (setq ret (concat ret (org-char-to-string sum)))
10133 ((not bytes) ; single byte(s)
10134 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10137 (defun org-link-unescape-single-byte-sequence (hex)
10138 "Unhexify hex-encoded single byte character sequences."
10139 (mapconcat (lambda (byte)
10140 (char-to-string (string-to-number byte 16)))
10141 (cdr (split-string hex "%")) ""))
10143 (defun org-xor (a b)
10147 (defun org-fixup-message-id-for-http (s)
10148 "Replace special characters in a message id, so it can be used in an http query."
10149 (when (string-match "%" s)
10150 (setq s (mapconcat (lambda (c)
10153 (char-to-string c)))
10155 (while (string-match "<" s)
10156 (setq s (replace-match "%3C" t t s)))
10157 (while (string-match ">" s)
10158 (setq s (replace-match "%3E" t t s)))
10159 (while (string-match "@" s)
10160 (setq s (replace-match "%40" t t s)))
10163 (defun org-link-prettify (link)
10164 "Return a human-readable representation of LINK.
10165 The car of LINK must be a raw link.
10166 The cdr of LINK must be either a link description or nil."
10167 (let ((desc (or (cadr link) "<no description>")))
10168 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10169 "<" (car link) ">")))
10172 (defun org-insert-link-global ()
10173 "Insert a link like Org-mode does.
10174 This command can be called in any mode to insert a link in Org-mode syntax."
10176 (org-load-modules-maybe)
10177 (org-run-like-in-org-mode 'org-insert-link))
10179 (defun org-insert-all-links (arg &optional pre post)
10180 "Insert all links in `org-stored-links'.
10181 When a universal prefix, do not delete the links from `org-stored-links'.
10182 When `ARG' is a number, insert the last N link(s).
10183 `PRE' and `POST' are optional arguments to define a string to
10184 prepend or to append."
10186 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10187 (links (copy-seq org-stored-links))
10189 (po (or post "\n"))
10191 (if (null org-stored-links)
10192 (message "No link to insert")
10193 (while (and (or (listp arg) (>= arg cnt))
10194 (setq l (if (listp arg)
10196 (pop org-stored-links))))
10197 (setq cnt (1+ cnt))
10199 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10202 (defun org-insert-last-stored-link (arg)
10203 "Insert the last link stored in `org-stored-links'."
10205 (org-insert-all-links arg "" "\n"))
10207 (defun org-link-fontify-links-to-this-file ()
10208 "Fontify links to the current file in `org-stored-links'."
10209 (let ((f (buffer-file-name)) a b)
10210 (setq a (mapcar (lambda(l)
10211 (let ((ll (car l)))
10212 (when (and (string-match "^file:\\(.+\\)::" ll)
10213 (equal f (expand-file-name (match-string 1 ll))))
10216 (when (featurep 'org-id)
10217 (setq b (mapcar (lambda(l)
10218 (let ((ll (car l)))
10219 (when (and (string-match "^id:\\(.+\\)$" ll)
10220 (equal f (expand-file-name
10221 (or (org-id-find-id-file
10222 (match-string 1 ll)) ""))))
10224 org-stored-links)))
10226 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10227 (delq nil (append a b)))))
10229 (defvar org-link-links-in-this-file nil)
10230 (defun org-insert-link (&optional complete-file link-location default-description)
10231 "Insert a link. At the prompt, enter the link.
10233 Completion can be used to insert any of the link protocol prefixes like
10234 http or ftp in use.
10236 The history can be used to select a link previously stored with
10237 `org-store-link'. When the empty string is entered (i.e. if you just
10238 press RET at the prompt), the link defaults to the most recently
10239 stored link. As SPC triggers completion in the minibuffer, you need to
10240 use M-SPC or C-q SPC to force the insertion of a space character.
10242 You will also be prompted for a description, and if one is given, it will
10243 be displayed in the buffer instead of the link.
10245 If there is already a link at point, this command will allow you to edit link
10246 and description parts.
10248 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10249 be selected using completion. The path to the file will be relative to the
10250 current directory if the file is in the current directory or a subdirectory.
10251 Otherwise, the link will be the absolute path as completed in the minibuffer
10252 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10253 option `org-link-file-path-type'.
10255 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10256 the current directory or below.
10258 With three \\[universal-argument] prefixes, negate the meaning of
10259 `org-keep-stored-link-after-insertion'.
10261 If `org-make-link-description-function' is non-nil, this function will be
10262 called with the link target, and the result will be the default
10265 If the LINK-LOCATION parameter is non-nil, this value will be
10266 used as the link location instead of reading one interactively.
10268 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10269 be used as the default description."
10271 (let* ((wcf (current-window-configuration))
10272 (origbuf (current-buffer))
10273 (region (if (org-region-active-p)
10274 (buffer-substring (region-beginning) (region-end))))
10275 (remove (and region (list (region-beginning) (region-end))))
10277 tmphist ; byte-compile incorrectly complains about this
10278 (link link-location)
10279 (abbrevs org-link-abbrev-alist-local)
10280 entry file all-prefixes auto-desc)
10282 (link-location) ; specified by arg, just use it.
10283 ((org-in-regexp org-bracket-link-regexp 1)
10284 ;; We do have a link at point, and we are going to edit it.
10285 (setq remove (list (match-beginning 0) (match-end 0)))
10286 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10287 (setq link (read-string "Link: "
10289 (org-match-string-no-properties 1)))))
10290 ((or (org-in-regexp org-angle-link-re)
10291 (org-in-regexp org-plain-link-re))
10292 ;; Convert to bracket link
10293 (setq remove (list (match-beginning 0) (match-end 0))
10294 link (read-string "Link: "
10295 (org-remove-angle-brackets (match-string 0)))))
10296 ((member complete-file '((4) (16)))
10297 ;; Completing read for file names.
10298 (setq link (org-file-complete-link complete-file)))
10300 ;; Read link, with completion for stored links.
10301 (org-link-fontify-links-to-this-file)
10302 (org-switch-to-buffer-other-window "*Org Links*")
10303 (with-current-buffer "*Org Links*"
10305 (insert "Insert a link.
10306 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10307 (when org-stored-links
10308 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10309 (insert (mapconcat 'org-link-prettify
10310 (reverse org-stored-links) "\n")))
10311 (goto-char (point-min)))
10312 (let ((cw (selected-window)))
10313 (select-window (get-buffer-window "*Org Links*" 'visible))
10314 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10315 (unless (pos-visible-in-window-p (point-max))
10316 (org-fit-window-to-buffer))
10317 (and (window-live-p cw) (select-window cw)))
10318 ;; Fake a link history, containing the stored links.
10319 (setq tmphist (append (mapcar 'car org-stored-links)
10320 org-insert-link-history))
10321 (setq all-prefixes (append (mapcar 'car abbrevs)
10322 (mapcar 'car org-link-abbrev-alist)
10327 (org-completing-read
10330 (mapcar (lambda (x) (concat x ":"))
10332 (mapcar 'car org-stored-links))
10335 (caar org-stored-links)))
10336 (if (not (string-match "\\S-" link))
10337 (user-error "No link selected"))
10339 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10341 (if (or (member link all-prefixes)
10342 (and (equal ":" (substring link -1))
10343 (member (substring link 0 -1) all-prefixes)
10344 (setq link (substring link 0 -1))))
10345 (setq link (with-current-buffer origbuf
10346 (org-link-try-special-completion link)))))
10347 (set-window-configuration wcf)
10348 (kill-buffer "*Org Links*"))
10349 (setq entry (assoc link org-stored-links))
10350 (or entry (push link org-insert-link-history))
10351 (setq desc (or desc (nth 1 entry)))))
10353 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10354 (not org-keep-stored-link-after-insertion))
10355 (setq org-stored-links (delq (assoc link org-stored-links)
10356 org-stored-links)))
10358 (if (and (string-match org-plain-link-re link)
10359 (not (string-match org-ts-regexp link)))
10360 ;; URL-like link, normalize the use of angular brackets.
10361 (setq link (org-remove-angle-brackets link)))
10363 ;; Check if we are linking to the current file with a search
10364 ;; option If yes, simplify the link by using only the search
10366 (when (and buffer-file-name
10367 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10368 (let* ((path (match-string 1 link))
10369 (case-fold-search nil)
10370 (search (match-string 2 link)))
10372 (if (equal (file-truename buffer-file-name) (file-truename path))
10373 ;; We are linking to this same file, with a search option
10374 (setq link search)))))
10376 ;; Check if we can/should use a relative path. If yes, simplify the link
10377 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10378 (let* ((type (match-string 1 link))
10379 (path (match-string 2 link))
10381 (case-fold-search nil))
10383 ((or (eq org-link-file-path-type 'absolute)
10384 (equal complete-file '(16)))
10385 (setq path (abbreviate-file-name (expand-file-name path))))
10386 ((eq org-link-file-path-type 'noabbrev)
10387 (setq path (expand-file-name path)))
10388 ((eq org-link-file-path-type 'relative)
10389 (setq path (file-relative-name path)))
10392 (if (string-match (concat "^" (regexp-quote
10394 (file-name-as-directory
10395 default-directory))))
10396 (expand-file-name path))
10397 ;; We are linking a file with relative path name.
10398 (setq path (substring (expand-file-name path)
10400 (setq path (abbreviate-file-name (expand-file-name path)))))))
10401 (setq link (concat type path))
10402 (if (equal desc origpath)
10403 (setq desc path))))
10405 (if org-make-link-description-function
10407 (or (condition-case nil
10408 (funcall org-make-link-description-function link desc)
10409 (error (progn (message "Can't get link description from `%s'"
10410 (symbol-name org-make-link-description-function))
10412 (read-string "Description: " default-description)))
10413 (if default-description (setq desc default-description)
10414 (setq desc (or (and auto-desc desc)
10415 (read-string "Description: " desc)))))
10417 (unless (string-match "\\S-" desc) (setq desc nil))
10418 (if remove (apply 'delete-region remove))
10419 (insert (org-make-link-string link desc))))
10421 (defun org-link-try-special-completion (type)
10422 "If there is completion support for link type TYPE, offer it."
10423 (let ((fun (intern (concat "org-" type "-complete-link"))))
10424 (if (functionp fun)
10426 (read-string "Link (no completion support): " (concat type ":")))))
10428 (defun org-file-complete-link (&optional arg)
10429 "Create a file link using completion."
10430 (let ((file (org-iread-file-name "File: "))
10431 (pwd (file-name-as-directory (expand-file-name ".")))
10432 (pwd1 (file-name-as-directory (abbreviate-file-name
10433 (expand-file-name ".")))))
10434 (cond ((equal arg '(16))
10436 (abbreviate-file-name (expand-file-name file))))
10438 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10439 (concat "file:" (match-string 1 file)))
10441 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10442 (expand-file-name file))
10444 (match-string 1 (expand-file-name file))))
10445 (t (concat "file:" file)))))
10447 (defun org-iread-file-name (&rest args)
10448 "Read-file-name using `ido-mode' speedup if available.
10449 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10450 See `read-file-name' for a description of parameters."
10451 (org-without-partial-completion
10452 (if (and org-completion-use-ido
10453 (fboundp 'ido-read-file-name)
10454 (org-bound-and-true-p ido-mode)
10455 (listp (nth 1 args)))
10456 (let ((ido-enter-matching-directory nil))
10457 (apply #'ido-read-file-name args))
10458 (apply #'read-file-name args))))
10460 (defun org-completing-read (&rest args)
10461 "Completing-read with SPACE being a normal character."
10462 (let ((enable-recursive-minibuffers t)
10463 (minibuffer-local-completion-map
10464 (copy-keymap minibuffer-local-completion-map)))
10465 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10466 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10467 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10468 (apply 'org-icompleting-read args)))
10470 (defun org-completing-read-no-i (&rest args)
10471 (let (org-completion-use-ido org-completion-use-iswitchb)
10472 (apply 'org-completing-read args)))
10474 (defun org-iswitchb-completing-read (prompt choices &rest args)
10475 "Use iswitch as a completing-read replacement to choose from choices.
10476 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10478 (let* ((iswitchb-use-virtual-buffers nil)
10479 (iswitchb-make-buflist-hook
10481 (setq iswitchb-temp-buflist choices))))
10482 (iswitchb-read-buffer prompt)))
10484 (defun org-icompleting-read (&rest args)
10485 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10486 Should be called like `completing-read'."
10487 (org-without-partial-completion
10488 (if (not (listp (nth 1 args)))
10489 ;; Ido only supports lists as the COLLECTION argument. Use
10490 ;; default completion function when second argument is not
10492 (apply #'completing-read args)
10493 (let ((ido-enter-matching-directory nil))
10494 (apply (cond ((and org-completion-use-ido
10495 (fboundp 'ido-completing-read)
10496 (org-bound-and-true-p ido-mode))
10497 #'ido-completing-read)
10498 ((and org-completion-use-iswitchb
10499 (org-bound-and-true-p iswitchb-mode))
10500 #'org-iswitchb-completing-read)
10501 (t #'completing-read))
10504 ;;; Opening/following a link
10506 (defvar org-link-search-failed nil)
10508 (defvar org-open-link-functions nil
10509 "Hook for functions finding a plain text link.
10510 These functions must take a single argument, the link content.
10511 They will be called for links that look like [[link text][description]]
10512 when LINK TEXT does not have a protocol like \"http:\" and does not look
10513 like a filename (e.g. \"./blue.png\").
10515 These functions will be called *before* Org attempts to resolve the
10516 link by doing text searches in the current buffer - so if you want a
10517 link \"[[target]]\" to still find \"<<target>>\", your function should
10518 handle this as a special case.
10520 When the function does handle the link, it must return a non-nil value.
10521 If it decides that it is not responsible for this link, it must return
10522 nil to indicate that that Org-mode can continue with other options
10523 like exact and fuzzy text search.")
10525 (defun org-next-link (&optional search-backward)
10526 "Move forward to the next link.
10527 If the link is in hidden text, expose it."
10529 (when (and org-link-search-failed (eq this-command last-command))
10530 (goto-char (point-min))
10531 (message "Link search wrapped back to beginning of buffer"))
10532 (setq org-link-search-failed nil)
10533 (let* ((pos (point))
10535 (a (assoc :link ct))
10536 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10537 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10538 ((looking-at org-any-link-re)
10539 ;; Don't stay stuck at link without an org-link face
10540 (forward-char (if search-backward -1 1))))
10541 (if (funcall srch-fun org-any-link-re nil t)
10543 (goto-char (match-beginning 0))
10544 (if (outline-invisible-p) (org-show-context)))
10546 (setq org-link-search-failed t)
10547 (message "No further link found"))))
10549 (defun org-previous-link ()
10550 "Move backward to the previous link.
10551 If the link is in hidden text, expose it."
10553 (funcall 'org-next-link t))
10555 (defun org-translate-link (s)
10556 "Translate a link string if a translation function has been defined."
10557 (if (and org-link-translation-function
10558 (fboundp org-link-translation-function)
10559 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10561 (setq s (funcall org-link-translation-function
10562 (match-string 1 s) (match-string 2 s)))
10563 (concat (car s) ":" (cdr s)))
10566 (defun org-translate-link-from-planner (type path)
10567 "Translate a link from Emacs Planner syntax so that Org can follow it.
10568 This is still an experimental function, your mileage may vary."
10570 ((member type '("http" "https" "news" "ftp"))
10571 ;; standard Internet links are the same.
10573 ((and (equal type "irc") (string-match "^//" path))
10574 ;; Planner has two / at the beginning of an irc link, we have 1.
10575 ;; We should have zero, actually....
10576 (setq path (substring path 1)))
10577 ((and (equal type "lisp") (string-match "^/" path))
10578 ;; Planner has a slash, we do not.
10579 (setq type "elisp" path (substring path 1)))
10580 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10581 ;; A typical message link. Planner has the id after the final slash,
10582 ;; we separate it with a hash mark
10583 (setq path (concat (match-string 1 path) "#"
10584 (org-remove-angle-brackets (match-string 2 path))))))
10587 (defun org-find-file-at-mouse (ev)
10588 "Open file link or URL at mouse."
10590 (mouse-set-point ev)
10591 (org-open-at-point 'in-emacs))
10593 (defun org-open-at-mouse (ev)
10594 "Open file link or URL at mouse.
10595 See the docstring of `org-open-file' for details."
10597 (mouse-set-point ev)
10598 (if (eq major-mode 'org-agenda-mode)
10599 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10600 (org-open-at-point))
10602 (defvar org-window-config-before-follow-link nil
10603 "The window configuration before following a link.
10604 This is saved in case the need arises to restore it.")
10607 (defun org-open-at-point-global ()
10608 "Follow a link like Org-mode does.
10609 This command can be called in any mode to follow a link that has
10612 (org-run-like-in-org-mode 'org-open-at-point))
10615 (defun org-open-link-from-string (s &optional arg reference-buffer)
10616 "Open a link in the string S, as if it was in Org-mode."
10617 (interactive "sLink: \nP")
10618 (let ((reference-buffer (or reference-buffer (current-buffer))))
10620 (let ((org-inhibit-startup (not reference-buffer)))
10623 (goto-char (point-min))
10624 (when reference-buffer
10625 (setq org-link-abbrev-alist-local
10626 (with-current-buffer reference-buffer
10627 org-link-abbrev-alist-local)))
10628 (org-open-at-point arg reference-buffer)))))
10630 (defvar org-open-at-point-functions nil
10631 "Hook that is run when following a link at point.
10633 Functions in this hook must return t if they identify and follow
10634 a link at point. If they don't find anything interesting at point,
10635 they must return nil.")
10637 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10638 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10639 (defun org-open-at-point (&optional arg reference-buffer)
10640 "Open link, timestamp, footnote or tags at point.
10642 When point is on a link, follow it. Normally, files will be
10643 opened by an appropriate application. If the optional prefix
10644 argument ARG is non-nil, Emacs will visit the file. With
10645 a double prefix argument, try to open outside of Emacs, in the
10646 application the system uses for this file type.
10648 When point is on a timestamp, open the agenda at the day
10651 When point is a footnote definition, move to the first reference
10652 found. If it is on a reference, move to the associated
10655 When point is on a headline, display a list of every link in the
10656 entry, so it is possible to pick one, or all, of them. If point
10657 is on a tag, call `org-tags-view' instead.
10659 When optional argument REFERENCE-BUFFER is non-nil, it should
10660 specify a buffer from where the link search should happen. This
10661 is used internally by `org-open-link-from-string'.
10663 On top of syntactically correct links, this function will open
10664 the link at point in comments or comment blocks and the first
10665 link in a property drawer line."
10667 ;; On a code block, open block's results.
10668 (unless (call-interactively 'org-babel-open-src-block-result)
10669 (org-load-modules-maybe)
10670 (setq org-window-config-before-follow-link (current-window-configuration))
10671 (org-remove-occur-highlights nil nil t)
10672 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10674 ;; Only consider supported types, even if they are not
10675 ;; the closest one.
10676 (org-element-lineage
10677 (org-element-context)
10678 '(comment comment-block footnote-definition footnote-reference
10679 headline inlinetask keyword link node-property
10682 (type (org-element-type context))
10683 (value (org-element-property :value context)))
10685 ((not context) (user-error "No link found"))
10686 ;; Exception: open timestamps and links in properties
10687 ;; drawers, keywords and comments.
10688 ((memq type '(comment comment-block keyword node-property))
10689 (cond ((org-in-regexp org-any-link-re)
10690 (org-open-link-from-string (match-string-no-properties 0)))
10691 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10692 (org-follow-timestamp-link))
10693 (t (user-error "No link found"))))
10694 ;; On a headline or an inlinetask, but not on a timestamp,
10695 ;; a link, a footnote reference or on tags.
10696 ((and (memq type '(headline inlinetask))
10698 (progn (save-excursion (beginning-of-line)
10699 (looking-at org-complex-heading-regexp))
10700 (or (not (match-beginning 5))
10701 (< (point) (match-beginning 5)))))
10702 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10704 (links-end (cdr data)))
10706 (dolist (link (if (stringp links) (list links) links))
10707 (search-forward link nil links-end)
10708 (goto-char (match-beginning 0))
10709 (org-open-at-point))
10710 (require 'org-attach)
10711 (org-attach-reveal 'if-exists))))
10712 ;; Do nothing on white spaces after an object, unless point
10713 ;; is right after it.
10716 (goto-char (org-element-property :end context))
10717 (skip-chars-backward " \t")
10719 (user-error "No link found"))
10720 ((eq type 'timestamp) (org-follow-timestamp-link))
10721 ;; On tags within a headline or an inlinetask.
10722 ((and (memq type '(headline inlinetask))
10723 (progn (save-excursion (beginning-of-line)
10724 (looking-at org-complex-heading-regexp))
10725 (and (match-beginning 5)
10726 (>= (point) (match-beginning 5)))))
10727 (org-tags-view arg (substring (match-string 5) 0 -1)))
10729 ;; When link is located within the description of another
10730 ;; link (e.g., an inline image), always open the parent
10732 (let*((link (let ((up (org-element-property :parent context)))
10733 (if (eq (org-element-type up) 'link) up context)))
10734 (type (org-element-property :type link))
10735 (path (org-link-unescape (org-element-property :path link))))
10736 ;; Switch back to REFERENCE-BUFFER needed when called in
10737 ;; a temporary buffer through `org-open-link-from-string'.
10738 (with-current-buffer (or reference-buffer (current-buffer))
10740 ((equal type "file")
10741 (if (string-match "[*?{]" (file-name-nondirectory path))
10743 ;; Look into `org-link-protocols' in order to find
10744 ;; a DEDICATED-FUNCTION to open file. The function
10745 ;; will be applied on raw link instead of parsed
10746 ;; link due to the limitation in `org-add-link-type'
10747 ;; ("open" function called with a single argument).
10748 ;; If no such function is found, fallback to
10749 ;; `org-open-file'.
10751 ;; Note : "file+emacs" and "file+sys" types are
10752 ;; hard-coded in order to escape the previous
10754 (let* ((option (org-element-property :search-option link))
10755 (app (org-element-property :application link))
10756 (dedicated-function
10757 (nth 1 (assoc app org-link-protocols))))
10758 (if dedicated-function
10759 (funcall dedicated-function
10761 (and option (concat "::" option))))
10762 (apply #'org-open-file
10765 ((equal app "emacs") 'emacs)
10766 ((equal app "sys") 'system))
10767 (cond ((not option) nil)
10768 ((org-string-match-p "\\`[0-9]+\\'" option)
10769 (list (string-to-number option)))
10771 (org-link-unescape option)))))))))
10772 ((assoc type org-link-protocols)
10773 (funcall (nth 1 (assoc type org-link-protocols)) path))
10774 ((equal type "help")
10775 (let ((f-or-v (intern path)))
10776 (cond ((fboundp f-or-v) (describe-function f-or-v))
10777 ((boundp f-or-v) (describe-variable f-or-v))
10778 (t (error "Not a known function or variable")))))
10779 ((member type '("http" "https" "ftp" "mailto" "news"))
10780 (browse-url (org-link-escape-browser (concat type ":" path))))
10781 ((equal type "doi")
10783 (org-link-escape-browser (concat org-doi-server-url path))))
10784 ((equal type "message") (browse-url (concat type ":" path)))
10785 ((equal type "shell")
10786 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10788 (if (or (and (org-string-nw-p
10789 org-confirm-shell-link-not-regexp)
10791 org-confirm-shell-link-not-regexp cmd))
10792 (not org-confirm-shell-link-function)
10793 (funcall org-confirm-shell-link-function
10794 (format "Execute \"%s\" in shell? "
10795 (org-add-props cmd nil
10796 'face 'org-warning))))
10798 (message "Executing %s" cmd)
10799 (shell-command cmd buf)
10800 (when (featurep 'midnight)
10801 (setq clean-buffer-list-kill-buffer-names
10802 (cons (buffer-name buf)
10803 clean-buffer-list-kill-buffer-names))))
10804 (user-error "Abort"))))
10805 ((equal type "elisp")
10807 (if (or (and (org-string-nw-p
10808 org-confirm-elisp-link-not-regexp)
10809 (org-string-match-p
10810 org-confirm-elisp-link-not-regexp cmd))
10811 (not org-confirm-elisp-link-function)
10812 (funcall org-confirm-elisp-link-function
10813 (format "Execute \"%s\" as elisp? "
10814 (org-add-props cmd nil
10815 'face 'org-warning))))
10816 (message "%s => %s" cmd
10817 (if (eq (string-to-char cmd) ?\()
10819 (call-interactively (read cmd))))
10820 (user-error "Abort"))))
10823 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10824 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10825 (unless (run-hook-with-args-until-success
10826 'org-open-link-functions path)
10827 (if (not arg) (org-mark-ring-push)
10828 (switch-to-buffer-other-window
10829 (org-get-buffer-for-internal-link (current-buffer))))
10831 (if (equal type "radio")
10832 `(org-search-radio-target
10833 ,(org-element-property :path link))
10835 ,(if (member type '("custom-id" "coderef"))
10836 (org-element-property :raw-link link)
10838 ;; Prevent fuzzy links from matching
10840 ,(and (equal type "fuzzy")
10842 (org-element-property :begin link)))))))
10843 (condition-case nil
10844 (let ((org-link-search-inhibit-query t)) (eval cmd))
10845 (error (progn (widen) (eval cmd)))))))
10846 (t (browse-url-at-point))))))
10847 ;; On a footnote reference or at a footnote definition's label.
10848 ((or (eq type 'footnote-reference)
10849 (and (eq type 'footnote-definition)
10851 ;; Do not validate action when point is on the
10852 ;; spaces right after the footnote label, in
10853 ;; order to be on par with behaviour on links.
10854 (skip-chars-forward " \t")
10856 (org-element-property :contents-begin context)))
10857 (if begin (< (point) begin)
10858 (= (org-element-property :post-affiliated context)
10859 (line-beginning-position)))))))
10860 (org-footnote-action))
10861 (t (user-error "No link found")))))
10862 (run-hook-with-args 'org-follow-link-hook)))
10864 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10865 "Offer links in the current entry and return the selected link.
10866 If there is only one link, return it.
10867 If NTH is an integer, return the NTH link found.
10868 If ZERO is a string, check also this string for a link, and if
10869 there is one, return it."
10870 (with-current-buffer buffer
10876 (in-emacs (if (integerp nth) nil nth))
10877 have-zero end links link c)
10878 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10879 (push (match-string 0 zero) links)
10880 (setq cnt (1- cnt) have-zero t))
10882 (org-back-to-heading t)
10883 (setq end (save-excursion (outline-next-heading) (point)))
10884 (while (re-search-forward org-any-link-re end t)
10885 (push (match-string 0) links))
10886 (setq links (org-uniquify (reverse links))))
10889 (message "No links"))
10890 ((equal (length links) 1)
10891 (setq link (car links)))
10892 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10893 (setq link (nth (if have-zero nth (1- nth)) links)))
10894 (t ; we have to select a link
10896 (save-window-excursion
10897 (delete-other-windows)
10898 (with-output-to-temp-buffer "*Select Link*"
10900 (if (not (string-match org-bracket-link-regexp l))
10901 (princ (format "[%c] %s\n" (incf cnt)
10902 (org-remove-angle-brackets l)))
10904 (princ (format "[%c] %s (%s)\n" (incf cnt)
10905 (match-string 3 l) (match-string 1 l)))
10906 (princ (format "[%c] %s\n" (incf cnt)
10907 (match-string 1 l))))))
10909 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10910 (message "Select link to open, RET to open all:")
10911 (setq c (read-char-exclusive))
10912 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10913 (when (equal c ?q) (user-error "Abort"))
10914 (if (equal c ?\C-m)
10916 (setq nth (- c ?0))
10917 (if have-zero (setq nth (1+ nth)))
10918 (unless (and (integerp nth) (>= (length links) nth))
10919 (user-error "Invalid link selection"))
10920 (setq link (nth (1- nth) links)))))
10921 (cons link end))))))
10923 ;; TODO: These functions are deprecated since `org-open-at-point'
10924 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10925 (defun org-open-file-with-system (path)
10926 "Open file at PATH using the system way of opening it."
10927 (org-open-file path 'system))
10928 (defun org-open-file-with-emacs (path)
10929 "Open file at PATH in Emacs."
10930 (org-open-file path 'emacs))
10935 (defvar org-create-file-search-functions nil
10936 "List of functions to construct the right search string for a file link.
10937 These functions are called in turn with point at the location to
10938 which the link should point.
10940 A function in the hook should first test if it would like to
10941 handle this file type, for example by checking the `major-mode'
10942 or the file extension. If it decides not to handle this file, it
10943 should just return nil to give other functions a chance. If it
10944 does handle the file, it must return the search string to be used
10945 when following the link. The search string will be part of the
10946 file link, given after a double colon, and `org-open-at-point'
10947 will automatically search for it. If special measures must be
10948 taken to make the search successful, another function should be
10949 added to the companion hook `org-execute-file-search-functions',
10952 A function in this hook may also use `setq' to set the variable
10953 `description' to provide a suggestion for the descriptive text to
10954 be used for this link when it gets inserted into an Org-mode
10955 buffer with \\[org-insert-link].")
10957 (defvar org-execute-file-search-functions nil
10958 "List of functions to execute a file search triggered by a link.
10960 Functions added to this hook must accept a single argument, the
10961 search string that was part of the file link, the part after the
10962 double colon. The function must first check if it would like to
10963 handle this search, for example by checking the `major-mode' or
10964 the file extension. If it decides not to handle this search, it
10965 should just return nil to give other functions a chance. If it
10966 does handle the search, it must return a non-nil value to keep
10967 other functions from trying.
10969 Each function can access the current prefix argument through the
10970 variable `current-prefix-arg'. Note that a single prefix is used
10971 to force opening a link in Emacs, so it may be good to only use a
10972 numeric or double prefix to guide the search function.
10974 In case this is needed, a function in this hook can also restore
10975 the window configuration before `org-open-at-point' was called using:
10977 (set-window-configuration org-window-config-before-follow-link)")
10979 (defun org-search-radio-target (target)
10980 "Search a radio target matching TARGET in current buffer.
10981 White spaces are not significant."
10982 (let ((re (format "<<<%s>>>"
10983 (mapconcat #'regexp-quote
10984 (org-split-string target "[ \t\n]+")
10985 "[ \t]+\\(?:\n[ \t]*\\)?")))
10987 (goto-char (point-min))
10988 (catch :radio-match
10989 (while (re-search-forward re nil t)
10991 (let ((object (org-element-context)))
10992 (when (eq (org-element-type object) 'radio-target)
10993 (goto-char (org-element-property :begin object))
10994 (org-show-context 'link-search)
10995 (throw :radio-match nil))))
10997 (user-error "No match for radio target: %s" target))))
10999 (defun org-link-search (s &optional avoid-pos stealth)
11000 "Search for a search string S.
11002 If S starts with \"#\", it triggers a custom ID search.
11004 If S is enclosed within parenthesis, it initiates a coderef
11007 If S is surrounded by forward slashes, it is interpreted as
11008 a regular expression. In Org mode files, this will create an
11009 `org-occur' sparse tree. In ordinary files, `occur' will be used
11010 to list matches. If the current buffer is in `dired-mode', grep
11011 will be used to search in all files.
11013 When AVOID-POS is given, ignore matches near that position.
11015 When optional argument STEALTH is non-nil, do not modify
11016 visibility around point, thus ignoring `org-show-context-detail'
11019 Search is case-insensitive and ignores white spaces. Return type
11020 of matched result, with is either `dedicated' or `fuzzy'."
11021 (unless (org-string-nw-p s) (error "Invalid search string \"%s\"" s))
11022 (let* ((case-fold-search t)
11024 (normalized (replace-regexp-in-string "\n[ \t]*" " " s))
11025 (words (org-split-string s "[ \t\n]+"))
11026 (s-multi-re (mapconcat #'regexp-quote words "[ \t]+\\(?:\n[ \t]*\\)?"))
11027 (s-single-re (mapconcat #'regexp-quote words "[ \t]+"))
11030 ;; Check if there are any special search functions.
11031 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11032 ((eq (string-to-char s) ?#)
11033 ;; Look for a custom ID S if S starts with "#".
11034 (let* ((id (substring normalized 1))
11035 (match (org-find-property "CUSTOM_ID" id)))
11036 (if match (progn (goto-char match) (setf type 'dedicated))
11037 (error "No match for custom ID: %s" id))))
11038 ((string-match "\\`(\\(.*\\))\\'" normalized)
11039 ;; Look for coderef targets if S is enclosed within parenthesis.
11040 (let ((coderef (match-string-no-properties 1 normalized))
11041 (re (substring s-single-re 1 -1)))
11042 (goto-char (point-min))
11043 (catch :coderef-match
11044 (while (re-search-forward re nil t)
11045 (let ((element (org-element-at-point)))
11046 (when (and (memq (org-element-type element)
11047 '(example-block src-block))
11048 ;; Build proper regexp according to current
11049 ;; block's label format.
11052 (or (org-element-property :label-fmt element)
11053 org-coderef-label-format))))
11055 (beginning-of-line)
11056 (looking-at (format ".*?\\(%s\\)[ \t]*$"
11057 (format label-fmt coderef))))))
11058 (setq type 'dedicated)
11059 (goto-char (match-beginning 1))
11060 (throw :coderef-match nil))))
11062 (error "No match for coderef: %s" coderef))))
11063 ((string-match "\\`/\\(.*\\)/\\'" normalized)
11064 ;; Look for a regular expression.
11065 (funcall (if (derived-mode-p 'org-mode) #'org-occur #'org-do-occur)
11066 (match-string 1 s)))
11069 (let* ((starred (eq (string-to-char normalized) ?*))
11070 (headline-search (and (derived-mode-p 'org-mode)
11071 (or org-link-search-must-match-exact-headline
11074 ;; Look for targets, only if not in a headline search.
11075 ((and (not headline-search)
11076 (let ((target (format "<<%s>>" s-multi-re)))
11077 (catch :target-match
11078 (goto-char (point-min))
11079 (while (re-search-forward target nil t)
11081 (let ((context (org-element-context)))
11082 (when (eq (org-element-type context) 'target)
11083 (setq type 'dedicated)
11084 (goto-char (org-element-property :begin context))
11085 (throw :target-match t))))
11087 ;; Look for elements named after S, only if not in a headline
11089 ((and (not headline-search)
11090 (let ((name (format "^[ \t]*#\\+NAME: +%s[ \t]*$" s-single-re)))
11092 (goto-char (point-min))
11093 (while (re-search-forward name nil t)
11094 (let ((element (org-element-at-point)))
11095 (when (equal (org-split-string
11096 (org-element-property :name element)
11099 (setq type 'dedicated)
11100 (beginning-of-line)
11101 (throw :name-match t))))
11103 ;; Regular text search. Prefer headlines in Org mode
11105 ((and (derived-mode-p 'org-mode)
11106 (let* ((wspace "[ \t]")
11107 (wspaceopt (concat wspace "*"))
11108 (cookie (concat "\\(?:"
11110 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11113 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)"))
11115 org-outline-regexp-bol
11116 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11117 "\\(?:\\[#.\\][ \t]+\\)?"
11118 "\\(?:" org-comment-string "[ \t]+\\)?"
11120 (let ((title (mapconcat #'regexp-quote
11122 (concat sep "+"))))
11123 (if starred (substring title 1) title))
11125 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11127 (goto-char (point-min))
11128 (re-search-forward re nil t)))
11129 (goto-char (match-beginning 0))
11130 (setq type 'dedicated))
11131 ;; Offer to create non-existent headline depending on
11132 ;; `org-link-search-must-match-exact-headline'.
11133 ((and headline-search
11134 (not org-link-search-inhibit-query)
11135 (eq org-link-search-must-match-exact-headline 'query-to-create)
11136 (yes-or-no-p "No match - create this as a new heading? "))
11137 (goto-char (point-max))
11138 (unless (bolp) (newline))
11139 (org-insert-heading nil t t)
11141 (beginning-of-line 0))
11142 ;; Only headlines are looked after. No need to process
11143 ;; further: throw an error.
11146 (error "No match for fuzzy expression: %s" normalized))
11147 ;; Regular text search.
11148 ((catch :fuzzy-match
11149 (goto-char (point-min))
11150 (while (re-search-forward s-multi-re nil t)
11151 ;; Skip match if it contains AVOID-POS or it is included
11152 ;; in a link with a description but outside the
11154 (unless (or (and avoid-pos
11155 (<= (match-beginning 0) avoid-pos)
11156 (> (match-end 0) avoid-pos))
11157 (and (save-match-data
11158 (org-in-regexp org-bracket-link-regexp))
11159 (match-beginning 3)
11160 (or (> (match-beginning 3) (point))
11161 (<= (match-end 3) (point)))
11162 (org-element-lineage
11163 (save-match-data (org-element-context))
11165 (goto-char (match-beginning 0))
11167 (throw :fuzzy-match t)))
11169 ;; All failed. Throw an error.
11170 (t (goto-char origin)
11171 (error "No match for fuzzy expression: %s" normalized))))))
11172 ;; Disclose surroundings of match, if appropriate.
11173 (when (and (derived-mode-p 'org-mode) (not stealth))
11174 (org-show-context 'link-search))
11177 (defun org-get-buffer-for-internal-link (buffer)
11178 "Return a buffer to be used for displaying the link target of internal links."
11180 ((not org-display-internal-link-with-indirect-buffer)
11182 ((string-match "(Clone)$" (buffer-name buffer))
11183 (message "Buffer is already a clone, not making another one")
11184 ;; we also do not modify visibility in this case
11186 (t ; make a new indirect buffer for displaying the link
11187 (let* ((bn (buffer-name buffer))
11188 (ibn (concat bn "(Clone)"))
11189 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11190 (with-current-buffer ib (org-overview))
11193 (defun org-do-occur (regexp &optional cleanup)
11194 "Call the Emacs command `occur'.
11195 If CLEANUP is non-nil, remove the printout of the regular expression
11196 in the *Occur* buffer. This is useful if the regex is long and not useful
11200 (let ((cwin (selected-window)) win beg end)
11201 (when (setq win (get-buffer-window "*Occur*"))
11202 (select-window win))
11203 (goto-char (point-min))
11204 (when (re-search-forward "match[a-z]+" nil t)
11205 (setq beg (match-end 0))
11206 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11207 (setq end (1- (match-beginning 0)))))
11208 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11209 (goto-char (point-min))
11210 (select-window cwin))))
11212 ;;; The mark ring for links jumps
11214 (defvar org-mark-ring nil
11215 "Mark ring for positions before jumps in Org-mode.")
11216 (defvar org-mark-ring-last-goto nil
11217 "Last position in the mark ring used to go back.")
11218 ;; Fill and close the ring
11219 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11220 (loop for i from 1 to org-mark-ring-length do
11221 (push (make-marker) org-mark-ring))
11222 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11225 (defun org-mark-ring-push (&optional pos buffer)
11226 "Put the current position or POS into the mark ring and rotate it."
11228 (setq pos (or pos (point)))
11229 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11230 (move-marker (car org-mark-ring)
11232 (or buffer (current-buffer)))
11234 (substitute-command-keys
11235 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11237 (defun org-mark-ring-goto (&optional n)
11238 "Jump to the previous position in the mark ring.
11239 With prefix arg N, jump back that many stored positions. When
11240 called several times in succession, walk through the entire ring.
11241 Org-mode commands jumping to a different position in the current file,
11242 or to another Org-mode file, automatically push the old position
11246 (if (eq last-command this-command)
11247 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11248 (setq p org-mark-ring))
11249 (setq org-mark-ring-last-goto p)
11251 (org-pop-to-buffer-same-window (marker-buffer m))
11253 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11255 (defun org-remove-angle-brackets (s)
11256 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11257 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11259 (defun org-add-angle-brackets (s)
11260 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11261 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11263 (defun org-remove-double-quotes (s)
11264 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11265 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11268 ;;; Following specific links
11270 (defun org-follow-timestamp-link ()
11271 "Open an agenda view for the time-stamp date/range at point."
11273 ((org-at-date-range-p t)
11274 (let ((org-agenda-start-on-weekday)
11275 (t1 (match-string 1))
11276 (t2 (match-string 2)) tt1 tt2)
11277 (setq tt1 (time-to-days (org-time-string-to-time t1))
11278 tt2 (time-to-days (org-time-string-to-time t2)))
11279 (let ((org-agenda-buffer-tmp-name
11280 (format "*Org Agenda(a:%s)"
11281 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11282 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11283 ((org-at-timestamp-p t)
11284 (let ((org-agenda-buffer-tmp-name
11285 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11286 (org-agenda-list nil (time-to-days (org-time-string-to-time
11287 (substring (match-string 1) 0 10)))
11289 (t (error "This should not happen"))))
11292 ;;; Following file links
11293 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11294 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11295 (declare-function mailcap-mime-info
11296 "mailcap" (string &optional request no-decode))
11297 (defvar org-wait nil)
11298 (defun org-open-file (path &optional in-emacs line search)
11299 "Open the file at PATH.
11300 First, this expands any special file name abbreviations. Then the
11301 configuration variable `org-file-apps' is checked if it contains an
11302 entry for this file type, and if yes, the corresponding command is launched.
11304 If no application is found, Emacs simply visits the file.
11306 With optional prefix argument IN-EMACS, Emacs will visit the file.
11307 With a double \\[universal-argument] \\[universal-argument] \
11308 prefix arg, Org tries to avoid opening in Emacs
11309 and to use an external application to visit the file.
11311 Optional LINE specifies a line to go to, optional SEARCH a string
11312 to search for. If LINE or SEARCH is given, the file will be
11313 opened in Emacs, unless an entry from org-file-apps that makes
11314 use of groups in a regexp matches.
11316 If you want to change the way frames are used when following a
11317 link, please customize `org-link-frame-setup'.
11319 If the file does not exist, an error is thrown."
11320 (let* ((file (if (equal path "")
11322 (substitute-in-file-name (expand-file-name path))))
11323 (file-apps (append org-file-apps (org-default-apps)))
11324 (apps (org-remove-if
11325 'org-file-apps-entry-match-against-dlink-p file-apps))
11326 (apps-dlink (org-remove-if-not
11327 'org-file-apps-entry-match-against-dlink-p file-apps))
11328 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11329 (dirp (if remp nil (file-directory-p file)))
11330 (file (if (and dirp org-open-directory-means-index-dot-org)
11331 (concat (file-name-as-directory file) "index.org")
11333 (a-m-a-p (assq 'auto-mode apps))
11334 (dfile (downcase file))
11335 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11336 (link (cond ((and (eq line nil)
11340 (concat file "::" (number-to-string line)))
11342 (concat file "::" search))))
11343 (dlink (downcase link))
11344 (old-buffer (current-buffer))
11346 (old-mode major-mode)
11347 ext cmd link-match-data)
11348 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11349 (setq ext (match-string 1 dfile))
11350 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11351 (setq ext (match-string 1 dfile))))
11353 ((member in-emacs '((16) system))
11354 (setq cmd (cdr (assoc 'system apps))))
11355 (in-emacs (setq cmd 'emacs))
11357 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11358 (and dirp (cdr (assoc 'directory apps)))
11359 ; first, try matching against apps-dlink
11360 ; if we get a match here, store the match data for later
11361 (let ((match (assoc-default dlink apps-dlink
11364 (progn (setq link-match-data (match-data))
11366 (progn (setq in-emacs (or in-emacs line search))
11367 nil))) ; if we have no match in apps-dlink,
11368 ; always open the file in emacs if line or search
11369 ; is given (for backwards compatibility)
11370 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11372 (cdr (assoc ext apps))
11373 (cdr (assoc t apps))))))
11374 (when (eq cmd 'system)
11375 (setq cmd (cdr (assoc 'system apps))))
11376 (when (eq cmd 'default)
11377 (setq cmd (cdr (assoc t apps))))
11378 (when (eq cmd 'mailcap)
11380 (mailcap-parse-mailcaps)
11381 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11382 (command (mailcap-mime-info mime-type)))
11383 (if (stringp command)
11385 (setq cmd 'emacs))))
11386 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11387 (not (file-exists-p file))
11388 (not org-open-non-existing-files))
11389 (user-error "No such file: %s" file))
11391 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11392 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11393 (while (string-match "['\"]%s['\"]" cmd)
11394 (setq cmd (replace-match "%s" t t cmd)))
11395 (while (string-match "%s" cmd)
11396 (setq cmd (replace-match
11398 (shell-quote-argument
11399 (convert-standard-filename file)))
11402 ;; Replace "%1", "%2" etc. in command with group matches from regex
11404 (let ((match-index 1)
11405 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11406 (set-match-data link-match-data)
11407 (while (<= match-index number-of-groups)
11408 (let ((regex (concat "%" (number-to-string match-index)))
11409 (replace-with (match-string match-index dlink)))
11410 (while (string-match regex cmd)
11411 (setq cmd (replace-match replace-with t t cmd))))
11412 (setq match-index (+ match-index 1)))))
11414 (save-window-excursion
11415 (message "Running %s...done" cmd)
11416 (start-process-shell-command cmd nil cmd)
11417 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11420 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11422 (if line (progn (org-goto-line line)
11423 (if (derived-mode-p 'org-mode)
11425 (if search (org-link-search search))))
11427 (let ((file (convert-standard-filename file)))
11429 (set-match-data link-match-data)
11431 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11432 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11433 (or (not (equal old-buffer (current-buffer)))
11434 (not (equal old-pos (point))))
11435 (org-mark-ring-push old-pos old-buffer))))
11437 (defun org-file-apps-entry-match-against-dlink-p (entry)
11438 "This function returns non-nil if `entry' uses a regular
11439 expression which should be matched against the whole link by
11442 It assumes that is the case when the entry uses a regular
11443 expression which has at least one grouping construct and the
11444 action is either a lisp form or a command string containing
11445 '%1', i.e. using at least one subexpression match as a
11447 (let ((selector (car entry))
11448 (action (cdr entry)))
11449 (if (stringp selector)
11450 (and (> (regexp-opt-depth selector) 0)
11451 (or (and (stringp action)
11452 (string-match "%[0-9]" action))
11456 (defun org-default-apps ()
11457 "Return the default applications for this operating system."
11459 ((eq system-type 'darwin)
11460 org-file-apps-defaults-macosx)
11461 ((eq system-type 'windows-nt)
11462 org-file-apps-defaults-windowsnt)
11463 (t org-file-apps-defaults-gnu)))
11465 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11466 "Convert extensions to regular expressions in the cars of LIST.
11467 Also, weed out any non-string entries, because the return value is used
11468 only for regexp matching.
11469 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11470 point to the symbol `emacs', indicating that the file should
11471 be opened in Emacs."
11474 (mapcar (lambda (x)
11475 (if (not (stringp (car x)))
11477 (if (string-match "\\W" (car x))
11479 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11482 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11484 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11485 (defun org-file-remote-p (file)
11486 "Test whether FILE specifies a location on a remote system.
11487 Return non-nil if the location is indeed remote.
11489 For example, the filename \"/user@host:/foo\" specifies a location
11490 on the system \"/user@host:\"."
11491 (cond ((fboundp 'file-remote-p)
11492 (file-remote-p file))
11493 ((fboundp 'tramp-handle-file-remote-p)
11494 (tramp-handle-file-remote-p file))
11495 ((and (boundp 'ange-ftp-name-format)
11496 (string-match (car ange-ftp-name-format) file))
11502 (defun org-get-org-file ()
11503 "Read a filename, with default directory `org-directory'."
11504 (let ((default (or org-default-notes-file remember-data-file)))
11505 (read-file-name (format "File name [%s]: " default)
11506 (file-name-as-directory org-directory)
11509 (defun org-notes-order-reversed-p ()
11510 "Check if the current file should receive notes in reversed order."
11512 ((not org-reverse-note-order) nil)
11513 ((eq t org-reverse-note-order) t)
11514 ((not (listp org-reverse-note-order)) nil)
11516 (let ((all org-reverse-note-order)
11518 (while (setq entry (pop all))
11519 (if (string-match (car entry) buffer-file-name)
11520 (throw 'exit (cdr entry))))
11523 (defvar org-refile-target-table nil
11524 "The list of refile targets, created by `org-refile'.")
11526 (defvar org-agenda-new-buffers nil
11527 "Buffers created to visit agenda files.")
11529 (defvar org-refile-cache nil
11530 "Cache for refile targets.")
11532 (defvar org-refile-markers nil
11533 "All the markers used for caching refile locations.")
11535 (defun org-refile-marker (pos)
11536 "Get a new refile marker, but only if caching is in use."
11537 (if (not org-refile-use-cache)
11539 (let ((m (make-marker)))
11540 (move-marker m pos)
11541 (push m org-refile-markers)
11544 (defun org-refile-cache-clear ()
11545 "Clear the refile cache and disable all the markers."
11546 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11547 (setq org-refile-markers nil)
11548 (setq org-refile-cache nil)
11549 (message "Refile cache has been cleared"))
11551 (defun org-refile-cache-check-set (set)
11552 "Check if all the markers in the cache still have live buffers."
11555 (while (and set (setq marker (nth 3 (pop set))))
11556 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11557 (when (and marker (null (marker-buffer marker)))
11558 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11560 (throw 'exit nil)))
11563 (defun org-refile-cache-put (set &rest identifiers)
11564 "Push the refile targets SET into the cache, under IDENTIFIERS."
11565 (let* ((key (sha1 (prin1-to-string identifiers)))
11566 (entry (assoc key org-refile-cache)))
11569 (push (cons key set) org-refile-cache))))
11571 (defun org-refile-cache-get (&rest identifiers)
11572 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11574 ((not org-refile-cache) nil)
11575 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11577 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11578 org-refile-cache))))
11579 (and set (org-refile-cache-check-set set) set)))))
11581 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11582 "Produce a table with refile targets."
11583 (let ((case-fold-search nil)
11584 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11585 (entries (or org-refile-targets '((nil . (:level . 1)))))
11586 targets tgs txt re files f desc descre fast-path-p level pos0)
11587 (message "Getting targets...")
11588 (with-current-buffer (or default-buffer (current-buffer))
11589 (while (setq entry (pop entries))
11590 (setq files (car entry) desc (cdr entry))
11591 (setq fast-path-p nil)
11593 ((null files) (setq files (list (current-buffer))))
11594 ((eq files 'org-agenda-files)
11595 (setq files (org-agenda-files 'unrestricted)))
11596 ((and (symbolp files) (fboundp files))
11597 (setq files (funcall files)))
11598 ((and (symbolp files) (boundp files))
11599 (setq files (symbol-value files))))
11600 (if (stringp files) (setq files (list files)))
11602 ((eq (car desc) :tag)
11603 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11604 ((eq (car desc) :todo)
11605 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11606 ((eq (car desc) :regexp)
11607 (setq descre (cdr desc)))
11608 ((eq (car desc) :level)
11609 (setq descre (concat "^\\*\\{" (number-to-string
11610 (if org-odd-levels-only
11611 (1- (* 2 (cdr desc)))
11614 ((eq (car desc) :maxlevel)
11615 (setq fast-path-p t)
11616 (setq descre (concat "^\\*\\{1," (number-to-string
11617 (if org-odd-levels-only
11618 (1- (* 2 (cdr desc)))
11621 (t (error "Bad refiling target description %s" desc)))
11622 (while (setq f (pop files))
11623 (with-current-buffer
11624 (if (bufferp f) f (org-get-agenda-file-buffer f))
11626 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11628 (if (bufferp f) (setq f (buffer-file-name
11629 (buffer-base-buffer f))))
11630 (setq f (and f (expand-file-name f)))
11631 (if (eq org-refile-use-outline-path 'file)
11632 (push (list (file-name-nondirectory f) f nil nil) tgs))
11636 (goto-char (point-min))
11637 (while (re-search-forward descre nil t)
11638 (goto-char (setq pos0 (point-at-bol)))
11640 (when org-refile-target-verify-function
11642 (or (funcall org-refile-target-verify-function)
11644 (when (and (looking-at org-complex-heading-regexp)
11645 (not (member (match-string 4) excluded-entries))
11647 (setq level (org-reduced-level
11648 (- (match-end 1) (match-beginning 1)))
11649 txt (org-link-display-format (match-string 4))
11650 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11651 re (format org-complex-heading-regexp-format
11652 (regexp-quote (match-string 4))))
11653 (when org-refile-use-outline-path
11654 (setq txt (mapconcat
11657 (if (eq org-refile-use-outline-path
11659 (list (file-name-nondirectory
11661 (buffer-base-buffer))))
11662 (if (eq org-refile-use-outline-path
11664 (list (buffer-file-name
11665 (buffer-base-buffer)))))
11666 (org-get-outline-path fast-path-p
11670 (push (list txt f re (org-refile-marker (point)))
11672 (when (= (point) pos0)
11673 ;; verification function has not moved point
11674 (goto-char (point-at-eol))))))))
11675 (when org-refile-use-cache
11676 (org-refile-cache-put tgs (buffer-file-name) descre))
11677 (setq targets (append tgs targets))))))
11678 (message "Getting targets...done")
11679 (nreverse targets)))
11681 (defun org-protect-slash (s)
11682 (while (string-match "/" s)
11683 (setq s (replace-match "\\" t t s)))
11686 (defvar org-olpa (make-vector 20 nil))
11688 (defun org-get-outline-path (&optional fastp level heading)
11689 "Return the outline path to the current entry, as a list.
11691 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11692 routine which makes outline path derivations for an entire file,
11693 avoiding backtracing. Refile target collection makes use of that."
11697 (error "Outline path failure, more than 19 levels"))
11698 (loop for i from level upto 19 do
11699 (aset org-olpa i nil))
11701 (delq nil (append org-olpa nil))
11702 (aset org-olpa level heading)))
11703 (let (rtn case-fold-search)
11707 (while (org-up-heading-safe)
11708 (when (looking-at org-complex-heading-regexp)
11710 (replace-regexp-in-string
11711 ;; Remove statistical/checkboxes cookies
11712 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11713 (org-match-string-no-properties 4)))
11717 (defun org-format-outline-path (path &optional width prefix separator)
11718 "Format the outline path PATH for display.
11719 WIDTH is the maximum number of characters that is available.
11720 PREFIX is a prefix to be included in the returned string,
11721 such as the file name.
11722 SEPARATOR is inserted between the different parts of the path,
11723 the default is \"/\"."
11724 (setq width (or width 79))
11725 (if prefix (setq width (- width (length prefix))))
11728 (let* ((nsteps (length path))
11729 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11730 (maxwidth (if (<= total-width width)
11731 10000 ;; everything fits
11732 ;; we need to shorten the level headings
11733 (/ (- width nsteps) nsteps)))
11734 (org-odd-levels-only nil)
11736 (total (1+ (length prefix))))
11737 (setq maxwidth (max maxwidth 10))
11739 (if prefix (or separator "/"))
11743 (if (and (= n nsteps) (< maxwidth 10000))
11744 (setq maxwidth (- total-width total)))
11745 (if (< (length h) maxwidth)
11746 (progn (setq total (+ total (length h) 1)) h)
11747 (setq h (substring h 0 (- maxwidth 2))
11748 total (+ total maxwidth 1))
11749 (if (string-match "[ \t]+\\'" h)
11750 (setq h (substring h 0 (match-beginning 0))))
11751 (setq h (concat h "..")))
11752 (org-add-props h nil 'face
11753 (nth (% (1- n) org-n-level-faces)
11756 path (or separator "/"))))))
11758 (defun org-display-outline-path (&optional file current separator just-return-string)
11759 "Display the current outline path in the echo area.
11761 If FILE is non-nil, prepend the output with the file name.
11762 If CURRENT is non-nil, append the current heading to the output.
11763 SEPARATOR is passed through to `org-format-outline-path'. It separates
11764 the different parts of the path and defaults to \"/\".
11765 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11767 (let* (case-fold-search
11768 (bfn (buffer-file-name (buffer-base-buffer)))
11769 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11771 (if current (setq path (append path
11773 (org-back-to-heading t)
11774 (if (looking-at org-complex-heading-regexp)
11775 (list (match-string 4)))))))
11777 (org-format-outline-path
11780 (and file bfn (concat (file-name-nondirectory bfn) separator))
11782 (if just-return-string
11783 (org-no-properties res)
11784 (org-unlogged-message "%s" res))))
11786 (defvar org-refile-history nil
11787 "History for refiling operations.")
11789 (defvar org-after-refile-insert-hook nil
11790 "Hook run after `org-refile' has inserted its stuff at the new location.
11791 Note that this is still *before* the stuff will be removed from
11792 the *old* location.")
11794 (defvar org-capture-last-stored-marker)
11795 (defvar org-refile-keep nil
11796 "Non-nil means `org-refile' will copy instead of refile.")
11799 "Like `org-refile', but copy."
11801 (let ((org-refile-keep t))
11802 (funcall 'org-refile nil nil nil "Copy")))
11804 (defun org-refile (&optional arg default-buffer rfloc msg)
11805 "Move the entry or entries at point to another heading.
11806 The list of target headings is compiled using the information in
11807 `org-refile-targets', which see.
11809 At the target location, the entry is filed as a subitem of the
11810 target heading. Depending on `org-reverse-note-order', the new
11811 subitem will either be the first or the last subitem.
11813 If there is an active region, all entries in that region will be
11814 refiled. However, the region must fulfill the requirement that
11815 the first heading sets the top-level of the moved text.
11817 With prefix arg ARG, the command will only visit the target
11818 location and not actually move anything.
11820 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11821 refiling operation has put the subtree.
11823 With a numeric prefix argument of `2', refile to the running clock.
11825 With a numeric prefix argument of `3', emulate `org-refile-keep'
11826 being set to `t' and copy to the target location, don't move it.
11827 Beware that keeping refiled entries may result in duplicated ID
11830 RFLOC can be a refile location obtained in a different way.
11832 MSG is a string to replace \"Refile\" in the default prompt with
11833 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11835 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11837 If you are using target caching (see `org-refile-use-cache'), you
11838 have to clear the target cache in order to find new targets.
11839 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11840 prefix argument (`C-u C-u C-u C-c C-w')."
11842 (if (member arg '(0 (64)))
11843 (org-refile-cache-clear)
11844 (let* ((actionmsg (cond (msg msg)
11845 ((equal arg 3) "Refile (and keep)")
11847 (cbuf (current-buffer))
11848 (regionp (org-region-active-p))
11849 (region-start (and regionp (region-beginning)))
11850 (region-end (and regionp (region-end)))
11851 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11852 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11853 pos it nbuf file re level reversed)
11854 (setq last-command nil)
11856 (goto-char region-start)
11857 (or (bolp) (goto-char (point-at-bol)))
11858 (setq region-start (point))
11859 (unless (or (org-kill-is-subtree-p
11860 (buffer-substring region-start region-end))
11861 (prog1 org-refile-active-region-within-subtree
11862 (let ((s (point-at-eol)))
11863 (org-toggle-heading)
11864 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11865 (user-error "The region is not a (sequence of) subtree(s)")))
11866 (if (equal arg '(16))
11867 (org-refile-goto-last-stored)
11870 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11872 (setq it (list (or org-clock-heading "running clock")
11874 (marker-buffer org-clock-hd-marker))
11876 (marker-position org-clock-hd-marker)))
11879 (let (heading-text)
11881 (unless (and arg (listp arg))
11882 (org-back-to-heading t)
11884 (replace-regexp-in-string
11885 org-bracket-link-regexp
11887 (nth 4 (org-heading-components)))))
11888 (org-refile-get-location
11889 (cond ((and arg (listp arg)) "Goto")
11890 (regionp (concat actionmsg " region to"))
11891 (t (concat actionmsg " subtree \""
11892 heading-text "\" to")))
11894 (and (not (equal '(4) arg))
11895 org-refile-allow-creating-parent-nodes)
11897 (setq file (nth 1 it)
11902 (equal (buffer-file-name) file)
11904 (and (>= pos region-start)
11905 (<= pos region-end))
11906 (and (>= pos (point))
11907 (< pos (save-excursion
11908 (org-end-of-subtree t t))))))
11909 (error "Cannot refile to position inside the tree or region"))
11910 (setq nbuf (or (find-buffer-visiting file)
11911 (find-file-noselect file)))
11912 (if (and arg (not (equal arg 3)))
11914 (org-pop-to-buffer-same-window nbuf)
11916 (org-show-context 'org-goto))
11919 (org-kill-new (buffer-substring region-start region-end))
11920 (org-save-markers-in-region region-start region-end))
11921 (org-copy-subtree 1 nil t))
11922 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11923 (find-file-noselect file)))
11924 (setq reversed (org-notes-order-reversed-p))
11931 (looking-at org-outline-regexp)
11932 (setq level (org-get-valid-level (funcall outline-level) 1))
11935 (or (outline-next-heading) (point-max))
11936 (or (save-excursion (org-get-next-sibling))
11937 (org-end-of-subtree t t)
11941 (goto-char (point-max))
11942 (goto-char (point-min))
11943 (or (outline-next-heading) (goto-char (point-max)))))
11944 (if (not (bolp)) (newline))
11945 (org-paste-subtree level nil nil t)
11946 (when org-log-refile
11947 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11948 (unless (eq org-log-refile 'note)
11949 (save-excursion (org-add-log-note))))
11950 (and org-auto-align-tags
11951 (let ((org-loop-over-headlines-in-active-region nil))
11952 (org-set-tags nil t)))
11953 (let ((bookmark-name (plist-get org-bookmark-names-plist
11955 (when bookmark-name
11956 (with-demoted-errors
11957 (bookmark-set bookmark-name))))
11958 ;; If we are refiling for capture, make sure that the
11959 ;; last-capture pointers point here
11960 (when (org-bound-and-true-p org-refile-for-capture)
11961 (let ((bookmark-name (plist-get org-bookmark-names-plist
11962 :last-capture-marker)))
11963 (when bookmark-name
11964 (with-demoted-errors
11965 (bookmark-set bookmark-name))))
11966 (move-marker org-capture-last-stored-marker (point)))
11967 (if (fboundp 'deactivate-mark) (deactivate-mark))
11968 (run-hooks 'org-after-refile-insert-hook))))
11969 (unless org-refile-keep
11971 (delete-region (point) (+ (point) (- region-end region-start)))
11973 (and (org-back-to-heading t) (point))
11974 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11975 (when (featurep 'org-inlinetask)
11976 (org-inlinetask-remove-END-maybe))
11977 (setq org-markers-to-move nil)
11978 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11980 (defun org-refile-goto-last-stored ()
11981 "Go to the location where the last refile was stored."
11983 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11984 (message "This is the location of the last refile"))
11986 (defun org-refile--get-location (refloc tbl)
11987 "When user refile to REFLOC, find the associated target in TBL.
11988 Also check `org-refile-target-table'."
11992 (lambda (r) (or (assoc r tbl)
11993 (assoc r org-refile-target-table)))
11994 (list (replace-regexp-in-string "/$" "" refloc)
11995 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11997 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11999 "Prompt the user for a refile location, using PROMPT.
12000 PROMPT should not be suffixed with a colon and a space, because
12001 this function appends the default value from
12002 `org-refile-history' automatically, if that is not empty.
12003 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12004 this is used for the GOTO interface."
12005 (let ((org-refile-targets org-refile-targets)
12006 (org-refile-use-outline-path org-refile-use-outline-path)
12008 (when (and (derived-mode-p 'org-mode)
12009 (not org-refile-use-cache)
12013 (setq excluded-entries
12014 (append excluded-entries (list (org-get-heading t t)))))))
12015 (setq org-refile-target-table
12016 (org-refile-get-targets default-buffer excluded-entries)))
12017 (unless org-refile-target-table
12018 (user-error "No refile targets"))
12019 (let* ((cbuf (current-buffer))
12020 (partial-completion-mode nil)
12021 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12022 (cfunc (if (and org-refile-use-outline-path
12023 org-outline-path-complete-in-steps)
12024 'org-olpath-completing-read
12025 'org-icompleting-read))
12026 (extra (if org-refile-use-outline-path "/" ""))
12027 (cbnex (concat (buffer-name) extra))
12028 (filename (and cfn (expand-file-name cfn)))
12031 (if (and (not (member org-refile-use-outline-path
12032 '(file full-file-path)))
12033 (not (equal filename (nth 1 x))))
12034 (cons (concat (car x) extra " ("
12035 (file-name-nondirectory (nth 1 x)) ")")
12037 (cons (concat (car x) extra) (cdr x))))
12038 org-refile-target-table))
12039 (completion-ignore-case t)
12041 (prompt (concat prompt
12042 (or (and (car org-refile-history)
12043 (concat " (default " (car org-refile-history) ")"))
12044 (and (assoc cbnex tbl) (setq cdef cbnex)
12045 (concat " (default " cbnex ")"))) ": "))
12046 pa answ parent-target child parent old-hist)
12047 (setq old-hist org-refile-history)
12048 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12049 nil 'org-refile-history (or cdef (car org-refile-history))))
12050 (if (setq pa (org-refile--get-location answ tbl))
12052 (org-refile-check-position pa)
12053 (when (or (not org-refile-history)
12054 (not (eq old-hist org-refile-history))
12055 (not (equal (car pa) (car org-refile-history))))
12056 (setq org-refile-history
12057 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12059 (cdr org-refile-history))))
12060 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12061 (pop org-refile-history)))
12063 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12065 (setq parent (match-string 1 answ)
12066 child (match-string 2 answ))
12067 (setq parent-target (org-refile--get-location parent tbl))
12068 (when (and parent-target
12069 (or (eq new-nodes t)
12070 (and (eq new-nodes 'confirm)
12071 (y-or-n-p (format "Create new node \"%s\"? "
12073 (org-refile-new-child parent-target child)))
12074 (user-error "Invalid target location")))))
12076 (declare-function org-string-nw-p "org-macs" (s))
12077 (defun org-refile-check-position (refile-pointer)
12078 "Check if the refile pointer matches the headline to which it points."
12079 (let* ((file (nth 1 refile-pointer))
12080 (re (nth 2 refile-pointer))
12081 (pos (nth 3 refile-pointer))
12083 (if (and (not (markerp pos)) (not file))
12084 (user-error "Please indicate a target file in the refile path")
12085 (when (org-string-nw-p re)
12086 (setq buffer (if (markerp pos)
12087 (marker-buffer pos)
12088 (or (find-buffer-visiting file)
12089 (find-file-noselect file))))
12090 (with-current-buffer buffer
12095 (beginning-of-line 1)
12096 (unless (org-looking-at-p re)
12097 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12099 (defun org-refile-new-child (parent-target child)
12100 "Use refile target PARENT-TARGET to add new CHILD below it."
12101 (unless parent-target
12102 (error "Cannot find parent for new node"))
12103 (let ((file (nth 1 parent-target))
12104 (pos (nth 3 parent-target))
12106 (with-current-buffer (or (find-buffer-visiting file)
12107 (find-file-noselect file))
12113 (goto-char (point-max))
12114 (if (not (bolp)) (newline)))
12115 (when (looking-at org-outline-regexp)
12116 (setq level (funcall outline-level))
12117 (org-end-of-subtree t t))
12118 (org-back-over-empty-lines)
12119 (insert "\n" (make-string
12120 (if pos (org-get-valid-level level 1) 1) ?*)
12122 (beginning-of-line 0)
12123 (list (concat (car parent-target) "/" child) file "" (point)))))))
12125 (defun org-olpath-completing-read (prompt collection &rest args)
12126 "Read an outline path like a file name."
12127 (let ((thetable collection)
12128 (org-completion-use-ido nil) ; does not work with ido.
12129 (org-completion-use-iswitchb nil)) ; or iswitchb
12130 (apply #'org-icompleting-read
12132 (lambda (string predicate &optional flag)
12134 ((eq flag nil) (try-completion string thetable))
12136 (let ((l (length string)))
12137 (mapcar (lambda (x)
12138 (let ((r (substring x l))
12139 (f (if (string-match " ([^)]*)$" x)
12142 (if (string-match "/" r)
12143 (concat string (substring r 0 (match-end 0)) f)
12145 (all-completions string thetable predicate))))
12147 ((eq flag 'lambda) (assoc string thetable))))
12150 ;;;; Dynamic blocks
12152 (defun org-find-dblock (name)
12153 "Find the first dynamic block with name NAME in the buffer.
12154 If not found, stay at current position and return nil."
12155 (let ((case-fold-search t) pos)
12157 (goto-char (point-min))
12158 (setq pos (and (re-search-forward
12159 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12160 (match-beginning 0))))
12161 (if pos (goto-char pos))
12164 (defun org-create-dblock (plist)
12165 "Create a dynamic block section, with parameters taken from PLIST.
12166 PLIST must contain a :name entry which is used as the name of the block."
12167 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12170 (let ((col (current-column))
12171 (name (plist-get plist :name)))
12172 (insert "#+BEGIN: " name)
12174 (if (eq (car plist) :name)
12175 (setq plist (cddr plist))
12176 (insert " " (prin1-to-string (pop plist)))))
12177 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12178 (beginning-of-line -2)))
12180 (defun org-prepare-dblock ()
12181 "Prepare dynamic block for refresh.
12182 This empties the block, puts the cursor at the insert position and returns
12183 the property list including an extra property :name with the block name."
12184 (unless (looking-at org-dblock-start-re)
12185 (user-error "Not at a dynamic block"))
12186 (let* ((begdel (1+ (match-end 0)))
12187 (name (org-no-properties (match-string 1)))
12188 (params (append (list :name name)
12189 (read (concat "(" (match-string 3) ")")))))
12191 (beginning-of-line 1)
12192 (skip-chars-forward " \t")
12193 (setq params (plist-put params :indentation-column (current-column))))
12194 (unless (re-search-forward org-dblock-end-re nil t)
12195 (error "Dynamic block not terminated"))
12198 (list :content (buffer-substring
12199 begdel (match-beginning 0)))))
12200 (delete-region begdel (match-beginning 0))
12205 (defun org-map-dblocks (&optional command)
12206 "Apply COMMAND to all dynamic blocks in the current buffer.
12207 If COMMAND is not given, use `org-update-dblock'."
12208 (let ((cmd (or command 'org-update-dblock)))
12210 (goto-char (point-min))
12211 (while (re-search-forward org-dblock-start-re nil t)
12212 (goto-char (match-beginning 0))
12214 (condition-case nil
12216 (error (message "Error during update of dynamic block"))))
12217 (unless (re-search-forward org-dblock-end-re nil t)
12218 (error "Dynamic block not terminated"))))))
12220 (defun org-dblock-update (&optional arg)
12221 "User command for updating dynamic blocks.
12222 Update the dynamic block at point. With prefix ARG, update all dynamic
12223 blocks in the buffer."
12226 (org-update-all-dblocks)
12227 (or (looking-at org-dblock-start-re)
12228 (org-beginning-of-dblock))
12229 (org-update-dblock)))
12231 (defun org-update-dblock ()
12232 "Update the dynamic block at point.
12233 This means to empty the block, parse for parameters and then call
12234 the correct writing function."
12237 (let* ((win (selected-window))
12239 (line (org-current-line))
12240 (params (org-prepare-dblock))
12241 (name (plist-get params :name))
12242 (indent (plist-get params :indentation-column))
12243 (cmd (intern (concat "org-dblock-write:" name))))
12244 (message "Updating dynamic block `%s' at line %d..." name line)
12245 (funcall cmd params)
12246 (message "Updating dynamic block `%s' at line %d...done" name line)
12248 (when (and indent (> indent 0))
12249 (setq indent (make-string indent ?\ ))
12251 (select-window win)
12252 (org-beginning-of-dblock)
12254 (while (not (looking-at org-dblock-end-re))
12256 (beginning-of-line 2))
12257 (when (looking-at org-dblock-end-re)
12258 (and (looking-at "[ \t]+")
12259 (replace-match ""))
12260 (insert indent)))))))
12262 (defun org-beginning-of-dblock ()
12263 "Find the beginning of the dynamic block at point.
12264 Error if there is no such block at point."
12265 (let ((pos (point))
12268 (if (and (re-search-backward org-dblock-start-re nil t)
12269 (setq beg (match-beginning 0))
12270 (re-search-forward org-dblock-end-re nil t)
12271 (> (match-end 0) pos))
12274 (error "Not in a dynamic block"))))
12276 (defun org-update-all-dblocks ()
12277 "Update all dynamic blocks in the buffer.
12278 This function can be used in a hook."
12280 (when (derived-mode-p 'org-mode)
12281 (org-map-dblocks 'org-update-dblock)))
12286 (declare-function org-export-backend-name "org-export" (cl-x))
12287 (declare-function org-export-backend-options "org-export" (cl-x))
12288 (defun org-get-export-keywords ()
12289 "Return a list of all currently understood export keywords.
12290 Export keywords include options, block names, attributes and
12291 keywords relative to each registered export back-end."
12294 (org-bound-and-true-p org-export-registered-backends)
12295 (delq nil keywords))
12296 ;; Back-end name (for keywords, like #+LATEX:)
12297 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12298 (dolist (option-entry (org-export-backend-options backend))
12299 ;; Back-end options.
12300 (push (nth 1 option-entry) keywords)))))
12302 (defconst org-options-keywords
12303 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12304 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12305 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12306 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12307 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12309 (defcustom org-structure-template-alist
12310 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12311 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12312 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12313 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12314 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12315 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12316 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12318 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12320 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12323 ("I" "#+INCLUDE: %file ?"))
12324 "Structure completion elements.
12325 This is a list of abbreviation keys and values. The value gets inserted
12326 if you type `<' followed by the key and then press the completion key,
12327 usually `TAB'. %file will be replaced by a file name after prompting
12328 for the file using completion. The cursor will be placed at the position
12329 of the `?` in the template.
12330 There are two templates for each key, the first uses the original Org syntax,
12331 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12332 the default when the /org-mtags.el/ module has been loaded. See also the
12333 variable `org-mtags-prefer-muse-templates'."
12334 :group 'org-completion
12337 (string :tag "Key")
12338 (string :tag "Template")))
12340 :package-version '(Org . "8.3"))
12342 (defun org-try-structure-completion ()
12343 "Try to complete a structure template before point.
12344 This looks for strings like \"<e\" on an otherwise empty line and
12346 (let ((l (buffer-substring (point-at-bol) (point)))
12348 (when (and (looking-at "[ \t]*$")
12349 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12350 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12351 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12352 (match-beginning 1)) a)
12355 (defun org-complete-expand-structure-template (start cell)
12356 "Expand a structure template."
12357 (let ((rpl (nth 1 cell))
12359 (delete-region start (point))
12360 (when (string-match "\\`[ \t]*#\\+" rpl)
12363 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12364 (setq ind (buffer-substring (point-at-bol) (point))))
12366 (setq start (point))
12367 (if (string-match "%file" rpl)
12368 (setq rpl (replace-match
12372 (abbreviate-file-name (read-file-name "Include file: ")))
12375 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12376 (concat "\n" ind)))
12378 (if (re-search-backward "\\?" start t) (delete-char 1))))
12380 ;;;; TODO, DEADLINE, Comments
12382 (defun org-toggle-comment ()
12383 "Change the COMMENT state of an entry."
12386 (org-back-to-heading)
12387 (looking-at org-complex-heading-regexp)
12388 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12389 (skip-chars-forward " \t")
12390 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12391 (if (org-in-commented-heading-p t)
12392 (delete-region (point)
12393 (progn (search-forward " " (line-end-position) 'move)
12394 (skip-chars-forward " \t")
12396 (insert org-comment-string)
12397 (unless (eolp) (insert " ")))))
12399 (defvar org-last-todo-state-is-todo nil
12400 "This is non-nil when the last TODO state change led to a TODO state.
12401 If the last change removed the TODO tag or switched to DONE, then
12404 (defvar org-setting-tags nil) ; dynamically skipped
12406 (defvar org-todo-setup-filter-hook nil
12407 "Hook for functions that pre-filter todo specs.
12408 Each function takes a todo spec and returns either nil or the spec
12409 transformed into canonical form." )
12411 (defvar org-todo-get-default-hook nil
12412 "Hook for functions that get a default item for todo.
12413 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12414 nil or a string to be used for the todo mark." )
12416 (defvar org-agenda-headline-snapshot-before-repeat)
12418 (defun org-current-effective-time ()
12419 "Return current time adjusted for `org-extend-today-until' variable."
12420 (let* ((ct (org-current-time))
12421 (dct (decode-time ct))
12424 (org-use-last-clock-out-time-as-effective-time
12425 (or (org-clock-get-last-clock-out-time) ct))
12426 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12427 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12431 (defun org-todo-yesterday (&optional arg)
12432 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12434 (if (eq major-mode 'org-agenda-mode)
12435 (apply 'org-agenda-todo-yesterday arg)
12436 (let* ((org-use-effective-time t)
12437 (hour (third (decode-time
12438 (org-current-time))))
12439 (org-extend-today-until (1+ hour)))
12442 (defvar org-block-entry-blocking ""
12443 "First entry preventing the TODO state change.")
12445 (defun org-cancel-repeater ()
12446 "Cancel a repeater by setting its numeric value to zero."
12449 (org-back-to-heading t)
12450 (let ((bound1 (point))
12451 (bound0 (save-excursion (outline-next-heading) (point))))
12452 (when (re-search-forward
12453 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12454 org-deadline-time-regexp "\\)\\|\\("
12455 org-ts-regexp "\\)")
12457 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12458 (replace-match "0" t nil nil 1))))))
12460 (defun org-todo (&optional arg)
12461 "Change the TODO state of an item.
12462 The state of an item is given by a keyword at the start of the heading,
12464 *** TODO Write paper
12467 The different keywords are specified in the variable `org-todo-keywords'.
12468 By default the available states are \"TODO\" and \"DONE\".
12469 So for this example: when the item starts with TODO, it is changed to DONE.
12470 When it starts with DONE, the DONE is removed. And when neither TODO nor
12471 DONE are present, add TODO at the beginning of the heading.
12473 With \\[universal-argument] prefix arg, use completion to determine the new \
12475 With numeric prefix arg, switch to that state.
12476 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12477 keywords (nextset).
12478 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12479 With a numeric prefix arg of 0, inhibit note taking for the change.
12480 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12482 When called through ELisp, arg is also interpreted in the following way:
12483 'none -> empty state
12484 \"\"(empty string) -> switch to empty state
12485 'done -> switch to DONE
12486 'nextset -> switch to the next set of keywords
12487 'previousset -> switch to the previous set of keywords
12488 \"WAITING\" -> switch to the specified keyword, but only if it
12489 really is a member of `org-todo-keywords'."
12491 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12492 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12493 'region-start-level 'region))
12494 org-loop-over-headlines-in-active-region)
12497 org-loop-over-headlines-in-active-region
12498 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12499 (if (equal arg '(16)) (setq arg 'nextset))
12500 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12501 (let ((org-blocker-hook org-blocker-hook)
12504 (when (equal arg '(64))
12505 (setq arg nil org-blocker-hook nil))
12506 (when (and org-blocker-hook
12507 (or org-inhibit-blocking
12508 (org-entry-get nil "NOBLOCKING")))
12509 (setq org-blocker-hook nil))
12512 (org-back-to-heading t)
12513 (when (org-in-commented-heading-p t)
12514 (org-toggle-comment)
12516 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12517 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12518 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12519 (let* ((match-data (match-data))
12520 (startpos (point-at-bol))
12521 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12522 (org-log-done org-log-done)
12523 (org-log-repeat org-log-repeat)
12524 (org-todo-log-states org-todo-log-states)
12525 (org-inhibit-logging
12527 (progn (setq arg nil) 'note) org-inhibit-logging))
12528 (this (match-string 1))
12529 (hl-pos (match-beginning 0))
12530 (head (org-get-todo-sequence-head this))
12531 (ass (assoc head org-todo-kwd-alist))
12532 (interpret (nth 1 ass))
12533 (done-word (nth 3 ass))
12534 (final-done-word (nth 4 ass))
12535 (org-last-state (or this ""))
12536 (completion-ignore-case t)
12537 (member (member this org-todo-keywords-1))
12538 (tail (cdr member))
12540 ((and org-todo-key-trigger
12541 (or (and (equal arg '(4))
12542 (eq org-use-fast-todo-selection 'prefix))
12543 (and (not arg) org-use-fast-todo-selection
12544 (not (eq org-use-fast-todo-selection
12546 ;; Use fast selection
12547 (org-fast-todo-selection))
12548 ((and (equal arg '(4))
12549 (or (not org-use-fast-todo-selection)
12550 (not org-todo-key-trigger)))
12551 ;; Read a state with completion
12552 (org-icompleting-read
12553 "State: " (mapcar 'list org-todo-keywords-1)
12557 (if tail (car tail) nil)
12558 (car org-todo-keywords-1)))
12560 (if (equal member org-todo-keywords-1)
12563 (nth (- (length org-todo-keywords-1)
12565 org-todo-keywords-1)
12566 (org-last org-todo-keywords-1))))
12567 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12568 (setq arg nil))) ; hack to fall back to cycling
12570 ;; user or caller requests a specific state
12572 ((equal arg "") nil)
12573 ((eq arg 'none) nil)
12574 ((eq arg 'done) (or done-word (car org-done-keywords)))
12576 (or (car (cdr (member head org-todo-heads)))
12577 (car org-todo-heads)))
12578 ((eq arg 'previousset)
12579 (let ((org-todo-heads (reverse org-todo-heads)))
12580 (or (car (cdr (member head org-todo-heads)))
12581 (car org-todo-heads))))
12582 ((car (member arg org-todo-keywords-1)))
12584 (user-error "State `%s' not valid in this file" arg))
12585 ((nth (1- (prefix-numeric-value arg))
12586 org-todo-keywords-1))))
12587 ((null member) (or head (car org-todo-keywords-1)))
12588 ((equal this final-done-word) nil) ;; -> make empty
12589 ((null tail) nil) ;; -> first entry
12590 ((memq interpret '(type priority))
12591 (if (eq this-command last-command)
12593 (if (> (length tail) 0)
12594 (or done-word (car org-done-keywords))
12599 (run-hook-with-args-until-success
12600 'org-todo-get-default-hook org-state org-last-state)
12602 (next (if org-state (concat " " org-state " ") " "))
12603 (change-plist (list :type 'todo-state-change :from this :to org-state
12604 :position startpos))
12606 (when org-blocker-hook
12607 (setq org-last-todo-state-is-todo
12608 (not (member this org-done-keywords)))
12609 (unless (save-excursion
12611 (org-with-wide-buffer
12612 (run-hook-with-args-until-failure
12613 'org-blocker-hook change-plist))))
12614 (if (org-called-interactively-p 'interactive)
12615 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12616 this org-state org-block-entry-blocking)
12618 (message "TODO state change from %s to %s blocked (by \"%s\")"
12619 this org-state org-block-entry-blocking)
12620 (throw 'exit nil))))
12621 (store-match-data match-data)
12622 (replace-match next t t)
12623 (cond ((equal this org-state)
12624 (message "TODO state was already %s" (org-trim next)))
12625 ((pos-visible-in-window-p hl-pos)
12626 (message "TODO state changed to %s" (org-trim next))))
12628 (setq head (org-get-todo-sequence-head org-state)
12629 ass (assoc head org-todo-kwd-alist)
12630 interpret (nth 1 ass)
12631 done-word (nth 3 ass)
12632 final-done-word (nth 4 ass)))
12633 (when (memq arg '(nextset previousset))
12634 (message "Keyword-Set %d/%d: %s"
12635 (- (length org-todo-sets) -1
12636 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12637 (length org-todo-sets)
12638 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12639 (setq org-last-todo-state-is-todo
12640 (not (member org-state org-done-keywords)))
12641 (setq now-done-p (and (member org-state org-done-keywords)
12642 (not (member this org-done-keywords))))
12643 (and logging (org-local-logging logging))
12644 (when (and (or org-todo-log-states org-log-done)
12645 (not (eq org-inhibit-logging t))
12646 (not (memq arg '(nextset previousset))))
12647 ;; we need to look at recording a time and note
12648 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12649 (nth 2 (assoc this org-todo-log-states))))
12650 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12651 (setq dolog 'time))
12652 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12654 (member org-state org-not-done-keywords)
12655 (not (member this org-not-done-keywords))))
12656 ;; This is now a todo state and was not one before
12657 ;; If there was a CLOSED time stamp, get rid of it.
12658 (org-add-planning-info nil nil 'closed))
12659 (when (and now-done-p org-log-done)
12660 ;; It is now done, and it was not done before
12661 (org-add-planning-info 'closed (org-current-effective-time))
12662 (if (and (not dolog) (eq 'note org-log-done))
12663 (org-add-log-setup 'done org-state this 'findpos 'note)))
12664 (when (and org-state dolog)
12665 ;; This is a non-nil state, and we need to log it
12666 (org-add-log-setup 'state org-state this 'findpos dolog)))
12667 ;; Fixup tag positioning
12668 (org-todo-trigger-tag-changes org-state)
12669 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12670 (when org-provide-todo-statistics
12671 (org-update-parent-todo-statistics))
12672 (run-hooks 'org-after-todo-state-change-hook)
12673 (if (and arg (not (member org-state org-done-keywords)))
12674 (setq head (org-get-todo-sequence-head org-state)))
12675 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12676 ;; Do we need to trigger a repeat?
12678 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12679 ;; This is for the agenda, take a snapshot of the headline.
12681 (setq org-agenda-headline-snapshot-before-repeat
12682 (org-get-heading))))
12683 (org-auto-repeat-maybe org-state))
12684 ;; Fixup cursor location if close to the keyword
12685 (if (and (outline-on-heading-p)
12687 (save-excursion (beginning-of-line 1)
12688 (looking-at org-todo-line-regexp))
12689 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12691 (goto-char (or (match-end 2) (match-end 1)))
12692 (and (looking-at " ") (just-one-space))))
12693 (when org-trigger-hook
12695 (run-hook-with-args 'org-trigger-hook change-plist)))
12696 (when commentp (org-toggle-comment))))))))
12698 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12699 "Block turning an entry into a TODO, using the hierarchy.
12700 This checks whether the current task should be blocked from state
12701 changes. Such blocking occurs when:
12703 1. The task has children which are not all in a completed state.
12705 2. A task has a parent with the property :ORDERED:, and there
12706 are siblings prior to the current task with incomplete
12709 3. The parent of the task is blocked because it has siblings that should
12710 be done first, or is child of a block grandparent TODO entry."
12712 (if (not org-enforce-todo-dependencies)
12713 t ; if locally turned off don't block
12715 ;; If this is not a todo state change, or if this entry is already DONE,
12717 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12718 (member (plist-get change-plist :from)
12719 (cons 'done org-done-keywords))
12720 (member (plist-get change-plist :to)
12721 (cons 'todo org-not-done-keywords))
12722 (not (plist-get change-plist :to)))
12723 (throw 'dont-block t))
12724 ;; If this task has children, and any are undone, it's blocked
12726 (org-back-to-heading t)
12727 (let ((this-level (funcall outline-level)))
12728 (outline-next-heading)
12729 (let ((child-level (funcall outline-level)))
12730 (while (and (not (eobp))
12731 (> child-level this-level))
12732 ;; this todo has children, check whether they are all
12734 (if (and (not (org-entry-is-done-p))
12735 (org-entry-is-todo-p))
12736 (progn (setq org-block-entry-blocking (org-get-heading))
12737 (throw 'dont-block nil)))
12738 (outline-next-heading)
12739 (setq child-level (funcall outline-level))))))
12740 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12741 ;; any previous siblings are undone, it's blocked
12743 (org-back-to-heading t)
12744 (let* ((pos (point))
12745 (parent-pos (and (org-up-heading-safe) (point))))
12746 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12747 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12749 (re-search-forward org-not-done-heading-regexp pos t))
12750 (setq org-block-entry-blocking (match-string 0))
12751 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12752 ;; Search further up the hierarchy, to see if an ancestor is blocked
12754 (goto-char parent-pos)
12755 (if (not (looking-at org-not-done-heading-regexp))
12756 (throw 'dont-block t)) ; do not block, parent is not a TODO
12758 (setq parent-pos (and (org-up-heading-safe) (point)))
12759 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12760 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12762 (re-search-forward org-not-done-heading-regexp pos t)
12763 (setq org-block-entry-blocking (org-get-heading)))
12764 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12766 (defcustom org-track-ordered-property-with-tag nil
12767 "Should the ORDERED property also be shown as a tag?
12768 The ORDERED property decides if an entry should require subtasks to be
12769 completed in sequence. Since a property is not very visible, setting
12770 this option means that toggling the ORDERED property with the command
12771 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12772 not relevant for the behavior, but it makes things more visible.
12774 Note that toggling the tag with tags commands will not change the property
12775 and therefore not influence behavior!
12777 This can be t, meaning the tag ORDERED should be used, It can also be a
12778 string to select a different tag for this task."
12781 (const :tag "No tracking" nil)
12782 (const :tag "Track with ORDERED tag" t)
12783 (string :tag "Use other tag")))
12785 (defun org-toggle-ordered-property ()
12786 "Toggle the ORDERED property of the current entry.
12787 For better visibility, you can track the value of this property with a tag.
12788 See variable `org-track-ordered-property-with-tag'."
12790 (let* ((t1 org-track-ordered-property-with-tag)
12791 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12793 (org-back-to-heading)
12794 (if (org-entry-get nil "ORDERED")
12796 (org-delete-property "ORDERED")
12797 (and tag (org-toggle-tag tag 'off))
12798 (message "Subtasks can be completed in arbitrary order"))
12799 (org-entry-put nil "ORDERED" "t")
12800 (and tag (org-toggle-tag tag 'on))
12801 (message "Subtasks must be completed in sequence")))))
12803 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12804 (defun org-block-todo-from-checkboxes (change-plist)
12805 "Block turning an entry into a TODO, using checkboxes.
12806 This checks whether the current task should be blocked from state
12807 changes because there are unchecked boxes in this entry."
12808 (if (not org-enforce-todo-checkbox-dependencies)
12809 t ; if locally turned off don't block
12811 ;; If this is not a todo state change, or if this entry is already DONE,
12813 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12814 (member (plist-get change-plist :from)
12815 (cons 'done org-done-keywords))
12816 (member (plist-get change-plist :to)
12817 (cons 'todo org-not-done-keywords))
12818 (not (plist-get change-plist :to)))
12819 (throw 'dont-block t))
12820 ;; If this task has checkboxes that are not checked, it's blocked
12822 (org-back-to-heading t)
12823 (let ((beg (point)) end)
12824 (outline-next-heading)
12827 (if (org-list-search-forward
12828 (concat (org-item-beginning-re)
12829 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12833 (if (boundp 'org-blocked-by-checkboxes)
12834 (setq org-blocked-by-checkboxes t))
12835 (throw 'dont-block nil)))))
12836 t))) ; do not block
12838 (defun org-entry-blocked-p ()
12839 "Is the current entry blocked?"
12840 (org-with-silent-modifications
12841 (if (org-entry-get nil "NOBLOCKING")
12842 nil ;; Never block this entry
12843 (not (run-hook-with-args-until-failure
12845 (list :type 'todo-state-change
12850 (defun org-update-statistics-cookies (all)
12851 "Update the statistics cookie, either from TODO or from checkboxes.
12852 This should be called with the cursor in a line with a statistics cookie."
12856 (org-update-checkbox-count 'all)
12857 (org-map-entries 'org-update-parent-todo-statistics))
12858 (if (not (org-at-heading-p))
12859 (org-update-checkbox-count)
12860 (let ((pos (point-marker))
12862 (ignore-errors (org-back-to-heading t))
12863 (if (not (org-at-heading-p))
12864 (org-update-checkbox-count)
12865 (setq l1 (org-outline-level))
12866 (setq end (save-excursion
12867 (outline-next-heading)
12868 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12870 (if (and (save-excursion
12872 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12873 (not (save-excursion (re-search-forward
12874 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12875 (org-update-checkbox-count)
12876 (if (and l2 (> l2 l1))
12879 (org-update-parent-todo-statistics))
12881 (beginning-of-line 1)
12882 (while (re-search-forward
12883 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12885 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12887 (move-marker pos nil)))))
12889 (defvar org-entry-property-inherited-from) ;; defined below
12890 (defun org-update-parent-todo-statistics ()
12891 "Update any statistics cookie in the parent of the current headline.
12892 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12893 the entire subtree and this will travel up the hierarchy and update
12894 statistics everywhere."
12895 (let* ((prop (save-excursion (org-up-heading-safe)
12896 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12897 (recursive (or (not org-hierarchical-todo-statistics)
12898 (and prop (string-match "\\<recursive\\>" prop))))
12899 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12902 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12903 level ltoggle l1 new ndel
12904 (cnt-all 0) (cnt-done 0) is-percent kwd
12905 checkbox-beg ov ovs ove cookie-present)
12908 (beginning-of-line 1)
12909 (setq ltoggle (funcall outline-level))
12910 ;; Three situations are to consider:
12912 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12913 ;; to the top-level ancestor on the headline;
12915 ;; 2. If parent has "recursive" property, repeat up to the
12916 ;; headline setting that property, taking inheritance into
12919 ;; 3. Else, move up to direct parent and proceed only once.
12920 (while (and (setq level (org-up-heading-safe))
12921 (or recursive first)
12923 (setq first nil cookie-present nil)
12927 (downcase (or (org-entry-get nil "COOKIE_DATA")
12930 (while (re-search-forward box-re (point-at-eol) t)
12931 (setq cnt-all 0 cnt-done 0 cookie-present t)
12932 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12934 (unless (outline-next-heading) (throw 'exit nil))
12935 (while (and (looking-at org-complex-heading-regexp)
12936 (> (setq l1 (length (match-string 1))) level))
12937 (setq kwd (and (or recursive (= l1 ltoggle))
12939 (if (or (eq org-provide-todo-statistics 'all-headlines)
12940 (and (eq org-provide-todo-statistics t)
12941 (or (member kwd org-done-keywords)))
12942 (and (listp org-provide-todo-statistics)
12943 (stringp (car org-provide-todo-statistics))
12944 (or (member kwd org-provide-todo-statistics)
12945 (member kwd org-done-keywords)))
12946 (and (listp org-provide-todo-statistics)
12947 (listp (car org-provide-todo-statistics))
12948 (or (member kwd (car org-provide-todo-statistics))
12949 (and (member kwd org-done-keywords)
12950 (member kwd (cadr org-provide-todo-statistics))))))
12951 (setq cnt-all (1+ cnt-all))
12952 (if (eq org-provide-todo-statistics t)
12953 (and kwd (setq cnt-all (1+ cnt-all)))))
12954 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12955 (member kwd org-done-keywords))
12956 (and (listp org-provide-todo-statistics)
12957 (listp (car org-provide-todo-statistics))
12958 (member kwd org-done-keywords)
12959 (member kwd (cadr org-provide-todo-statistics)))
12960 (and (listp org-provide-todo-statistics)
12961 (stringp (car org-provide-todo-statistics))
12962 (member kwd org-done-keywords)))
12963 (setq cnt-done (1+ cnt-done)))
12964 (outline-next-heading)))
12967 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12968 (format "[%d/%d]" cnt-done cnt-all))
12969 ndel (- (match-end 0) checkbox-beg))
12970 ;; handle overlays when updating cookie from column view
12971 (when (setq ov (car (overlays-at checkbox-beg)))
12972 (setq ovs (overlay-start ov) ove (overlay-end ov))
12973 (delete-overlay ov))
12974 (goto-char checkbox-beg)
12976 (delete-region (point) (+ (point) ndel))
12977 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12978 (when ov (move-overlay ov ovs ove)))
12979 (when cookie-present
12980 (run-hook-with-args 'org-after-todo-statistics-hook
12981 cnt-done (- cnt-all cnt-done))))))
12982 (run-hooks 'org-todo-statistics-hook)))
12984 (defvar org-after-todo-statistics-hook nil
12985 "Hook that is called after a TODO statistics cookie has been updated.
12986 Each function is called with two arguments: the number of not-done entries
12987 and the number of done entries.
12989 For example, the following function, when added to this hook, will switch
12990 an entry to DONE when all children are done, and back to TODO when new
12991 entries are set to a TODO status. Note that this hook is only called
12992 when there is a statistics cookie in the headline!
12994 (defun org-summary-todo (n-done n-not-done)
12995 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12996 (let (org-log-done org-log-states) ; turn off logging
12997 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13000 (defvar org-todo-statistics-hook nil
13001 "Hook that is run whenever Org thinks TODO statistics should be updated.
13002 This hook runs even if there is no statistics cookie present, in which case
13003 `org-after-todo-statistics-hook' would not run.")
13005 (defun org-todo-trigger-tag-changes (state)
13006 "Apply the changes defined in `org-todo-state-tags-triggers'."
13007 (let ((l org-todo-state-tags-triggers)
13009 (when (or (not state) (equal state ""))
13010 (setq changes (append changes (cdr (assoc "" l)))))
13011 (when (and (stringp state) (> (length state) 0))
13012 (setq changes (append changes (cdr (assoc state l)))))
13013 (when (member state org-not-done-keywords)
13014 (setq changes (append changes (cdr (assoc 'todo l)))))
13015 (when (member state org-done-keywords)
13016 (setq changes (append changes (cdr (assoc 'done l)))))
13017 (dolist (c changes)
13018 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13020 (defun org-local-logging (value)
13021 "Get logging settings from a property VALUE."
13023 ;; directly set the variables, they are already local.
13024 (setq org-log-done nil
13026 org-todo-log-states nil)
13027 (setq words (org-split-string value))
13028 (while (setq w (pop words))
13030 ((setq a (assoc w org-startup-options))
13031 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13032 (set (nth 1 a) (nth 2 a))))
13033 ((setq a (org-extract-log-state-settings w))
13034 (and (member (car a) org-todo-keywords-1)
13035 (push a org-todo-log-states)))))))
13037 (defun org-get-todo-sequence-head (kwd)
13038 "Return the head of the TODO sequence to which KWD belongs.
13039 If KWD is not set, check if there is a text property remembering the
13044 (or (get-text-property (point-at-bol) 'org-todo-head)
13046 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13047 nil (point-at-eol)))
13048 (get-text-property p 'org-todo-head))))
13049 ((not (member kwd org-todo-keywords-1))
13050 (car org-todo-keywords-1))
13051 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13053 (defun org-fast-todo-selection ()
13054 "Fast TODO keyword selection with single keys.
13055 Returns the new TODO keyword, or nil if no state change should occur."
13056 (let* ((fulltable org-todo-key-alist)
13057 (done-keywords org-done-keywords) ;; needed for the faces.
13058 (maxlen (apply 'max (mapcar
13060 (if (stringp (car x)) (string-width (car x)) 0))
13063 (fwidth (+ maxlen 3 1 3))
13064 (ncol (/ (- (window-width) 4) fwidth))
13068 (save-window-excursion
13070 (set-buffer (get-buffer-create " *Org todo*"))
13071 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13073 (org-set-local 'org-done-keywords done-keywords)
13074 (setq tbl fulltable cnt 0)
13075 (while (setq e (pop tbl))
13077 ((equal e '(:startgroup))
13078 (push '() groups) (setq ingroup t)
13079 (when (not (= cnt 0))
13083 ((equal e '(:endgroup))
13084 (setq ingroup nil cnt 0)
13086 ((equal e '(:newline))
13087 (when (not (= cnt 0))
13091 (while (equal (car tbl) '(:newline))
13093 (setq tbl (cdr tbl)))))
13095 (setq tg (car e) c (cdr e))
13096 (if ingroup (push tg (car groups)))
13097 (setq tg (org-add-props tg nil 'face
13098 (org-get-todo-face tg)))
13099 (if (and (= cnt 0) (not ingroup)) (insert " "))
13100 (insert "[" c "] " tg (make-string
13101 (- fwidth 4 (length tg)) ?\ ))
13102 (when (= (setq cnt (1+ cnt)) ncol)
13104 (if ingroup (insert " "))
13107 (goto-char (point-min))
13108 (if (not expert) (org-fit-window-to-buffer))
13109 (message "[a-z..]:Set [SPC]:clear")
13110 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13113 (and (= c ?q) (not (rassoc c fulltable))))
13114 (setq quit-flag t))
13116 ((setq e (rassoc c fulltable) tg (car e))
13118 (t (setq quit-flag t)))))))
13120 (defun org-entry-is-todo-p ()
13121 (member (org-get-todo-state) org-not-done-keywords))
13123 (defun org-entry-is-done-p ()
13124 (member (org-get-todo-state) org-done-keywords))
13126 (defun org-get-todo-state ()
13127 "Return the TODO keyword of the current subtree."
13129 (org-back-to-heading t)
13130 (and (looking-at org-todo-line-regexp)
13132 (match-string 2))))
13134 (defun org-at-date-range-p (&optional inactive-ok)
13135 "Is the cursor inside a date range?"
13139 (let ((pos (point)))
13140 (skip-chars-backward "^[<\r\n")
13141 (skip-chars-backward "<[")
13142 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13143 (>= (match-end 0) pos)
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)
13152 (defun org-get-repeat (&optional tagline)
13153 "Check if there is a deadline/schedule with repeater in this entry."
13156 (org-back-to-heading t)
13157 (and (re-search-forward (if tagline
13158 (concat tagline "\\s-*" org-repeat-re)
13160 (org-entry-end-position) t)
13161 (match-string-no-properties 1)))))
13163 (defvar org-last-changed-timestamp)
13164 (defvar org-last-inserted-timestamp)
13165 (defvar org-log-post-message)
13166 (defvar org-log-note-purpose)
13167 (defvar org-log-note-how nil)
13168 (defvar org-log-note-extra)
13169 (defun org-auto-repeat-maybe (done-word)
13170 "Check if the current headline contains a repeated deadline/schedule.
13171 If yes, set TODO state back to what it was and change the base date
13172 of repeating deadline/scheduled time stamps to new date.
13173 This function is run automatically after each state change to a DONE state."
13174 ;; last-state is dynamically scoped into this function
13175 (let* ((repeat (org-get-repeat))
13176 (aa (assoc org-last-state org-todo-kwd-alist))
13177 (interpret (nth 1 aa))
13179 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13180 (msg "Entry repeats: ")
13182 (org-todo-log-states nil)
13183 re type n what ts time to-state)
13184 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13185 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13186 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13187 org-todo-repeat-to-state))
13188 (unless (and to-state (member to-state org-todo-keywords-1))
13189 (setq to-state (if (eq interpret 'type) org-last-state head)))
13190 (org-todo to-state)
13191 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13192 (org-entry-put nil "LAST_REPEAT" (format-time-string
13193 (org-time-stamp-format t t))))
13194 (when org-log-repeat
13195 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13196 (memq 'org-add-log-note post-command-hook))
13197 ;; OK, we are already setup for some record
13198 (if (eq org-log-repeat 'note)
13199 ;; make sure we take a note, not only a time stamp
13200 (setq org-log-note-how 'note))
13201 ;; Set up for taking a record
13202 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13204 'findpos org-log-repeat)))
13205 (org-back-to-heading t)
13206 (org-add-planning-info nil nil 'closed)
13207 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13208 org-deadline-time-regexp "\\)\\|\\("
13209 org-ts-regexp "\\)"))
13210 (while (re-search-forward
13211 re (save-excursion (outline-next-heading) (point)) t)
13212 (setq type (if (match-end 1) org-scheduled-string
13213 (if (match-end 3) org-deadline-string "Plain:"))
13214 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13215 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13216 (setq n (string-to-number (match-string 2 ts))
13217 what (match-string 3 ts))
13218 (if (equal what "w") (setq n (* n 7) what "d"))
13219 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13220 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13221 ;; Preparation, see if we need to modify the start date for the change
13222 (when (match-end 1)
13223 (setq time (save-match-data (org-time-string-to-time ts)))
13225 ((equal (match-string 1 ts) ".")
13226 ;; Shift starting date to today
13227 (org-timestamp-change
13228 (- (org-today) (time-to-days time))
13230 ((equal (match-string 1 ts) "+")
13231 (let ((nshiftmax 10) (nshift 0))
13232 (while (or (= nshift 0)
13233 (<= (time-to-days time)
13234 (time-to-days (current-time))))
13235 (when (= (incf nshift) nshiftmax)
13236 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13237 (user-error "Abort")))
13238 (org-timestamp-change n (cdr (assoc what whata)))
13239 (org-at-timestamp-p t)
13240 (setq ts (match-string 1))
13241 (setq time (save-match-data (org-time-string-to-time ts)))))
13242 (org-timestamp-change (- n) (cdr (assoc what whata)))
13243 ;; rematch, so that we have everything in place for the real shift
13244 (org-at-timestamp-p t)
13245 (setq ts (match-string 1))
13246 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13247 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13248 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13249 (setq org-log-post-message msg)
13250 (message "%s" msg))))
13252 (defun org-show-todo-tree (arg)
13253 "Make a compact tree which shows all headlines marked with TODO.
13254 The tree will show the lines where the regexp matches, and all higher
13255 headlines above the match.
13256 With a \\[universal-argument] prefix, prompt for a regexp to match.
13257 With a numeric prefix N, construct a sparse tree for the Nth element
13258 of `org-todo-keywords-1'."
13260 (let ((case-fold-search nil)
13262 (cond ((null arg) org-not-done-regexp)
13264 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13265 (mapcar 'list org-todo-keywords-1))))
13267 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13269 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13270 (regexp-quote (nth (1- (prefix-numeric-value arg))
13271 org-todo-keywords-1)))
13272 (t (user-error "Invalid prefix argument: %s" arg)))))
13273 (message "%d TODO entries found"
13274 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13276 (defun org-deadline (arg &optional time)
13277 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13278 With one universal prefix argument, remove any deadline from the item.
13279 With two universal prefix arguments, prompt for a warning delay.
13280 With argument TIME, set the deadline at the corresponding date. TIME
13281 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13283 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13284 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13285 'region-start-level 'region))
13286 org-loop-over-headlines-in-active-region)
13288 `(org-deadline ',arg ,time)
13289 org-loop-over-headlines-in-active-region
13290 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13291 (let* ((old-date (org-entry-get nil "DEADLINE"))
13292 (old-date-time (if old-date (org-time-string-to-time old-date)))
13293 (repeater (and old-date
13295 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13297 (match-string 1 old-date))))
13300 (when (and old-date org-log-redeadline)
13301 (org-add-log-setup 'deldeadline nil old-date 'findpos
13302 org-log-redeadline))
13303 (org-remove-timestamp-with-keyword org-deadline-string)
13304 (message "Item no longer has a deadline."))
13307 (org-back-to-heading t)
13308 (if (re-search-forward
13309 org-deadline-time-regexp
13310 (save-excursion (outline-next-heading) (point)) t)
13311 (let* ((rpl0 (match-string 1))
13312 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13314 (concat org-deadline-string
13320 (org-read-date nil t nil "Warn starting from" old-date-time)))
13321 (time-to-days old-date-time))))
13323 (user-error "No deadline information to update"))))
13325 (org-add-planning-info 'deadline time 'closed)
13326 (when (and old-date org-log-redeadline
13327 (not (equal old-date
13328 (substring org-last-inserted-timestamp 1 -1))))
13329 (org-add-log-setup 'redeadline nil old-date 'findpos
13330 org-log-redeadline))
13333 (org-back-to-heading t)
13334 (when (re-search-forward (concat org-deadline-string " "
13335 org-last-inserted-timestamp)
13337 (outline-next-heading) (point)) t)
13338 (goto-char (1- (match-end 0)))
13339 (insert " " repeater)
13340 (setq org-last-inserted-timestamp
13341 (concat (substring org-last-inserted-timestamp 0 -1)
13343 (substring org-last-inserted-timestamp -1))))))
13344 (message "Deadline on %s" org-last-inserted-timestamp))))))
13346 (defun org-schedule (arg &optional time)
13347 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13348 With one universal prefix argument, remove any scheduling date from the item.
13349 With two universal prefix arguments, prompt for a delay cookie.
13350 With argument TIME, scheduled at the corresponding date. TIME can
13351 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13353 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13354 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13355 'region-start-level 'region))
13356 org-loop-over-headlines-in-active-region)
13358 `(org-schedule ',arg ,time)
13359 org-loop-over-headlines-in-active-region
13360 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13361 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13362 (old-date-time (if old-date (org-time-string-to-time old-date)))
13363 (repeater (and old-date
13365 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13367 (match-string 1 old-date))))
13371 (when (and old-date org-log-reschedule)
13372 (org-add-log-setup 'delschedule nil old-date 'findpos
13373 org-log-reschedule))
13374 (org-remove-timestamp-with-keyword org-scheduled-string)
13375 (message "Item is no longer scheduled.")))
13378 (org-back-to-heading t)
13379 (if (re-search-forward
13380 org-scheduled-time-regexp
13381 (save-excursion (outline-next-heading) (point)) t)
13382 (let* ((rpl0 (match-string 1))
13383 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13385 (concat org-scheduled-string
13391 (org-read-date nil t nil "Delay until" old-date-time)))
13392 (time-to-days old-date-time))))
13394 (user-error "No scheduled information to update"))))
13396 (org-add-planning-info 'scheduled time 'closed)
13397 (when (and old-date org-log-reschedule
13398 (not (equal old-date
13399 (substring org-last-inserted-timestamp 1 -1))))
13400 (org-add-log-setup 'reschedule nil old-date 'findpos
13401 org-log-reschedule))
13404 (org-back-to-heading t)
13405 (when (re-search-forward (concat org-scheduled-string " "
13406 org-last-inserted-timestamp)
13408 (outline-next-heading) (point)) t)
13409 (goto-char (1- (match-end 0)))
13410 (insert " " repeater)
13411 (setq org-last-inserted-timestamp
13412 (concat (substring org-last-inserted-timestamp 0 -1)
13414 (substring org-last-inserted-timestamp -1))))))
13415 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13417 (defun org-get-scheduled-time (pom &optional inherit)
13418 "Get the scheduled time as a time tuple, of a format suitable
13419 for calling org-schedule with, or if there is no scheduling,
13421 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13423 (apply 'encode-time (org-parse-time-string time)))))
13425 (defun org-get-deadline-time (pom &optional inherit)
13426 "Get the deadline as a time tuple, of a format suitable for
13427 calling org-deadline with, or if there is no scheduling, returns
13429 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13431 (apply 'encode-time (org-parse-time-string time)))))
13433 (defun org-remove-timestamp-with-keyword (keyword)
13434 "Remove all time stamps with KEYWORD in the current entry."
13435 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13438 (org-back-to-heading t)
13440 (outline-next-heading)
13441 (while (re-search-backward re beg t)
13443 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13444 (equal (char-before) ?\ ))
13445 (backward-delete-char 1)
13446 (if (string-match "^[ \t]*$" (buffer-substring
13447 (point-at-bol) (point-at-eol)))
13448 (delete-region (point-at-bol)
13449 (min (point-max) (1+ (point-at-eol))))))))))
13451 (defvar org-time-was-given) ; dynamically scoped parameter
13452 (defvar org-end-time-was-given) ; dynamically scoped parameter
13454 (defun org-at-planning-p ()
13455 "Non-nil when point is on a planning info line."
13456 ;; This is as accurate and faster than `org-element-at-point' since
13457 ;; planning info location is fixed in the section.
13458 (org-with-wide-buffer
13459 (beginning-of-line)
13460 (and (org-looking-at-p org-planning-line-re)
13463 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13464 (org-back-to-heading t)
13465 (org-with-limited-levels (org-back-to-heading t)))
13466 (line-beginning-position 2))))))
13468 (defun org-add-planning-info (what &optional time &rest remove)
13469 "Insert new timestamp with keyword in the planning line.
13470 WHAT indicates what kind of time stamp to add. It is a symbol
13471 among `closed', `deadline', `scheduled' and nil. TIME indicates
13472 the time to use. If none is given, the user is prompted for
13473 a date. REMOVE indicates what kind of entries to remove. An old
13474 WHAT entry will also be removed."
13475 (let (org-time-was-given org-end-time-was-given default-time default-input)
13477 (when (and (memq what '(scheduled deadline))
13479 (and (stringp time)
13480 (string-match "^[-+]+[0-9]" time))))
13481 ;; Try to get a default date/time from existing timestamp
13483 (org-back-to-heading t)
13484 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13485 (when (re-search-forward (if (eq what 'scheduled)
13486 org-scheduled-time-regexp
13487 org-deadline-time-regexp)
13489 (setq ts (match-string 1)
13490 default-time (apply 'encode-time (org-parse-time-string ts))
13491 default-input (and ts (org-get-compact-tod ts)))))))
13495 ;; This is a string (relative or absolute), set
13497 (apply #'encode-time
13498 (org-read-date-analyze
13499 time default-time (decode-time default-time)))
13500 ;; If necessary, get the time from the user
13501 (or time (org-read-date nil 'to-time nil nil
13502 default-time default-input)))))
13504 (org-with-wide-buffer
13505 (org-back-to-heading t)
13507 (unless (bolp) (insert "\n"))
13508 (cond ((org-looking-at-p org-planning-line-re)
13509 ;; Move to current indentation.
13510 (skip-chars-forward " \t")
13511 ;; Check if we have to remove something.
13512 (dolist (type (if what (cons what remove) remove))
13514 (when (re-search-forward
13518 (closed org-closed-time-regexp)
13519 (deadline org-deadline-time-regexp)
13520 (scheduled org-scheduled-time-regexp)
13522 (error "Invalid planning type: %s" type))))
13523 (line-end-position) t)
13525 (when (looking-at "--+<[^>]+>") (replace-match ""))
13526 (when (and (not what) (eq type 'closed))
13528 (beginning-of-line)
13529 (when (looking-at "[ \t]*$")
13530 (delete-region (point)
13531 (line-beginning-position 2)))))))
13532 ;; Remove leading white spaces.
13533 (when (looking-at "[ \t]+") (replace-match ""))))
13534 ((not what) (throw 'exit nil)) ; Nothing to do.
13535 (t (insert-before-markers "\n")
13537 (when org-adapt-indentation
13538 (org-indent-to-column (1+ (org-outline-level))))))
13540 ;; Insert planning keyword.
13542 (closed org-closed-string)
13543 (deadline org-deadline-string)
13544 (scheduled org-scheduled-string)
13545 (otherwise (error "Invalid planning type: %s" what)))
13547 ;; Insert associated timestamp.
13548 (let ((ts (org-insert-time-stamp
13550 (or org-time-was-given
13551 (and (eq what 'closed) org-log-done-with-time))
13553 nil nil (list org-end-time-was-given))))
13554 (unless (eolp) (insert " "))
13557 (defvar org-log-note-marker (make-marker))
13558 (defvar org-log-note-purpose nil)
13559 (defvar org-log-note-state nil)
13560 (defvar org-log-note-previous-state nil)
13561 (defvar org-log-note-extra nil)
13562 (defvar org-log-note-window-configuration nil)
13563 (defvar org-log-note-return-to (make-marker))
13564 (defvar org-log-note-effective-time nil
13565 "Remembered current time so that dynamically scoped
13566 `org-extend-today-until' affects tha timestamps in state change
13569 (defvar org-log-post-message nil
13570 "Message to be displayed after a log note has been stored.
13571 The auto-repeater uses this.")
13573 (defun org-add-note ()
13574 "Add a note to the current entry.
13575 This is done in the same way as adding a state change note."
13577 (org-add-log-setup 'note nil nil 'findpos nil))
13579 (defun org-log-beginning (&optional create)
13580 "Return expected start of log notes in current entry.
13581 When optional argument CREATE is non-nil, the function creates
13582 a drawer to store notes, if necessary. Returned position ignores
13584 (org-with-wide-buffer
13585 (org-end-of-meta-data)
13586 (let ((end (if (org-at-heading-p) (point)
13587 (save-excursion (outline-next-heading) (point))))
13588 (drawer (org-log-into-drawer)))
13591 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13592 (case-fold-search t))
13594 ;; Try to find existing drawer.
13595 (while (re-search-forward regexp end t)
13596 (let ((element (org-element-at-point)))
13597 (when (eq (org-element-type element) 'drawer)
13598 (let ((cend (org-element-property :contents-end element)))
13599 (when (and (not org-log-states-order-reversed) cend)
13601 (throw 'exit nil))))
13602 ;; No drawer found. Create one, if permitted.
13604 (unless (bolp) (insert "\n"))
13605 (let ((beg (point)))
13606 (insert ":" drawer ":\n:END:\n")
13607 (org-indent-region beg (point)))
13608 (end-of-line -1)))))
13609 (org-log-state-notes-insert-after-drawers
13610 (while (and (looking-at org-drawer-regexp)
13611 (progn (goto-char (match-end 0))
13612 (re-search-forward org-property-end-re end t)))
13614 (if (bolp) (point) (line-beginning-position 2))))
13616 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13617 "Set up the post command hook to take a note.
13618 If this is about to TODO state change, the new state is expected in STATE.
13619 When FINDPOS is non-nil, find the correct position for the note in
13620 the current entry. If not, assume that it can be inserted at point.
13621 HOW is an indicator what kind of note should be created.
13622 EXTRA is additional text that will be inserted into the notes buffer."
13623 (org-with-wide-buffer
13625 (goto-char (org-log-beginning t))
13626 (unless org-log-states-order-reversed
13627 (org-skip-over-state-notes)
13628 (skip-chars-backward " \t\n\r")
13630 (move-marker org-log-note-marker (point))
13631 ;; Preserve position even if a property drawer is inserted in the
13633 (set-marker-insertion-type org-log-note-marker t)
13634 (setq org-log-note-purpose purpose
13635 org-log-note-state state
13636 org-log-note-previous-state prev-state
13637 org-log-note-how how
13638 org-log-note-extra extra
13639 org-log-note-effective-time (org-current-effective-time))
13640 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13642 (defun org-skip-over-state-notes ()
13643 "Skip past the list of State notes in an entry."
13644 (when (ignore-errors (goto-char (org-in-item-p)))
13645 (let* ((struct (org-list-struct))
13646 (prevs (org-list-prevs-alist struct))
13648 (concat "[ \t]*- +"
13649 (replace-regexp-in-string
13651 (org-replace-escapes
13652 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13653 `(("%d" . ,org-ts-regexp-inactive)
13654 ("%D" . ,org-ts-regexp)
13655 ("%s" . "\"\\S-+\"")
13656 ("%S" . "\"\\S-+\"")
13657 ("%t" . ,org-ts-regexp-inactive)
13658 ("%T" . ,org-ts-regexp)
13660 ("%U" . ".*?")))))))
13661 (while (org-looking-at-p regexp)
13662 (goto-char (or (org-list-get-next-item (point) struct prevs)
13663 (org-list-get-item-end (point) struct)))))))
13665 (defun org-add-log-note (&optional purpose)
13666 "Pop up a window for taking a note, and add this note later at point."
13667 (remove-hook 'post-command-hook 'org-add-log-note)
13668 (setq org-log-note-window-configuration (current-window-configuration))
13669 (delete-other-windows)
13670 (move-marker org-log-note-return-to (point))
13671 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13672 (goto-char org-log-note-marker)
13673 (org-switch-to-buffer-other-window "*Org Note*")
13675 (if (memq org-log-note-how '(time state))
13676 (let (current-prefix-arg) (org-store-log-note))
13677 (let ((org-inhibit-startup t)) (org-mode))
13678 (insert (format "# Insert note for %s.
13679 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13681 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13682 ((eq org-log-note-purpose 'done) "closed todo item")
13683 ((eq org-log-note-purpose 'state)
13684 (format "state change from \"%s\" to \"%s\""
13685 (or org-log-note-previous-state "")
13686 (or org-log-note-state "")))
13687 ((eq org-log-note-purpose 'reschedule)
13689 ((eq org-log-note-purpose 'delschedule)
13690 "no longer scheduled")
13691 ((eq org-log-note-purpose 'redeadline)
13692 "changing deadline")
13693 ((eq org-log-note-purpose 'deldeadline)
13694 "removing deadline")
13695 ((eq org-log-note-purpose 'refile)
13697 ((eq org-log-note-purpose 'note)
13699 (t (error "This should not happen")))))
13700 (if org-log-note-extra (insert org-log-note-extra))
13701 (org-set-local 'org-finish-function 'org-store-log-note)
13702 (run-hooks 'org-log-buffer-setup-hook)))
13704 (defvar org-note-abort nil) ; dynamically scoped
13705 (defun org-store-log-note ()
13706 "Finish taking a log note, and insert it to where it belongs."
13707 (let ((txt (buffer-string)))
13708 (kill-buffer (current-buffer))
13709 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13710 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13711 (setq txt (replace-match "" t t txt)))
13712 (if (string-match "\\s-+\\'" txt)
13713 (setq txt (replace-match "" t t txt)))
13714 (setq lines (org-split-string txt "\n"))
13715 (when (and note (string-match "\\S-" note))
13717 (org-replace-escapes
13719 (list (cons "%u" (user-login-name))
13720 (cons "%U" user-full-name)
13721 (cons "%t" (format-time-string
13722 (org-time-stamp-format 'long 'inactive)
13723 org-log-note-effective-time))
13724 (cons "%T" (format-time-string
13725 (org-time-stamp-format 'long nil)
13726 org-log-note-effective-time))
13727 (cons "%d" (format-time-string
13728 (org-time-stamp-format nil 'inactive)
13729 org-log-note-effective-time))
13730 (cons "%D" (format-time-string
13731 (org-time-stamp-format nil nil)
13732 org-log-note-effective-time))
13734 ((not org-log-note-state) "")
13735 ((org-string-match-p org-ts-regexp
13736 org-log-note-state)
13738 (substring org-log-note-state 1 -1)))
13739 (t (format "\"%s\"" org-log-note-state))))
13742 ((not org-log-note-previous-state) "")
13743 ((org-string-match-p org-ts-regexp
13744 org-log-note-previous-state)
13747 org-log-note-previous-state 1 -1)))
13748 (t (format "\"%s\""
13749 org-log-note-previous-state)))))))
13750 (when lines (setq note (concat note " \\\\")))
13752 (when (or current-prefix-arg org-note-abort)
13753 (when (org-log-into-drawer)
13754 (org-remove-empty-drawer-at org-log-note-marker))
13757 (with-current-buffer (marker-buffer org-log-note-marker)
13758 (org-with-wide-buffer
13759 (goto-char org-log-note-marker)
13760 (move-marker org-log-note-marker nil)
13761 ;; Make sure point is at the beginning of an empty line.
13762 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13763 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13764 ;; In an existing list, add a new item at the top level.
13765 ;; Otherwise, indent line like a regular one.
13766 (let ((itemp (org-in-item-p)))
13768 (org-indent-line-to
13769 (let ((struct (save-excursion
13770 (goto-char itemp) (org-list-struct))))
13771 (org-list-get-ind (org-list-get-top-point struct) struct)))
13772 (org-indent-line)))
13773 (insert (org-list-bullet-string "-") (pop lines))
13774 (let ((ind (org-list-item-body-column (line-beginning-position))))
13775 (dolist (line lines)
13777 (org-indent-line-to ind)
13779 (message "Note stored")
13780 (org-back-to-heading t)
13781 (org-cycle-hide-drawers 'children))
13782 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13783 ;; from within `org-add-log-note' because `buffer-undo-list'
13784 ;; is then modified outside of `org-with-remote-undo'.
13785 (when (eq this-command 'org-agenda-todo)
13786 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13787 ;; Don't add undo information when called from `org-agenda-todo'
13788 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13789 (set-window-configuration org-log-note-window-configuration)
13790 (with-current-buffer (marker-buffer org-log-note-return-to)
13791 (goto-char org-log-note-return-to))
13792 (move-marker org-log-note-return-to nil)
13793 (and org-log-post-message (message "%s" org-log-post-message))))
13795 (defun org-remove-empty-drawer-at (pos)
13796 "Remove an empty drawer at position POS.
13797 POS may also be a marker."
13798 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13799 (org-with-wide-buffer
13801 (let ((drawer (org-element-at-point)))
13802 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13803 (not (org-element-property :contents-begin drawer)))
13804 (delete-region (org-element-property :begin drawer)
13805 (progn (goto-char (org-element-property :end drawer))
13806 (skip-chars-backward " \r\t\n")
13810 (defvar org-ts-type nil)
13811 (defun org-sparse-tree (&optional arg type)
13812 "Create a sparse tree, prompt for the details.
13813 This command can create sparse trees. You first need to select the type
13814 of match used to create the tree:
13816 t Show all TODO entries.
13817 T Show entries with a specific TODO keyword.
13818 m Show entries selected by a tags/property match.
13819 p Enter a property name and its value (both with completion on existing
13820 names/values) and show entries with that property.
13821 r Show entries matching a regular expression (`/' can be used as well).
13822 b Show deadlines and scheduled items before a date.
13823 a Show deadlines and scheduled items after a date.
13824 d Show deadlines due within `org-deadline-warning-days'.
13825 D Show deadlines and scheduled items between a date range."
13827 (setq type (or type org-sparse-tree-default-date-type))
13828 (setq org-ts-type type)
13829 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13830 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13831 [c]ycle through date types: %s"
13833 (all "all timestamps")
13834 (scheduled "only scheduled")
13835 (deadline "only deadline")
13836 (active "only active timestamps")
13837 (inactive "only inactive timestamps")
13838 (closed "with a closed time-stamp")
13839 (otherwise "scheduled/deadline")))
13840 (let ((answer (read-char-exclusive)))
13846 (memq type '(nil all scheduled deadline active inactive closed)))))
13847 (?d (call-interactively 'org-check-deadlines))
13848 (?b (call-interactively 'org-check-before-date))
13849 (?a (call-interactively 'org-check-after-date))
13850 (?D (call-interactively 'org-check-dates-range))
13851 (?t (call-interactively 'org-show-todo-tree))
13852 (?T (org-show-todo-tree '(4)))
13853 (?m (call-interactively 'org-match-sparse-tree))
13855 (let* ((kwd (org-icompleting-read
13856 "Property: " (mapcar 'list (org-buffer-property-keys))))
13857 (value (org-icompleting-read
13858 "Value: " (mapcar 'list (org-property-values kwd)))))
13859 (unless (string-match "\\`{.*}\\'" value)
13860 (setq value (concat "\"" value "\"")))
13861 (org-match-sparse-tree arg (concat kwd "=" value))))
13862 ((?r ?R ?/) (call-interactively 'org-occur))
13863 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13865 (defvar org-occur-highlights nil
13866 "List of overlays used for occur matches.")
13867 (make-variable-buffer-local 'org-occur-highlights)
13868 (defvar org-occur-parameters nil
13869 "Parameters of the active org-occur calls.
13870 This is a list, each call to org-occur pushes as cons cell,
13871 containing the regular expression and the callback, onto the list.
13872 The list can contain several entries if `org-occur' has been called
13873 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13874 will only contain one set of parameters. When the highlights are
13875 removed (for example with `C-c C-c', or with the next edit (depending
13876 on `org-remove-highlights-with-change'), this variable is emptied
13878 (make-variable-buffer-local 'org-occur-parameters)
13880 (defun org-occur (regexp &optional keep-previous callback)
13881 "Make a compact tree which shows all matches of REGEXP.
13882 The tree will show the lines where the regexp matches, and all higher
13883 headlines above the match. It will also show the heading after the match,
13884 to make sure editing the matching entry is easy.
13885 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13886 call to `org-occur' will be kept, to allow stacking of calls to this
13888 If CALLBACK is non-nil, it is a function which is called to confirm
13889 that the match should indeed be shown."
13890 (interactive "sRegexp: \nP")
13891 (when (equal regexp "")
13892 (user-error "Regexp cannot be empty"))
13893 (unless keep-previous
13894 (org-remove-occur-highlights nil nil t))
13895 (push (cons regexp callback) org-occur-parameters)
13898 (goto-char (point-min))
13899 (if (or (not keep-previous) ; do not want to keep
13900 (not org-occur-highlights)) ; no previous matches
13903 (while (re-search-forward regexp nil t)
13904 (when (or (not callback)
13905 (save-match-data (funcall callback)))
13906 (setq cnt (1+ cnt))
13907 (when org-highlight-sparse-tree-matches
13908 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13909 (org-show-context 'occur-tree))))
13910 (when org-remove-highlights-with-change
13911 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13913 (unless org-sparse-tree-open-archived-trees
13914 (org-hide-archived-subtrees (point-min) (point-max)))
13915 (run-hooks 'org-occur-hook)
13916 (if (org-called-interactively-p 'interactive)
13917 (message "%d match(es) for regexp %s" cnt regexp))
13920 (defun org-occur-next-match (&optional n reset)
13921 "Function for `next-error-function' to find sparse tree matches.
13922 N is the number of matches to move, when negative move backwards.
13923 RESET is entirely ignored - this function always goes back to the
13924 starting point when no match is found."
13925 (let* ((limit (if (< n 0) (point-min) (point-max)))
13926 (search-func (if (< n 0)
13927 'previous-single-char-property-change
13928 'next-single-char-property-change))
13933 (while (setq p1 (funcall search-func (point) 'org-type))
13934 (when (equal p1 limit)
13936 (user-error "No more matches"))
13937 (when (equal (get-char-property p1 'org-type) 'org-occur)
13941 (throw 'exit (point))))
13944 (user-error "No more matches"))))
13946 (defun org-show-context (&optional key)
13947 "Make sure point and context are visible.
13948 Optional argument KEY, when non-nil, is a symbol. See
13949 `org-show-context-detail' for allowed values and how much is to
13951 (org-show-set-visibility
13952 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13953 ((cdr (assq key org-show-context-detail)))
13954 (t (cdr (assq 'default org-show-context-detail))))))
13956 (defun org-show-set-visibility (detail)
13957 "Set visibility around point according to DETAIL.
13958 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13959 `tree', `canonical' or t. See `org-show-context-detail' for more
13961 (unless (org-before-first-heading-p)
13962 ;; Show current heading and possibly its entry, following headline
13963 ;; or all children.
13964 (if (and (org-at-heading-p) (not (eq detail 'local)))
13965 (org-flag-heading nil)
13967 (org-with-limited-levels
13969 ((tree canonical t) (show-children))
13970 ((nil minimal ancestors))
13972 (outline-next-heading)
13973 (org-flag-heading nil))))))
13974 ;; Show all siblings.
13975 (when (eq detail 'lineage) (org-show-siblings))
13976 ;; Show ancestors, possibly with their children.
13977 (when (memq detail '(ancestors lineage tree canonical t))
13979 (while (org-up-heading-safe)
13980 (org-flag-heading nil)
13981 (when (memq detail '(canonical t)) (org-show-entry))
13982 (when (memq detail '(tree canonical t)) (show-children)))))))
13984 (defvar org-reveal-start-hook nil
13985 "Hook run before revealing a location.")
13987 (defun org-reveal (&optional siblings)
13988 "Show current entry, hierarchy above it, and the following headline.
13990 This can be used to show a consistent set of context around
13991 locations exposed with `org-show-context'.
13993 With optional argument SIBLINGS, on each level of the hierarchy all
13994 siblings are shown. This repairs the tree structure to what it would
13995 look like when opened with hierarchical calls to `org-cycle'.
13997 With double optional argument \\[universal-argument] \\[universal-argument], \
13998 go to the parent and show the
14001 (run-hooks 'org-reveal-start-hook)
14002 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
14003 ((equal siblings '(16))
14005 (when (org-up-heading-safe)
14007 (run-hook-with-args 'org-cycle-hook 'subtree))))
14008 (t (org-show-set-visibility 'lineage))))
14010 (defun org-highlight-new-match (beg end)
14011 "Highlight from BEG to END and mark the highlight is an occur headline."
14012 (let ((ov (make-overlay beg end)))
14013 (overlay-put ov 'face 'secondary-selection)
14014 (overlay-put ov 'org-type 'org-occur)
14015 (push ov org-occur-highlights)))
14017 (defun org-remove-occur-highlights (&optional beg end noremove)
14018 "Remove the occur highlights from the buffer.
14019 BEG and END are ignored. If NOREMOVE is nil, remove this function
14020 from the `before-change-functions' in the current buffer."
14022 (unless org-inhibit-highlight-removal
14023 (mapc 'delete-overlay org-occur-highlights)
14024 (setq org-occur-highlights nil)
14025 (setq org-occur-parameters nil)
14027 (remove-hook 'before-change-functions
14028 'org-remove-occur-highlights 'local))))
14032 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14033 "Regular expression matching the priority indicator.")
14035 (defvar org-remove-priority-next-time nil)
14037 (defun org-priority-up ()
14038 "Increase the priority of the current item."
14040 (org-priority 'up))
14042 (defun org-priority-down ()
14043 "Decrease the priority of the current item."
14045 (org-priority 'down))
14047 (defun org-priority (&optional action show)
14048 "Change the priority of an item.
14049 ACTION can be `set', `up', `down', or a character."
14051 (if (equal action '(4))
14052 (org-show-priority)
14053 (unless org-enable-priority-commands
14054 (user-error "Priority commands are disabled"))
14055 (setq action (or action 'set))
14056 (let (current new news have remove)
14058 (org-back-to-heading t)
14059 (if (looking-at org-priority-regexp)
14060 (setq current (string-to-char (match-string 2))
14063 ((eq action 'remove)
14064 (setq remove t new ?\ ))
14065 ((or (eq action 'set)
14066 (if (featurep 'xemacs) (characterp action) (integerp action)))
14067 (if (not (eq action 'set))
14069 (message "Priority %c-%c, SPC to remove: "
14070 org-highest-priority org-lowest-priority)
14072 (setq new (read-char-exclusive))))
14073 (if (and (= (upcase org-highest-priority) org-highest-priority)
14074 (= (upcase org-lowest-priority) org-lowest-priority))
14075 (setq new (upcase new)))
14076 (cond ((equal new ?\ ) (setq remove t))
14077 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14078 (user-error "Priority must be between `%c' and `%c'"
14079 org-highest-priority org-lowest-priority))))
14082 (1- current) ; normal cycling
14083 ;; last priority was empty
14084 (if (eq last-command this-command)
14085 org-lowest-priority ; wrap around empty to lowest
14087 (if org-priority-start-cycle-with-default
14088 org-default-priority
14089 (1- org-default-priority))))))
14092 (1+ current) ; normal cycling
14093 ;; last priority was empty
14094 (if (eq last-command this-command)
14095 org-highest-priority ; wrap around empty to highest
14097 (if org-priority-start-cycle-with-default
14098 org-default-priority
14099 (1+ org-default-priority))))))
14100 (t (user-error "Invalid action")))
14101 (if (or (< (upcase new) org-highest-priority)
14102 (> (upcase new) org-lowest-priority))
14103 (if (and (memq action '(up down))
14104 (not have) (not (eq last-command this-command)))
14105 ;; `new' is from default priority
14107 "The default can not be set, see `org-default-priority' why")
14108 ;; normal cycling: `new' is beyond highest/lowest priority
14109 ;; and is wrapped around to the empty priority
14111 (setq news (format "%c" new))
14114 (replace-match "" t t nil 1)
14115 (replace-match news t t nil 2))
14117 (user-error "No priority cookie found in line")
14118 (let ((case-fold-search nil))
14119 (looking-at org-todo-line-regexp))
14122 (goto-char (match-end 2))
14123 (insert " [#" news "]"))
14124 (goto-char (match-beginning 3))
14125 (insert "[#" news "] "))))
14126 (org-set-tags nil 'align))
14128 (message "Priority removed")
14129 (message "Priority of current item set to %s" news)))))
14131 (defun org-show-priority ()
14132 "Show the priority of the current item.
14133 This priority is composed of the main priority given with the [#A] cookies,
14134 and by additional input from the age of a schedules or deadline entry."
14136 (let ((pri (if (eq major-mode 'org-agenda-mode)
14137 (org-get-at-bol 'priority)
14140 (beginning-of-line)
14141 (and (looking-at org-heading-regexp)
14142 (org-get-priority (match-string 0))))))))
14143 (message "Priority is %d" (if pri pri -1000))))
14145 (defun org-get-priority (s)
14146 "Find priority cookie and return priority."
14148 (if (functionp org-get-priority-function)
14149 (funcall org-get-priority-function)
14150 (if (not (string-match org-priority-regexp s))
14151 (* 1000 (- org-lowest-priority org-default-priority))
14152 (* 1000 (- org-lowest-priority
14153 (string-to-char (match-string 2 s))))))))
14157 (defvar org-agenda-archives-mode)
14158 (defvar org-map-continue-from nil
14159 "Position from where mapping should continue.
14160 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14162 (defvar org-scanner-tags nil
14163 "The current tag list while the tags scanner is running.")
14164 (defvar org-trust-scanner-tags nil
14165 "Should `org-get-tags-at' use the tags for the scanner.
14166 This is for internal dynamical scoping only.
14167 When this is non-nil, the function `org-get-tags-at' will return the value
14168 of `org-scanner-tags' instead of building the list by itself. This
14169 can lead to large speed-ups when the tags scanner is used in a file with
14170 many entries, and when the list of tags is retrieved, for example to
14171 obtain a list of properties. Building the tags list for each entry in such
14172 a file becomes an N^2 operation - but with this variable set, it scales
14175 (defun org-scan-tags (action matcher todo-only &optional start-level)
14176 "Scan headline tags with inheritance and produce output ACTION.
14178 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14179 or `agenda' to produce an entry list for an agenda view. It can also be
14180 a Lisp form or a function that should be called at each matched headline, in
14181 this case the return value is a list of all return values from these calls.
14183 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14184 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14185 only lines with a not-done TODO keyword are included in the output.
14186 This should be the same variable that was scoped into
14187 and set by `org-make-tags-matcher' when it constructed MATCHER.
14189 START-LEVEL can be a string with asterisks, reducing the scope to
14190 headlines matching this string."
14191 (require 'org-agenda)
14192 (let* ((re (concat "^"
14194 ;; Get the correct level to match
14195 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14196 org-outline-regexp)
14198 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14199 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14200 (props (list 'face 'default
14201 'done-face 'org-agenda-done
14202 'undone-face 'default
14203 'mouse-face 'highlight
14204 'org-not-done-regexp org-not-done-regexp
14205 'org-todo-regexp org-todo-regexp
14206 'org-complex-heading-regexp org-complex-heading-regexp
14208 (format "mouse-2 or RET jump to org file %s"
14209 (abbreviate-file-name
14210 (or (buffer-file-name (buffer-base-buffer))
14211 (buffer-name (buffer-base-buffer)))))))
14212 (org-map-continue-from nil)
14213 lspos tags tags-list
14214 (tags-alist (list (cons 0 org-file-tags)))
14215 (llast 0) rtn rtn1 level category i txt
14216 todo marker entry priority
14217 ts-date ts-date-type ts-date-pair)
14218 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14219 (setq action (list 'lambda nil action)))
14221 (goto-char (point-min))
14222 (when (eq action 'sparse-tree)
14224 (org-remove-occur-highlights))
14225 (while (let (case-fold-search)
14226 (re-search-forward re nil t))
14227 (setq org-map-continue-from nil)
14229 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14230 tags (if (match-end 4) (org-match-string-no-properties 4)))
14231 (goto-char (setq lspos (match-beginning 0)))
14232 (setq level (org-reduced-level (org-outline-level))
14233 category (org-get-category))
14234 (when (eq action 'agenda)
14235 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14236 ts-date (car ts-date-pair)
14237 ts-date-type (cdr ts-date-pair)))
14238 (setq i llast llast level)
14239 ;; remove tag lists from same and sublevels
14240 (while (>= i level)
14241 (when (setq entry (assoc i tags-alist))
14242 (setq tags-alist (delete entry tags-alist)))
14244 ;; add the next tags
14246 (setq tags (org-split-string tags ":")
14248 (cons (cons level tags) tags-alist)))
14249 ;; compile tags for current headline
14251 (if org-use-tag-inheritance
14252 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14254 org-scanner-tags tags-list)
14255 (when org-use-tag-inheritance
14256 (setcdr (car tags-alist)
14257 (mapcar (lambda (x)
14258 (setq x (copy-sequence x))
14259 (org-add-prop-inherited x))
14260 (cdar tags-alist))))
14261 (when (and tags org-use-tag-inheritance
14262 (or (not (eq t org-use-tag-inheritance))
14263 org-tags-exclude-from-inheritance))
14264 ;; selective inheritance, remove uninherited ones
14265 (setcdr (car tags-alist)
14266 (org-remove-uninherited-tags (cdar tags-alist))))
14269 ;; eval matcher only when the todo condition is OK
14270 (and (or (not todo-only) (member todo org-not-done-keywords))
14271 (let ((case-fold-search t) (org-trust-scanner-tags t))
14274 ;; Call the skipper, but return t if it does not skip,
14275 ;; so that the `and' form continues evaluating
14277 (unless (eq action 'sparse-tree) (org-agenda-skip))
14280 ;; Check if timestamps are deselecting this entry
14281 (or (not todo-only)
14282 (and (member todo org-not-done-keywords)
14283 (or (not org-agenda-tags-todo-honor-ignore-options)
14284 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14286 ;; select this headline
14288 ((eq action 'sparse-tree)
14289 (and org-highlight-sparse-tree-matches
14290 (org-get-heading) (match-end 0)
14291 (org-highlight-new-match
14292 (match-beginning 1) (match-end 1)))
14293 (org-show-context 'tags-tree))
14294 ((eq action 'agenda)
14295 (setq txt (org-agenda-format-item
14298 (if (eq org-tags-match-list-sublevels 'indented)
14299 (make-string (1- level) ?.) "")
14301 (make-string level ?\s)
14304 priority (org-get-priority txt))
14306 (setq marker (org-agenda-new-marker))
14307 (org-add-props txt props
14308 'org-marker marker 'org-hd-marker marker 'org-category category
14312 'type (concat "tagsmatch" ts-date-type))
14314 ((functionp action)
14315 (setq org-map-continue-from nil)
14317 (setq rtn1 (funcall action))
14319 (t (user-error "Invalid action")))
14321 ;; if we are to skip sublevels, jump to end of subtree
14322 (unless org-tags-match-list-sublevels
14323 (org-end-of-subtree t)
14324 (backward-char 1))))
14325 ;; Get the correct position from where to continue
14326 (if org-map-continue-from
14327 (goto-char org-map-continue-from)
14328 (and (= (point) lspos) (end-of-line 1)))))
14329 (when (and (eq action 'sparse-tree)
14330 (not org-sparse-tree-open-archived-trees))
14331 (org-hide-archived-subtrees (point-min) (point-max)))
14334 (defun org-remove-uninherited-tags (tags)
14335 "Remove all tags that are not inherited from the list TAGS."
14337 ((eq org-use-tag-inheritance t)
14338 (if org-tags-exclude-from-inheritance
14339 (org-delete-all org-tags-exclude-from-inheritance tags)
14341 ((not org-use-tag-inheritance) nil)
14342 ((stringp org-use-tag-inheritance)
14345 (if (and (string-match org-use-tag-inheritance x)
14346 (not (member x org-tags-exclude-from-inheritance)))
14349 ((listp org-use-tag-inheritance)
14352 (if (member x org-use-tag-inheritance) x nil))
14355 (defun org-match-sparse-tree (&optional todo-only match)
14356 "Create a sparse tree according to tags string MATCH.
14357 MATCH can contain positive and negative selection of tags, like
14358 \"+WORK+URGENT-WITHBOSS\".
14359 If optional argument TODO-ONLY is non-nil, only select lines that are
14362 (org-agenda-prepare-buffers (list (current-buffer)))
14363 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14365 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14367 (defvar org-cached-props nil)
14368 (defun org-cached-entry-get (pom property)
14369 (if (or (eq t org-use-property-inheritance)
14370 (and (stringp org-use-property-inheritance)
14371 (let ((case-fold-search t))
14372 (org-string-match-p org-use-property-inheritance property)))
14373 (and (listp org-use-property-inheritance)
14374 (member-ignore-case property org-use-property-inheritance)))
14375 ;; Caching is not possible, check it directly.
14376 (org-entry-get pom property 'inherit)
14377 ;; Get all properties, so we can do complicated checks easily.
14378 (cdr (assoc-string property
14379 (or org-cached-props
14380 (setq org-cached-props (org-entry-properties pom)))
14383 (defun org-global-tags-completion-table (&optional files)
14384 "Return the list of all tags in all agenda buffer/files.
14385 Optional FILES argument is a list of files which can be used
14386 instead of the agenda files."
14393 (set-buffer (find-file-noselect file))
14394 (append (org-get-buffer-tags)
14395 (mapcar (lambda (x) (if (stringp (car-safe x))
14396 (list (car-safe x)) nil))
14398 (if (and files (car files))
14400 (org-agenda-files))))))))
14402 (defun org-make-tags-matcher (match)
14403 "Create the TAGS/TODO matcher form for the selection string MATCH.
14405 The variable `todo-only' is scoped dynamically into this function.
14406 It will be set to t if the matcher restricts matching to TODO entries,
14407 otherwise will not be touched.
14409 Returns a cons of the selection string MATCH and the constructed
14410 lisp form implementing the matcher. The matcher is to be evaluated
14411 at an Org entry, with point on the headline, and returns t if the
14412 entry matches the selection string MATCH. The returned lisp form
14413 references two variables with information about the entry, which
14414 must be bound around the form's evaluation: todo, the TODO keyword
14415 at the entry (or nil of none); and tags-list, the list of all tags
14416 at the entry including inherited ones. Additionally, the category
14417 of the entry (if any) must be specified as the text property
14418 'org-category on the headline.
14420 See also `org-scan-tags'.
14422 (declare (special todo-only))
14423 (unless (boundp 'todo-only)
14424 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14426 ;; Get a new match request, with completion against the global
14427 ;; tags table and the local tags in current buffer
14428 (let ((org-last-tags-completion-table
14430 (delq nil (append (org-get-buffer-tags)
14431 (org-global-tags-completion-table))))))
14432 (setq match (org-completing-read-no-i
14433 "Match: " 'org-tags-completion-function nil nil nil
14434 'org-tags-history))))
14436 ;; Parse the string and create a lisp form
14437 (let ((match0 match)
14438 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14440 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14441 orterms term orlist re-p str-p level-p level-op time-p
14442 prop-p pn pv po gv rest (start 0) (ss 0))
14443 ;; Expand group tags
14444 (setq match (org-tags-expand match))
14446 ;; Check if there is a TODO part of this match, which would be the
14447 ;; part after a "/". TO make sure that this slash is not part of
14448 ;; a property value to be matched against, we also check that there
14449 ;; is no " after that slash.
14450 ;; First, find the last slash
14451 (while (string-match "/+" match ss)
14452 (setq start (match-beginning 0) ss (match-end 0)))
14453 (if (and (string-match "/+" match start)
14454 (not (save-match-data (string-match "\"" match start))))
14455 ;; match contains also a todo-matching request
14457 (setq tagsmatch (substring match 0 (match-beginning 0))
14458 todomatch (substring match (match-end 0)))
14459 (if (string-match "^!" todomatch)
14460 (setq todo-only t todomatch (substring todomatch 1)))
14461 (if (string-match "^\\s-*$" todomatch)
14462 (setq todomatch nil)))
14463 ;; only matching tags
14464 (setq tagsmatch match todomatch nil))
14466 ;; Make the tags matcher
14467 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14468 (setq tagsmatcher t)
14469 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14470 (while (setq term (pop orterms))
14471 (while (and (equal (substring term -1) "\\") orterms)
14472 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14473 (while (string-match re term)
14474 (setq rest (substring term (match-end 0))
14475 minus (and (match-end 1)
14476 (equal (match-string 1 term) "-"))
14477 tag (save-match-data (replace-regexp-in-string
14479 (match-string 2 term)))
14480 re-p (equal (string-to-char tag) ?{)
14481 level-p (match-end 4)
14482 prop-p (match-end 5)
14484 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14486 (setq level-op (org-op-to-function (match-string 3 term)))
14487 `(,level-op level ,(string-to-number
14488 (match-string 4 term))))
14490 (setq pn (match-string 5 term)
14491 po (match-string 6 term)
14492 pv (match-string 7 term)
14493 re-p (equal (string-to-char pv) ?{)
14494 str-p (equal (string-to-char pv) ?\")
14495 time-p (save-match-data
14496 (string-match "^\"[[<].*[]>]\"$" pv))
14497 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14498 (if time-p (setq pv (org-matcher-time pv)))
14499 (setq po (org-op-to-function po (if time-p 'time str-p)))
14501 ((equal pn "CATEGORY")
14502 (setq gv '(get-text-property (point) 'org-category)))
14506 (setq gv `(org-cached-entry-get nil ,pn))))
14509 `(not (string-match ,pv (or ,gv "")))
14510 `(string-match ,pv (or ,gv "")))
14512 `(,po (or ,gv "") ,pv)
14513 `(,po (string-to-number (or ,gv ""))
14514 ,(string-to-number pv) ))))
14515 (t `(member ,tag tags-list)))
14516 mm (if minus (list 'not mm) mm)
14518 (push mm tagsmatcher))
14519 (push (if (> (length tagsmatcher) 1)
14520 (cons 'and tagsmatcher)
14523 (setq tagsmatcher nil))
14524 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14526 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14527 ;; Make the todo matcher
14528 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14529 (setq todomatcher t)
14530 (setq orterms (org-split-string todomatch "|") orlist nil)
14531 (while (setq term (pop orterms))
14532 (while (string-match re term)
14533 (setq minus (and (match-end 1)
14534 (equal (match-string 1 term) "-"))
14535 kwd (match-string 2 term)
14536 re-p (equal (string-to-char kwd) ?{)
14537 term (substring term (match-end 0))
14539 `(string-match ,(substring kwd 1 -1) todo)
14540 (list 'equal 'todo kwd))
14541 mm (if minus (list 'not mm) mm))
14542 (push mm todomatcher))
14543 (push (if (> (length todomatcher) 1)
14544 (cons 'and todomatcher)
14547 (setq todomatcher nil))
14548 (setq todomatcher (if (> (length orlist) 1)
14549 (cons 'or orlist) (car orlist))))
14551 ;; Return the string and lisp forms of the matcher
14552 (setq matcher (if todomatcher
14553 (list 'and tagsmatcher todomatcher)
14556 (setq matcher (list 'and '(member todo org-not-done-keywords)
14558 (cons match0 matcher)))
14560 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14561 "Expand group tags in MATCH.
14563 This replaces every group tag in MATCH with a regexp tag search.
14564 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14565 will be replaced like this:
14567 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14568 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14569 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14571 Replacing by a regexp preserves the structure of the match.
14572 E.g., this expansion
14574 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14576 will match anything tagged with \"Lab\" and \"Home\", or tagged
14577 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14579 A group tag in MATCH can contain regular expressions of its own.
14580 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14581 will be replaced like this:
14583 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14585 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14586 assumed to be a single group tag, and the function will return
14587 the list of tags in this group.
14589 When DOWNCASE is non-nil, expand downcased TAGS."
14591 (let* ((case-fold-search t)
14592 (stable org-mode-syntax-table)
14593 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14594 (taggroups (if downcased
14595 (mapcar (lambda (tg) (mapcar #'downcase tg))
14598 (taggroups-keys (mapcar #'car taggroups))
14599 (return-match (if downcased (downcase match) match))
14601 (work-already-expanded tags-already-expanded)
14602 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14603 ;; @ and _ are allowed as word-components in tags.
14604 (modify-syntax-entry ?@ "w" stable)
14605 (modify-syntax-entry ?_ "w" stable)
14606 ;; Temporarily replace regexp-expressions in the match-expression.
14607 (while (string-match "{.+?}" return-match)
14609 (push (match-string 0 return-match) regexps-in-match)
14610 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14611 (while (and taggroups-keys
14612 (with-syntax-table stable
14614 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14615 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14616 (let* ((dir (match-string 1 return-match))
14617 (tag (match-string 2 return-match))
14618 (tag (if downcased (downcase tag) tag)))
14619 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14620 (member tag work-already-expanded))
14621 (setq tags-in-group (assoc tag taggroups))
14622 (push tag work-already-expanded)
14623 ;; Recursively expand each tag in the group, if the tag hasn't
14624 ;; already been expanded. Restore the match-data after all recursive calls.
14626 (let (tags-expanded)
14627 (dolist (x (cdr tags-in-group))
14628 (if (and (member x taggroups-keys)
14629 (not (member x work-already-expanded)))
14630 (setq tags-expanded
14633 (org-tags-expand x t downcased
14634 work-already-expanded)
14636 (setq tags-expanded
14637 (append (list x) tags-expanded)))
14638 (setq work-already-expanded
14640 (append tags-expanded
14641 work-already-expanded))))
14642 (setq tags-in-group
14643 (delete-dups (cons (car tags-in-group)
14645 ;; Filter tag-regexps from tags.
14646 (setq regexp-in-group-escaped
14647 (delq nil (mapcar (lambda (x)
14649 (and (equal "{" (substring x 0 1))
14650 (equal "}" (substring x -1))
14655 (mapcar (lambda (x)
14656 (substring x 1 -1))
14657 regexp-in-group-escaped)
14659 (delq nil (mapcar (lambda (x)
14661 (and (not (equal "{" (substring x 0 1)))
14662 (not (equal "}" (substring x -1)))
14666 ;; If single-as-list, do no more in the while-loop.
14667 (if (not single-as-list)
14669 (when regexp-in-group
14670 (setq regexp-in-group
14672 (mapconcat 'identity regexp-in-group
14674 (setq tags-in-group
14677 (regexp-opt tags-in-group)
14681 (when (stringp tags-in-group)
14682 (org-add-props tags-in-group '(grouptag t)))
14684 (replace-match tags-in-group t t return-match)))
14685 (setq tags-in-group
14686 (append regexp-in-group-escaped tags-in-group))))
14687 (setq taggroups-keys (delete tag taggroups-keys))))
14688 ;; Add the regular expressions back into the match-expression again.
14689 (while regexps-in-match
14690 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14691 (pop regexps-in-match)
14695 (if tags-in-group tags-in-group (list return-match))
14698 (list (if downcased (downcase match) match))
14701 (defun org-op-to-function (op &optional stringp)
14702 "Turn an operator into the appropriate function."
14705 ((equal op "<" ) '(< string< org-time<))
14706 ((equal op ">" ) '(> org-string> org-time>))
14707 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14708 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14709 ((member op '("=" "==")) '(= string= org-time=))
14710 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14711 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14713 (defun org<> (a b) (not (= a b)))
14714 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14715 (defun org-string>= (a b) (not (string< a b)))
14716 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14717 (defun org-string<> (a b) (not (string= a b)))
14718 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14719 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14720 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14721 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14722 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14723 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14725 "Convert S to a floating point time.
14726 If S is already a number, just return it. If it is a string, parse
14727 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14731 (condition-case nil
14732 (float-time (apply 'encode-time (org-parse-time-string s)))
14736 (defun org-time-today ()
14737 "Time in seconds today at 0:00.
14738 Returns the float number of seconds since the beginning of the
14739 epoch to the beginning of today (00:00)."
14740 (float-time (apply 'encode-time
14741 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14743 (defun org-matcher-time (s)
14744 "Interpret a time comparison value."
14747 ((string= s "<now>") (float-time))
14748 ((string= s "<today>") (org-time-today))
14749 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14750 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14751 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14752 (+ (org-time-today)
14753 (* (string-to-number (match-string 1 s))
14754 (cdr (assoc (match-string 2 s)
14755 '(("d" . 86400.0) ("w" . 604800.0)
14756 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14759 (defun org-match-any-p (re list)
14760 "Does re match any element of list?"
14761 (setq list (mapcar (lambda (x) (string-match re x)) list))
14764 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14765 (defvar org-tags-overlay (make-overlay 1 1))
14766 (org-detach-overlay org-tags-overlay)
14768 (defun org-get-local-tags-at (&optional pos)
14769 "Get a list of tags defined in the current headline."
14770 (org-get-tags-at pos 'local))
14772 (defun org-get-local-tags ()
14773 "Get a list of tags defined in the current headline."
14774 (org-get-tags-at nil 'local))
14776 (defun org-get-tags-at (&optional pos local)
14777 "Get a list of all headline tags applicable at POS.
14778 POS defaults to point. If tags are inherited, the list contains
14779 the targets in the same sequence as the headlines appear, i.e.
14780 the tags of the current headline come last.
14781 When LOCAL is non-nil, only return tags from the current headline,
14782 ignore inherited ones."
14784 (if (and org-trust-scanner-tags
14785 (or (not pos) (equal pos (point)))
14788 (let (tags ltags lastpos parent)
14792 (goto-char (or pos (point)))
14795 (condition-case nil
14797 (org-back-to-heading t)
14798 (while (not (equal lastpos (point)))
14799 (setq lastpos (point))
14801 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14802 (setq ltags (org-split-string
14803 (org-match-string-no-properties 1) ":"))
14805 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14808 (org-remove-uninherited-tags ltags)
14811 (or org-use-tag-inheritance (throw 'done t))
14812 (if local (throw 'done t))
14813 (or (org-up-heading-safe) (error nil))
14818 (reverse (delete-dups
14820 (org-remove-uninherited-tags
14821 org-file-tags) tags)))))))))
14823 (defun org-add-prop-inherited (s)
14824 (add-text-properties 0 (length s) '(inherited t) s)
14827 (defun org-toggle-tag (tag &optional onoff)
14828 "Toggle the tag TAG for the current line.
14829 If ONOFF is `on' or `off', don't toggle but set to this state."
14832 (org-back-to-heading t)
14833 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14836 (setq current (match-string 1))
14837 (replace-match ""))
14839 (setq current (nreverse (org-split-string current ":")))
14843 (or (member tag current) (push tag current)))
14845 (or (not (member tag current)) (setq current (delete tag current))))
14846 (t (if (member tag current)
14847 (setq current (delete tag current))
14849 (push tag current))))
14853 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14854 (org-set-tags nil t))
14855 (delete-horizontal-space))
14856 (run-hooks 'org-after-tags-change-hook))
14859 (defun org-align-tags-here (to-col)
14860 ;; Assumes that this is a headline
14861 "Align tags on the current headline to TO-COL."
14862 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14863 (beginning-of-line 1)
14864 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14865 (< pos (match-beginning 2)))
14867 (setq tags-l (- (match-end 2) (match-beginning 2)))
14868 (goto-char (match-beginning 1))
14870 (delete-region (point) (1+ (match-beginning 2)))
14871 (setq ncol (max (current-column)
14875 (- (abs to-col) tags-l))))
14877 (insert (make-string (- ncol (current-column)) ?\ ))
14878 (setq ncol (current-column))
14879 (when indent-tabs-mode (tabify p (point-at-eol)))
14880 (org-move-to-column (min ncol col)))
14883 (defun org-set-tags-command (&optional arg just-align)
14884 "Call the set-tags command for the current entry."
14886 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14887 (org-set-tags arg just-align)
14889 (unless (and (org-region-active-p)
14890 org-loop-over-headlines-in-active-region)
14891 (org-back-to-heading t))
14892 (org-set-tags arg just-align))))
14894 (defun org-set-tags-to (data)
14895 "Set the tags of the current entry to DATA, replacing the current tags.
14896 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14897 If DATA is nil or the empty string, any tags will be removed."
14898 (interactive "sTags: ")
14902 ((equal data "") "")
14904 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14907 (concat ":" (mapconcat 'identity data ":") ":"))))
14910 (org-back-to-heading t)
14911 (when (looking-at org-complex-heading-regexp)
14914 (goto-char (match-beginning 5))
14916 (delete-region (point) (point-at-eol))
14917 (org-set-tags nil 'align))
14918 (goto-char (point-at-eol))
14920 (org-set-tags nil 'align)))
14921 (beginning-of-line 1)
14922 (if (looking-at ".*?\\([ \t]+\\)$")
14923 (delete-region (match-beginning 1) (match-end 1))))))
14925 (defun org-align-all-tags ()
14926 "Align the tags i all headings."
14929 (or (ignore-errors (org-back-to-heading t))
14930 (outline-next-heading))
14931 (if (org-at-heading-p)
14933 (message "No headings"))))
14935 (defvar org-indent-indentation-per-level)
14936 (defun org-set-tags (&optional arg just-align)
14937 "Set the tags for the current headline.
14938 With prefix ARG, realign all tags in headings in the current buffer.
14939 When JUST-ALIGN is non-nil, only align tags."
14941 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14942 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14943 'region-start-level
14945 org-loop-over-headlines-in-active-region)
14947 ;; We don't use ARG and JUST-ALIGN here because these args
14948 ;; are not useful when looping over headlines.
14950 org-loop-over-headlines-in-active-region
14952 '(when (outline-invisible-p) (org-end-of-subtree nil t))))
14953 (let ((org-setting-tags t))
14956 (goto-char (point-min))
14957 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14958 (while (re-search-forward org-outline-regexp-bol nil t)
14959 (org-set-tags nil t)
14961 (message "All tags realigned to column %d" org-tags-column))
14962 (let* ((current (org-get-tags-string))
14963 (col (current-column))
14965 (if just-align current
14966 ;; Get a new set of tags from the user.
14970 org-last-tags-completion-table
14972 org-tag-persistent-alist
14973 (or org-tag-alist (org-get-buffer-tags))
14975 org-complete-tags-always-offer-all-agenda-tags
14976 (org-global-tags-completion-table
14977 (org-agenda-files))))))
14978 (current-tags (org-split-string current ":"))
14980 (nreverse (nthcdr (length current-tags)
14981 (nreverse (org-get-tags-at))))))
14982 (replace-regexp-in-string
14985 (if (or (eq t org-use-fast-tag-selection)
14986 (and org-use-fast-tag-selection
14987 (delq nil (mapcar #'cdr table))))
14988 (org-fast-tag-selection
14989 current-tags inherited-tags table
14990 (and org-fast-tag-selection-include-todo
14991 org-todo-key-alist))
14992 (let ((org-add-colon-after-tag-completion
14993 (< 1 (length table))))
14997 #'org-tags-completion-function
14998 nil nil current 'org-tags-history))))))))))
15000 (when org-tags-sort-function
15004 (sort (org-split-string tags (org-re "[^[:alnum:]_@#%]+"))
15005 org-tags-sort-function)
15008 (if (not (org-string-nw-p tags)) (setq tags "")
15009 (unless (string-match ":\\'" tags) (setq tags (concat tags ":")))
15010 (unless (string-match "\\`:" tags) (setq tags (concat ":" tags))))
15012 ;; Insert new tags at the correct column
15013 (beginning-of-line)
15014 (let ((level (if (looking-at org-outline-regexp)
15015 (- (match-end 0) (point) 1)
15018 ((and (equal current "") (equal tags "")))
15019 ((re-search-forward
15020 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15021 (line-end-position)
15023 (if (equal tags "") (replace-match "" t t)
15024 (goto-char (match-beginning 0))
15025 (let* ((c0 (current-column))
15026 ;; Compute offset for the case of org-indent-mode
15028 (di (if (org-bound-and-true-p org-indent-mode)
15029 (* (1- org-indent-indentation-per-level)
15032 (p0 (if (eq (char-before) ?*) (1+ (point)) (point)))
15033 (tc (+ org-tags-column
15034 (if (> org-tags-column 0) (- di) di)))
15037 (- (- tc) (string-width tags)))))
15038 (rpl (concat (make-string (max 0 (- c1 c0)) ?\s) tags)))
15039 (replace-match rpl t t)
15040 (when (and (not (featurep 'xemacs)) indent-tabs-mode)
15041 (tabify p0 (point))))))
15042 (t (error "Tags alignment failed"))))
15043 (org-move-to-column col))
15044 (unless just-align (run-hooks 'org-after-tags-change-hook))))))
15046 (defun org-change-tag-in-region (beg end tag off)
15047 "Add or remove TAG for each entry in the region.
15048 This works in the agenda, and also in an org-mode buffer."
15050 (list (region-beginning) (region-end)
15051 (let ((org-last-tags-completion-table
15052 (if (derived-mode-p 'org-mode)
15054 (delq nil (append (org-get-buffer-tags)
15055 (org-global-tags-completion-table))))
15056 (org-global-tags-completion-table))))
15057 (org-icompleting-read
15058 "Tag: " 'org-tags-completion-function nil nil nil
15059 'org-tags-history))
15061 (message "[s]et or
[r]emove? ")
15062 (equal (read-char-exclusive) ?r))))
15063 (if (fboundp 'deactivate-mark) (deactivate-mark))
15064 (let ((agendap (equal major-mode 'org-agenda-mode))
15065 l1 l2 m buf pos newhead (cnt 0))
15067 (setq l2 (1- (org-current-line)))
15069 (setq l1 (org-current-line))
15070 (loop for l from l1 to l2 do
15072 (setq m (get-text-property (point) 'org-hd-marker))
15073 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15075 (setq buf (if agendap (marker-buffer m) (current-buffer))
15076 pos (if agendap m (point)))
15077 (with-current-buffer buf
15081 (setq cnt (1+ cnt))
15082 (org-toggle-tag tag (if off 'off 'on))
15083 (setq newhead (org-get-heading)))))
15084 (and agendap (org-agenda-change-all-lines newhead m))))
15085 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15087 (defun org-tags-completion-function (string predicate &optional flag)
15088 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15089 (confirm (lambda (x) (stringp (car x)))))
15090 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15091 (setq s1 (match-string 1 string)
15092 s2 (match-string 2 string))
15093 (setq s1 "" s2 string))
15097 (setq rtn (try-completion s2 ctable confirm))
15100 (concat s1 s2 (substring rtn (length s2))
15101 (if (and org-add-colon-after-tag-completion
15102 (assoc rtn ctable))
15107 (all-completions s2 ctable confirm))
15110 (assoc s2 ctable)))))
15112 (defun org-fast-tag-insert (kwd tags face &optional end)
15113 "Insert KDW, and the TAGS, the latter with face FACE.
15115 (insert (format "%-12s" (concat kwd ":"))
15116 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15119 (defun org-fast-tag-show-exit (flag)
15122 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15123 (replace-match ""))
15126 (org-move-to-column (- (window-width) 19) t)
15127 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15129 (defun org-set-current-tags-overlay (current prefix)
15130 "Add an overlay to CURRENT tag with PREFIX."
15131 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15132 (if (featurep 'xemacs)
15133 (org-overlay-display org-tags-overlay (concat prefix s)
15134 'secondary-selection)
15135 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15136 (org-overlay-display org-tags-overlay (concat prefix s)))))
15138 (defvar org-last-tag-selection-key nil)
15139 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15140 "Fast tag selection with single keys.
15141 CURRENT is the current list of tags in the headline, INHERITED is the
15142 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15143 possibly with grouping information. TODO-TABLE is a similar table with
15144 TODO keywords, should these have keys assigned to them.
15145 If the keys are nil, a-z are automatically assigned.
15146 Returns the new tags string, or nil to not change the current settings."
15147 (let* ((fulltable (append table todo-table))
15148 (maxlen (apply 'max (mapcar
15150 (if (stringp (car x)) (string-width (car x)) 0))
15152 (buf (current-buffer))
15153 (expert (eq org-fast-tag-selection-single-key 'expert))
15155 (fwidth (+ maxlen 3 1 3))
15156 (ncol (/ (- (window-width) 4) fwidth))
15159 tg cnt e c char c1 c2 ntable tbl rtn
15160 ov-start ov-end ov-prefix
15161 (exit-after-next org-fast-tag-selection-single-key)
15162 (done-keywords org-done-keywords)
15163 groups ingroup intaggroup)
15165 (beginning-of-line 1)
15167 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15168 (setq ov-start (match-beginning 1)
15169 ov-end (match-end 1)
15171 (setq ov-start (1- (point-at-eol))
15172 ov-end (1+ ov-start))
15173 (skip-chars-forward "^\n\r")
15176 (buffer-substring (1- (point)) (point))
15177 (if (> (current-column) org-tags-column)
15179 (make-string (- org-tags-column (current-column)) ?\ ))))))
15180 (move-overlay org-tags-overlay ov-start ov-end)
15181 (save-window-excursion
15183 (set-buffer (get-buffer-create " *Org tags*"))
15184 (delete-other-windows)
15185 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15186 (org-switch-to-buffer-other-window " *Org tags*"))
15188 (org-set-local 'org-done-keywords done-keywords)
15189 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15190 (org-fast-tag-insert "Current" current c-face "\n\n")
15191 (org-fast-tag-show-exit exit-after-next)
15192 (org-set-current-tags-overlay current ov-prefix)
15193 (setq tbl fulltable char ?a cnt 0)
15194 (while (setq e (pop tbl))
15196 ((eq (car e) :startgroup)
15197 (push '() groups) (setq ingroup t)
15198 (unless (zerop cnt)
15201 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15202 ((eq (car e) :endgroup)
15203 (setq ingroup nil cnt 0)
15204 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15205 ((eq (car e) :startgrouptag)
15206 (setq intaggroup t)
15207 (unless (zerop cnt)
15211 ((eq (car e) :endgrouptag)
15212 (setq intaggroup nil cnt 0)
15214 ((equal e '(:newline))
15215 (unless (zerop cnt)
15219 (while (equal (car tbl) '(:newline))
15221 (setq tbl (cdr tbl)))))
15222 ((equal e '(:grouptags)) (insert " : "))
15224 (setq tg (copy-sequence (car e)) c2 nil)
15227 ;; automatically assign a character.
15228 (setq c1 (string-to-char
15229 (downcase (substring
15230 tg (if (= (string-to-char tg) ?@) 1 0)))))
15231 (if (or (rassoc c1 ntable) (rassoc c1 table))
15232 (while (or (rassoc char ntable) (rassoc char table))
15233 (setq char (1+ char)))
15235 (setq c (or c2 char)))
15236 (when ingroup (push tg (car groups)))
15237 (setq tg (org-add-props tg nil 'face
15239 ((not (assoc tg table))
15240 (org-get-todo-face tg))
15241 ((member tg current) c-face)
15242 ((member tg inherited) i-face))))
15243 (when (equal (caar tbl) :grouptags)
15244 (org-add-props tg nil 'face 'org-tag-group))
15245 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15246 (insert "[" c "] " tg (make-string
15247 (- fwidth 4 (length tg)) ?\ ))
15248 (push (cons tg c) ntable)
15249 (when (= (incf cnt) ncol)
15251 (when (or ingroup intaggroup) (insert " "))
15253 (setq ntable (nreverse ntable))
15255 (goto-char (point-min))
15256 (unless expert (org-fit-window-to-buffer))
15260 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15261 (if (not groups) "no " "")
15262 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15263 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15264 (setq org-last-tag-selection-key c)
15266 ((= c ?\r) (throw 'exit t))
15268 (setq groups (not groups))
15269 (goto-char (point-min))
15270 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15273 (org-fast-tag-show-exit
15274 (setq exit-after-next (not exit-after-next)))
15276 (delete-other-windows)
15277 (set-window-buffer (split-window-vertically) " *Org tags*")
15278 (org-switch-to-buffer-other-window " *Org tags*")
15279 (org-fit-window-to-buffer)))
15281 (and (= c ?q) (not (rassoc c ntable))))
15282 (org-detach-overlay org-tags-overlay)
15283 (setq quit-flag t))
15286 (when exit-after-next (setq exit-after-next 'now)))
15288 (condition-case nil
15289 (setq tg (org-icompleting-read
15292 (with-current-buffer buf
15293 (org-get-buffer-tags)))))
15294 (quit (setq tg "")))
15295 (when (string-match "\\S-" tg)
15296 (add-to-list 'buffer-tags (list tg))
15297 (if (member tg current)
15298 (setq current (delete tg current))
15299 (push tg current)))
15300 (when exit-after-next (setq exit-after-next 'now)))
15301 ((setq e (rassoc c todo-table) tg (car e))
15302 (with-current-buffer buf
15303 (save-excursion (org-todo tg)))
15304 (when exit-after-next (setq exit-after-next 'now)))
15305 ((setq e (rassoc c ntable) tg (car e))
15306 (if (member tg current)
15307 (setq current (delete tg current))
15308 (loop for g in groups do
15309 (when (member tg g)
15310 (dolist (x g) (setq current (delete x current)))))
15312 (when exit-after-next (setq exit-after-next 'now))))
15314 ;; Create a sorted list
15318 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15319 (when (eq exit-after-next 'now) (throw 'exit t))
15320 (goto-char (point-min))
15321 (beginning-of-line 2)
15322 (delete-region (point) (point-at-eol))
15323 (org-fast-tag-insert "Current" current c-face)
15324 (org-set-current-tags-overlay current ov-prefix)
15325 (while (re-search-forward
15326 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15327 (setq tg (match-string 1))
15328 (add-text-properties
15329 (match-beginning 1) (match-end 1)
15332 ((member tg current) c-face)
15333 ((member tg inherited) i-face)
15334 (t (get-text-property (match-beginning 1) 'face))))))
15335 (goto-char (point-min)))))
15336 (org-detach-overlay org-tags-overlay)
15338 (mapconcat 'identity current ":")
15341 (defun org-get-tags-string ()
15342 "Get the TAGS string in the current headline."
15343 (unless (org-at-heading-p t)
15344 (user-error "Not on a heading"))
15346 (beginning-of-line 1)
15347 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15348 (org-match-string-no-properties 1)
15351 (defun org-get-tags ()
15352 "Get the list of tags specified in the current headline."
15353 (org-split-string (org-get-tags-string) ":"))
15355 (defun org-get-buffer-tags ()
15356 "Get a table of all tags used in the buffer, for completion."
15357 (org-with-wide-buffer
15358 (goto-char (point-min))
15359 (let ((tag-re (concat org-outline-regexp-bol
15360 "\\(?:.*?[ \t]\\)?"
15361 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15363 (while (re-search-forward tag-re nil t)
15364 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15366 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15368 ;;;; The mapping API
15370 (defun org-map-entries (func &optional match scope &rest skip)
15371 "Call FUNC at each headline selected by MATCH in SCOPE.
15373 FUNC is a function or a lisp form. The function will be called without
15374 arguments, with the cursor positioned at the beginning of the headline.
15375 The return values of all calls to the function will be collected and
15376 returned as a list.
15378 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15379 does not need to preserve point. After evaluation, the cursor will be
15380 moved to the end of the line (presumably of the headline of the
15381 processed entry) and search continues from there. Under some
15382 circumstances, this may not produce the wanted results. For example,
15383 if you have removed (e.g. archived) the current (sub)tree it could
15384 mean that the next entry will be skipped entirely. In such cases, you
15385 can specify the position from where search should continue by making
15386 FUNC set the variable `org-map-continue-from' to the desired buffer
15389 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15390 Only headlines that are matched by this query will be considered during
15391 the iteration. When MATCH is nil or t, all headlines will be
15392 visited by the iteration.
15394 SCOPE determines the scope of this command. It can be any of:
15396 nil The current buffer, respecting the restriction if any
15397 tree The subtree started with the entry at point
15398 region The entries within the active region, if any
15400 The entries within the active region, but only those at
15401 the same level than the first one.
15402 file The current buffer, without restriction
15404 The current buffer, and any archives associated with it
15405 agenda All agenda files
15406 agenda-with-archives
15407 All agenda files with any archive files associated with them
15409 If this is a list, all files in the list will be scanned
15411 The remaining args are treated as settings for the skipping facilities of
15412 the scanner. The following items can be given here:
15414 archive skip trees with the archive tag
15415 comment skip trees with the COMMENT keyword
15416 function or Emacs Lisp form:
15417 will be used as value for `org-agenda-skip-function', so
15418 whenever the function returns a position, FUNC will not be
15419 called for that entry and search will continue from the
15422 If your function needs to retrieve the tags including inherited tags
15423 at the *current* entry, you can use the value of the variable
15424 `org-scanner-tags' which will be much faster than getting the value
15425 with `org-get-tags-at'. If your function gets properties with
15426 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15427 to t around the call to `org-entry-properties' to get the same speedup.
15428 Note that if your function moves around to retrieve tags and properties at
15429 a *different* entry, you cannot use these techniques."
15430 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15431 (not (org-region-active-p)))
15432 (let* ((org-agenda-archives-mode nil) ; just to make sure
15433 (org-agenda-skip-archived-trees (memq 'archive skip))
15434 (org-agenda-skip-comment-trees (memq 'comment skip))
15435 (org-agenda-skip-function
15436 (car (org-delete-all '(comment archive) skip)))
15437 (org-tags-match-list-sublevels t)
15438 (start-level (eq scope 'region-start-level))
15440 org-todo-keywords-for-agenda
15441 org-done-keywords-for-agenda
15442 org-todo-keyword-alist-for-agenda
15443 org-tag-alist-for-agenda
15447 ((eq match t) (setq matcher t))
15448 ((eq match nil) (setq matcher t))
15449 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15453 (cond ((eq scope 'tree)
15454 (org-back-to-heading t)
15455 (org-narrow-to-subtree)
15457 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15458 (org-region-active-p))
15459 ;; If needed, set start-level to a string like "2"
15462 (goto-char (region-beginning))
15463 (unless (org-at-heading-p) (outline-next-heading))
15464 (setq start-level (org-current-level))))
15465 (narrow-to-region (region-beginning)
15467 (goto-char (region-end))
15468 (unless (and (bolp) (org-at-heading-p))
15469 (outline-next-heading))
15475 (org-agenda-prepare-buffers
15476 (list (buffer-file-name (current-buffer))))
15477 (setq res (org-scan-tags func matcher todo-only start-level)))
15478 ;; Get the right scope
15480 ((and scope (listp scope) (symbolp (car scope)))
15481 (setq scope (eval scope)))
15482 ((eq scope 'agenda)
15483 (setq scope (org-agenda-files t)))
15484 ((eq scope 'agenda-with-archives)
15485 (setq scope (org-agenda-files t))
15486 (setq scope (org-add-archive-files scope)))
15488 (setq scope (list (buffer-file-name))))
15489 ((eq scope 'file-with-archives)
15490 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15491 (org-agenda-prepare-buffers scope)
15492 (while (setq file (pop scope))
15493 (with-current-buffer (org-find-base-buffer-visiting file)
15497 (goto-char (point-min))
15498 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15503 (defconst org-special-properties
15504 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15505 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15506 "The special properties valid in Org mode.
15507 These are properties that are not defined in the property drawer,
15508 but in some other way.")
15510 (defconst org-default-properties
15511 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15512 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15513 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15514 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15515 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15516 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15517 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15518 "Some properties that are used by Org mode for various purposes.
15519 Being in this list makes sure that they are offered for completion.")
15521 (defun org--update-property-plist (key val props)
15522 "Associate KEY to VAL in alist PROPS.
15523 Modifications are made by side-effect. Return new alist."
15524 (let* ((appending (string= (substring key -1) "+"))
15525 (key (if appending (substring key 0 -1) key))
15526 (old (assoc-string key props t)))
15527 (if (not old) (cons (cons key val) props)
15528 (setcdr old (if appending (concat (cdr old) " " val) val))
15531 (defun org-get-property-block (&optional beg force)
15532 "Return the (beg . end) range of the body of the property drawer.
15533 BEG is the beginning of the current subtree, or of the part
15534 before the first headline. If it is not given, it will be found.
15535 If the drawer does not exist, create it if FORCE is non-nil, or
15537 (org-with-wide-buffer
15538 (when beg (goto-char beg))
15539 (unless (org-before-first-heading-p)
15540 (let ((beg (cond (beg)
15541 ((or (not (featurep 'org-inlinetask))
15542 (org-inlinetask-in-task-p))
15543 (org-back-to-heading t))
15544 (t (org-with-limited-levels (org-back-to-heading t))))))
15546 (when (org-looking-at-p org-planning-line-re) (forward-line))
15547 (cond ((looking-at org-property-drawer-re)
15549 (cons (point) (progn (goto-char (match-end 0))
15550 (line-beginning-position))))
15553 (org-insert-property-drawer)
15554 (let ((pos (save-excursion (search-forward ":END:")
15555 (line-beginning-position))))
15556 (cons pos pos))))))))
15558 (defun org-at-property-p ()
15559 "Non-nil when point is inside a property drawer.
15560 See `org-property-re' for match data, if applicable."
15562 (beginning-of-line)
15563 (and (looking-at org-property-re)
15564 (let ((property-drawer (save-match-data (org-get-property-block))))
15565 (and property-drawer
15566 (>= (point) (car property-drawer))
15567 (< (point) (cdr property-drawer)))))))
15569 (defun org-property-action ()
15570 "Do an action on properties."
15572 (unless (org-at-property-p) (user-error "Not at a property"))
15573 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15574 (let ((c (read-char-exclusive)))
15576 (?s (call-interactively #'org-set-property))
15577 (?d (call-interactively #'org-delete-property))
15578 (?D (call-interactively #'org-delete-property-globally))
15579 (?c (call-interactively #'org-compute-property-at-point))
15580 (otherwise (user-error "No such property action %c" c)))))
15582 (defun org-inc-effort ()
15583 "Increment the value of the effort property in the current entry."
15585 (org-set-effort nil t))
15587 (defvar org-clock-effort) ; Defined in org-clock.el.
15588 (defvar org-clock-current-task) ; Defined in org-clock.el.
15589 (defun org-set-effort (&optional value increment)
15590 "Set the effort property of the current entry.
15591 With numerical prefix arg, use the nth allowed value, 0 stands for the
15592 10th allowed value.
15594 When INCREMENT is non-nil, set the property to the next allowed value."
15596 (if (equal value 0) (setq value 10))
15597 (let* ((completion-ignore-case t)
15598 (prop org-effort-property)
15599 (cur (org-entry-get nil prop))
15600 (allowed (org-property-get-allowed-values nil prop 'table))
15601 (existing (mapcar 'list (org-property-values prop)))
15602 (heading (nth 4 (org-heading-components)))
15605 ((stringp value) value)
15606 ((and allowed (integerp value))
15607 (or (car (nth (1- value) allowed))
15608 (car (org-last allowed))))
15609 ((and allowed increment)
15610 (or (caadr (member (list cur) allowed))
15611 (user-error "Allowed effort values are not set")))
15613 (message "Select 1-9,0, [RET%s]: %s"
15614 (if cur (concat "=" cur) "")
15615 (mapconcat 'car allowed " "))
15616 (setq rpl (read-char-exclusive))
15617 (if (equal rpl ?\r)
15619 (setq rpl (- rpl ?0))
15620 (if (equal rpl 0) (setq rpl 10))
15621 (if (and (> rpl 0) (<= rpl (length allowed)))
15622 (car (nth (1- rpl) allowed))
15623 (org-completing-read "Effort: " allowed nil))))
15625 (let (org-completion-use-ido org-completion-use-iswitchb)
15626 (org-completing-read
15627 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15628 (concat "[" cur "]") "")
15630 existing nil nil "" nil cur))))))
15631 (unless (equal (org-entry-get nil prop) val)
15632 (org-entry-put nil prop val))
15633 (org-refresh-property
15634 '((effort . identity)
15635 (effort-minutes . org-duration-string-to-minutes))
15637 (when (string= heading org-clock-current-task)
15638 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15639 (org-clock-update-mode-line))
15640 (message "%s is now %s" prop val)))
15642 (defun org-entry-properties (&optional pom which)
15643 "Get all properties of the current entry.
15645 When POM is a buffer position, get all properties from the entry
15648 This includes the TODO keyword, the tags, time strings for
15649 deadline, scheduled, and clocking, and any additional properties
15650 defined in the entry.
15652 If WHICH is nil or `all', get all properties. If WHICH is
15653 `special' or `standard', only get that subclass. If WHICH is
15654 a string, only get that property.
15656 Return value is an alist. Keys are properties, as upcased
15658 (org-with-point-at pom
15659 (when (and (derived-mode-p 'org-mode)
15660 (ignore-errors (org-back-to-heading t)))
15662 (let* ((beg (point))
15663 (specific (and (stringp which) (upcase which)))
15664 (which (cond ((not specific) which)
15665 ((member specific org-special-properties) 'special)
15668 ;; Get the special properties, like TODO and TAGS.
15669 (when (memq which '(nil all special))
15670 (when (or (not specific) (string= specific "CLOCKSUM"))
15671 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15673 (push (cons "CLOCKSUM"
15674 (org-columns-number-to-string
15675 (/ (float clocksum) 60.) 'add_times))
15677 (when specific (throw 'exit props)))
15678 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15679 (let ((clocksumt (get-text-property (point)
15680 :org-clock-minutes-today)))
15682 (push (cons "CLOCKSUM_T"
15683 (org-columns-number-to-string
15684 (/ (float clocksumt) 60.) 'add_times))
15686 (when specific (throw 'exit props)))
15687 (when (or (not specific) (string= specific "ITEM"))
15688 (when (looking-at org-complex-heading-regexp)
15691 (org-match-string-no-properties 1)
15692 (let ((title (org-match-string-no-properties 4)))
15693 (when (org-string-nw-p title)
15694 (concat " " (org-remove-tabs title))))))
15696 (when specific (throw 'exit props)))
15697 (when (or (not specific) (string= specific "TODO"))
15698 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15699 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15700 (when specific (throw 'exit props)))
15701 (when (or (not specific) (string= specific "PRIORITY"))
15702 (when (looking-at org-priority-regexp)
15703 (push (cons "PRIORITY" (org-match-string-no-properties 2))
15705 (when specific (throw 'exit props)))
15706 (when (or (not specific) (string= specific "FILE"))
15707 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15709 (when specific (throw 'exit props)))
15710 (when (or (not specific) (string= specific "TAGS"))
15711 (let ((value (org-string-nw-p (org-get-tags-string))))
15712 (when value (push (cons "TAGS" value) props)))
15713 (when specific (throw 'exit props)))
15714 (when (or (not specific) (string= specific "ALLTAGS"))
15715 (let ((value (org-get-tags-at)))
15717 (push (cons "ALLTAGS"
15718 (format ":%s:" (mapconcat #'identity value ":")))
15720 (when specific (throw 'exit props)))
15721 (when (or (not specific) (string= specific "BLOCKED"))
15722 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15723 (when specific (throw 'exit props)))
15724 (when (or (not specific)
15725 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15727 (when (org-looking-at-p org-planning-line-re)
15729 (let ((bol (line-beginning-position))
15730 ;; Backward compatibility: time keywords used to
15731 ;; be configurable (before 8.3). Make sure we
15732 ;; get the correct keyword.
15733 (key-assoc `(("CLOSED" . ,org-closed-string)
15734 ("DEADLINE" . ,org-deadline-string)
15735 ("SCHEDULED" . ,org-scheduled-string))))
15736 (dolist (pair (if specific (list (assoc specific key-assoc))
15739 (when (search-backward (cdr pair) bol t)
15740 (goto-char (match-end 0))
15741 (skip-chars-forward " \t")
15742 (and (looking-at org-ts-regexp-both)
15743 (push (cons (car pair)
15744 (org-match-string-no-properties 0))
15746 (when specific (throw 'exit props)))
15747 (when (or (not specific)
15748 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15751 (let ((regexp (cond
15752 ((string= specific "TIMESTAMP")
15754 ((string= specific "TIMESTAMP_IA")
15755 org-ts-regexp-inactive)
15756 ((assoc "TIMESTAMP_IA" ts)
15758 ((assoc "TIMESTAMP" ts)
15759 org-ts-regexp-inactive)
15760 (t org-ts-regexp-both))))
15762 (while (re-search-forward regexp end t)
15764 (let ((object (org-element-context)))
15765 ;; Accept to match timestamps in node
15766 ;; properties, too.
15767 (when (memq (org-element-type object)
15768 '(node-property timestamp))
15770 (org-element-property :type object)))
15772 ((and (memq type '(active active-range))
15773 (not (equal specific "TIMESTAMP_IA")))
15774 (unless (assoc "TIMESTAMP" ts)
15775 (push (cons "TIMESTAMP"
15776 (org-element-property
15777 :raw-value object))
15779 (when specific (throw 'exit ts))))
15780 ((and (memq type '(inactive inactive-range))
15781 (not (string= specific "TIMESTAMP")))
15782 (unless (assoc "TIMESTAMP_IA" ts)
15783 (push (cons "TIMESTAMP_IA"
15784 (org-element-property
15785 :raw-value object))
15787 (when specific (throw 'exit ts))))))
15788 ;; Both timestamp types are found,
15789 ;; move to next part.
15790 (when (= (length ts) 2) (throw 'next ts)))))
15793 ;; First look for timestamps within headline.
15794 (let ((ts (funcall find-ts (line-end-position) nil)))
15795 (if (= (length ts) 2) (setq props (nconc ts props))
15797 ;; Then find timestamps in the section, skipping
15799 (when (org-looking-at-p org-planning-line-re)
15801 (let ((end (save-excursion (outline-next-heading))))
15802 (setq props (nconc (funcall find-ts end ts) props))))))))
15803 ;; Get the standard properties, like :PROP:.
15804 (when (memq which '(nil all standard))
15805 ;; If we are looking after a specific property, delegate
15806 ;; to `org-entry-get', which is faster. However, make an
15807 ;; exception for "CATEGORY", since it can be also set
15808 ;; through keywords (i.e. #+CATEGORY).
15809 (if (and specific (not (equal specific "CATEGORY")))
15810 (let ((value (org-entry-get beg specific nil t)))
15811 (throw 'exit (and value (list (cons specific value)))))
15812 (let ((range (org-get-property-block beg)))
15814 (let ((end (cdr range)) seen-base)
15815 (goto-char (car range))
15816 ;; Unlike to `org--update-property-plist', we
15817 ;; handle the case where base values is found
15818 ;; after its extension. We also forbid standard
15819 ;; properties to be named as special properties.
15820 (while (re-search-forward org-property-re end t)
15821 (let* ((key (upcase (org-match-string-no-properties 2)))
15822 (extendp (org-string-match-p "\\+\\'" key))
15823 (key-base (if extendp (substring key 0 -1) key))
15824 (value (org-match-string-no-properties 3)))
15826 ((member-ignore-case key-base org-special-properties))
15829 (org--update-property-plist key value props)))
15830 ((member key seen-base))
15831 (t (push key seen-base)
15832 (let ((p (assoc-string key props t)))
15833 (if p (setcdr p (concat value " " (cdr p)))
15834 (push (cons key value) props))))))))))))
15835 (unless (assoc "CATEGORY" props)
15836 (push (cons "CATEGORY" (org-get-category beg)) props)
15837 (when (string= specific "CATEGORY") (throw 'exit props)))
15839 (append (get-text-property beg 'org-summaries) props))))))
15841 (defun org-property--local-values (property literal-nil)
15842 "Return value for PROPERTY in current entry.
15843 Value is a list whose care is the base value for PROPERTY and cdr
15844 a list of accumulated values. Return nil if neither is found in
15845 the entry. Also return nil when PROPERTY is set to \"nil\",
15846 unless LITERAL-NIL is non-nil."
15847 (let ((range (org-get-property-block)))
15849 (goto-char (car range))
15850 (let* ((case-fold-search t)
15855 (let ((v (and (re-search-forward
15856 (org-re-property property nil t) end t)
15857 (org-match-string-no-properties 3))))
15858 (list (if literal-nil v (org-not-nil v)))))))
15859 ;; Find additional values.
15860 (let* ((property+ (org-re-property (concat property "+") nil t)))
15861 (while (re-search-forward property+ end t)
15862 (push (org-match-string-no-properties 3) value)))
15863 ;; Return final values.
15864 (and (not (equal value '(nil))) (nreverse value))))))
15866 (defun org-entry-get (pom property &optional inherit literal-nil)
15867 "Get value of PROPERTY for entry or content at point-or-marker POM.
15869 If INHERIT is non-nil and the entry does not have the property,
15870 then also check higher levels of the hierarchy. If INHERIT is
15871 the symbol `selective', use inheritance only if the setting in
15872 `org-use-property-inheritance' selects PROPERTY for inheritance.
15874 If the property is present but empty, the return value is the
15875 empty string. If the property is not present at all, nil is
15876 returned. In any other case, return the value as a string.
15877 Search is case-insensitive.
15879 If LITERAL-NIL is set, return the string value \"nil\" as
15880 a string, do not interpret it as the list atom nil. This is used
15881 for inheritance when a \"nil\" value can supersede a non-nil
15882 value higher up the hierarchy."
15883 (org-with-point-at pom
15885 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15886 ;; We need a special property. Use `org-entry-properties' to
15887 ;; retrieve it, but specify the wanted property.
15888 (cdr (assoc-string property (org-entry-properties nil property))))
15890 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15891 (org-entry-get-with-inheritance property literal-nil))
15893 (let* ((local (org-property--local-values property literal-nil))
15894 (value (and local (mapconcat #'identity (delq nil local) " "))))
15895 (if literal-nil value (org-not-nil value)))))))
15897 (defun org-property-or-variable-value (var &optional inherit)
15898 "Check if there is a property fixing the value of VAR.
15899 If yes, return this value. If not, return the current value of the variable."
15900 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15901 (if (and prop (stringp prop) (string-match "\\S-" prop))
15903 (symbol-value var))))
15905 (defun org-entry-delete (pom property)
15906 "Delete PROPERTY from entry at point-or-marker POM.
15907 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15908 non-nil when a property was removed."
15909 (unless (member property org-special-properties)
15910 (org-with-point-at pom
15911 (let ((range (org-get-property-block)))
15913 (let* ((begin (car range))
15914 (origin (cdr range))
15915 (end (copy-marker origin))
15916 (re (org-re-property
15917 (concat (regexp-quote property) "\\+?") t t)))
15919 (while (re-search-forward re end t)
15920 (delete-region (match-beginning 0) (line-beginning-position 2)))
15921 ;; If drawer is empty, remove it altogether.
15922 (when (= begin end)
15923 (delete-region (line-beginning-position 0)
15924 (line-beginning-position 2)))
15925 ;; Return non-nil if some property was removed.
15926 (prog1 (/= end origin) (set-marker end nil))))))))
15928 ;; Multi-values properties are properties that contain multiple values
15929 ;; These values are assumed to be single words, separated by whitespace.
15930 (defun org-entry-add-to-multivalued-property (pom property value)
15931 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15932 (let* ((old (org-entry-get pom property))
15933 (values (and old (org-split-string old "[ \t]"))))
15934 (setq value (org-entry-protect-space value))
15935 (unless (member value values)
15936 (setq values (append values (list value)))
15937 (org-entry-put pom property
15938 (mapconcat 'identity values " ")))))
15940 (defun org-entry-remove-from-multivalued-property (pom property value)
15941 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15942 (let* ((old (org-entry-get pom property))
15943 (values (and old (org-split-string old "[ \t]"))))
15944 (setq value (org-entry-protect-space value))
15945 (when (member value values)
15946 (setq values (delete value values))
15947 (org-entry-put pom property
15948 (mapconcat 'identity values " ")))))
15950 (defun org-entry-member-in-multivalued-property (pom property value)
15951 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15952 (let* ((old (org-entry-get pom property))
15953 (values (and old (org-split-string old "[ \t]"))))
15954 (setq value (org-entry-protect-space value))
15955 (member value values)))
15957 (defun org-entry-get-multivalued-property (pom property)
15958 "Return a list of values in a multivalued property."
15959 (let* ((value (org-entry-get pom property))
15960 (values (and value (org-split-string value "[ \t]"))))
15961 (mapcar 'org-entry-restore-space values)))
15963 (defun org-entry-put-multivalued-property (pom property &rest values)
15964 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15965 VALUES should be a list of strings. Spaces will be protected."
15966 (org-entry-put pom property
15967 (mapconcat 'org-entry-protect-space values " "))
15968 (let* ((value (org-entry-get pom property))
15969 (values (and value (org-split-string value "[ \t]"))))
15970 (mapcar 'org-entry-restore-space values)))
15972 (defun org-entry-protect-space (s)
15973 "Protect spaces and newline in string S."
15974 (while (string-match " " s)
15975 (setq s (replace-match "%20" t t s)))
15976 (while (string-match "\n" s)
15977 (setq s (replace-match "%0A" t t s)))
15980 (defun org-entry-restore-space (s)
15981 "Restore spaces and newline in string S."
15982 (while (string-match "%20" s)
15983 (setq s (replace-match " " t t s)))
15984 (while (string-match "%0A" s)
15985 (setq s (replace-match "\n" t t s)))
15988 (defvar org-entry-property-inherited-from (make-marker)
15989 "Marker pointing to the entry from where a property was inherited.
15990 Each call to `org-entry-get-with-inheritance' will set this marker to the
15991 location of the entry where the inheritance search matched. If there was
15992 no match, the marker will point nowhere.
15993 Note that also `org-entry-get' calls this function, if the INHERIT flag
15996 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15997 "Get PROPERTY of entry or content at point, search higher levels if needed.
15998 The search will stop at the first ancestor which has the property defined.
15999 If the value found is \"nil\", return nil to show that the property
16000 should be considered as undefined (this is the meaning of nil here).
16001 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
16002 (move-marker org-entry-property-inherited-from nil)
16003 (org-with-wide-buffer
16007 (let ((v (org-property--local-values property literal-nil)))
16010 (concat (mapconcat #'identity (delq nil v) " ")
16015 (org-back-to-heading t)
16016 (move-marker org-entry-property-inherited-from (point))
16018 ((org-up-heading-safe))
16021 (cdr (or (assoc-string property org-file-properties t)
16022 (assoc-string property org-global-properties t)
16023 (assoc-string property org-global-properties-fixed t)))))
16024 (cond ((not global))
16025 (value (setq value (concat global " " value)))
16026 (t (setq value global))))
16027 (throw 'exit nil))))))
16028 (if literal-nil value (org-not-nil value)))))
16030 (defvar org-property-changed-functions nil
16031 "Hook called when the value of a property has changed.
16032 Each hook function should accept two arguments, the name of the property
16033 and the new value.")
16035 (defun org-entry-put (pom property value)
16036 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16038 If the value is `nil', it is converted to the empty string. If
16039 it is not a string, an error is raised.
16041 PROPERTY can be any regular property (see
16042 `org-special-properties'). It can also be \"TODO\",
16043 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16045 For the last two properties, VALUE may have any of the special
16046 values \"earlier\" and \"later\". The function then increases or
16047 decreases scheduled or deadline date by one day."
16048 (cond ((null value) (setq value ""))
16049 ((not (stringp value)) (error "Properties values should be strings")))
16050 (org-with-point-at pom
16051 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16052 (org-back-to-heading t)
16053 (org-with-limited-levels (org-back-to-heading t)))
16054 (let ((beg (point)))
16056 ((equal property "TODO")
16057 (cond ((not (org-string-nw-p value)) (setq value 'none))
16058 ((not (member value org-todo-keywords-1))
16059 (user-error "\"%s\" is not a valid TODO state" value)))
16061 (org-set-tags nil 'align))
16062 ((equal property "PRIORITY")
16063 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16064 (org-set-tags nil 'align))
16065 ((equal property "SCHEDULED")
16067 (if (and (org-looking-at-p org-planning-line-re)
16069 org-scheduled-time-regexp (line-end-position) t))
16070 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16071 ((string= value "later") (org-timestamp-change 1 'day))
16072 ((string= value "") (org-schedule '(4)))
16073 (t (org-schedule nil value)))
16074 (if (member value '("earlier" "later" ""))
16075 (call-interactively #'org-schedule)
16076 (org-schedule nil value))))
16077 ((equal property "DEADLINE")
16079 (if (and (org-looking-at-p org-planning-line-re)
16081 org-deadline-time-regexp (line-end-position) t))
16082 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16083 ((string= value "later") (org-timestamp-change 1 'day))
16084 ((string= value "") (org-deadline '(4)))
16085 (t (org-deadline nil value)))
16086 (if (member value '("earlier" "later" ""))
16087 (call-interactively #'org-deadline)
16088 (org-deadline nil value))))
16089 ((member property org-special-properties)
16090 (error "The %s property cannot be set with `org-entry-put'" property))
16092 (let* ((range (org-get-property-block beg 'force))
16094 (case-fold-search t))
16095 (goto-char (car range))
16096 (if (re-search-forward (org-re-property property nil t) end t)
16097 (progn (delete-region (match-beginning 0) (match-end 0))
16098 (goto-char (match-beginning 0)))
16102 (insert ":" property ":")
16103 (when value (insert " " value))
16104 (org-indent-line)))))
16105 (run-hook-with-args 'org-property-changed-functions property value)))
16107 (defun org-buffer-property-keys (&optional specials defaults columns)
16108 "Get all property keys in the current buffer.
16110 When SPECIALS is non-nil, also list the special properties that
16111 reflect things like tags and TODO state.
16113 When DEFAULTS is non-nil, also include properties that has
16114 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16115 DESCRIPTION, LOCATION, and LOGGING and others.
16117 When COLUMNS in non-nil, also include property names given in
16118 COLUMN formats in the current buffer."
16119 (let ((case-fold-search t)
16121 (and specials org-special-properties)
16122 (and defaults (cons org-effort-property org-default-properties))
16124 (org-with-wide-buffer
16125 (goto-char (point-min))
16126 (while (re-search-forward org-property-start-re nil t)
16127 (let ((range (org-get-property-block)))
16130 (when (and (not (org-before-first-heading-p))
16131 (y-or-n-p (format "Malformed drawer at %d, repair?"
16132 (line-beginning-position))))
16133 (org-get-property-block nil t))
16135 (goto-char (car range))
16136 (let ((begin (car range))
16138 ;; Make sure that found property block is not located
16139 ;; before current point, as it would generate an infloop.
16140 ;; It can happen, for example, in the following
16147 ;; *************** Inlinetask
16152 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16153 (while (< (point) end)
16154 (let ((p (progn (looking-at org-property-re)
16155 (org-match-string-no-properties 2))))
16156 ;; Only add true property name, not extension symbol.
16157 (add-to-list 'props
16158 (if (not (org-string-match-p "\\+\\'" p)) p
16159 (substring p 0 -1))))
16161 (outline-next-heading)))
16163 (goto-char (point-min))
16164 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16165 (let ((element (org-element-at-point)))
16166 (when (memq (org-element-type element) '(keyword node-property))
16167 (let ((value (org-element-property :value element))
16169 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16170 (setq start (match-end 0))
16171 (let ((p (org-match-string-no-properties 1 value)))
16172 (unless (member-ignore-case p org-special-properties)
16173 (add-to-list 'props p))))))))))
16174 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16176 (defun org-property-values (key)
16177 "List all non-nil values of property KEY in current buffer."
16178 (org-with-wide-buffer
16179 (goto-char (point-min))
16180 (let ((case-fold-search t)
16181 (re (org-re-property key))
16183 (while (re-search-forward re nil t)
16184 (add-to-list 'values (org-entry-get (point) key)))
16187 (defun org-insert-property-drawer ()
16188 "Insert a property drawer into the current entry."
16189 (org-with-wide-buffer
16190 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16191 (org-back-to-heading t)
16192 (org-with-limited-levels (org-back-to-heading t)))
16194 (when (org-looking-at-p org-planning-line-re) (forward-line))
16195 (unless (org-looking-at-p org-property-drawer-re)
16196 (let ((inhibit-read-only t))
16197 (unless (bolp) (insert "\n"))
16198 (let ((begin (point)))
16199 (insert ":PROPERTIES:\n:END:\n")
16200 (org-indent-region begin (point)))))))
16202 (defun org-insert-drawer (&optional arg drawer)
16203 "Insert a drawer at point.
16205 When optional argument ARG is non-nil, insert a property drawer.
16207 Optional argument DRAWER, when non-nil, is a string representing
16208 drawer's name. Otherwise, the user is prompted for a name.
16210 If a region is active, insert the drawer around that region
16213 Point is left between drawer's boundaries."
16215 (let* ((drawer (if arg "PROPERTIES"
16216 (or drawer (read-from-minibuffer "Drawer: ")))))
16218 ;; With C-u, fall back on `org-insert-property-drawer'
16219 (arg (org-insert-property-drawer))
16220 ;; Check validity of suggested drawer's name.
16221 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16222 (user-error "Invalid drawer name"))
16223 ;; With an active region, insert a drawer at point.
16224 ((not (org-region-active-p))
16226 (unless (bolp) (insert "\n"))
16227 (insert (format ":%s:\n\n:END:\n" drawer))
16228 (forward-line -2)))
16229 ;; Otherwise, insert the drawer at point
16231 (let ((rbeg (region-beginning))
16232 (rend (copy-marker (region-end))))
16236 (beginning-of-line)
16237 (when (save-excursion
16238 (re-search-forward org-outline-regexp-bol rend t))
16239 (user-error "Drawers cannot contain headlines"))
16240 ;; Position point at the beginning of the first
16241 ;; non-blank line in region. Insert drawer's opening
16242 ;; there, then indent it.
16243 (org-skip-whitespace)
16244 (beginning-of-line)
16245 (insert ":" drawer ":\n")
16247 (indent-for-tab-command)
16248 ;; Move point to the beginning of the first blank line
16249 ;; after the last non-blank line in region. Insert
16250 ;; drawer's closing, then indent it.
16252 (skip-chars-backward " \r\t\n")
16254 (deactivate-mark t)
16255 (indent-for-tab-command)
16256 (unless (eolp) (insert "\n")))
16257 ;; Clear marker, whatever the outcome of insertion is.
16258 (set-marker rend nil)))))))
16260 (defvar org-property-set-functions-alist nil
16261 "Property set function alist.
16262 Each entry should have the following format:
16264 (PROPERTY . READ-FUNCTION)
16266 The read function will be called with the same argument as
16267 `org-completing-read'.")
16269 (defun org-set-property-function (property)
16270 "Get the function that should be used to set PROPERTY.
16271 This is computed according to `org-property-set-functions-alist'."
16272 (or (cdr (assoc property org-property-set-functions-alist))
16273 'org-completing-read))
16275 (defun org-read-property-value (property)
16276 "Read PROPERTY value from user."
16277 (let* ((completion-ignore-case t)
16278 (allowed (org-property-get-allowed-values nil property 'table))
16279 (cur (org-entry-get nil property))
16280 (prompt (concat property " value"
16281 (if (and cur (string-match "\\S-" cur))
16282 (concat " [" cur "]") "") ": "))
16283 (set-function (org-set-property-function property))
16285 (funcall set-function prompt allowed nil
16286 (not (get-text-property 0 'org-unrestricted
16288 (let (org-completion-use-ido org-completion-use-iswitchb)
16289 (funcall set-function prompt
16290 (mapcar 'list (org-property-values property))
16291 nil nil "" nil cur)))))
16294 (defvar org-last-set-property nil)
16295 (defvar org-last-set-property-value nil)
16296 (defun org-read-property-name ()
16297 "Read a property name."
16298 (let ((completion-ignore-case t)
16299 (default-prop (or (and (org-at-property-p)
16300 (org-match-string-no-properties 2))
16301 org-last-set-property)))
16302 (org-completing-read
16304 (if default-prop (concat " [" default-prop "]") "")
16306 (mapcar #'list (org-buffer-property-keys nil t t))
16307 nil nil nil nil default-prop)))
16309 (defun org-set-property-and-value (use-last)
16310 "Allow to set [PROPERTY]: [value] direction from prompt.
16311 When use-default, don't even ask, just use the last
16312 \"[PROPERTY]: [value]\" string from the history."
16314 (let* ((completion-ignore-case t)
16315 (pv (or (and use-last org-last-set-property-value)
16316 (org-completing-read
16317 "Enter a \"[Property]: [value]\" pair: "
16318 nil nil nil nil nil
16319 org-last-set-property-value)))
16321 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16322 (setq prop (match-string 1 pv)
16323 val (match-string 2 pv))
16324 (org-set-property prop val))))
16326 (defun org-set-property (property value)
16327 "In the current entry, set PROPERTY to VALUE.
16328 When called interactively, this will prompt for a property name, offering
16329 completion on existing and default properties. And then it will prompt
16330 for a value, offering completion either on allowed values (via an inherited
16331 xxx_ALL property) or on existing values in other instances of this property
16332 in the current file."
16333 (interactive (list nil nil))
16334 (let* ((property (or property (org-read-property-name)))
16335 (value (or value (org-read-property-value property)))
16336 (fn (cdr (assoc property org-properties-postprocess-alist))))
16337 (setq org-last-set-property property)
16338 (setq org-last-set-property-value (concat property ": " value))
16339 ;; Possibly postprocess the inserted value:
16340 (when fn (setq value (funcall fn value)))
16341 (unless (equal (org-entry-get nil property) value)
16342 (org-entry-put nil property value))))
16344 (defun org-find-property (property &optional value)
16345 "Find first entry in buffer that sets PROPERTY.
16347 When optional argument VALUE is non-nil, only consider an entry
16348 if it contains PROPERTY set to this value. If PROPERTY should be
16349 explicitly set to nil, use string \"nil\" for VALUE.
16351 Return position where the entry begins, or nil if there is no
16352 such entry. If narrowing is in effect, only search the visible
16353 part of the buffer."
16355 (goto-char (point-min))
16356 (let ((case-fold-search t)
16357 (re (org-re-property property nil (not value) value)))
16359 (while (re-search-forward re nil t)
16360 (when (if value (org-at-property-p)
16361 (org-entry-get (point) property nil t))
16362 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16364 (defun org-delete-property (property)
16365 "In the current entry, delete PROPERTY."
16367 (let* ((completion-ignore-case t)
16368 (cat (org-entry-get (point) "CATEGORY"))
16369 (props0 (org-entry-properties nil 'standard))
16370 (props (if cat props0
16371 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16372 (prop (if (< 1 (length props))
16373 (org-icompleting-read "Property: " props nil t)
16377 (message "No property to delete in this entry")
16378 (org-entry-delete nil property)
16379 (message "Property \"%s\" deleted" property)))
16381 (defun org-delete-property-globally (property)
16382 "Remove PROPERTY globally, from all entries.
16383 This function ignores narrowing, if any."
16385 (let* ((completion-ignore-case t)
16386 (prop (org-icompleting-read
16387 "Globally remove property: "
16388 (mapcar #'list (org-buffer-property-keys)))))
16390 (org-with-wide-buffer
16391 (goto-char (point-min))
16393 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16394 (while (re-search-forward re nil t)
16395 (when (org-entry-delete (point) property) (incf count)))
16396 (message "Property \"%s\" removed from %d entries" property count))))
16398 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16400 (defun org-compute-property-at-point ()
16401 "Compute the property at point.
16402 This looks for an enclosing column format, extracts the operator and
16403 then applies it to the property in the column format's scope."
16405 (unless (org-at-property-p)
16406 (user-error "Not at a property"))
16407 (let ((prop (org-match-string-no-properties 2)))
16408 (org-columns-get-format-and-top-level)
16409 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16410 (user-error "No operator defined for property %s" prop))
16411 (org-columns-compute prop)))
16413 (defvar org-property-allowed-value-functions nil
16414 "Hook for functions supplying allowed values for a specific property.
16415 The functions must take a single argument, the name of the property, and
16416 return a flat list of allowed values. If \":ETC\" is one of
16417 the values, this means that these values are intended as defaults for
16418 completion, but that other values should be allowed too.
16419 The functions must return nil if they are not responsible for this
16422 (defun org-property-get-allowed-values (pom property &optional table)
16423 "Get allowed values for the property PROPERTY.
16424 When TABLE is non-nil, return an alist that can directly be used for
16428 ((equal property "TODO")
16429 (setq vals (org-with-point-at pom
16430 (append org-todo-keywords-1 '("")))))
16431 ((equal property "PRIORITY")
16432 (let ((n org-lowest-priority))
16433 (while (>= n org-highest-priority)
16434 (push (char-to-string n) vals)
16436 ((equal property "CATEGORY"))
16437 ((member property org-special-properties))
16438 ((setq vals (run-hook-with-args-until-success
16439 'org-property-allowed-value-functions property)))
16441 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16442 (when (and vals (string-match "\\S-" vals))
16443 (setq vals (car (read-from-string (concat "(" vals ")"))))
16444 (setq vals (mapcar (lambda (x)
16445 (cond ((stringp x) x)
16446 ((numberp x) (number-to-string x))
16447 ((symbolp x) (symbol-name x))
16450 (when (member ":ETC" vals)
16451 (setq vals (remove ":ETC" vals))
16452 (org-add-props (car vals) '(org-unrestricted t)))
16453 (if table (mapcar 'list vals) vals)))
16455 (defun org-property-previous-allowed-value (&optional previous)
16456 "Switch to the next allowed value for this property."
16458 (org-property-next-allowed-value t))
16460 (defun org-property-next-allowed-value (&optional previous)
16461 "Switch to the next allowed value for this property."
16463 (unless (org-at-property-p)
16464 (user-error "Not at a property"))
16465 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16466 (key (match-string 2))
16467 (value (match-string 3))
16468 (allowed (or (org-property-get-allowed-values (point) key)
16469 (and (member value '("[ ]" "[-]" "[X]"))
16471 (heading (save-match-data (nth 4 (org-heading-components))))
16474 (user-error "Allowed values for this property have not been defined"))
16475 (if previous (setq allowed (reverse allowed)))
16476 (if (member value allowed)
16477 (setq nval (car (cdr (member value allowed)))))
16478 (setq nval (or nval (car allowed)))
16479 (if (equal nval value)
16480 (user-error "Only one allowed value for this property"))
16481 (org-at-property-p)
16482 (replace-match (concat " :" key ": " nval) t t)
16484 (beginning-of-line 1)
16485 (skip-chars-forward " \t")
16486 (when (equal prop org-effort-property)
16487 (org-refresh-property
16488 '((effort . identity)
16489 (effort-minutes . org-duration-string-to-minutes))
16491 (when (string= org-clock-current-task heading)
16492 (setq org-clock-effort nval)
16493 (org-clock-update-mode-line)))
16494 (run-hook-with-args 'org-property-changed-functions key nval)))
16496 (defun org-find-olp (path &optional this-buffer)
16497 "Return a marker pointing to the entry at outline path OLP.
16498 If anything goes wrong, throw an error.
16499 You can wrap this call to catch the error like this:
16501 (condition-case msg
16502 (org-mobile-locate-entry (match-string 4))
16503 (error (nth 1 msg)))
16505 The return value will then be either a string with the error message,
16506 or a marker if everything is OK.
16508 If THIS-BUFFER is set, the outline path does not contain a file,
16510 (let* ((file (if this-buffer buffer-file-name (pop path)))
16511 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16515 limit re end found pos heading cnt flevel)
16516 (unless buffer (error "File not found :%s" file))
16517 (with-current-buffer buffer
16521 (setq limit (point-max))
16522 (goto-char (point-min))
16523 (while (setq heading (pop path))
16524 (setq re (format org-complex-heading-regexp-format
16525 (regexp-quote heading)))
16526 (setq cnt 0 pos (point))
16527 (while (re-search-forward re end t)
16528 (setq level (- (match-end 1) (match-beginning 1)))
16529 (if (and (>= level lmin) (<= level lmax))
16530 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16531 (when (= cnt 0) (error "Heading not found on level %d: %s"
16533 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16536 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16537 (setq end (save-excursion (org-end-of-subtree t t))))
16538 (when (org-at-heading-p)
16539 (point-marker)))))))
16541 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16542 "Find node HEADING in BUFFER.
16543 Return a marker to the heading if it was found, or nil if not.
16544 If POS-ONLY is set, return just the position instead of a marker.
16546 The heading text must match exact, but it may have a TODO keyword,
16547 a priority cookie and tags in the standard locations."
16548 (with-current-buffer (or buffer (current-buffer))
16552 (goto-char (point-min))
16553 (let (case-fold-search)
16554 (if (re-search-forward
16555 (format org-complex-heading-regexp-format
16556 (regexp-quote heading)) nil t)
16558 (match-beginning 0)
16559 (move-marker (make-marker) (match-beginning 0)))))))))
16561 (defun org-find-exact-heading-in-directory (heading &optional dir)
16562 "Find Org node headline HEADING in all .org files in directory DIR.
16563 When the target headline is found, return a marker to this location."
16564 (let ((files (directory-files (or dir default-directory)
16565 t "\\`[^.#].*\\.org\\'"))
16566 file visiting m buffer)
16568 (while (setq file (pop files))
16569 (message "trying %s" file)
16570 (setq visiting (org-find-base-buffer-visiting file))
16571 (setq buffer (or visiting (find-file-noselect file)))
16572 (setq m (org-find-exact-headline-in-buffer
16574 (when (and (not m) (not visiting)) (kill-buffer buffer))
16575 (and m (throw 'found m))))))
16577 (defun org-find-entry-with-id (ident)
16578 "Locate the entry that contains the ID property with exact value IDENT.
16579 IDENT can be a string, a symbol or a number, this function will search for
16580 the string representation of it.
16581 Return the position where this entry starts, or nil if there is no such entry."
16582 (interactive "sID: ")
16584 ((stringp ident) ident)
16585 ((symbolp ident) (symbol-name ident))
16586 ((numberp ident) (number-to-string ident))
16587 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16588 (org-with-wide-buffer (org-find-property "ID" id))))
16592 (defvar org-last-changed-timestamp nil)
16593 (defvar org-last-inserted-timestamp nil
16594 "The last time stamp inserted with `org-insert-time-stamp'.")
16595 (defvar org-ts-what) ; dynamically scoped parameter
16597 (defun org-time-stamp (arg &optional inactive)
16598 "Prompt for a date/time and insert a time stamp.
16600 If the user specifies a time like HH:MM or if this command is
16601 called with at least one prefix argument, the time stamp contains
16602 the date and the time. Otherwise, only the date is included.
16604 All parts of a date not specified by the user are filled in from
16605 the timestamp at point, if any, or the current date/time
16608 If there is already a timestamp at the cursor, it is replaced.
16610 With two universal prefix arguments, insert an active timestamp
16611 with the current time without prompting the user.
16613 When called from lisp, the timestamp is inactive if INACTIVE is
16617 (cond ((org-at-date-range-p t)
16619 (goto-char (match-beginning 0))
16620 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16622 ((org-at-timestamp-p t) (match-string 0))))
16623 ;; Default time is either the timestamp at point or today.
16624 ;; When entering a range, only the range start is considered.
16625 (default-time (if (not ts) (current-time)
16626 (apply #'encode-time (org-parse-time-string ts))))
16627 (default-input (and ts (org-get-compact-tod ts)))
16629 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16630 (match-string 0 ts)))
16632 org-end-time-was-given
16634 (and (if (equal arg '(16)) (current-time)
16635 ;; Preserve `this-command' and `last-command'.
16636 (let ((this-command this-command)
16637 (last-command last-command))
16639 arg 'totime nil nil default-time default-input
16643 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16644 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16646 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16648 ;; Make sure we're on a timestamp. When in the middle of a date
16649 ;; range, move arbitrarily to range end.
16650 (unless (org-at-timestamp-p t)
16651 (skip-chars-forward "-")
16652 (org-at-timestamp-p t))
16654 (setq org-last-changed-timestamp
16655 (org-insert-time-stamp
16656 time (or org-time-was-given arg)
16657 inactive nil nil (list org-end-time-was-given)))
16660 (insert " " repeater)
16661 (setq org-last-changed-timestamp
16662 (concat (substring org-last-inserted-timestamp 0 -1)
16663 " " repeater ">")))
16664 (message "Timestamp updated"))
16665 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16666 (t (org-insert-time-stamp
16667 time (or org-time-was-given arg) inactive nil nil
16668 (list org-end-time-was-given))))))
16670 ;; FIXME: can we use this for something else, like computing time differences?
16671 (defun org-get-compact-tod (s)
16672 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16673 (let* ((t1 (match-string 1 s))
16674 (h1 (string-to-number (match-string 2 s)))
16675 (m1 (string-to-number (match-string 3 s)))
16676 (t2 (and (match-end 4) (match-string 5 s)))
16677 (h2 (and t2 (string-to-number (match-string 6 s))))
16678 (m2 (and t2 (string-to-number (match-string 7 s))))
16682 (setq dh (- h2 h1) dm (- m2 m1))
16683 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16684 (concat t1 "+" (number-to-string dh)
16685 (and (/= 0 dm) (format ":%02d" dm)))))))
16687 (defun org-time-stamp-inactive (&optional arg)
16688 "Insert an inactive time stamp.
16689 An inactive time stamp is enclosed in square brackets instead of angle
16690 brackets. It is inactive in the sense that it does not trigger agenda entries,
16691 does not link to the calendar and cannot be changed with the S-cursor keys.
16692 So these are more for recording a certain time/date."
16694 (org-time-stamp arg 'inactive))
16696 (defvar org-date-ovl (make-overlay 1 1))
16697 (overlay-put org-date-ovl 'face 'org-date-selected)
16698 (org-detach-overlay org-date-ovl)
16700 (defvar org-ans1) ; dynamically scoped parameter
16701 (defvar org-ans2) ; dynamically scoped parameter
16703 (defvar org-plain-time-of-day-regexp) ; defined below
16705 (defvar org-overriding-default-time nil) ; dynamically scoped
16706 (defvar org-read-date-overlay nil)
16707 (defvar org-dcst nil) ; dynamically scoped
16708 (defvar org-read-date-history nil)
16709 (defvar org-read-date-final-answer nil)
16710 (defvar org-read-date-analyze-futurep nil)
16711 (defvar org-read-date-analyze-forced-year nil)
16712 (defvar org-read-date-inactive)
16714 (defvar org-read-date-minibuffer-local-map
16715 (let* ((map (make-sparse-keymap)))
16716 (set-keymap-parent map minibuffer-local-map)
16717 (org-defkey map (kbd ".")
16718 (lambda () (interactive)
16719 ;; Are we at the beginning of the prompt?
16720 (if (looking-back "^[^:]+: ")
16721 (org-eval-in-calendar '(calendar-goto-today))
16723 (org-defkey map (kbd "C-.")
16724 (lambda () (interactive)
16725 (org-eval-in-calendar '(calendar-goto-today))))
16726 (org-defkey map [(meta shift left)]
16727 (lambda () (interactive)
16728 (org-eval-in-calendar '(calendar-backward-month 1))))
16729 (org-defkey map [(meta shift right)]
16730 (lambda () (interactive)
16731 (org-eval-in-calendar '(calendar-forward-month 1))))
16732 (org-defkey map [(meta shift up)]
16733 (lambda () (interactive)
16734 (org-eval-in-calendar '(calendar-backward-year 1))))
16735 (org-defkey map [(meta shift down)]
16736 (lambda () (interactive)
16737 (org-eval-in-calendar '(calendar-forward-year 1))))
16738 (org-defkey map [?\e (shift left)]
16739 (lambda () (interactive)
16740 (org-eval-in-calendar '(calendar-backward-month 1))))
16741 (org-defkey map [?\e (shift right)]
16742 (lambda () (interactive)
16743 (org-eval-in-calendar '(calendar-forward-month 1))))
16744 (org-defkey map [?\e (shift up)]
16745 (lambda () (interactive)
16746 (org-eval-in-calendar '(calendar-backward-year 1))))
16747 (org-defkey map [?\e (shift down)]
16748 (lambda () (interactive)
16749 (org-eval-in-calendar '(calendar-forward-year 1))))
16750 (org-defkey map [(shift up)]
16751 (lambda () (interactive)
16752 (org-eval-in-calendar '(calendar-backward-week 1))))
16753 (org-defkey map [(shift down)]
16754 (lambda () (interactive)
16755 (org-eval-in-calendar '(calendar-forward-week 1))))
16756 (org-defkey map [(shift left)]
16757 (lambda () (interactive)
16758 (org-eval-in-calendar '(calendar-backward-day 1))))
16759 (org-defkey map [(shift right)]
16760 (lambda () (interactive)
16761 (org-eval-in-calendar '(calendar-forward-day 1))))
16762 (org-defkey map "!"
16763 (lambda () (interactive)
16764 (org-eval-in-calendar '(diary-view-entries))
16766 (org-defkey map ">"
16767 (lambda () (interactive)
16768 (org-eval-in-calendar '(calendar-scroll-left 1))))
16769 (org-defkey map "<"
16770 (lambda () (interactive)
16771 (org-eval-in-calendar '(calendar-scroll-right 1))))
16772 (org-defkey map "\C-v"
16773 (lambda () (interactive)
16774 (org-eval-in-calendar
16775 '(calendar-scroll-left-three-months 1))))
16776 (org-defkey map "\M-v"
16777 (lambda () (interactive)
16778 (org-eval-in-calendar
16779 '(calendar-scroll-right-three-months 1))))
16781 "Keymap for minibuffer commands when using `org-read-date'.")
16784 (defvar org-defdecode)
16785 (defvar org-with-time)
16787 (defun org-read-date (&optional org-with-time to-time from-string prompt
16788 default-time default-input inactive)
16789 "Read a date, possibly a time, and make things smooth for the user.
16790 The prompt will suggest to enter an ISO date, but you can also enter anything
16791 which will at least partially be understood by `parse-time-string'.
16792 Unrecognized parts of the date will default to the current day, month, year,
16793 hour and minute. If this command is called to replace a timestamp at point,
16794 or to enter the second timestamp of a range, the default time is taken
16795 from the existing stamp. Furthermore, the command prefers the future,
16796 so if you are giving a date where the year is not given, and the day-month
16797 combination is already past in the current year, it will assume you
16798 mean next year. For details, see the manual. A few examples:
16800 3-2-5 --> 2003-02-05
16801 feb 15 --> currentyear-02-15
16802 2/15 --> currentyear-02-15
16803 sep 12 9 --> 2009-09-12
16804 12:45 --> today 12:45
16805 22 sept 0:34 --> currentyear-09-22 0:34
16806 12 --> currentyear-currentmonth-12
16807 Fri --> nearest Friday after today
16808 -Tue --> last Tuesday
16811 Furthermore you can specify a relative date by giving, as the *first* thing
16812 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16813 change in days weeks, months, years.
16814 With a single plus or minus, the date is relative to today. With a double
16815 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16816 +4d --> four days from today
16817 +4 --> same as above
16818 +2w --> two weeks from today
16819 ++5 --> five days from default date
16821 The function understands only English month and weekday abbreviations.
16823 While prompting, a calendar is popped up - you can also select the
16824 date with the mouse (button 1). The calendar shows a period of three
16825 months. To scroll it to other months, use the keys `>' and `<'.
16826 If you don't like the calendar, turn it off with
16827 \(setq org-read-date-popup-calendar nil)
16829 With optional argument TO-TIME, the date will immediately be converted
16830 to an internal time.
16831 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16832 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16833 still enter a time, and this function will inform the calling routine
16834 about this change. The calling routine may then choose to change the
16835 format used to insert the time stamp into the buffer to include the time.
16836 With optional argument FROM-STRING, read from this string instead from
16837 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16838 the time/date that is used for everything that is not specified by the
16840 (require 'parse-time)
16841 (let* ((org-time-stamp-rounding-minutes
16842 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16843 (org-dcst org-display-custom-times)
16844 (ct (org-current-time))
16845 (org-def (or org-overriding-default-time default-time ct))
16846 (org-defdecode (decode-time org-def))
16848 (when (< (nth 2 org-defdecode) org-extend-today-until)
16849 (setcar (nthcdr 2 org-defdecode) -1)
16850 (setcar (nthcdr 1 org-defdecode) 59)
16851 (setq org-def (apply 'encode-time org-defdecode)
16852 org-defdecode (decode-time org-def)))))
16853 (cur-frame (selected-frame))
16854 (mouse-autoselect-window nil) ; Don't let the mouse jump
16855 (calendar-frame-setup nil)
16856 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16857 (calendar-move-hook nil)
16858 (calendar-view-diary-initially-flag nil)
16859 (calendar-view-holidays-initially-flag nil)
16860 (timestr (format-time-string
16861 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16862 (prompt (concat (if prompt (concat prompt " ") "")
16863 (format "Date+time [%s]: " timestr)))
16864 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16867 (from-string (setq ans from-string))
16868 (org-read-date-popup-calendar
16870 (save-window-excursion
16872 (when (eq calendar-setup 'calendar-only)
16874 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16875 (select-frame cal-frame))
16876 (org-eval-in-calendar '(setq cursor-type nil) t)
16879 (calendar-forward-day (- (time-to-days org-def)
16880 (calendar-absolute-from-gregorian
16881 (calendar-current-date))))
16882 (org-eval-in-calendar nil t)
16883 (let* ((old-map (current-local-map))
16884 (map (copy-keymap calendar-mode-map))
16885 (minibuffer-local-map
16886 (copy-keymap org-read-date-minibuffer-local-map)))
16887 (org-defkey map (kbd "RET") 'org-calendar-select)
16888 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16889 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16892 (use-local-map map)
16893 (setq org-read-date-inactive inactive)
16894 (add-hook 'post-command-hook 'org-read-date-display)
16895 (setq org-ans0 (read-string prompt default-input
16896 'org-read-date-history nil))
16897 ;; org-ans0: from prompt
16898 ;; org-ans1: from mouse click
16899 ;; org-ans2: from calendar motion
16900 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16901 (remove-hook 'post-command-hook 'org-read-date-display)
16902 (use-local-map old-map)
16903 (when org-read-date-overlay
16904 (delete-overlay org-read-date-overlay)
16905 (setq org-read-date-overlay nil)))))
16906 (bury-buffer "*Calendar*")
16908 (delete-frame cal-frame)
16909 (select-frame-set-input-focus cur-frame))))))
16911 (t ; Naked prompt only
16913 (setq ans (read-string prompt default-input
16914 'org-read-date-history timestr))
16915 (when org-read-date-overlay
16916 (delete-overlay org-read-date-overlay)
16917 (setq org-read-date-overlay nil)))))
16919 (setq final (org-read-date-analyze ans org-def org-defdecode))
16921 (when org-read-date-analyze-forced-year
16922 (message "Year was forced into %s"
16923 (if org-read-date-force-compatible-dates
16924 "compatible range (1970-2037)"
16925 "range representable on this machine"))
16928 ;; One round trip to get rid of 34th of August and stuff like that....
16929 (setq final (decode-time (apply 'encode-time final)))
16931 (setq org-read-date-final-answer ans)
16934 (apply 'encode-time final)
16935 (if (and (boundp 'org-time-was-given) org-time-was-given)
16936 (format "%04d-%02d-%02d %02d:%02d"
16937 (nth 5 final) (nth 4 final) (nth 3 final)
16938 (nth 2 final) (nth 1 final))
16939 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16941 (defun org-read-date-display ()
16942 "Display the current date prompt interpretation in the minibuffer."
16943 (when org-read-date-display-live
16944 (when org-read-date-overlay
16945 (delete-overlay org-read-date-overlay))
16946 (when (minibufferp (current-buffer))
16949 (while (not (equal (buffer-substring
16950 (max (point-min) (- (point) 4)) (point))
16953 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16954 " " (or org-ans1 org-ans2)))
16955 (org-end-time-was-given nil)
16956 (f (org-read-date-analyze ans org-def org-defdecode))
16958 org-time-stamp-custom-formats
16959 org-time-stamp-formats))
16960 (fmt (if (or org-with-time
16961 (and (boundp 'org-time-was-given) org-time-was-given))
16964 (txt (format-time-string fmt (apply 'encode-time f)))
16965 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16966 (txt (concat "=> " txt)))
16967 (when (and org-end-time-was-given
16968 (string-match org-plain-time-of-day-regexp txt))
16969 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16970 org-end-time-was-given
16971 (substring txt (match-end 0)))))
16972 (when org-read-date-analyze-futurep
16973 (setq txt (concat txt " (=>F)")))
16974 (setq org-read-date-overlay
16975 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16976 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16978 (defun org-read-date-analyze (ans org-def org-defdecode)
16979 "Analyze the combined answer of the date prompt."
16980 ;; FIXME: cleanup and comment
16981 (let ((nowdecode (decode-time (current-time)))
16982 delta deltan deltaw deltadef year month day
16983 hour minute second wday pm h2 m2 tl wday1
16984 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16985 (setq org-read-date-analyze-futurep nil
16986 org-read-date-analyze-forced-year nil)
16987 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16990 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16991 (setq ans (replace-match "" t t ans)
16993 deltaw (nth 1 delta)
16994 deltadef (nth 2 delta)))
16996 ;; Check if there is an iso week date in there. If yes, store the
16997 ;; info and postpone interpreting it until the rest of the parsing
16999 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
17000 (setq iso-year (if (match-end 1)
17001 (org-small-year-to-year
17002 (string-to-number (match-string 1 ans))))
17003 iso-weekday (if (match-end 3)
17004 (string-to-number (match-string 3 ans)))
17005 iso-week (string-to-number (match-string 2 ans)))
17006 (setq ans (replace-match "" t t ans)))
17008 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
17009 (when (string-match
17010 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
17011 (setq year (if (match-end 2)
17012 (string-to-number (match-string 2 ans))
17013 (progn (setq kill-year t)
17014 (string-to-number (format-time-string "%Y"))))
17015 month (string-to-number (match-string 3 ans))
17016 day (string-to-number (match-string 4 ans)))
17017 (if (< year 100) (setq year (+ 2000 year)))
17018 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17021 ;; Help matching dotted european dates
17022 (when (string-match
17023 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
17024 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
17026 (string-to-number (format-time-string "%Y")))
17027 day (string-to-number (match-string 1 ans))
17028 month (string-to-number (match-string 2 ans))
17029 ans (replace-match (format "%04d-%02d-%02d" year month day)
17032 ;; Help matching american dates, like 5/30 or 5/30/7
17033 (when (string-match
17034 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17035 (setq year (if (match-end 4)
17036 (string-to-number (match-string 4 ans))
17037 (progn (setq kill-year t)
17038 (string-to-number (format-time-string "%Y"))))
17039 month (string-to-number (match-string 1 ans))
17040 day (string-to-number (match-string 2 ans)))
17041 (if (< year 100) (setq year (+ 2000 year)))
17042 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17044 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17045 ;; If there is a time with am/pm, and *no* time without it, we convert
17046 ;; so that matching will be successful.
17047 (loop for i from 1 to 2 do ; twice, for end time as well
17048 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17049 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17050 (setq hour (string-to-number (match-string 1 ans))
17051 minute (if (match-end 3)
17052 (string-to-number (match-string 3 ans))
17055 (string-to-char (downcase (match-string 4 ans)))))
17056 (if (and (= hour 12) (not pm))
17058 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17059 (setq ans (replace-match (format "%02d:%02d" hour minute)
17062 ;; Check if a time range is given as a duration
17063 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17064 (setq hour (string-to-number (match-string 1 ans))
17065 h2 (+ hour (string-to-number (match-string 3 ans)))
17066 minute (string-to-number (match-string 2 ans))
17067 m2 (+ minute (if (match-end 5) (string-to-number
17068 (match-string 5 ans))0)))
17069 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17070 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17073 ;; Check if there is a time range
17074 (when (boundp 'org-end-time-was-given)
17075 (setq org-time-was-given nil)
17076 (when (and (string-match org-plain-time-of-day-regexp ans)
17078 (setq org-end-time-was-given (match-string 8 ans))
17079 (setq ans (concat (substring ans 0 (match-beginning 7))
17080 (substring ans (match-end 7))))))
17082 (setq tl (parse-time-string ans)
17083 day (or (nth 3 tl) (nth 3 org-defdecode))
17086 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17087 ;; Day was specified. Make sure DAY+MONTH
17088 ;; combination happens in the future.
17091 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17092 (nth 4 nowdecode)))
17093 (t (nth 4 org-defdecode)))
17095 (cond ((and (not kill-year) (nth 5 tl)))
17096 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17097 ;; Month was guessed in the future and is at least
17098 ;; equal to NOWDECODE's. Fix year accordingly.
17100 (if (or (> month (nth 4 nowdecode))
17101 (>= day (nth 3 nowdecode)))
17103 (1+ (nth 5 nowdecode))))
17104 ;; Month was specified. Make sure MONTH+YEAR
17105 ;; combination happens in the future.
17108 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17109 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17110 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17111 (t (nth 5 nowdecode))))
17112 (t (nth 5 org-defdecode)))
17113 hour (or (nth 2 tl) (nth 2 org-defdecode))
17114 minute (or (nth 1 tl) (nth 1 org-defdecode))
17115 second (or (nth 0 tl) 0)
17118 (when (and (eq org-read-date-prefer-future 'time)
17119 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17120 (equal day (nth 3 nowdecode))
17121 (equal month (nth 4 nowdecode))
17122 (equal year (nth 5 nowdecode))
17124 (or (< (nth 2 tl) (nth 2 nowdecode))
17125 (and (= (nth 2 tl) (nth 2 nowdecode))
17127 (< (nth 1 tl) (nth 1 nowdecode)))))
17131 ;; Special date definitions below
17134 ;; There was an iso week
17137 (setq year (or iso-year year)
17138 day (or iso-weekday wday 1)
17139 wday nil ; to make sure that the trigger below does not match
17140 iso-date (calendar-gregorian-from-absolute
17141 (calendar-iso-to-absolute
17142 (list iso-week day year))))
17143 ; FIXME: Should we also push ISO weeks into the future?
17144 ; (when (and org-read-date-prefer-future
17146 ; (< (calendar-absolute-from-gregorian iso-date)
17147 ; (time-to-days (current-time))))
17148 ; (setq year (1+ year)
17149 ; iso-date (calendar-gregorian-from-absolute
17150 ; (calendar-iso-to-absolute
17151 ; (list iso-week day year)))))
17152 (setq month (car iso-date)
17153 year (nth 2 iso-date)
17154 day (nth 1 iso-date)))
17158 (let ((now (decode-time (current-time))))
17159 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17160 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17161 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17162 ((equal deltaw "m") (setq month (+ month deltan)))
17163 ((equal deltaw "y") (setq year (+ year deltan)))))
17164 ((and wday (not (nth 3 tl)))
17165 ;; Weekday was given, but no day, so pick that day in the week
17166 ;; on or after the derived date.
17167 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17168 (unless (equal wday wday1)
17169 (setq day (+ day (% (- wday wday1 -7) 7))))))
17170 (if (and (boundp 'org-time-was-given)
17172 (setq org-time-was-given t))
17173 (if (< year 100) (setq year (+ 2000 year)))
17174 ;; Check of the date is representable
17175 (if org-read-date-force-compatible-dates
17178 (setq year 1970 org-read-date-analyze-forced-year t))
17180 (setq year 2037 org-read-date-analyze-forced-year t)))
17181 (condition-case nil
17182 (ignore (encode-time second minute hour day month year))
17184 (setq year (nth 5 org-defdecode))
17185 (setq org-read-date-analyze-forced-year t))))
17186 (setq org-read-date-analyze-futurep futurep)
17187 (list second minute hour day month year)))
17189 (defvar parse-time-weekdays)
17190 (defun org-read-date-get-relative (s today default)
17191 "Check string S for special relative date string.
17192 TODAY and DEFAULT are internal times, for today and for a default.
17193 Return shift list (N what def-flag)
17194 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17195 N is the number of WHATs to shift.
17196 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17197 the DEFAULT date rather than TODAY."
17198 (require 'parse-time)
17202 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17204 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17205 "\\([ \t]\\|$\\)") s)
17206 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17207 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17208 (string-to-char (substring (match-string 1 s) -1))
17210 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17211 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17212 (what (if (match-end 3) (match-string 3 s) "d"))
17213 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17214 (date (if rel default today))
17215 (wday (nth 6 (decode-time date)))
17219 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17220 (if (= delta 0) (setq delta 7))
17223 (setq delta (- delta 7))
17224 (if (= delta 0) (setq delta -7))))
17225 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17226 (list delta "d" rel))
17227 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17229 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17230 "Turn a user-specified date into the internal representation.
17231 The internal representation needed by the calendar is (month day year).
17232 This is a wrapper to handle the brain-dead convention in calendar that
17233 user function argument order change dependent on argument order."
17234 (if (boundp 'calendar-date-style)
17236 ((eq calendar-date-style 'american)
17237 (list arg1 arg2 arg3))
17238 ((eq calendar-date-style 'european)
17239 (list arg2 arg1 arg3))
17240 ((eq calendar-date-style 'iso)
17241 (list arg2 arg3 arg1)))
17242 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17243 (if (org-bound-and-true-p european-calendar-style)
17244 (list arg2 arg1 arg3)
17245 (list arg1 arg2 arg3)))))
17247 (defun org-eval-in-calendar (form &optional keepdate)
17248 "Eval FORM in the calendar window and return to current window.
17249 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17250 otherwise stick to the current value of `org-ans2'."
17251 (let ((sf (selected-frame))
17252 (sw (selected-window)))
17253 (select-window (get-buffer-window "*Calendar*" t))
17255 (when (and (not keepdate) (calendar-cursor-to-date))
17256 (let* ((date (calendar-cursor-to-date))
17257 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17258 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17259 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17261 (org-select-frame-set-input-focus sf)))
17263 (defun org-calendar-select ()
17264 "Return to `org-read-date' with the date currently selected.
17265 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17267 (when (calendar-cursor-to-date)
17268 (let* ((date (calendar-cursor-to-date))
17269 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17270 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17271 (if (active-minibuffer-window) (exit-minibuffer))))
17273 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17274 "Insert a date stamp for the date given by the internal TIME.
17275 See `format-time-string' for the format of TIME.
17276 WITH-HM means use the stamp format that includes the time of the day.
17277 INACTIVE means use square brackets instead of angular ones, so that the
17278 stamp will not contribute to the agenda.
17279 PRE and POST are optional strings to be inserted before and after the
17281 The command returns the inserted time stamp."
17282 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17284 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17285 (insert-before-markers (or pre ""))
17286 (when (listp extra)
17287 (setq extra (car extra))
17288 (if (and (stringp extra)
17289 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17290 (setq extra (format "-%02d:%02d"
17291 (string-to-number (match-string 1 extra))
17292 (string-to-number (match-string 2 extra))))
17295 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17296 (insert-before-markers (setq stamp (format-time-string fmt time)))
17297 (insert-before-markers (or post ""))
17298 (setq org-last-inserted-timestamp stamp)))
17300 (defun org-toggle-time-stamp-overlays ()
17301 "Toggle the use of custom time stamp formats."
17303 (setq org-display-custom-times (not org-display-custom-times))
17304 (unless org-display-custom-times
17305 (let ((p (point-min)) (bmp (buffer-modified-p)))
17306 (while (setq p (next-single-property-change p 'display))
17307 (if (and (get-text-property p 'display)
17308 (eq (get-text-property p 'face) 'org-date))
17309 (remove-text-properties
17310 p (setq p (next-single-property-change p 'display))
17312 (set-buffer-modified-p bmp)))
17313 (if (featurep 'xemacs)
17314 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17315 (org-restart-font-lock)
17316 (setq org-table-may-need-update t)
17317 (if org-display-custom-times
17318 (message "Time stamps are overlaid with custom format")
17319 (message "Time stamp overlays removed")))
17321 (defun org-display-custom-time (beg end)
17322 "Overlay modified time stamp format over timestamp between BEG and END."
17323 (let* ((ts (buffer-substring beg end))
17324 t1 w1 with-hm tf time str w2 (off 0))
17326 (setq t1 (org-parse-time-string ts t))
17327 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17328 (setq off (- (match-end 0) (match-beginning 0)))))
17329 (setq end (- end off))
17330 (setq w1 (- end beg)
17331 with-hm (and (nth 1 t1) (nth 2 t1))
17332 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17333 time (org-fix-decoded-time t1)
17335 (format-time-string
17336 (substring tf 1 -1) (apply 'encode-time time))
17337 nil 'mouse-face 'highlight)
17339 (if (not (= w2 w1))
17340 (add-text-properties (1+ beg) (+ 2 beg)
17341 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17342 (if (featurep 'xemacs)
17344 (put-text-property beg end 'invisible t)
17345 (put-text-property beg end 'end-glyph (make-glyph str)))
17346 (put-text-property beg end 'display str))))
17348 (defun org-fix-decoded-time (time)
17349 "Set 0 instead of nil for the first 6 elements of time.
17350 Don't touch the rest."
17352 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17354 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17356 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17357 "Difference between TIMESTAMP-STRING and now in days.
17358 If SECONDS is non-nil, return the difference in seconds."
17359 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17360 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17361 (funcall fdiff (current-time)))))
17363 (defun org-deadline-close (timestamp-string &optional ndays)
17364 "Is the time in TIMESTAMP-STRING close to the current date?"
17365 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17366 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17367 (not (org-entry-is-done-p))))
17369 (defun org-get-wdays (ts &optional delay zero-delay)
17370 "Get the deadline lead time appropriate for timestring TS.
17371 When DELAY is non-nil, get the delay time for scheduled items
17372 instead of the deadline lead time. When ZERO-DELAY is non-nil
17373 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17374 don't try to find the delay cookie in the scheduled timestamp."
17375 (let ((tv (if delay org-scheduled-delay-days
17376 org-deadline-warning-days)))
17378 ((or (and delay (< tv 0))
17379 (and delay zero-delay (<= tv 0))
17380 (and (not delay) (<= tv 0)))
17381 ;; Enforce this value no matter what
17383 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17384 ;; lead time is specified.
17385 (floor (* (string-to-number (match-string 1 ts))
17386 (cdr (assoc (match-string 2 ts)
17387 '(("d" . 1) ("w" . 7)
17388 ("m" . 30.4) ("y" . 365.25)
17389 ("h" . 0.041667)))))))
17390 ;; go for the default.
17393 (defun org-calendar-select-mouse (ev)
17394 "Return to `org-read-date' with the date currently selected.
17395 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17397 (mouse-set-point ev)
17398 (when (calendar-cursor-to-date)
17399 (let* ((date (calendar-cursor-to-date))
17400 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17401 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17402 (if (active-minibuffer-window) (exit-minibuffer))))
17404 (defun org-check-deadlines (ndays)
17405 "Check if there are any deadlines due or past due.
17406 A deadline is considered due if it happens within `org-deadline-warning-days'
17407 days from today's date. If the deadline appears in an entry marked DONE,
17408 it is not shown. The prefix arg NDAYS can be used to test that many
17409 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17411 (let* ((org-warn-days
17413 ((equal ndays '(4)) 100000)
17414 (ndays (prefix-numeric-value ndays))
17415 (t (abs org-deadline-warning-days))))
17416 (case-fold-search nil)
17417 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17419 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17421 (message "%d deadlines past-due or due within %d days"
17422 (org-occur regexp nil callback)
17425 (defsubst org-re-timestamp (type)
17426 "Return a regexp for timestamp TYPE.
17427 Allowed values for TYPE are:
17429 all: all timestamps
17430 active: only active timestamps (<...>)
17431 inactive: only inactive timestamps ([...])
17432 scheduled: only scheduled timestamps
17433 deadline: only deadline timestamps
17434 closed: only closed time-stamps
17436 When TYPE is nil, fall back on returning a regexp that matches
17437 both scheduled and deadline timestamps."
17439 (all org-ts-regexp-both)
17440 (active org-ts-regexp)
17441 (inactive org-ts-regexp-inactive)
17442 (scheduled org-scheduled-time-regexp)
17443 (deadline org-deadline-time-regexp)
17444 (closed org-closed-time-regexp)
17447 (regexp-opt (list org-deadline-string org-scheduled-string))
17448 " *<\\([^>]+\\)>"))))
17450 (defun org-check-before-date (date)
17451 "Check if there are deadlines or scheduled entries before DATE."
17452 (interactive (list (org-read-date)))
17453 (let ((case-fold-search nil)
17454 (regexp (org-re-timestamp org-ts-type))
17457 (and ,(if (memq org-ts-type '(active inactive all))
17458 '(eq (org-element-type (org-element-context)) 'timestamp)
17459 '(org-at-planning-p))
17461 (org-time-string-to-time (match-string 1))
17462 (org-time-string-to-time date))))))
17463 (message "%d entries before %s"
17464 (org-occur regexp nil callback) date)))
17466 (defun org-check-after-date (date)
17467 "Check if there are deadlines or scheduled entries after DATE."
17468 (interactive (list (org-read-date)))
17469 (let ((case-fold-search nil)
17470 (regexp (org-re-timestamp org-ts-type))
17473 (and ,(if (memq org-ts-type '(active inactive all))
17474 '(eq (org-element-type (org-element-context)) 'timestamp)
17475 '(org-at-planning-p))
17477 (org-time-string-to-time (match-string 1))
17478 (org-time-string-to-time date)))))))
17479 (message "%d entries after %s"
17480 (org-occur regexp nil callback) date)))
17482 (defun org-check-dates-range (start-date end-date)
17483 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17484 (interactive (list (org-read-date nil nil nil "Range starts")
17485 (org-read-date nil nil nil "Range end")))
17486 (let ((case-fold-search nil)
17487 (regexp (org-re-timestamp org-ts-type))
17490 (let ((match (match-string 1)))
17492 ,(if (memq org-ts-type '(active inactive all))
17493 '(eq (org-element-type (org-element-context)) 'timestamp)
17494 '(org-at-planning-p))
17496 (org-time-string-to-time match)
17497 (org-time-string-to-time start-date)))
17499 (org-time-string-to-time match)
17500 (org-time-string-to-time end-date)))))))
17501 (message "%d entries between %s and %s"
17502 (org-occur regexp nil callback) start-date end-date)))
17504 (defun org-evaluate-time-range (&optional to-buffer)
17505 "Evaluate a time range by computing the difference between start and end.
17506 Normally the result is just printed in the echo area, but with prefix arg
17507 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17508 If the time range is actually in a table, the result is inserted into the
17510 For time difference computation, a year is assumed to be exactly 365
17511 days in order to avoid rounding problems."
17514 (org-clock-update-time-maybe)
17516 (unless (org-at-date-range-p t)
17517 (goto-char (point-at-bol))
17518 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17519 (if (not (org-at-date-range-p t))
17520 (user-error "Not at a time-stamp range, and none found in current line")))
17521 (let* ((ts1 (match-string 1))
17522 (ts2 (match-string 2))
17523 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17524 (match-end (match-end 0))
17525 (time1 (org-time-string-to-time ts1))
17526 (time2 (org-time-string-to-time ts2))
17527 (t1 (org-float-time time1))
17528 (t2 (org-float-time time2))
17529 (diff (abs (- t2 t1)))
17530 (negative (< (- t2 t1) 0))
17531 ;; (ys (floor (* 365 24 60 60)))
17534 (fy "%dy %dd %02d:%02d")
17536 (fd "%dd %02d:%02d")
17541 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17543 d (floor (/ diff ds)) diff (mod diff ds)
17544 h (floor (/ diff hs)) diff (mod diff hs)
17545 m (floor (/ diff 60)))
17546 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17548 d (floor (+ (/ diff ds) 0.5))
17550 (if (not to-buffer)
17551 (message "%s" (org-make-tdiff-string y d h m))
17552 (if (org-at-table-p)
17554 (goto-char match-end)
17556 (and (looking-at " *|") (goto-char (match-end 0))))
17557 (goto-char match-end))
17559 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17560 (replace-match ""))
17561 (if negative (insert " -"))
17562 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17563 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17564 (insert " " (format fh h m))))
17565 (if align (org-table-align))
17566 (message "Time difference inserted")))))
17568 (defun org-make-tdiff-string (y d h m)
17571 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17573 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17575 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17577 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17579 (apply 'format fmt (nreverse l))))
17581 (defun org-time-string-to-time (s &optional buffer pos)
17582 "Convert a timestamp string into internal time."
17583 (condition-case errdata
17584 (apply 'encode-time (org-parse-time-string s))
17585 (error (error "Bad timestamp `%s'%s\nError was: %s"
17586 s (if (not (and buffer pos))
17588 (format " at %d in buffer `%s'" pos buffer))
17591 (defun org-time-string-to-seconds (s)
17592 "Convert a timestamp string to a number of seconds."
17593 (org-float-time (org-time-string-to-time s)))
17595 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17596 "Convert a time stamp to an absolute day number.
17597 If there is a specifier for a cyclic time stamp, get the closest
17599 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17600 The variable `date' is bound by the calendar when this is called."
17602 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17603 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17606 ((and daynr (string-match "\\+\\([0-9]+\\)[hdwmy]" s)
17607 (> (string-to-number (match-string 1 s)) 0))
17608 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17609 (time-to-days (current-time))) (match-string 0 s)
17612 (condition-case errdata
17613 (apply 'encode-time (org-parse-time-string s))
17614 (error (error "Bad timestamp `%s'%s\nError was: %s"
17615 s (if (not (and buffer pos))
17617 (format " at %d in buffer `%s'" pos buffer))
17618 (cdr errdata))))))))
17620 (defun org-days-to-iso-week (days)
17621 "Return the iso week number."
17623 (car (calendar-iso-from-absolute days)))
17625 (defun org-small-year-to-year (year)
17626 "Convert 2-digit years into 4-digit years.
17627 YEAR is expanded into one of the 30 next years, if possible, or
17628 into a past one. Any year larger than 99 is returned unchanged."
17629 (if (>= year 100) year
17630 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17631 (century (/ current 100))
17632 (offset (- year (% current 100))))
17633 (cond ((> offset 30) (+ (* (1- century) 100) year))
17634 ((> offset -70) (+ (* century 100) year))
17635 (t (+ (* (1+ century) 100) year))))))
17637 (defun org-time-from-absolute (d)
17638 "Return the time corresponding to date D.
17639 D may be an absolute day number, or a calendar-type list (month day year)."
17640 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17641 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17643 (defun org-calendar-holiday ()
17644 "List of holidays, for Diary display in Org-mode."
17645 (require 'holidays)
17647 (if (fboundp 'calendar-check-holidays)
17648 'calendar-check-holidays 'check-calendar-holidays) date)))
17649 (if hl (mapconcat 'identity hl "; "))))
17651 (defun org-diary-sexp-entry (sexp entry date)
17652 "Process a SEXP diary ENTRY for DATE."
17653 (require 'diary-lib)
17654 (let ((result (if calendar-debug-sexp
17655 (let ((stack-trace-on-error t))
17656 (eval (car (read-from-string sexp))))
17657 (condition-case nil
17658 (eval (car (read-from-string sexp)))
17661 (message "Bad sexp at line %d in %s: %s"
17663 (buffer-file-name) sexp)
17665 (cond ((stringp result) (split-string result "; "))
17666 ((and (consp result)
17667 (not (consp (cdr result)))
17668 (stringp (cdr result))) (cdr result))
17669 ((and (consp result)
17670 (stringp (car result))) result)
17673 (defun org-diary-to-ical-string (frombuf)
17674 "Get iCalendar entries from diary entries in buffer FROMBUF.
17675 This uses the icalendar.el library."
17676 (let* ((tmpdir (if (featurep 'xemacs)
17678 temporary-file-directory))
17679 (tmpfile (make-temp-name
17680 (expand-file-name "orgics" tmpdir)))
17682 (with-current-buffer frombuf
17683 (icalendar-export-region (point-min) (point-max) tmpfile)
17684 (setq buf (find-buffer-visiting tmpfile))
17686 (goto-char (point-min))
17687 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17688 (setq b (match-beginning 0)))
17689 (goto-char (point-max))
17690 (if (re-search-backward "^END:VEVENT" nil t)
17691 (setq e (match-end 0)))
17692 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17694 (delete-file tmpfile)
17697 (defun org-closest-date (start current change prefer show-all)
17698 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17699 When PREFER is `past', return a date that is either CURRENT or past.
17700 When PREFER is `future', return a date that is either CURRENT or future.
17701 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17702 ;; Make the proper lists from the dates
17704 (let ((a1 '(("h" . hour)
17709 (shour (nth 2 (org-parse-time-string start)))
17710 dn dw sday cday n1 n2 n0
17711 d m y y1 y2 date1 date2 nmonths nm ny m2)
17713 (setq start (org-date-to-gregorian start)
17714 current (org-date-to-gregorian
17717 (time-to-days (current-time))))
17718 sday (calendar-absolute-from-gregorian start)
17719 cday (calendar-absolute-from-gregorian current))
17721 (if (<= cday sday) (throw 'exit sday))
17723 (when (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17724 (setq dn (string-to-number (match-string 1 change))
17725 dw (cdr (assoc (match-string 2 change) a1))))
17726 (unless (and dn (> dn 0))
17727 (user-error "Invalid change specifier: %s" change))
17728 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17731 (let ((missing-hours
17732 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17734 (setq n1 (if (zerop missing-hours) cday
17735 (- cday (1+ (floor (/ missing-hours 24)))))
17736 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17738 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17741 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17742 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17743 (setq date1 (list m d y1)
17744 n1 (calendar-absolute-from-gregorian date1)
17745 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17746 n2 (calendar-absolute-from-gregorian date2)))
17748 ;; approx number of month between the two dates
17749 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17750 ;; How often does dn fit in there?
17751 (setq d (nth 1 start) m (car start) y (nth 2 start)
17752 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17754 ny (floor (/ m 12))
17757 (while (> m 12) (setq m (- m 12) y (1+ y)))
17758 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17759 (setq m2 (+ m dn) y2 y)
17760 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17761 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17762 (while (<= n2 cday)
17763 (setq n1 n2 m m2 y y2)
17764 (setq m2 (+ m dn) y2 y)
17765 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17766 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17767 ;; Make sure n1 is the earlier date
17768 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17771 ((eq prefer 'past) (if (= cday n2) n2 n1))
17772 ((eq prefer 'future) (if (= cday n1) n1 n2))
17773 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17775 ((eq prefer 'past) (if (= cday n2) n2 n1))
17776 ((eq prefer 'future) (if (= cday n1) n1 n2))
17777 (t (if (= cday n1) n1 n2)))))))
17779 (defun org-date-to-gregorian (date)
17780 "Turn any specification of DATE into a Gregorian date for the calendar."
17781 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17782 ((and (listp date) (= (length date) 3)) date)
17784 (setq date (org-parse-time-string date))
17785 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17787 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17789 (defun org-parse-time-string (s &optional nodefault)
17790 "Parse the standard Org-mode time string.
17791 This should be a lot faster than the normal `parse-time-string'.
17792 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17793 hour and minute fields will be nil if not given."
17794 (cond ((string-match org-ts-regexp0 s)
17796 (if (or (match-beginning 8) (not nodefault))
17797 (string-to-number (or (match-string 8 s) "0")))
17798 (if (or (match-beginning 7) (not nodefault))
17799 (string-to-number (or (match-string 7 s) "0")))
17800 (string-to-number (match-string 4 s))
17801 (string-to-number (match-string 3 s))
17802 (string-to-number (match-string 2 s))
17804 ((string-match "^<[^>]+>$" s)
17805 (decode-time (seconds-to-time (org-matcher-time s))))
17806 (t (error "Not a standard Org-mode time string: %s" s))))
17808 (defun org-timestamp-up (&optional arg)
17809 "Increase the date item at the cursor by one.
17810 If the cursor is on the year, change the year. If it is on the month,
17811 the day or the time, change that.
17812 With prefix ARG, change by that many units."
17814 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17816 (defun org-timestamp-down (&optional arg)
17817 "Decrease the date item at the cursor by one.
17818 If the cursor is on the year, change the year. If it is on the month,
17819 the day or the time, change that.
17820 With prefix ARG, change by that many units."
17822 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17824 (defun org-timestamp-up-day (&optional arg)
17825 "Increase the date in the time stamp by one day.
17826 With prefix ARG, change that many days."
17828 (if (and (not (org-at-timestamp-p t))
17829 (org-at-heading-p))
17831 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17833 (defun org-timestamp-down-day (&optional arg)
17834 "Decrease the date in the time stamp by one day.
17835 With prefix ARG, change that many days."
17837 (if (and (not (org-at-timestamp-p t))
17838 (org-at-heading-p))
17840 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17842 (defun org-at-timestamp-p (&optional inactive-ok)
17843 "Determine if the cursor is in or at a timestamp."
17845 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17847 (ans (or (looking-at tsr)
17849 (skip-chars-backward "^[<\n\r\t")
17850 (if (> (point) (point-min)) (backward-char 1))
17851 (and (looking-at tsr)
17852 (> (- (match-end 0) pos) -1))))))
17854 (boundp 'org-ts-what)
17857 ((= pos (match-beginning 0)) 'bracket)
17858 ;; Point is considered to be "on the bracket" whether
17859 ;; it's really on it or right after it.
17860 ((= pos (1- (match-end 0))) 'bracket)
17861 ((= pos (match-end 0)) 'after)
17862 ((org-pos-in-match-range pos 2) 'year)
17863 ((org-pos-in-match-range pos 3) 'month)
17864 ((org-pos-in-match-range pos 7) 'hour)
17865 ((org-pos-in-match-range pos 8) 'minute)
17866 ((or (org-pos-in-match-range pos 4)
17867 (org-pos-in-match-range pos 5)) 'day)
17868 ((and (> pos (or (match-end 8) (match-end 5)))
17869 (< pos (match-end 0)))
17870 (- pos (or (match-end 8) (match-end 5))))
17874 (defun org-toggle-timestamp-type ()
17875 "Toggle the type (<active> or [inactive]) of a time stamp."
17877 (when (org-at-timestamp-p t)
17878 (let ((beg (match-beginning 0)) (end (match-end 0))
17879 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17882 (while (re-search-forward "[][<>]" end t)
17883 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17885 (message "Timestamp is now %sactive"
17886 (if (equal (char-after beg) ?<) "" "in")))))
17888 (defun org-at-clock-log-p nil
17889 "Is the cursor on the clock log line?"
17891 (move-beginning-of-line 1)
17892 (looking-at org-clock-line-re)))
17894 (defvar org-clock-history) ; defined in org-clock.el
17895 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17896 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17897 "Change the date in the time stamp at point.
17898 The date will be changed by N times WHAT. WHAT can be `day', `month',
17899 `year', `minute', `second'. If WHAT is not given, the cursor position
17900 in the timestamp determines what will be changed.
17901 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17902 (let ((origin (point)) origin-cat
17904 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17907 ts time time0 fixnext clrgx)
17908 (if (not (org-at-timestamp-p t))
17909 (user-error "Not at a timestamp"))
17910 (if (and (not what) (eq org-ts-what 'bracket))
17911 (org-toggle-timestamp-type)
17912 ;; Point isn't on brackets. Remember the part of the time-stamp
17913 ;; the point was in. Indeed, size of time-stamps may change,
17914 ;; but point must be kept in the same category nonetheless.
17915 (setq origin-cat org-ts-what)
17916 (if (and (not what) (not (eq org-ts-what 'day))
17917 org-display-custom-times
17918 (get-text-property (point) 'display)
17919 (not (get-text-property (1- (point)) 'display)))
17920 (setq org-ts-what 'day))
17921 (setq org-ts-what (or what org-ts-what)
17922 inactive (= (char-after (match-beginning 0)) ?\[)
17923 ts (match-string 0))
17925 (when (string-match
17926 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17928 (setq extra (match-string 1 ts))
17929 (if suppress-tmp-delay
17930 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17931 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17933 (setq time0 (org-parse-time-string ts))
17935 (eq org-ts-what 'minute)
17936 (not current-prefix-arg))
17937 ;; This looks like s-up and s-down. Change by one rounding step.
17938 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17939 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17940 (setcar (cdr time0) (+ (nth 1 time0)
17941 (if (> n 0) (- rem) (- dm rem))))))
17943 (encode-time (or (car time0) 0)
17944 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17945 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17946 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17947 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17948 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17950 (when (and (member org-ts-what '(hour minute))
17952 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17953 (setq extra (org-modify-ts-extra
17955 (if (eq org-ts-what 'hour) 2 5)
17957 (when (integerp org-ts-what)
17958 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17959 (if (eq what 'calendar)
17960 (let ((cal-date (org-get-date-from-calendar)))
17961 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17962 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17963 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17964 (setcar time0 (or (car time0) 0))
17965 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17966 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17967 (setq time (apply 'encode-time time0))))
17968 ;; Insert the new time-stamp, and ensure point stays in the same
17969 ;; category as before (i.e. not after the last position in that
17971 (let ((pos (point)))
17972 ;; Stay before inserted string. `save-excursion' is of no use.
17973 (setq org-last-changed-timestamp
17974 (org-insert-time-stamp time with-hm inactive nil nil extra))
17977 (looking-at org-ts-regexp3)
17979 ;; `day' category ends before `hour' if any, or at
17980 ;; the end of the day name.
17981 ((eq origin-cat 'day)
17982 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17983 ((eq origin-cat 'hour) (min (match-end 7) origin))
17984 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17985 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17986 ;; `year' and `month' have both fixed size: point
17987 ;; couldn't have moved into another part.
17989 ;; Update clock if on a CLOCK line.
17990 (org-clock-update-time-maybe)
17991 ;; Maybe adjust the closest clock in `org-clock-history'
17992 (when org-clock-adjust-closest
17993 (if (not (and (org-at-clock-log-p)
17994 (< 1 (length (delq nil (mapcar 'marker-position
17995 org-clock-history))))))
17996 (message "No clock to adjust")
17997 (cond ((save-excursion ; fix previous clock?
17998 (re-search-backward org-ts-regexp0 nil t)
17999 (org-looking-back (concat org-clock-string " \\[")))
18000 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
18001 ((save-excursion ; fix next clock?
18002 (re-search-backward org-ts-regexp0 nil t)
18003 (looking-at (concat org-ts-regexp0 "\\] =>")))
18004 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
18005 (save-window-excursion
18006 ;; Find closest clock to point, adjust the previous/next one in history
18007 (let* ((p (save-excursion (org-back-to-heading t)))
18008 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
18010 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
18011 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
18013 (message "No clock to adjust")
18015 (org-goto-marker-or-bmk clfixpos)
18017 (when (re-search-forward clrgx nil t)
18018 (goto-char (match-beginning 1))
18019 (let (org-clock-adjust-closest)
18020 (org-timestamp-change n org-ts-what updown))
18021 (message "Clock adjusted in %s for heading: %s"
18022 (file-name-nondirectory (buffer-file-name))
18023 (org-get-heading t t)))))))))
18024 ;; Try to recenter the calendar window, if any.
18025 (if (and org-calendar-follow-timestamp-change
18026 (get-buffer-window "*Calendar*" t)
18027 (memq org-ts-what '(day month year)))
18028 (org-recenter-calendar (time-to-days time))))))
18030 (defun org-modify-ts-extra (s pos n dm)
18031 "Change the different parts of the lead-time and repeat fields in timestamp."
18032 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18034 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18036 ((or (org-pos-in-match-range pos 2)
18037 (org-pos-in-match-range pos 3))
18038 (setq m (string-to-number (match-string 3 s))
18039 h (string-to-number (match-string 2 s)))
18040 (if (org-pos-in-match-range pos 2)
18042 (setq n (* dm (org-no-warnings (signum n))))
18043 (when (not (= 0 (setq rem (% m dm))))
18044 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18046 (if (< m 0) (setq m (+ m 60) h (1- h)))
18047 (if (> m 59) (setq m (- m 60) h (1+ h)))
18048 (setq h (min 24 (max 0 h)))
18049 (setq ng 1 new (format "-%02d:%02d" h m)))
18050 ((org-pos-in-match-range pos 6)
18051 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18052 ((org-pos-in-match-range pos 5)
18053 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18055 ((org-pos-in-match-range pos 9)
18056 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18057 ((org-pos-in-match-range pos 8)
18058 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18062 (substring s 0 (match-beginning ng))
18064 (substring s (match-end ng))))))
18067 (defun org-recenter-calendar (date)
18068 "If the calendar is visible, recenter it to DATE."
18069 (let ((cwin (get-buffer-window "*Calendar*" t)))
18071 (let ((calendar-move-hook nil))
18072 (with-selected-window cwin
18073 (calendar-goto-date (if (listp date) date
18074 (calendar-gregorian-from-absolute date))))))))
18076 (defun org-goto-calendar (&optional arg)
18077 "Go to the Emacs calendar at the current date.
18078 If there is a time stamp in the current line, go to that date.
18079 A prefix ARG can be used to force the current date."
18081 (let ((tsr org-ts-regexp) diff
18082 (calendar-move-hook nil)
18083 (calendar-view-holidays-initially-flag nil)
18084 (calendar-view-diary-initially-flag nil))
18085 (if (or (org-at-timestamp-p)
18087 (beginning-of-line 1)
18088 (looking-at (concat ".*" tsr))))
18089 (let ((d1 (time-to-days (current-time)))
18091 (org-time-string-to-time (match-string 1)))))
18092 (setq diff (- d2 d1))))
18094 (calendar-goto-today)
18095 (if (and diff (not arg)) (calendar-forward-day diff))))
18097 (defun org-get-date-from-calendar ()
18098 "Return a list (month day year) of date at point in calendar."
18099 (with-current-buffer "*Calendar*"
18101 (calendar-cursor-to-date))))
18103 (defun org-date-from-calendar ()
18104 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18105 If there is already a time stamp at the cursor position, update it."
18107 (if (org-at-timestamp-p t)
18108 (org-timestamp-change 0 'calendar)
18109 (let ((cal-date (org-get-date-from-calendar)))
18110 (org-insert-time-stamp
18111 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18113 (defcustom org-effort-durations
18117 ("w" . ,(* 60 8 5))
18118 ("m" . ,(* 60 8 5 4))
18119 ("y" . ,(* 60 8 5 40)))
18120 "Conversion factor to minutes for an effort modifier.
18122 Each entry has the form (MODIFIER . MINUTES).
18124 In an effort string, a number followed by MODIFIER is multiplied
18125 by the specified number of MINUTES to obtain an effort in
18128 For example, if the value of this variable is ((\"hours\" . 60)), then an
18129 effort string \"2hours\" is equivalent to 120 minutes."
18132 :package-version '(Org . "8.3")
18133 :type '(alist :key-type (string :tag "Modifier")
18134 :value-type (number :tag "Minutes")))
18136 (defun org-minutes-to-clocksum-string (m)
18137 "Format number of minutes as a clocksum string.
18138 The format is determined by `org-time-clocksum-format',
18139 `org-time-clocksum-use-fractional' and
18140 `org-time-clocksum-fractional-format' and
18141 `org-time-clocksum-use-effort-durations'."
18142 (let ((clocksum "")
18143 (m (round m)) ; Don't allow fractions of minutes
18145 (setq h (if org-time-clocksum-use-effort-durations
18146 (cdr (assoc "h" org-effort-durations)) 60)
18147 d (if org-time-clocksum-use-effort-durations
18148 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18149 w (if org-time-clocksum-use-effort-durations
18150 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18151 mo (if org-time-clocksum-use-effort-durations
18152 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18153 y (if org-time-clocksum-use-effort-durations
18154 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18155 ;; fractional format
18156 (if org-time-clocksum-use-fractional
18158 ;; single format string
18159 ((stringp org-time-clocksum-fractional-format)
18160 (format org-time-clocksum-fractional-format (/ m (float h))))
18161 ;; choice of fractional formats for different time units
18162 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18163 (> (/ (truncate m) (* y d h)) 0))
18164 (format fmt (/ m (* y d (float h)))))
18165 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18166 (> (/ (truncate m) (* mo d h)) 0))
18167 (format fmt (/ m (* mo d (float h)))))
18168 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18169 (> (/ (truncate m) (* w d h)) 0))
18170 (format fmt (/ m (* w d (float h)))))
18171 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18172 (> (/ (truncate m) (* d h)) 0))
18173 (format fmt (/ m (* d (float h)))))
18174 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18175 (> (/ (truncate m) h) 0))
18176 (format fmt (/ m (float h))))
18177 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18179 ;; fall back to smallest time unit with a format
18180 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18181 (format fmt (/ m (float h))))
18182 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18183 (format fmt (/ m (* d (float h)))))
18184 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18185 (format fmt (/ m (* w d (float h)))))
18186 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18187 (format fmt (/ m (* mo d (float h)))))
18188 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18189 (format fmt (/ m (* y d (float h))))))
18190 ;; standard (non-fractional) format, with single format string
18191 (if (stringp org-time-clocksum-format)
18192 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18193 ;; separate formats components
18194 (and (setq fmt (plist-get org-time-clocksum-format :years))
18195 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18196 (plist-get org-time-clocksum-format :require-years))
18197 (setq clocksum (concat clocksum (format fmt n))
18198 m (- m (* n y d h))))
18199 (and (setq fmt (plist-get org-time-clocksum-format :months))
18200 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18201 (plist-get org-time-clocksum-format :require-months))
18202 (setq clocksum (concat clocksum (format fmt n))
18203 m (- m (* n mo d h))))
18204 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18205 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18206 (plist-get org-time-clocksum-format :require-weeks))
18207 (setq clocksum (concat clocksum (format fmt n))
18208 m (- m (* n w d h))))
18209 (and (setq fmt (plist-get org-time-clocksum-format :days))
18210 (or (> (setq n (/ (truncate m) (* d h))) 0)
18211 (plist-get org-time-clocksum-format :require-days))
18212 (setq clocksum (concat clocksum (format fmt n))
18213 m (- m (* n d h))))
18214 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18215 (or (> (setq n (/ (truncate m) h)) 0)
18216 (plist-get org-time-clocksum-format :require-hours))
18217 (setq clocksum (concat clocksum (format fmt n))
18219 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18220 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18221 (setq clocksum (concat clocksum (format fmt m))))
18222 ;; return formatted time duration
18225 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18226 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18227 "Org mode version 8.0")
18229 (defun org-hours-to-clocksum-string (n)
18230 (org-minutes-to-clocksum-string (* n 60)))
18232 (defun org-hh:mm-string-to-minutes (s)
18233 "Convert a string H:MM to a number of minutes.
18234 If the string is just a number, interpret it as minutes.
18235 In fact, the first hh:mm or number in the string will be taken,
18236 there can be extra stuff in the string.
18237 If no number is found, the return value is 0."
18240 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18241 (+ (* (string-to-number (match-string 1 s)) 60)
18242 (string-to-number (match-string 2 s))))
18243 ((string-match "\\([0-9]+\\)" s)
18244 (string-to-number (match-string 1 s)))
18247 (defcustom org-image-actual-width t
18248 "Should we use the actual width of images when inlining them?
18250 When set to `t', always use the image width.
18252 When set to a number, use imagemagick (when available) to set
18253 the image's width to this value.
18255 When set to a number in a list, try to get the width from any
18256 #+ATTR.* keyword if it matches a width specification like
18258 #+ATTR_HTML: :width 300px
18260 and fall back on that number if none is found.
18262 When set to nil, try to get the width from an #+ATTR.* keyword
18263 and fall back on the original width if none is found.
18265 This requires Emacs >= 24.1, build with imagemagick support."
18266 :group 'org-appearance
18268 :package-version '(Org . "8.0")
18270 (const :tag "Use the image width" t)
18271 (integer :tag "Use a number of pixels")
18272 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18273 (const :tag "Use #+ATTR* or don't resize" nil)))
18275 (defcustom org-agenda-inhibit-startup nil
18276 "Inhibit startup when preparing agenda buffers.
18277 When this variable is `t', the initialization of the Org agenda
18278 buffers is inhibited: e.g. the visibility state is not set, the
18279 tables are not re-aligned, etc."
18282 :group 'org-agenda)
18284 (define-obsolete-variable-alias
18285 'org-agenda-ignore-drawer-properties
18286 'org-agenda-ignore-properties "25.1")
18288 (defcustom org-agenda-ignore-properties nil
18289 "Avoid updating text properties when building the agenda.
18290 Properties are used to prepare buffers for effort estimates,
18291 appointments, statistics and subtree-local categories.
18292 If you don't use these in the agenda, you can add them to this
18293 list and agenda building will be a bit faster.
18294 The value is a list, with zero or more of the symbols `effort', `appt',
18295 `stats' or `category'."
18296 :type '(set :greedy t
18302 :package-version '(Org . "8.3")
18303 :group 'org-agenda)
18305 (defun org-duration-string-to-minutes (s &optional output-to-string)
18306 "Convert a duration string S to minutes.
18308 A bare number is interpreted as minutes, modifiers can be set by
18309 customizing `org-effort-durations' (which see).
18311 Entries containing a colon are interpreted as H:MM by
18312 `org-hh:mm-string-to-minutes'."
18314 (re (concat "\\([0-9.]+\\) *\\("
18315 (regexp-opt (mapcar 'car org-effort-durations))
18317 (while (string-match re s)
18318 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18319 (string-to-number (match-string 1 s))))
18320 (setq s (replace-match "" nil t s)))
18321 (setq result (floor result))
18322 (incf result (org-hh:mm-string-to-minutes s))
18323 (if output-to-string (number-to-string result) result)))
18327 (defun org-save-all-org-buffers ()
18328 "Save all Org-mode buffers without user confirmation."
18330 (message "Saving all Org-mode buffers...")
18331 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18332 (when (featurep 'org-id) (org-id-locations-save))
18333 (message "Saving all Org-mode buffers... done"))
18335 (defun org-revert-all-org-buffers ()
18336 "Revert all Org-mode buffers.
18337 Prompt for confirmation when there are unsaved changes.
18338 Be sure you know what you are doing before letting this function
18339 overwrite your changes.
18341 This function is useful in a setup where one tracks org files
18342 with a version control system, to revert on one machine after pulling
18343 changes from another. I believe the procedure must be like this:
18345 1. M-x org-save-all-org-buffers
18346 2. Pull changes from the other machine, resolve conflicts
18347 3. M-x org-revert-all-org-buffers"
18349 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18350 (user-error "Abort"))
18352 (save-window-excursion
18355 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18356 (with-current-buffer b buffer-file-name))
18357 (org-pop-to-buffer-same-window b)
18358 (revert-buffer t 'no-confirm)))
18360 (when (and (featurep 'org-id) org-id-track-globally)
18361 (org-id-locations-load)))))
18366 (defun org-switchb (&optional arg)
18367 "Switch between Org buffers.
18368 With one prefix argument, restrict available buffers to files.
18369 With two prefix arguments, restrict available buffers to agenda files.
18371 Defaults to `iswitchb' for buffer name completion.
18372 Set `org-completion-use-ido' to make it use ido instead."
18374 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18375 ((equal arg '(16)) (org-buffer-list 'agenda))
18376 (t (org-buffer-list))))
18377 (org-completion-use-iswitchb org-completion-use-iswitchb)
18378 (org-completion-use-ido org-completion-use-ido))
18379 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18380 (setq org-completion-use-iswitchb t))
18381 (org-pop-to-buffer-same-window
18382 (org-icompleting-read "Org buffer: "
18383 (mapcar 'list (mapcar 'buffer-name blist))
18386 ;;; Define some older names previously used for this functionality
18388 (defalias 'org-ido-switchb 'org-switchb)
18390 (defalias 'org-iswitchb 'org-switchb)
18392 (defun org-buffer-list (&optional predicate exclude-tmp)
18393 "Return a list of Org buffers.
18394 PREDICATE can be `export', `files' or `agenda'.
18396 export restrict the list to Export buffers.
18397 files restrict the list to buffers visiting Org files.
18398 agenda restrict the list to buffers visiting agenda files.
18400 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18402 (agenda-files (and (eq predicate 'agenda)
18403 (mapcar 'file-truename (org-agenda-files t))))
18406 ((eq predicate 'files)
18407 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18408 ((eq predicate 'export)
18409 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18410 ((eq predicate 'agenda)
18412 (with-current-buffer b
18413 (and (derived-mode-p 'org-mode)
18414 (setq bfn (buffer-file-name b))
18415 (member (file-truename bfn) agenda-files)))))
18416 (t (lambda (b) (with-current-buffer b
18417 (or (derived-mode-p 'org-mode)
18418 (string-match "\*Org .*Export"
18419 (buffer-name b)))))))))
18423 (if (and (funcall filter b)
18424 (or (not exclude-tmp)
18425 (not (string-match "tmp" (buffer-name b)))))
18430 (defun org-agenda-files (&optional unrestricted archives)
18431 "Get the list of agenda files.
18432 Optional UNRESTRICTED means return the full list even if a restriction
18433 is currently in place.
18434 When ARCHIVES is t, include all archive files that are really being
18435 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18436 `org-agenda-archives-mode' is t."
18439 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18440 ((stringp org-agenda-files) (org-read-agenda-file-list))
18441 ((listp org-agenda-files) org-agenda-files)
18442 (t (error "Invalid value of `org-agenda-files'")))))
18443 (setq files (apply 'append
18444 (mapcar (lambda (f)
18445 (if (file-directory-p f)
18447 f t org-agenda-file-regexp)
18450 (when org-agenda-skip-unavailable-files
18451 (setq files (delq nil
18454 (and (file-readable-p file) file)))
18456 (when (or (eq archives t)
18457 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18458 (setq files (org-add-archive-files files)))
18461 (defun org-agenda-file-p (&optional file)
18462 "Return non-nil, if FILE is an agenda file.
18463 If FILE is omitted, use the file associated with the current
18465 (let ((fname (or file (buffer-file-name))))
18467 (member (file-truename fname)
18468 (mapcar #'file-truename (org-agenda-files t))))))
18470 (defun org-edit-agenda-file-list ()
18471 "Edit the list of agenda files.
18472 Depending on setup, this either uses customize to edit the variable
18473 `org-agenda-files', or it visits the file that is holding the list. In the
18474 latter case, the buffer is set up in a way that saving it automatically kills
18475 the buffer and restores the previous window configuration."
18477 (if (stringp org-agenda-files)
18478 (let ((cw (current-window-configuration)))
18479 (find-file org-agenda-files)
18480 (org-set-local 'org-window-configuration cw)
18481 (org-add-hook 'after-save-hook
18483 (set-window-configuration
18484 (prog1 org-window-configuration
18485 (kill-buffer (current-buffer))))
18486 (org-install-agenda-files-menu)
18487 (message "New agenda file list installed"))
18489 (message "%s" (substitute-command-keys
18490 "Edit list and finish with \\[save-buffer]")))
18491 (customize-variable 'org-agenda-files)))
18493 (defun org-store-new-agenda-file-list (list)
18494 "Set new value for the agenda file list and save it correctly."
18495 (if (stringp org-agenda-files)
18496 (let ((fe (org-read-agenda-file-list t)) b u)
18497 (while (setq b (find-buffer-visiting org-agenda-files))
18499 (with-temp-file org-agenda-files
18502 (lambda (f) ;; Keep un-expanded entries.
18503 (if (setq u (assoc f fe))
18508 (let ((org-mode-hook nil) (org-inhibit-startup t)
18509 (org-insert-mode-line-in-empty-file nil))
18510 (setq org-agenda-files list)
18511 (customize-save-variable 'org-agenda-files org-agenda-files))))
18513 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18514 "Read the list of agenda files from a file.
18515 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18516 filenames, used by `org-store-new-agenda-file-list' to write back
18517 un-expanded file names."
18518 (when (file-directory-p org-agenda-files)
18519 (error "`org-agenda-files' cannot be a single directory"))
18520 (when (stringp org-agenda-files)
18522 (insert-file-contents org-agenda-files)
18525 (let ((e (expand-file-name (substitute-in-file-name f)
18527 (if pair-with-expansion
18530 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18533 (defun org-cycle-agenda-files ()
18534 "Cycle through the files in `org-agenda-files'.
18535 If the current buffer visits an agenda file, find the next one in the list.
18536 If the current buffer does not, find the first agenda file."
18538 (let* ((fs (org-agenda-files t))
18539 (files (append fs (list (car fs))))
18540 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18542 (unless files (user-error "No agenda files"))
18544 (while (setq file (pop files))
18545 (if (equal (file-truename file) tcf)
18547 (find-file (car files))
18549 (find-file (car fs)))
18550 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18552 (defun org-agenda-file-to-front (&optional to-end)
18553 "Move/add the current file to the top of the agenda file list.
18554 If the file is not present in the list, it is added to the front. If it is
18555 present, it is moved there. With optional argument TO-END, add/move to the
18558 (let ((org-agenda-skip-unavailable-files nil)
18559 (file-alist (mapcar (lambda (x)
18560 (cons (file-truename x) x))
18561 (org-agenda-files t)))
18562 (ctf (file-truename
18563 (or buffer-file-name
18564 (user-error "Please save the current buffer to a file"))))
18566 (setq x (assoc ctf file-alist) had x)
18568 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18570 (setq file-alist (append (delq x file-alist) (list x)))
18571 (setq file-alist (cons x (delq x file-alist))))
18572 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18573 (org-install-agenda-files-menu)
18574 (message "File %s to %s of agenda file list"
18575 (if had "moved" "added") (if to-end "end" "front"))))
18577 (defun org-remove-file (&optional file)
18578 "Remove current file from the list of files in variable `org-agenda-files'.
18579 These are the files which are being checked for agenda entries.
18580 Optional argument FILE means use this file instead of the current."
18582 (let* ((org-agenda-skip-unavailable-files nil)
18583 (file (or file buffer-file-name
18584 (user-error "Current buffer does not visit a file")))
18585 (true-file (file-truename file))
18586 (afile (abbreviate-file-name file))
18587 (files (delq nil (mapcar
18589 (if (equal true-file
18592 (org-agenda-files t)))))
18593 (if (not (= (length files) (length (org-agenda-files t))))
18595 (org-store-new-agenda-file-list files)
18596 (org-install-agenda-files-menu)
18597 (message "Removed from Org Agenda list: %s" afile))
18598 (message "File was not in list: %s (not removed)" afile))))
18600 (defun org-file-menu-entry (file)
18601 (vector file (list 'find-file file) t))
18603 (defun org-check-agenda-file (file)
18604 "Make sure FILE exists. If not, ask user what to do."
18605 (when (not (file-exists-p file))
18606 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18607 (abbreviate-file-name file))
18608 (let ((r (downcase (read-char-exclusive))))
18611 (org-remove-file file)
18612 (throw 'nextfile t))
18613 (t (user-error "Abort"))))))
18615 (defun org-get-agenda-file-buffer (file)
18616 "Get an agenda buffer visiting FILE.
18617 If the buffer needs to be created, add it to the list of buffers
18618 which might be released later."
18619 (let ((buf (org-find-base-buffer-visiting file)))
18621 buf ; just return it
18622 ;; Make a new buffer and remember it
18623 (setq buf (find-file-noselect file))
18624 (if buf (push buf org-agenda-new-buffers))
18627 (defun org-release-buffers (blist)
18628 "Release all buffers in list, asking the user for confirmation when needed.
18629 When a buffer is unmodified, it is just killed. When modified, it is saved
18630 \(if the user agrees) and then killed."
18632 (while (setq buf (pop blist))
18633 (setq file (buffer-file-name buf))
18634 (when (and (buffer-modified-p buf)
18636 (y-or-n-p (format "Save file %s? " file)))
18637 (with-current-buffer buf (save-buffer)))
18638 (kill-buffer buf))))
18640 (defun org-agenda-prepare-buffers (files)
18641 "Create buffers for all agenda files, protect archived trees and comments."
18643 (let ((pa '(:org-archived t))
18644 (pc '(:org-comment t))
18645 (pall '(:org-archived t :org-comment t))
18646 (inhibit-read-only t)
18647 (org-inhibit-startup org-agenda-inhibit-startup)
18648 (rea (concat ":" org-archive-tag ":"))
18650 (setq org-tag-alist-for-agenda nil
18651 org-tag-groups-alist-for-agenda nil)
18654 (while (setq file (pop files))
18658 (org-check-agenda-file file)
18659 (set-buffer (org-get-agenda-file-buffer file)))
18661 (org-set-regexps-and-options 'tags-only)
18663 (or (memq 'category org-agenda-ignore-properties)
18664 (org-refresh-category-properties))
18665 (or (memq 'stats org-agenda-ignore-properties)
18666 (org-refresh-stats-properties))
18667 (or (memq 'effort org-agenda-ignore-properties)
18668 (org-refresh-effort-properties))
18669 (or (memq 'appt org-agenda-ignore-properties)
18670 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18671 (setq org-todo-keywords-for-agenda
18672 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18673 (setq org-done-keywords-for-agenda
18674 (append org-done-keywords-for-agenda org-done-keywords))
18675 (setq org-todo-keyword-alist-for-agenda
18676 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18677 (setq org-tag-alist-for-agenda
18679 (append org-tag-alist-for-agenda
18681 org-tag-persistent-alist)))
18683 (setq org-tag-groups-alist-for-agenda
18684 (org-uniquify-alist
18685 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18686 (org-with-silent-modifications
18688 (remove-text-properties (point-min) (point-max) pall)
18689 (when org-agenda-skip-archived-trees
18690 (goto-char (point-min))
18691 (while (re-search-forward rea nil t)
18692 (if (org-at-heading-p t)
18693 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18694 (goto-char (point-min))
18695 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18696 (while (re-search-forward re nil t)
18697 (when (save-match-data (org-in-commented-heading-p t))
18698 (add-text-properties
18699 (match-beginning 0) (org-end-of-subtree t) pc)))))
18700 (goto-char pos)))))
18701 (setq org-todo-keywords-for-agenda
18702 (org-uniquify org-todo-keywords-for-agenda))
18703 (setq org-todo-keyword-alist-for-agenda
18704 (org-uniquify org-todo-keyword-alist-for-agenda))))
18707 ;;;; CDLaTeX minor mode
18709 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18710 "Keymap for the minor `org-cdlatex-mode'.")
18712 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18713 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18714 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18715 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18716 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18718 (defvar org-cdlatex-texmathp-advice-is-done nil
18719 "Flag remembering if we have applied the advice to texmathp already.")
18721 (define-minor-mode org-cdlatex-mode
18722 "Toggle the minor `org-cdlatex-mode'.
18723 This mode supports entering LaTeX environment and math in LaTeX fragments
18725 \\{org-cdlatex-mode-map}"
18727 (when org-cdlatex-mode
18729 (run-hooks 'cdlatex-mode-hook)
18730 (cdlatex-compute-tables))
18731 (unless org-cdlatex-texmathp-advice-is-done
18732 (setq org-cdlatex-texmathp-advice-is-done t)
18733 (defadvice texmathp (around org-math-always-on activate)
18734 "Always return t in org-mode buffers.
18735 This is because we want to insert math symbols without dollars even outside
18736 the LaTeX math segments. If Orgmode thinks that point is actually inside
18737 an embedded LaTeX fragment, let texmathp do its job.
18738 \\[org-cdlatex-mode-map]"
18742 ((not (derived-mode-p 'org-mode)) ad-do-it)
18743 ((eq this-command 'cdlatex-math-symbol)
18744 (setq ad-return-value t
18745 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18747 (let ((p (org-inside-LaTeX-fragment-p)))
18748 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18749 (setq ad-return-value t
18750 texmathp-why '("Org-mode embedded math" . 0))
18751 (if p ad-do-it)))))))))
18753 (defun turn-on-org-cdlatex ()
18754 "Unconditionally turn on `org-cdlatex-mode'."
18755 (org-cdlatex-mode 1))
18757 (defun org-try-cdlatex-tab ()
18758 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18759 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18760 - inside a LaTeX fragment, or
18761 - after the first word in a line, where an abbreviation expansion could
18762 insert a LaTeX environment."
18763 (when org-cdlatex-mode
18765 ;; Before any word on the line: No expansion possible.
18766 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18767 ;; Just after first word on the line: Expand it. Make sure it
18768 ;; cannot happen on headlines, though.
18770 (skip-chars-backward "a-zA-Z0-9*")
18771 (skip-chars-backward " \t")
18772 (and (bolp) (not (org-at-heading-p))))
18774 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18776 (defun org-cdlatex-underscore-caret (&optional arg)
18777 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18778 Revert to the normal definition outside of these fragments."
18780 (if (org-inside-LaTeX-fragment-p)
18781 (call-interactively 'cdlatex-sub-superscript)
18782 (let (org-cdlatex-mode)
18783 (call-interactively (key-binding (vector last-input-event))))))
18785 (defun org-cdlatex-math-modify (&optional arg)
18786 "Execute `cdlatex-math-modify' in LaTeX fragments.
18787 Revert to the normal definition outside of these fragments."
18789 (if (org-inside-LaTeX-fragment-p)
18790 (call-interactively 'cdlatex-math-modify)
18791 (let (org-cdlatex-mode)
18792 (call-interactively (key-binding (vector last-input-event))))))
18794 (defun org-cdlatex-environment-indent (&optional environment item)
18795 "Execute `cdlatex-environment' and indent the inserted environment.
18797 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18799 The inserted environment is indented to current indentation
18800 unless point is at the beginning of the line, in which the
18801 environment remains unintended."
18803 ;; cdlatex-environment always return nil. Therefore, capture output
18804 ;; first and determine if an environment was selected.
18805 (let* ((beg (point-marker))
18806 (end (copy-marker (point) t))
18808 (ignore-errors (cdlatex-environment environment item))
18810 ;; Figure out how many lines to move forward after the
18811 ;; environment has been inserted.
18812 (lines (when inserted
18814 (- (loop while (< beg (point))
18816 do (forward-line -1)
18819 (if (progn (goto-char beg)
18820 (and (progn (skip-chars-forward " \t") (eolp))
18821 (progn (skip-chars-backward " \t") (bolp))))
18823 (env (org-trim (delete-and-extract-region beg end))))
18825 ;; Get indentation of next line unless at column 0.
18826 (let ((ind (if (bolp) 0
18828 (org-return-indent)
18829 (prog1 (org-get-indentation)
18830 (when (progn (skip-chars-forward " \t") (eolp))
18831 (delete-region beg (point)))))))
18832 (bol (progn (skip-chars-backward " \t") (bolp))))
18833 ;; Insert a newline before environment unless at column zero
18834 ;; to "escape" the current line. Insert a newline if
18835 ;; something is one the same line as \end{ENVIRONMENT}.
18837 (concat (unless bol "\n") env
18838 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18839 (unless (zerop ind)
18842 (while (< (point) end)
18843 (unless (eolp) (org-indent-line-to ind))
18846 (forward-line lines)
18847 (org-indent-line-to ind)))
18848 (set-marker beg nil)
18849 (set-marker end nil)))
18852 ;;;; LaTeX fragments
18854 (defun org-inside-LaTeX-fragment-p ()
18855 "Test if point is inside a LaTeX fragment.
18856 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18857 sequence appearing also before point.
18858 Even though the matchers for math are configurable, this function assumes
18859 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18860 delimiters are skipped when they have been removed by customization.
18861 The return value is nil, or a cons cell with the delimiter and the
18862 position of this delimiter.
18864 This function does a reasonably good job, but can locally be fooled by
18865 for example currency specifications. For example it will assume being in
18866 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18867 fragments that are properly closed, but during editing, we have to live
18868 with the uncertainty caused by missing closing delimiters. This function
18869 looks only before point, not after."
18871 (let ((pos (point))
18872 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18874 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18876 dd-on str (start 0) m re)
18879 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18880 re (nth 1 (assoc "$" org-latex-regexps)))
18881 (while (string-match re str start)
18883 ((= (match-end 0) (length str))
18884 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18885 ((= (match-end 0) (- (length str) 5))
18887 (t (setq start (match-end 0))))))
18888 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18890 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18891 (and (match-beginning 2) (throw 'exit nil))
18893 (while (re-search-backward "\\$\\$" lim t)
18894 (setq dd-on (not dd-on)))
18896 (if dd-on (cons "$$" m))))))
18898 (defun org-inside-latex-macro-p ()
18899 "Is point inside a LaTeX macro or its arguments?"
18902 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18904 (defvar org-latex-fragment-image-overlays nil
18905 "List of overlays carrying the images of latex fragments.")
18906 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18908 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18909 "Remove all overlays with LaTeX fragment images in current buffer.
18910 When optional arguments BEG and END are non-nil, remove all
18911 overlays between them instead. Return t when some overlays were
18912 removed, nil otherwise."
18914 (setq org-latex-fragment-image-overlays
18915 (let ((beg (or beg (point-min)))
18916 (end (or end (point-max))))
18919 (and (>= (overlay-start o) beg)
18920 (<= (overlay-end o) end)
18921 (progn (delete-overlay o)
18922 (or removedp (setq removedp t)))))
18923 org-latex-fragment-image-overlays)))
18926 (define-obsolete-function-alias
18927 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18928 (defun org-toggle-latex-fragment (&optional arg)
18929 "Preview the LaTeX fragment at point, or all locally or globally.
18931 If the cursor is on a LaTeX fragment, create the image and overlay
18932 it over the source code, if there is none. Remove it otherwise.
18933 If there is no fragment at point, display all fragments in the
18936 With prefix ARG, preview or clear image for all fragments in the
18937 current subtree or in the whole buffer when used before the first
18938 headline. With a double prefix ARG \\[universal-argument] \
18939 \\[universal-argument] preview or clear images
18940 for all fragments in the buffer."
18942 (unless (buffer-file-name (buffer-base-buffer))
18943 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18944 (when (display-graphic-p)
18947 (let ((window-start (window-start)) msg)
18950 ((or (equal arg '(16))
18951 (and (equal arg '(4))
18952 (org-with-limited-levels (org-before-first-heading-p))))
18953 (if (org-remove-latex-fragment-image-overlays)
18954 (progn (message "LaTeX fragments images removed from buffer")
18956 (setq msg "Creating images for buffer...")))
18958 (org-with-limited-levels (org-back-to-heading t))
18959 (let ((beg (point))
18960 (end (progn (org-end-of-subtree t) (point))))
18961 (if (org-remove-latex-fragment-image-overlays beg end)
18963 (message "LaTeX fragment images removed from subtree")
18965 (setq msg "Creating images for subtree...")
18966 (narrow-to-region beg end))))
18967 ((let ((datum (org-element-context)))
18968 (when (memq (org-element-type datum)
18969 '(latex-environment latex-fragment))
18970 (let* ((beg (org-element-property :begin datum))
18971 (end (org-element-property :end datum)))
18972 (if (org-remove-latex-fragment-image-overlays beg end)
18973 (progn (message "LaTeX fragment image removed")
18975 (narrow-to-region beg end)
18976 (setq msg "Creating image..."))))))
18978 (org-with-limited-levels
18979 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18980 (outline-previous-heading)
18982 (end (progn (outline-next-heading) (point))))
18983 (if (org-remove-latex-fragment-image-overlays beg end)
18985 (message "LaTeX fragment images removed from section")
18987 (setq msg "Creating images for section...")
18988 (narrow-to-region beg end))))))
18989 (let ((file (buffer-file-name (buffer-base-buffer))))
18991 (concat org-latex-preview-ltxpng-directory
18992 (file-name-sans-extension (file-name-nondirectory file)))
18993 ;; Emacs cannot overlay images from remote hosts.
18994 ;; Create it in `temporary-file-directory' instead.
18995 (if (file-remote-p file) temporary-file-directory
18997 'overlays msg 'forbuffer
18998 org-latex-create-formula-image-program)))
18999 ;; Work around a bug that doesn't restore window's start
19000 ;; when widening back the buffer.
19001 (set-window-start nil window-start)
19002 (message (concat msg "done")))))))
19004 (defun org-format-latex
19005 (prefix &optional dir overlays msg forbuffer processing-type)
19006 "Replace LaTeX fragments with links to an image, and produce images.
19008 When optional argument OVERLAYS is non-nil, display the image on
19009 top of the fragment instead of replacing it.
19011 PROCESSING-TYPE is the conversion method to use, as a symbol.
19013 Some of the options can be changed using the variable
19014 `org-format-latex-options', which see."
19015 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
19016 (unless (eq processing-type 'verbatim)
19017 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
19020 (goto-char (point-min))
19021 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
19022 (when (and overlays (memq processing-type '(dvipng imagemagick)))
19023 (overlay-recenter (point-max)))
19024 (while (re-search-forward math-regexp nil t)
19025 (unless (and overlays
19026 (eq (get-char-property (point) 'org-overlay-type)
19027 'org-latex-overlay))
19028 (let* ((context (org-element-context))
19029 (type (org-element-type context)))
19030 (when (memq type '(latex-environment latex-fragment))
19031 (let ((block-type (eq type 'latex-environment))
19032 (value (org-element-property :value context))
19033 (beg (org-element-property :begin context))
19034 (end (save-excursion
19035 (goto-char (org-element-property :end context))
19036 (skip-chars-backward " \r\t\n")
19038 (case processing-type
19040 ;; Prepare for MathJax processing.
19041 (if (eq (char-after beg) ?$)
19043 (delete-region beg end)
19044 (insert "\\(" (substring value 1 -1) "\\)"))
19046 ((dvipng imagemagick)
19047 ;; Process to an image.
19050 (let* ((face (face-at-point))
19051 ;; Get the colors from the face at point.
19053 (let ((color (plist-get org-format-latex-options
19055 (if (and forbuffer (eq color 'auto))
19056 (face-attribute face :foreground nil 'default)
19059 (let ((color (plist-get org-format-latex-options
19061 (if (and forbuffer (eq color 'auto))
19062 (face-attribute face :background nil 'default)
19064 (hash (sha1 (prin1-to-string
19065 (list org-format-latex-header
19066 org-latex-default-packages-alist
19067 org-latex-packages-alist
19068 org-format-latex-options
19069 forbuffer value fg bg))))
19070 (absprefix (expand-file-name prefix dir))
19071 (linkfile (format "%s_%s.png" prefix hash))
19072 (movefile (format "%s_%s.png" absprefix hash))
19073 (sep (and block-type "\n\n"))
19074 (link (concat sep "[[file:" linkfile "]]" sep))
19076 (org-combine-plists
19077 org-format-latex-options
19078 `(:foreground ,fg :background ,bg))))
19079 (when msg (message msg cnt))
19080 (unless checkdir-flag ; Ensure the directory exists.
19081 (setq checkdir-flag t)
19082 (let ((todir (file-name-directory absprefix)))
19083 (unless (file-directory-p todir)
19084 (make-directory todir t))))
19085 (unless (file-exists-p movefile)
19086 (org-create-formula-image
19087 value movefile options forbuffer processing-type))
19090 (dolist (o (overlays-in beg end))
19091 (when (eq (overlay-get o 'org-overlay-type)
19092 'org-latex-overlay)
19093 (delete-overlay o)))
19094 (let ((ov (make-overlay beg end)))
19097 'org-latex-overlay)
19098 (overlay-put ov 'evaporate t)
19099 (if (featurep 'xemacs)
19101 (overlay-put ov 'invisible t)
19105 (vector 'png :file movefile))))
19112 (push ov org-latex-fragment-image-overlays))
19114 (delete-region beg end)
19116 (org-add-props link
19117 (list 'org-latex-src
19118 (replace-regexp-in-string "\"" "" value)
19119 'org-latex-src-embed-type
19120 (if block-type 'paragraph 'character)))))))
19122 ;; Process to MathML.
19123 (unless (org-format-latex-mathml-available-p)
19124 (user-error "LaTeX to MathML converter not configured"))
19126 (when msg (message msg cnt))
19128 (delete-region beg end)
19129 (insert (org-format-latex-as-mathml
19130 value block-type prefix dir)))
19132 (error "Unknown conversion type %s for LaTeX fragments"
19133 processing-type)))))))))))
19135 (defun org-create-math-formula (latex-frag &optional mathml-file)
19136 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19137 Use `org-latex-to-mathml-convert-command'. If the conversion is
19138 sucessful, return the portion between \"<math...> </math>\"
19139 elements otherwise return nil. When MATHML-FILE is specified,
19140 write the results in to that file. When invoked as an
19141 interactive command, prompt for LATEX-FRAG, with initial value
19142 set to the current active region and echo the results for user
19144 (interactive (list (let ((frag (when (org-region-active-p)
19145 (buffer-substring-no-properties
19146 (region-beginning) (region-end)))))
19147 (read-string "LaTeX Fragment: " frag nil frag))))
19148 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19149 (let* ((tmp-in-file (file-relative-name
19150 (make-temp-name (expand-file-name "ltxmathml-in"))))
19151 (ignore (write-region latex-frag nil tmp-in-file))
19152 (tmp-out-file (file-relative-name
19153 (make-temp-name (expand-file-name "ltxmathml-out"))))
19155 org-latex-to-mathml-convert-command
19156 `((?j . ,(and org-latex-to-mathml-jar-file
19157 (shell-quote-argument
19159 org-latex-to-mathml-jar-file))))
19160 (?I . ,(shell-quote-argument tmp-in-file))
19162 (?o . ,(shell-quote-argument tmp-out-file)))))
19163 mathml shell-command-output)
19164 (when (org-called-interactively-p 'any)
19165 (unless (org-format-latex-mathml-available-p)
19166 (user-error "LaTeX to MathML converter not configured")))
19167 (message "Running %s" cmd)
19168 (setq shell-command-output (shell-command-to-string cmd))
19170 (when (file-readable-p tmp-out-file)
19171 (with-current-buffer (find-file-noselect tmp-out-file t)
19172 (goto-char (point-min))
19173 (when (re-search-forward
19176 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19181 (prog1 (match-string 0) (kill-buffer))))))
19185 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19187 (write-region mathml nil mathml-file))
19188 (when (org-called-interactively-p 'any)
19190 ((message "LaTeX to MathML conversion failed")
19191 (message shell-command-output)))
19192 (delete-file tmp-in-file)
19193 (when (file-exists-p tmp-out-file)
19194 (delete-file tmp-out-file))
19197 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19198 prefix &optional dir)
19199 "Use `org-create-math-formula' but check local cache first."
19200 (let* ((absprefix (expand-file-name prefix dir))
19201 (print-length nil) (print-level nil)
19202 (formula-id (concat
19207 org-latex-to-mathml-convert-command)))))
19208 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19209 (formula-cache-dir (file-name-directory formula-cache)))
19211 (unless (file-directory-p formula-cache-dir)
19212 (make-directory formula-cache-dir t))
19214 (unless (file-exists-p formula-cache)
19215 (org-create-math-formula latex-frag formula-cache))
19217 (if (file-exists-p formula-cache)
19218 ;; Successful conversion. Return the link to MathML file.
19220 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19221 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19222 'org-latex-src-embed-type (if latex-frag-type
19223 'paragraph 'character)))
19224 ;; Failed conversion. Return the LaTeX fragment verbatim
19227 (defun org-create-formula-image (string tofile options buffer &optional type)
19228 "Create an image from LaTeX source using dvipng or convert.
19229 This function calls either `org-create-formula-image-with-dvipng'
19230 or `org-create-formula-image-with-imagemagick' depending on the
19231 value of `org-latex-create-formula-image-program' or on the value
19232 of the optional TYPE variable.
19234 Note: ultimately these two function should be combined as they
19235 share a good deal of logic."
19236 (org-check-external-command
19237 "latex" "needed to convert LaTeX fragments to images")
19239 (case (or type org-latex-create-formula-image-program)
19241 (org-check-external-command
19242 "dvipng" "needed to convert LaTeX fragments to images")
19243 #'org-create-formula-image-with-dvipng)
19245 (org-check-external-command
19246 "convert" "you need to install imagemagick")
19247 #'org-create-formula-image-with-imagemagick)
19249 "Invalid value of `org-latex-create-formula-image-program'")))
19250 string tofile options buffer))
19252 (declare-function org-export-get-backend "ox" (name))
19253 (declare-function org-export--get-global-options "ox" (&optional backend))
19254 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19255 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19256 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19257 (defun org-create-formula--latex-header ()
19258 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19259 (let ((info (org-combine-plists (org-export--get-global-options
19260 (org-export-get-backend 'latex))
19261 (org-export--get-inbuffer-options
19262 (org-export-get-backend 'latex)))))
19263 (org-latex-guess-babel-language
19264 (org-latex-guess-inputenc
19265 (org-splice-latex-header
19266 org-format-latex-header
19267 org-latex-default-packages-alist
19268 org-latex-packages-alist t
19269 (plist-get info :latex-header)))
19272 (defun org--get-display-dpi ()
19273 "Get the DPI of the display.
19275 Assumes that the display has the same pixel width in the
19276 horizontal and vertical directions."
19277 (if (display-graphic-p)
19278 (round (/ (display-pixel-height)
19279 (/ (display-mm-height) 25.4)))
19280 (error "Attempt to calculate the dpi of a non-graphic display")))
19282 ;; This function borrows from Ganesh Swami's latex2png.el
19283 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19284 "This calls dvipng."
19285 (require 'ox-latex)
19286 (let* ((tmpdir (if (featurep 'xemacs)
19288 temporary-file-directory))
19289 (texfilebase (make-temp-name
19290 (expand-file-name "orgtex" tmpdir)))
19291 (texfile (concat texfilebase ".tex"))
19292 (dvifile (concat texfilebase ".dvi"))
19293 (pngfile (concat texfilebase ".png"))
19294 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19295 ;; This assumes that the display has the same pixel width in
19296 ;; the horizontal and vertical directions
19297 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19298 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19300 (bg (or (plist-get options (if buffer :background :html-background))
19302 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19303 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19304 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19305 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19306 (let ((latex-header (org-create-formula--latex-header)))
19307 (with-temp-file texfile
19308 (insert latex-header)
19309 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19310 (let ((dir default-directory))
19313 (call-process "latex" nil nil nil texfile))
19315 (if (not (file-exists-p dvifile))
19316 (progn (message "Failed to create dvi file from %s" texfile) nil)
19318 (if (featurep 'xemacs)
19319 (call-process "dvipng" nil nil nil
19324 (call-process "dvipng" nil nil nil
19327 ;;"-x" scale "-y" scale
19331 (if (not (file-exists-p pngfile))
19332 (if org-format-latex-signal-error
19333 (error "Failed to create png file from %s" texfile)
19334 (message "Failed to create png file from %s" texfile)
19336 ;; Use the requested file name and clean up
19337 (copy-file pngfile tofile 'replace)
19338 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19339 (if (file-exists-p (concat texfilebase e))
19340 (delete-file (concat texfilebase e))))
19343 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19344 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19345 "This calls convert, which is included into imagemagick."
19346 (require 'ox-latex)
19347 (let* ((tmpdir (if (featurep 'xemacs)
19349 temporary-file-directory))
19350 (texfilebase (make-temp-name
19351 (expand-file-name "orgtex" tmpdir)))
19352 (texfile (concat texfilebase ".tex"))
19353 (pdffile (concat texfilebase ".pdf"))
19354 (pngfile (concat texfilebase ".png"))
19355 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19356 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19357 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19359 (bg (or (plist-get options (if buffer :background :html-background))
19361 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19362 (setq fg (org-latex-color-format fg)))
19363 (if (eq bg 'default) (setq bg (org-latex-color :background))
19364 (setq bg (org-latex-color-format
19365 (if (string= bg "Transparent") "white" bg))))
19366 (let ((latex-header (org-create-formula--latex-header)))
19367 (with-temp-file texfile
19368 (insert latex-header)
19369 (insert "\n\\begin{document}\n"
19370 "\\definecolor{fg}{rgb}{" fg "}\n"
19371 "\\definecolor{bg}{rgb}{" bg "}\n"
19372 "\n\\pagecolor{bg}\n"
19376 "\n\\end{document}\n")))
19377 (org-latex-compile texfile t)
19378 (if (not (file-exists-p pdffile))
19379 (progn (message "Failed to create pdf file from %s" texfile) nil)
19381 (if (featurep 'xemacs)
19382 (call-process "convert" nil nil nil
19388 ;; "-sharpen" "0x1.0"
19390 (call-process "convert" nil nil nil
19396 ;; "-sharpen" "0x1.0"
19398 (if (not (file-exists-p pngfile))
19399 (if org-format-latex-signal-error
19400 (error "Failed to create png file from %s" texfile)
19401 (message "Failed to create png file from %s" texfile)
19403 ;; Use the requested file name and clean up
19404 (copy-file pngfile tofile 'replace)
19405 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19406 (if (file-exists-p (concat texfilebase e))
19407 (delete-file (concat texfilebase e))))
19410 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19411 "Fill a LaTeX header template TPL.
19412 In the template, the following place holders will be recognized:
19414 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19415 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19416 [PACKAGES] \\usepackage statements for PKG
19417 [NO-PACKAGES] do not include PKG
19418 [EXTRA] the string EXTRA
19419 [NO-EXTRA] do not include EXTRA
19421 For backward compatibility, if both the positive and the negative place
19422 holder is missing, the positive one (without the \"NO-\") will be
19423 assumed to be present at the end of the template.
19424 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19426 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19427 (let (rpl (end ""))
19428 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19429 (setq rpl (if (or (match-end 1) (not def-pkg))
19430 "" (org-latex-packages-to-string def-pkg snippets-p t))
19431 tpl (replace-match rpl t t tpl))
19432 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19434 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19435 (setq rpl (if (or (match-end 1) (not pkg))
19436 "" (org-latex-packages-to-string pkg snippets-p t))
19437 tpl (replace-match rpl t t tpl))
19440 (org-latex-packages-to-string pkg snippets-p)))))
19442 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19443 (setq rpl (if (or (match-end 1) (not extra))
19444 "" (concat extra "\n"))
19445 tpl (replace-match rpl t t tpl))
19446 (if (and extra (string-match "\\S-" extra))
19447 (setq end (concat end "\n" extra))))
19449 (if (string-match "\\S-" end)
19450 (concat tpl "\n" end)
19453 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19454 "Turn an alist of packages into a string with the \\usepackage macros."
19455 (setq pkg (mapconcat (lambda(p)
19458 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19459 (format "%% Package %s omitted" (cadr p)))
19460 ((equal "" (car p))
19461 (format "\\usepackage{%s}" (cadr p)))
19463 (format "\\usepackage[%s]{%s}"
19464 (car p) (cadr p)))))
19467 (if newline (concat pkg "\n") pkg))
19469 (defun org-dvipng-color (attr)
19470 "Return a RGB color specification for dvipng."
19471 (apply 'format "rgb %s %s %s"
19472 (mapcar 'org-normalize-color
19473 (if (featurep 'xemacs)
19474 (color-rgb-components
19475 (face-property 'default
19476 (cond ((eq attr :foreground) 'foreground)
19477 ((eq attr :background) 'background))))
19478 (color-values (face-attribute 'default attr nil))))))
19480 (defun org-dvipng-color-format (color-name)
19481 "Convert COLOR-NAME to a RGB color value for dvipng."
19482 (apply 'format "rgb %s %s %s"
19483 (mapcar 'org-normalize-color
19484 (color-values color-name))))
19486 (defun org-latex-color (attr)
19487 "Return a RGB color for the LaTeX color package."
19488 (apply 'format "%s,%s,%s"
19489 (mapcar 'org-normalize-color
19490 (if (featurep 'xemacs)
19491 (color-rgb-components
19492 (face-property 'default
19493 (cond ((eq attr :foreground) 'foreground)
19494 ((eq attr :background) 'background))))
19495 (color-values (face-attribute 'default attr nil))))))
19497 (defun org-latex-color-format (color-name)
19498 "Convert COLOR-NAME to a RGB color value."
19499 (apply 'format "%s,%s,%s"
19500 (mapcar 'org-normalize-color
19501 (color-values color-name))))
19503 (defun org-normalize-color (value)
19504 "Return string to be used as color value for an RGB component."
19505 (format "%g" (/ value 65535.0)))
19511 (defvar org-inline-image-overlays nil)
19512 (make-variable-buffer-local 'org-inline-image-overlays)
19514 (defun org-toggle-inline-images (&optional include-linked)
19515 "Toggle the display of inline images.
19516 INCLUDE-LINKED is passed to `org-display-inline-images'."
19518 (if org-inline-image-overlays
19520 (org-remove-inline-images)
19521 (when (org-called-interactively-p 'interactive)
19522 (message "Inline image display turned off")))
19523 (org-display-inline-images include-linked)
19524 (when (org-called-interactively-p 'interactive)
19525 (message (if org-inline-image-overlays
19526 (format "%d images displayed inline"
19527 (length org-inline-image-overlays))
19528 "No images to display inline")))))
19530 (defun org-redisplay-inline-images ()
19531 "Refresh the display of inline images."
19533 (if (not org-inline-image-overlays)
19534 (org-toggle-inline-images)
19535 (org-toggle-inline-images)
19536 (org-toggle-inline-images)))
19538 (defun org-display-inline-images (&optional include-linked refresh beg end)
19539 "Display inline images.
19541 An inline image is a link which follows either of these
19544 1. Its path is a file with an extension matching return value
19545 from `image-file-name-regexp' and it has no contents.
19547 2. Its description consists in a single link of the previous
19550 When optional argument INCLUDE-LINKED is non-nil, also links with
19551 a text description part will be inlined. This can be nice for
19552 a quick look at those images, but it does not reflect what
19553 exported files will look like.
19555 When optional argument REFRESH is non-nil, refresh existing
19556 images between BEG and END. This will create new image displays
19557 only if necessary. BEG and END default to the buffer
19560 (when (display-graphic-p)
19562 (org-remove-inline-images)
19563 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19564 (org-with-wide-buffer
19565 (goto-char (or beg (point-min)))
19566 (let ((case-fold-search t)
19567 (file-extension-re (org-image-file-name-regexp)))
19568 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19569 (let ((link (save-match-data (org-element-context))))
19570 ;; Check if we're at an inline image.
19571 (when (and (equal (org-element-property :type link) "file")
19573 (not (org-element-property :contents-begin link)))
19574 (let ((parent (org-element-property :parent link)))
19575 (or (not (eq (org-element-type parent) 'link))
19576 (not (cdr (org-element-contents parent)))))
19577 (org-string-match-p file-extension-re
19578 (org-element-property :path link)))
19579 (let ((file (expand-file-name
19581 (org-element-property :path link)))))
19582 (when (file-exists-p file)
19584 ;; Apply `org-image-actual-width' specifications.
19586 ((not (image-type-available-p 'imagemagick)) nil)
19587 ((eq org-image-actual-width t) nil)
19588 ((listp org-image-actual-width)
19590 ;; First try to find a width among
19591 ;; attributes associated to the paragraph
19592 ;; containing link.
19595 (while (and (setq e (org-element-property
19597 (not (eq (org-element-type e)
19602 (goto-char (org-element-property :begin paragraph))
19605 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19606 (org-element-property
19607 :post-affiliated paragraph)
19609 (string-to-number (match-string 1))))))
19610 ;; Otherwise, fall-back to provided number.
19611 (car org-image-actual-width)))
19612 ((numberp org-image-actual-width)
19613 org-image-actual-width)))
19614 (old (get-char-property-and-overlay
19615 (org-element-property :begin link)
19616 'org-image-overlay)))
19617 (if (and (car-safe old) refresh)
19618 (image-refresh (overlay-get (cdr old) 'display))
19619 (let ((image (create-image file
19620 (and width 'imagemagick)
19625 ;; If inline image is the description
19626 ;; of another link, be sure to
19627 ;; consider the latter as the one to
19628 ;; apply the overlay on.
19630 (org-element-property :parent link)))
19631 (if (eq (org-element-type parent) 'link)
19635 (org-element-property :begin link)
19638 (org-element-property :end link))
19639 (skip-chars-backward " \t")
19641 (overlay-put ov 'display image)
19642 (overlay-put ov 'face 'default)
19643 (overlay-put ov 'org-image-overlay t)
19645 ov 'modification-hooks
19646 (list 'org-display-inline-remove-overlay))
19647 (push ov org-inline-image-overlays)))))))))))))))
19649 (define-obsolete-function-alias
19650 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19652 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19653 "Remove inline-display overlay if a corresponding region is modified."
19654 (let ((inhibit-modification-hooks t))
19655 (when (and ov after)
19656 (delete ov org-inline-image-overlays)
19657 (delete-overlay ov))))
19659 (defun org-remove-inline-images ()
19660 "Remove inline display of images."
19662 (mapc 'delete-overlay org-inline-image-overlays)
19663 (setq org-inline-image-overlays nil))
19667 ;; Outline functions from `outline-mode-prefix-map'
19668 ;; that can be remapped in Org:
19669 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19670 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19671 (define-key org-mode-map [remap outline-forward-same-level]
19672 'org-forward-heading-same-level)
19673 (define-key org-mode-map [remap outline-backward-same-level]
19674 'org-backward-heading-same-level)
19675 (define-key org-mode-map [remap show-branches]
19676 'org-kill-note-or-show-branches)
19677 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19678 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19679 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19680 (define-key org-mode-map [remap outline-next-visible-heading]
19681 'org-next-visible-heading)
19682 (define-key org-mode-map [remap outline-previous-visible-heading]
19683 'org-previous-visible-heading)
19685 ;; Outline functions from `outline-mode-prefix-map' that can not
19686 ;; be remapped in Org:
19688 ;; - the column "key binding" shows whether the Outline function is still
19689 ;; available in Org mode on the same key that it has been bound to in
19691 ;; - "overridden": key used for a different functionality in Org mode
19692 ;; - else: key still bound to the same Outline function in Org mode
19694 ;; | Outline function | key binding | Org replacement |
19695 ;; |------------------------------------+-------------+--------------------------|
19696 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19697 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19698 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19699 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19700 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19701 ;; | `show-entry' | overridden | no replacement |
19702 ;; | `show-children' | `C-c C-i' | visibility cycling |
19703 ;; | `show-branches' | `C-c C-k' | still same function |
19704 ;; | `show-subtree' | overridden | visibility cycling |
19705 ;; | `show-all' | overridden | no replacement |
19706 ;; | `hide-subtree' | overridden | visibility cycling |
19707 ;; | `hide-body' | overridden | no replacement |
19708 ;; | `hide-entry' | overridden | visibility cycling |
19709 ;; | `hide-leaves' | overridden | no replacement |
19710 ;; | `hide-sublevels' | overridden | no replacement |
19711 ;; | `hide-other' | overridden | no replacement |
19713 ;; Make `C-c C-x' a prefix key
19714 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19716 ;; TAB key with modifiers
19717 (org-defkey org-mode-map "\C-i" 'org-cycle)
19718 (org-defkey org-mode-map [(tab)] 'org-cycle)
19719 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19720 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19721 ;; The following line is necessary under Suse GNU/Linux
19722 (unless (featurep 'xemacs)
19723 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19724 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19725 (define-key org-mode-map [backtab] 'org-shifttab)
19727 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19728 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19729 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19731 ;; Cursor keys with modifiers
19732 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19733 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19734 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19735 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19737 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19738 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19739 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19740 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19741 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19742 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19744 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19745 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19746 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19747 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19749 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19750 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19751 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19752 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19755 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19756 (mapc (lambda (pair)
19757 (define-key org-babel-map (car pair) (cdr pair)))
19758 org-babel-key-bindings)
19760 ;;; Extra keys for tty access.
19761 ;; We only set them when really needed because otherwise the
19762 ;; menus don't show the simple keys
19764 (when (or org-use-extra-keys
19765 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19766 (not window-system))
19767 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19768 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19769 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19770 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19771 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19772 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19773 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19774 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19775 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19776 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19777 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19778 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19779 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19780 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19781 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19782 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19783 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19784 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19785 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19786 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19787 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19788 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19789 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19790 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19791 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19792 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19793 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19794 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19796 ;; All the other keys
19798 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19799 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19800 (if (boundp 'narrow-map)
19801 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19802 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19803 (if (boundp 'narrow-map)
19804 (org-defkey narrow-map "b" 'org-narrow-to-block)
19805 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19806 (if (boundp 'narrow-map)
19807 (org-defkey narrow-map "e" 'org-narrow-to-element)
19808 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19809 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19810 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19811 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19812 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19813 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19814 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19815 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19816 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19817 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19818 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19819 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19820 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19821 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19822 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19823 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19824 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19825 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19826 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19827 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19828 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19829 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19830 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19831 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19832 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19833 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19834 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19835 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19836 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19837 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19838 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19839 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19840 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19841 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19842 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19843 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19844 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19845 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19846 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19847 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19848 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19849 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19850 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19851 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19852 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19853 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19854 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19855 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19856 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19857 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19858 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19859 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19860 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19861 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19862 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19863 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19864 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19865 (org-defkey org-mode-map "\C-c^" 'org-sort)
19866 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19867 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19868 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19869 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19870 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19871 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19872 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19873 (org-defkey org-mode-map "\M-^" 'org-delete-indentation)
19874 (org-defkey org-mode-map "\C-m" 'org-return)
19875 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19876 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19877 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19878 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19879 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19880 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19881 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19882 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19883 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19884 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19885 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19886 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19887 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19888 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19889 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19890 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19891 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19892 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19893 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19894 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19895 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19896 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19897 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19898 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19899 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19901 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19902 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19903 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19905 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19906 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19907 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19908 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19909 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19910 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19911 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19912 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19913 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19914 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19915 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19916 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19917 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19918 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19919 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19920 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19921 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19922 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19923 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19924 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19925 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19926 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19928 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19929 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19930 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19931 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19932 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19934 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19936 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19938 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19939 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19941 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19944 (when (featurep 'xemacs)
19945 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19948 (defconst org-speed-commands-default
19950 ("Outline Navigation")
19951 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19952 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19953 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19954 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19955 ("F" . org-next-block)
19956 ("B" . org-previous-block)
19957 ("u" . (org-speed-move-safe 'outline-up-heading))
19959 ("g" . (org-refile t))
19960 ("Outline Visibility")
19962 ("C" . org-shifttab)
19963 (" " . org-display-outline-path)
19964 ("s" . org-narrow-to-subtree)
19965 ("=" . org-columns)
19966 ("Outline Structure Editing")
19968 ("D" . org-metadown)
19969 ("r" . org-metaright)
19970 ("l" . org-metaleft)
19971 ("R" . org-shiftmetaright)
19972 ("L" . org-shiftmetaleft)
19973 ("i" . (progn (forward-char 1) (call-interactively
19974 'org-insert-heading-respect-content)))
19977 ("a" . org-archive-subtree-default-with-confirmation)
19978 ("@" . org-mark-subtree)
19979 ("#" . org-toggle-comment)
19981 ("I" . org-clock-in)
19982 ("O" . org-clock-out)
19983 ("Meta Data Editing")
19985 ("," . (org-priority))
19986 ("0" . (org-priority ?\ ))
19987 ("1" . (org-priority ?A))
19988 ("2" . (org-priority ?B))
19989 ("3" . (org-priority ?C))
19990 (":" . org-set-tags-command)
19991 ("e" . org-set-effort)
19992 ("E" . org-inc-effort)
19993 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19994 (org-entry-put (point) "APPT_WARNTIME" m)))
19995 ("Agenda Views etc")
19997 ("/" . org-sparse-tree)
19999 ("o" . org-open-at-point)
20000 ("?" . org-speed-command-help)
20001 ("<" . (org-agenda-set-restriction-lock 'subtree))
20002 (">" . (org-agenda-remove-restriction-lock))
20004 "The default speed commands.")
20006 (defun org-print-speed-command (e)
20007 (if (> (length (car e)) 1)
20012 (princ (make-string (length (car e)) ?-))
20016 (if (symbolp (cdr e))
20017 (princ (symbol-name (cdr e)))
20021 (defun org-speed-command-help ()
20022 "Show the available speed commands."
20024 (if (not org-use-speed-commands)
20025 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
20026 (with-output-to-temp-buffer "*Help*"
20027 (princ "User-defined Speed commands\n===========================\n")
20028 (mapc 'org-print-speed-command org-speed-commands-user)
20030 (princ "Built-in Speed commands\n=======================\n")
20031 (mapc 'org-print-speed-command org-speed-commands-default))
20032 (with-current-buffer "*Help*"
20033 (setq truncate-lines t))))
20035 (defun org-speed-move-safe (cmd)
20036 "Execute CMD, but make sure that the cursor always ends up in a headline.
20037 If not, return to the original position and throw an error."
20039 (let ((pos (point)))
20040 (call-interactively cmd)
20041 (unless (and (bolp) (org-at-heading-p))
20043 (error "Boundary reached while executing %s" cmd))))
20045 (defvar org-self-insert-command-undo-counter 0)
20047 (defvar org-table-auto-blank-field) ; defined in org-table.el
20048 (defvar org-speed-command nil)
20050 (define-obsolete-function-alias
20051 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20053 (defun org-speed-command-activate (keys)
20054 "Hook for activating single-letter speed commands.
20055 `org-speed-commands-default' specifies a minimal command set.
20056 Use `org-speed-commands-user' for further customization."
20057 (when (or (and (bolp) (looking-at org-outline-regexp))
20058 (and (functionp org-use-speed-commands)
20059 (funcall org-use-speed-commands)))
20060 (cdr (assoc keys (append org-speed-commands-user
20061 org-speed-commands-default)))))
20063 (define-obsolete-function-alias
20064 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20066 (defun org-babel-speed-command-activate (keys)
20067 "Hook for activating single-letter code block commands."
20068 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20069 (cdr (assoc keys org-babel-key-bindings))))
20071 (defcustom org-speed-command-hook
20072 '(org-speed-command-default-hook org-babel-speed-command-hook)
20073 "Hook for activating speed commands at strategic locations.
20074 Hook functions are called in sequence until a valid handler is
20077 Each hook takes a single argument, a user-pressed command key
20078 which is also a `self-insert-command' from the global map.
20080 Within the hook, examine the cursor position and the command key
20081 and return nil or a valid handler as appropriate. Handler could
20082 be one of an interactive command, a function, or a form.
20084 Set `org-use-speed-commands' to non-nil value to enable this
20085 hook. The default setting is `org-speed-command-activate'."
20086 :group 'org-structure
20090 (defun org-self-insert-command (N)
20091 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20092 If the cursor is in a table looking at whitespace, the whitespace is
20093 overwritten, and the table is not marked as requiring realignment."
20095 (org-check-before-invisible-edit 'insert)
20097 ((and org-use-speed-commands
20098 (let ((kv (this-command-keys-vector)))
20099 (setq org-speed-command
20100 (run-hook-with-args-until-success
20101 'org-speed-command-hook
20102 (make-string 1 (aref kv (1- (length kv))))))))
20104 ((commandp org-speed-command)
20105 (setq this-command org-speed-command)
20106 (call-interactively org-speed-command))
20107 ((functionp org-speed-command)
20108 (funcall org-speed-command))
20109 ((and org-speed-command (listp org-speed-command))
20110 (eval org-speed-command))
20111 (t (let (org-use-speed-commands)
20112 (call-interactively 'org-self-insert-command)))))
20116 ;; check if we blank the field, and if that triggers align
20117 (and (featurep 'org-table) org-table-auto-blank-field
20119 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20120 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20121 ;; got extra space, this field does not determine column width
20122 (let (org-table-may-need-update) (org-table-blank-field))
20123 ;; no extra space, this field may determine column width
20124 (org-table-blank-field)))
20127 (looking-at "[^|\n]* |"))
20128 (let (org-table-may-need-update)
20129 (goto-char (1- (match-end 0)))
20130 (backward-delete-char 1)
20131 (goto-char (match-beginning 0))
20132 (self-insert-command N)))
20134 (setq org-table-may-need-update t)
20135 (self-insert-command N)
20136 (org-fix-tags-on-the-fly)
20137 (if org-self-insert-cluster-for-undo
20138 (if (not (eq last-command 'org-self-insert-command))
20139 (setq org-self-insert-command-undo-counter 1)
20140 (if (>= org-self-insert-command-undo-counter 20)
20141 (setq org-self-insert-command-undo-counter 1)
20142 (and (> org-self-insert-command-undo-counter 0)
20143 buffer-undo-list (listp buffer-undo-list)
20144 (not (cadr buffer-undo-list)) ; remove nil entry
20145 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20146 (setq org-self-insert-command-undo-counter
20147 (1+ org-self-insert-command-undo-counter))))))))
20149 (defun org-check-before-invisible-edit (kind)
20150 "Check is editing if kind KIND would be dangerous with invisible text around.
20151 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20152 ;; First, try to get out of here as quickly as possible, to reduce overhead
20153 (if (and org-catch-invisible-edits
20154 (or (not (boundp 'visible-mode)) (not visible-mode))
20155 (or (get-char-property (point) 'invisible)
20156 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20157 ;; OK, we need to take a closer look
20158 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20159 (invisible-before-point (if (bobp) nil (get-char-property
20160 (1- (point)) 'invisible)))
20161 (border-and-ok-direction
20163 ;; Check if we are acting predictably before invisible text
20164 (and invisible-at-point (not invisible-before-point)
20165 (memq kind '(insert delete-backward)))
20166 ;; Check if we are acting predictably after invisible text
20167 ;; This works not well, and I have turned it off. It seems
20168 ;; better to always show and stop after invisible text.
20169 ;; (and (not invisible-at-point) invisible-before-point
20170 ;; (memq kind '(insert delete)))
20172 (when (or (memq invisible-at-point '(outline org-hide-block t))
20173 (memq invisible-before-point '(outline org-hide-block t)))
20174 (if (eq org-catch-invisible-edits 'error)
20175 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20176 (if (and org-custom-properties-overlays
20177 (y-or-n-p "Display invisible properties in this buffer? "))
20178 (org-toggle-custom-properties-visibility)
20179 ;; Make the area visible
20181 (if invisible-before-point
20182 (goto-char (previous-single-char-property-change
20183 (point) 'invisible)))
20186 ((eq org-catch-invisible-edits 'show)
20187 ;; That's it, we do the edit after showing
20189 "Unfolding invisible region around point before editing")
20191 ((and (eq org-catch-invisible-edits 'smart)
20192 border-and-ok-direction)
20193 (message "Unfolding invisible region around point before editing"))
20195 ;; Don't do the edit, make the user repeat it in full visibility
20196 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20198 (defun org-fix-tags-on-the-fly ()
20199 (when (and (equal (char-after (point-at-bol)) ?*)
20200 (org-at-heading-p))
20201 (org-align-tags-here org-tags-column)))
20203 (defun org-delete-backward-char (N)
20204 "Like `delete-backward-char', insert whitespace at field end in tables.
20205 When deleting backwards, in tables this function will insert whitespace in
20206 front of the next \"|\" separator, to keep the table aligned. The table will
20207 still be marked for re-alignment if the field did fill the entire column,
20208 because, in this case the deletion might narrow the column."
20211 (org-check-before-invisible-edit 'delete-backward)
20212 (if (and (org-table-p)
20214 (string-match "|" (buffer-substring (point-at-bol) (point)))
20215 (looking-at ".*?|"))
20216 (let ((pos (point))
20217 (noalign (looking-at "[^|\n\r]* |"))
20218 (c org-table-may-need-update))
20219 (backward-delete-char N)
20220 (if (not overwrite-mode)
20222 (skip-chars-forward "^|")
20224 (goto-char (1- pos))))
20225 ;; noalign: if there were two spaces at the end, this field
20226 ;; does not determine the width of the column.
20227 (if noalign (setq org-table-may-need-update c)))
20228 (backward-delete-char N)
20229 (org-fix-tags-on-the-fly))))
20231 (defun org-delete-char (N)
20232 "Like `delete-char', but insert whitespace at field end in tables.
20233 When deleting characters, in tables this function will insert whitespace in
20234 front of the next \"|\" separator, to keep the table aligned. The table will
20235 still be marked for re-alignment if the field did fill the entire column,
20236 because, in this case the deletion might narrow the column."
20239 (org-check-before-invisible-edit 'delete)
20240 (if (and (org-table-p)
20242 (not (= (char-after) ?|))
20244 (if (looking-at ".*?|")
20245 (let ((pos (point))
20246 (noalign (looking-at "[^|\n\r]* |"))
20247 (c org-table-may-need-update))
20249 (concat (substring (match-string 0) 1 -1) " |") nil t)
20251 ;; noalign: if there were two spaces at the end, this field
20252 ;; does not determine the width of the column.
20253 (if noalign (setq org-table-may-need-update c)))
20256 (org-fix-tags-on-the-fly))))
20258 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20259 (put 'org-self-insert-command 'delete-selection
20261 (not (run-hook-with-args-until-success
20262 'self-insert-uses-region-functions))))
20263 (put 'orgtbl-self-insert-command 'delete-selection
20265 (not (run-hook-with-args-until-success
20266 'self-insert-uses-region-functions))))
20267 (put 'org-delete-char 'delete-selection 'supersede)
20268 (put 'org-delete-backward-char 'delete-selection 'supersede)
20269 (put 'org-yank 'delete-selection 'yank)
20271 ;; Make `flyspell-mode' delay after some commands
20272 (put 'org-self-insert-command 'flyspell-delayed t)
20273 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20274 (put 'org-delete-char 'flyspell-delayed t)
20275 (put 'org-delete-backward-char 'flyspell-delayed t)
20277 ;; Make pabbrev-mode expand after org-mode commands
20278 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20279 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20281 (defun org-remap (map &rest commands)
20282 "In MAP, remap the functions given in COMMANDS.
20283 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20286 (setq old (pop commands) new (pop commands))
20287 (if (fboundp 'command-remapping)
20288 (org-defkey map (vector 'remap old) new)
20289 (substitute-key-definition old new map global-map)))))
20291 (defun org-transpose-words ()
20292 "Transpose words for Org.
20293 This uses the `org-mode-transpose-word-syntax-table' syntax
20294 table, which interprets characters in `org-emphasis-alist' as
20295 word constituents."
20297 (with-syntax-table org-mode-transpose-word-syntax-table
20298 (call-interactively 'transpose-words)))
20299 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20301 (when (eq org-enable-table-editor 'optimized)
20302 ;; If the user wants maximum table support, we need to hijack
20303 ;; some standard editing functions
20304 (org-remap org-mode-map
20305 'self-insert-command 'org-self-insert-command
20306 'delete-char 'org-delete-char
20307 'delete-backward-char 'org-delete-backward-char)
20308 (org-defkey org-mode-map "|" 'org-force-self-insert))
20310 (defvar org-ctrl-c-ctrl-c-hook nil
20311 "Hook for functions attaching themselves to `C-c C-c'.
20313 This can be used to add additional functionality to the C-c C-c
20314 key which executes context-dependent commands. This hook is run
20315 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20316 run after the last test.
20318 Each function will be called with no arguments. The function
20319 must check if the context is appropriate for it to act. If yes,
20320 it should do its thing and then return a non-nil value. If the
20321 context is wrong, just do nothing and return nil.")
20323 (defvar org-ctrl-c-ctrl-c-final-hook nil
20324 "Hook for functions attaching themselves to `C-c C-c'.
20326 This can be used to add additional functionality to the C-c C-c
20327 key which executes context-dependent commands. This hook is run
20328 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20329 before the first test.
20331 Each function will be called with no arguments. The function
20332 must check if the context is appropriate for it to act. If yes,
20333 it should do its thing and then return a non-nil value. If the
20334 context is wrong, just do nothing and return nil.")
20336 (defvar org-tab-first-hook nil
20337 "Hook for functions to attach themselves to TAB.
20338 See `org-ctrl-c-ctrl-c-hook' for more information.
20339 This hook runs as the first action when TAB is pressed, even before
20340 `org-cycle' messes around with the `outline-regexp' to cater for
20341 inline tasks and plain list item folding.
20342 If any function in this hook returns t, any other actions that
20343 would have been caused by TAB (such as table field motion or visibility
20344 cycling) will not occur.")
20346 (defvar org-tab-after-check-for-table-hook nil
20347 "Hook for functions to attach themselves to TAB.
20348 See `org-ctrl-c-ctrl-c-hook' for more information.
20349 This hook runs after it has been established that the cursor is not in a
20350 table, but before checking if the cursor is in a headline or if global cycling
20352 If any function in this hook returns t, not other actions like visibility
20353 cycling will be done.")
20355 (defvar org-tab-after-check-for-cycling-hook nil
20356 "Hook for functions to attach themselves to TAB.
20357 See `org-ctrl-c-ctrl-c-hook' for more information.
20358 This hook runs after it has been established that not table field motion and
20359 not visibility should be done because of current context. This is probably
20360 the place where a package like yasnippets can hook in.")
20362 (defvar org-tab-before-tab-emulation-hook nil
20363 "Hook for functions to attach themselves to TAB.
20364 See `org-ctrl-c-ctrl-c-hook' for more information.
20365 This hook runs after every other options for TAB have been exhausted, but
20366 before indentation and \t insertion takes place.")
20368 (defvar org-metaleft-hook nil
20369 "Hook for functions attaching themselves to `M-left'.
20370 See `org-ctrl-c-ctrl-c-hook' for more information.")
20371 (defvar org-metaright-hook nil
20372 "Hook for functions attaching themselves to `M-right'.
20373 See `org-ctrl-c-ctrl-c-hook' for more information.")
20374 (defvar org-metaup-hook nil
20375 "Hook for functions attaching themselves to `M-up'.
20376 See `org-ctrl-c-ctrl-c-hook' for more information.")
20377 (defvar org-metadown-hook nil
20378 "Hook for functions attaching themselves to `M-down'.
20379 See `org-ctrl-c-ctrl-c-hook' for more information.")
20380 (defvar org-shiftmetaleft-hook nil
20381 "Hook for functions attaching themselves to `M-S-left'.
20382 See `org-ctrl-c-ctrl-c-hook' for more information.")
20383 (defvar org-shiftmetaright-hook nil
20384 "Hook for functions attaching themselves to `M-S-right'.
20385 See `org-ctrl-c-ctrl-c-hook' for more information.")
20386 (defvar org-shiftmetaup-hook nil
20387 "Hook for functions attaching themselves to `M-S-up'.
20388 See `org-ctrl-c-ctrl-c-hook' for more information.")
20389 (defvar org-shiftmetadown-hook nil
20390 "Hook for functions attaching themselves to `M-S-down'.
20391 See `org-ctrl-c-ctrl-c-hook' for more information.")
20392 (defvar org-metareturn-hook nil
20393 "Hook for functions attaching themselves to `M-RET'.
20394 See `org-ctrl-c-ctrl-c-hook' for more information.")
20395 (defvar org-shiftup-hook nil
20396 "Hook for functions attaching themselves to `S-up'.
20397 See `org-ctrl-c-ctrl-c-hook' for more information.")
20398 (defvar org-shiftup-final-hook nil
20399 "Hook for functions attaching themselves to `S-up'.
20400 This one runs after all other options except shift-select have been excluded.
20401 See `org-ctrl-c-ctrl-c-hook' for more information.")
20402 (defvar org-shiftdown-hook nil
20403 "Hook for functions attaching themselves to `S-down'.
20404 See `org-ctrl-c-ctrl-c-hook' for more information.")
20405 (defvar org-shiftdown-final-hook nil
20406 "Hook for functions attaching themselves to `S-down'.
20407 This one runs after all other options except shift-select have been excluded.
20408 See `org-ctrl-c-ctrl-c-hook' for more information.")
20409 (defvar org-shiftleft-hook nil
20410 "Hook for functions attaching themselves to `S-left'.
20411 See `org-ctrl-c-ctrl-c-hook' for more information.")
20412 (defvar org-shiftleft-final-hook nil
20413 "Hook for functions attaching themselves to `S-left'.
20414 This one runs after all other options except shift-select have been excluded.
20415 See `org-ctrl-c-ctrl-c-hook' for more information.")
20416 (defvar org-shiftright-hook nil
20417 "Hook for functions attaching themselves to `S-right'.
20418 See `org-ctrl-c-ctrl-c-hook' for more information.")
20419 (defvar org-shiftright-final-hook nil
20420 "Hook for functions attaching themselves to `S-right'.
20421 This one runs after all other options except shift-select have been excluded.
20422 See `org-ctrl-c-ctrl-c-hook' for more information.")
20424 (defun org-modifier-cursor-error ()
20425 "Throw an error, a modified cursor command was applied in wrong context."
20426 (user-error "This command is active in special context like tables, headlines or items"))
20428 (defun org-shiftselect-error ()
20429 "Throw an error because Shift-Cursor command was applied in wrong context."
20430 (if (and (boundp 'shift-select-mode) shift-select-mode)
20431 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20432 (user-error "This command works only in special context like headlines or timestamps")))
20434 (defun org-call-for-shift-select (cmd)
20435 (let ((this-command-keys-shift-translated t))
20436 (call-interactively cmd)))
20438 (defun org-shifttab (&optional arg)
20439 "Global visibility cycling or move to previous table field.
20440 Call `org-table-previous-field' within a table.
20441 When ARG is nil, cycle globally through visibility states.
20442 When ARG is a numeric prefix, show contents of this level."
20445 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20447 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20448 (message "Content view to level: %d" arg)
20449 (org-content (prefix-numeric-value arg2))
20450 (org-cycle-show-empty-lines t)
20451 (setq org-cycle-global-status 'overview)))
20452 (t (call-interactively 'org-global-cycle))))
20454 (defun org-shiftmetaleft ()
20455 "Promote subtree or delete table column.
20456 Calls `org-promote-subtree', `org-outdent-item-tree', or
20457 `org-table-delete-column', depending on context. See the
20458 individual commands for more information."
20461 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20462 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20463 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20464 ((if (not (org-region-active-p)) (org-at-item-p)
20465 (save-excursion (goto-char (region-beginning))
20467 (call-interactively 'org-outdent-item-tree))
20468 (t (org-modifier-cursor-error))))
20470 (defun org-shiftmetaright ()
20471 "Demote subtree or insert table column.
20472 Calls `org-demote-subtree', `org-indent-item-tree', or
20473 `org-table-insert-column', depending on context. See the
20474 individual commands for more information."
20477 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20478 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20479 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20480 ((if (not (org-region-active-p)) (org-at-item-p)
20481 (save-excursion (goto-char (region-beginning))
20483 (call-interactively 'org-indent-item-tree))
20484 (t (org-modifier-cursor-error))))
20486 (defun org-shiftmetaup (&optional arg)
20487 "Drag the line at point up.
20488 In a table, kill the current row.
20489 On a clock timestamp, update the value of the timestamp like `S-<up>'
20490 but also adjust the previous clocked item in the clock history.
20491 Everywhere else, drag the line at point up."
20494 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20495 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20496 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20497 (call-interactively 'org-timestamp-up)))
20498 (t (call-interactively 'org-drag-line-backward))))
20500 (defun org-shiftmetadown (&optional arg)
20501 "Drag the line at point down.
20502 In a table, insert an empty row at the current line.
20503 On a clock timestamp, update the value of the timestamp like `S-<down>'
20504 but also adjust the previous clocked item in the clock history.
20505 Everywhere else, drag the line at point down."
20508 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20509 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20510 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20511 (call-interactively 'org-timestamp-down)))
20512 (t (call-interactively 'org-drag-line-forward))))
20514 (defsubst org-hidden-tree-error ()
20516 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20518 (defun org-metaleft (&optional arg)
20519 "Promote heading, list item at point or move table column left.
20521 Calls `org-do-promote', `org-outdent-item' or `org-table-move-column',
20522 depending on context. With no specific context, calls the Emacs
20523 default `backward-word'. See the individual commands for more
20526 This function runs the hook `org-metaleft-hook' as a first step,
20527 and returns at first non-nil value."
20530 ((run-hook-with-args-until-success 'org-metaleft-hook))
20531 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20532 ((org-with-limited-levels
20533 (or (org-at-heading-p)
20534 (and (org-region-active-p)
20536 (goto-char (region-beginning))
20537 (org-at-heading-p)))))
20538 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20539 (call-interactively 'org-do-promote))
20540 ;; At an inline task.
20541 ((org-at-heading-p)
20542 (call-interactively 'org-inlinetask-promote))
20543 ((or (org-at-item-p)
20544 (and (org-region-active-p)
20546 (goto-char (region-beginning))
20548 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20549 (call-interactively 'org-outdent-item))
20550 (t (call-interactively 'backward-word))))
20552 (defun org-metaright (&optional arg)
20553 "Demote heading, list item at point or move table column right.
20555 In front of a drawer or a block keyword, indent it correctly.
20557 Calls `org-do-demote', `org-indent-item', `org-table-move-column',
20558 `org-indnet-drawer' or `org-indent-block' depending on context.
20559 With no specific context, calls the Emacs default `forward-word'.
20560 See the individual commands for more information.
20562 This function runs the hook `org-metaright-hook' as a first step,
20563 and returns at first non-nil value."
20566 ((run-hook-with-args-until-success 'org-metaright-hook))
20567 ((org-at-table-p) (call-interactively 'org-table-move-column))
20568 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20569 ((org-at-block-p) (call-interactively 'org-indent-block))
20570 ((org-with-limited-levels
20571 (or (org-at-heading-p)
20572 (and (org-region-active-p)
20574 (goto-char (region-beginning))
20575 (org-at-heading-p)))))
20576 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20577 (call-interactively 'org-do-demote))
20578 ;; At an inline task.
20579 ((org-at-heading-p)
20580 (call-interactively 'org-inlinetask-demote))
20581 ((or (org-at-item-p)
20582 (and (org-region-active-p)
20584 (goto-char (region-beginning))
20586 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20587 (call-interactively 'org-indent-item))
20588 (t (call-interactively 'forward-word))))
20590 (defun org-check-for-hidden (what)
20591 "Check if there are hidden headlines/items in the current visual line.
20592 WHAT can be either `headlines' or `items'. If the current line is
20593 an outline or item heading and it has a folded subtree below it,
20594 this function returns t, nil otherwise."
20596 ((eq what 'headlines) org-outline-regexp-bol)
20597 ((eq what 'items) (org-item-beginning-re))
20598 (t (error "This should not happen"))))
20602 (unless (org-region-active-p)
20603 (setq beg (point-at-bol))
20604 (beginning-of-line 2)
20605 (while (and (not (eobp)) ;; this is like `next-line'
20606 (get-char-property (1- (point)) 'invisible))
20607 (beginning-of-line 2))
20610 (goto-char (point-at-eol))
20611 (setq end (max end (point)))
20612 (while (re-search-forward re end t)
20613 (if (get-char-property (match-beginning 0) 'invisible)
20617 (defun org-metaup (&optional arg)
20618 "Move subtree up or move table row up.
20619 Calls `org-move-subtree-up' or `org-table-move-row' or
20620 `org-move-item-up', depending on context. See the individual commands
20621 for more information."
20624 ((run-hook-with-args-until-success 'org-metaup-hook))
20625 ((org-region-active-p)
20626 (let* ((a (min (region-beginning) (region-end)))
20627 (b (1- (max (region-beginning) (region-end))))
20628 (c (save-excursion (goto-char a)
20629 (move-beginning-of-line 0)))
20630 (d (save-excursion (goto-char a)
20631 (move-end-of-line 0) (point))))
20632 (transpose-regions a b c d)
20634 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20635 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20636 ((org-at-item-p) (call-interactively 'org-move-item-up))
20637 (t (org-drag-element-backward))))
20639 (defun org-metadown (&optional arg)
20640 "Move subtree down or move table row down.
20641 Calls `org-move-subtree-down' or `org-table-move-row' or
20642 `org-move-item-down', depending on context. See the individual
20643 commands for more information."
20646 ((run-hook-with-args-until-success 'org-metadown-hook))
20647 ((org-region-active-p)
20648 (let* ((a (min (region-beginning) (region-end)))
20649 (b (max (region-beginning) (region-end)))
20650 (c (save-excursion (goto-char b)
20651 (move-beginning-of-line 1)))
20652 (d (save-excursion (goto-char b)
20653 (move-end-of-line 1) (1+ (point)))))
20654 (transpose-regions a b c d)
20656 ((org-at-table-p) (call-interactively 'org-table-move-row))
20657 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20658 ((org-at-item-p) (call-interactively 'org-move-item-down))
20659 (t (org-drag-element-forward))))
20661 (defun org-shiftup (&optional arg)
20662 "Increase item in timestamp or increase priority of current headline.
20663 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20664 depending on context. See the individual commands for more information."
20667 ((run-hook-with-args-until-success 'org-shiftup-hook))
20668 ((and org-support-shift-select (org-region-active-p))
20669 (org-call-for-shift-select 'previous-line))
20670 ((org-at-timestamp-p t)
20671 (call-interactively (if org-edit-timestamp-down-means-later
20672 'org-timestamp-down 'org-timestamp-up)))
20673 ((and (not (eq org-support-shift-select 'always))
20674 org-enable-priority-commands
20675 (org-at-heading-p))
20676 (call-interactively 'org-priority-up))
20677 ((and (not org-support-shift-select) (org-at-item-p))
20678 (call-interactively 'org-previous-item))
20679 ((org-clocktable-try-shift 'up arg))
20680 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20681 (org-support-shift-select
20682 (org-call-for-shift-select 'previous-line))
20683 (t (org-shiftselect-error))))
20685 (defun org-shiftdown (&optional arg)
20686 "Decrease item in timestamp or decrease priority of current headline.
20687 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20688 depending on context. See the individual commands for more information."
20691 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20692 ((and org-support-shift-select (org-region-active-p))
20693 (org-call-for-shift-select 'next-line))
20694 ((org-at-timestamp-p t)
20695 (call-interactively (if org-edit-timestamp-down-means-later
20696 'org-timestamp-up 'org-timestamp-down)))
20697 ((and (not (eq org-support-shift-select 'always))
20698 org-enable-priority-commands
20699 (org-at-heading-p))
20700 (call-interactively 'org-priority-down))
20701 ((and (not org-support-shift-select) (org-at-item-p))
20702 (call-interactively 'org-next-item))
20703 ((org-clocktable-try-shift 'down arg))
20704 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20705 (org-support-shift-select
20706 (org-call-for-shift-select 'next-line))
20707 (t (org-shiftselect-error))))
20709 (defun org-shiftright (&optional arg)
20710 "Cycle the thing at point or in the current line, depending on context.
20711 Depending on context, this does one of the following:
20713 - switch a timestamp at point one day into the future
20714 - on a headline, switch to the next TODO keyword.
20715 - on an item, switch entire list to the next bullet type
20716 - on a property line, switch to the next allowed value
20717 - on a clocktable definition line, move time block into the future"
20720 ((run-hook-with-args-until-success 'org-shiftright-hook))
20721 ((and org-support-shift-select (org-region-active-p))
20722 (org-call-for-shift-select 'forward-char))
20723 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20724 ((and (not (eq org-support-shift-select 'always))
20725 (org-at-heading-p))
20726 (let ((org-inhibit-logging
20727 (not org-treat-S-cursor-todo-selection-as-state-change))
20728 (org-inhibit-blocking
20729 (not org-treat-S-cursor-todo-selection-as-state-change)))
20730 (org-call-with-arg 'org-todo 'right)))
20731 ((or (and org-support-shift-select
20732 (not (eq org-support-shift-select 'always))
20733 (org-at-item-bullet-p))
20734 (and (not org-support-shift-select) (org-at-item-p)))
20735 (org-call-with-arg 'org-cycle-list-bullet nil))
20736 ((and (not (eq org-support-shift-select 'always))
20737 (org-at-property-p))
20738 (call-interactively 'org-property-next-allowed-value))
20739 ((org-clocktable-try-shift 'right arg))
20740 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20741 (org-support-shift-select
20742 (org-call-for-shift-select 'forward-char))
20743 (t (org-shiftselect-error))))
20745 (defun org-shiftleft (&optional arg)
20746 "Cycle the thing at point or in the current line, depending on context.
20747 Depending on context, this does one of the following:
20749 - switch a timestamp at point one day into the past
20750 - on a headline, switch to the previous TODO keyword.
20751 - on an item, switch entire list to the previous bullet type
20752 - on a property line, switch to the previous allowed value
20753 - on a clocktable definition line, move time block into the past"
20756 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20757 ((and org-support-shift-select (org-region-active-p))
20758 (org-call-for-shift-select 'backward-char))
20759 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20760 ((and (not (eq org-support-shift-select 'always))
20761 (org-at-heading-p))
20762 (let ((org-inhibit-logging
20763 (not org-treat-S-cursor-todo-selection-as-state-change))
20764 (org-inhibit-blocking
20765 (not org-treat-S-cursor-todo-selection-as-state-change)))
20766 (org-call-with-arg 'org-todo 'left)))
20767 ((or (and org-support-shift-select
20768 (not (eq org-support-shift-select 'always))
20769 (org-at-item-bullet-p))
20770 (and (not org-support-shift-select) (org-at-item-p)))
20771 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20772 ((and (not (eq org-support-shift-select 'always))
20773 (org-at-property-p))
20774 (call-interactively 'org-property-previous-allowed-value))
20775 ((org-clocktable-try-shift 'left arg))
20776 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20777 (org-support-shift-select
20778 (org-call-for-shift-select 'backward-char))
20779 (t (org-shiftselect-error))))
20781 (defun org-shiftcontrolright ()
20782 "Switch to next TODO set."
20785 ((and org-support-shift-select (org-region-active-p))
20786 (org-call-for-shift-select 'forward-word))
20787 ((and (not (eq org-support-shift-select 'always))
20788 (org-at-heading-p))
20789 (org-call-with-arg 'org-todo 'nextset))
20790 (org-support-shift-select
20791 (org-call-for-shift-select 'forward-word))
20792 (t (org-shiftselect-error))))
20794 (defun org-shiftcontrolleft ()
20795 "Switch to previous TODO set."
20798 ((and org-support-shift-select (org-region-active-p))
20799 (org-call-for-shift-select 'backward-word))
20800 ((and (not (eq org-support-shift-select 'always))
20801 (org-at-heading-p))
20802 (org-call-with-arg 'org-todo 'previousset))
20803 (org-support-shift-select
20804 (org-call-for-shift-select 'backward-word))
20805 (t (org-shiftselect-error))))
20807 (defun org-shiftcontrolup (&optional n)
20808 "Change timestamps synchronously up in CLOCK log lines.
20809 Optional argument N tells to change by that many units."
20811 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20812 (let (org-support-shift-select)
20813 (org-clock-timestamps-up n))
20814 (user-error "Not at a clock log")))
20816 (defun org-shiftcontroldown (&optional n)
20817 "Change timestamps synchronously down in CLOCK log lines.
20818 Optional argument N tells to change by that many units."
20820 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20821 (let (org-support-shift-select)
20822 (org-clock-timestamps-down n))
20823 (user-error "Not at a clock log")))
20825 (defun org-increase-number-at-point (&optional inc)
20826 "Increment the number at point.
20827 With an optional prefix numeric argument INC, increment using
20828 this numeric value."
20830 (if (not (number-at-point))
20831 (user-error "Not on a number")
20832 (unless inc (setq inc 1))
20833 (let ((pos (point))
20834 (beg (skip-chars-backward "-+^/*0-9eE."))
20835 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20836 (setq nap (buffer-substring-no-properties
20837 (+ pos beg) (+ pos beg end)))
20838 (delete-region (+ pos beg) (+ pos beg end))
20839 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20840 (when (org-at-table-p)
20842 (org-table-end-of-field 1))))
20844 (defun org-decrease-number-at-point (&optional inc)
20845 "Decrement the number at point.
20846 With an optional prefix numeric argument INC, decrement using
20847 this numeric value."
20849 (org-increase-number-at-point (- (or inc 1))))
20851 (defun org-ctrl-c-ret ()
20852 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20855 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20856 (t (call-interactively 'org-insert-heading))))
20858 (defun org-find-visible ()
20860 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20861 (get-char-property s 'invisible)))
20863 (defun org-find-invisible ()
20865 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20866 (not (get-char-property s 'invisible))))
20869 (defun org-copy-visible (beg end)
20870 "Copy the visible parts of the region."
20875 (narrow-to-region beg end)
20876 (setq s (goto-char (point-min)))
20877 (while (not (= (point) (point-max)))
20878 (goto-char (org-find-invisible))
20879 (push (buffer-substring s (point)) snippets)
20880 (setq s (goto-char (org-find-visible))))))
20881 (kill-new (apply 'concat (nreverse snippets)))))
20883 (defun org-copy-special ()
20884 "Copy region in table or copy current subtree.
20885 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20886 See the individual commands for more information."
20888 (call-interactively
20889 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20891 (defun org-cut-special ()
20892 "Cut region in table or cut current subtree.
20893 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20894 See the individual commands for more information."
20896 (call-interactively
20897 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20899 (defun org-paste-special (arg)
20900 "Paste rectangular region into table, or past subtree relative to level.
20901 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20902 See the individual commands for more information."
20904 (if (org-at-table-p)
20905 (org-table-paste-rectangle)
20906 (org-paste-subtree arg)))
20908 (defsubst org-in-fixed-width-region-p ()
20909 "Is point in a fixed-width region?"
20911 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20913 (defun org-edit-special (&optional arg)
20914 "Call a special editor for the element at point.
20915 When at a table, call the formula editor with `org-table-edit-formulas'.
20916 When in a source code block, call `org-edit-src-code'.
20917 When in a fixed-width region, call `org-edit-fixed-width-region'.
20918 When in an export block, call `org-edit-export-block'.
20919 When at an #+INCLUDE keyword, visit the included file.
20920 When at a footnote reference, call `org-edit-footnote-reference'
20921 On a link, call `ffap' to visit the link at point.
20922 Otherwise, return a user error."
20924 (let ((element (org-element-at-point)))
20925 (assert (not buffer-read-only) nil
20926 "Buffer is read-only: %s" (buffer-name))
20927 (case (org-element-type element)
20929 (if (not arg) (org-edit-src-code)
20930 (let* ((info (org-babel-get-src-block-info))
20931 (lang (nth 0 info))
20932 (params (nth 2 info))
20933 (session (cdr (assq :session params))))
20934 (if (not session) (org-edit-src-code)
20935 ;; At a src-block with a session and function called with
20936 ;; an ARG: switch to the buffer related to the inferior
20939 (funcall (intern (concat "org-babel-prep-session:" lang))
20940 session params))))))
20942 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20943 (org-open-link-from-string
20946 (let ((value (org-element-property :value element)))
20947 (cond ((not (org-string-nw-p value))
20948 (user-error "No file to edit"))
20949 ((string-match "\\`\"\\(.*?\\)\"" value)
20950 (match-string 1 value))
20951 ((string-match "\\`[^ \t\"]\\S-*" value)
20952 (match-string 0 value))
20953 (t (user-error "No valid file specified")))))))
20954 (user-error "No special environment to edit here")))
20956 (if (eq (org-element-property :type element) 'table.el)
20957 (org-edit-table.el)
20958 (call-interactively 'org-table-edit-formulas)))
20959 ;; Only Org tables contain `table-row' type elements.
20960 (table-row (call-interactively 'org-table-edit-formulas))
20961 (example-block (org-edit-src-code))
20962 (export-block (org-edit-export-block))
20963 (fixed-width (org-edit-fixed-width-region))
20965 ;; No notable element at point. Though, we may be at a link or
20966 ;; a footnote reference, which are objects. Thus, scan deeper.
20967 (let ((context (org-element-context element)))
20968 (case (org-element-type context)
20969 (link (call-interactively #'ffap))
20970 (footnote-reference (org-edit-footnote-reference))
20971 (t (user-error "No special environment to edit here"))))))))
20973 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20974 (defun org-ctrl-c-ctrl-c (&optional arg)
20975 "Set tags in headline, or update according to changed information at point.
20977 This command does many different things, depending on context:
20979 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20980 this is what we do.
20982 - If the cursor is on a statistics cookie, update it.
20984 - If the cursor is in a headline, prompt for tags and insert them
20985 into the current line, aligned to `org-tags-column'. When called
20986 with prefix arg, realign all tags in the current buffer.
20988 - If the cursor is in one of the special #+KEYWORD lines, this
20989 triggers scanning the buffer for these lines and updating the
20992 - If the cursor is inside a table, realign the table. This command
20993 works even if the automatic table editor has been turned off.
20995 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20998 - If the cursor is at a footnote reference or definition, jump to
20999 the corresponding definition or references, respectively.
21001 - If the cursor is a the beginning of a dynamic block, update it.
21003 - If the current buffer is a capture buffer, close note and file it.
21005 - If the cursor is on a <<<target>>>, update radio targets and
21006 corresponding links in this buffer.
21008 - If the cursor is on a numbered item in a plain list, renumber the
21011 - If the cursor is on a checkbox, toggle it.
21013 - If the cursor is on a code block, evaluate it. The variable
21014 `org-confirm-babel-evaluate' can be used to control prompting
21015 before code block evaluation, by default every code block
21016 evaluation requires confirmation. Code block evaluation can be
21017 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
21020 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
21021 org-occur-highlights)
21022 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
21023 (org-remove-occur-highlights)
21024 (message "Temporary highlights/overlays removed from current buffer"))
21025 ((and (local-variable-p 'org-finish-function (current-buffer))
21026 (fboundp org-finish-function))
21027 (funcall org-finish-function))
21028 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
21030 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
21031 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21032 (user-error "C-c C-c can do nothing useful at this location"))
21033 (let* ((context (org-element-context))
21034 (type (org-element-type context)))
21036 ;; When at a link, act according to the parent instead.
21037 (link (setq context (org-element-property :parent context))
21038 (setq type (org-element-type context)))
21039 ;; Unsupported object types: refer to the first supported
21040 ;; element or object containing it.
21041 ((bold code entity export-snippet inline-babel-call inline-src-block
21042 italic latex-fragment line-break macro strike-through subscript
21043 superscript underline verbatim)
21045 (org-element-lineage
21046 context '(radio-target paragraph verse-block table-cell)))))
21047 ;; For convenience: at the first line of a paragraph on the
21048 ;; same line as an item, apply function on that item instead.
21049 (when (eq type 'paragraph)
21050 (let ((parent (org-element-property :parent context)))
21051 (when (and (eq (org-element-type parent) 'item)
21052 (= (line-beginning-position)
21053 (org-element-property :begin parent)))
21054 (setq context parent type 'item))))
21055 ;; Act according to type of element or object at point.
21057 (clock (org-clock-update-time-maybe))
21060 (goto-char (org-element-property :post-affiliated context))
21061 (org-update-dblock)))
21062 (footnote-definition
21063 (goto-char (org-element-property :post-affiliated context))
21064 (call-interactively 'org-footnote-action))
21065 (footnote-reference (call-interactively 'org-footnote-action))
21066 ((headline inlinetask)
21067 (save-excursion (goto-char (org-element-property :begin context))
21068 (call-interactively 'org-set-tags)))
21070 ;; At an item: a double C-u set checkbox to "[-]"
21071 ;; unconditionally, whereas a single one will toggle its
21072 ;; presence. Without an universal argument, if the item
21073 ;; has a checkbox, toggle it. Otherwise repair the list.
21074 (let* ((box (org-element-property :checkbox context))
21075 (struct (org-element-property :structure context))
21076 (old-struct (copy-tree struct))
21077 (parents (org-list-parents-alist struct))
21078 (prevs (org-list-prevs-alist struct))
21079 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21080 (org-list-set-checkbox
21081 (org-element-property :begin context) struct
21082 (cond ((equal arg '(16)) "[-]")
21083 ((and (not box) (equal arg '(4))) "[ ]")
21084 ((or (not box) (equal arg '(4))) nil)
21085 ((eq box 'on) "[ ]")
21087 ;; Mimic `org-list-write-struct' but with grabbing
21088 ;; a return value from `org-list-struct-fix-box'.
21089 (org-list-struct-fix-ind struct parents 2)
21090 (org-list-struct-fix-item-end struct)
21091 (org-list-struct-fix-bul struct prevs)
21092 (org-list-struct-fix-ind struct parents)
21094 (org-list-struct-fix-box struct parents prevs orderedp)))
21095 (if (and box (equal struct old-struct))
21096 (if (equal arg '(16))
21097 (message "Checkboxes already reset")
21098 (user-error "Cannot toggle this checkbox: %s"
21100 "all subitems checked"
21101 "unchecked subitems")))
21102 (org-list-struct-apply-struct struct old-struct)
21103 (org-update-checkbox-count-maybe))
21105 (message "Checkboxes were removed due to empty box at line %d"
21106 (org-current-line block-item))))))
21108 (let ((org-inhibit-startup-visibility-stuff t)
21109 (org-startup-align-all-tables nil))
21110 (when (boundp 'org-table-coordinate-overlays)
21111 (mapc 'delete-overlay org-table-coordinate-overlays)
21112 (setq org-table-coordinate-overlays nil))
21113 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21114 (message "Local setup has been refreshed"))
21116 ;; At a plain list, with a double C-u argument, set
21117 ;; checkboxes of each item to "[-]", whereas a single one
21118 ;; will toggle their presence according to the state of the
21119 ;; first item in the list. Without an argument, repair the
21121 (let* ((begin (org-element-property :contents-begin context))
21122 (beginm (move-marker (make-marker) begin))
21123 (struct (org-element-property :structure context))
21124 (old-struct (copy-tree struct))
21125 (first-box (save-excursion
21127 (looking-at org-list-full-item-re)
21128 (match-string-no-properties 3)))
21129 (new-box (cond ((equal arg '(16)) "[-]")
21130 ((equal arg '(4)) (unless first-box "[ ]"))
21131 ((equal first-box "[X]") "[ ]")
21135 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21136 (org-list-get-all-items
21137 begin struct (org-list-prevs-alist struct))))
21138 ((and first-box (eq (point) begin))
21139 ;; For convenience, when point is at bol on the first
21140 ;; item of the list and no argument is provided, simply
21141 ;; toggle checkbox of that item, if any.
21142 (org-list-set-checkbox begin struct new-box)))
21143 (org-list-write-struct
21144 struct (org-list-parents-alist struct) old-struct)
21145 (org-update-checkbox-count-maybe)
21146 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21147 ((property-drawer node-property)
21148 (call-interactively 'org-property-action))
21149 ((radio-target target)
21150 (call-interactively 'org-update-radio-target-regexp))
21152 (call-interactively 'org-update-statistics-cookies))
21153 ((table table-cell table-row)
21154 ;; At a table, recalculate every field and align it. Also
21155 ;; send the table if necessary. If the table has
21156 ;; a `table.el' type, just give up. At a table row or
21157 ;; cell, maybe recalculate line but always align table.
21158 (if (eq (org-element-property :type context) 'table.el)
21159 (message "Use C-c ' to edit table.el tables")
21160 (let ((org-enable-table-editor t))
21161 (if (or (eq type 'table)
21162 ;; Check if point is at a TBLFM line.
21163 (and (eq type 'table-row)
21164 (= (point) (org-element-property :end context))))
21166 (if (org-at-TBLFM-p)
21167 (progn (require 'org-table)
21168 (org-table-calc-current-TBLFM))
21169 (goto-char (org-element-property :contents-begin context))
21170 (org-call-with-arg 'org-table-recalculate (or arg t))
21171 (orgtbl-send-table 'maybe)))
21172 (org-table-maybe-eval-formula)
21173 (cond (arg (call-interactively 'org-table-recalculate))
21174 ((org-table-maybe-recalculate-line))
21175 (t (org-table-align)))))))
21176 (timestamp (org-timestamp-change 0 'day))
21178 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21180 "C-c C-c can do nothing useful at this location")))))))))
21182 (defun org-mode-restart ()
21184 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21185 (funcall major-mode)
21186 (hack-local-variables)
21187 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21188 (org-indent-mode -1)))
21189 (message "%s restarted" major-mode))
21191 (defun org-kill-note-or-show-branches ()
21192 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21194 (if (not org-finish-function)
21197 (call-interactively 'show-branches))
21198 (let ((org-note-abort t))
21199 (funcall org-finish-function))))
21201 (defun org-delete-indentation (&optional ARG)
21202 "Join current line to previous and fix whitespace at join.
21204 If previous line is a headline add to headline title. Otherwise
21205 the function calls `delete-indentation'.
21207 With argument, join this line to following line."
21209 (if (save-excursion
21210 (if ARG (beginning-of-line)
21212 (looking-at org-complex-heading-regexp))
21214 (let ((tags-column (when (match-beginning 5)
21215 (save-excursion (goto-char (match-beginning 5))
21216 (current-column))))
21217 (string (concat " " (progn (when ARG (forward-line 1))
21218 (org-trim (delete-and-extract-region
21219 (line-beginning-position)
21220 (line-end-position)))))))
21221 (unless (bobp) (delete-region (point) (1- (point))))
21222 (goto-char (or (match-end 4)
21223 (match-beginning 5)
21225 (skip-chars-backward " \t")
21226 (save-excursion (insert string))
21227 ;; Adjust alignment of tags.
21229 (org-align-tags-here (if org-auto-align-tags
21232 (delete-indentation ARG)))
21234 (defun org-open-line (n)
21235 "Insert a new row in tables, call `open-line' elsewhere.
21236 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21239 ((not org-special-ctrl-o)
21242 (org-table-insert-row))
21246 (defun org-return (&optional indent)
21247 "Goto next table row or insert a newline.
21249 Calls `org-table-next-row' or `newline', depending on context.
21251 When optional INDENT argument is non-nil, call
21252 `newline-and-indent' instead of `newline'.
21254 When `org-return-follows-link' is non-nil and point is on
21255 a timestamp or a link, call `org-open-at-point'. However, it
21256 will not happen if point is in a table or on a \"dead\"
21257 object (e.g., within a comment). In these case, you need to use
21258 `org-open-at-point' directly."
21260 (if (and (not (bolp))
21261 (save-excursion (beginning-of-line)
21262 (looking-at org-complex-heading-regexp)))
21264 (let ((tags-column (when (match-beginning 5)
21265 (save-excursion (goto-char (match-beginning 5))
21266 (current-column))))
21267 ;; Test if before or after headline title.
21268 (string (when (and (match-end 4)
21269 (not (or (< (point)
21273 (goto-char (match-beginning 4))
21274 (skip-chars-backward " \t")
21276 (and (match-beginning 5)
21277 (>= (point) (match-beginning 5))))))
21278 ;; Point is on headline keywords, tags or cookies. Do not break
21279 ;; them: add a newline after the headline instead.
21281 (delete-and-extract-region (point) (match-end 4))))))
21282 ;; Adjust alignment of tags.
21283 (when (and tags-column string)
21284 (org-align-tags-here (if org-auto-align-tags
21289 (if indent (newline-and-indent) (newline))
21290 (and string (save-excursion (insert (org-trim string)))))
21291 (let* ((context (if org-return-follows-link (org-element-context)
21292 (org-element-at-point)))
21293 (type (org-element-type context)))
21295 ;; In a table, call `org-table-next-row'.
21296 ((or (and (eq type 'table)
21297 (>= (point) (org-element-property :contents-begin context))
21298 (< (point) (org-element-property :contents-end context)))
21299 (org-element-lineage context '(table-row table-cell) t))
21300 (org-table-justify-field-maybe)
21301 (call-interactively #'org-table-next-row))
21302 ;; On a link or a timestamp but not on white spaces after it,
21303 ;; call `org-open-line' if `org-return-follows-link' allows it.
21304 ((and org-return-follows-link
21305 (memq type '(link timestamp))
21307 (save-excursion (goto-char (org-element-property :end context))
21308 (skip-chars-backward " \t")
21310 (call-interactively #'org-open-at-point))
21311 ;; In a list, make sure indenting keeps trailing text within.
21314 (org-element-lineage context '(item)))
21315 (let ((trailing-data
21316 (delete-and-extract-region (point) (line-end-position))))
21317 (newline-and-indent)
21318 (save-excursion (insert trailing-data))))
21319 (t (if indent (newline-and-indent) (newline)))))))
21321 (defun org-return-indent ()
21322 "Goto next table row or insert a newline and indent.
21323 Calls `org-table-next-row' or `newline-and-indent', depending on
21324 context. See the individual commands for more information."
21328 (defun org-ctrl-c-star ()
21329 "Compute table, or change heading status of lines.
21330 Calls `org-table-recalculate' or `org-toggle-heading',
21331 depending on context."
21335 (call-interactively 'org-table-recalculate))
21337 ;; Convert all lines in region to list items
21338 (call-interactively 'org-toggle-heading))))
21340 (defun org-ctrl-c-minus ()
21341 "Insert separator line in table or modify bullet status of line.
21342 Also turns a plain line or a region of lines into list items.
21343 Calls `org-table-insert-hline', `org-toggle-item', or
21344 `org-cycle-list-bullet', depending on context."
21348 (call-interactively 'org-table-insert-hline))
21349 ((org-region-active-p)
21350 (call-interactively 'org-toggle-item))
21352 (call-interactively 'org-cycle-list-bullet))
21354 (call-interactively 'org-toggle-item))))
21356 (defun org-toggle-item (arg)
21357 "Convert headings or normal lines to items, items to normal lines.
21358 If there is no active region, only the current line is considered.
21360 If the first non blank line in the region is a headline, convert
21361 all headlines to items, shifting text accordingly.
21363 If it is an item, convert all items to normal lines.
21365 If it is normal text, change region into a list of items.
21366 With a prefix argument ARG, change the region in a single item."
21370 ;; Shift text in current section to IND, from point to END.
21371 ;; The function leaves point to END line.
21373 (let ((min-i 1000) (end (copy-marker end)))
21374 ;; First determine the minimum indentation (MIN-I) of
21378 (while (< (point) end)
21379 (let ((i (org-get-indentation)))
21381 ;; Skip blank lines and inline tasks.
21382 ((looking-at "^[ \t]*$"))
21383 ((looking-at org-outline-regexp-bol))
21384 ;; We can't find less than 0 indentation.
21385 ((zerop i) (throw 'exit (setq min-i 0)))
21386 ((< i min-i) (setq min-i i))))
21388 ;; Then indent each line so that a line indented to
21389 ;; MIN-I becomes indented to IND. Ignore blank lines
21390 ;; and inline tasks in the process.
21391 (let ((delta (- ind min-i)))
21392 (while (< (point) end)
21393 (unless (or (looking-at "^[ \t]*$")
21394 (looking-at org-outline-regexp-bol))
21395 (org-indent-line-to (+ (org-get-indentation) delta)))
21396 (forward-line)))))))
21399 ;; Return beginning of first non-blank line, starting from
21404 (skip-chars-forward " \r\t\n")
21407 ;; Determine boundaries of changes.
21408 (if (org-region-active-p)
21409 (setq beg (funcall skip-blanks (region-beginning))
21410 end (copy-marker (region-end)))
21411 (setq beg (funcall skip-blanks (point-at-bol))
21412 end (copy-marker (point-at-eol))))
21413 ;; Depending on the starting line, choose an action on the text
21414 ;; between BEG and END.
21415 (org-with-limited-levels
21419 ;; Case 1. Start at an item: de-itemize. Note that it only
21420 ;; happens when a region is active: `org-ctrl-c-minus'
21421 ;; would call `org-cycle-list-bullet' otherwise.
21423 (while (< (point) end)
21424 (when (org-at-item-p)
21425 (skip-chars-forward " \t")
21426 (delete-region (point) (match-end 0)))
21428 ;; Case 2. Start at an heading: convert to items.
21429 ((org-at-heading-p)
21430 (let* ((bul (org-list-bullet-string "-"))
21431 (bul-len (length bul))
21432 (done (org-entry-is-done-p))
21433 (todo (org-entry-is-todo-p))
21434 ;; Indentation of the first heading. It should be
21435 ;; relative to the indentation of its parent, if any.
21436 (start-ind (save-excursion
21438 ((not org-adapt-indentation) 0)
21439 ((not (outline-previous-heading)) 0)
21440 (t (length (match-string 0))))))
21441 ;; Level of first heading. Further headings will be
21442 ;; compared to it to determine hierarchy in the list.
21443 (ref-level (org-reduced-level (org-outline-level))))
21444 (when (or done todo) (org-todo ""))
21445 (while (< (point) end)
21446 (let* ((level (org-reduced-level (org-outline-level)))
21447 (delta (max 0 (- level ref-level))))
21448 ;; If current headline is less indented than the first
21449 ;; one, set it as reference, in order to preserve
21451 (when (< level ref-level) (setq ref-level level))
21452 (replace-match bul t t)
21453 (org-indent-line-to (+ start-ind (* delta bul-len)))
21454 (when (or done todo)
21455 (let* ((struct (org-list-struct))
21456 (old (copy-tree struct)))
21457 (org-list-set-checkbox (line-beginning-position)
21459 (if done "[X]" "[ ]"))
21460 (org-list-write-struct struct
21461 (org-list-parents-alist struct)
21463 ;; Ensure all text down to END (or SECTION-END) belongs
21464 ;; to the newly created item.
21465 (let ((section-end (save-excursion
21466 (or (outline-next-heading) (point)))))
21468 (funcall shift-text
21469 (+ start-ind (* (1+ delta) bul-len))
21470 (min end section-end)))))))
21471 ;; Case 3. Normal line with ARG: make the first line of region
21472 ;; an item, and shift indentation of others lines to
21473 ;; set them as item's body.
21474 (arg (let* ((bul (org-list-bullet-string "-"))
21475 (bul-len (length bul))
21476 (ref-ind (org-get-indentation)))
21477 (skip-chars-forward " \t")
21480 (while (< (point) end)
21481 ;; Ensure that lines less indented than first one
21482 ;; still get included in item body.
21483 (funcall shift-text
21484 (+ ref-ind bul-len)
21485 (min end (save-excursion (or (outline-next-heading)
21488 ;; Case 4. Normal line without ARG: turn each non-item line
21491 (while (< (point) end)
21492 (unless (or (org-at-heading-p) (org-at-item-p))
21493 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21495 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21496 (forward-line))))))))
21498 (defun org-toggle-heading (&optional nstars)
21499 "Convert headings to normal text, or items or text to headings.
21500 If there is no active region, only convert the current line.
21502 With a \\[universal-argument] prefix, convert the whole list at
21503 point into heading.
21507 - If the first non blank line is a headline, remove the stars
21508 from all headlines in the region.
21510 - If it is a normal line, turn each and every normal line (i.e.,
21511 not an heading or an item) in the region into headings. If you
21512 want to convert only the first line of this region, use one
21513 universal prefix argument.
21515 - If it is a plain list item, turn all plain list items into headings.
21517 When converting a line into a heading, the number of stars is chosen
21518 such that the lines become children of the current entry. However,
21519 when a numeric prefix argument is given, its value determines the
21520 number of stars to add."
21524 ;; Return beginning of first non-blank line, starting from
21529 (while (org-at-comment-p) (forward-line))
21530 (skip-chars-forward " \r\t\n")
21533 ;; Determine boundaries of changes. If a universal prefix has
21534 ;; been given, put the list in a region. If region ends at a bol,
21535 ;; do not consider the last line to be in the region.
21537 (when (and current-prefix-arg (org-at-item-p))
21538 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21539 (org-mark-element))
21541 (if (org-region-active-p)
21542 (setq beg (funcall skip-blanks (region-beginning))
21543 end (copy-marker (save-excursion
21544 (goto-char (region-end))
21545 (if (bolp) (point) (point-at-eol)))))
21546 (setq beg (funcall skip-blanks (point-at-bol))
21547 end (copy-marker (point-at-eol))))
21548 ;; Ensure inline tasks don't count as headings.
21549 (org-with-limited-levels
21553 ;; Case 1. Started at an heading: de-star headings.
21554 ((org-at-heading-p)
21555 (while (< (point) end)
21556 (when (org-at-heading-p t)
21557 (looking-at org-outline-regexp) (replace-match "")
21560 ;; Case 2. Started at an item: change items into headlines.
21561 ;; One star will be added by `org-list-to-subtree'.
21563 (while (< (point) end)
21564 (when (org-at-item-p)
21565 ;; Pay attention to cases when region ends before list.
21566 (let* ((struct (org-list-struct))
21567 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21569 (narrow-to-region (point) list-end)
21570 (insert (org-list-to-subtree (org-list-parse-list t)))))
21573 ;; Case 3. Started at normal text: make every line an heading,
21574 ;; skipping headlines and items.
21577 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21579 (cond (nstars "") ; stars from prefix only
21580 ((equal stars "") "*") ; before first heading
21581 (org-odd-levels-only "**") ; inside heading, odd
21582 (t "*"))) ; inside heading, oddeven
21583 (rpl (concat stars add-stars " "))
21584 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21585 (while (< (point) (if (equal nstars '(4)) lend end))
21586 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21587 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21588 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21589 (forward-line)))))))
21590 (unless toggled (message "Cannot toggle heading from here"))))
21592 (defun org-meta-return (&optional arg)
21593 "Insert a new heading or wrap a region in a table.
21594 Calls `org-insert-heading' or `org-table-wrap-region', depending
21595 on context. See the individual commands for more information."
21597 (org-check-before-invisible-edit 'insert)
21598 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21599 (call-interactively (if (org-at-table-p) #'org-table-wrap-region
21600 #'org-insert-heading))))
21604 (defsubst org-in-subtree-not-table-p ()
21605 "Are we in a subtree and not in a table?"
21606 (and (not (org-before-first-heading-p))
21607 (not (org-at-table-p))))
21609 ;; Define the Org-mode menus
21610 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21612 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21613 ["Next Field" org-cycle (org-at-table-p)]
21614 ["Previous Field" org-shifttab (org-at-table-p)]
21615 ["Next Row" org-return (org-at-table-p)]
21617 ["Blank Field" org-table-blank-field (org-at-table-p)]
21618 ["Edit Field" org-table-edit-field (org-at-table-p)]
21619 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21622 ["Move Column Left" org-metaleft (org-at-table-p)]
21623 ["Move Column Right" org-metaright (org-at-table-p)]
21624 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21625 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21627 ["Move Row Up" org-metaup (org-at-table-p)]
21628 ["Move Row Down" org-metadown (org-at-table-p)]
21629 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21630 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21631 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21633 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21635 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21636 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21637 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21638 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21641 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21642 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21643 ["Edit Formulas" org-edit-special (org-at-table-p)]
21645 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21646 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21647 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21649 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21651 ["Sum Column/Rectangle" org-table-sum
21652 (or (org-at-table-p) (org-region-active-p))]
21653 ["Which Column?" org-table-current-column (org-at-table-p)])
21655 org-table-toggle-formula-debugger
21656 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21657 ["Show Col/Row Numbers"
21658 org-table-toggle-coordinate-overlays
21660 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21662 ["Create" org-table-create (and (not (org-at-table-p))
21663 org-enable-table-editor)]
21664 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21665 ["Import from File" org-table-import (not (org-at-table-p))]
21666 ["Export to File" org-table-export (org-at-table-p)]
21668 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21671 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21672 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21674 (easy-menu-define org-org-menu org-mode-map "Org menu"
21677 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21678 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21679 ["Sparse Tree..." org-sparse-tree t]
21680 ["Reveal Context" org-reveal t]
21681 ["Show All" show-all t]
21683 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21685 ["New Heading" org-insert-heading t]
21686 ("Navigate Headings"
21687 ["Up" outline-up-heading t]
21688 ["Next" outline-next-visible-heading t]
21689 ["Previous" outline-previous-visible-heading t]
21690 ["Next Same Level" outline-forward-same-level t]
21691 ["Previous Same Level" outline-backward-same-level t]
21693 ["Jump" org-goto t])
21695 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21697 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21698 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21700 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21701 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21702 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21704 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21706 ["Copy visible text" org-copy-visible t]
21708 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21709 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21710 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21711 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21713 ["Sort Region/Children" org-sort t]
21715 ["Convert to odd levels" org-convert-to-odd-levels t]
21716 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21718 ["Emphasis..." org-emphasize t]
21719 ["Edit Source Example" org-edit-special t]
21721 ["Footnote new/jump" org-footnote-action t]
21722 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21724 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21726 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21727 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21728 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21732 ["Store Link (Global)" org-store-link t]
21733 ["Find existing link to here" org-occur-link-in-agenda-files t]
21734 ["Insert Link" org-insert-link t]
21735 ["Follow Link" org-open-at-point t]
21737 ["Next link" org-next-link t]
21738 ["Previous link" org-previous-link t]
21740 ["Descriptive Links"
21741 org-toggle-link-display
21743 :selected org-descriptive-links
21746 org-toggle-link-display
21748 :selected (not org-descriptive-links)])
21751 ["TODO/DONE/-" org-todo t]
21753 ["Next keyword" org-shiftright (org-at-heading-p)]
21754 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21755 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21756 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21757 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21758 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21759 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21761 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21762 :selected org-enforce-todo-dependencies :style toggle :active t]
21763 "Settings for tree at point"
21764 ["Do Children sequentially" org-toggle-ordered-property :style radio
21765 :selected (org-entry-get nil "ORDERED")
21766 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21767 ["Do Children parallel" org-toggle-ordered-property :style radio
21768 :selected (not (org-entry-get nil "ORDERED"))
21769 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21771 ["Set Priority" org-priority t]
21772 ["Priority Up" org-shiftup t]
21773 ["Priority Down" org-shiftdown t]
21775 ["Get news from all feeds" org-feed-update-all t]
21776 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21777 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21778 ("TAGS and Properties"
21779 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21780 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21782 ["Set property" org-set-property (not (org-before-first-heading-p))]
21783 ["Column view of properties" org-columns t]
21784 ["Insert Column View DBlock" org-insert-columns-dblock t])
21785 ("Dates and Scheduling"
21786 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21787 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21789 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21790 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21791 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21792 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21793 ["Compute Time Range" org-evaluate-time-range t]
21794 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21795 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21797 ["Custom time format" org-toggle-time-stamp-overlays
21798 :style radio :selected org-display-custom-times]
21800 ["Goto Calendar" org-goto-calendar t]
21801 ["Date from Calendar" org-date-from-calendar t]
21803 ["Start/Restart Timer" org-timer-start t]
21804 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21805 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21806 ["Insert Timer String" org-timer t]
21807 ["Insert Timer Item" org-timer-item t])
21809 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21810 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21811 ["Clock out" org-clock-out t]
21812 ["Clock cancel" org-clock-cancel t]
21814 ["Mark as default task" org-clock-mark-default-task t]
21815 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21816 ["Goto running clock" org-clock-goto t]
21818 ["Display times" org-clock-display t]
21819 ["Create clock table" org-clock-report t]
21821 ["Record DONE time"
21822 (progn (setq org-log-done (not org-log-done))
21823 (message "Switching to %s will %s record a timestamp"
21824 (car org-done-keywords)
21825 (if org-log-done "automatically" "not")))
21826 :style toggle :selected org-log-done])
21828 ["Agenda Command..." org-agenda t]
21829 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21830 ("File List for Agenda")
21831 ("Special views current file"
21832 ["TODO Tree" org-show-todo-tree t]
21833 ["Check Deadlines" org-check-deadlines t]
21834 ["Timeline" org-timeline t]
21835 ["Tags/Property tree" org-match-sparse-tree t])
21837 ["Export/Publish..." org-export-dispatch t]
21839 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21840 :selected org-cdlatex-mode]
21841 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21842 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21843 ["Modify math symbol" org-cdlatex-math-modify
21844 (org-inside-LaTeX-fragment-p)]
21845 ["Insert citation" org-reftex-citation t]
21847 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21850 ["Push Files and Views" org-mobile-push t]
21851 ["Get Captured and Flagged" org-mobile-pull t]
21852 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21854 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21857 ["Show Version" org-version t]
21858 ["Info Documentation" org-info t])
21860 ["Browse Org Group" org-customize t]
21862 ["Expand This Menu" org-create-customize-menu
21863 (fboundp 'customize-menu-create)])
21864 ["Send bug report" org-submit-bug-report t]
21867 ["Refresh setup current buffer" org-mode-restart t]
21868 ["Reload Org (after update)" org-reload t]
21869 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21872 (defun org-info (&optional node)
21873 "Read documentation for Org-mode in the info system.
21874 With optional NODE, go directly to that node."
21876 (info (format "(org)%s" (or node ""))))
21879 (defun org-submit-bug-report ()
21880 "Submit a bug report on Org-mode via mail.
21882 Don't hesitate to report any problems or inaccurate documentation.
21884 If you don't have setup sending mail from (X)Emacs, please copy the
21885 output buffer into your mail program, as it gives us important
21886 information about your Org-mode version and configuration."
21888 (require 'reporter)
21889 (org-load-modules-maybe)
21890 (org-require-autoloaded-modules)
21891 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21892 (reporter-submit-bug-report
21893 "emacs-orgmode@gnu.org"
21894 (org-version nil 'full)
21896 (save-window-excursion
21897 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21898 (delete-other-windows)
21900 (insert "You are about to submit a bug report to the Org-mode mailing list.
21902 We would like to add your full Org-mode and Outline configuration to the
21903 bug report. This greatly simplifies the work of the maintainer and
21904 other experts on the mailing list.
21906 HOWEVER, some variables you have customized may contain private
21907 information. The names of customers, colleagues, or friends, might
21908 appear in the form of file names, tags, todo states, or search strings.
21909 If you answer yes to the prompt, you might want to check and remove
21910 such private information before sending the email.")
21911 (add-text-properties (point-min) (point-max) '(face org-warning))
21912 (when (yes-or-no-p "Include your Org-mode configuration ")
21916 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21917 (or (and (symbol-value v)
21918 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21920 (get v 'custom-type) (get v 'standard-value)
21921 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21923 (kill-buffer (get-buffer "*Warn about privacy*"))
21926 "Remember to cover the basics, that is, what you expected to happen and
21927 what in fact did happen. You don't know how to make a good report? See
21929 http://orgmode.org/manual/Feedback.html#Feedback
21931 Your bug report will be posted to the Org-mode mailing list.
21932 ------------------------------------------------------------------------")
21934 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21935 (replace-match "\\1Bug: \\3 [\\2]")))))
21938 (defun org-install-agenda-files-menu ()
21939 (let ((bl (buffer-list)))
21942 (set-buffer (pop bl))
21943 (if (derived-mode-p 'org-mode) (setq bl nil)))
21944 (when (derived-mode-p 'org-mode)
21946 '("Org") "File List for Agenda"
21949 ["Edit File List" (org-edit-agenda-file-list) t]
21950 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21951 ["Remove Current File from List" org-remove-file t]
21952 ["Cycle through agenda files" org-cycle-agenda-files t]
21953 ["Occur in all agenda files" org-occur-in-agenda-files t]
21955 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21959 (defun org-require-autoloaded-modules ()
21962 '(org-agenda org-archive org-attach org-clock org-colview org-id
21963 org-table org-timer)))
21966 (defun org-reload (&optional uncompiled)
21967 "Reload all org lisp files.
21968 With prefix arg UNCOMPILED, load the uncompiled versions."
21970 (require 'loadhist)
21971 (let* ((org-dir (org-find-library-dir "org"))
21972 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21973 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21974 (remove-re (mapconcat 'identity
21975 (mapcar (lambda (f) (concat "^" f "$"))
21976 (list (if (featurep 'xemacs)
21978 "org-colview-xemacs")
21979 "org" "org-loaddefs" "org-version"))
21981 (feats (delete-dups
21982 (mapcar 'file-name-sans-extension
21983 (mapcar 'file-name-nondirectory
21985 (mapcar 'feature-file
21992 (if (and (string-match feature-re f)
21993 (not (string-match remove-re f)))
21997 (list "org-version" "org")))
21998 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21999 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
22000 load-uncore load-misses)
22003 (mapcar (lambda (f)
22004 (or (org-load-noerror-mustsuffix (concat org-dir f))
22005 (and (string= org-dir contrib-dir)
22006 (org-load-noerror-mustsuffix (concat contrib-dir f)))
22007 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
22008 (add-to-list 'load-uncore f 'append)
22013 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
22014 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
22016 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
22017 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
22018 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
22021 (defun org-customize ()
22022 "Call the customize function with org as argument."
22024 (org-load-modules-maybe)
22025 (org-require-autoloaded-modules)
22026 (customize-browse 'org))
22028 (defun org-create-customize-menu ()
22029 "Create a full customization menu for Org-mode, insert it into the menu."
22031 (org-load-modules-maybe)
22032 (org-require-autoloaded-modules)
22033 (if (fboundp 'customize-menu-create)
22036 '("Org") "Customize"
22037 `(["Browse Org group" org-customize t]
22039 ,(customize-menu-create 'org)
22040 ["Set" Custom-set t]
22041 ["Save" Custom-save t]
22042 ["Reset to Current" Custom-reset-current t]
22043 ["Reset to Saved" Custom-reset-saved t]
22044 ["Reset to Standard Settings" Custom-reset-standard t]))
22045 (message "\"Org\"-menu now contains full customization menu"))
22046 (error "Cannot expand menu (outdated version of cus-edit.el)")))
22048 ;;;; Miscellaneous stuff
22050 ;;; Generally useful functions
22052 (defsubst org-get-at-eol (property n)
22053 "Get text property PROPERTY at the end of line less N characters."
22054 (get-text-property (- (point-at-eol) n) property))
22056 (defun org-find-text-property-in-string (prop s)
22057 "Return the first non-nil value of property PROP in string S."
22058 (or (get-text-property 0 prop s)
22059 (get-text-property (or (next-single-property-change 0 prop s) 0)
22062 (defun org-display-warning (message) ;; Copied from Emacs-Muse
22063 "Display the given MESSAGE as a warning."
22064 (if (fboundp 'display-warning)
22065 (display-warning 'org message
22066 (if (featurep 'xemacs) 'warning :warning))
22067 (let ((buf (get-buffer-create "*Org warnings*")))
22068 (with-current-buffer buf
22069 (goto-char (point-max))
22070 (insert "Warning (Org): " message)
22073 (display-buffer buf)
22076 (defun org-eval (form)
22077 "Eval FORM and return result."
22078 (condition-case error
22080 (error (format "%%![Error: %s]" error))))
22082 (defun org-in-clocktable-p ()
22083 "Check if the cursor is in a clocktable."
22084 (let ((pos (point)) start)
22087 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
22088 (setq start (match-beginning 0))
22089 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
22090 (>= (match-end 0) pos)
22093 (defun org-in-verbatim-emphasis ()
22095 (and (org-in-regexp org-emph-re 2)
22096 (>= (point) (match-beginning 3))
22097 (<= (point) (match-end 4))
22098 (member (match-string 3) '("=" "~")))))
22100 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22101 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22102 (if (and marker (marker-buffer marker)
22103 (buffer-live-p (marker-buffer marker)))
22105 (org-pop-to-buffer-same-window (marker-buffer marker))
22106 (if (or (> marker (point-max)) (< marker (point-min)))
22109 (org-show-context 'org-goto))
22111 (bookmark-jump bookmark)
22112 (error "Cannot find location"))))
22114 (defun org-quote-csv-field (s)
22115 "Quote field for inclusion in CSV material."
22116 (if (string-match "[\",]" s)
22117 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22120 (defun org-force-self-insert (N)
22121 "Needed to enforce self-insert under remapping."
22123 (self-insert-command N))
22125 (defun org-string-width (s)
22126 "Compute width of string, ignoring invisible characters.
22127 This ignores character with invisibility property `org-link', and also
22128 characters with property `org-cwidth', because these will become invisible
22129 upon the next fontification round."
22131 (when (or (eq t buffer-invisibility-spec)
22132 (assq 'org-link buffer-invisibility-spec))
22133 (while (setq b (text-property-any 0 (length s)
22134 'invisible 'org-link s))
22135 (setq s (concat (substring s 0 b)
22136 (substring s (or (next-single-property-change
22137 b 'invisible s) (length s)))))))
22138 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22139 (setq s (concat (substring s 0 b)
22140 (substring s (or (next-single-property-change
22141 b 'org-cwidth s) (length s))))))
22142 (setq l (string-width s) b -1)
22143 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22144 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22147 (defun org-shorten-string (s maxlength)
22148 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22149 If the string is shorter or has length MAXLENGTH, just return the
22150 original string. If it is longer, the functions finds a space in the
22151 string, breaks this string off at that locations and adds three dots
22152 as ellipsis. Including the ellipsis, the string will not be longer
22153 than MAXLENGTH. If finding a good breaking point in the string does
22154 not work, the string is just chopped off in the middle of a word
22156 (if (<= (length s) maxlength)
22158 (let* ((n (max (- maxlength 4) 1))
22159 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22160 (if (string-match re s)
22161 (concat (match-string 1 s) "...")
22162 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22164 (defun org-get-indentation (&optional line)
22165 "Get the indentation of the current line, interpreting tabs.
22166 When LINE is given, assume it represents a line and compute its indentation."
22168 (if (string-match "^ *" (org-remove-tabs line))
22171 (beginning-of-line 1)
22172 (skip-chars-forward " \t")
22173 (current-column))))
22175 (defun org-get-string-indentation (s)
22176 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22177 (let ((n -1) (i 0) (w tab-width) c)
22179 (while (< (setq n (1+ n)) (length s))
22180 (setq c (aref s n))
22181 (cond ((= c ?\ ) (setq i (1+ i)))
22182 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22183 (t (throw 'exit t)))))
22186 (defun org-remove-tabs (s &optional width)
22187 "Replace tabulators in S with spaces.
22188 Assumes that s is a single line, starting in column 0."
22189 (setq width (or width tab-width))
22190 (while (string-match "\t" s)
22191 (setq s (replace-match
22193 (- (* width (/ (+ (match-beginning 0) width) width))
22194 (match-beginning 0)) ?\ )
22198 (defun org-fix-indentation (line ind)
22199 "Fix indentation in LINE.
22200 IND is a cons cell with target and minimum indentation.
22201 If the current indentation in LINE is smaller than the minimum,
22202 leave it alone. If it is larger than ind, set it to the target."
22203 (let* ((l (org-remove-tabs line))
22204 (i (org-get-indentation l))
22205 (i1 (car ind)) (i2 (cdr ind)))
22206 (if (>= i i2) (setq l (substring line i2)))
22208 (concat (make-string i1 ?\ ) l)
22211 (defun org-remove-indentation (code &optional n)
22212 "Remove the maximum common indentation from the lines in CODE.
22213 N may optionally be the number of spaces to remove."
22216 (org-do-remove-indentation n)
22219 (defun org-do-remove-indentation (&optional n)
22220 "Remove the maximum common indentation from the buffer."
22221 (untabify (point-min) (point-max))
22222 (let ((min 10000) re)
22225 (goto-char (point-min))
22226 (while (re-search-forward "^ *[^ \n]" nil t)
22227 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22228 (unless (or (= min 0) (= min 10000))
22229 (setq re (format "^ \\{%d\\}" min))
22230 (goto-char (point-min))
22231 (while (re-search-forward re nil t)
22236 (defun org-fill-template (template alist)
22237 "Find each %key of ALIST in TEMPLATE and replace it."
22238 (let ((case-fold-search nil)
22240 (setq alist (sort (copy-sequence alist)
22241 (lambda (a b) (< (length (car a)) (length (car b))))))
22242 (while (setq entry (pop alist))
22244 (replace-regexp-in-string
22245 (concat "%" (regexp-quote (car entry)))
22246 (or (cdr entry) "") template t t)))
22249 (defun org-base-buffer (buffer)
22250 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22253 (or (buffer-base-buffer buffer)
22256 (defun org-wrap (string &optional width lines)
22257 "Wrap string to either a number of lines, or a width in characters.
22258 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22259 that costs. If there is a word longer than WIDTH, the text is actually
22260 wrapped to the length of that word.
22261 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22262 many lines, whatever width that takes.
22263 The return value is a list of lines, without newlines at the end."
22264 (let* ((words (org-split-string string "[ \t\n]+"))
22265 (maxword (apply 'max (mapcar 'org-string-width words)))
22268 (org-do-wrap words (max maxword width)))
22271 (setq ll (org-do-wrap words maxword))
22272 (if (<= (length ll) lines)
22275 (while (> (length ll) lines)
22277 (setq ll (org-do-wrap words w)))
22279 (t (error "Cannot wrap this")))))
22281 (defun org-do-wrap (words width)
22282 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22285 (setq line (pop words))
22286 (while (and words (< (+ (length line) (length (car words))) width))
22287 (setq line (concat line " " (pop words))))
22288 (setq lines (push line lines)))
22291 (defun org-split-string (string &optional separators)
22292 "Splits STRING into substrings at SEPARATORS.
22293 No empty strings are returned if there are matches at the beginning
22294 and end of string."
22295 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22299 (while (and (string-match rexp string
22301 (= start (match-beginning 0))
22302 (< start (length string)))
22304 (< (match-beginning 0) (length string)))
22306 (or (eq (match-beginning 0) 0)
22307 (and (eq (match-beginning 0) (match-end 0))
22308 (eq (match-beginning 0) start))
22310 (cons (substring string start (match-beginning 0))
22312 (setq start (match-end 0)))
22313 (or (eq start (length string))
22315 (cons (substring string start)
22319 (defun org-quote-vert (s)
22320 "Replace \"|\" with \"\\vert\"."
22321 (while (string-match "|" s)
22322 (setq s (replace-match "\\vert" t t s)))
22325 (defun org-uuidgen-p (s)
22326 "Is S an ID created by UUIDGEN?"
22327 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22329 (defun org-in-src-block-p (&optional inside)
22330 "Whether point is in a code source block.
22331 When INSIDE is non-nil, don't consider we are within a src block
22332 when point is at #+BEGIN_SRC or #+END_SRC."
22333 (let ((case-fold-search t) ov)
22334 (or (and (eq (get-char-property (point) 'src-block) t))
22338 (beginning-of-line)
22339 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22341 (defun org-context ()
22342 "Return a list of contexts of the current cursor position.
22343 If several contexts apply, all are returned.
22344 Each context entry is a list with a symbol naming the context, and
22345 two positions indicating start and end of the context. Possible
22348 :headline anywhere in a headline
22349 :headline-stars on the leading stars in a headline
22350 :todo-keyword on a TODO keyword (including DONE) in a headline
22351 :tags on the TAGS in a headline
22352 :priority on the priority cookie in a headline
22353 :item on the first line of a plain list item
22354 :item-bullet on the bullet/number of a plain list item
22355 :checkbox on the checkbox in a plain list item
22356 :table in an org-mode table
22357 :table-special on a special filed in a table
22358 :table-table in a table.el table
22359 :clocktable in a clocktable
22360 :src-block in a source block
22361 :link on a hyperlink
22362 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22363 :target on a <<target>>
22364 :radio-target on a <<<radio-target>>>
22365 :latex-fragment on a LaTeX fragment
22366 :latex-preview on a LaTeX fragment with overlaid preview image
22368 This function expects the position to be visible because it uses font-lock
22369 faces as a help to recognize the following contexts: :table-special, :link,
22371 (let* ((f (get-text-property (point) 'face))
22372 (faces (if (listp f) f (list f)))
22373 (case-fold-search t)
22374 (p (point)) clist o)
22375 ;; First the large context
22377 ((org-at-heading-p t)
22378 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22380 (beginning-of-line 1)
22381 (looking-at org-todo-line-tags-regexp))
22382 (push (org-point-in-group p 1 :headline-stars) clist)
22383 (push (org-point-in-group p 2 :todo-keyword) clist)
22384 (push (org-point-in-group p 4 :tags) clist))
22386 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22387 (if (looking-at "\\[#[A-Z0-9]\\]")
22388 (push (org-point-in-group p 0 :priority) clist)))
22391 (push (org-point-in-group p 2 :item-bullet) clist)
22392 (push (list :item (point-at-bol)
22393 (save-excursion (org-end-of-item) (point)))
22395 (and (org-at-item-checkbox-p)
22396 (push (org-point-in-group p 0 :checkbox) clist)))
22399 (push (list :table (org-table-begin) (org-table-end)) clist)
22400 (if (memq 'org-formula faces)
22401 (push (list :table-special
22402 (previous-single-property-change p 'face)
22403 (next-single-property-change p 'face)) clist)))
22404 ((org-at-table-p 'any)
22405 (push (list :table-table) clist)))
22408 (let ((case-fold-search t))
22409 ;; New the "medium" contexts: clocktables, source blocks
22410 (cond ((org-in-clocktable-p)
22411 (push (list :clocktable
22412 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22413 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22414 (match-beginning 1))
22415 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22416 (match-end 0))) clist))
22417 ((org-in-src-block-p)
22418 (push (list :src-block
22419 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22420 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22421 (match-beginning 1))
22422 (and (search-forward "#+END_SRC" nil t)
22423 (match-beginning 0))) clist))))
22426 ;; Now the small context
22428 ((org-at-timestamp-p)
22429 (push (org-point-in-group p 0 :timestamp) clist))
22430 ((memq 'org-link faces)
22432 (previous-single-property-change p 'face)
22433 (next-single-property-change p 'face)) clist))
22434 ((memq 'org-special-keyword faces)
22435 (push (list :keyword
22436 (previous-single-property-change p 'face)
22437 (next-single-property-change p 'face)) clist))
22439 (push (org-point-in-group p 0 :target) clist)
22440 (goto-char (1- (match-beginning 0)))
22441 (if (looking-at org-radio-target-regexp)
22442 (push (org-point-in-group p 0 :radio-target) clist))
22444 ((setq o (car (delq nil
22447 (if (memq x org-latex-fragment-image-overlays) x))
22448 (overlays-at (point))))))
22449 (push (list :latex-fragment
22450 (overlay-start o) (overlay-end o)) clist)
22451 (push (list :latex-preview
22452 (overlay-start o) (overlay-end o)) clist))
22453 ((org-inside-LaTeX-fragment-p)
22454 ;; FIXME: positions wrong.
22455 (push (list :latex-fragment (point) (point)) clist)))
22457 (setq clist (nreverse (delq nil clist)))
22460 (defun org-in-regexp (re &optional nlines visually)
22461 "Check if point is inside a match of RE.
22463 Normally only the current line is checked, but you can include
22464 NLINES extra lines after point into the search. If VISUALLY is
22465 set, require that the cursor is not after the match but really
22466 on, so that the block visually is on the match."
22468 (let ((pos (point))
22469 (eol (point-at-eol (+ 1 (or nlines 0))))
22470 (inc (if visually 1 0)))
22472 (beginning-of-line (- 1 (or nlines 0)))
22473 (while (re-search-forward re eol t)
22474 (if (and (<= (match-beginning 0) pos)
22475 (>= (+ inc (match-end 0)) pos))
22476 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22477 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22480 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22481 "Non-nil when point is between matches of START-RE and END-RE.
22483 Also return a non-nil value when point is on one of the matches.
22485 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22486 buffer positions. Default values are the positions of headlines
22487 surrounding the point.
22489 The functions returns a cons cell whose car (resp. cdr) is the
22490 position before START-RE (resp. after END-RE)."
22492 (let ((pos (point))
22493 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22494 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22497 ;; Point is on a block when on START-RE or if START-RE can be
22498 ;; found before it...
22499 (and (or (org-in-regexp start-re)
22500 (re-search-backward start-re limit-up t))
22501 (setq beg (match-beginning 0))
22502 ;; ... and END-RE after it...
22503 (goto-char (match-end 0))
22504 (re-search-forward end-re limit-down t)
22505 (> (setq end (match-end 0)) pos)
22506 ;; ... without another START-RE in-between.
22507 (goto-char (match-beginning 0))
22508 (not (re-search-backward start-re (1+ beg) t))
22510 (cons beg end))))))
22512 (defun org-in-block-p (names)
22513 "Non-nil when point belongs to a block whose name belongs to NAMES.
22515 NAMES is a list of strings containing names of blocks.
22517 Return first block name matched, or nil. Beware that in case of
22518 nested blocks, the returned name may not belong to the closest
22522 (let ((case-fold-search t)
22523 (lim-up (save-excursion (outline-previous-heading)))
22524 (lim-down (save-excursion (outline-next-heading))))
22525 (mapc (lambda (name)
22526 (let ((n (regexp-quote name)))
22527 (when (org-between-regexps-p
22528 (concat "^[ \t]*#\\+begin_" n)
22529 (concat "^[ \t]*#\\+end_" n)
22535 (defun org-occur-in-agenda-files (regexp &optional nlines)
22536 "Call `multi-occur' with buffers for all agenda files."
22537 (interactive "sOrg-files matching: \np")
22538 (let* ((files (org-agenda-files))
22539 (tnames (mapcar 'file-truename files))
22540 (extra org-agenda-text-search-extra-files)
22542 (when (eq (car extra) 'agenda-archives)
22543 (setq extra (cdr extra))
22544 (setq files (org-add-archive-files files)))
22545 (while (setq f (pop extra))
22546 (unless (member (file-truename f) tnames)
22547 (add-to-list 'files f 'append)
22548 (add-to-list 'tnames (file-truename f) 'append)))
22550 (mapcar (lambda (x)
22551 (with-current-buffer
22552 (or (get-file-buffer x) (find-file-noselect x))
22558 (if (boundp 'occur-mode-find-occurrence-hook)
22560 (add-hook 'occur-mode-find-occurrence-hook
22562 (when (derived-mode-p 'org-mode)
22565 (defadvice occur-mode-goto-occurrence
22566 (after org-occur-reveal activate)
22567 (and (derived-mode-p 'org-mode) (org-reveal)))
22568 (defadvice occur-mode-goto-occurrence-other-window
22569 (after org-occur-reveal activate)
22570 (and (derived-mode-p 'org-mode) (org-reveal)))
22571 (defadvice occur-mode-display-occurrence
22572 (after org-occur-reveal activate)
22573 (when (derived-mode-p 'org-mode)
22574 (let ((pos (occur-mode-find-occurrence)))
22575 (with-current-buffer (marker-buffer pos)
22580 (defun org-occur-link-in-agenda-files ()
22581 "Create a link and search for it in the agendas.
22582 The link is not stored in `org-stored-links', it is just created
22583 for the search purpose."
22585 (let ((link (condition-case nil
22586 (org-store-link nil)
22587 (error "Unable to create a link to here"))))
22588 (org-occur-in-agenda-files (regexp-quote link))))
22590 (defun org-reverse-string (string)
22591 "Return the reverse of STRING."
22592 (apply 'string (reverse (string-to-list string))))
22594 ;; defsubst org-uniquify must be defined before first use
22596 (defun org-uniquify-alist (alist)
22597 "Merge elements of ALIST with the same key.
22599 For example, in this alist:
22601 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22602 => '((a 1 3) (b 2))
22604 merge (a 1) and (a 3) into (a 1 3).
22606 The function returns the new ALIST."
22611 (if (not (assoc (car e) rtn))
22613 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22614 (setq rtn (assq-delete-all (car e) rtn))
22619 (defun org-delete-all (elts list)
22620 "Remove all elements in ELTS from LIST."
22622 (setq list (delete (pop elts) list)))
22625 (defun org-count (cl-item cl-seq)
22626 "Count the number of occurrences of ITEM in SEQ.
22627 Taken from `count' in cl-seq.el with all keyword arguments removed."
22628 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22629 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22630 (while (< cl-start cl-end)
22631 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22632 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22633 (setq cl-start (1+ cl-start)))
22636 (defun org-remove-if (predicate seq)
22637 "Remove everything from SEQ that fulfills PREDICATE."
22641 (if (not (funcall predicate e)) (push e res)))
22644 (defun org-remove-if-not (predicate seq)
22645 "Remove everything from SEQ that does not fulfill PREDICATE."
22649 (if (funcall predicate e) (push e res)))
22652 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22653 "Reduce two-argument FUNCTION across SEQ.
22654 Taken from `reduce' in cl-seq.el with all keyword arguments but
22655 \":initial-value\" removed."
22656 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22657 (cadr (memq :initial-value cl-keys)))
22658 (cl-seq (pop cl-seq))
22659 (t (funcall cl-func)))))
22661 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22664 (defun org-every (pred seq)
22665 "Return true if PREDICATE is true of every element of SEQ.
22666 Adapted from `every' in cl.el."
22668 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22671 (defun org-some (pred seq)
22672 "Return true if PREDICATE is true of any element of SEQ.
22673 Adapted from `some' in cl.el."
22675 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22678 (defun org-back-over-empty-lines ()
22679 "Move backwards over whitespace, to the beginning of the first empty line.
22680 Returns the number of empty lines passed."
22681 (let ((pos (point)))
22682 (if (cdr (assoc 'heading org-blank-before-new-entry))
22683 (skip-chars-backward " \t\n\r")
22685 (forward-line -1)))
22686 (beginning-of-line 2)
22687 (goto-char (min (point) pos))
22688 (count-lines (point) pos)))
22690 (defun org-skip-whitespace ()
22691 (skip-chars-forward " \t\n\r"))
22693 (defun org-point-in-group (point group &optional context)
22694 "Check if POINT is in match-group GROUP.
22695 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22696 match. If the match group does not exist or point is not inside it,
22698 (and (match-beginning group)
22699 (>= point (match-beginning group))
22700 (<= point (match-end group))
22702 (list context (match-beginning group) (match-end group))
22705 (defun org-switch-to-buffer-other-window (&rest args)
22706 "Switch to buffer in a second window on the current frame.
22707 In particular, do not allow pop-up frames.
22708 Returns the newly created buffer."
22710 (apply 'switch-to-buffer-other-window args)))
22712 (defun org-combine-plists (&rest plists)
22713 "Create a single property list from all plists in PLISTS.
22714 The process starts by copying the first list, and then setting properties
22715 from the other lists. Settings in the last list are the most significant
22716 ones and overrule settings in the other lists."
22717 (let ((rtn (copy-sequence (pop plists)))
22720 (setq ls (pop plists))
22722 (setq p (pop ls) v (pop ls))
22723 (setq rtn (plist-put rtn p v))))
22726 (defun org-replace-escapes (string table)
22727 "Replace %-escapes in STRING with values in TABLE.
22728 TABLE is an association list with keys like \"%a\" and string values.
22729 The sequences in STRING may contain normal field width and padding information,
22730 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22731 so values can contain further %-escapes if they are define later in TABLE."
22732 (let ((tbl (copy-alist table))
22733 (case-fold-search nil)
22736 (while (setq e (pop tbl))
22737 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22738 (when (and (cdr e) (string-match re (cdr e)))
22739 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22741 (add-text-properties 0 3 (list 'sref sref) safe)
22742 (setcdr e (replace-match safe t t (cdr e)))))
22743 (while (string-match re string)
22744 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22746 (setq string (replace-match rpl t t string))))
22747 (while (setq pchg (next-property-change pchg string))
22748 (let ((sref (get-text-property pchg 'sref string)))
22749 (when (and sref (string-match "SREF" string pchg))
22750 (setq string (replace-match sref t t string)))))
22753 (defun org-sublist (list start end)
22754 "Return a section of LIST, from START to END.
22755 Counting starts at 1."
22756 (let (rtn (c start))
22757 (setq list (nthcdr (1- start) list))
22758 (while (and list (<= c end))
22759 (push (pop list) rtn)
22763 (defun org-find-base-buffer-visiting (file)
22764 "Like `find-buffer-visiting' but always return the base buffer and
22765 not an indirect buffer."
22766 (let ((buf (or (get-file-buffer file)
22767 (find-buffer-visiting file))))
22769 (or (buffer-base-buffer buf) buf)
22772 (defun org-image-file-name-regexp (&optional extensions)
22773 "Return regexp matching the file names of images.
22774 If EXTENSIONS is given, only match these."
22775 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22776 (image-file-name-regexp)
22777 (let ((image-file-name-extensions
22779 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22780 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22782 (regexp-opt (nconc (mapcar 'upcase
22783 image-file-name-extensions)
22784 image-file-name-extensions)
22788 (defun org-file-image-p (file &optional extensions)
22789 "Return non-nil if FILE is an image."
22791 (string-match (org-image-file-name-regexp extensions) file)))
22793 (defun org-get-cursor-date (&optional with-time)
22794 "Return the date at cursor in as a time.
22795 This works in the calendar and in the agenda, anywhere else it just
22796 returns the current time.
22797 If WITH-TIME is non-nil, returns the time of the event at point (in
22798 the agenda) or the current time of the day."
22799 (let (date day defd tp tm hod mod)
22801 (setq tp (get-text-property (point) 'time))
22802 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22803 (setq hod (string-to-number (match-string 1 tp))
22804 mod (string-to-number (match-string 2 tp))))
22805 (or tp (setq hod (nth 2 (decode-time (current-time)))
22806 mod (nth 1 (decode-time (current-time))))))
22808 ((eq major-mode 'calendar-mode)
22809 (setq date (calendar-cursor-to-date)
22810 defd (encode-time 0 (or mod 0) (or hod 0)
22811 (nth 1 date) (nth 0 date) (nth 2 date))))
22812 ((eq major-mode 'org-agenda-mode)
22813 (setq day (get-text-property (point) 'day))
22815 (setq date (calendar-gregorian-from-absolute day)
22816 defd (encode-time 0 (or mod 0) (or hod 0)
22817 (nth 1 date) (nth 0 date) (nth 2 date))))))
22818 (or defd (current-time))))
22820 (defun org-mark-subtree (&optional up)
22821 "Mark the current subtree.
22822 This puts point at the start of the current subtree, and mark at
22823 the end. If a numeric prefix UP is given, move up into the
22824 hierarchy of headlines by UP levels before marking the subtree."
22826 (org-with-limited-levels
22827 (cond ((org-at-heading-p) (beginning-of-line))
22828 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22829 (t (outline-previous-visible-heading 1))))
22830 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22831 (if (org-called-interactively-p 'any)
22832 (call-interactively 'org-mark-element)
22833 (org-mark-element)))
22838 (defun org--get-expected-indentation (element contentsp)
22839 "Expected indentation column for current line, according to ELEMENT.
22840 ELEMENT is an element containing point. CONTENTSP is non-nil
22841 when indentation is to be computed according to contents of
22843 (let ((type (org-element-type element))
22844 (start (org-element-property :begin element))
22845 (post-affiliated (org-element-property :post-affiliated element)))
22846 (org-with-wide-buffer
22850 ((diary-sexp footnote-definition) 0)
22851 ((headline inlinetask nil)
22852 (if (not org-adapt-indentation) 0
22853 (let ((level (org-current-level)))
22854 (if level (1+ level) 0))))
22855 ((item plain-list) (org-list-item-body-column post-affiliated))
22858 (org-get-indentation))))
22859 ((memq type '(headline inlinetask nil))
22860 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22861 (org--get-expected-indentation element t)
22863 ((memq type '(diary-sexp footnote-definition)) 0)
22864 ;; First paragraph of a footnote definition or an item.
22865 ;; Indent like parent.
22866 ((< (line-beginning-position) start)
22867 (org--get-expected-indentation
22868 (org-element-property :parent element) t))
22869 ;; At first line: indent according to previous sibling, if any,
22870 ;; ignoring footnote definitions and inline tasks, or parent's
22872 ((= (line-beginning-position) start)
22875 (if (= (point-min) start) (throw 'exit 0)
22876 (goto-char (1- start))
22877 (let* ((previous (org-element-at-point))
22879 (while (and parent (<= (org-element-property :end parent) start))
22880 (setq previous parent
22881 parent (org-element-property :parent parent)))
22883 ((not previous) (throw 'exit 0))
22884 ((> (org-element-property :end previous) start)
22885 (throw 'exit (org--get-expected-indentation previous t)))
22886 ((memq (org-element-type previous)
22887 '(footnote-definition inlinetask))
22888 (setq start (org-element-property :begin previous)))
22889 (t (goto-char (org-element-property :begin previous))
22891 (if (bolp) (org-get-indentation)
22892 ;; At first paragraph in an item or
22893 ;; a footnote definition.
22894 (org--get-expected-indentation
22895 (org-element-property :parent previous) t))))))))))
22896 ;; Otherwise, move to the first non-blank line above.
22898 (beginning-of-line)
22899 (let ((pos (point)))
22900 (skip-chars-backward " \r\t\n")
22902 ;; Two blank lines end a footnote definition or a plain
22903 ;; list. When we indent an empty line after them, the
22904 ;; containing list or footnote definition is over, so it
22905 ;; qualifies as a previous sibling. Therefore, we indent
22906 ;; like its first line.
22907 ((and (memq type '(footnote-definition plain-list))
22908 (> (count-lines (point) pos) 2))
22910 (org-get-indentation))
22911 ;; Line above is the first one of a paragraph at the
22912 ;; beginning of an item or a footnote definition. Indent
22914 ((< (line-beginning-position) start)
22915 (org--get-expected-indentation
22916 (org-element-property :parent element) t))
22917 ;; Line above is the beginning of an element, i.e., point
22918 ;; was originally on the blank lines between element's start
22920 ((= (line-beginning-position) post-affiliated)
22921 (org--get-expected-indentation element t))
22922 ;; POS is after contents in a greater element. Indent like
22923 ;; the beginning of the element.
22925 ;; As a special case, if point is at the end of a footnote
22926 ;; definition or an item, indent like the very last element
22928 ((and (not (eq type 'paragraph))
22929 (let ((cend (org-element-property :contents-end element)))
22930 (and cend (<= cend pos))))
22931 (if (memq type '(footnote-definition item plain-list))
22932 (let ((last (org-element-at-point)))
22933 (org--get-expected-indentation
22935 (memq (org-element-type last)
22936 '(footnote-definition item plain-list))))
22938 (org-get-indentation)))
22939 ;; In any other case, indent like the current line.
22940 (t (org-get-indentation)))))))))
22942 (defun org--align-node-property ()
22943 "Align node property at point.
22944 Alignment is done according to `org-property-format', which see."
22945 (when (save-excursion
22946 (beginning-of-line)
22947 (looking-at org-property-re))
22949 (concat (match-string 4)
22951 (format org-property-format (match-string 1) (match-string 3))))
22954 (defun org-indent-line ()
22955 "Indent line depending on context.
22957 Indentation is done according to the following rules:
22959 - Footnote definitions, diary sexps, headlines and inline tasks
22960 have to start at column 0.
22962 - On the very first line of an element, consider, in order, the
22963 next rules until one matches:
22965 1. If there's a sibling element before, ignoring footnote
22966 definitions and inline tasks, indent like its first line.
22968 2. If element has a parent, indent like its contents. More
22969 precisely, if parent is an item, indent after the
22970 description part, if any, or the bullet (see
22971 `org-list-description-max-indent'). Else, indent like
22972 parent's first line.
22974 3. Otherwise, indent relatively to current level, if
22975 `org-adapt-indentation' is non-nil, or to left margin.
22977 - On a blank line at the end of an element, indent according to
22978 the type of the element. More precisely
22980 1. If element is a plain list, an item, or a footnote
22981 definition, indent like the very last element within.
22983 2. If element is a paragraph, indent like its last non blank
22986 3. Otherwise, indent like its very first line.
22988 - In the code part of a source block, use language major mode
22989 to indent current line if `org-src-tab-acts-natively' is
22990 non-nil. If it is nil, do nothing.
22992 - Otherwise, indent like the first non-blank line above.
22994 The function doesn't indent an item as it could break the whole
22995 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22996 \\[org-shiftmetaright].
22998 Also align node properties according to `org-property-format'."
23002 (let ((indent-line-function
23003 (cadadr (assq 'indent-line-function org-fb-vars))))
23004 (indent-according-to-mode)))
23005 ((org-at-heading-p) 'noindent)
23007 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
23008 (type (org-element-type element)))
23009 (cond ((and (memq type '(plain-list item))
23010 (= (line-beginning-position)
23011 (org-element-property :post-affiliated element)))
23013 ((and (eq type 'src-block)
23014 org-src-tab-acts-natively
23015 (> (line-beginning-position)
23016 (org-element-property :post-affiliated element))
23017 (< (line-beginning-position)
23018 (org-with-wide-buffer
23019 (goto-char (org-element-property :end element))
23020 (skip-chars-backward " \r\t\n")
23021 (line-beginning-position))))
23022 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
23024 (let ((column (org--get-expected-indentation element nil)))
23025 ;; Preserve current column.
23026 (if (<= (current-column) (current-indentation))
23027 (org-indent-line-to column)
23028 (save-excursion (org-indent-line-to column))))
23029 ;; Align node property. Also preserve current column.
23030 (when (eq type 'node-property)
23031 (let ((column (current-column)))
23032 (org--align-node-property)
23033 (org-move-to-column column)))))))))
23035 (defun org-indent-region (start end)
23036 "Indent each non-blank line in the region.
23037 Called from a program, START and END specify the region to
23038 indent. The function will not indent contents of example blocks,
23039 verse blocks and export blocks as leading white spaces are
23040 assumed to be significant there."
23044 (skip-chars-forward " \r\t\n")
23045 (unless (eobp) (beginning-of-line))
23048 ;; Set IND as indentation for all lines between point and
23049 ;; POS or END, whichever comes first. Blank lines are
23050 ;; ignored. Leave point after POS once done.
23051 (let ((limit (copy-marker (min end pos))))
23052 (while (< (point) limit)
23053 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
23055 (set-marker limit nil))))
23056 (end (copy-marker end)))
23057 (while (< (point) end)
23058 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
23059 (let* ((element (org-element-at-point))
23060 (type (org-element-type element))
23061 (element-end (copy-marker (org-element-property :end element)))
23062 (ind (org--get-expected-indentation element nil)))
23064 ((or (memq type '(paragraph table table-row))
23065 (not (or (org-element-property :contents-begin element)
23067 '(example-block export-block src-block)))))
23068 ;; Elements here are indented as a single block. Also
23069 ;; align node properties.
23070 (when (eq type 'node-property)
23071 (org--align-node-property)
23072 (beginning-of-line))
23073 (funcall indent-to ind element-end))
23075 ;; Elements in this category consist of three parts:
23076 ;; before the contents, the contents, and after the
23077 ;; contents. The contents are treated specially,
23078 ;; according to the element type, or not indented at
23079 ;; all. Other parts are indented as a single block.
23080 (let* ((post (copy-marker
23081 (org-element-property :post-affiliated element)))
23085 ((not (org-element-property :contents-begin element))
23086 ;; Fake contents for source blocks.
23087 (org-with-wide-buffer
23091 ((memq type '(footnote-definition item plain-list))
23092 ;; Contents in these elements could start on
23093 ;; the same line as the beginning of the
23094 ;; element. Make sure we start indenting
23095 ;; from the second line.
23096 (org-with-wide-buffer
23099 (skip-chars-forward " \r\t\n")
23100 (if (eobp) (point) (line-beginning-position))))
23101 (t (org-element-property :contents-begin element)))))
23103 (or (org-element-property :contents-end element)
23104 ;; Fake contents for source blocks.
23105 (org-with-wide-buffer
23106 (goto-char element-end)
23107 (skip-chars-backward " \r\t\n")
23108 (line-beginning-position)))
23110 ;; Do not change items indentation individually as it
23111 ;; might break the list as a whole. On the other
23112 ;; hand, when at a plain list, indent it as a whole.
23113 (cond ((eq type 'plain-list)
23114 (let ((offset (- ind (org-get-indentation))))
23115 (unless (zerop offset)
23116 (indent-rigidly (org-element-property :begin element)
23117 (org-element-property :end element)
23120 ((eq type 'item) (goto-char cbeg))
23121 (t (funcall indent-to ind cbeg)))
23122 (when (< (point) end)
23124 ((example-block export-block verse-block))
23126 ;; In a source block, indent source code
23127 ;; according to language major mode, but only if
23128 ;; `org-src-tab-acts-natively' is non-nil.
23129 (when (and (< (point) end) org-src-tab-acts-natively)
23131 (org-babel-do-in-edit-buffer
23132 (indent-region (point-min) (point-max))))))
23133 (t (org-indent-region (point) (min cend end))))
23134 (goto-char (min cend end))
23135 (when (< (point) end) (funcall indent-to ind element-end)))
23136 (set-marker post nil)
23137 (set-marker cbeg nil)
23138 (set-marker cend nil))))
23139 (set-marker element-end nil))))
23140 (set-marker end nil))))
23142 (defun org-indent-drawer ()
23143 "Indent the drawer at point."
23145 (unless (save-excursion
23146 (beginning-of-line)
23147 (org-looking-at-p org-drawer-regexp))
23148 (user-error "Not at a drawer"))
23149 (let ((element (org-element-at-point)))
23150 (unless (memq (org-element-type element) '(drawer property-drawer))
23151 (user-error "Not at a drawer"))
23152 (org-with-wide-buffer
23153 (org-indent-region (org-element-property :begin element)
23154 (org-element-property :end element))))
23155 (message "Drawer at point indented"))
23157 (defun org-indent-block ()
23158 "Indent the block at point."
23160 (unless (save-excursion
23161 (beginning-of-line)
23162 (let ((case-fold-search t))
23163 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23164 (user-error "Not at a block"))
23165 (let ((element (org-element-at-point)))
23166 (unless (memq (org-element-type element)
23167 '(comment-block center-block dynamic-block example-block
23168 export-block quote-block special-block
23169 src-block verse-block))
23170 (user-error "Not at a block"))
23171 (org-with-wide-buffer
23172 (org-indent-region (org-element-property :begin element)
23173 (org-element-property :end element))))
23174 (message "Block at point indented"))
23179 ;; We use our own fill-paragraph and auto-fill functions.
23181 ;; `org-fill-paragraph' relies on adaptive filling and context
23182 ;; checking. Appropriate `fill-prefix' is computed with
23183 ;; `org-adaptive-fill-function'.
23185 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23186 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23187 ;; `org-adaptive-fill-function' value. Internally,
23188 ;; `org-comment-line-break-function' breaks the line.
23190 ;; `org-setup-filling' installs filling and auto-filling related
23191 ;; variables during `org-mode' initialization.
23193 (defvar org-element-paragraph-separate) ; org-element.el
23194 (defun org-setup-filling ()
23195 (require 'org-element)
23196 ;; Prevent auto-fill from inserting unwanted new items.
23197 (when (boundp 'fill-nobreak-predicate)
23199 'fill-nobreak-predicate
23201 (append fill-nobreak-predicate
23202 '(org-fill-line-break-nobreak-p
23203 org-fill-paragraph-with-timestamp-nobreak-p)))))
23204 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23205 (org-set-local 'paragraph-start paragraph-ending)
23206 (org-set-local 'paragraph-separate paragraph-ending))
23207 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23208 (org-set-local 'auto-fill-inhibit-regexp nil)
23209 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23210 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23211 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23213 (defun org-fill-line-break-nobreak-p ()
23214 "Non-nil when a new line at point would create an Org line break."
23216 (skip-chars-backward "[ \t]")
23217 (skip-chars-backward "\\\\")
23218 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23220 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23221 "Non-nil when a new line at point would split a timestamp."
23222 (and (org-at-timestamp-p t)
23223 (not (looking-at org-ts-regexp-both))))
23225 (declare-function message-in-body-p "message" ())
23226 (defvar orgtbl-line-start-regexp) ; From org-table.el
23227 (defun org-adaptive-fill-function ()
23228 "Compute a fill prefix for the current line.
23229 Return fill prefix, as a string, or nil if current line isn't
23230 meant to be filled. For convenience, if `adaptive-fill-regexp'
23231 matches in paragraphs or comments, use it."
23233 (when (derived-mode-p 'message-mode)
23235 (beginning-of-line)
23236 (cond ((not (message-in-body-p)) (throw 'exit nil))
23237 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23238 ((looking-at message-cite-prefix-regexp)
23239 (throw 'exit (match-string-no-properties 0)))
23240 ((looking-at org-outline-regexp)
23241 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23242 (org-with-wide-buffer
23243 (unless (org-at-heading-p)
23244 (let* ((p (line-beginning-position))
23245 (element (save-excursion
23246 (beginning-of-line)
23247 (org-element-at-point)))
23248 (type (org-element-type element))
23249 (post-affiliated (org-element-property :post-affiliated element)))
23250 (unless (< p post-affiliated)
23254 (beginning-of-line)
23255 (looking-at "[ \t]*")
23256 (concat (match-string 0) "# ")))
23257 (footnote-definition "")
23259 (make-string (org-list-item-body-column post-affiliated) ?\s))
23261 ;; Fill prefix is usually the same as the current line,
23262 ;; unless the paragraph is at the beginning of an item.
23263 (let ((parent (org-element-property :parent element)))
23265 (beginning-of-line)
23266 (cond ((eq (org-element-type parent) 'item)
23267 (make-string (org-list-item-body-column
23268 (org-element-property :begin parent))
23270 ((and adaptive-fill-regexp
23272 ;; `adaptive-fill-function' to let
23273 ;; `fill-context-prefix' handle
23274 ;; `adaptive-fill-regexp' variable.
23275 (let (adaptive-fill-function)
23276 (fill-context-prefix
23278 (org-element-property :end element)))))
23279 ((looking-at "[ \t]+") (match-string 0))
23282 ;; Only fill contents if P is within block boundaries.
23283 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23286 (cend (save-excursion
23287 (goto-char (org-element-property :end element))
23288 (skip-chars-backward " \r\t\n")
23289 (line-beginning-position))))
23290 (when (and (>= p cbeg) (< p cend))
23291 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23295 (declare-function message-goto-body "message" ())
23296 (defvar message-cite-prefix-regexp) ; From message.el
23297 (defun org-fill-paragraph (&optional justify)
23298 "Fill element at point, when applicable.
23300 This function only applies to comment blocks, comments, example
23301 blocks and paragraphs. Also, as a special case, re-align table
23302 when point is at one.
23304 If JUSTIFY is non-nil (interactively, with prefix argument),
23305 justify as well. If `sentence-end-double-space' is non-nil, then
23306 period followed by one space does not end a sentence, so don't
23307 break a line there. The variable `fill-column' controls the
23310 For convenience, when point is at a plain list, an item or
23311 a footnote definition, try to fill the first paragraph within."
23313 (if (and (derived-mode-p 'message-mode)
23314 (or (not (message-in-body-p))
23315 (save-excursion (move-beginning-of-line 1)
23316 (looking-at message-cite-prefix-regexp))))
23317 ;; First ensure filling is correct in message-mode.
23318 (let ((fill-paragraph-function
23319 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23320 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23321 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23322 (paragraph-separate
23323 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23324 (fill-paragraph nil))
23325 (with-syntax-table org-mode-transpose-word-syntax-table
23326 ;; Move to end of line in order to get the first paragraph
23327 ;; within a plain list or a footnote definition.
23328 (let ((element (save-excursion
23330 (or (ignore-errors (org-element-at-point))
23331 (user-error "An element cannot be parsed line %d"
23332 (line-number-at-pos (point)))))))
23333 ;; First check if point is in a blank line at the beginning of
23334 ;; the buffer. In that case, ignore filling.
23335 (case (org-element-type element)
23336 ;; Use major mode filling function is src blocks.
23337 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23338 ;; Align Org tables, leave table.el tables as-is.
23339 (table-row (org-table-align) t)
23341 (when (eq (org-element-property :type element) 'org)
23343 (goto-char (org-element-property :post-affiliated element))
23344 (org-table-align)))
23347 ;; Paragraphs may contain `line-break' type objects.
23348 (let ((beg (max (point-min)
23349 (org-element-property :contents-begin element)))
23350 (end (min (point-max)
23351 (org-element-property :contents-end element))))
23352 ;; Do nothing if point is at an affiliated keyword.
23353 (if (< (line-end-position) beg) t
23354 (when (derived-mode-p 'message-mode)
23355 ;; In `message-mode', do not fill following citation
23356 ;; in current paragraph nor text before message body.
23357 (let ((body-start (save-excursion (message-goto-body))))
23358 (when body-start (setq beg (max body-start beg))))
23359 (when (save-excursion
23361 (concat "^" message-cite-prefix-regexp) end t))
23362 (setq end (match-beginning 0))))
23363 ;; Fill paragraph, taking line breaks into account.
23366 (let ((cuts (list beg)))
23367 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23368 (when (eq 'line-break
23370 (save-excursion (backward-char)
23371 (org-element-context))))
23372 (push (point) cuts)))
23373 (dolist (c (delq end cuts))
23374 (fill-region-as-paragraph c end justify)
23377 ;; Contents of `comment-block' type elements should be
23378 ;; filled as plain text, but only if point is within block
23381 (let* ((case-fold-search t)
23382 (beg (save-excursion
23383 (goto-char (org-element-property :begin element))
23384 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23387 (end (save-excursion
23388 (goto-char (org-element-property :end element))
23389 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23390 (line-beginning-position))))
23391 (if (or (< (point) beg) (> (point) end)) t
23392 (fill-region-as-paragraph
23393 (save-excursion (end-of-line)
23394 (re-search-backward "^[ \t]*$" beg 'move)
23395 (line-beginning-position))
23396 (save-excursion (beginning-of-line)
23397 (re-search-forward "^[ \t]*$" end 'move)
23398 (line-beginning-position))
23402 (let ((begin (org-element-property :post-affiliated element))
23403 (end (org-element-property :end element)))
23404 (when (and (>= (point) begin) (<= (point) end))
23405 (let ((begin (save-excursion
23407 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23408 (progn (forward-line) (point))
23410 (end (save-excursion
23412 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23413 (1- (line-beginning-position))
23414 (skip-chars-backward " \r\t\n")
23415 (line-end-position)))))
23416 ;; Do not fill comments when at a blank line.
23417 (when (> end begin)
23420 (beginning-of-line)
23421 (looking-at "[ \t]*#")
23422 (let ((comment-prefix (match-string 0)))
23423 (goto-char (match-end 0))
23424 (if (looking-at adaptive-fill-regexp)
23425 (concat comment-prefix (match-string 0))
23426 (concat comment-prefix " "))))))
23428 (fill-region-as-paragraph begin end justify))))))
23430 ;; Ignore every other element.
23433 (defun org-auto-fill-function ()
23434 "Auto-fill function."
23435 ;; Check if auto-filling is meaningful.
23436 (let ((fc (current-fill-column)))
23437 (when (and fc (> (current-column) fc))
23438 (let* ((fill-prefix (org-adaptive-fill-function))
23439 ;; Enforce empty fill prefix, if required. Otherwise, it
23440 ;; will be computed again.
23441 (adaptive-fill-mode (not (equal fill-prefix ""))))
23442 (when fill-prefix (do-auto-fill))))))
23444 (defun org-comment-line-break-function (&optional soft)
23445 "Break line at point and indent, continuing comment if within one.
23446 The inserted newline is marked hard if variable
23447 `use-hard-newlines' is true, unless optional argument SOFT is
23449 (if soft (insert-and-inherit ?\n) (newline 1))
23450 (save-excursion (forward-char -1) (delete-horizontal-space))
23451 (delete-horizontal-space)
23452 (indent-to-left-margin)
23453 (insert-before-markers-and-inherit fill-prefix))
23456 ;;; Fixed Width Areas
23458 (defun org-toggle-fixed-width ()
23459 "Toggle fixed-width markup.
23461 Add or remove fixed-width markup on current line, whenever it
23462 makes sense. Return an error otherwise.
23464 If a region is active and if it contains only fixed-width areas
23465 or blank lines, remove all fixed-width markup in it. If the
23466 region contains anything else, convert all non-fixed-width lines
23467 to fixed-width ones.
23469 Blank lines at the end of the region are ignored unless the
23470 region only contains such lines."
23472 (if (not (org-region-active-p))
23475 ;; Remove fixed width marker only in a fixed-with element.
23477 ;; Add fixed width maker in paragraphs, in blank lines after
23478 ;; elements or at the beginning of a headline or an inlinetask,
23479 ;; and before any one-line elements (e.g., a clock).
23481 (beginning-of-line)
23482 (let* ((element (org-element-at-point))
23483 (type (org-element-type element)))
23485 ((and (eq type 'fixed-width)
23486 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23488 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23489 ((and (memq type '(babel-call clock comment diary-sexp headline
23490 horizontal-rule keyword paragraph
23492 (<= (org-element-property :post-affiliated element) (point)))
23493 (skip-chars-forward " \t")
23495 ((and (org-looking-at-p "[ \t]*$")
23496 (or (eq type 'inlinetask)
23498 (skip-chars-forward " \r\t\n")
23499 (<= (org-element-property :end element) (point)))))
23500 (delete-region (point) (line-end-position))
23503 (t (user-error "Cannot insert a fixed-width line here")))))
23505 (let* ((begin (save-excursion
23506 (goto-char (region-beginning))
23507 (line-beginning-position)))
23510 (goto-char (region-end))
23511 (unless (eolp) (beginning-of-line))
23512 (if (save-excursion (re-search-backward "\\S-" begin t))
23513 (progn (skip-chars-backward " \r\t\n") (point))
23519 (skip-chars-forward " \r\t\n")
23520 (when (eobp) (throw 'not-all-p nil))
23521 (while (< (point) end)
23522 (let ((element (org-element-at-point)))
23523 (if (eq (org-element-type element) 'fixed-width)
23524 (goto-char (org-element-property :end element))
23525 (throw 'not-all-p nil))))
23527 (if all-fixed-width-p
23530 (while (< (point) end)
23531 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23534 (if (= (line-end-position) (match-end 0)) 0 1)))
23536 (let ((min-ind (point-max)))
23537 ;; Find minimum indentation across all lines.
23540 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23543 (while (< (point) end)
23544 (unless (org-looking-at-p "[ \t]*$")
23545 (let ((ind (org-get-indentation)))
23546 (setq min-ind (min min-ind ind))
23547 (when (zerop ind) (throw 'zerop t))))
23549 ;; Loop over all lines and add fixed-width markup everywhere
23550 ;; but in fixed-width lines.
23553 (while (< (point) end)
23555 ((org-at-heading-p)
23558 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23561 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23562 (let* ((element (org-element-at-point))
23563 (element-end (org-element-property :end element)))
23564 (if (eq (org-element-type element) 'fixed-width)
23565 (progn (goto-char element-end)
23566 (skip-chars-backward " \r\t\n")
23568 (let ((limit (min end element-end)))
23569 (while (< (point) limit)
23570 (org-move-to-column min-ind t)
23572 (forward-line))))))
23574 (org-move-to-column min-ind t)
23576 (forward-line)))))))
23577 (set-marker end nil))))
23582 ;; Org comments syntax is quite complex. It requires the entire line
23583 ;; to be just a comment. Also, even with the right syntax at the
23584 ;; beginning of line, some some elements (i.e. verse-block or
23585 ;; example-block) don't accept comments. Usual Emacs comment commands
23586 ;; cannot cope with those requirements. Therefore, Org replaces them.
23588 ;; Org still relies on `comment-dwim', but cannot trust
23589 ;; `comment-only-p'. So, `comment-region-function' and
23590 ;; `uncomment-region-function' both point
23591 ;; to`org-comment-or-uncomment-region'. Eventually,
23592 ;; `org-insert-comment' takes care of insertion of comments at the
23593 ;; beginning of line.
23595 ;; `org-setup-comments-handling' install comments related variables
23596 ;; during `org-mode' initialization.
23598 (defun org-setup-comments-handling ()
23600 (org-set-local 'comment-use-syntax nil)
23601 (org-set-local 'comment-start "# ")
23602 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23603 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23604 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23605 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23607 (defun org-insert-comment ()
23608 "Insert an empty comment above current line.
23609 If the line is empty, insert comment at its beginning. When
23610 point is within a source block, comment according to the related
23612 (if (let ((element (org-element-at-point)))
23613 (and (eq (org-element-type element) 'src-block)
23615 (goto-char (org-element-property :post-affiliated element))
23616 (line-end-position))
23619 (goto-char (org-element-property :end element))
23620 (skip-chars-backward " \r\t\n")
23621 (line-beginning-position))
23623 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23624 (beginning-of-line)
23625 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23630 (defvar comment-empty-lines) ; From newcomment.el.
23631 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23632 "Comment or uncomment each non-blank line in the region.
23633 Uncomment each non-blank line between BEG and END if it only
23634 contains commented lines. Otherwise, comment them. If region is
23635 strictly within a source block, use appropriate comment syntax."
23636 (if (let ((element (org-element-at-point)))
23637 (and (eq (org-element-type element) 'src-block)
23639 (goto-char (org-element-property :post-affiliated element))
23640 (line-end-position))
23642 (>= (save-excursion
23643 (goto-char (org-element-property :end element))
23644 (skip-chars-backward " \r\t\n")
23645 (line-beginning-position))
23647 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23650 (narrow-to-region (save-excursion (goto-char beg)
23651 (skip-chars-forward " \r\t\n" end)
23652 (line-beginning-position))
23653 (save-excursion (goto-char end)
23654 (skip-chars-backward " \r\t\n" beg)
23655 (line-end-position)))
23657 ;; UNCOMMENTP is non-nil when every non blank line between
23658 ;; BEG and END is a comment.
23660 (goto-char (point-min))
23661 (while (and (not (eobp))
23662 (let ((element (org-element-at-point)))
23663 (and (eq (org-element-type element) 'comment)
23664 (goto-char (min (point-max)
23665 (org-element-property
23666 :end element)))))))
23669 ;; Only blank lines and comments in region: uncomment it.
23671 (goto-char (point-min))
23672 (while (not (eobp))
23673 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23674 (replace-match "" nil nil nil 1))
23676 ;; Comment each line in region.
23677 (let ((min-indent (point-max)))
23678 ;; First find the minimum indentation across all lines.
23680 (goto-char (point-min))
23681 (while (and (not (eobp)) (not (zerop min-indent)))
23682 (unless (looking-at "[ \t]*$")
23683 (setq min-indent (min min-indent (current-indentation))))
23685 ;; Then loop over all lines.
23687 (goto-char (point-min))
23688 (while (not (eobp))
23689 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23690 ;; Don't get fooled by invisible text (e.g. link path)
23691 ;; when moving to column MIN-INDENT.
23692 (let ((buffer-invisibility-spec nil))
23693 (org-move-to-column min-indent t))
23694 (insert comment-start))
23695 (forward-line)))))))))
23697 (defun org-comment-dwim (arg)
23698 "Call `comment-dwim' within a source edit buffer if needed."
23700 (if (org-in-src-block-p)
23701 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23702 (call-interactively 'comment-dwim)))
23707 ;; This section contains tools to operate on timestamp objects, as
23708 ;; returned by, e.g. `org-element-context'.
23710 (defun org-timestamp--to-internal-time (timestamp &optional end)
23711 "Encode TIMESTAMP object into Emacs internal time.
23712 Use end of date range or time range when END is non-nil."
23713 (apply #'encode-time
23716 (lambda (prop) (or (org-element-property prop timestamp) 0))
23717 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23718 '(:minute-start :hour-start :day-start :month-start
23721 (defun org-timestamp-has-time-p (timestamp)
23722 "Non-nil when TIMESTAMP has a time specified."
23723 (org-element-property :hour-start timestamp))
23725 (defun org-timestamp-format (timestamp format &optional end utc)
23726 "Format a TIMESTAMP object into a string.
23728 FORMAT is a format specifier to be passed to
23729 `format-time-string'.
23731 When optional argument END is non-nil, use end of date-range or
23732 time-range, if possible.
23734 When optional argument UTC is non-nil, time will be expressed as
23736 (format-time-string
23737 format (org-timestamp--to-internal-time timestamp end) utc))
23739 (defun org-timestamp-split-range (timestamp &optional end)
23740 "Extract a TIMESTAMP object from a date or time range.
23742 END, when non-nil, means extract the end of the range.
23743 Otherwise, extract its start.
23745 Return a new timestamp object."
23746 (let ((type (org-element-property :type timestamp)))
23747 (if (memq type '(active inactive diary)) timestamp
23748 (let ((split-ts (org-element-copy timestamp)))
23750 (org-element-put-property
23751 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23752 ;; Copy start properties over end properties if END is
23753 ;; non-nil. Otherwise, copy end properties over `start' ones.
23754 (let ((p-alist '((:minute-start . :minute-end)
23755 (:hour-start . :hour-end)
23756 (:day-start . :day-end)
23757 (:month-start . :month-end)
23758 (:year-start . :year-end))))
23759 (dolist (p-cell p-alist)
23760 (org-element-put-property
23762 (funcall (if end #'car #'cdr) p-cell)
23763 (org-element-property
23764 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23765 ;; Eventually refresh `:raw-value'.
23766 (org-element-put-property split-ts :raw-value nil)
23767 (org-element-put-property
23768 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23770 (defun org-timestamp-translate (timestamp &optional boundary)
23771 "Translate TIMESTAMP object to custom format.
23773 Format string is defined in `org-time-stamp-custom-formats',
23776 When optional argument BOUNDARY is non-nil, it is either the
23777 symbol `start' or `end'. In this case, only translate the
23778 starting or ending part of TIMESTAMP if it is a date or time
23779 range. Otherwise, translate both parts.
23781 Return timestamp as-is if `org-display-custom-times' is nil or if
23782 it has a `diary' type."
23783 (let ((type (org-element-property :type timestamp)))
23784 (if (or (not org-display-custom-times) (eq type 'diary))
23785 (org-element-interpret-data timestamp)
23786 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23787 org-time-stamp-custom-formats)))
23788 (if (and (not boundary) (memq type '(active-range inactive-range)))
23789 (concat (org-timestamp-format timestamp fmt)
23791 (org-timestamp-format timestamp fmt t))
23792 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23798 (defun org-reftex-citation ()
23799 "Use reftex-citation to insert a citation into the buffer.
23800 This looks for a line like
23802 #+BIBLIOGRAPHY: foo plain option:-d
23804 and derives from it that foo.bib is the bibliography file relevant
23805 for this document. It then installs the necessary environment for RefTeX
23806 to work in this buffer and calls `reftex-citation' to insert a citation
23809 Export of such citations to both LaTeX and HTML is handled by the contributed
23810 package ox-bibtex by Taru Karttunen."
23812 (let ((reftex-docstruct-symbol 'rds)
23813 (reftex-cite-format "\\cite{%l}")
23818 (let ((case-fold-search t)
23819 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23820 (if (not (save-excursion
23821 (or (re-search-forward re nil t)
23822 (re-search-backward re nil t))))
23823 (user-error "No bibliography defined in file")
23824 (setq bib (concat (match-string 1) ".bib")
23825 rds (list (list 'bib bib)))))))
23826 (call-interactively 'reftex-citation)))
23828 ;;;; Functions extending outline functionality
23830 (defun org-beginning-of-line (&optional arg)
23831 "Go to the beginning of the current line. If that is invisible, continue
23832 to a visible line beginning. This makes the function of C-a more intuitive.
23833 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23834 first attempt, and only move to after the tags when the cursor is already
23835 beyond the end of the headline."
23837 (let ((pos (point))
23838 (special (if (consp org-special-ctrl-a/e)
23839 (car org-special-ctrl-a/e)
23840 org-special-ctrl-a/e))
23841 deactivate-mark refpos)
23842 (if (org-bound-and-true-p visual-line-mode)
23843 (beginning-of-visual-line 1)
23844 (beginning-of-line 1))
23845 (if (and arg (fboundp 'move-beginning-of-line))
23846 (call-interactively 'move-beginning-of-line)
23850 (if (org-truely-invisible-p)
23851 (while (and (not (bobp)) (org-truely-invisible-p))
23853 (beginning-of-line 1))
23854 (forward-char 1))))
23857 ((and (looking-at org-complex-heading-regexp)
23858 (eq (char-after (match-end 1)) ?\s))
23859 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23863 (cond ((> pos refpos) refpos)
23864 ((= pos (point)) refpos)
23866 (cond ((> pos (point)) (point))
23867 ((not (eq last-command this-command)) (point))
23870 ;; Being at an item and not looking at an the item means point
23871 ;; was previously moved to beginning of a visual line, which
23872 ;; doesn't contain the item. Therefore, do nothing special,
23874 (when (looking-at org-list-full-item-re)
23875 ;; Set special position at first white space character after
23876 ;; bullet, and check-box, if any.
23877 (let ((after-bullet
23878 (let ((box (match-end 3)))
23879 (if (not box) (match-end 1)
23880 (let ((after (char-after box)))
23881 (if (and after (= after ? )) (1+ box) box))))))
23882 ;; Special case: Move point to special position when
23883 ;; currently after it or at beginning of line.
23885 (when (or (> pos after-bullet) (= (point) pos))
23886 (goto-char after-bullet))
23887 ;; Reversed case: Move point to special position when
23888 ;; point was already at beginning of line and command is
23890 (when (and (= (point) pos) (eq last-command this-command))
23891 (goto-char after-bullet))))))))
23893 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23894 (setq disable-point-adjustment
23895 (or (not (invisible-p (point)))
23896 (not (invisible-p (max (point-min) (1- (point))))))))
23898 (defun org-end-of-line (&optional arg)
23899 "Go to the end of the line.
23900 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23901 tags on the first attempt, and only move to after the tags when
23902 the cursor is already beyond the end of the headline."
23904 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23905 org-special-ctrl-a/e))
23906 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23907 'end-of-visual-line)
23908 ((fboundp 'move-end-of-line) 'move-end-of-line)
23911 (if (or (not special) arg) (call-interactively move-fun)
23912 (let* ((element (save-excursion (beginning-of-line)
23913 (org-element-at-point)))
23914 (type (org-element-type element)))
23916 ((memq type '(headline inlinetask))
23917 (let ((pos (point)))
23918 (beginning-of-line 1)
23919 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23921 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23922 (goto-char (match-beginning 1))
23923 (goto-char (match-end 0)))
23924 (if (or (< pos (match-end 0))
23925 (not (eq this-command last-command)))
23926 (goto-char (match-end 0))
23927 (goto-char (match-beginning 1))))
23928 (call-interactively move-fun))))
23929 ((outline-invisible-p (line-end-position))
23930 ;; If element is hidden, `move-end-of-line' would put point
23931 ;; after it. Use `end-of-line' to stay on current line.
23932 (call-interactively 'end-of-line))
23933 (t (call-interactively move-fun)))))
23934 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23935 (setq disable-point-adjustment
23936 (or (not (invisible-p (point)))
23937 (not (invisible-p (max (point-min) (1- (point))))))))
23939 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23940 (define-key org-mode-map "\C-e" 'org-end-of-line)
23942 (defun org-backward-sentence (&optional arg)
23943 "Go to beginning of sentence, or beginning of table field.
23944 This will call `backward-sentence' or `org-table-beginning-of-field',
23945 depending on context."
23947 (let* ((element (org-element-at-point))
23948 (contents-begin (org-element-property :contents-begin element))
23949 (table (org-element-lineage element '(table) t)))
23951 (> (point) contents-begin)
23952 (<= (point) (org-element-property :contents-end table)))
23953 (call-interactively #'org-table-beginning-of-field)
23955 (when (and contents-begin
23956 (< (point-min) contents-begin)
23957 (> (point) contents-begin))
23958 (narrow-to-region contents-begin
23959 (org-element-property :contents-end element)))
23960 (call-interactively #'backward-sentence)))))
23962 (defun org-forward-sentence (&optional arg)
23963 "Go to end of sentence, or end of table field.
23964 This will call `forward-sentence' or `org-table-end-of-field',
23965 depending on context."
23967 (let* ((element (org-element-at-point))
23968 (contents-end (org-element-property :contents-end element))
23969 (table (org-element-lineage element '(table) t)))
23971 (>= (point) (org-element-property :contents-begin table))
23972 (< (point) contents-end))
23973 (call-interactively #'org-table-end-of-field)
23975 (when (and contents-end
23976 (> (point-max) contents-end)
23977 ;; Skip blank lines between elements.
23978 (< (org-element-property :end element)
23979 (save-excursion (goto-char contents-end)
23980 (skip-chars-forward " \r\t\n"))))
23981 (narrow-to-region (org-element-property :contents-begin element)
23983 (call-interactively #'forward-sentence)))))
23985 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23986 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23988 (defun org-kill-line (&optional arg)
23989 "Kill line, to tags or end of line."
23992 ((or (not org-special-ctrl-k)
23994 (not (org-at-heading-p)))
23995 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23996 org-ctrl-k-protect-subtree)
23997 (if (or (eq org-ctrl-k-protect-subtree 'error)
23998 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23999 (user-error "C-k aborted as it would kill a hidden subtree")))
24000 (call-interactively
24001 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
24002 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
24003 (kill-region (point) (match-beginning 1))
24004 (org-set-tags nil t))
24005 (t (kill-region (point) (point-at-eol)))))
24007 (define-key org-mode-map "\C-k" 'org-kill-line)
24009 (defun org-yank (&optional arg)
24010 "Yank. If the kill is a subtree, treat it specially.
24011 This command will look at the current kill and check if is a single
24012 subtree, or a series of subtrees[1]. If it passes the test, and if the
24013 cursor is at the beginning of a line or after the stars of a currently
24014 empty headline, then the yank is handled specially. How exactly depends
24015 on the value of the following variables, both set by default.
24017 `org-yank-folded-subtrees'
24018 When set, the subtree(s) will be folded after insertion, but only
24019 if doing so would now swallow text after the yanked text.
24021 `org-yank-adjusted-subtrees'
24022 When set, the subtree will be promoted or demoted in order to
24023 fit into the local outline tree structure, which means that the
24024 level will be adjusted so that it becomes the smaller one of the
24025 two *visible* surrounding headings.
24027 Any prefix to this command will cause `yank' to be called directly with
24028 no special treatment. In particular, a simple \\[universal-argument] prefix \
24030 plainly yank the text as it is.
24032 \[1] The test checks if the first non-white line is a heading
24033 and if there are no other headings with fewer stars."
24035 (org-yank-generic 'yank arg))
24037 (defun org-yank-generic (command arg)
24038 "Perform some yank-like command.
24040 This function implements the behavior described in the `org-yank'
24041 documentation. However, it has been generalized to work for any
24042 interactive command with similar behavior."
24044 ;; pretend to be command COMMAND
24045 (setq this-command command)
24048 (call-interactively command)
24050 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
24051 (and (org-kill-is-subtree-p)
24053 (and (looking-at "[ \t]*$")
24056 (buffer-substring (point-at-bol) (point)))))))
24059 ((and subtreep org-yank-folded-subtrees)
24060 (let ((beg (point))
24062 (if (and subtreep org-yank-adjusted-subtrees)
24063 (org-paste-subtree nil nil 'for-yank)
24064 (call-interactively command))
24068 (when (and (bolp) subtreep
24069 (not (setq swallowp
24070 (org-yank-folding-would-swallow-text beg end))))
24071 (org-with-limited-levels
24072 (or (looking-at org-outline-regexp)
24073 (re-search-forward org-outline-regexp-bol end t))
24074 (while (and (< (point) end) (looking-at org-outline-regexp))
24076 (org-cycle-show-empty-lines 'folded)
24077 (condition-case nil
24078 (outline-forward-same-level 1)
24079 (error (goto-char end))))))
24082 "Inserted text not folded because that would swallow text"))
24085 (skip-chars-forward " \t\n\r")
24086 (beginning-of-line 1)
24087 (push-mark beg 'nomsg)))
24088 ((and subtreep org-yank-adjusted-subtrees)
24089 (let ((beg (point-at-bol)))
24090 (org-paste-subtree nil nil 'for-yank)
24091 (push-mark beg 'nomsg)))
24093 (call-interactively command))))))
24095 (defun org-yank-folding-would-swallow-text (beg end)
24096 "Would hide-subtree at BEG swallow any text after END?"
24098 (org-with-limited-levels
24101 (when (or (looking-at org-outline-regexp)
24102 (re-search-forward org-outline-regexp-bol end t))
24103 (setq level (org-outline-level)))
24105 (skip-chars-forward " \t\r\n\v\f")
24107 (and (bolp) (looking-at org-outline-regexp)
24108 (<= (org-outline-level) level)))
24109 nil ; Nothing would be swallowed
24110 t))))) ; something would swallow
24112 (define-key org-mode-map "\C-y" 'org-yank)
24114 (defun org-truely-invisible-p ()
24115 "Check if point is at a character currently not visible.
24116 This version does not only check the character property, but also
24118 ;; Early versions of noutline don't have `outline-invisible-p'.
24119 (if (org-bound-and-true-p visible-mode)
24121 (outline-invisible-p)))
24123 (defun org-invisible-p2 ()
24124 "Check if point is at a character currently not visible."
24126 (if (and (eolp) (not (bobp))) (backward-char 1))
24127 ;; Early versions of noutline don't have `outline-invisible-p'.
24128 (outline-invisible-p)))
24130 (defun org-back-to-heading (&optional invisible-ok)
24131 "Call `outline-back-to-heading', but provide a better error message."
24132 (condition-case nil
24133 (outline-back-to-heading invisible-ok)
24134 (error (error "Before first headline at position %d in buffer %s"
24135 (point) (current-buffer)))))
24137 (defun org-before-first-heading-p ()
24138 "Before first heading?"
24141 (null (re-search-backward org-outline-regexp-bol nil t))))
24143 (defun org-at-heading-p (&optional ignored)
24144 (outline-on-heading-p t))
24145 ;; Compatibility alias with Org versions < 7.8.03
24146 (defalias 'org-on-heading-p 'org-at-heading-p)
24148 (defun org-in-commented-heading-p (&optional no-inheritance)
24149 "Non-nil if point is under a commented heading.
24150 This function also checks ancestors of the current headline,
24151 unless optional argument NO-INHERITANCE is non-nil."
24153 ((org-before-first-heading-p) nil)
24154 ((let ((headline (nth 4 (org-heading-components))))
24156 (let ((case-fold-search nil))
24157 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24159 (no-inheritance nil)
24161 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24163 (defun org-at-comment-p nil
24164 "Is cursor in a commented line?"
24167 (beginning-of-line)
24168 (looking-at "^[ \t]*# "))))
24170 (defun org-at-drawer-p nil
24171 "Is cursor at a drawer keyword?"
24173 (move-beginning-of-line 1)
24174 (looking-at org-drawer-regexp)))
24176 (defun org-at-block-p nil
24177 "Is cursor at a block keyword?"
24179 (move-beginning-of-line 1)
24180 (looking-at org-block-regexp)))
24182 (defun org-point-at-end-of-empty-headline ()
24183 "If point is at the end of an empty headline, return t, else nil.
24184 If the heading only contains a TODO keyword, it is still still considered
24186 (and (looking-at "[ \t]*$")
24187 (when org-todo-line-regexp
24189 (beginning-of-line 1)
24190 (let ((case-fold-search nil))
24191 (looking-at org-todo-line-regexp)
24192 (string= (match-string 3) ""))))))
24194 (defun org-at-heading-or-item-p ()
24195 (or (org-at-heading-p) (org-at-item-p)))
24197 (defun org-at-target-p ()
24198 (or (org-in-regexp org-radio-target-regexp)
24199 (org-in-regexp org-target-regexp)))
24200 ;; Compatibility alias with Org versions < 7.8.03
24201 (defalias 'org-on-target-p 'org-at-target-p)
24203 (defun org-up-heading-all (arg)
24204 "Move to the heading line of which the present line is a subheading.
24205 This function considers both visible and invisible heading lines.
24206 With argument, move up ARG levels."
24207 (if (fboundp 'outline-up-heading-all)
24208 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24209 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24211 (defun org-up-heading-safe ()
24212 "Move to the heading line of which the present line is a subheading.
24213 This version will not throw an error. It will return the level of the
24214 headline found, or nil if no higher level is found.
24216 Also, this function will be a lot faster than `outline-up-heading',
24217 because it relies on stars being the outline starters. This can really
24218 make a significant difference in outlines with very many siblings."
24219 (when (ignore-errors (org-back-to-heading t))
24220 (let ((level-up (1- (funcall outline-level))))
24221 (and (> level-up 0)
24222 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24223 (funcall outline-level)))))
24225 (defun org-first-sibling-p ()
24226 "Is this heading the first child of its parents?"
24228 (let ((re org-outline-regexp-bol)
24230 (unless (org-at-heading-p t)
24231 (user-error "Not at a heading"))
24232 (setq level (funcall outline-level))
24234 (if (not (re-search-backward re nil t))
24236 (setq l (funcall outline-level))
24239 (defun org-goto-sibling (&optional previous)
24240 "Goto the next sibling, even if it is invisible.
24241 When PREVIOUS is set, go to the previous sibling instead. Returns t
24242 when a sibling was found. When none is found, return nil and don't
24244 (let ((fun (if previous 're-search-backward 're-search-forward))
24246 (re org-outline-regexp-bol)
24248 (when (ignore-errors (org-back-to-heading t))
24249 (setq level (funcall outline-level))
24251 (or previous (forward-char 1))
24252 (while (funcall fun re nil t)
24253 (setq l (funcall outline-level))
24254 (when (< l level) (goto-char pos) (throw 'exit nil))
24255 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24259 (defun org-show-siblings ()
24260 "Show all siblings of the current headline."
24262 (while (org-goto-sibling) (org-flag-heading nil)))
24264 (while (org-goto-sibling 'previous)
24265 (org-flag-heading nil))))
24267 (defun org-goto-first-child ()
24268 "Goto the first child, even if it is invisible.
24269 Return t when a child was found. Otherwise don't move point and
24271 (let (level (pos (point)) (re org-outline-regexp-bol))
24272 (when (ignore-errors (org-back-to-heading t))
24273 (setq level (outline-level))
24275 (if (and (re-search-forward re nil t) (> (outline-level) level))
24276 (progn (goto-char (match-beginning 0)) t)
24277 (goto-char pos) nil))))
24279 (defun org-show-hidden-entry ()
24280 "Show an entry where even the heading is hidden."
24284 (defun org-flag-heading (flag &optional entry)
24285 "Flag the current heading. FLAG non-nil means make invisible.
24286 When ENTRY is non-nil, show the entire entry."
24288 (org-back-to-heading t)
24289 ;; Check if we should show the entire entry
24294 (and (outline-next-heading)
24295 (org-flag-heading nil))))
24296 (outline-flag-region (max (point-min) (1- (point)))
24297 (save-excursion (outline-end-of-heading) (point))
24300 (defun org-get-next-sibling ()
24301 "Move to next heading of the same level, and return point.
24302 If there is no such heading, return nil.
24303 This is like outline-next-sibling, but invisible headings are ok."
24304 (let ((level (funcall outline-level)))
24305 (outline-next-heading)
24306 (while (and (not (eobp)) (> (funcall outline-level) level))
24307 (outline-next-heading))
24308 (if (or (eobp) (< (funcall outline-level) level))
24312 (defun org-get-last-sibling ()
24313 "Move to previous heading of the same level, and return point.
24314 If there is no such heading, return nil."
24315 (let ((opoint (point))
24316 (level (funcall outline-level)))
24317 (outline-previous-heading)
24318 (when (and (/= (point) opoint) (outline-on-heading-p t))
24319 (while (and (> (funcall outline-level) level)
24321 (outline-previous-heading))
24322 (if (< (funcall outline-level) level)
24326 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24327 "Goto to the end of a subtree."
24328 ;; This contains an exact copy of the original function, but it uses
24329 ;; `org-back-to-heading', to make it work also in invisible
24330 ;; trees. And is uses an invisible-ok argument.
24331 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24332 ;; Furthermore, when used inside Org, finding the end of a large subtree
24333 ;; with many children and grandchildren etc, this can be much faster
24334 ;; than the outline version.
24335 (org-back-to-heading invisible-ok)
24337 (level (funcall outline-level)))
24338 (if (and (derived-mode-p 'org-mode) (< level 1000))
24339 ;; A true heading (not a plain list item), in Org-mode
24340 ;; This means we can easily find the end by looking
24341 ;; only for the right number of stars. Using a regexp to do
24342 ;; this is so much faster than using a Lisp loop.
24343 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24345 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24346 ;; something else, do it the slow way
24347 (while (and (not (eobp))
24348 (or first (> (funcall outline-level) level)))
24350 (outline-next-heading)))
24352 (if (memq (preceding-char) '(?\n ?\^M))
24354 ;; Go to end of line before heading
24356 (if (memq (preceding-char) '(?\n ?\^M))
24357 ;; leave blank line before heading
24358 (forward-char -1))))))
24361 (defun org-end-of-meta-data (&optional full)
24362 "Skip planning line and properties drawer in current entry.
24363 When optional argument FULL is non-nil, also skip empty lines,
24364 clocking lines and regular drawers at the beginning of the
24366 (org-back-to-heading t)
24368 (when (org-looking-at-p org-planning-line-re) (forward-line))
24369 (when (looking-at org-property-drawer-re)
24370 (goto-char (match-end 0))
24372 (when (and full (not (org-at-heading-p)))
24374 (let ((end (save-excursion (outline-next-heading) (point)))
24375 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24376 (while (not (eobp))
24377 (cond ((org-looking-at-p org-drawer-regexp)
24378 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24381 ((org-looking-at-p re) (forward-line))
24382 (t (throw 'exit t))))))))
24384 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24385 "Move forward to the ARG'th subheading at same level as this one.
24386 Stop at the first and last subheadings of a superior heading.
24387 Normally this only looks at visible headings, but when INVISIBLE-OK is
24388 non-nil it will also look at invisible ones."
24390 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24391 (if (and arg (< arg 0))
24392 (goto-char (point-min))
24393 (outline-next-heading))
24395 (let ((level (- (match-end 0) (match-beginning 0) 1))
24396 (f (if (and arg (< arg 0))
24397 're-search-backward
24398 're-search-forward))
24399 (count (if arg (abs arg) 1))
24401 (while (and (prog1 (> count 0)
24402 (forward-char (if (and arg (< arg 0)) -1 1)))
24403 (funcall f org-outline-regexp-bol nil 'move))
24404 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24405 (cond ((< l level) (setq count 0))
24409 (goto-char (line-beginning-position))
24410 (not (outline-invisible-p)))))
24411 (setq count (1- count))
24413 (setq result (point)))))))
24414 (goto-char result))
24415 (beginning-of-line 1)))
24417 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24418 "Move backward to the ARG'th subheading at same level as this one.
24419 Stop at the first and last subheadings of a superior heading."
24421 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24423 (defun org-next-visible-heading (arg)
24424 "Move to the next visible heading.
24426 This function wraps `outline-next-visible-heading' with
24427 `org-with-limited-levels' in order to skip over inline tasks and
24428 respect customization of `org-odd-levels-only'."
24430 (org-with-limited-levels
24431 (outline-next-visible-heading arg)))
24433 (defun org-previous-visible-heading (arg)
24434 "Move to the next visible heading.
24436 This function wraps `outline-previous-visible-heading' with
24437 `org-with-limited-levels' in order to skip over inline tasks and
24438 respect customization of `org-odd-levels-only'."
24440 (org-with-limited-levels
24441 (outline-previous-visible-heading arg)))
24443 (defun org-next-block (arg &optional backward block-regexp)
24444 "Jump to the next block.
24446 With a prefix argument ARG, jump forward ARG many blocks.
24448 When BACKWARD is non-nil, jump to the previous block.
24450 When BLOCK-REGEXP is non-nil, use this regexp to find blocks.
24451 Match data is set according to this regexp when the function
24454 Return point at beginning of the opening line of found block.
24455 Throw an error if no block is found."
24457 (let ((re (or block-regexp "^[ \t]*#\\+BEGIN"))
24458 (case-fold-search t)
24459 (search-fn (if backward #'re-search-backward #'re-search-forward))
24463 (if backward (beginning-of-line) (end-of-line))
24464 (while (and (> count 0) (funcall search-fn re nil t))
24465 (let ((element (save-excursion
24466 (goto-char (match-beginning 0))
24467 (save-match-data (org-element-at-point)))))
24468 (when (and (memq (org-element-type element)
24469 '(center-block comment-block dynamic-block
24470 example-block export-block quote-block
24471 special-block src-block verse-block))
24472 (<= (match-beginning 0)
24473 (org-element-property :post-affiliated element)))
24474 (setq last-element element)
24477 (prog1 (goto-char (org-element-property :post-affiliated last-element))
24478 (save-match-data (org-show-context)))
24480 (user-error "No %s code blocks" (if backward "previous" "further")))))
24482 (defun org-previous-block (arg &optional block-regexp)
24483 "Jump to the previous block.
24484 With a prefix argument ARG, jump backward ARG many source blocks.
24485 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24487 (org-next-block arg t block-regexp))
24489 (defun org-forward-paragraph ()
24490 "Move forward to beginning of next paragraph or equivalent.
24492 The function moves point to the beginning of the next visible
24493 structural element, which can be a paragraph, a table, a list
24494 item, etc. It also provides some special moves for convenience:
24496 - On an affiliated keyword, jump to the beginning of the
24498 - On an item or a footnote definition, move to the second
24499 element inside, if any.
24500 - On a table or a property drawer, jump after it.
24501 - On a verse or source block, stop after blank lines."
24503 (when (eobp) (user-error "Cannot move further down"))
24504 (let* ((deactivate-mark nil)
24505 (element (org-element-at-point))
24506 (type (org-element-type element))
24507 (post-affiliated (org-element-property :post-affiliated element))
24508 (contents-begin (org-element-property :contents-begin element))
24509 (contents-end (org-element-property :contents-end element))
24510 (end (let ((end (org-element-property :end element)) (parent element))
24511 (while (and (setq parent (org-element-property :parent parent))
24512 (= (org-element-property :contents-end parent) end))
24513 (setq end (org-element-property :end parent)))
24515 (cond ((not element)
24516 (skip-chars-forward " \r\t\n")
24517 (or (eobp) (beginning-of-line)))
24518 ;; On affiliated keywords, move to element's beginning.
24519 ((< (point) post-affiliated)
24520 (goto-char post-affiliated))
24521 ;; At a table row, move to the end of the table. Similarly,
24522 ;; at a node property, move to the end of the property
24524 ((memq type '(node-property table-row))
24525 (goto-char (org-element-property
24526 :end (org-element-property :parent element))))
24527 ((memq type '(property-drawer table)) (goto-char end))
24528 ;; Consider blank lines as separators in verse and source
24529 ;; blocks to ease editing.
24530 ((memq type '(src-block verse-block))
24531 (when (eq type 'src-block)
24533 (save-excursion (goto-char end)
24534 (skip-chars-backward " \r\t\n")
24535 (line-beginning-position))))
24536 (beginning-of-line)
24537 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24538 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24540 (skip-chars-forward " \r\t\n")
24541 (if (= (point) contents-end) (goto-char end)
24542 (beginning-of-line))))
24543 ;; With no contents, just skip element.
24544 ((not contents-begin) (goto-char end))
24545 ;; If contents are invisible, skip the element altogether.
24546 ((outline-invisible-p (line-end-position))
24549 (org-with-limited-levels (outline-next-visible-heading 1)))
24550 ;; At a plain list, make sure we move to the next item
24551 ;; instead of skipping the whole list.
24552 (plain-list (forward-char)
24553 (org-forward-paragraph))
24554 (otherwise (goto-char end))))
24555 ((>= (point) contents-end) (goto-char end))
24556 ((>= (point) contents-begin)
24557 ;; This can only happen on paragraphs and plain lists.
24559 (paragraph (goto-char end))
24560 ;; At a plain list, try to move to second element in
24561 ;; first item, if possible.
24562 (plain-list (end-of-line)
24563 (org-forward-paragraph))))
24564 ;; When contents start on the middle of a line (e.g. in
24565 ;; items and footnote definitions), try to reach first
24566 ;; element starting after current line.
24567 ((> (line-end-position) contents-begin)
24569 (org-forward-paragraph))
24570 (t (goto-char contents-begin)))))
24572 (defun org-backward-paragraph ()
24573 "Move backward to start of previous paragraph or equivalent.
24575 The function moves point to the beginning of the current
24576 structural element, which can be a paragraph, a table, a list
24577 item, etc., or to the beginning of the previous visible one if
24578 point is already there. It also provides some special moves for
24581 - On an affiliated keyword, jump to the first one.
24582 - On a table or a property drawer, move to its beginning.
24583 - On a verse or source block, stop before blank lines."
24585 (when (bobp) (user-error "Cannot move further up"))
24586 (let* ((deactivate-mark nil)
24587 (element (org-element-at-point))
24588 (type (org-element-type element))
24589 (contents-begin (org-element-property :contents-begin element))
24590 (contents-end (org-element-property :contents-end element))
24591 (post-affiliated (org-element-property :post-affiliated element))
24592 (begin (org-element-property :begin element)))
24594 ((not element) (goto-char (point-min)))
24597 (org-backward-paragraph))
24598 ((<= (point) post-affiliated) (goto-char begin))
24599 ((memq type '(node-property table-row))
24600 (goto-char (org-element-property
24601 :post-affiliated (org-element-property :parent element))))
24602 ((memq type '(property-drawer table)) (goto-char begin))
24603 ((memq type '(src-block verse-block))
24604 (when (eq type 'src-block)
24605 (setq contents-begin
24606 (save-excursion (goto-char begin) (forward-line) (point))))
24607 (if (= (point) contents-begin) (goto-char post-affiliated)
24608 ;; Inside a verse block, see blank lines as paragraph
24610 (let ((origin (point)))
24611 (skip-chars-backward " \r\t\n" contents-begin)
24612 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24613 (skip-chars-forward " \r\t\n" origin)
24614 (if (= (point) origin) (goto-char contents-begin)
24615 (beginning-of-line))))))
24616 ((not contents-begin) (goto-char (or post-affiliated begin)))
24617 ((eq type 'paragraph)
24618 (goto-char contents-begin)
24619 ;; When at first paragraph in an item or a footnote definition,
24620 ;; move directly to beginning of line.
24621 (let ((parent-contents
24622 (org-element-property
24623 :contents-begin (org-element-property :parent element))))
24624 (when (and parent-contents (= parent-contents contents-begin))
24625 (beginning-of-line))))
24626 ;; At the end of a greater element, move to the beginning of the
24627 ;; last element within.
24628 ((>= (point) contents-end)
24629 (goto-char (1- contents-end))
24630 (org-backward-paragraph))
24631 (t (goto-char (or post-affiliated begin))))
24632 ;; Ensure we never leave point invisible.
24633 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24635 (defun org-forward-element ()
24636 "Move forward by one element.
24637 Move to the next element at the same level, when possible."
24639 (cond ((eobp) (user-error "Cannot move further down"))
24640 ((org-with-limited-levels (org-at-heading-p))
24641 (let ((origin (point)))
24642 (goto-char (org-end-of-subtree nil t))
24643 (unless (org-with-limited-levels (org-at-heading-p))
24645 (user-error "Cannot move further down"))))
24647 (let* ((elem (org-element-at-point))
24648 (end (org-element-property :end elem))
24649 (parent (org-element-property :parent elem)))
24650 (cond ((and parent (= (org-element-property :contents-end parent) end))
24651 (goto-char (org-element-property :end parent)))
24652 ((integer-or-marker-p end) (goto-char end))
24653 (t (message "No element at point")))))))
24655 (defun org-backward-element ()
24656 "Move backward by one element.
24657 Move to the previous element at the same level, when possible."
24659 (cond ((bobp) (user-error "Cannot move further up"))
24660 ((org-with-limited-levels (org-at-heading-p))
24661 ;; At a headline, move to the previous one, if any, or stay
24663 (let ((origin (point)))
24664 (org-with-limited-levels (org-backward-heading-same-level 1))
24665 ;; When current headline has no sibling above, move to its
24667 (when (= (point) origin)
24668 (or (org-with-limited-levels (org-up-heading-safe))
24669 (progn (goto-char origin)
24670 (user-error "Cannot move further up"))))))
24672 (let* ((elem (org-element-at-point))
24673 (beg (org-element-property :begin elem)))
24675 ;; Move to beginning of current element if point isn't
24677 ((null beg) (message "No element at point"))
24678 ((/= (point) beg) (goto-char beg))
24680 (skip-chars-backward " \r\t\n")
24682 (let ((prev (org-element-at-point)))
24683 (goto-char (org-element-property :begin prev))
24684 (while (and (setq prev (org-element-property :parent prev))
24685 (<= (org-element-property :end prev) beg))
24686 (goto-char (org-element-property :begin prev)))))))))))
24688 (defun org-up-element ()
24689 "Move to upper element."
24691 (if (org-with-limited-levels (org-at-heading-p))
24692 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24693 (let* ((elem (org-element-at-point))
24694 (parent (org-element-property :parent elem)))
24695 (if parent (goto-char (org-element-property :begin parent))
24696 (if (org-with-limited-levels (org-before-first-heading-p))
24697 (user-error "No surrounding element")
24698 (org-with-limited-levels (org-back-to-heading)))))))
24700 (defvar org-element-greater-elements)
24701 (defun org-down-element ()
24702 "Move to inner element."
24704 (let ((element (org-element-at-point)))
24706 ((memq (org-element-type element) '(plain-list table))
24707 (goto-char (org-element-property :contents-begin element))
24709 ((memq (org-element-type element) org-element-greater-elements)
24710 ;; If contents are hidden, first disclose them.
24711 (when (outline-invisible-p (line-end-position)) (org-cycle))
24712 (goto-char (or (org-element-property :contents-begin element)
24713 (user-error "No content for this element"))))
24714 (t (user-error "No inner element")))))
24716 (defun org-drag-element-backward ()
24717 "Move backward element at point."
24719 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24720 (let* ((elem (org-element-at-point))
24723 (goto-char (org-element-property :begin elem))
24724 (skip-chars-backward " \r\t\n")
24726 (let* ((beg (org-element-property :begin elem))
24727 (prev (org-element-at-point))
24729 (while (and (setq up (org-element-property :parent up))
24730 (<= (org-element-property :end up) beg))
24733 ;; Error out if no previous element or previous element is
24734 ;; a parent of the current one.
24735 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24736 (user-error "Cannot drag element backward")
24737 (let ((pos (point)))
24738 (org-element-swap-A-B prev-elem elem)
24739 (goto-char (+ (org-element-property :begin prev-elem)
24740 (- pos (org-element-property :begin elem)))))))))
24742 (defun org-drag-element-forward ()
24743 "Move forward element at point."
24745 (let* ((pos (point))
24746 (elem (org-element-at-point)))
24747 (when (= (point-max) (org-element-property :end elem))
24748 (user-error "Cannot drag element forward"))
24749 (goto-char (org-element-property :end elem))
24750 (let ((next-elem (org-element-at-point)))
24751 (when (or (org-element-nested-p elem next-elem)
24752 (and (eq (org-element-type next-elem) 'headline)
24753 (not (eq (org-element-type elem) 'headline))))
24755 (user-error "Cannot drag element forward"))
24756 ;; Compute new position of point: it's shifted by NEXT-ELEM
24757 ;; body's length (without final blanks) and by the length of
24758 ;; blanks between ELEM and NEXT-ELEM.
24759 (let ((size-next (- (save-excursion
24760 (goto-char (org-element-property :end next-elem))
24761 (skip-chars-backward " \r\t\n")
24763 ;; Small correction if buffer doesn't end
24764 ;; with a newline character.
24765 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24766 (org-element-property :begin next-elem)))
24767 (size-blank (- (org-element-property :end elem)
24769 (goto-char (org-element-property :end elem))
24770 (skip-chars-backward " \r\t\n")
24773 (org-element-swap-A-B elem next-elem)
24774 (goto-char (+ pos size-next size-blank))))))
24776 (defun org-drag-line-forward (arg)
24777 "Drag the line at point ARG lines forward."
24779 (dotimes (n (abs arg))
24780 (let ((c (current-column)))
24783 (beginning-of-line 2)
24784 (transpose-lines 1)
24785 (beginning-of-line 0))
24786 (transpose-lines 1)
24787 (beginning-of-line -1))
24788 (org-move-to-column c))))
24790 (defun org-drag-line-backward (arg)
24791 "Drag the line at point ARG lines backward."
24793 (org-drag-line-forward (- arg)))
24795 (defun org-mark-element ()
24796 "Put point at beginning of this element, mark at end.
24798 Interactively, if this command is repeated or (in Transient Mark
24799 mode) if the mark is active, it marks the next element after the
24800 ones already marked."
24802 (let (deactivate-mark)
24803 (if (and (org-called-interactively-p 'any)
24804 (or (and (eq last-command this-command) (mark t))
24805 (and transient-mark-mode mark-active)))
24809 (goto-char (org-element-property :end (org-element-at-point)))))
24810 (let ((element (org-element-at-point)))
24812 (push-mark (org-element-property :end element) t t)
24813 (goto-char (org-element-property :begin element))))))
24815 (defun org-narrow-to-element ()
24816 "Narrow buffer to current element."
24818 (let ((elem (org-element-at-point)))
24820 ((eq (car elem) 'headline)
24822 (org-element-property :begin elem)
24823 (org-element-property :end elem)))
24824 ((memq (car elem) org-element-greater-elements)
24826 (org-element-property :contents-begin elem)
24827 (org-element-property :contents-end elem)))
24830 (org-element-property :begin elem)
24831 (org-element-property :end elem))))))
24833 (defun org-transpose-element ()
24834 "Transpose current and previous elements, keeping blank lines between.
24835 Point is moved after both elements."
24837 (org-skip-whitespace)
24838 (let ((end (org-element-property :end (org-element-at-point))))
24839 (org-drag-element-backward)
24842 (defun org-unindent-buffer ()
24843 "Un-indent the visible part of the buffer.
24844 Relative indentation (between items, inside blocks, etc.) isn't
24847 (unless (eq major-mode 'org-mode)
24848 (user-error "Cannot un-indent a buffer not in Org mode"))
24849 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24850 unindent-tree ; For byte-compiler.
24856 (if (memq (org-element-type element) '(headline section))
24857 (funcall unindent-tree (org-element-contents element))
24861 (org-element-property :begin element)
24862 (org-element-property :end element))
24863 (org-do-remove-indentation)))))
24864 (reverse contents))))))
24865 (funcall unindent-tree (org-element-contents parse-tree))))
24867 (defun org-show-subtree ()
24868 "Show everything after this heading at deeper levels."
24870 (outline-flag-region
24873 (org-end-of-subtree t t))
24876 (defun org-show-entry ()
24877 "Show the body directly following this heading.
24878 Show the heading too, if it is currently invisible."
24882 (org-back-to-heading t)
24883 (outline-flag-region
24884 (max (point-min) (1- (point)))
24886 (if (re-search-forward
24887 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24888 (match-beginning 1)
24891 (org-cycle-hide-drawers 'children))))
24893 (defun org-make-options-regexp (kwds &optional extra)
24894 "Make a regular expression for keyword lines.
24895 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24896 when non-nil, is a regexp matching keywords names."
24897 (concat "^[ \t]*#\\+\\("
24899 (and extra (concat (and kwds "\\|") extra))
24900 "\\):[ \t]*\\(.*\\)"))
24902 ;; Make isearch reveal the necessary context
24903 (defun org-isearch-end ()
24904 "Reveal context after isearch exits."
24905 (when isearch-success ; only if search was successful
24906 (if (featurep 'xemacs)
24907 ;; Under XEmacs, the hook is run in the correct place,
24908 ;; we directly show the context.
24909 (org-show-context 'isearch)
24910 ;; In Emacs the hook runs *before* restoring the overlays.
24911 ;; So we have to use a one-time post-command-hook to do this.
24912 ;; (Emacs 22 has a special variable, see function `org-mode')
24913 (unless (and (boundp 'isearch-mode-end-hook-quit)
24914 isearch-mode-end-hook-quit)
24915 ;; Only when the isearch was not quitted.
24916 (org-add-hook 'post-command-hook 'org-isearch-post-command
24917 'append 'local)))))
24919 (defun org-isearch-post-command ()
24920 "Remove self from hook, and show context."
24921 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24922 (org-show-context 'isearch))
24925 ;;;; Integration with and fixes for other packages
24929 (defvar org-imenu-markers nil
24930 "All markers currently used by Imenu.")
24931 (make-variable-buffer-local 'org-imenu-markers)
24933 (defun org-imenu-new-marker (&optional pos)
24934 "Return a new marker for use by Imenu, and remember the marker."
24935 (let ((m (make-marker)))
24936 (move-marker m (or pos (point)))
24937 (push m org-imenu-markers)
24940 (defun org-imenu-get-tree ()
24941 "Produce the index for Imenu."
24942 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24943 (setq org-imenu-markers nil)
24944 (let* ((n org-imenu-depth)
24945 (re (concat "^" (org-get-limited-outline-regexp)))
24946 (subs (make-vector (1+ n) nil))
24948 m level head0 head)
24952 (goto-char (point-max))
24953 (while (re-search-backward re nil t)
24954 (setq level (org-reduced-level (funcall outline-level)))
24955 (when (and (<= level n)
24956 (looking-at org-complex-heading-regexp)
24957 (setq head0 (org-match-string-no-properties 4)))
24958 (setq head (org-link-display-format head0)
24959 m (org-imenu-new-marker))
24960 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24961 (if (>= level last-level)
24962 (push (cons head m) (aref subs level))
24963 (push (cons head (aref subs (1+ level))) (aref subs level))
24964 (loop for i from (1+ level) to n do (aset subs i nil)))
24965 (setq last-level level)))))
24968 (eval-after-load "imenu"
24970 (add-hook 'imenu-after-jump-hook
24972 (if (derived-mode-p 'org-mode)
24973 (org-show-context 'org-goto))))))
24975 (defun org-link-display-format (link)
24976 "Replace a link with its the description.
24977 If there is no description, use the link target."
24979 (if (string-match org-bracket-link-analytic-regexp link)
24980 (replace-match (if (match-end 5)
24981 (match-string 5 link)
24982 (concat (match-string 1 link)
24983 (match-string 3 link)))
24987 (defun org-toggle-link-display ()
24988 "Toggle the literal or descriptive display of links."
24990 (if org-descriptive-links
24991 (progn (org-remove-from-invisibility-spec '(org-link))
24992 (org-restart-font-lock)
24993 (setq org-descriptive-links nil))
24994 (progn (add-to-invisibility-spec '(org-link))
24995 (org-restart-font-lock)
24996 (setq org-descriptive-links t))))
24998 ;; Speedbar support
25000 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
25001 "Overlay marking the agenda restriction line in speedbar.")
25002 (overlay-put org-speedbar-restriction-lock-overlay
25003 'face 'org-agenda-restriction-lock)
25004 (overlay-put org-speedbar-restriction-lock-overlay
25005 'help-echo "Agendas are currently limited to this item.")
25006 (org-detach-overlay org-speedbar-restriction-lock-overlay)
25008 (defun org-speedbar-set-agenda-restriction ()
25009 "Restrict future agenda commands to the location at point in speedbar.
25010 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
25012 (require 'org-agenda)
25013 (let (p m tp np dir txt)
25015 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25017 (setq m (get-text-property p 'org-imenu-marker))
25018 (with-current-buffer (marker-buffer m)
25020 (org-agenda-set-restriction-lock 'subtree)))
25021 ((setq p (text-property-any (point-at-bol) (point-at-eol)
25022 'speedbar-function 'speedbar-find-file))
25023 (setq tp (previous-single-property-change
25024 (1+ p) 'speedbar-function)
25025 np (next-single-property-change
25026 tp 'speedbar-function)
25027 dir (speedbar-line-directory)
25028 txt (buffer-substring-no-properties (or tp (point-min))
25029 (or np (point-max))))
25030 (with-current-buffer (find-file-noselect
25031 (let ((default-directory dir))
25032 (expand-file-name txt)))
25033 (unless (derived-mode-p 'org-mode)
25034 (user-error "Cannot restrict to non-Org-mode file"))
25035 (org-agenda-set-restriction-lock 'file)))
25036 (t (user-error "Don't know how to restrict Org-mode's agenda")))
25037 (move-overlay org-speedbar-restriction-lock-overlay
25038 (point-at-bol) (point-at-eol))
25039 (setq current-prefix-arg nil)
25040 (org-agenda-maybe-redo)))
25042 (defvar speedbar-file-key-map)
25043 (declare-function speedbar-add-supported-extension "speedbar" (extension))
25044 (eval-after-load "speedbar"
25046 (speedbar-add-supported-extension ".org")
25047 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
25048 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
25049 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
25050 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
25051 (add-hook 'speedbar-visiting-tag-hook
25052 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
25054 ;;; Fixes and Hacks for problems with other packages
25056 (defun org--flyspell-object-check-p (element)
25057 "Non-nil when Flyspell can check object at point.
25058 ELEMENT is the element at point."
25059 (let ((object (save-excursion
25060 (when (org-looking-at-p "\\>") (backward-char))
25061 (org-element-context element))))
25062 (case (org-element-type object)
25063 ;; Prevent checks in links due to keybinding conflict with
25065 ((code entity export-snippet inline-babel-call
25066 inline-src-block line-break latex-fragment link macro
25067 statistics-cookie target timestamp verbatim)
25069 (footnote-reference
25070 ;; Only in inline footnotes, within the definition.
25071 (and (eq (org-element-property :type object) 'inline)
25073 (goto-char (org-element-property :begin object))
25074 (search-forward ":" nil t 2))
25078 (defun org-mode-flyspell-verify ()
25079 "Function used for `flyspell-generic-check-word-predicate'."
25080 (if (org-at-heading-p)
25081 ;; At a headline or an inlinetask, check title only. This is
25082 ;; faster than relying on `org-element-at-point'.
25083 (and (save-excursion (beginning-of-line)
25084 (and (let ((case-fold-search t))
25085 (not (looking-at "\\*+ END[ \t]*$")))
25086 (looking-at org-complex-heading-regexp)))
25087 (match-beginning 4)
25088 (>= (point) (match-beginning 4))
25089 (or (not (match-beginning 5))
25090 (< (point) (match-beginning 5))))
25091 (let* ((element (org-element-at-point))
25092 (post-affiliated (org-element-property :post-affiliated element)))
25094 ;; Ignore checks in all affiliated keywords but captions.
25095 ((< (point) post-affiliated)
25096 (and (save-excursion
25097 (beginning-of-line)
25098 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
25099 (> (point) (match-end 0))
25100 (org--flyspell-object-check-p element)))
25101 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
25102 ((let ((log (org-log-into-drawer)))
25104 (let ((drawer (org-element-lineage element '(drawer))))
25106 (eq (compare-strings
25108 (org-element-property :drawer-name drawer) nil nil t)
25112 (case (org-element-type element)
25113 ((comment quote-section) t)
25115 ;; Allow checks between block markers, not on them.
25116 (and (> (line-beginning-position) post-affiliated)
25119 (skip-chars-forward " \r\t\n")
25120 (< (point) (org-element-property :end element)))))
25121 ;; Arbitrary list of keywords where checks are meaningful.
25122 ;; Make sure point is on the value part of the element.
25124 (and (member (org-element-property :key element)
25125 '("DESCRIPTION" "TITLE"))
25127 (search-backward ":" (line-beginning-position) t))))
25128 ;; Check is globally allowed in paragraphs verse blocks and
25129 ;; table rows (after affiliated keywords) but some objects
25130 ;; must not be affected.
25131 ((paragraph table-row verse-block)
25132 (let ((cbeg (org-element-property :contents-begin element))
25133 (cend (org-element-property :contents-end element)))
25134 (and cbeg (>= (point) cbeg) (< (point) cend)
25135 (org--flyspell-object-check-p element))))))))))
25136 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25138 (defun org-remove-flyspell-overlays-in (beg end)
25139 "Remove flyspell overlays in region."
25140 (and (org-bound-and-true-p flyspell-mode)
25141 (fboundp 'flyspell-delete-region-overlays)
25142 (flyspell-delete-region-overlays beg end)))
25144 (defvar flyspell-delayed-commands)
25145 (eval-after-load "flyspell"
25146 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25148 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25149 (eval-after-load "bookmark"
25150 '(if (boundp 'bookmark-after-jump-hook)
25151 ;; We can use the hook
25152 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25153 ;; Hook not available, use advice
25154 (defadvice bookmark-jump (after org-make-visible activate)
25155 "Make the position visible."
25156 (org-bookmark-jump-unhide))))
25158 ;; Make sure saveplace shows the location if it was hidden
25159 (eval-after-load "saveplace"
25160 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25161 "Make the position visible."
25162 (org-bookmark-jump-unhide)))
25164 ;; Make sure ecb shows the location if it was hidden
25165 (eval-after-load "ecb"
25166 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25167 "Make hierarchy visible when jumping into location from ECB tree buffer."
25168 (if (derived-mode-p 'org-mode)
25169 (org-show-context))))
25171 (defun org-bookmark-jump-unhide ()
25172 "Unhide the current position, to show the bookmark location."
25173 (and (derived-mode-p 'org-mode)
25174 (or (outline-invisible-p)
25175 (save-excursion (goto-char (max (point-min) (1- (point))))
25176 (outline-invisible-p)))
25177 (org-show-context 'bookmark-jump)))
25179 (defun org-mark-jump-unhide ()
25180 "Make the point visible with `org-show-context' after jumping to the mark."
25181 (when (and (derived-mode-p 'org-mode)
25182 (outline-invisible-p))
25183 (org-show-context 'mark-goto)))
25185 (eval-after-load "simple"
25186 '(defadvice pop-to-mark-command (after org-make-visible activate)
25187 "Make the point visible with `org-show-context'."
25188 (org-mark-jump-unhide)))
25190 (eval-after-load "simple"
25191 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25192 "Make the point visible with `org-show-context'."
25193 (org-mark-jump-unhide)))
25195 (eval-after-load "simple"
25196 '(defadvice pop-global-mark (after org-make-visible activate)
25197 "Make the point visible with `org-show-context'."
25198 (org-mark-jump-unhide)))
25200 ;; Make session.el ignore our circular variable
25201 (defvar session-globals-exclude)
25202 (eval-after-load "session"
25203 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25209 (run-hooks 'org-load-hook)
25211 ;;; org.el ends here