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 (declare-function cdlatex-environment
"ext:cdlatex" (environment item
))
96 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
97 ;; some places -- e.g. see the macro `org-with-limited-levels'.
99 ;; In Org buffers, the value of `outline-regexp' is that of
100 ;; `org-outline-regexp'. The only function still directly relying on
101 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
102 ;; job when `orgstruct-mode' is active.
103 (defvar org-outline-regexp
"\\*+ "
104 "Regexp to match Org headlines.")
106 (defvar org-outline-regexp-bol
"^\\*+ "
107 "Regexp to match Org headlines.
108 This is similar to `org-outline-regexp' but additionally makes
109 sure that we are at the beginning of the line.")
111 (defvar org-heading-regexp
"^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
112 "Matches a headline, putting stars and text into groups.
113 Stars are put in group 1 and the trimmed body in group 2.")
115 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
116 (unless (boundp 'calendar-view-holidays-initially-flag
)
117 (org-defvaralias 'calendar-view-holidays-initially-flag
118 'view-calendar-holidays-initially
))
119 (unless (boundp 'calendar-view-diary-initially-flag
)
120 (org-defvaralias 'calendar-view-diary-initially-flag
121 'view-diary-entries-initially
))
122 (unless (boundp 'diary-fancy-buffer
)
123 (org-defvaralias 'diary-fancy-buffer
'fancy-diary-buffer
))
125 (declare-function org-add-archive-files
"org-archive" (files))
127 (declare-function org-inlinetask-at-task-p
"org-inlinetask" ())
128 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
129 (declare-function org-inlinetask-toggle-visibility
"org-inlinetask" ())
130 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
131 (declare-function org-clock-get-last-clock-out-time
"org-clock" ())
132 (declare-function org-clock-timestamps-up
"org-clock" (&optional n
))
133 (declare-function org-clock-timestamps-down
"org-clock" (&optional n
))
134 (declare-function org-clock-remove-overlays
"org-clock" (&optional beg end noremove
))
135 (declare-function org-clock-sum
"org-clock" (&optional tstart tend headline-filter propname
))
136 (declare-function org-clock-sum-current-item
"org-clock" (&optional tstart
))
137 (declare-function org-clock-update-time-maybe
"org-clock" ())
138 (declare-function org-clocktable-shift
"org-clock" (dir n
))
140 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
141 (declare-function org-babel-do-in-edit-buffer
"ob-core" (&rest body
))
142 (declare-function orgtbl-mode
"org-table" (&optional arg
))
143 (declare-function org-clock-out
"org-clock" (&optional switch-to-state fail-quietly at-time
))
144 (declare-function org-beamer-mode
"ox-beamer" ())
145 (declare-function org-table-blank-field
"org-table" ())
146 (declare-function org-table-edit-field
"org-table" (arg))
147 (declare-function org-table-insert-row
"org-table" (&optional arg
))
148 (declare-function org-table-justify-field-maybe
"org-table" (&optional new
))
149 (declare-function org-table-calc-current-TBLFM
"org-table" (&optional arg
))
150 (declare-function org-id-get-create
"org-id" (&optional force
))
151 (declare-function org-add-archive-files
"org-archive" (files))
152 (declare-function org-id-find-id-file
"org-id" (id))
153 (declare-function org-tags-view
"org-agenda" (&optional todo-only match
))
154 (declare-function org-agenda-list
"org-agenda" (&optional arg start-day span
))
155 (declare-function org-agenda-redo
"org-agenda" (&optional all
))
156 (declare-function org-table-align
"org-table" ())
157 (declare-function org-table-begin
"org-table" (&optional table-type
))
158 (declare-function org-table-blank-field
"org-table" ())
159 (declare-function org-table-end
"org-table" (&optional table-type
))
160 (declare-function org-table-end-of-field
"org-table" (&optional n
))
161 (declare-function org-table-insert-row
"org-table" (&optional arg
))
162 (declare-function org-table-paste-rectangle
"org-table" ())
163 (declare-function org-table-maybe-eval-formula
"org-table" ())
164 (declare-function org-table-maybe-recalculate-line
"org-table" ())
165 (declare-function orgtbl-ascii-plot
"org-table" (&optional ask
))
166 (declare-function org-plot
/gnuplot
"org-plot" (&optional params
))
168 (declare-function org-element-at-point
"org-element" ())
169 (declare-function org-element-cache-reset
"org-element" (&optional all
))
170 (declare-function org-element-cache-refresh
"org-element" (pos))
171 (declare-function org-element-contents
"org-element" (element))
172 (declare-function org-element-context
"org-element" (&optional element
))
173 (declare-function org-element-interpret-data
"org-element"
174 (data &optional parent
))
175 (declare-function org-element-nested-p
"org-element" (elem-a elem-b
))
176 (declare-function org-element-parse-buffer
"org-element"
177 (&optional granularity visible-only
))
178 (declare-function org-element-property
"org-element" (property element
))
179 (declare-function org-element-put-property
"org-element"
180 (element property value
))
181 (declare-function org-element-swap-A-B
"org-element" (elem-a elem-b
))
182 (declare-function org-element-parse-buffer
"org-element"
183 (&optional granularity visible-only
))
184 (declare-function org-element-type
"org-element" (element))
186 (defsubst org-uniquify
(list)
187 "Non-destructively remove duplicate elements from LIST."
188 (let ((res (copy-sequence list
))) (delete-dups res
)))
190 (defsubst org-get-at-bol
(property)
191 "Get text property PROPERTY at the beginning of line."
192 (get-text-property (point-at-bol) property
))
194 (defsubst org-trim
(s)
195 "Remove whitespace at the beginning and the end of string S."
196 (replace-regexp-in-string
198 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s
)))
200 ;; load languages based on value of `org-babel-load-languages'
201 (defvar org-babel-load-languages
)
204 (defun org-babel-do-load-languages (sym value
)
205 "Load the languages defined in `org-babel-load-languages'."
206 (set-default sym value
)
208 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
211 (require (intern (concat "ob-" lang
))))
213 (funcall 'fmakunbound
214 (intern (concat "org-babel-execute:" lang
)))
215 (funcall 'fmakunbound
216 (intern (concat "org-babel-expand-body:" lang
)))))))
217 org-babel-load-languages
))
219 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
221 (defun org-babel-load-file (file &optional compile
)
222 "Load Emacs Lisp source code blocks in the Org-mode FILE.
223 This function exports the source code using `org-babel-tangle'
224 and then loads the resulting file using `load-file'. With prefix
225 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
226 file to byte-code before it is loaded."
227 (interactive "fFile to load: \nP")
228 (let* ((age (lambda (file)
230 (time-subtract (current-time)
231 (nth 5 (or (file-attributes (file-truename file
))
232 (file-attributes file
)))))))
233 (base-name (file-name-sans-extension file
))
234 (exported-file (concat base-name
".el")))
235 ;; tangle if the org-mode file is newer than the elisp file
236 (unless (and (file-exists-p exported-file
)
237 (> (funcall age file
) (funcall age exported-file
)))
238 ;; Tangle-file traversal returns reversed list of tangled files
239 ;; and we want to evaluate the first target.
241 (car (last (org-babel-tangle-file file exported-file
"emacs-lisp")))))
244 (progn (byte-compile-file exported-file
'load
)
245 "Compiled and loaded")
246 (progn (load-file exported-file
) "Loaded"))
249 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
250 "Languages which can be evaluated in Org-mode buffers.
251 This list can be used to load support for any of the languages
252 below, note that each language will depend on a different set of
253 system executables and/or Emacs modes. When a language is
254 \"loaded\", then code blocks in that language can be evaluated
255 with `org-babel-execute-src-block' bound by default to C-c
256 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
257 be set to remove code block evaluation from the C-c C-c
258 keybinding. By default only Emacs Lisp (which has no
259 requirements) is loaded."
261 :set
'org-babel-do-load-languages
263 :type
'(alist :tag
"Babel Languages"
266 (const :tag
"Awk" awk
)
269 (const :tag
"Asymptote" asymptote
)
270 (const :tag
"Calc" calc
)
271 (const :tag
"Clojure" clojure
)
272 (const :tag
"CSS" css
)
273 (const :tag
"Ditaa" ditaa
)
274 (const :tag
"Dot" dot
)
275 (const :tag
"Emacs Lisp" emacs-lisp
)
276 (const :tag
"Forth" forth
)
277 (const :tag
"Fortran" fortran
)
278 (const :tag
"Gnuplot" gnuplot
)
279 (const :tag
"Haskell" haskell
)
282 (const :tag
"Java" java
)
283 (const :tag
"Javascript" js
)
284 (const :tag
"LaTeX" latex
)
285 (const :tag
"Ledger" ledger
)
286 (const :tag
"Lilypond" lilypond
)
287 (const :tag
"Lisp" lisp
)
288 (const :tag
"Makefile" makefile
)
289 (const :tag
"Maxima" maxima
)
290 (const :tag
"Matlab" matlab
)
291 (const :tag
"Mscgen" mscgen
)
292 (const :tag
"Ocaml" ocaml
)
293 (const :tag
"Octave" octave
)
294 (const :tag
"Org" org
)
295 (const :tag
"Perl" perl
)
296 (const :tag
"Pico Lisp" picolisp
)
297 (const :tag
"PlantUML" plantuml
)
298 (const :tag
"Python" python
)
299 (const :tag
"Ruby" ruby
)
300 (const :tag
"Sass" sass
)
301 (const :tag
"Scala" scala
)
302 (const :tag
"Scheme" scheme
)
303 (const :tag
"Screen" screen
)
304 (const :tag
"Shell Script" shell
)
305 (const :tag
"Shen" shen
)
306 (const :tag
"Sql" sql
)
307 (const :tag
"Sqlite" sqlite
)
308 (const :tag
"ebnf2ps" ebnf2ps
))
309 :value-type
(boolean :tag
"Activate" :value t
)))
311 ;;;; Customization variables
312 (defcustom org-clone-delete-id nil
313 "Remove ID property of clones of a subtree.
314 When non-nil, clones of a subtree don't inherit the ID property.
315 Otherwise they inherit the ID property with a new unique
325 (defun org-version (&optional here full message
)
326 "Show the org-mode version.
327 Interactively, or when MESSAGE is non-nil, show it in echo area.
328 With prefix argument, or when HERE is non-nil, insert it at point.
329 In non-interactive uses, a reduced version string is output unless
331 (interactive (list current-prefix-arg t
(not current-prefix-arg
)))
332 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
333 (save-load-suffixes (when (boundp 'load-suffixes
) load-suffixes
))
334 (load-suffixes (list ".el"))
335 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
337 (and (fboundp 'org-release
) (fboundp 'org-git-version
))
338 (org-load-noerror-mustsuffix (concat org-dir
"org-version"))))
339 (load-suffixes save-load-suffixes
)
340 (org-version (org-release))
341 (git-version (org-git-version))
342 (version (format "Org-mode version %s (%s @ %s)"
346 (if (string= org-dir org-install-dir
)
348 (concat "mixed installation! " org-install-dir
" and " org-dir
))
349 "org-loaddefs.el can not be found!")))
350 (version1 (if full version org-version
)))
351 (when here
(insert version1
))
352 (when message
(message "%s" version1
))
355 (defconst org-version
(org-version))
362 (defconst org-block-regexp
363 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
364 "Regular expression for hiding blocks.")
366 (defconst org-dblock-start-re
367 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
368 "Matches the start line of a dynamic block, with parameters.")
370 (defconst org-dblock-end-re
"^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
371 "Matches the end of a dynamic block.")
373 ;;;; Clock and Planning
375 (defconst org-clock-string
"CLOCK:"
376 "String used as prefix for timestamps clocking work hours on an item.")
378 (defconst org-closed-string
"CLOSED:"
379 "String used as the prefix for timestamps logging closing a TODO entry.")
381 (defconst org-deadline-string
"DEADLINE:"
382 "String to mark deadline entries.
383 A deadline is this string, followed by a time stamp. Should be a word,
384 terminated by a colon. You can insert a schedule keyword and
385 a timestamp with \\[org-deadline].")
387 (defconst org-scheduled-string
"SCHEDULED:"
388 "String to mark scheduled TODO entries.
389 A schedule is this string, followed by a time stamp. Should be a word,
390 terminated by a colon. You can insert a schedule keyword and
391 a timestamp with \\[org-schedule].")
393 (defconst org-ds-keyword-length
397 (list org-deadline-string org-scheduled-string
398 org-clock-string org-closed-string
))))
399 "Maximum length of the DEADLINE and SCHEDULED keywords.")
401 (defconst org-planning-line-re
404 (list org-closed-string org-deadline-string org-scheduled-string
)
406 "Matches a line with planning info.
407 Matched keyword is in group 1.")
409 (defconst org-clock-line-re
410 (concat "^[ \t]*" org-clock-string
)
411 "Matches a line with clock info.")
413 (defconst org-deadline-regexp
(concat "\\<" org-deadline-string
)
414 "Matches the DEADLINE keyword.")
416 (defconst org-deadline-time-regexp
417 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
418 "Matches the DEADLINE keyword together with a time stamp.")
420 (defconst org-deadline-time-hour-regexp
421 (concat "\\<" org-deadline-string
422 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
423 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
425 (defconst org-deadline-line-regexp
426 (concat "\\<\\(" org-deadline-string
"\\).*")
427 "Matches the DEADLINE keyword and the rest of the line.")
429 (defconst org-scheduled-regexp
(concat "\\<" org-scheduled-string
)
430 "Matches the SCHEDULED keyword.")
432 (defconst org-scheduled-time-regexp
433 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
434 "Matches the SCHEDULED keyword together with a time stamp.")
436 (defconst org-scheduled-time-hour-regexp
437 (concat "\\<" org-scheduled-string
438 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
439 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
441 (defconst org-closed-time-regexp
442 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
443 "Matches the CLOSED keyword together with a time stamp.")
445 (defconst org-keyword-time-regexp
448 (list org-scheduled-string org-deadline-string org-closed-string
451 " *[[<]\\([^]>]+\\)[]>]")
452 "Matches any of the 4 keywords, together with the time stamp.")
454 (defconst org-keyword-time-not-clock-regexp
458 (list org-scheduled-string org-deadline-string org-closed-string
) t
)
459 " *[[<]\\([^]>]+\\)[]>]")
460 "Matches any of the 3 keywords, together with the time stamp.")
462 (defconst org-maybe-keyword-time-regexp
465 (list org-scheduled-string org-deadline-string org-closed-string
469 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
472 "Matches a timestamp, possibly preceded by a keyword.")
474 (defconst org-all-time-keywords
475 (mapcar (lambda (w) (substring w
0 -
1))
476 (list org-scheduled-string org-deadline-string
477 org-clock-string org-closed-string
))
478 "List of time keywords.")
482 (defconst org-drawer-regexp
"^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
483 "Matches first or last line of a hidden block.
484 Group 1 contains drawer's name or \"END\".")
486 (defconst org-property-start-re
"^[ \t]*:PROPERTIES:[ \t]*$"
487 "Regular expression matching the first line of a property drawer.")
489 (defconst org-property-end-re
"^[ \t]*:END:[ \t]*$"
490 "Regular expression matching the last line of a property drawer.")
492 (defconst org-clock-drawer-start-re
"^[ \t]*:CLOCK:[ \t]*$"
493 "Regular expression matching the first line of a clock drawer.")
495 (defconst org-clock-drawer-end-re
"^[ \t]*:END:[ \t]*$"
496 "Regular expression matching the last line of a clock drawer.")
498 (defconst org-property-drawer-re
499 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
500 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
501 "[ \t]*:END:[ \t]*$")
502 "Matches an entire property drawer.")
504 (defconst org-clock-drawer-re
505 (concat "\\(" org-clock-drawer-start-re
"\\)[^\000]*?\\("
506 org-clock-drawer-end-re
"\\)\n?")
507 "Matches an entire clock drawer.")
511 (defconst org-heading-keyword-regexp-format
512 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
513 "Printf format for a regexp matching a headline with some keyword.
514 This regexp will match the headline of any node which has the
515 exact keyword that is put into the format. The keyword isn't in
516 any group by default, but the stars and the body are.")
518 (defconst org-heading-keyword-maybe-regexp-format
519 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
520 "Printf format for a regexp matching a headline, possibly with some keyword.
521 This regexp can match any headline with the specified keyword, or
522 without a keyword. The keyword isn't in any group by default,
523 but the stars and the body are.")
525 (defconst org-archive-tag
"ARCHIVE"
526 "The tag that marks a subtree as archived.
527 An archived subtree does not open during visibility cycling, and does
528 not contribute to the agenda listings.")
530 (defconst org-comment-string
"COMMENT"
531 "Entries starting with this keyword will never be exported.
532 An entry can be toggled between COMMENT and normal with
533 \\[org-toggle-comment].")
536 ;;;; LaTeX Environments and Fragments
538 (defconst org-latex-regexps
539 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
540 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
541 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
542 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
543 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
544 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
545 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil
)
546 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil
))
547 "Regular expressions for matching embedded LaTeX.")
551 (defconst org-effort-property
"Effort"
552 "The property that is being used to keep track of effort estimates.
553 Effort estimates given in this property need to have the format H:MM.")
557 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
558 "Detect an org-type or table-type table.")
560 (defconst org-table-line-regexp
"^[ \t]*|"
561 "Detect an org-type table line.")
563 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
564 "Detect an org-type table line.")
566 (defconst org-table-hline-regexp
"^[ \t]*|-"
567 "Detect an org-type table hline.")
569 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
570 "Detect a table-type table hline.")
572 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
573 "Detect the first line outside a table when searching from within it.
574 This works for both table types.")
576 (defconst org-TBLFM-regexp
"^[ \t]*#\\+TBLFM: "
577 "Detect a #+TBLFM line.")
581 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
582 "Regular expression for fast time stamp matching.")
584 (defconst org-ts-regexp-inactive
585 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
586 "Regular expression for fast inactive time stamp matching.")
588 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
589 "Regular expression for fast time stamp matching.")
591 (defconst org-ts-regexp0
592 "\\(\\([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.
594 This one does not require the space after the date, so it can be used
595 on a string that terminates immediately after the date.")
597 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
598 "Regular expression matching time strings for analysis.")
600 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
601 "Regular expression matching time stamps, with groups.")
603 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
604 "Regular expression matching time stamps (also [..]), with groups.")
606 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
607 "Regular expression matching a time stamp range.")
609 (defconst org-tr-regexp-both
610 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
611 "Regular expression matching a time stamp range.")
613 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
614 org-ts-regexp
"\\)?")
615 "Regular expression matching a time stamp or time stamp range.")
617 (defconst org-tsr-regexp-both
618 (concat org-ts-regexp-both
"\\(--?-?"
619 org-ts-regexp-both
"\\)?")
620 "Regular expression matching a time stamp or time stamp range.
621 The time stamps may be either active or inactive.")
623 (defconst org-repeat-re
624 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
625 "Regular expression for specifying repeated events.
626 After a match, group 1 contains the repeat expression.")
628 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
629 "Formats for `format-time-string' which are used for time stamps.")
632 ;;; The custom variables
635 "Outline-based notes management and organizer."
640 (defcustom org-mode-hook nil
641 "Mode hook for Org-mode, run after the mode was turned on."
645 (defcustom org-load-hook nil
646 "Hook that is run after org.el has been loaded."
650 (defcustom org-log-buffer-setup-hook nil
651 "Hook that is run after an Org log buffer is created."
656 (defvar org-modules
) ; defined below
657 (defvar org-modules-loaded nil
658 "Have the modules been loaded already?")
660 (defun org-load-modules-maybe (&optional force
)
661 "Load all extensions listed in `org-modules'."
662 (when (or force
(not org-modules-loaded
))
664 (condition-case nil
(require ext
)
665 (error (message "Problems while trying to load feature `%s'" ext
))))
667 (setq org-modules-loaded t
)))
669 (defun org-set-modules (var value
)
670 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
672 (when (featurep 'org
)
673 (org-load-modules-maybe 'force
)
674 (org-element-cache-reset 'all
)))
676 (defcustom org-modules
'(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail
)
677 "Modules that should always be loaded together with org.el.
679 If a description starts with <C>, the file is not part of Emacs
680 and loading it will require that you have downloaded and properly
681 installed the Org mode distribution.
683 You can also use this system to load external packages (i.e. neither Org
684 core modules, nor modules from the CONTRIB directory). Just add symbols
685 to the end of the list. If the package is called org-xyz.el, then you need
686 to add the symbol `xyz', and the package must have a call to:
690 For export specific modules, see also `org-export-backends'."
692 :set
'org-set-modules
694 :package-version
'(Org .
"8.0")
697 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
698 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
699 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
700 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
701 (const :tag
" docview: Links to doc-view buffers" org-docview
)
702 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
703 (const :tag
" habit: Track your consistency with habits" org-habit
)
704 (const :tag
" id: Global IDs for identifying entries" org-id
)
705 (const :tag
" info: Links to Info nodes" org-info
)
706 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
707 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
708 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
709 (const :tag
" mouse: Additional mouse support" org-mouse
)
710 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
711 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
712 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
714 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
715 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
716 (const :tag
"C bullets: Add overlays to headlines stars" org-bullets
)
717 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
718 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
719 (const :tag
"C collector: Collect properties into tables" org-collector
)
720 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
721 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
722 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
723 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
724 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
725 (const :tag
"C eval: Include command output as text" org-eval
)
726 (const :tag
"C eww: Store link to url of eww" org-eww
)
727 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
728 (const :tag
"C favtable: Lookup table of favorite references and links" org-favtable
)
729 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
730 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
731 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
732 (const :tag
"C jira: Add a jira:ticket protocol to Org-mode" org-jira
)
733 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
734 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
735 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
736 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
737 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
738 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
739 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
740 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
741 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
742 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
743 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
744 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
745 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
746 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
747 (const :tag
"C track: Keep up with Org-mode development" org-track
)
748 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
749 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
750 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
751 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
752 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
754 (defvar org-export--registered-backends
) ; From ox.el.
755 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
756 (declare-function org-export-backend-name
"ox" (backend))
757 (defcustom org-export-backends
'(ascii html icalendar latex
)
758 "List of export back-ends that should be always available.
760 If a description starts with <C>, the file is not part of Emacs
761 and loading it will require that you have downloaded and properly
762 installed the Org mode distribution.
764 Unlike to `org-modules', libraries in this list will not be
765 loaded along with Org, but only once the export framework is
768 This variable needs to be set before org.el is loaded. If you
769 need to make a change while Emacs is running, use the customize
770 interface or run the following code, where VAL stands for the new
771 value of the variable, after updating it:
774 \(setq org-export--registered-backends
777 \(let ((name (org-export-backend-name backend)))
781 \(and (org-export-derived-backend-p b name)
782 \(throw 'parentp t)))))))
783 org-export--registered-backends))
784 \(let ((new-list (mapcar 'org-export-backend-name
785 org-export--registered-backends)))
786 \(dolist (backend val)
788 \((not (load (format \"ox-%s\" backend) t t))
789 \(message \"Problems while trying to load export back-end `%s'\"
791 \((not (memq backend new-list)) (push backend new-list))))
792 \(set-default 'org-export-backends new-list)))
794 Adding a back-end to this list will also pull the back-end it
799 :package-version
'(Org .
"8.0")
800 :initialize
'custom-initialize-set
801 :set
(lambda (var val
)
802 (if (not (featurep 'ox
)) (set-default var val
)
803 ;; Any back-end not required anymore (not present in VAL and not
804 ;; a parent of any back-end in the new value) is removed from the
805 ;; list of registered back-ends.
806 (setq org-export--registered-backends
809 (let ((name (org-export-backend-name backend
)))
813 (and (org-export-derived-backend-p b name
)
814 (throw 'parentp t
)))))))
815 org-export--registered-backends
))
816 ;; Now build NEW-LIST of both new back-ends and required
818 (let ((new-list (mapcar 'org-export-backend-name
819 org-export--registered-backends
)))
820 (dolist (backend val
)
822 ((not (load (format "ox-%s" backend
) t t
))
823 (message "Problems while trying to load export back-end `%s'"
825 ((not (memq backend new-list
)) (push backend new-list
))))
826 ;; Set VAR to that list with fixed dependencies.
827 (set-default var new-list
))))
828 :type
'(set :greedy t
829 (const :tag
" ascii Export buffer to ASCII format" ascii
)
830 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
831 (const :tag
" html Export buffer to HTML format" html
)
832 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
833 (const :tag
" latex Export buffer to LaTeX format" latex
)
834 (const :tag
" man Export buffer to MAN format" man
)
835 (const :tag
" md Export buffer to Markdown format" md
)
836 (const :tag
" odt Export buffer to ODT format" odt
)
837 (const :tag
" org Export buffer to Org format" org
)
838 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
839 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
840 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
841 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
842 (const :tag
"C groff Export buffer to Groff format" groff
)
843 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
844 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
845 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
846 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
851 (condition-case nil
(require (intern (format "ox-%s" backend
)))
852 (error (message "Problems while trying to load export back-end `%s'"
854 org-export-backends
))
856 (defcustom org-support-shift-select nil
857 "Non-nil means make shift-cursor commands select text when possible.
859 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
860 start selecting a region, or enlarge regions started in this way.
861 In Org-mode, in special contexts, these same keys are used for
862 other purposes, important enough to compete with shift selection.
863 Org tries to balance these needs by supporting `shift-select-mode'
864 outside these special contexts, under control of this variable.
866 The default of this variable is nil, to avoid confusing behavior. Shifted
867 cursor keys will then execute Org commands in the following contexts:
868 - on a headline, changing TODO state (left/right) and priority (up/down)
869 - on a time stamp, changing the time
870 - in a plain list item, changing the bullet type
871 - in a property definition line, switching between allowed values
872 - in the BEGIN line of a clock table (changing the time block).
873 Outside these contexts, the commands will throw an error.
875 When this variable is t and the cursor is not in a special
876 context, Org-mode will support shift-selection for making and
877 enlarging regions. To make this more effective, the bullet
878 cycling will no longer happen anywhere in an item line, but only
879 if the cursor is exactly on the bullet.
881 If you set this variable to the symbol `always', then the keys
882 will not be special in headlines, property lines, and item lines,
883 to make shift selection work there as well. If this is what you
884 want, you can use the following alternative commands: `C-c C-t'
885 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
886 can be used to switch TODO sets, `C-c -' to cycle item bullet
887 types, and properties can be edited by hand or in column view.
889 However, when the cursor is on a timestamp, shift-cursor commands
890 will still edit the time stamp - this is just too good to give up.
892 XEmacs user should have this variable set to nil, because
893 `shift-select-mode' is in Emacs 23 or later only."
896 (const :tag
"Never" nil
)
897 (const :tag
"When outside special context" t
)
898 (const :tag
"Everywhere except timestamps" always
)))
900 (defcustom org-loop-over-headlines-in-active-region nil
901 "Shall some commands act upon headlines in the active region?
903 When set to `t', some commands will be performed in all headlines
904 within the active region.
906 When set to `start-level', some commands will be performed in all
907 headlines within the active region, provided that these headlines
908 are of the same level than the first one.
910 When set to a string, those commands will be performed on the
911 matching headlines within the active region. Such string must be
912 a tags/property/todo match as it is used in the agenda tags view.
914 The list of commands is: `org-schedule', `org-deadline',
915 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
916 `org-archive-to-archive-sibling'. The archiving commands skip
917 already archived entries."
918 :type
'(choice (const :tag
"Don't loop" nil
)
919 (const :tag
"All headlines in active region" t
)
920 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
921 (string :tag
"Tags/Property/Todo matcher"))
926 (defgroup org-startup nil
927 "Options concerning startup of Org-mode."
931 (defcustom org-startup-folded t
932 "Non-nil means entering Org-mode will switch to OVERVIEW.
933 This can also be configured on a per-file basis by adding one of
934 the following lines anywhere in the buffer:
936 #+STARTUP: fold (or `overview', this is equivalent)
937 #+STARTUP: nofold (or `showall', this is equivalent)
939 #+STARTUP: showeverything
941 By default, this option is ignored when Org opens agenda files
942 for the first time. If you want the agenda to honor the startup
943 option, set `org-agenda-inhibit-startup' to nil."
946 (const :tag
"nofold: show all" nil
)
947 (const :tag
"fold: overview" t
)
948 (const :tag
"content: all headlines" content
)
949 (const :tag
"show everything, even drawers" showeverything
)))
951 (defcustom org-startup-truncated t
952 "Non-nil means entering Org-mode will set `truncate-lines'.
953 This is useful since some lines containing links can be very long and
954 uninteresting. Also tables look terrible when wrapped."
958 (defcustom org-startup-indented nil
959 "Non-nil means turn on `org-indent-mode' on startup.
960 This can also be configured on a per-file basis by adding one of
961 the following lines anywhere in the buffer:
965 :group
'org-structure
967 (const :tag
"Not" nil
)
968 (const :tag
"Globally (slow on startup in large files)" t
)))
970 (defcustom org-use-sub-superscripts t
971 "Non-nil means interpret \"_\" and \"^\" for display.
973 If you want to control how Org exports those characters, see
974 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
975 used to be an alias for `org-export-with-sub-superscripts' in
976 Org <8.0, it is not anymore.
978 When this option is turned on, you can use TeX-like syntax for
979 sub- and superscripts within the buffer. Several characters after
980 \"_\" or \"^\" will be considered as a single item - so grouping
981 with {} is normally not needed. For example, the following things
982 will be parsed as single sub- or superscripts:
984 10^24 or 10^tau several digits will be considered 1 item.
985 10^-12 or 10^-tau a leading sign with digits or a word
986 x^2-y^3 will be read as x^2 - y^3, because items are
987 terminated by almost any nonword/nondigit char.
988 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
990 Still, ambiguity is possible. So when in doubt, use {} to enclose
991 the sub/superscript. If you set this variable to the symbol `{}',
992 the braces are *required* in order to trigger interpretations as
993 sub/superscript. This can be helpful in documents that need \"_\"
994 frequently in plain text."
997 :package-version
'(Org .
"8.0")
999 (const :tag
"Always interpret" t
)
1000 (const :tag
"Only with braces" {})
1001 (const :tag
"Never interpret" nil
)))
1003 (defcustom org-startup-with-beamer-mode nil
1004 "Non-nil means turn on `org-beamer-mode' on startup.
1005 This can also be configured on a per-file basis by adding one of
1006 the following lines anywhere in the buffer:
1013 (defcustom org-startup-align-all-tables nil
1014 "Non-nil means align all tables when visiting a file.
1015 This is useful when the column width in tables is forced with <N> cookies
1016 in table fields. Such tables will look correct only after the first re-align.
1017 This can also be configured on a per-file basis by adding one of
1018 the following lines anywhere in the buffer:
1024 (defcustom org-startup-with-inline-images nil
1025 "Non-nil means show inline images when loading a new Org file.
1026 This can also be configured on a per-file basis by adding one of
1027 the following lines anywhere in the buffer:
1028 #+STARTUP: inlineimages
1029 #+STARTUP: noinlineimages"
1034 (defcustom org-startup-with-latex-preview nil
1035 "Non-nil means preview LaTeX fragments when loading a new Org file.
1037 This can also be configured on a per-file basis by adding one of
1038 the following lines anywhere in the buffer:
1039 #+STARTUP: latexpreview
1040 #+STARTUP: nolatexpreview"
1043 :package-version
'(Org .
"8.0")
1046 (defcustom org-insert-mode-line-in-empty-file nil
1047 "Non-nil means insert the first line setting Org-mode in empty files.
1048 When the function `org-mode' is called interactively in an empty file, this
1049 normally means that the file name does not automatically trigger Org-mode.
1050 To ensure that the file will always be in Org-mode in the future, a
1051 line enforcing Org-mode will be inserted into the buffer, if this option
1056 (defcustom org-replace-disputed-keys nil
1057 "Non-nil means use alternative key bindings for some keys.
1058 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1059 These keys are also used by other packages like shift-selection-mode'
1060 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1061 If you want to use Org-mode together with one of these other modes,
1062 or more generally if you would like to move some Org-mode commands to
1063 other keys, set this variable and configure the keys with the variable
1064 `org-disputed-keys'.
1066 This option is only relevant at load-time of Org-mode, and must be set
1067 *before* org.el is loaded. Changing it requires a restart of Emacs to
1072 (defcustom org-use-extra-keys nil
1073 "Non-nil means use extra key sequence definitions for certain commands.
1074 This happens automatically if you run XEmacs or if `window-system'
1075 is nil. This variable lets you do the same manually. You must
1076 set it before loading org.
1078 Example: on Carbon Emacs 22 running graphically, with an external
1079 keyboard on a Powerbook, the default way of setting M-left might
1080 not work for either Alt or ESC. Setting this variable will make
1085 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1087 (defcustom org-disputed-keys
1088 '(([(shift up
)] .
[(meta p
)])
1089 ([(shift down
)] .
[(meta n
)])
1090 ([(shift left
)] .
[(meta -
)])
1091 ([(shift right
)] .
[(meta +)])
1092 ([(control shift right
)] .
[(meta shift
+)])
1093 ([(control shift left
)] .
[(meta shift -
)]))
1094 "Keys for which Org-mode and other modes compete.
1095 This is an alist, cars are the default keys, second element specifies
1096 the alternative to use when `org-replace-disputed-keys' is t.
1098 Keys can be specified in any syntax supported by `define-key'.
1099 The value of this option takes effect only at Org-mode's startup,
1100 therefore you'll have to restart Emacs to apply it after changing."
1104 (defun org-key (key)
1105 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1106 Or return the original if not disputed.
1107 Also apply the translations defined in `org-xemacs-key-equivalents'."
1108 (when org-replace-disputed-keys
1109 (let* ((nkey (key-description key
))
1110 (x (org-find-if (lambda (x)
1111 (equal (key-description (car x
)) nkey
))
1112 org-disputed-keys
)))
1113 (setq key
(if x
(cdr x
) key
))))
1114 (when (featurep 'xemacs
)
1115 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1118 (defun org-find-if (predicate seq
)
1121 (if (funcall predicate
(car seq
))
1122 (throw 'exit
(car seq
))
1125 (defun org-defkey (keymap key def
)
1126 "Define a key, possibly translated, as returned by `org-key'."
1127 (define-key keymap
(org-key key
) def
))
1129 (defcustom org-ellipsis nil
1130 "The ellipsis to use in the Org-mode outline.
1131 When nil, just use the standard three dots.
1132 When a string, use that string instead.
1133 When a face, use the standard 3 dots, but with the specified face.
1134 The change affects only Org-mode (which will then use its own display table).
1135 Changing this requires executing \\[org-mode] in a buffer to become
1138 :type
'(choice (const :tag
"Default" nil
)
1139 (face :tag
"Face" :value org-warning
)
1140 (string :tag
"String" :value
"...#")))
1142 (defvar org-display-table nil
1143 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1145 (defgroup org-keywords nil
1146 "Keywords in Org-mode."
1150 (defcustom org-closed-keep-when-no-todo nil
1151 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1153 :group
'org-keywords
1155 :package-version
'(Org .
"8.0")
1158 (defgroup org-structure nil
1159 "Options concerning the general structure of Org-mode files."
1160 :tag
"Org Structure"
1163 (defgroup org-reveal-location nil
1164 "Options about how to make context of a location visible."
1165 :tag
"Org Reveal Location"
1166 :group
'org-structure
)
1168 (defconst org-context-choice
1170 (const :tag
"Always" t
)
1171 (const :tag
"Never" nil
)
1172 (repeat :greedy t
:tag
"Individual contexts"
1174 (choice :tag
"Context"
1181 (const bookmark-jump
)
1185 "Contexts for the reveal options.")
1187 (defcustom org-show-hierarchy-above
'((default . t
))
1188 "Non-nil means show full hierarchy when revealing a location.
1189 Org-mode often shows locations in an org-mode file which might have
1190 been invisible before. When this is set, the hierarchy of headings
1191 above the exposed location is shown.
1192 Turning this off for example for sparse trees makes them very compact.
1193 Instead of t, this can also be an alist specifying this option for different
1194 contexts. Valid contexts are
1195 agenda when exposing an entry from the agenda
1196 org-goto when using the command `org-goto' on key C-c C-j
1197 occur-tree when using the command `org-occur' on key C-c /
1198 tags-tree when constructing a sparse tree based on tags matches
1199 link-search when exposing search matches associated with a link
1200 mark-goto when exposing the jump goal of a mark
1201 bookmark-jump when exposing a bookmark location
1202 isearch when exiting from an incremental search
1203 default default for all contexts not set explicitly"
1204 :group
'org-reveal-location
1205 :type org-context-choice
)
1207 (defcustom org-show-following-heading
'((default . nil
))
1208 "Non-nil means show following heading when revealing a location.
1209 Org-mode often shows locations in an org-mode file which might have
1210 been invisible before. When this is set, the heading following the
1212 Turning this off for example for sparse trees makes them very compact,
1213 but makes it harder to edit the location of the match. In such a case,
1214 use the command \\[org-reveal] to show more context.
1215 Instead of t, this can also be an alist specifying this option for different
1216 contexts. See `org-show-hierarchy-above' for valid contexts."
1217 :group
'org-reveal-location
1218 :type org-context-choice
)
1220 (defcustom org-show-siblings
'((default . nil
) (isearch t
) (bookmark-jump t
))
1221 "Non-nil means show all sibling heading when revealing a location.
1222 Org-mode often shows locations in an org-mode file which might have
1223 been invisible before. When this is set, the sibling of the current entry
1224 heading are all made visible. If `org-show-hierarchy-above' is t,
1225 the same happens on each level of the hierarchy above the current entry.
1227 By default this is on for the isearch context, off for all other contexts.
1228 Turning this off for example for sparse trees makes them very compact,
1229 but makes it harder to edit the location of the match. In such a case,
1230 use the command \\[org-reveal] to show more context.
1231 Instead of t, this can also be an alist specifying this option for different
1232 contexts. See `org-show-hierarchy-above' for valid contexts."
1233 :group
'org-reveal-location
1234 :type org-context-choice
1236 :package-version
'(Org .
"8.0"))
1238 (defcustom org-show-entry-below
'((default . nil
))
1239 "Non-nil means show the entry below a headline when revealing a location.
1240 Org-mode often shows locations in an org-mode file which might have
1241 been invisible before. When this is set, the text below the headline that is
1242 exposed is also shown.
1244 By default this is off for all contexts.
1245 Instead of t, this can also be an alist specifying this option for different
1246 contexts. See `org-show-hierarchy-above' for valid contexts."
1247 :group
'org-reveal-location
1248 :type org-context-choice
)
1250 (defcustom org-indirect-buffer-display
'other-window
1251 "How should indirect tree buffers be displayed?
1252 This applies to indirect buffers created with the commands
1253 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1255 current-window Display in the current window
1256 other-window Just display in another window.
1257 dedicated-frame Create one new frame, and re-use it each time.
1258 new-frame Make a new frame each time. Note that in this case
1259 previously-made indirect buffers are kept, and you need to
1260 kill these buffers yourself."
1261 :group
'org-structure
1262 :group
'org-agenda-windows
1264 (const :tag
"In current window" current-window
)
1265 (const :tag
"In current frame, other window" other-window
)
1266 (const :tag
"Each time a new frame" new-frame
)
1267 (const :tag
"One dedicated frame" dedicated-frame
)))
1269 (defcustom org-use-speed-commands nil
1270 "Non-nil means activate single letter commands at beginning of a headline.
1271 This may also be a function to test for appropriate locations where speed
1272 commands should be active.
1274 For example, to activate speed commands when the point is on any
1275 star at the beginning of the headline, you can do this:
1277 (setq org-use-speed-commands
1278 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1279 :group
'org-structure
1281 (const :tag
"Never" nil
)
1282 (const :tag
"At beginning of headline stars" t
)
1285 (defcustom org-speed-commands-user nil
1286 "Alist of additional speed commands.
1287 This list will be checked before `org-speed-commands-default'
1288 when the variable `org-use-speed-commands' is non-nil
1289 and when the cursor is at the beginning of a headline.
1290 The car if each entry is a string with a single letter, which must
1291 be assigned to `self-insert-command' in the global map.
1292 The cdr is either a command to be called interactively, a function
1293 to be called, or a form to be evaluated.
1294 An entry that is just a list with a single string will be interpreted
1295 as a descriptive headline that will be added when listing the speed
1296 commands in the Help buffer using the `?' speed command."
1297 :group
'org-structure
1298 :type
'(repeat :value
("k" . ignore
)
1299 (choice :value
("k" . ignore
)
1300 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1301 (cons :tag
"Letter and Command"
1302 (string :tag
"Command letter")
1307 (defcustom org-bookmark-names-plist
1308 '(:last-capture
"org-capture-last-stored"
1309 :last-refile
"org-refile-last-stored"
1310 :last-capture-marker
"org-capture-last-stored-marker")
1311 "Names for bookmarks automatically set by some Org commands.
1312 This can provide strings as names for a number of bookmarks Org sets
1313 automatically. The following keys are currently implemented:
1315 :last-capture-marker
1317 When a key does not show up in the property list, the corresponding bookmark
1319 :group
'org-structure
1322 (defgroup org-cycle nil
1323 "Options concerning visibility cycling in Org-mode."
1325 :group
'org-structure
)
1327 (defcustom org-cycle-skip-children-state-if-no-children t
1328 "Non-nil means skip CHILDREN state in entries that don't have any."
1332 (defcustom org-cycle-max-level nil
1333 "Maximum level which should still be subject to visibility cycling.
1334 Levels higher than this will, for cycling, be treated as text, not a headline.
1335 When `org-odd-levels-only' is set, a value of N in this variable actually
1336 means 2N-1 stars as the limiting headline.
1337 When nil, cycle all levels.
1338 Note that the limiting level of cycling is also influenced by
1339 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1340 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1344 (const :tag
"No limit" nil
)
1345 (integer :tag
"Maximum level")))
1347 (defcustom org-hide-block-startup nil
1348 "Non-nil means entering Org-mode will fold all blocks.
1349 This can also be set in on a per-file basis with
1351 #+STARTUP: hideblocks
1352 #+STARTUP: showblocks"
1357 (defcustom org-cycle-global-at-bob nil
1358 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1359 This makes it possible to do global cycling without having to use S-TAB or
1360 \\[universal-argument] TAB. For this special case to work, the first line
1361 of the buffer must not be a headline -- it may be empty or some other text.
1362 When used in this way, `org-cycle-hook' is disabled temporarily to make
1363 sure the cursor stays at the beginning of the buffer. When this option is
1364 nil, don't do anything special at the beginning of the buffer."
1368 (defcustom org-cycle-level-after-item
/entry-creation t
1369 "Non-nil means cycle entry level or item indentation in new empty entries.
1371 When the cursor is at the end of an empty headline, i.e., with only stars
1372 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1373 and then all possible ancestor states, before returning to the original state.
1374 This makes data entry extremely fast: M-RET to create a new headline,
1375 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1377 When the cursor is at the end of an empty plain list item, one TAB will
1378 make it a subitem, two or more tabs will back up to make this an item
1379 higher up in the item hierarchy."
1383 (defcustom org-cycle-emulate-tab t
1384 "Where should `org-cycle' emulate TAB.
1386 white Only in completely white lines
1387 whitestart Only at the beginning of lines, before the first non-white char
1388 t Everywhere except in headlines
1389 exc-hl-bol Everywhere except at the start of a headline
1390 If TAB is used in a place where it does not emulate TAB, the current subtree
1391 visibility is cycled."
1393 :type
'(choice (const :tag
"Never" nil
)
1394 (const :tag
"Only in completely white lines" white
)
1395 (const :tag
"Before first char in a line" whitestart
)
1396 (const :tag
"Everywhere except in headlines" t
)
1397 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1399 (defcustom org-cycle-separator-lines
2
1400 "Number of empty lines needed to keep an empty line between collapsed trees.
1401 If you leave an empty line between the end of a subtree and the following
1402 headline, this empty line is hidden when the subtree is folded.
1403 Org-mode will leave (exactly) one empty line visible if the number of
1404 empty lines is equal or larger to the number given in this variable.
1405 So the default 2 means at least 2 empty lines after the end of a subtree
1406 are needed to produce free space between a collapsed subtree and the
1409 If the number is negative, and the number of empty lines is at least -N,
1410 all empty lines are shown.
1412 Special case: when 0, never leave empty lines in collapsed view."
1415 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1417 (defcustom org-pre-cycle-hook nil
1418 "Hook that is run before visibility cycling is happening.
1419 The function(s) in this hook must accept a single argument which indicates
1420 the new state that will be set right after running this hook. The
1421 argument is a symbol. Before a global state change, it can have the values
1422 `overview', `content', or `all'. Before a local state change, it can have
1423 the values `folded', `children', or `subtree'."
1427 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1428 org-cycle-hide-drawers
1429 org-cycle-hide-inline-tasks
1430 org-cycle-show-empty-lines
1431 org-optimize-window-after-visibility-change
)
1432 "Hook that is run after `org-cycle' has changed the buffer visibility.
1433 The function(s) in this hook must accept a single argument which indicates
1434 the new state that was set by the most recent `org-cycle' command. The
1435 argument is a symbol. After a global state change, it can have the values
1436 `overview', `contents', or `all'. After a local state change, it can have
1437 the values `folded', `children', or `subtree'."
1441 (defgroup org-edit-structure nil
1442 "Options concerning structure editing in Org-mode."
1443 :tag
"Org Edit Structure"
1444 :group
'org-structure
)
1446 (defcustom org-odd-levels-only nil
1447 "Non-nil means skip even levels and only use odd levels for the outline.
1448 This has the effect that two stars are being added/taken away in
1449 promotion/demotion commands. It also influences how levels are
1450 handled by the exporters.
1451 Changing it requires restart of `font-lock-mode' to become effective
1452 for fontification also in regions already fontified.
1453 You may also set this on a per-file basis by adding one of the following
1454 lines to the buffer:
1458 :group
'org-edit-structure
1459 :group
'org-appearance
1462 (defcustom org-adapt-indentation t
1463 "Non-nil means adapt indentation to outline node level.
1465 When this variable is set, Org assumes that you write outlines by
1466 indenting text in each node to align with the headline (after the
1467 stars). The following issues are influenced by this variable:
1469 - The indentation is increased by one space in a demotion
1470 command, and decreased by one in a promotion command. However,
1471 in the latter case, if shifting some line in the entry body
1472 would alter document structure (e.g., insert a new headline),
1473 indentation is not changed at all.
1475 - Property drawers and planning information is inserted indented
1476 when this variable is set. When nil, they will not be indented.
1478 - TAB indents a line relative to current level. The lines below
1479 a headline will be indented when this variable is set.
1481 Note that this is all about true indentation, by adding and
1482 removing space characters. See also `org-indent.el' which does
1483 level-dependent indentation in a virtual way, i.e. at display
1485 :group
'org-edit-structure
1488 (defcustom org-special-ctrl-a
/e nil
1489 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1491 When t, `C-a' will bring back the cursor to the beginning of the
1492 headline text, i.e. after the stars and after a possible TODO
1493 keyword. In an item, this will be the position after bullet and
1494 check-box, if any. When the cursor is already at that position,
1495 another `C-a' will bring it to the beginning of the line.
1497 `C-e' will jump to the end of the headline, ignoring the presence
1498 of tags in the headline. A second `C-e' will then jump to the
1499 true end of the line, after any tags. This also means that, when
1500 this variable is non-nil, `C-e' also will never jump beyond the
1501 end of the heading of a folded section, i.e. not after the
1504 When set to the symbol `reversed', the first `C-a' or `C-e' works
1505 normally, going to the true line boundary first. Only a directly
1506 following, identical keypress will bring the cursor to the
1509 This may also be a cons cell where the behavior for `C-a' and
1510 `C-e' is set separately."
1511 :group
'org-edit-structure
1513 (const :tag
"off" nil
)
1514 (const :tag
"on: after stars/bullet and before tags first" t
)
1515 (const :tag
"reversed: true line boundary first" reversed
)
1516 (cons :tag
"Set C-a and C-e separately"
1517 (choice :tag
"Special C-a"
1518 (const :tag
"off" nil
)
1519 (const :tag
"on: after stars/bullet first" t
)
1520 (const :tag
"reversed: before stars/bullet first" reversed
))
1521 (choice :tag
"Special C-e"
1522 (const :tag
"off" nil
)
1523 (const :tag
"on: before tags first" t
)
1524 (const :tag
"reversed: after tags first" reversed
)))))
1525 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1527 (defcustom org-special-ctrl-k nil
1528 "Non-nil means `C-k' will behave specially in headlines.
1529 When nil, `C-k' will call the default `kill-line' command.
1530 When t, the following will happen while the cursor is in the headline:
1532 - When the cursor is at the beginning of a headline, kill the entire
1533 line and possible the folded subtree below the line.
1534 - When in the middle of the headline text, kill the headline up to the tags.
1535 - When after the headline text, kill the tags."
1536 :group
'org-edit-structure
1539 (defcustom org-ctrl-k-protect-subtree nil
1540 "Non-nil means, do not delete a hidden subtree with C-k.
1541 When set to the symbol `error', simply throw an error when C-k is
1542 used to kill (part-of) a headline that has hidden text behind it.
1543 Any other non-nil value will result in a query to the user, if it is
1544 OK to kill that hidden subtree. When nil, kill without remorse."
1545 :group
'org-edit-structure
1548 (const :tag
"Do not protect hidden subtrees" nil
)
1549 (const :tag
"Protect hidden subtrees with a security query" t
)
1550 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1552 (defcustom org-special-ctrl-o t
1553 "Non-nil means, make `C-o' insert a row in tables."
1554 :group
'org-edit-structure
1557 (defcustom org-catch-invisible-edits nil
1558 "Check if in invisible region before inserting or deleting a character.
1561 nil Do not check, so just do invisible edits.
1562 error Throw an error and do nothing.
1563 show Make point visible, and do the requested edit.
1564 show-and-error Make point visible, then throw an error and abort the edit.
1565 smart Make point visible, and do insertion/deletion if it is
1566 adjacent to visible text and the change feels predictable.
1567 Never delete a previously invisible character or add in the
1568 middle or right after an invisible region. Basically, this
1569 allows insertion and backward-delete right before ellipses.
1570 FIXME: maybe in this case we should not even show?"
1571 :group
'org-edit-structure
1574 (const :tag
"Do not check" nil
)
1575 (const :tag
"Throw error when trying to edit" error
)
1576 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1577 (const :tag
"Show invisible part and do the edit" show
)
1578 (const :tag
"Be smart and do the right thing" smart
)))
1580 (defcustom org-yank-folded-subtrees t
1581 "Non-nil means when yanking subtrees, fold them.
1582 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1583 it starts with a heading and all other headings in it are either children
1584 or siblings, then fold all the subtrees. However, do this only if no
1585 text after the yank would be swallowed into a folded tree by this action."
1586 :group
'org-edit-structure
1589 (defcustom org-yank-adjusted-subtrees nil
1590 "Non-nil means when yanking subtrees, adjust the level.
1591 With this setting, `org-paste-subtree' is used to insert the subtree, see
1592 this function for details."
1593 :group
'org-edit-structure
1596 (defcustom org-M-RET-may-split-line
'((default . t
))
1597 "Non-nil means M-RET will split the line at the cursor position.
1598 When nil, it will go to the end of the line before making a
1600 You may also set this option in a different way for different
1601 contexts. Valid contexts are:
1603 headline when creating a new headline
1604 item when creating a new item
1605 table in a table field
1606 default the value to be used for all contexts not explicitly
1608 :group
'org-structure
1611 (const :tag
"Always" t
)
1612 (const :tag
"Never" nil
)
1613 (repeat :greedy t
:tag
"Individual contexts"
1615 (choice :tag
"Context"
1623 (defcustom org-insert-heading-respect-content nil
1624 "Non-nil means insert new headings after the current subtree.
1625 When nil, the new heading is created directly after the current line.
1626 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1627 this variable on for the duration of the command."
1628 :group
'org-structure
1631 (defcustom org-blank-before-new-entry
'((heading . auto
)
1632 (plain-list-item . auto
))
1633 "Should `org-insert-heading' leave a blank line before new heading/item?
1634 The value is an alist, with `heading' and `plain-list-item' as CAR,
1635 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1636 which case Org will look at the surrounding headings/items and try to
1637 make an intelligent decision whether to insert a blank line or not.
1639 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1640 the setting here is ignored and no empty line is inserted to avoid breaking
1641 the list structure."
1642 :group
'org-edit-structure
1644 (cons (const heading
)
1645 (choice (const :tag
"Never" nil
)
1646 (const :tag
"Always" t
)
1647 (const :tag
"Auto" auto
)))
1648 (cons (const plain-list-item
)
1649 (choice (const :tag
"Never" nil
)
1650 (const :tag
"Always" t
)
1651 (const :tag
"Auto" auto
)))))
1653 (defcustom org-insert-heading-hook nil
1654 "Hook being run after inserting a new heading."
1655 :group
'org-edit-structure
1658 (defcustom org-enable-fixed-width-editor t
1659 "Non-nil means lines starting with \":\" are treated as fixed-width.
1660 This currently only means they are never auto-wrapped.
1661 When nil, such lines will be treated like ordinary lines."
1662 :group
'org-edit-structure
1665 (defcustom org-goto-auto-isearch t
1666 "Non-nil means typing characters in `org-goto' starts incremental search.
1667 When nil, you can use these keybindings to navigate the buffer:
1669 q Quit the org-goto interface
1670 n Go to the next visible heading
1671 p Go to the previous visible heading
1672 f Go one heading forward on same level
1673 b Go one heading backward on same level
1674 u Go one heading up"
1675 :group
'org-edit-structure
1678 (defgroup org-sparse-trees nil
1679 "Options concerning sparse trees in Org-mode."
1680 :tag
"Org Sparse Trees"
1681 :group
'org-structure
)
1683 (defcustom org-highlight-sparse-tree-matches t
1684 "Non-nil means highlight all matches that define a sparse tree.
1685 The highlights will automatically disappear the next time the buffer is
1686 changed by an edit command."
1687 :group
'org-sparse-trees
1690 (defcustom org-remove-highlights-with-change t
1691 "Non-nil means any change to the buffer will remove temporary highlights.
1692 Such highlights are created by `org-occur' and `org-clock-display'.
1693 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1694 The highlights created by `org-toggle-latex-fragment' always need
1695 `C-c C-x C-l' to be removed."
1696 :group
'org-sparse-trees
1701 (defcustom org-occur-hook
'(org-first-headline-recenter)
1702 "Hook that is run after `org-occur' has constructed a sparse tree.
1703 This can be used to recenter the window to show as much of the structure
1705 :group
'org-sparse-trees
1708 (defgroup org-imenu-and-speedbar nil
1709 "Options concerning imenu and speedbar in Org-mode."
1710 :tag
"Org Imenu and Speedbar"
1711 :group
'org-structure
)
1713 (defcustom org-imenu-depth
2
1714 "The maximum level for Imenu access to Org-mode headlines.
1715 This also applied for speedbar access."
1716 :group
'org-imenu-and-speedbar
1719 (defgroup org-table nil
1720 "Options concerning tables in Org-mode."
1724 (defcustom org-enable-table-editor
'optimized
1725 "Non-nil means lines starting with \"|\" are handled by the table editor.
1726 When nil, such lines will be treated like ordinary lines.
1728 When equal to the symbol `optimized', the table editor will be optimized to
1730 - Automatic overwrite mode in front of whitespace in table fields.
1731 This makes the structure of the table stay in tact as long as the edited
1732 field does not exceed the column width.
1733 - Minimize the number of realigns. Normally, the table is aligned each time
1734 TAB or RET are pressed to move to another field. With optimization this
1735 happens only if changes to a field might have changed the column width.
1736 Optimization requires replacing the functions `self-insert-command',
1737 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1738 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1739 very good at guessing when a re-align will be necessary, but you can always
1740 force one with \\[org-ctrl-c-ctrl-c].
1742 If you would like to use the optimized version in Org-mode, but the
1743 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1745 This variable can be used to turn on and off the table editor during a session,
1746 but in order to toggle optimization, a restart is required.
1748 See also the variable `org-table-auto-blank-field'."
1751 (const :tag
"off" nil
)
1753 (const :tag
"on, optimized" optimized
)))
1755 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1756 (version<= emacs-version
"24.1"))
1757 "Non-nil means cluster self-insert commands for undo when possible.
1758 If this is set, then, like in the Emacs command loop, 20 consecutive
1759 characters will be undone together.
1760 This is configurable, because there is some impact on typing performance."
1764 (defcustom org-table-tab-recognizes-table.el t
1765 "Non-nil means TAB will automatically notice a table.el table.
1766 When it sees such a table, it moves point into it and - if necessary -
1767 calls `table-recognize-table'."
1768 :group
'org-table-editing
1771 (defgroup org-link nil
1772 "Options concerning links in Org-mode."
1776 (defvar org-link-abbrev-alist-local nil
1777 "Buffer-local version of `org-link-abbrev-alist', which see.
1778 The value of this is taken from the #+LINK lines.")
1779 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1781 (defcustom org-link-abbrev-alist nil
1782 "Alist of link abbreviations.
1783 The car of each element is a string, to be replaced at the start of a link.
1784 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1785 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1787 [[linkkey:tag][description]]
1789 The 'linkkey' must be a word word, starting with a letter, followed
1790 by letters, numbers, '-' or '_'.
1792 If REPLACE is a string, the tag will simply be appended to create the link.
1793 If the string contains \"%s\", the tag will be inserted there. If the string
1794 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1795 at that point (see the function `url-hexify-string'). If the string contains
1796 the specifier \"%(my-function)\", then the custom function `my-function' will
1797 be invoked: this function takes the tag as its only argument and must return
1800 REPLACE may also be a function that will be called with the tag as the
1801 only argument to create the link, which should be returned as a string.
1803 See the manual for examples."
1807 (string :tag
"Protocol")
1809 (string :tag
"Format")
1812 (defcustom org-descriptive-links t
1813 "Non-nil means Org will display descriptive links.
1814 E.g. [[http://orgmode.org][Org website]] will be displayed as
1815 \"Org Website\", hiding the link itself and just displaying its
1816 description. When set to `nil', Org will display the full links
1819 You can interactively set the value of this variable by calling
1820 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1824 (defcustom org-link-file-path-type
'adaptive
1825 "How the path name in file links should be stored.
1828 relative Relative to the current directory, i.e. the directory of the file
1829 into which the link is being inserted.
1830 absolute Absolute path, if possible with ~ for home directory.
1831 noabbrev Absolute path, no abbreviation of home directory.
1832 adaptive Use relative path for files in the current directory and sub-
1833 directories of it. For other files, use an absolute path."
1841 (defvaralias 'org-activate-links
'org-highlight-links
)
1842 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1843 "Types of links that should be highlighted in Org-mode files.
1845 This is a list of symbols, each one of them leading to the
1846 highlighting of a certain link type.
1848 You can still open links that are not highlighted.
1850 In principle, it does not hurt to turn on highlighting for all
1851 link types. There may be a small gain when turning off unused
1852 link types. The types are:
1854 bracket The recommended [[link][description]] or [[link]] links with hiding.
1855 angle Links in angular brackets that may contain whitespace like
1856 <bbdb:Carsten Dominik>.
1857 plain Plain links in normal text, no whitespace, like http://google.com.
1858 radio Text that is matched by a radio target, see manual for details.
1859 tag Tag settings in a headline (link to tag search).
1860 date Time stamps (link to calendar).
1861 footnote Footnote labels.
1863 If you set this variable during an Emacs session, use `org-mode-restart'
1864 in the Org buffer so that the change takes effect."
1866 :group
'org-appearance
1867 :type
'(set :greedy t
1868 (const :tag
"Double bracket links" bracket
)
1869 (const :tag
"Angular bracket links" angle
)
1870 (const :tag
"Plain text links" plain
)
1871 (const :tag
"Radio target matches" radio
)
1872 (const :tag
"Tags" tag
)
1873 (const :tag
"Timestamps" date
)
1874 (const :tag
"Footnotes" footnote
)))
1876 (defcustom org-make-link-description-function nil
1877 "Function to use for generating link descriptions from links.
1878 When nil, the link location will be used. This function must take
1879 two parameters: the first one is the link, the second one is the
1880 description generated by `org-insert-link'. The function should
1881 return the description to use."
1883 :type
'(choice (const nil
) (function)))
1885 (defgroup org-link-store nil
1886 "Options concerning storing links in Org-mode."
1887 :tag
"Org Store Link"
1890 (defcustom org-url-hexify-p t
1891 "When non-nil, hexify URL when creating a link."
1894 :group
'org-link-store
)
1896 (defcustom org-email-link-description-format
"Email %c: %.30s"
1897 "Format of the description part of a link to an email or usenet message.
1898 The following %-escapes will be replaced by corresponding information:
1900 %F full \"From\" field
1901 %f name, taken from \"From\" field, address if no name
1902 %T full \"To\" field
1903 %t first name in \"To\" field, address if no name
1904 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1905 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1910 You may use normal field width specification between the % and the letter.
1911 This is for example useful to limit the length of the subject.
1913 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1914 :group
'org-link-store
1917 (defcustom org-from-is-user-regexp
1919 (when (and user-mail-address
(not (string= user-mail-address
"")))
1920 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1921 (when (and user-full-name
(not (string= user-full-name
"")))
1922 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1923 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1924 "Regexp matched against the \"From:\" header of an email or usenet message.
1925 It should match if the message is from the user him/herself."
1926 :group
'org-link-store
1929 (defcustom org-context-in-file-links t
1930 "Non-nil means file links from `org-store-link' contain context.
1931 A search string will be added to the file name with :: as separator and
1932 used to find the context when the link is activated by the command
1933 `org-open-at-point'. When this option is t, the entire active region
1934 will be placed in the search string of the file link. If set to a
1935 positive integer, only the first n lines of context will be stored.
1937 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1938 negates this setting for the duration of the command."
1939 :group
'org-link-store
1940 :type
'(choice boolean integer
))
1942 (defcustom org-keep-stored-link-after-insertion nil
1943 "Non-nil means keep link in list for entire session.
1945 The command `org-store-link' adds a link pointing to the current
1946 location to an internal list. These links accumulate during a session.
1947 The command `org-insert-link' can be used to insert links into any
1948 Org-mode file (offering completion for all stored links). When this
1949 option is nil, every link which has been inserted once using \\[org-insert-link]
1950 will be removed from the list, to make completing the unused links
1952 :group
'org-link-store
1955 (defgroup org-link-follow nil
1956 "Options concerning following links in Org-mode."
1957 :tag
"Org Follow Link"
1960 (defcustom org-link-translation-function nil
1961 "Function to translate links with different syntax to Org syntax.
1962 This can be used to translate links created for example by the Planner
1963 or emacs-wiki packages to Org syntax.
1964 The function must accept two parameters, a TYPE containing the link
1965 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1966 which is everything after the link protocol. It should return a cons
1967 with possibly modified values of type and path.
1968 Org contains a function for this, so if you set this variable to
1969 `org-translate-link-from-planner', you should be able follow many
1970 links created by planner."
1971 :group
'org-link-follow
1972 :type
'(choice (const nil
) (function)))
1974 (defcustom org-follow-link-hook nil
1975 "Hook that is run after a link has been followed."
1976 :group
'org-link-follow
1979 (defcustom org-tab-follows-link nil
1980 "Non-nil means on links TAB will follow the link.
1981 Needs to be set before org.el is loaded.
1982 This really should not be used, it does not make sense, and the
1983 implementation is bad."
1984 :group
'org-link-follow
1987 (defcustom org-return-follows-link nil
1988 "Non-nil means on links RET will follow the link.
1989 In tables, the special behavior of RET has precedence."
1990 :group
'org-link-follow
1993 (defcustom org-mouse-1-follows-link
1994 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1995 "Non-nil means mouse-1 on a link will follow the link.
1996 A longer mouse click will still set point. Does not work on XEmacs.
1997 Needs to be set before org.el is loaded."
1998 :group
'org-link-follow
2000 :package-version
'(Org .
"8.3")
2002 (const :tag
"A double click follows the link" double
)
2003 (const :tag
"Unconditionally follow the link with mouse-1" t
)
2004 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
2006 (defcustom org-mark-ring-length
4
2007 "Number of different positions to be recorded in the ring.
2008 Changing this requires a restart of Emacs to work correctly."
2009 :group
'org-link-follow
2012 (defcustom org-link-search-must-match-exact-headline
'query-to-create
2013 "Non-nil means internal links in Org files must exactly match a headline.
2014 When nil, the link search tries to match a phrase with all words
2015 in the search text."
2016 :group
'org-link-follow
2019 (const :tag
"Use fuzzy text search" nil
)
2020 (const :tag
"Match only exact headline" t
)
2021 (const :tag
"Match exact headline or query to create it"
2024 (defcustom org-link-frame-setup
2025 '((vm . vm-visit-folder-other-frame
)
2026 (vm-imap . vm-visit-imap-folder-other-frame
)
2027 (gnus . org-gnus-no-new-news
)
2028 (file . find-file-other-window
)
2029 (wl . wl-other-frame
))
2030 "Setup the frame configuration for following links.
2031 When following a link with Emacs, it may often be useful to display
2032 this link in another window or frame. This variable can be used to
2033 set this up for the different types of links.
2036 `vm-visit-folder-other-window'
2037 `vm-visit-folder-other-frame'
2038 For Gnus, use any of
2041 `org-gnus-no-new-news'
2042 For FILE, use any of
2044 `find-file-other-window'
2045 `find-file-other-frame'
2046 For Wanderlust use any of
2049 For the calendar, use the variable `calendar-setup'.
2050 For BBDB, it is currently only possible to display the matches in
2052 :group
'org-link-follow
2056 (const vm-visit-folder
)
2057 (const vm-visit-folder-other-window
)
2058 (const vm-visit-folder-other-frame
)))
2059 (cons (const vm-imap
)
2061 (const vm-visit-imap-folder
)
2062 (const vm-visit-imap-folder-other-window
)
2063 (const vm-visit-imap-folder-other-frame
)))
2067 (const gnus-other-frame
)
2068 (const org-gnus-no-new-news
)))
2072 (const find-file-other-window
)
2073 (const find-file-other-frame
)))
2077 (const wl-other-frame
)))))
2079 (defcustom org-display-internal-link-with-indirect-buffer nil
2080 "Non-nil means use indirect buffer to display infile links.
2081 Activating internal links (from one location in a file to another location
2082 in the same file) normally just jumps to the location. When the link is
2083 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2085 another window. When this option is set, the other window actually displays
2086 an indirect buffer clone of the current buffer, to avoid any visibility
2087 changes to the current buffer."
2088 :group
'org-link-follow
2091 (defcustom org-open-non-existing-files nil
2092 "Non-nil means `org-open-file' will open non-existing files.
2093 When nil, an error will be generated.
2094 This variable applies only to external applications because they
2095 might choke on non-existing files. If the link is to a file that
2096 will be opened in Emacs, the variable is ignored."
2097 :group
'org-link-follow
2100 (defcustom org-open-directory-means-index-dot-org nil
2101 "Non-nil means a link to a directory really means to index.org.
2102 When nil, following a directory link will run dired or open a finder/explorer
2103 window on that directory."
2104 :group
'org-link-follow
2107 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2108 "Non-nil means ask for confirmation before executing shell links.
2109 Shell links can be dangerous: just think about a link
2111 [[shell:rm -rf ~/*][Google Search]]
2113 This link would show up in your Org-mode document as \"Google Search\",
2114 but really it would remove your entire home directory.
2115 Therefore we advise against setting this variable to nil.
2116 Just change it to `y-or-n-p' if you want to confirm with a
2117 single keystroke rather than having to type \"yes\"."
2118 :group
'org-link-follow
2120 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2121 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2122 (const :tag
"no confirmation (dangerous)" nil
)))
2123 (put 'org-confirm-shell-link-function
2124 'safe-local-variable
2125 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2127 (defcustom org-confirm-shell-link-not-regexp
""
2128 "A regexp to skip confirmation for shell links."
2129 :group
'org-link-follow
2133 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2134 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2135 Elisp links can be dangerous: just think about a link
2137 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2139 This link would show up in your Org-mode document as \"Google Search\",
2140 but really it would remove your entire home directory.
2141 Therefore we advise against setting this variable to nil.
2142 Just change it to `y-or-n-p' if you want to confirm with a
2143 single keystroke rather than having to type \"yes\"."
2144 :group
'org-link-follow
2146 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2147 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2148 (const :tag
"no confirmation (dangerous)" nil
)))
2149 (put 'org-confirm-shell-link-function
2150 'safe-local-variable
2151 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2153 (defcustom org-confirm-elisp-link-not-regexp
""
2154 "A regexp to skip confirmation for Elisp links."
2155 :group
'org-link-follow
2159 (defconst org-file-apps-defaults-gnu
2163 "Default file applications on a UNIX or GNU/Linux system.
2164 See `org-file-apps'.")
2166 (defconst org-file-apps-defaults-macosx
2169 (system .
"open %s")
2171 ("eps.gz" .
"gv %s")
2173 ("fig" .
"xfig %s"))
2174 "Default file applications on a MacOS X system.
2175 The system \"open\" is known as a default, but we use X11 applications
2176 for some files for which the OS does not have a good default.
2177 See `org-file-apps'.")
2179 (defconst org-file-apps-defaults-windowsnt
2183 (list (if (featurep 'xemacs
)
2184 'mswindows-shell-execute
2188 (list (if (featurep 'xemacs
)
2189 'mswindows-shell-execute
2192 "Default file applications on a Windows NT system.
2193 The system \"open\" is used for most files.
2194 See `org-file-apps'.")
2196 (defcustom org-file-apps
2197 '((auto-mode . emacs
)
2198 ("\\.mm\\'" . default
)
2199 ("\\.x?html?\\'" . default
)
2200 ("\\.pdf\\'" . default
))
2201 "External applications for opening `file:path' items in a document.
2202 Org-mode uses system defaults for different file types, but
2203 you can use this variable to set the application for a given file
2204 extension. The entries in this list are cons cells where the car identifies
2205 files and the cdr the corresponding command. Possible values for the
2207 \"string\" A string as a file identifier can be interpreted in different
2208 ways, depending on its contents:
2210 - Alphanumeric characters only:
2211 Match links with this file extension.
2212 Example: (\"pdf\" . \"evince %s\")
2213 to open PDFs with evince.
2215 - Regular expression: Match links where the
2216 filename matches the regexp. If you want to
2217 use groups here, use shy groups.
2219 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2220 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2221 to open *.html and *.xhtml with firefox.
2223 - Regular expression which contains (non-shy) groups:
2224 Match links where the whole link, including \"::\", and
2225 anything after that, matches the regexp.
2226 In a custom command string, %1, %2, etc. are replaced with
2227 the parts of the link that were matched by the groups.
2228 For backwards compatibility, if a command string is given
2229 that does not use any of the group matches, this case is
2230 handled identically to the second one (i.e. match against
2232 In a custom lisp form, you can access the group matches with
2233 (match-string n link).
2235 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2236 to open [[file:document.pdf::5]] with evince at page 5.
2238 `directory' Matches a directory
2239 `remote' Matches a remote file, accessible through tramp or efs.
2240 Remote files most likely should be visited through Emacs
2241 because external applications cannot handle such paths.
2242 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2243 so all files Emacs knows how to handle. Using this with
2244 command `emacs' will open most files in Emacs. Beware that this
2245 will also open html files inside Emacs, unless you add
2246 (\"html\" . default) to the list as well.
2247 t Default for files not matched by any of the other options.
2248 `system' The system command to open files, like `open' on Windows
2249 and Mac OS X, and mailcap under GNU/Linux. This is the command
2250 that will be selected if you call `C-c C-o' with a double
2251 \\[universal-argument] \\[universal-argument] prefix.
2253 Possible values for the command are:
2254 `emacs' The file will be visited by the current Emacs process.
2255 `default' Use the default application for this file type, which is the
2256 association for t in the list, most likely in the system-specific
2258 This can be used to overrule an unwanted setting in the
2259 system-specific variable.
2260 `system' Use the system command for opening files, like \"open\".
2261 This command is specified by the entry whose car is `system'.
2262 Most likely, the system-specific version of this variable
2263 does define this command, but you can overrule/replace it
2265 string A command to be executed by a shell; %s will be replaced
2266 by the path to the file.
2267 sexp A Lisp form which will be evaluated. The file path will
2268 be available in the Lisp variable `file'.
2269 For more examples, see the system specific constants
2270 `org-file-apps-defaults-macosx'
2271 `org-file-apps-defaults-windowsnt'
2272 `org-file-apps-defaults-gnu'."
2273 :group
'org-link-follow
2275 (cons (choice :value
""
2276 (string :tag
"Extension")
2277 (const :tag
"System command to open files" system
)
2278 (const :tag
"Default for unrecognized files" t
)
2279 (const :tag
"Remote file" remote
)
2280 (const :tag
"Links to a directory" directory
)
2281 (const :tag
"Any files that have Emacs modes"
2284 (const :tag
"Visit with Emacs" emacs
)
2285 (const :tag
"Use default" default
)
2286 (const :tag
"Use the system command" system
)
2287 (string :tag
"Command")
2288 (sexp :tag
"Lisp form")))))
2290 (defcustom org-doi-server-url
"http://dx.doi.org/"
2291 "The URL of the DOI server."
2294 :group
'org-link-follow
)
2296 (defgroup org-refile nil
2297 "Options concerning refiling entries in Org-mode."
2301 (defcustom org-directory
"~/org"
2302 "Directory with org files.
2303 This is just a default location to look for Org files. There is no need
2304 at all to put your files into this directory. It is only used in the
2305 following situations:
2307 1. When a capture template specifies a target file that is not an
2308 absolute path. The path will then be interpreted relative to
2310 2. When a capture note is filed away in an interactive way (when exiting the
2311 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2312 with `org-directory' as the default path."
2317 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2318 "Default target for storing notes.
2319 Used as a fall back file for org-capture.el, for templates that
2320 do not specify a target file."
2324 (const :tag
"Default from remember-data-file" nil
)
2327 (defcustom org-goto-interface
'outline
2328 "The default interface to be used for `org-goto'.
2330 outline The interface shows an outline of the relevant file
2331 and the correct heading is found by moving through
2332 the outline or by searching with incremental search.
2333 outline-path-completion Headlines in the current buffer are offered via
2334 completion. This is the interface also used by
2335 the refile command."
2338 (const :tag
"Outline" outline
)
2339 (const :tag
"Outline-path-completion" outline-path-completion
)))
2341 (defcustom org-goto-max-level
5
2342 "Maximum target level when running `org-goto' with refile interface."
2346 (defcustom org-reverse-note-order nil
2347 "Non-nil means store new notes at the beginning of a file or entry.
2348 When nil, new notes will be filed to the end of a file or entry.
2349 This can also be a list with cons cells of regular expressions that
2350 are matched against file names, and values."
2354 (const :tag
"Reverse always" t
)
2355 (const :tag
"Reverse never" nil
)
2356 (repeat :tag
"By file name regexp"
2357 (cons regexp boolean
))))
2359 (defcustom org-log-refile nil
2360 "Information to record when a task is refiled.
2362 Possible values are:
2364 nil Don't add anything
2365 time Add a time stamp to the task
2366 note Prompt for a note and add it with template `org-log-note-headings'
2368 This option can also be set with on a per-file-basis with
2370 #+STARTUP: nologrefile
2371 #+STARTUP: logrefile
2372 #+STARTUP: lognoterefile
2374 You can have local logging settings for a subtree by setting the LOGGING
2375 property to one or more of these keywords.
2377 When bulk-refiling from the agenda, the value `note' is forbidden and
2378 will temporarily be changed to `time'."
2380 :group
'org-progress
2383 (const :tag
"No logging" nil
)
2384 (const :tag
"Record timestamp" time
)
2385 (const :tag
"Record timestamp with note." note
)))
2387 (defcustom org-refile-targets nil
2388 "Targets for refiling entries with \\[org-refile].
2389 This is a list of cons cells. Each cell contains:
2390 - a specification of the files to be considered, either a list of files,
2391 or a symbol whose function or variable value will be used to retrieve
2392 a file name or a list of file names. If you use `org-agenda-files' for
2393 that, all agenda files will be scanned for targets. Nil means consider
2394 headings in the current buffer.
2395 - A specification of how to find candidate refile targets. This may be
2397 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2398 This tag has to be present in all target headlines, inheritance will
2400 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2402 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2403 headlines that are refiling targets.
2404 - a cons cell (:level . N). Any headline of level N is considered a target.
2405 Note that, when `org-odd-levels-only' is set, level corresponds to
2406 order in hierarchy, not to the number of stars.
2407 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2408 Note that, when `org-odd-levels-only' is set, level corresponds to
2409 order in hierarchy, not to the number of stars.
2411 Each element of this list generates a set of possible targets.
2412 The union of these sets is presented (with completion) to
2413 the user by `org-refile'.
2415 You can set the variable `org-refile-target-verify-function' to a function
2416 to verify each headline found by the simple criteria above.
2418 When this variable is nil, all top-level headlines in the current buffer
2419 are used, equivalent to the value `((nil . (:level . 1))'."
2423 (choice :value org-agenda-files
2424 (const :tag
"All agenda files" org-agenda-files
)
2425 (const :tag
"Current buffer" nil
)
2426 (function) (variable) (file))
2427 (choice :tag
"Identify target headline by"
2428 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2429 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2430 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2431 (cons :tag
"Level number" (const :value
:level
) (integer))
2432 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2434 (defcustom org-refile-target-verify-function nil
2435 "Function to verify if the headline at point should be a refile target.
2436 The function will be called without arguments, with point at the
2437 beginning of the headline. It should return t and leave point
2438 where it is if the headline is a valid target for refiling.
2440 If the target should not be selected, the function must return nil.
2441 In addition to this, it may move point to a place from where the search
2442 should be continued. For example, the function may decide that the entire
2443 subtree of the current entry should be excluded and move point to the end
2450 (defcustom org-refile-use-cache nil
2451 "Non-nil means cache refile targets to speed up the process.
2452 The cache for a particular file will be updated automatically when
2453 the buffer has been killed, or when any of the marker used for flagging
2454 refile targets no longer points at a live buffer.
2455 If you have added new entries to a buffer that might themselves be targets,
2456 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2457 find that easier, `C-u C-u C-u C-c C-w'."
2462 (defcustom org-refile-use-outline-path nil
2463 "Non-nil means provide refile targets as paths.
2464 So a level 3 headline will be available as level1/level2/level3.
2466 When the value is `file', also include the file name (without directory)
2467 into the path. In this case, you can also stop the completion after
2468 the file name, to get entries inserted as top level in the file.
2470 When `full-file-path', include the full file path."
2473 (const :tag
"Not" nil
)
2474 (const :tag
"Yes" t
)
2475 (const :tag
"Start with file name" file
)
2476 (const :tag
"Start with full file path" full-file-path
)))
2478 (defcustom org-outline-path-complete-in-steps t
2479 "Non-nil means complete the outline path in hierarchical steps.
2480 When Org-mode uses the refile interface to select an outline path
2481 \(see variable `org-refile-use-outline-path'), the completion of
2482 the path can be done is a single go, or if can be done in steps down
2483 the headline hierarchy. Going in steps is probably the best if you
2484 do not use a special completion package like `ido' or `icicles'.
2485 However, when using these packages, going in one step can be very
2486 fast, while still showing the whole path to the entry."
2490 (defcustom org-refile-allow-creating-parent-nodes nil
2491 "Non-nil means allow to create new nodes as refile targets.
2492 New nodes are then created by adding \"/new node name\" to the completion
2493 of an existing node. When the value of this variable is `confirm',
2494 new node creation must be confirmed by the user (recommended).
2495 When nil, the completion must match an existing entry.
2497 Note that, if the new heading is not seen by the criteria
2498 listed in `org-refile-targets', multiple instances of the same
2499 heading would be created by trying again to file under the new
2503 (const :tag
"Never" nil
)
2504 (const :tag
"Always" t
)
2505 (const :tag
"Prompt for confirmation" confirm
)))
2507 (defcustom org-refile-active-region-within-subtree nil
2508 "Non-nil means also refile active region within a subtree.
2510 By default `org-refile' doesn't allow refiling regions if they
2511 don't contain a set of subtrees, but it might be convenient to
2512 do so sometimes: in that case, the first line of the region is
2513 converted to a headline before refiling."
2518 (defgroup org-todo nil
2519 "Options concerning TODO items in Org-mode."
2523 (defgroup org-progress nil
2524 "Options concerning Progress logging in Org-mode."
2528 (defvar org-todo-interpretation-widgets
2529 '((:tag
"Sequence (cycling hits every state)" sequence
)
2530 (:tag
"Type (cycling directly to DONE)" type
))
2531 "The available interpretation symbols for customizing `org-todo-keywords'.
2532 Interested libraries should add to this list.")
2534 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2535 "List of TODO entry keyword sequences and their interpretation.
2536 \\<org-mode-map>This is a list of sequences.
2538 Each sequence starts with a symbol, either `sequence' or `type',
2539 indicating if the keywords should be interpreted as a sequence of
2540 action steps, or as different types of TODO items. The first
2541 keywords are states requiring action - these states will select a headline
2542 for inclusion into the global TODO list Org-mode produces. If one of
2543 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2544 signify that no further action is necessary. If \"|\" is not found,
2545 the last keyword is treated as the only DONE state of the sequence.
2547 The command \\[org-todo] cycles an entry through these states, and one
2548 additional state where no keyword is present. For details about this
2549 cycling, see the manual.
2551 TODO keywords and interpretation can also be set on a per-file basis with
2552 the special #+SEQ_TODO and #+TYP_TODO lines.
2554 Each keyword can optionally specify a character for fast state selection
2555 \(in combination with the variable `org-use-fast-todo-selection')
2556 and specifiers for state change logging, using the same syntax that
2557 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2558 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2559 indicates to record a time stamp each time this state is selected.
2561 Each keyword may also specify if a timestamp or a note should be
2562 recorded when entering or leaving the state, by adding additional
2563 characters in the parenthesis after the keyword. This looks like this:
2564 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2565 record only the time of the state change. With X and Y being either
2566 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2567 Y when leaving the state if and only if the *target* state does not
2568 define X. You may omit any of the fast-selection key or X or /Y,
2569 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2571 For backward compatibility, this variable may also be just a list
2572 of keywords. In this case the interpretation (sequence or type) will be
2573 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2575 :group
'org-keywords
2577 (repeat :tag
"Old syntax, just keywords"
2578 (string :tag
"Keyword"))
2579 (repeat :tag
"New syntax"
2582 :tag
"Interpretation"
2583 ;;Quick and dirty way to see
2584 ;;`org-todo-interpretations'. This takes the
2585 ;;place of item arguments
2593 org-todo-interpretation-widgets
))
2596 (string :tag
"Keyword"))))))
2598 (defvar org-todo-keywords-1 nil
2599 "All TODO and DONE keywords active in a buffer.")
2600 (make-variable-buffer-local 'org-todo-keywords-1
)
2601 (defvar org-todo-keywords-for-agenda nil
)
2602 (defvar org-done-keywords-for-agenda nil
)
2603 (defvar org-todo-keyword-alist-for-agenda nil
)
2604 (defvar org-tag-alist-for-agenda nil
2605 "Alist of all tags from all agenda files.")
2606 (defvar org-tag-groups-alist-for-agenda nil
2607 "Alist of all groups tags from all current agenda files.")
2608 (defvar org-tag-groups-alist nil
)
2609 (make-variable-buffer-local 'org-tag-groups-alist
)
2610 (defvar org-agenda-contributing-files nil
)
2611 (defvar org-not-done-keywords nil
)
2612 (make-variable-buffer-local 'org-not-done-keywords
)
2613 (defvar org-done-keywords nil
)
2614 (make-variable-buffer-local 'org-done-keywords
)
2615 (defvar org-todo-heads nil
)
2616 (make-variable-buffer-local 'org-todo-heads
)
2617 (defvar org-todo-sets nil
)
2618 (make-variable-buffer-local 'org-todo-sets
)
2619 (defvar org-todo-log-states nil
)
2620 (make-variable-buffer-local 'org-todo-log-states
)
2621 (defvar org-todo-kwd-alist nil
)
2622 (make-variable-buffer-local 'org-todo-kwd-alist
)
2623 (defvar org-todo-key-alist nil
)
2624 (make-variable-buffer-local 'org-todo-key-alist
)
2625 (defvar org-todo-key-trigger nil
)
2626 (make-variable-buffer-local 'org-todo-key-trigger
)
2628 (defcustom org-todo-interpretation
'sequence
2629 "Controls how TODO keywords are interpreted.
2630 This variable is in principle obsolete and is only used for
2631 backward compatibility, if the interpretation of todo keywords is
2632 not given already in `org-todo-keywords'. See that variable for
2635 :group
'org-keywords
2636 :type
'(choice (const sequence
)
2639 (defcustom org-use-fast-todo-selection t
2640 "Non-nil means use the fast todo selection scheme with C-c C-t.
2641 This variable describes if and under what circumstances the cycling
2642 mechanism for TODO keywords will be replaced by a single-key, direct
2645 When nil, fast selection is never used.
2647 When the symbol `prefix', it will be used when `org-todo' is called
2648 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2649 `C-u t' in an agenda buffer.
2651 When t, fast selection is used by default. In this case, the prefix
2652 argument forces cycling instead.
2654 In all cases, the special interface is only used if access keys have
2655 actually been assigned by the user, i.e. if keywords in the configuration
2656 are followed by a letter in parenthesis, like TODO(t)."
2659 (const :tag
"Never" nil
)
2660 (const :tag
"By default" t
)
2661 (const :tag
"Only with C-u C-c C-t" prefix
)))
2663 (defcustom org-provide-todo-statistics t
2664 "Non-nil means update todo statistics after insert and toggle.
2665 ALL-HEADLINES means update todo statistics by including headlines
2666 with no TODO keyword as well, counting them as not done.
2667 A list of TODO keywords means the same, but skip keywords that are
2669 When set to a list of two lists, the first list contains keywords
2670 to consider as TODO keywords, the second list contains keywords
2671 to consider as DONE keywords.
2673 When this is set, todo statistics is updated in the parent of the
2674 current entry each time a todo state is changed."
2677 (const :tag
"Yes, only for TODO entries" t
)
2678 (const :tag
"Yes, including all entries" all-headlines
)
2679 (repeat :tag
"Yes, for TODOs in this list"
2680 (string :tag
"TODO keyword"))
2681 (list :tag
"Yes, for TODOs and DONEs in these lists"
2682 (repeat (string :tag
"TODO keyword"))
2683 (repeat (string :tag
"DONE keyword")))
2684 (other :tag
"No TODO statistics" nil
)))
2686 (defcustom org-hierarchical-todo-statistics t
2687 "Non-nil means TODO statistics covers just direct children.
2688 When nil, all entries in the subtree are considered.
2689 This has only an effect if `org-provide-todo-statistics' is set.
2690 To set this to nil for only a single subtree, use a COOKIE_DATA
2691 property and include the word \"recursive\" into the value."
2695 (defcustom org-after-todo-state-change-hook nil
2696 "Hook which is run after the state of a TODO item was changed.
2697 The new state (a string with a TODO keyword, or nil) is available in the
2698 Lisp variable `org-state'."
2702 (defvar org-blocker-hook nil
2703 "Hook for functions that are allowed to block a state change.
2705 Functions in this hook should not modify the buffer.
2706 Each function gets as its single argument a property list,
2707 see `org-trigger-hook' for more information about this list.
2709 If any of the functions in this hook returns nil, the state change
2712 (defvar org-trigger-hook nil
2713 "Hook for functions that are triggered by a state change.
2715 Each function gets as its single argument a property list with at
2716 least the following elements:
2718 (:type type-of-change :position pos-at-entry-start
2719 :from old-state :to new-state)
2721 Depending on the type, more properties may be present.
2723 This mechanism is currently implemented for:
2727 :type todo-state-change
2728 :from previous state (keyword as a string), or nil, or a symbol
2729 'todo' or 'done', to indicate the general type of state.
2730 :to new state, like in :from")
2732 (defcustom org-enforce-todo-dependencies nil
2733 "Non-nil means undone TODO entries will block switching the parent to DONE.
2734 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2735 be blocked if any prior sibling is not yet done.
2736 Finally, if the parent is blocked because of ordered siblings of its own,
2737 the child will also be blocked."
2738 :set
(lambda (var val
)
2741 (add-hook 'org-blocker-hook
2742 'org-block-todo-from-children-or-siblings-or-parent
)
2743 (remove-hook 'org-blocker-hook
2744 'org-block-todo-from-children-or-siblings-or-parent
)))
2748 (defcustom org-enforce-todo-checkbox-dependencies nil
2749 "Non-nil means unchecked boxes will block switching the parent to DONE.
2750 When this is nil, checkboxes have no influence on switching TODO states.
2751 When non-nil, you first need to check off all check boxes before the TODO
2752 entry can be switched to DONE.
2753 This variable needs to be set before org.el is loaded, and you need to
2754 restart Emacs after a change to make the change effective. The only way
2755 to change is while Emacs is running is through the customize interface."
2756 :set
(lambda (var val
)
2759 (add-hook 'org-blocker-hook
2760 'org-block-todo-from-checkboxes
)
2761 (remove-hook 'org-blocker-hook
2762 'org-block-todo-from-checkboxes
)))
2766 (defcustom org-treat-insert-todo-heading-as-state-change nil
2767 "Non-nil means inserting a TODO heading is treated as state change.
2768 So when the command \\[org-insert-todo-heading] is used, state change
2769 logging will apply if appropriate. When nil, the new TODO item will
2770 be inserted directly, and no logging will take place."
2774 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2775 "Non-nil means switching TODO states with S-cursor counts as state change.
2776 This is the default behavior. However, setting this to nil allows a
2777 convenient way to select a TODO state and bypass any logging associated
2782 (defcustom org-todo-state-tags-triggers nil
2783 "Tag changes that should be triggered by TODO state changes.
2784 This is a list. Each entry is
2786 (state-change (tag . flag) .......)
2788 State-change can be a string with a state, and empty string to indicate the
2789 state that has no TODO keyword, or it can be one of the symbols `todo'
2790 or `done', meaning any not-done or done state, respectively."
2794 (cons (choice :tag
"When changing to"
2795 (const :tag
"Not-done state" todo
)
2796 (const :tag
"Done state" done
)
2797 (string :tag
"State"))
2799 (cons :tag
"Tag action"
2801 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2803 (defcustom org-log-done nil
2804 "Information to record when a task moves to the DONE state.
2806 Possible values are:
2808 nil Don't add anything, just change the keyword
2809 time Add a time stamp to the task
2810 note Prompt for a note and add it with template `org-log-note-headings'
2812 This option can also be set with on a per-file-basis with
2814 #+STARTUP: nologdone
2816 #+STARTUP: lognotedone
2818 You can have local logging settings for a subtree by setting the LOGGING
2819 property to one or more of these keywords."
2821 :group
'org-progress
2823 (const :tag
"No logging" nil
)
2824 (const :tag
"Record CLOSED timestamp" time
)
2825 (const :tag
"Record CLOSED timestamp with note." note
)))
2827 ;; Normalize old uses of org-log-done.
2829 ((eq org-log-done t
) (setq org-log-done
'time
))
2830 ((and (listp org-log-done
) (memq 'done org-log-done
))
2831 (setq org-log-done
'note
)))
2833 (defcustom org-log-reschedule nil
2834 "Information to record when the scheduling date of a tasks is modified.
2836 Possible values are:
2838 nil Don't add anything, just change the date
2839 time Add a time stamp to the task
2840 note Prompt for a note and add it with template `org-log-note-headings'
2842 This option can also be set with on a per-file-basis with
2844 #+STARTUP: nologreschedule
2845 #+STARTUP: logreschedule
2846 #+STARTUP: lognotereschedule"
2848 :group
'org-progress
2850 (const :tag
"No logging" nil
)
2851 (const :tag
"Record timestamp" time
)
2852 (const :tag
"Record timestamp with note." note
)))
2854 (defcustom org-log-redeadline nil
2855 "Information to record when the deadline date of a tasks is modified.
2857 Possible values are:
2859 nil Don't add anything, just change the date
2860 time Add a time stamp to the task
2861 note Prompt for a note and add it with template `org-log-note-headings'
2863 This option can also be set with on a per-file-basis with
2865 #+STARTUP: nologredeadline
2866 #+STARTUP: logredeadline
2867 #+STARTUP: lognoteredeadline
2869 You can have local logging settings for a subtree by setting the LOGGING
2870 property to one or more of these keywords."
2872 :group
'org-progress
2874 (const :tag
"No logging" nil
)
2875 (const :tag
"Record timestamp" time
)
2876 (const :tag
"Record timestamp with note." note
)))
2878 (defcustom org-log-note-clock-out nil
2879 "Non-nil means record a note when clocking out of an item.
2880 This can also be configured on a per-file basis by adding one of
2881 the following lines anywhere in the buffer:
2883 #+STARTUP: lognoteclock-out
2884 #+STARTUP: nolognoteclock-out"
2886 :group
'org-progress
2889 (defcustom org-log-done-with-time t
2890 "Non-nil means the CLOSED time stamp will contain date and time.
2891 When nil, only the date will be recorded."
2892 :group
'org-progress
2895 (defcustom org-log-note-headings
2896 '((done .
"CLOSING NOTE %t")
2897 (state .
"State %-12s from %-12S %t")
2898 (note .
"Note taken on %t")
2899 (reschedule .
"Rescheduled from %S on %t")
2900 (delschedule .
"Not scheduled, was %S on %t")
2901 (redeadline .
"New deadline from %S on %t")
2902 (deldeadline .
"Removed deadline, was %S on %t")
2903 (refile .
"Refiled on %t")
2905 "Headings for notes added to entries.
2906 The value is an alist, with the car being a symbol indicating the note
2907 context, and the cdr is the heading to be used. The heading may also be the
2909 %t in the heading will be replaced by a time stamp.
2910 %T will be an active time stamp instead the default inactive one
2911 %d will be replaced by a short-format time stamp.
2912 %D will be replaced by an active short-format time stamp.
2913 %s will be replaced by the new TODO state, in double quotes.
2914 %S will be replaced by the old TODO state, in double quotes.
2915 %u will be replaced by the user name.
2916 %U will be replaced by the full user name.
2918 In fact, it is not a good idea to change the `state' entry, because
2919 agenda log mode depends on the format of these entries."
2921 :group
'org-progress
2922 :type
'(list :greedy t
2923 (cons (const :tag
"Heading when closing an item" done
) string
)
2925 "Heading when changing todo state (todo sequence only)"
2927 (cons (const :tag
"Heading when just taking a note" note
) string
)
2928 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2929 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2930 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2931 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2932 (cons (const :tag
"Heading when refiling" refile
) string
)
2933 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2935 (unless (assq 'note org-log-note-headings
)
2936 (push '(note .
"%t") org-log-note-headings
))
2938 (defcustom org-log-into-drawer nil
2939 "Non-nil means insert state change notes and time stamps into a drawer.
2940 When nil, state changes notes will be inserted after the headline and
2941 any scheduling and clock lines, but not inside a drawer.
2943 The value of this variable should be the name of the drawer to use.
2944 LOGBOOK is proposed as the default drawer for this purpose, you can
2945 also set this to a string to define the drawer of your choice.
2947 A value of t is also allowed, representing \"LOGBOOK\".
2949 A value of t or nil can also be set with on a per-file-basis with
2951 #+STARTUP: logdrawer
2952 #+STARTUP: nologdrawer
2954 If this variable is set, `org-log-state-notes-insert-after-drawers'
2957 You can set the property LOG_INTO_DRAWER to overrule this setting for
2960 Do not check directly this variable in a Lisp program. Call
2961 function `org-log-into-drawer' instead."
2963 :group
'org-progress
2965 (const :tag
"Not into a drawer" nil
)
2966 (const :tag
"LOGBOOK" t
)
2967 (string :tag
"Other")))
2969 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2971 (defun org-log-into-drawer ()
2972 "Name of the log drawer, as a string, or nil.
2973 This is the value of `org-log-into-drawer'. However, if the
2974 current entry has or inherits a LOG_INTO_DRAWER property, it will
2975 be used instead of the default value."
2976 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2977 (cond ((equal p
"nil") nil
)
2978 ((equal p
"t") "LOGBOOK")
2981 ((stringp org-log-into-drawer
) org-log-into-drawer
)
2982 (org-log-into-drawer "LOGBOOK"))))
2984 (defcustom org-log-state-notes-insert-after-drawers nil
2985 "Non-nil means insert state change notes after any drawers in entry.
2986 Only the drawers that *immediately* follow the headline and the
2987 deadline/scheduled line are skipped.
2988 When nil, insert notes right after the heading and perhaps the line
2989 with deadline/scheduling if present.
2991 This variable will have no effect if `org-log-into-drawer' is
2994 :group
'org-progress
2997 (defcustom org-log-states-order-reversed t
2998 "Non-nil means the latest state note will be directly after heading.
2999 When nil, the state change notes will be ordered according to time.
3001 This option can also be set with on a per-file-basis with
3003 #+STARTUP: logstatesreversed
3004 #+STARTUP: nologstatesreversed"
3006 :group
'org-progress
3009 (defcustom org-todo-repeat-to-state nil
3010 "The TODO state to which a repeater should return the repeating task.
3011 By default this is the first task in a TODO sequence, or the previous state
3012 in a TODO_TYP set. But you can specify another task here.
3013 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3016 :type
'(choice (const :tag
"Head of sequence" nil
)
3017 (string :tag
"Specific state")))
3019 (defcustom org-log-repeat
'time
3020 "Non-nil means record moving through the DONE state when triggering repeat.
3021 An auto-repeating task is immediately switched back to TODO when
3022 marked DONE. If you are not logging state changes (by adding \"@\"
3023 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3024 record a closing note, there will be no record of the task moving
3025 through DONE. This variable forces taking a note anyway.
3027 nil Don't force a record
3028 time Record a time stamp
3029 note Prompt for a note and add it with template `org-log-note-headings'
3031 This option can also be set with on a per-file-basis with
3033 #+STARTUP: nologrepeat
3034 #+STARTUP: logrepeat
3035 #+STARTUP: lognoterepeat
3037 You can have local logging settings for a subtree by setting the LOGGING
3038 property to one or more of these keywords."
3040 :group
'org-progress
3042 (const :tag
"Don't force a record" nil
)
3043 (const :tag
"Force recording the DONE state" time
)
3044 (const :tag
"Force recording a note with the DONE state" note
)))
3047 (defgroup org-priorities nil
3048 "Priorities in Org-mode."
3049 :tag
"Org Priorities"
3052 (defcustom org-enable-priority-commands t
3053 "Non-nil means priority commands are active.
3054 When nil, these commands will be disabled, so that you never accidentally
3056 :group
'org-priorities
3059 (defcustom org-highest-priority ?A
3060 "The highest priority of TODO items. A character like ?A, ?B etc.
3061 Must have a smaller ASCII number than `org-lowest-priority'."
3062 :group
'org-priorities
3065 (defcustom org-lowest-priority ?C
3066 "The lowest priority of TODO items. A character like ?A, ?B etc.
3067 Must have a larger ASCII number than `org-highest-priority'."
3068 :group
'org-priorities
3071 (defcustom org-default-priority ?B
3072 "The default priority of TODO items.
3073 This is the priority an item gets if no explicit priority is given.
3074 When starting to cycle on an empty priority the first step in the cycle
3075 depends on `org-priority-start-cycle-with-default'. The resulting first
3076 step priority must not exceed the range from `org-highest-priority' to
3077 `org-lowest-priority' which means that `org-default-priority' has to be
3078 in this range exclusive or inclusive the range boundaries. Else the
3079 first step refuses to set the default and the second will fall back
3080 to (depending on the command used) the highest or lowest priority."
3081 :group
'org-priorities
3084 (defcustom org-priority-start-cycle-with-default t
3085 "Non-nil means start with default priority when starting to cycle.
3086 When this is nil, the first step in the cycle will be (depending on the
3087 command used) one higher or lower than the default priority.
3088 See also `org-default-priority'."
3089 :group
'org-priorities
3092 (defcustom org-get-priority-function nil
3093 "Function to extract the priority from a string.
3094 The string is normally the headline. If this is nil Org computes the
3095 priority from the priority cookie like [#A] in the headline. It returns
3096 an integer, increasing by 1000 for each priority level.
3097 The user can set a different function here, which should take a string
3098 as an argument and return the numeric priority."
3099 :group
'org-priorities
3105 (defgroup org-time nil
3106 "Options concerning time stamps and deadlines in Org-mode."
3110 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3111 "Number of minutes to round time stamps to.
3112 These are two values, the first applies when first creating a time stamp.
3113 The second applies when changing it with the commands `S-up' and `S-down'.
3114 When changing the time stamp, this means that it will change in steps
3115 of N minutes, as given by the second value.
3117 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3118 numbers should be factors of 60, so for example 5, 10, 15.
3120 When this is larger than 1, you can still force an exact time stamp by using
3121 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3122 and by using a prefix arg to `S-up/down' to specify the exact number
3123 of minutes to shift."
3125 :get
(lambda (var) ; Make sure both elements are there
3126 (if (integerp (default-value var
))
3127 (list (default-value var
) 5)
3128 (default-value var
)))
3130 (integer :tag
"when inserting times")
3131 (integer :tag
"when modifying times")))
3133 ;; Normalize old customizations of this variable.
3134 (when (integerp org-time-stamp-rounding-minutes
)
3135 (setq org-time-stamp-rounding-minutes
3136 (list org-time-stamp-rounding-minutes
3137 org-time-stamp-rounding-minutes
)))
3139 (defcustom org-display-custom-times nil
3140 "Non-nil means overlay custom formats over all time stamps.
3141 The formats are defined through the variable `org-time-stamp-custom-formats'.
3142 To turn this on on a per-file basis, insert anywhere in the file:
3143 #+STARTUP: customtime"
3147 (make-variable-buffer-local 'org-display-custom-times
)
3149 (defcustom org-time-stamp-custom-formats
3150 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3151 "Custom formats for time stamps. See `format-time-string' for the syntax.
3152 These are overlaid over the default ISO format if the variable
3153 `org-display-custom-times' is set. Time like %H:%M should be at the
3154 end of the second format. The custom formats are also honored by export
3155 commands, if custom time display is turned on at the time of export."
3159 (defun org-time-stamp-format (&optional long inactive
)
3160 "Get the right format for a time string."
3161 (let ((f (if long
(cdr org-time-stamp-formats
)
3162 (car org-time-stamp-formats
))))
3164 (concat "[" (substring f
1 -
1) "]")
3167 (defcustom org-time-clocksum-format
3168 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3169 "The format string used when creating CLOCKSUM lines.
3170 This is also used when Org mode generates a time duration.
3172 The value can be a single format string containing two
3173 %-sequences, which will be filled with the number of hours and
3174 minutes in that order.
3176 Alternatively, the value can be a plist associating any of the
3177 keys :years, :months, :weeks, :days, :hours or :minutes with
3178 format strings. The time duration is formatted using only the
3179 time components that are needed and concatenating the results.
3180 If a time unit in absent, it falls back to the next smallest
3183 The keys :require-years, :require-months, :require-days,
3184 :require-weeks, :require-hours, :require-minutes are also
3185 meaningful. A non-nil value for these keys indicates that the
3186 corresponding time component should always be included, even if
3192 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3195 means durations longer than a day will be expressed in days,
3196 hours and minutes, and durations less than a day will always be
3197 expressed in hours and minutes (even for durations less than an
3202 \(:days \"%dd\" :minutes \"%dm\")
3204 means durations longer than a day will be expressed in days and
3205 minutes, and durations less than a day will be expressed entirely
3206 in minutes (even for durations longer than an hour)."
3210 :package-version
'(Org .
"8.0")
3211 :type
'(choice (string :tag
"Format string")
3213 (group :inline t
(const :tag
"Years" :years
)
3214 (string :tag
"Format string"))
3216 (const :tag
"Always show years" :require-years
)
3218 (group :inline t
(const :tag
"Months" :months
)
3219 (string :tag
"Format string"))
3221 (const :tag
"Always show months" :require-months
)
3223 (group :inline t
(const :tag
"Weeks" :weeks
)
3224 (string :tag
"Format string"))
3226 (const :tag
"Always show weeks" :require-weeks
)
3228 (group :inline t
(const :tag
"Days" :days
)
3229 (string :tag
"Format string"))
3231 (const :tag
"Always show days" :require-days
)
3233 (group :inline t
(const :tag
"Hours" :hours
)
3234 (string :tag
"Format string"))
3236 (const :tag
"Always show hours" :require-hours
)
3238 (group :inline t
(const :tag
"Minutes" :minutes
)
3239 (string :tag
"Format string"))
3241 (const :tag
"Always show minutes" :require-minutes
)
3244 (defcustom org-time-clocksum-use-fractional nil
3245 "When non-nil, \\[org-clock-display] uses fractional times.
3246 See `org-time-clocksum-format' for more on time clock formats."
3252 (defcustom org-time-clocksum-use-effort-durations nil
3253 "When non-nil, \\[org-clock-display] uses effort durations.
3254 E.g. by default, one day is considered to be a 8 hours effort,
3255 so a task that has been clocked for 16 hours will be displayed
3256 as during 2 days in the clock display or in the clocktable.
3258 See `org-effort-durations' on how to set effort durations
3259 and `org-time-clocksum-format' for more on time clock formats."
3263 :package-version
'(Org .
"8.0")
3266 (defcustom org-time-clocksum-fractional-format
"%.2f"
3267 "The format string used when creating CLOCKSUM lines,
3268 or when Org mode generates a time duration, if
3269 `org-time-clocksum-use-fractional' is enabled.
3271 The value can be a single format string containing one
3272 %-sequence, which will be filled with the number of hours as
3275 Alternatively, the value can be a plist associating any of the
3276 keys :years, :months, :weeks, :days, :hours or :minutes with
3277 a format string. The time duration is formatted using the
3278 largest time unit which gives a non-zero integer part. If all
3279 specified formats have zero integer part, the smallest time unit
3282 :type
'(choice (string :tag
"Format string")
3283 (set (group :inline t
(const :tag
"Years" :years
)
3284 (string :tag
"Format string"))
3285 (group :inline t
(const :tag
"Months" :months
)
3286 (string :tag
"Format string"))
3287 (group :inline t
(const :tag
"Weeks" :weeks
)
3288 (string :tag
"Format string"))
3289 (group :inline t
(const :tag
"Days" :days
)
3290 (string :tag
"Format string"))
3291 (group :inline t
(const :tag
"Hours" :hours
)
3292 (string :tag
"Format string"))
3293 (group :inline t
(const :tag
"Minutes" :minutes
)
3294 (string :tag
"Format string")))))
3296 (defcustom org-deadline-warning-days
14
3297 "Number of days before expiration during which a deadline becomes active.
3298 This variable governs the display in sparse trees and in the agenda.
3299 When 0 or negative, it means use this number (the absolute value of it)
3300 even if a deadline has a different individual lead time specified.
3302 Custom commands can set this variable in the options section."
3304 :group
'org-agenda-daily
/weekly
3307 (defcustom org-scheduled-delay-days
0
3308 "Number of days before a scheduled item becomes active.
3309 This variable governs the display in sparse trees and in the agenda.
3310 The default value (i.e. 0) means: don't delay scheduled item.
3311 When negative, it means use this number (the absolute value of it)
3312 even if a scheduled item has a different individual delay time
3315 Custom commands can set this variable in the options section."
3317 :group
'org-agenda-daily
/weekly
3319 :package-version
'(Org .
"8.0")
3322 (defcustom org-read-date-prefer-future t
3323 "Non-nil means assume future for incomplete date input from user.
3324 This affects the following situations:
3325 1. The user gives a month but not a year.
3326 For example, if it is April and you enter \"feb 2\", this will be read
3327 as Feb 2, *next* year. \"May 5\", however, will be this year.
3328 2. The user gives a day, but no month.
3329 For example, if today is the 15th, and you enter \"3\", Org-mode will
3330 read this as the third of *next* month. However, if you enter \"17\",
3331 it will be considered as *this* month.
3333 If you set this variable to the symbol `time', then also the following
3336 3. If the user gives a time.
3337 If the time is before now, it will be interpreted as tomorrow.
3339 Currently none of this works for ISO week specifications.
3341 When this option is nil, the current day, month and year will always be
3344 See also `org-agenda-jump-prefer-future'."
3347 (const :tag
"Never" nil
)
3348 (const :tag
"Check month and day" t
)
3349 (const :tag
"Check month, day, and time" time
)))
3351 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3352 "Should the agenda jump command prefer the future for incomplete dates?
3353 The default is to do the same as configured in `org-read-date-prefer-future'.
3354 But you can also set a deviating value here.
3355 This may t or nil, or the symbol `org-read-date-prefer-future'."
3360 (const :tag
"Use org-read-date-prefer-future"
3361 org-read-date-prefer-future
)
3362 (const :tag
"Never" nil
)
3363 (const :tag
"Always" t
)))
3365 (defcustom org-read-date-force-compatible-dates t
3366 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3368 Depending on the system Emacs is running on, certain dates cannot
3369 be represented with the type used internally to represent time.
3370 Dates between 1970-1-1 and 2038-1-1 can always be represented
3371 correctly. Some systems allow for earlier dates, some for later,
3372 some for both. One way to find out it to insert any date into an
3373 Org buffer, putting the cursor on the year and hitting S-up and
3374 S-down to test the range.
3376 When this variable is set to t, the date/time prompt will not let
3377 you specify dates outside the 1970-2037 range, so it is certain that
3378 these dates will work in whatever version of Emacs you are
3379 running, and also that you can move a file from one Emacs implementation
3380 to another. WHenever Org is forcing the year for you, it will display
3383 When this variable is nil, Org will check if the date is
3384 representable in the specific Emacs implementation you are using.
3385 If not, it will force a year, usually the current year, and beep
3386 to remind you. Currently this setting is not recommended because
3387 the likelihood that you will open your Org files in an Emacs that
3388 has limited date range is not negligible.
3390 A workaround for this problem is to use diary sexp dates for time
3391 stamps outside of this range."
3396 (defcustom org-read-date-display-live t
3397 "Non-nil means display current interpretation of date prompt live.
3398 This display will be in an overlay, in the minibuffer."
3402 (defcustom org-read-date-popup-calendar t
3403 "Non-nil means pop up a calendar when prompting for a date.
3404 In the calendar, the date can be selected with mouse-1. However, the
3405 minibuffer will also be active, and you can simply enter the date as well.
3406 When nil, only the minibuffer will be available."
3409 (org-defvaralias 'org-popup-calendar-for-date-prompt
3410 'org-read-date-popup-calendar
)
3412 (make-obsolete-variable
3413 'org-read-date-minibuffer-setup-hook
3414 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3415 (defcustom org-read-date-minibuffer-setup-hook nil
3416 "Hook to be used to set up keys for the date/time interface.
3417 Add key definitions to `minibuffer-local-map', which will be a
3420 WARNING: This option is obsolete, you should use
3421 `org-read-date-minibuffer-local-map' to set up keys."
3425 (defcustom org-extend-today-until
0
3426 "The hour when your day really ends. Must be an integer.
3427 This has influence for the following applications:
3428 - When switching the agenda to \"today\". It it is still earlier than
3429 the time given here, the day recognized as TODAY is actually yesterday.
3430 - When a date is read from the user and it is still before the time given
3431 here, the current date and time will be assumed to be yesterday, 23:59.
3432 Also, timestamps inserted in capture templates follow this rule.
3434 IMPORTANT: This is a feature whose implementation is and likely will
3435 remain incomplete. Really, it is only here because past midnight seems to
3436 be the favorite working time of John Wiegley :-)"
3440 (defcustom org-use-effective-time nil
3441 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3442 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3443 \"effective time\" of any timestamps between midnight and 8am will be
3444 23:59 of the previous day."
3449 (defcustom org-use-last-clock-out-time-as-effective-time nil
3450 "When non-nil, use the last clock out time for `org-todo'.
3451 Note that this option has precedence over the combined use of
3452 `org-use-effective-time' and `org-extend-today-until'."
3455 :package-version
'(Org .
"8.0")
3458 (defcustom org-edit-timestamp-down-means-later nil
3459 "Non-nil means S-down will increase the time in a time stamp.
3460 When nil, S-up will increase."
3464 (defcustom org-calendar-follow-timestamp-change t
3465 "Non-nil means make the calendar window follow timestamp changes.
3466 When a timestamp is modified and the calendar window is visible, it will be
3467 moved to the new date."
3471 (defgroup org-tags nil
3472 "Options concerning tags in Org-mode."
3476 (defcustom org-tag-alist nil
3477 "List of tags allowed in Org-mode files.
3478 When this list is nil, Org-mode will base TAG input on what is already in the
3480 The value of this variable is an alist, the car of each entry must be a
3481 keyword as a string, the cdr may be a character that is used to select
3482 that tag through the fast-tag-selection interface.
3483 See the manual for details."
3487 (cons (string :tag
"Tag name")
3488 (character :tag
"Access char"))
3489 (list :tag
"Start radio group"
3491 (option (string :tag
"Group description")))
3492 (list :tag
"Group tags delimiter"
3494 (list :tag
"End radio group"
3496 (option (string :tag
"Group description")))
3497 (const :tag
"New line" (:newline
)))))
3499 (defcustom org-tag-persistent-alist nil
3500 "List of tags that will always appear in all Org-mode files.
3501 This is in addition to any in buffer settings or customizations
3503 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3504 The value of this variable is an alist, the car of each entry must be a
3505 keyword as a string, the cdr may be a character that is used to select
3506 that tag through the fast-tag-selection interface.
3507 See the manual for details.
3508 To disable these tags on a per-file basis, insert anywhere in the file:
3513 (cons (string :tag
"Tag name")
3514 (character :tag
"Access char"))
3515 (const :tag
"Start radio group" (:startgroup
))
3516 (const :tag
"Group tags delimiter" (:grouptags
))
3517 (const :tag
"End radio group" (:endgroup
))
3518 (const :tag
"New line" (:newline
)))))
3520 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3521 "If non-nil, always offer completion for all tags of all agenda files.
3522 Instead of customizing this variable directly, you might want to
3523 set it locally for capture buffers, because there no list of
3524 tags in that file can be created dynamically (there are none).
3526 (add-hook 'org-capture-mode-hook
3528 (set (make-local-variable
3529 'org-complete-tags-always-offer-all-agenda-tags)
3535 (defvar org-file-tags nil
3536 "List of tags that can be inherited by all entries in the file.
3537 The tags will be inherited if the variable `org-use-tag-inheritance'
3538 says they should be.
3539 This variable is populated from #+FILETAGS lines.")
3541 (defcustom org-use-fast-tag-selection
'auto
3542 "Non-nil means use fast tag selection scheme.
3543 This is a special interface to select and deselect tags with single keys.
3544 When nil, fast selection is never used.
3545 When the symbol `auto', fast selection is used if and only if selection
3546 characters for tags have been configured, either through the variable
3547 `org-tag-alist' or through a #+TAGS line in the buffer.
3548 When t, fast selection is always used and selection keys are assigned
3549 automatically if necessary."
3552 (const :tag
"Always" t
)
3553 (const :tag
"Never" nil
)
3554 (const :tag
"When selection characters are configured" auto
)))
3556 (defcustom org-fast-tag-selection-single-key nil
3557 "Non-nil means fast tag selection exits after first change.
3558 When nil, you have to press RET to exit it.
3559 During fast tag selection, you can toggle this flag with `C-c'.
3560 This variable can also have the value `expert'. In this case, the window
3561 displaying the tags menu is not even shown, until you press C-c again."
3564 (const :tag
"No" nil
)
3565 (const :tag
"Yes" t
)
3566 (const :tag
"Expert" expert
)))
3568 (defvar org-fast-tag-selection-include-todo nil
3569 "Non-nil means fast tags selection interface will also offer TODO states.
3570 This is an undocumented feature, you should not rely on it.")
3572 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3573 "The column to which tags should be indented in a headline.
3574 If this number is positive, it specifies the column. If it is negative,
3575 it means that the tags should be flushright to that column. For example,
3576 -80 works well for a normal 80 character screen.
3577 When 0, place tags directly after headline text, with only one space in
3582 (defcustom org-auto-align-tags t
3583 "Non-nil keeps tags aligned when modifying headlines.
3584 Some operations (i.e. demoting) change the length of a headline and
3585 therefore shift the tags around. With this option turned on, after
3586 each such operation the tags are again aligned to `org-tags-column'."
3590 (defcustom org-use-tag-inheritance t
3591 "Non-nil means tags in levels apply also for sublevels.
3592 When nil, only the tags directly given in a specific line apply there.
3593 This may also be a list of tags that should be inherited, or a regexp that
3594 matches tags that should be inherited. Additional control is possible
3595 with the variable `org-tags-exclude-from-inheritance' which gives an
3596 explicit list of tags to be excluded from inheritance, even if the value of
3597 `org-use-tag-inheritance' would select it for inheritance.
3599 If this option is t, a match early-on in a tree can lead to a large
3600 number of matches in the subtree when constructing the agenda or creating
3601 a sparse tree. If you only want to see the first match in a tree during
3602 a search, check out the variable `org-tags-match-list-sublevels'."
3605 (const :tag
"Not" nil
)
3606 (const :tag
"Always" t
)
3607 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3608 (regexp :tag
"Tags matched by regexp")))
3610 (defcustom org-tags-exclude-from-inheritance nil
3611 "List of tags that should never be inherited.
3612 This is a way to exclude a few tags from inheritance. For way to do
3613 the opposite, to actively allow inheritance for selected tags,
3614 see the variable `org-use-tag-inheritance'."
3616 :type
'(repeat (string :tag
"Tag")))
3618 (defun org-tag-inherit-p (tag)
3619 "Check if TAG is one that should be inherited."
3621 ((member tag org-tags-exclude-from-inheritance
) nil
)
3622 ((eq org-use-tag-inheritance t
) t
)
3623 ((not org-use-tag-inheritance
) nil
)
3624 ((stringp org-use-tag-inheritance
)
3625 (string-match org-use-tag-inheritance tag
))
3626 ((listp org-use-tag-inheritance
)
3627 (member tag org-use-tag-inheritance
))
3628 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3630 (defcustom org-tags-match-list-sublevels t
3631 "Non-nil means list also sublevels of headlines matching a search.
3632 This variable applies to tags/property searches, and also to stuck
3633 projects because this search is based on a tags match as well.
3635 When set to the symbol `indented', sublevels are indented with
3638 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3639 the sublevels of a headline matching a tag search often also match
3640 the same search. Listing all of them can create very long lists.
3641 Setting this variable to nil causes subtrees of a match to be skipped.
3643 This variable is semi-obsolete and probably should always be true. It
3644 is better to limit inheritance to certain tags using the variables
3645 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3648 (const :tag
"No, don't list them" nil
)
3649 (const :tag
"Yes, do list them" t
)
3650 (const :tag
"List them, indented with leading dots" indented
)))
3652 (defcustom org-tags-sort-function nil
3653 "When set, tags are sorted using this function as a comparator."
3656 (const :tag
"No sorting" nil
)
3657 (const :tag
"Alphabetical" string
<)
3658 (const :tag
"Reverse alphabetical" string
>)
3659 (function :tag
"Custom function" nil
)))
3661 (defvar org-tags-history nil
3662 "History of minibuffer reads for tags.")
3663 (defvar org-last-tags-completion-table nil
3664 "The last used completion table for tags.")
3665 (defvar org-after-tags-change-hook nil
3666 "Hook that is run after the tags in a line have changed.")
3668 (defgroup org-properties nil
3669 "Options concerning properties in Org-mode."
3670 :tag
"Org Properties"
3673 (defcustom org-property-format
"%-10s %s"
3674 "How property key/value pairs should be formatted by `indent-line'.
3675 When `indent-line' hits a property definition, it will format the line
3676 according to this format, mainly to make sure that the values are
3677 lined-up with respect to each other."
3678 :group
'org-properties
3681 (defcustom org-properties-postprocess-alist nil
3682 "Alist of properties and functions to adjust inserted values.
3683 Elements of this alist must be of the form
3685 ([string] [function])
3687 where [string] must be a property name and [function] must be a
3688 lambda expression: this lambda expression must take one argument,
3689 the value to adjust, and return the new value as a string.
3691 For example, this element will allow the property \"Remaining\"
3692 to be updated wrt the relation between the \"Effort\" property
3693 and the clock summary:
3695 ((\"Remaining\" (lambda(value)
3696 (let ((clocksum (org-clock-sum-current-item))
3697 (effort (org-duration-string-to-minutes
3698 (org-entry-get (point) \"Effort\"))))
3699 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3700 :group
'org-properties
3702 :type
'(alist :key-type
(string :tag
"Property")
3703 :value-type
(function :tag
"Function")))
3705 (defcustom org-use-property-inheritance nil
3706 "Non-nil means properties apply also for sublevels.
3708 This setting is chiefly used during property searches. Turning it on can
3709 cause significant overhead when doing a search, which is why it is not
3712 When nil, only the properties directly given in the current entry count.
3713 When t, every property is inherited. The value may also be a list of
3714 properties that should have inheritance, or a regular expression matching
3715 properties that should be inherited.
3717 However, note that some special properties use inheritance under special
3718 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3719 and the properties ending in \"_ALL\" when they are used as descriptor
3720 for valid values of a property.
3722 Note for programmers:
3723 When querying an entry with `org-entry-get', you can control if inheritance
3724 should be used. By default, `org-entry-get' looks only at the local
3725 properties. You can request inheritance by setting the inherit argument
3726 to t (to force inheritance) or to `selective' (to respect the setting
3728 :group
'org-properties
3730 (const :tag
"Not" nil
)
3731 (const :tag
"Always" t
)
3732 (repeat :tag
"Specific properties" (string :tag
"Property"))
3733 (regexp :tag
"Properties matched by regexp")))
3735 (defun org-property-inherit-p (property)
3736 "Check if PROPERTY is one that should be inherited."
3738 ((eq org-use-property-inheritance t
) t
)
3739 ((not org-use-property-inheritance
) nil
)
3740 ((stringp org-use-property-inheritance
)
3741 (string-match org-use-property-inheritance property
))
3742 ((listp org-use-property-inheritance
)
3743 (member property org-use-property-inheritance
))
3744 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3746 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3747 "The default column format, if no other format has been defined.
3748 This variable can be set on the per-file basis by inserting a line
3750 #+COLUMNS: %25ITEM ....."
3751 :group
'org-properties
3754 (defcustom org-columns-ellipses
".."
3755 "The ellipses to be used when a field in column view is truncated.
3756 When this is the empty string, as many characters as possible are shown,
3757 but then there will be no visual indication that the field has been truncated.
3758 When this is a string of length N, the last N characters of a truncated
3759 field are replaced by this string. If the column is narrower than the
3760 ellipses string, only part of the ellipses string will be shown."
3761 :group
'org-properties
3764 (defcustom org-columns-modify-value-for-display-function nil
3765 "Function that modifies values for display in column view.
3766 For example, it can be used to cut out a certain part from a time stamp.
3767 The function must take 2 arguments:
3769 column-title The title of the column (*not* the property name)
3770 value The value that should be modified.
3772 The function should return the value that should be displayed,
3773 or nil if the normal value should be used."
3774 :group
'org-properties
3775 :type
'(choice (const nil
) (function)))
3777 (defconst org-global-properties-fixed
3778 '(("VISIBILITY_ALL" .
"folded children content all")
3779 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3780 "List of property/value pairs that can be inherited by any entry.
3782 These are fixed values, for the preset properties. The user variable
3783 that can be used to add to this list is `org-global-properties'.
3785 The entries in this list are cons cells where the car is a property
3786 name and cdr is a string with the value. If the value represents
3787 multiple items like an \"_ALL\" property, separate the items by
3790 (defcustom org-global-properties nil
3791 "List of property/value pairs that can be inherited by any entry.
3793 This list will be combined with the constant `org-global-properties-fixed'.
3795 The entries in this list are cons cells where the car is a property
3796 name and cdr is a string with the value.
3798 You can set buffer-local values for the same purpose in the variable
3799 `org-file-properties' this by adding lines like
3801 #+PROPERTY: NAME VALUE"
3802 :group
'org-properties
3804 (cons (string :tag
"Property")
3805 (string :tag
"Value"))))
3807 (defvar org-file-properties nil
3808 "List of property/value pairs that can be inherited by any entry.
3809 Valid for the current buffer.
3810 This variable is populated from #+PROPERTY lines.")
3811 (make-variable-buffer-local 'org-file-properties
)
3813 (defgroup org-agenda nil
3814 "Options concerning agenda views in Org-mode."
3818 (defvar org-category nil
3819 "Variable used by org files to set a category for agenda display.
3820 Such files should use a file variable to set it, for example
3822 # -*- mode: org; org-category: \"ELisp\"
3824 or contain a special line
3828 If the file does not specify a category, then file's base name
3830 (make-variable-buffer-local 'org-category
)
3831 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3833 (defcustom org-agenda-files nil
3834 "The files to be used for agenda display.
3835 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3836 \\[org-remove-file]. You can also use customize to edit the list.
3838 If an entry is a directory, all files in that directory that are matched by
3839 `org-agenda-file-regexp' will be part of the file list.
3841 If the value of the variable is not a list but a single file name, then
3842 the list of agenda files is actually stored and maintained in that file, one
3843 agenda file per line. In this file paths can be given relative to
3844 `org-directory'. Tilde expansion and environment variable substitution
3848 (repeat :tag
"List of files and directories" file
)
3849 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3851 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3852 "Regular expression to match files for `org-agenda-files'.
3853 If any element in the list in that variable contains a directory instead
3854 of a normal file, all files in that directory that are matched by this
3855 regular expression will be included."
3859 (defcustom org-agenda-text-search-extra-files nil
3860 "List of extra files to be searched by text search commands.
3861 These files will be searched in addition to the agenda files by the
3862 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3863 Note that these files will only be searched for text search commands,
3864 not for the other agenda views like todo lists, tag searches or the weekly
3865 agenda. This variable is intended to list notes and possibly archive files
3866 that should also be searched by these two commands.
3867 In fact, if the first element in the list is the symbol `agenda-archives',
3868 then all archive files of all agenda files will be added to the search
3871 :type
'(set :greedy t
3872 (const :tag
"Agenda Archives" agenda-archives
)
3873 (repeat :inline t
(file))))
3875 (org-defvaralias 'org-agenda-multi-occur-extra-files
3876 'org-agenda-text-search-extra-files
)
3878 (defcustom org-agenda-skip-unavailable-files nil
3879 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3880 A nil value means to remove them, after a query, from the list."
3884 (defcustom org-calendar-to-agenda-key
[?c
]
3885 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3886 The command `org-calendar-goto-agenda' will be bound to this key. The
3887 default is the character `c' because then `c' can be used to switch back and
3888 forth between agenda and calendar."
3892 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3893 "The key to be installed in `calendar-mode-map' for adding diary entries.
3894 This option is irrelevant until `org-agenda-diary-file' has been configured
3895 to point to an Org-mode file. When that is the case, the command
3896 `org-agenda-diary-entry' will be bound to the key given here, by default
3897 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3898 if you want to continue doing this, you need to change this to a different
3903 (defcustom org-agenda-diary-file
'diary-file
3904 "File to which to add new entries with the `i' key in agenda and calendar.
3905 When this is the symbol `diary-file', the functionality in the Emacs
3906 calendar will be used to add entries to the `diary-file'. But when this
3907 points to a file, `org-agenda-diary-entry' will be used instead."
3910 (const :tag
"The standard Emacs diary file" diary-file
)
3911 (file :tag
"Special Org file diary entries")))
3913 (eval-after-load "calendar"
3915 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3916 'org-calendar-goto-agenda
)
3917 (add-hook 'calendar-mode-hook
3919 (unless (eq org-agenda-diary-file
'diary-file
)
3920 (define-key calendar-mode-map
3921 org-calendar-insert-diary-entry-key
3922 'org-agenda-diary-entry
))))))
3924 (defgroup org-latex nil
3925 "Options for embedding LaTeX code into Org-mode."
3929 (defcustom org-format-latex-options
3930 '(:foreground default
:background default
:scale
1.0
3931 :html-foreground
"Black" :html-background
"Transparent"
3932 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3933 "Options for creating images from LaTeX fragments.
3934 This is a property list with the following properties:
3935 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3936 `default' means use the foreground of the default face.
3937 `auto' means use the foreground from the text face.
3938 :background the background color, or \"Transparent\".
3939 `default' means use the background of the default face.
3940 `auto' means use the background from the text face.
3941 :scale a scaling factor for the size of the images, to get more pixels
3942 :html-foreground, :html-background, :html-scale
3943 the same numbers for HTML export.
3944 :matchers a list indicating which matchers should be used to
3945 find LaTeX fragments. Valid members of this list are:
3946 \"begin\" find environments
3947 \"$1\" find single characters surrounded by $.$
3948 \"$\" find math expressions surrounded by $...$
3949 \"$$\" find math expressions surrounded by $$....$$
3950 \"\\(\" find math expressions surrounded by \\(...\\)
3951 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3955 (defcustom org-format-latex-signal-error t
3956 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3957 When nil, just push out a message."
3962 (defcustom org-latex-to-mathml-jar-file nil
3963 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3964 Use this to specify additional executable file say a jar file.
3966 When using MathToWeb as the converter, specify the full-path to
3967 your mathtoweb.jar file."
3971 (const :tag
"None" nil
)
3972 (file :tag
"JAR file" :must-match t
)))
3974 (defcustom org-latex-to-mathml-convert-command nil
3975 "Command to convert LaTeX fragments to MathML.
3976 Replace format-specifiers in the command as noted below and use
3977 `shell-command' to convert LaTeX to MathML.
3978 %j: Executable file in fully expanded form as specified by
3979 `org-latex-to-mathml-jar-file'.
3980 %I: Input LaTeX file in fully expanded form
3981 %o: Output MathML file
3982 This command is used by `org-create-math-formula'.
3984 When using MathToWeb as the converter, set this to
3985 \"java -jar %j -unicode -force -df %o %I\"."
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
)
4076 ("" "longtable" nil
)
4080 ("normalem" "ulem" t
)
4089 "Alist of default packages to be inserted in the header.
4091 Change this only if one of the packages here causes an
4092 incompatibility with another package you are using.
4094 The packages in this list are needed by one part or another of
4095 Org mode to function properly:
4097 - inputenc, fontenc: for basic font and character selection
4098 - fixltx2e: Important patches of LaTeX itself
4099 - graphicx: for including images
4100 - longtable: For multipage tables
4101 - float, wrapfig: for figure placement
4102 - rotating: for sideways figures and tables
4103 - ulem: for underline and strike-through
4104 - amsmath: for subscript and superscript and math environments
4105 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4106 for interpreting the entities in `org-entities'. You can skip
4107 some of these packages if you don't use any of their symbols.
4108 - capt-of: for captions outside of floats
4109 - hyperref: for cross references
4111 Therefore you should not modify this variable unless you know
4112 what you are doing. The one reason to change it anyway is that
4113 you might be loading some other package that conflicts with one
4114 of the default packages. Each element is either a cell or
4117 A cell is of the format:
4119 \( \"options\" \"package\" SNIPPET-FLAG).
4121 If SNIPPET-FLAG is non-nil, the package also needs to be included
4122 when compiling LaTeX snippets into images for inclusion into
4125 A string will be inserted as-is in the header of the document."
4127 :group
'org-export-latex
4128 :set
'org-set-packages-alist
4129 :get
'org-get-packages-alist
4133 (list :tag
"options/package pair"
4134 (string :tag
"options")
4135 (string :tag
"package")
4136 (boolean :tag
"Snippet"))
4137 (string :tag
"A line of LaTeX"))))
4139 (defcustom org-latex-packages-alist nil
4140 "Alist of packages to be inserted in every LaTeX header.
4142 These will be inserted after `org-latex-default-packages-alist'.
4143 Each element is either a cell or a string.
4145 A cell is of the format:
4147 \(\"options\" \"package\" SNIPPET-FLAG)
4149 SNIPPET-FLAG, when non-nil, indicates that this package is also
4150 needed when turning LaTeX snippets into images for inclusion into
4153 A string will be inserted as-is in the header of the document.
4155 Make sure that you only list packages here which:
4157 - you want in every file;
4158 - do not conflict with the setup in `org-format-latex-header';
4159 - do not conflict with the default packages in
4160 `org-latex-default-packages-alist'."
4162 :group
'org-export-latex
4163 :set
'org-set-packages-alist
4164 :get
'org-get-packages-alist
4167 (list :tag
"options/package pair"
4168 (string :tag
"options")
4169 (string :tag
"package")
4170 (boolean :tag
"Snippet"))
4171 (string :tag
"A line of LaTeX"))))
4173 (defgroup org-appearance nil
4174 "Settings for Org-mode appearance."
4175 :tag
"Org Appearance"
4178 (defcustom org-level-color-stars-only nil
4179 "Non-nil means fontify only the stars in each headline.
4180 When nil, the entire headline is fontified.
4181 Changing it requires restart of `font-lock-mode' to become effective
4182 also in regions already fontified."
4183 :group
'org-appearance
4186 (defcustom org-hide-leading-stars nil
4187 "Non-nil means hide the first N-1 stars in a headline.
4188 This works by using the face `org-hide' for these stars. This
4189 face is white for a light background, and black for a dark
4190 background. You may have to customize the face `org-hide' to
4192 Changing it requires restart of `font-lock-mode' to become effective
4193 also in regions already fontified.
4194 You may also set this on a per-file basis by adding one of the following
4195 lines to the buffer:
4197 #+STARTUP: hidestars
4198 #+STARTUP: showstars"
4199 :group
'org-appearance
4202 (defcustom org-hidden-keywords nil
4203 "List of symbols corresponding to keywords to be hidden the org buffer.
4204 For example, a value '(title) for this list will make the document's title
4205 appear in the buffer without the initial #+TITLE: keyword."
4206 :group
'org-appearance
4208 :type
'(set (const :tag
"#+AUTHOR" author
)
4209 (const :tag
"#+DATE" date
)
4210 (const :tag
"#+EMAIL" email
)
4211 (const :tag
"#+TITLE" title
)))
4213 (defcustom org-custom-properties nil
4214 "List of properties (as strings) with a special meaning.
4215 The default use of these custom properties is to let the user
4216 hide them with `org-toggle-custom-properties-visibility'."
4217 :group
'org-properties
4218 :group
'org-appearance
4220 :type
'(repeat (string :tag
"Property Name")))
4222 (defcustom org-fontify-done-headline nil
4223 "Non-nil means change the face of a headline if it is marked DONE.
4224 Normally, only the TODO/DONE keyword indicates the state of a headline.
4225 When this is non-nil, the headline after the keyword is set to the
4226 `org-headline-done' as an additional indication."
4227 :group
'org-appearance
4230 (defcustom org-fontify-emphasized-text t
4231 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4232 Changing this variable requires a restart of Emacs to take effect."
4233 :group
'org-appearance
4236 (defcustom org-fontify-whole-heading-line nil
4237 "Non-nil means fontify the whole line for headings.
4238 This is useful when setting a background color for the
4240 :group
'org-appearance
4243 (defcustom org-highlight-latex-and-related nil
4244 "Non-nil means highlight LaTeX related syntax in the buffer.
4245 When non nil, the value should be a list containing any of the
4247 `latex' Highlight LaTeX snippets and environments.
4248 `script' Highlight subscript and superscript.
4249 `entities' Highlight entities."
4250 :group
'org-appearance
4252 :package-version
'(Org .
"8.0")
4254 (const :tag
"No highlighting" nil
)
4255 (set :greedy t
:tag
"Highlight"
4256 (const :tag
"LaTeX snippets and environments" latex
)
4257 (const :tag
"Subscript and superscript" script
)
4258 (const :tag
"Entities" entities
))))
4260 (defcustom org-hide-emphasis-markers nil
4261 "Non-nil mean font-lock should hide the emphasis marker characters."
4262 :group
'org-appearance
4265 (defcustom org-hide-macro-markers nil
4266 "Non-nil mean font-lock should hide the brackets marking macro calls."
4267 :group
'org-appearance
4270 (defcustom org-pretty-entities nil
4271 "Non-nil means show entities as UTF8 characters.
4272 When nil, the \\name form remains in the buffer."
4273 :group
'org-appearance
4277 (defcustom org-pretty-entities-include-sub-superscripts t
4278 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4279 :group
'org-appearance
4283 (defvar org-emph-re nil
4284 "Regular expression for matching emphasis.
4285 After a match, the match groups contain these elements:
4286 0 The match of the full regular expression, including the characters
4287 before and after the proper match
4288 1 The character before the proper match, or empty at beginning of line
4289 2 The proper match, including the leading and trailing markers
4290 3 The leading marker like * or /, indicating the type of highlighting
4291 4 The text between the emphasis markers, not including the markers
4292 5 The character after the match, empty at the end of a line")
4293 (defvar org-verbatim-re nil
4294 "Regular expression for matching verbatim text.")
4295 (defvar org-emphasis-regexp-components
) ; defined just below
4296 (defvar org-emphasis-alist
) ; defined just below
4297 (defun org-set-emph-re (var val
)
4298 "Set variable and compute the emphasis regular expression."
4300 (when (and (boundp 'org-emphasis-alist
)
4301 (boundp 'org-emphasis-regexp-components
)
4302 org-emphasis-alist org-emphasis-regexp-components
)
4303 (let* ((e org-emphasis-regexp-components
)
4309 (body1 (concat body
"*?"))
4310 (markers (mapconcat 'car org-emphasis-alist
""))
4311 (vmarkers (mapconcat
4312 (lambda (x) (if (eq (nth 2 x
) 'verbatim
) (car x
) ""))
4313 org-emphasis-alist
"")))
4314 ;; make sure special characters appear at the right position in the class
4315 (if (string-match "\\^" markers
)
4316 (setq markers
(concat (replace-match "" t t markers
) "^")))
4317 (if (string-match "-" markers
)
4318 (setq markers
(concat (replace-match "" t t markers
) "-")))
4319 (if (string-match "\\^" vmarkers
)
4320 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
4321 (if (string-match "-" vmarkers
)
4322 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
4324 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
4325 (int-to-string nl
) "\\}")))
4328 (concat "\\([" pre
"]\\|^\\)"
4330 "\\([" markers
"]\\)"
4338 "\\([" post
"]\\|$\\)"))
4339 (setq org-verbatim-re
4340 (concat "\\([" pre
"]\\|^\\)"
4342 "\\([" vmarkers
"]\\)"
4350 "\\([" post
"]\\|$\\)")))))
4352 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4353 ;; set this option proved cumbersome. See this message/thread:
4354 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4355 (defvar org-emphasis-regexp-components
4356 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4357 "Components used to build the regular expression for emphasis.
4358 This is a list with five entries. Terminology: In an emphasis string
4359 like \" *strong word* \", we call the initial space PREMATCH, the final
4360 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4361 and \"trong wor\" is the body. The different components in this variable
4362 specify what is allowed/forbidden in each part:
4364 pre Chars allowed as prematch. Beginning of line will be allowed too.
4365 post Chars allowed as postmatch. End of line will be allowed too.
4366 border The chars *forbidden* as border characters.
4367 body-regexp A regexp like \".\" to match a body character. Don't use
4368 non-shy groups here, and don't allow newline here.
4369 newline The maximum number of newlines allowed in an emphasis exp.
4371 You need to reload Org or to restart Emacs after customizing this.")
4373 (defcustom org-emphasis-alist
4377 ("=" org-verbatim verbatim
)
4378 ("~" org-code verbatim
)
4379 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))))
4380 "Alist of characters and faces to emphasize text.
4381 Text starting and ending with a special character will be emphasized,
4382 for example *bold*, _underlined_ and /italic/. This variable sets the
4383 marker characters and the face to be used by font-lock for highlighting
4384 in Org-mode Emacs buffers.
4386 You need to reload Org or to restart Emacs after customizing this."
4387 :group
'org-appearance
4388 :set
'org-set-emph-re
4390 :package-version
'(Org .
"8.0")
4393 (string :tag
"Marker character")
4395 (face :tag
"Font-lock-face")
4396 (plist :tag
"Face property list"))
4397 (option (const verbatim
)))))
4399 (defvar org-protecting-blocks
4400 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4401 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4402 This is needed for font-lock setup.")
4404 ;;; Miscellaneous options
4406 (defgroup org-completion nil
4407 "Completion in Org-mode."
4408 :tag
"Org Completion"
4411 (defcustom org-completion-use-ido nil
4412 "Non-nil means use ido completion wherever possible.
4413 Note that `ido-mode' must be active for this variable to be relevant.
4414 If you decide to turn this variable on, you might well want to turn off
4415 `org-outline-path-complete-in-steps'.
4416 See also `org-completion-use-iswitchb'."
4417 :group
'org-completion
4420 (defcustom org-completion-use-iswitchb nil
4421 "Non-nil means use iswitchb completion wherever possible.
4422 Note that `iswitchb-mode' must be active for this variable to be relevant.
4423 If you decide to turn this variable on, you might well want to turn off
4424 `org-outline-path-complete-in-steps'.
4425 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4426 :group
'org-completion
4429 (defcustom org-completion-fallback-command
'hippie-expand
4430 "The expansion command called by \\[pcomplete] in normal context.
4431 Normal means, no org-mode-specific context."
4432 :group
'org-completion
4435 ;;; Functions and variables from their packages
4436 ;; Declared here to avoid compiler warnings
4439 (defvar outline-mode-menu-heading
)
4440 (defvar outline-mode-menu-show
)
4441 (defvar outline-mode-menu-hide
)
4442 (defvar zmacs-regions
) ; XEmacs regions
4445 (defvar mark-active
)
4448 (declare-function calendar-iso-to-absolute
"cal-iso" (date))
4449 (declare-function calendar-forward-day
"cal-move" (arg))
4450 (declare-function calendar-goto-date
"cal-move" (date))
4451 (declare-function calendar-goto-today
"cal-move" ())
4452 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
4453 (defvar calc-embedded-close-formula
)
4454 (defvar calc-embedded-open-formula
)
4455 (declare-function cdlatex-tab
"ext:cdlatex" ())
4456 (declare-function cdlatex-compute-tables
"ext:cdlatex" ())
4457 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
4458 (defvar font-lock-unfontify-region-function
)
4459 (declare-function iswitchb-read-buffer
"iswitchb"
4460 (prompt &optional default require-match start matches-set
))
4461 (defvar iswitchb-temp-buflist
)
4462 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
4463 (defvar org-agenda-tags-todo-honor-ignore-options
)
4464 (declare-function org-agenda-skip
"org-agenda" ())
4466 org-agenda-format-item
"org-agenda"
4467 (extra txt
&optional level category tags dotime noprefix remove-re habitp
))
4468 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
4469 (declare-function org-agenda-change-all-lines
"org-agenda"
4470 (newhead hdmarker
&optional fixface just-this
))
4471 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
4472 (declare-function org-agenda-maybe-redo
"org-agenda" ())
4473 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
4475 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
4476 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4477 "org-agenda" (&optional end
))
4478 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
4479 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
4480 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
4481 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
4482 (declare-function org-indent-mode
"org-indent" (&optional arg
))
4483 (declare-function parse-time-string
"parse-time" (string))
4484 (declare-function org-attach-reveal
"org-attach" (&optional if-exists
))
4485 (declare-function orgtbl-send-table
"org-table" (&optional maybe
))
4486 (defvar remember-data-file
)
4487 (defvar texmathp-why
)
4488 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
4489 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
4490 (declare-function calc-eval
"calc" (str &optional separator
&rest args
))
4493 (defun turn-on-orgtbl ()
4494 "Unconditionally turn on `orgtbl-mode'."
4495 (require 'org-table
)
4498 (defun org-at-table-p (&optional table-type
)
4499 "Return t if the cursor is inside an org-type table.
4500 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4501 (if org-enable-table-editor
4503 (beginning-of-line 1)
4504 (looking-at (if table-type org-table-any-line-regexp
4505 org-table-line-regexp
)))
4507 (defsubst org-table-p
() (org-at-table-p))
4509 (defun org-at-table.el-p
()
4510 "Return t if and only if we are at a table.el table."
4511 (and (org-at-table-p 'any
)
4513 (goto-char (org-table-begin 'any
))
4514 (looking-at org-table1-hline-regexp
))))
4516 (defun org-table-recognize-table.el
()
4517 "If there is a table.el table nearby, recognize it and move into it."
4518 (if org-table-tab-recognizes-table.el
4519 (if (org-at-table.el-p
)
4521 (beginning-of-line 1)
4522 (if (looking-at org-table-dataline-regexp
)
4524 (if (looking-at org-table1-hline-regexp
)
4526 (beginning-of-line 2)
4527 (if (looking-at org-table-any-border-regexp
)
4528 (beginning-of-line -
1)))))
4529 (if (re-search-forward "|" (org-table-end t
) t
)
4532 (if (table--at-cell-p (point))
4534 (message "recognizing table.el table...")
4535 (table-recognize-table)
4536 (message "recognizing table.el table...done")))
4537 (error "This should not happen"))
4542 (defun org-at-table-hline-p ()
4543 "Return t if the cursor is inside a hline in a table."
4544 (if org-enable-table-editor
4546 (beginning-of-line 1)
4547 (looking-at org-table-hline-regexp
))
4550 (defun org-table-map-tables (function &optional quietly
)
4551 "Apply FUNCTION to the start of all tables in the buffer."
4555 (goto-char (point-min))
4556 (while (re-search-forward org-table-any-line-regexp nil t
)
4558 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4559 (beginning-of-line 1)
4560 (when (and (looking-at org-table-line-regexp
)
4561 ;; Exclude tables in src/example/verbatim/clocktable blocks
4562 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4563 (save-excursion (funcall function
))
4564 (or (looking-at org-table-line-regexp
)
4566 (re-search-forward org-table-any-border-regexp nil
1))))
4567 (unless quietly
(message "Mapping tables: done")))
4569 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock" (beg end
))
4570 (declare-function org-clock-update-mode-line
"org-clock" ())
4571 (declare-function org-resolve-clocks
"org-clock"
4572 (&optional also-non-dangling-p prompt last-valid
))
4574 (defun org-at-TBLFM-p (&optional pos
)
4575 "Return t when point (or POS) is in #+TBLFM line."
4578 (goto-char (or pos
(point)))
4579 (beginning-of-line 1)
4580 (looking-at org-TBLFM-regexp
)))
4582 (defvar org-clock-start-time
)
4583 (defvar org-clock-marker
(make-marker)
4584 "Marker recording the last clock-in.")
4585 (defvar org-clock-hd-marker
(make-marker)
4586 "Marker recording the last clock-in, but the headline position.")
4587 (defvar org-clock-heading
""
4588 "The heading of the current clock entry.")
4589 (defun org-clock-is-active ()
4590 "Return the buffer where the clock is currently running.
4591 Return nil if no clock is running."
4592 (marker-buffer org-clock-marker
))
4594 (defun org-check-running-clock ()
4595 "Check if the current buffer contains the running clock.
4596 If yes, offer to stop it and to save the buffer with the changes."
4597 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
4598 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4601 (when (y-or-n-p "Save changed buffer?")
4604 (defun org-clocktable-try-shift (dir n
)
4605 "Check if this line starts a clock table, if yes, shift the time block."
4606 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4607 (org-clocktable-shift dir n
)))
4610 (defun org-clock-persistence-insinuate ()
4611 "Set up hooks for clock persistence."
4612 (require 'org-clock
)
4613 (add-hook 'org-mode-hook
'org-clock-load
)
4614 (add-hook 'kill-emacs-hook
'org-clock-save
))
4616 (defgroup org-archive nil
4617 "Options concerning archiving in Org-mode."
4619 :group
'org-structure
)
4621 (defcustom org-archive-location
"%s_archive::"
4622 "The location where subtrees should be archived.
4624 The value of this variable is a string, consisting of two parts,
4625 separated by a double-colon. The first part is a filename and
4626 the second part is a headline.
4628 When the filename is omitted, archiving happens in the same file.
4629 %s in the filename will be replaced by the current file
4630 name (without the directory part). Archiving to a different file
4631 is useful to keep archived entries from contributing to the
4634 The archived entries will be filed as subtrees of the specified
4635 headline. When the headline is omitted, the subtrees are simply
4636 filed away at the end of the file, as top-level entries. Also in
4637 the heading you can use %s to represent the file name, this can be
4638 useful when using the same archive for a number of different files.
4640 Here are a few examples:
4642 If the current file is Projects.org, archive in file
4643 Projects.org_archive, as top-level trees. This is the default.
4645 \"::* Archived Tasks\"
4646 Archive in the current file, under the top-level headline
4647 \"* Archived Tasks\".
4649 \"~/org/archive.org::\"
4650 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4652 \"~/org/archive.org::* From %s\"
4653 Archive in file ~/org/archive.org (absolute path), under headlines
4654 \"From FILENAME\" where file name is the current file name.
4656 \"~/org/datetree.org::datetree/* Finished Tasks\"
4657 The \"datetree/\" string is special, signifying to archive
4658 items to the datetree. Items are placed in either the CLOSED
4659 date of the item, or the current date if there is no CLOSED date.
4660 The heading will be a subentry to the current date. There doesn't
4661 need to be a heading, but there always needs to be a slash after
4662 datetree. For example, to store archived items directly in the
4663 datetree, use \"~/org/datetree.org::datetree/\".
4665 \"basement::** Finished Tasks\"
4666 Archive in file ./basement (relative path), as level 3 trees
4667 below the level 2 heading \"** Finished Tasks\".
4669 You may set this option on a per-file basis by adding to the buffer a
4672 #+ARCHIVE: basement::** Finished Tasks
4674 You may also define it locally for a subtree by setting an ARCHIVE property
4675 in the entry. If such a property is found in an entry, or anywhere up
4676 the hierarchy, it will be used."
4680 (defcustom org-agenda-skip-archived-trees t
4681 "Non-nil means the agenda will skip any items located in archived trees.
4682 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4683 variable is no longer recommended, you should leave it at the value t.
4684 Instead, use the key `v' to cycle the archives-mode in the agenda."
4686 :group
'org-agenda-skip
4689 (defcustom org-columns-skip-archived-trees t
4690 "Non-nil means ignore archived trees when creating column view."
4692 :group
'org-properties
4695 (defcustom org-cycle-open-archived-trees nil
4696 "Non-nil means `org-cycle' will open archived trees.
4697 An archived tree is a tree marked with the tag ARCHIVE.
4698 When nil, archived trees will stay folded. You can still open them with
4699 normal outline commands like `show-all', but not with the cycling commands."
4704 (defcustom org-sparse-tree-open-archived-trees nil
4705 "Non-nil means sparse tree construction shows matches in archived trees.
4706 When nil, matches in these trees are highlighted, but the trees are kept in
4709 :group
'org-sparse-trees
4712 (defcustom org-sparse-tree-default-date-type nil
4713 "The default date type when building a sparse tree.
4714 When this is nil, a date is a scheduled or a deadline timestamp.
4715 Otherwise, these types are allowed:
4718 active: only active timestamps (<...>)
4719 inactive: only inactive timestamps ([...])
4720 scheduled: only scheduled timestamps
4721 deadline: only deadline timestamps"
4722 :type
'(choice (const :tag
"Scheduled or deadline" nil
)
4723 (const :tag
"All timestamps" all
)
4724 (const :tag
"Only active timestamps" active
)
4725 (const :tag
"Only inactive timestamps" inactive
)
4726 (const :tag
"Only scheduled timestamps" scheduled
)
4727 (const :tag
"Only deadline timestamps" deadline
)
4728 (const :tag
"Only closed timestamps" closed
))
4730 :package-version
'(Org .
"8.3")
4731 :group
'org-sparse-trees
)
4733 (defun org-cycle-hide-archived-subtrees (state)
4734 "Re-hide all archived subtrees after a visibility state change."
4735 (when (and (not org-cycle-open-archived-trees
)
4736 (not (memq state
'(overview folded
))))
4738 (let* ((globalp (memq state
'(contents all
)))
4739 (beg (if globalp
(point-min) (point)))
4740 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4741 (org-hide-archived-subtrees beg end
)
4743 (if (looking-at (concat ".*:" org-archive-tag
":"))
4744 (message "%s" (substitute-command-keys
4745 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4747 (defun org-force-cycle-archived ()
4748 "Cycle subtree even if it is archived."
4750 (setq this-command
'org-cycle
)
4751 (let ((org-cycle-open-archived-trees t
))
4752 (call-interactively 'org-cycle
)))
4754 (defun org-hide-archived-subtrees (beg end
)
4755 "Re-hide all archived subtrees after a visibility state change."
4756 (org-with-wide-buffer
4757 (let ((case-fold-search nil
)
4758 (re (concat org-outline-regexp-bol
".*:" org-archive-tag
":")))
4760 (while (and (< (point) end
) (re-search-forward re end t
))
4761 (when (member org-archive-tag
(org-get-tags))
4762 (org-flag-subtree t
)
4763 (org-end-of-subtree t
))))))
4765 (declare-function outline-end-of-heading
"outline" ())
4766 (declare-function outline-flag-region
"outline" (from to flag
))
4767 (defun org-flag-subtree (flag)
4769 (org-back-to-heading t
)
4770 (outline-end-of-heading)
4771 (outline-flag-region (point)
4772 (progn (org-end-of-subtree t
) (point))
4775 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4777 ;; Declare Column View Code
4779 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4780 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4781 (declare-function org-columns-compute
"org-colview" (property))
4785 (declare-function org-id-store-link
"org-id")
4786 (declare-function org-id-locations-load
"org-id")
4787 (declare-function org-id-locations-save
"org-id")
4788 (defvar org-id-track-globally
)
4790 ;;; Variables for pre-computed regular expressions, all buffer local
4792 (defvar org-todo-regexp nil
4793 "Matches any of the TODO state keywords.")
4794 (make-variable-buffer-local 'org-todo-regexp
)
4795 (defvar org-not-done-regexp nil
4796 "Matches any of the TODO state keywords except the last one.")
4797 (make-variable-buffer-local 'org-not-done-regexp
)
4798 (defvar org-not-done-heading-regexp nil
4799 "Matches a TODO headline that is not done.")
4800 (make-variable-buffer-local 'org-not-done-regexp
)
4801 (defvar org-todo-line-regexp nil
4802 "Matches a headline and puts TODO state into group 2 if present.")
4803 (make-variable-buffer-local 'org-todo-line-regexp
)
4804 (defvar org-complex-heading-regexp nil
4805 "Matches a headline and puts everything into groups:
4807 group 2: The todo keyword, maybe
4808 group 3: Priority cookie
4809 group 4: True headline
4811 (make-variable-buffer-local 'org-complex-heading-regexp
)
4812 (defvar org-complex-heading-regexp-format nil
4813 "Printf format to make regexp to match an exact headline.
4814 This regexp will match the headline of any node which has the
4815 exact headline text that is put into the format, but may have any
4816 TODO state, priority and tags.")
4817 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4818 (defvar org-todo-line-tags-regexp nil
4819 "Matches a headline and puts TODO state into group 2 if present.
4820 Also put tags into group 4 if tags are present.")
4821 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4823 (defconst org-plain-time-of-day-regexp
4826 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4829 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4831 "Regular expression to match a plain time or time range.
4832 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4833 groups carry important information:
4835 1 the first time, range or not
4836 8 the second time, if it is a range.")
4838 (defconst org-plain-time-extension-regexp
4841 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4842 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4843 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4844 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4845 groups carry important information:
4848 9 minutes of duration")
4850 (defconst org-stamp-time-of-day-regexp
4852 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4853 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4855 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4856 "Regular expression to match a timestamp time or time range.
4857 After a match, the following groups carry important information:
4859 1 date plus weekday, for back referencing to make sure both times are on the same day
4860 2 the first time, range or not
4861 4 the second time, if it is a range.")
4863 (defconst org-startup-options
4864 '(("fold" org-startup-folded t
)
4865 ("overview" org-startup-folded t
)
4866 ("nofold" org-startup-folded nil
)
4867 ("showall" org-startup-folded nil
)
4868 ("showeverything" org-startup-folded showeverything
)
4869 ("content" org-startup-folded content
)
4870 ("indent" org-startup-indented t
)
4871 ("noindent" org-startup-indented nil
)
4872 ("hidestars" org-hide-leading-stars t
)
4873 ("showstars" org-hide-leading-stars nil
)
4874 ("odd" org-odd-levels-only t
)
4875 ("oddeven" org-odd-levels-only nil
)
4876 ("align" org-startup-align-all-tables t
)
4877 ("noalign" org-startup-align-all-tables nil
)
4878 ("inlineimages" org-startup-with-inline-images t
)
4879 ("noinlineimages" org-startup-with-inline-images nil
)
4880 ("latexpreview" org-startup-with-latex-preview t
)
4881 ("nolatexpreview" org-startup-with-latex-preview nil
)
4882 ("customtime" org-display-custom-times t
)
4883 ("logdone" org-log-done time
)
4884 ("lognotedone" org-log-done note
)
4885 ("nologdone" org-log-done nil
)
4886 ("lognoteclock-out" org-log-note-clock-out t
)
4887 ("nolognoteclock-out" org-log-note-clock-out nil
)
4888 ("logrepeat" org-log-repeat state
)
4889 ("lognoterepeat" org-log-repeat note
)
4890 ("logdrawer" org-log-into-drawer t
)
4891 ("nologdrawer" org-log-into-drawer nil
)
4892 ("logstatesreversed" org-log-states-order-reversed t
)
4893 ("nologstatesreversed" org-log-states-order-reversed nil
)
4894 ("nologrepeat" org-log-repeat nil
)
4895 ("logreschedule" org-log-reschedule time
)
4896 ("lognotereschedule" org-log-reschedule note
)
4897 ("nologreschedule" org-log-reschedule nil
)
4898 ("logredeadline" org-log-redeadline time
)
4899 ("lognoteredeadline" org-log-redeadline note
)
4900 ("nologredeadline" org-log-redeadline nil
)
4901 ("logrefile" org-log-refile time
)
4902 ("lognoterefile" org-log-refile note
)
4903 ("nologrefile" org-log-refile nil
)
4904 ("fninline" org-footnote-define-inline t
)
4905 ("nofninline" org-footnote-define-inline nil
)
4906 ("fnlocal" org-footnote-section nil
)
4907 ("fnauto" org-footnote-auto-label t
)
4908 ("fnprompt" org-footnote-auto-label nil
)
4909 ("fnconfirm" org-footnote-auto-label confirm
)
4910 ("fnplain" org-footnote-auto-label plain
)
4911 ("fnadjust" org-footnote-auto-adjust t
)
4912 ("nofnadjust" org-footnote-auto-adjust nil
)
4913 ("constcgs" constants-unit-system cgs
)
4914 ("constSI" constants-unit-system SI
)
4915 ("noptag" org-tag-persistent-alist nil
)
4916 ("hideblocks" org-hide-block-startup t
)
4917 ("nohideblocks" org-hide-block-startup nil
)
4918 ("beamer" org-startup-with-beamer-mode t
)
4919 ("entitiespretty" org-pretty-entities t
)
4920 ("entitiesplain" org-pretty-entities nil
))
4921 "Variable associated with STARTUP options for org-mode.
4922 Each element is a list of three items: the startup options (as written
4923 in the #+STARTUP line), the corresponding variable, and the value to set
4924 this variable to if the option is found. An optional forth element PUSH
4925 means to push this value onto the list in the variable.")
4927 (defcustom org-group-tags t
4928 "When non-nil (the default), use group tags.
4929 This can be turned on/off through `org-toggle-tags-groups'."
4934 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4936 (defun org-toggle-tags-groups ()
4937 "Toggle support for group tags.
4938 Support for group tags is controlled by the option
4939 `org-group-tags', which is non-nil by default."
4941 (setq org-group-tags
(not org-group-tags
))
4942 (cond ((and (derived-mode-p 'org-agenda-mode
)
4945 ((derived-mode-p 'org-mode
)
4946 (let ((org-inhibit-startup t
)) (org-mode))))
4947 (message "Groups tags support has been turned %s"
4948 (if org-group-tags
"on" "off")))
4950 (defun org-set-regexps-and-options (&optional tags-only
)
4951 "Precompute regular expressions used in the current buffer.
4952 When optional argument TAGS-ONLY is non-nil, only compute tags
4953 related expressions."
4954 (when (derived-mode-p 'org-mode
)
4955 (let ((alist (org--setup-collect-keywords
4956 (org-make-options-regexp
4957 (append '("FILETAGS" "TAGS" "SETUPFILE")
4958 (and (not tags-only
)
4959 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4960 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4961 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4962 (org--setup-process-tags
4963 (cdr (assq 'tags alist
)) (cdr (assq 'filetags alist
)))
4966 (org-set-local 'org-file-properties
(cdr (assq 'property alist
)))
4967 ;; Archive location.
4968 (let ((archive (cdr (assq 'archive alist
))))
4969 (when archive
(org-set-local 'org-archive-location archive
)))
4971 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
4973 (org-set-local 'org-category
(intern cat
))
4974 (org-set-local 'org-file-properties
4975 (org--update-property-plist
4976 "CATEGORY" cat org-file-properties
))))
4978 (let ((column (cdr (assq 'columns alist
))))
4979 (when column
(org-set-local 'org-columns-default-format column
)))
4981 (setq org-table-formula-constants-local
(cdr (assq 'constants alist
)))
4982 ;; Link abbreviations.
4983 (let ((links (cdr (assq 'link alist
))))
4984 (when links
(setq org-link-abbrev-alist-local
(nreverse links
))))
4986 (let ((priorities (cdr (assq 'priorities alist
))))
4988 (org-set-local 'org-highest-priority
(nth 0 priorities
))
4989 (org-set-local 'org-lowest-priority
(nth 1 priorities
))
4990 (org-set-local 'org-default-priority
(nth 2 priorities
))))
4992 (let ((scripts (assq 'scripts alist
)))
4994 (org-set-local 'org-use-sub-superscripts
(cdr scripts
))))
4996 (let ((startup (cdr (assq 'startup alist
))))
4997 (dolist (option startup
)
4998 (let ((entry (assoc-string option org-startup-options t
)))
5000 (let ((var (nth 1 entry
))
5001 (val (nth 2 entry
)))
5002 (if (not (nth 3 entry
)) (org-set-local var val
)
5003 (unless (listp (symbol-value var
))
5004 (org-set-local var nil
))
5005 (add-to-list var val
)))))))
5007 (org-set-local 'org-todo-kwd-alist nil
)
5008 (org-set-local 'org-todo-key-alist nil
)
5009 (org-set-local 'org-todo-key-trigger nil
)
5010 (org-set-local 'org-todo-keywords-1 nil
)
5011 (org-set-local 'org-done-keywords nil
)
5012 (org-set-local 'org-todo-heads nil
)
5013 (org-set-local 'org-todo-sets nil
)
5014 (org-set-local 'org-todo-log-states nil
)
5015 (let ((todo-sequences
5016 (or (nreverse (cdr (assq 'todo alist
)))
5017 (let ((d (default-value 'org-todo-keywords
)))
5018 (if (not (stringp (car d
))) d
5019 ;; XXX: Backward compatibility code.
5020 (list (cons org-todo-interpretation d
)))))))
5021 (dolist (sequence todo-sequences
)
5022 (let* ((sequence (or (run-hook-with-args-until-success
5023 'org-todo-setup-filter-hook sequence
)
5025 (sequence-type (car sequence
))
5026 (keywords (cdr sequence
))
5027 (sep (member "|" keywords
))
5029 (dolist (k (remove "|" keywords
))
5030 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5032 (error "Invalid TODO keyword %s" k
))
5033 (let ((name (match-string 1 k
))
5034 (key (match-string 2 k
))
5035 (log (org-extract-log-state-settings k
)))
5037 (push (cons name
(and key
(string-to-char key
))) alist
)
5038 (when log
(push log org-todo-log-states
))))
5039 (let* ((names (nreverse names
))
5040 (done (if sep
(org-remove-keyword-keys (cdr sep
))
5043 (tail (list sequence-type head
(car done
) (org-last done
))))
5044 (add-to-list 'org-todo-heads head
'append
)
5045 (push names org-todo-sets
)
5046 (setq org-done-keywords
(append org-done-keywords done nil
))
5047 (setq org-todo-keywords-1
(append org-todo-keywords-1 names nil
))
5048 (setq org-todo-key-alist
5049 (append org-todo-key-alist
5051 (append '((:startgroup
))
5054 (dolist (k names
) (push (cons k tail
) org-todo-kwd-alist
))))))
5055 (setq org-todo-sets
(nreverse org-todo-sets
)
5056 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5057 org-todo-key-trigger
(delq nil
(mapcar #'cdr org-todo-key-alist
))
5058 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
))
5059 ;; Compute the regular expressions and other local variables.
5060 ;; Using `org-outline-regexp-bol' would complicate them much,
5061 ;; because of the fixed white space at the end of that string.
5062 (if (not org-done-keywords
)
5063 (setq org-done-keywords
5064 (and org-todo-keywords-1
(last org-todo-keywords-1
))))
5065 (setq org-not-done-keywords
5066 (org-delete-all org-done-keywords
5067 (copy-sequence org-todo-keywords-1
))
5068 org-todo-regexp
(regexp-opt org-todo-keywords-1 t
)
5069 org-not-done-regexp
(regexp-opt org-not-done-keywords t
)
5070 org-not-done-heading-regexp
5071 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5072 org-todo-line-regexp
5073 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5074 org-complex-heading-regexp
5075 (concat "^\\(\\*+\\)"
5076 "\\(?: +" org-todo-regexp
"\\)?"
5077 "\\(?: +\\(\\[#.\\]\\)\\)?"
5078 "\\(?: +\\(.*?\\)\\)??"
5079 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5081 org-complex-heading-regexp-format
5082 (concat "^\\(\\*+\\)"
5083 "\\(?: +" org-todo-regexp
"\\)?"
5084 "\\(?: +\\(\\[#.\\]\\)\\)?"
5086 ;; Stats cookies can be stuck to body.
5087 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5089 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5091 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5093 org-todo-line-tags-regexp
5094 (concat "^\\(\\*+\\)"
5095 "\\(?: +" org-todo-regexp
"\\)?"
5096 "\\(?: +\\(.*?\\)\\)??"
5097 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5099 (org-compute-latex-and-related-regexp)))))
5101 (defun org--setup-collect-keywords (regexp &optional files alist
)
5102 "Return setup keywords values as an alist.
5104 REGEXP matches a subset of setup keywords. FILES is a list of
5105 file names already visited. It is used to avoid circular setup
5106 files. ALIST, when non-nil, is the alist computed so far.
5108 Return value contains the following keys: `archive', `category',
5109 `columns', `constants', `filetags', `link', `priorities',
5110 `property', `scripts', `startup', `tags' and `todo'."
5111 (org-with-wide-buffer
5112 (goto-char (point-min))
5113 (let ((case-fold-search t
))
5114 (while (re-search-forward regexp nil t
)
5115 (let ((element (org-element-at-point)))
5116 (when (eq (org-element-type element
) 'keyword
)
5117 (let ((key (org-element-property :key element
))
5118 (value (org-element-property :value element
)))
5120 ((equal key
"ARCHIVE")
5121 (when (org-string-nw-p value
)
5122 (push (cons 'archive value
) alist
)))
5123 ((equal key
"CATEGORY") (push (cons 'category value
) alist
))
5124 ((equal key
"COLUMNS") (push (cons 'columns value
) alist
))
5125 ((equal key
"CONSTANTS")
5126 (let* ((constants (assq 'constants alist
))
5127 (store (cdr constants
)))
5128 (dolist (pair (org-split-string value
))
5129 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5131 (let* ((name (match-string 1 pair
))
5132 (value (match-string 2 pair
))
5133 (old (assoc name store
)))
5134 (if old
(setcdr old value
)
5135 (push (cons name value
) store
)))))
5136 (if constants
(setcdr constants store
)
5137 (push (cons 'constants store
) alist
))))
5138 ((equal key
"FILETAGS")
5139 (when (org-string-nw-p value
)
5140 (let ((old (assq 'filetags alist
))
5142 (mapcar (lambda (x) (org-split-string x
":"))
5143 (org-split-string value
)))))
5144 (if old
(setcdr old
(append new
(cdr old
)))
5145 (push (cons 'filetags new
) alist
)))))
5147 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5148 (let ((links (assq 'link alist
))
5149 (pair (cons (org-match-string-no-properties 1 value
)
5150 (org-match-string-no-properties 2 value
))))
5151 (if links
(push pair
(cdr links
))
5152 (push (list 'link pair
) alist
)))))
5153 ((equal key
"OPTIONS")
5154 (when (and (org-string-nw-p value
)
5155 (string-match "\\^:\\(t\\|nil\\|{}\\)" value
))
5156 (push (cons 'scripts
(read (match-string 1 value
))) alist
)))
5157 ((equal key
"PRIORITIES")
5158 (push (cons 'priorities
5159 (let ((prio (org-split-string value
)))
5160 (if (< (length prio
) 3) '(?A ?C ?B
)
5161 (mapcar #'string-to-char prio
))))
5163 ((equal key
"PROPERTY")
5164 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value
)
5165 (let* ((property (assq 'property alist
))
5166 (value (org--update-property-plist
5167 (org-match-string-no-properties 1 value
)
5168 (org-match-string-no-properties 2 value
)
5170 (if property
(setcdr property value
)
5171 (push (cons 'property value
) alist
)))))
5172 ((equal key
"STARTUP")
5173 (let ((startup (assq 'startup alist
)))
5176 (append (cdr startup
) (org-split-string value
)))
5177 (push (cons 'startup
(org-split-string value
)) alist
))))
5179 (let ((tag-cell (assq 'tags alist
)))
5182 (append (cdr tag-cell
)
5184 (org-split-string value
)))
5185 (push (cons 'tags
(org-split-string value
)) alist
))))
5186 ((member key
'("TODO" "SEQ_TODO" "TYP_TODO"))
5187 (let ((todo (assq 'todo alist
))
5188 (value (cons (if (equal key
"TYP_TODO") 'type
'sequence
)
5189 (org-split-string value
))))
5190 (if todo
(push value
(cdr todo
))
5191 (push (list 'todo value
) alist
))))
5192 ((equal key
"SETUPFILE")
5193 (unless buffer-read-only
; Do not check in Gnus messages.
5194 (let ((f (and (org-string-nw-p value
)
5196 (org-remove-double-quotes value
)))))
5197 (when (and f
(file-readable-p f
) (not (member f files
)))
5199 (insert-file-contents f
)
5201 ;; Fake Org mode to benefit from cache
5202 ;; without recurring needlessly.
5203 (let ((major-mode 'org-mode
))
5204 (org--setup-collect-keywords
5205 regexp
(cons f files
) alist
)))))))))))))))
5208 (defun org--setup-process-tags (tags filetags
)
5209 "Precompute variables used for tags.
5210 TAGS is a list of tags and tag group symbols, as strings.
5211 FILETAGS is a list of tags, as strings."
5212 ;; Process the file tags.
5213 (org-set-local 'org-file-tags
5214 (mapcar #'org-add-prop-inherited filetags
))
5215 ;; Provide default tags if no local tags are found.
5216 (when (and (not tags
) org-tag-alist
)
5218 (mapcar (lambda (tag)
5224 (otherwise (concat (car tag
)
5225 (and (characterp (cdr tag
))
5226 (format "(%c)" (cdr tag
)))))))
5228 ;; Process the tags.
5229 (org-set-local 'org-tag-groups-alist nil
)
5230 (org-set-local 'org-tag-alist nil
)
5233 (let ((e (car tags
)))
5234 (setq tags
(cdr tags
))
5237 (push '(:startgroup
) org-tag-alist
)
5238 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5240 (push '(:endgroup
) org-tag-alist
)
5241 (setq group-flag nil
))
5243 (push '(:grouptags
) org-tag-alist
)
5244 (setq group-flag
'append
))
5245 ((equal e
"\\n") (push '(:newline
) org-tag-alist
))
5247 (org-re "\\`\\([[:alnum:]_@#%]+\\)\\(?:(\\(.\\))\\)?\\'") e
)
5248 (let ((tag (match-string 1 e
))
5249 (key (and (match-beginning 2)
5250 (string-to-char (match-string 2 e
)))))
5251 (cond ((eq group-flag
'append
)
5252 (setcar org-tag-groups-alist
5253 (append (car org-tag-groups-alist
) (list tag
))))
5254 (group-flag (push (list tag
) org-tag-groups-alist
)))
5255 (unless (assoc tag org-tag-alist
)
5256 (push (cons tag key
) org-tag-alist
))))))))
5257 (setq org-tag-alist
(nreverse org-tag-alist
)))
5259 (defun org-file-contents (file &optional noerror
)
5260 "Return the contents of FILE, as a string."
5261 (if (and file
(file-readable-p file
))
5263 (insert-file-contents file
)
5265 (funcall (if noerror
'message
'error
)
5266 "Cannot read file \"%s\"%s"
5268 (let ((from (buffer-file-name (buffer-base-buffer))))
5269 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5271 (defun org-extract-log-state-settings (x)
5272 "Extract the log state setting from a TODO keyword string.
5273 This will extract info from a string like \"WAIT(w@/!)\"."
5274 (let (kw key log1 log2
)
5275 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5276 (setq kw
(match-string 1 x
)
5277 key
(and (match-end 2) (match-string 2 x
))
5278 log1
(and (match-end 3) (match-string 3 x
))
5279 log2
(and (match-end 4) (match-string 4 x
)))
5282 (and log1
(if (equal log1
"!") 'time
'note
))
5283 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5285 (defun org-remove-keyword-keys (list)
5286 "Remove a pair of parenthesis at the end of each string in LIST."
5288 (if (string-match "(.*)$" x
)
5289 (substring x
0 (match-beginning 0))
5293 (defun org-assign-fast-keys (alist)
5294 "Assign fast keys to a keyword-key alist.
5295 Respect keys that are already there."
5296 (let (new e
(alt ?
0))
5297 (while (setq e
(pop alist
))
5298 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5299 (cdr e
)) ;; Key already assigned.
5301 (let ((clist (string-to-list (downcase (car e
))))
5302 (used (append new alist
)))
5303 (when (= (car clist
) ?
@)
5305 (while (and clist
(rassoc (car clist
) used
))
5308 (while (rassoc alt used
)
5310 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5313 ;;; Some variables used in various places
5315 (defvar org-window-configuration nil
5316 "Used in various places to store a window configuration.")
5317 (defvar org-selected-window nil
5318 "Used in various places to store a window configuration.")
5319 (defvar org-finish-function nil
5320 "Function to be called when `C-c C-c' is used.
5321 This is for getting out of special buffers like capture.")
5324 ;; FIXME: Occasionally check by commenting these, to make sure
5325 ;; no other functions uses these, forgetting to let-bind them.
5326 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5327 (defvar org-last-state
)
5328 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5330 ;; Defined somewhere in this file, but used before definition.
5331 (defvar org-entities
) ;; defined in org-entities.el
5332 (defvar org-struct-menu
)
5333 (defvar org-org-menu
)
5334 (defvar org-tbl-menu
)
5336 ;;;; Define the Org-mode
5338 ;; We use a before-change function to check if a table might need
5340 (defvar org-table-may-need-update t
5341 "Indicates that a table might need an update.
5342 This variable is set by `org-before-change-function'.
5343 `org-table-align' sets it back to nil.")
5344 (defun org-before-change-function (beg end
)
5345 "Every change indicates that a table might need an update."
5346 (setq org-table-may-need-update t
))
5347 (defvar org-mode-map
)
5348 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5349 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5350 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5351 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5352 (defvar org-table-buffer-is-an nil
)
5354 (defvar bidi-paragraph-direction
)
5355 (defvar buffer-face-mode-face
)
5358 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5359 (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"))
5360 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5362 ;; Other stuff we need.
5363 (require 'time-date
)
5364 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5368 ;; (require 'org-macs) moved higher up in the file before it is first used
5369 (require 'org-entities
)
5370 ;; (require 'org-compat) moved higher up in the file before it is first used
5371 (require 'org-faces
)
5373 (require 'org-pcomplete
)
5375 (require 'org-footnote
)
5376 (require 'org-macro
)
5382 (define-derived-mode org-mode outline-mode
"Org"
5383 "Outline-based notes management and organizer, alias
5384 \"Carsten's outline-mode for keeping track of everything.\"
5386 Org-mode develops organizational tasks around a NOTES file which
5387 contains information about projects as plain text. Org-mode is
5388 implemented on top of outline-mode, which is ideal to keep the content
5389 of large files well structured. It supports ToDo items, deadlines and
5390 time stamps, which magically appear in the diary listing of the Emacs
5391 calendar. Tables are easily created with a built-in table editor.
5392 Plain text URL-like links connect to websites, emails (VM), Usenet
5393 messages (Gnus), BBDB entries, and any files related to the project.
5394 For printing and sharing of notes, an Org-mode file (or a part of it)
5395 can be exported as a structured ASCII or HTML file.
5397 The following commands are available:
5401 ;; Get rid of Outline menus, they are not needed
5402 ;; Need to do this here because define-derived-mode sets up
5403 ;; the keymap so late. Still, it is a waste to call this each time
5404 ;; we switch another buffer into org-mode.
5405 (if (featurep 'xemacs
)
5406 (when (boundp 'outline-mode-menu-heading
)
5407 ;; Assume this is Greg's port, it uses easymenu
5408 (easy-menu-remove outline-mode-menu-heading
)
5409 (easy-menu-remove outline-mode-menu-show
)
5410 (easy-menu-remove outline-mode-menu-hide
))
5411 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5412 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5413 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5415 (org-load-modules-maybe)
5416 (easy-menu-add org-org-menu
)
5417 (easy-menu-add org-tbl-menu
)
5418 (org-install-agenda-files-menu)
5419 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5420 (add-to-invisibility-spec '(org-cwidth))
5421 (add-to-invisibility-spec '(org-hide-block . t
))
5422 (when (featurep 'xemacs
)
5423 (org-set-local 'line-move-ignore-invisible t
))
5424 (org-set-local 'outline-regexp org-outline-regexp
)
5425 (org-set-local 'outline-level
'org-outline-level
)
5426 (setq bidi-paragraph-direction
'left-to-right
)
5427 (when (and org-ellipsis
5428 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5429 (fboundp 'make-glyph-code
))
5430 (unless org-display-table
5431 (setq org-display-table
(make-display-table)))
5432 (set-display-table-slot
5435 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5437 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5438 (setq buffer-display-table org-display-table
))
5439 (org-set-regexps-and-options)
5440 (org-set-font-lock-defaults)
5441 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5442 ;; tag faces set outside customize.... force initialization.
5443 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5445 (org-set-local 'calc-embedded-open-mode
"# ")
5446 ;; Modify a few syntax entries
5447 (modify-syntax-entry ?
@ "w")
5448 (modify-syntax-entry ?
\" "\"")
5449 (modify-syntax-entry ?
\\ "_")
5450 (modify-syntax-entry ?~
"_")
5451 (if org-startup-truncated
(setq truncate-lines t
))
5452 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5453 (org-set-local 'font-lock-unfontify-region-function
5454 'org-unfontify-region
)
5455 ;; Activate before-change-function
5456 (org-set-local 'org-table-may-need-update t
)
5457 (org-add-hook 'before-change-functions
'org-before-change-function nil
5459 ;; Check for running clock before killing a buffer
5460 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5461 ;; Initialize macros templates.
5462 (org-macro-initialize-templates)
5463 ;; Initialize radio targets.
5464 (org-update-radio-target-regexp)
5466 (org-set-local 'indent-line-function
'org-indent-line
)
5467 (org-set-local 'indent-region-function
'org-indent-region
)
5468 ;; Filling and auto-filling.
5471 (org-setup-comments-handling)
5472 ;; Initialize cache.
5473 (org-element-cache-reset)
5474 ;; Beginning/end of defun
5475 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5476 (org-set-local 'end-of-defun-function
5478 (if (not (org-at-heading-p))
5479 (org-forward-element)
5480 (org-forward-element)
5481 (forward-char -
1))))
5482 ;; Next error for sparse trees
5483 (org-set-local 'next-error-function
'org-occur-next-match
)
5484 ;; Make sure dependence stuff works reliably, even for users who set it
5486 (if org-enforce-todo-dependencies
5487 (add-hook 'org-blocker-hook
5488 'org-block-todo-from-children-or-siblings-or-parent
)
5489 (remove-hook 'org-blocker-hook
5490 'org-block-todo-from-children-or-siblings-or-parent
))
5491 (if org-enforce-todo-checkbox-dependencies
5492 (add-hook 'org-blocker-hook
5493 'org-block-todo-from-checkboxes
)
5494 (remove-hook 'org-blocker-hook
5495 'org-block-todo-from-checkboxes
))
5497 ;; Align options lines
5499 'align-mode-rules-list
5500 '((org-in-buffer-settings
5501 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5502 (modes .
'(org-mode)))))
5505 (org-set-local 'imenu-create-index-function
5506 'org-imenu-get-tree
)
5508 ;; Make isearch reveal context
5509 (if (or (featurep 'xemacs
)
5510 (not (boundp 'outline-isearch-open-invisible-function
)))
5511 ;; Emacs 21 and XEmacs make use of the hook
5512 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5513 ;; Emacs 22 deals with this through a special variable
5514 (org-set-local 'outline-isearch-open-invisible-function
5515 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5517 ;; Setup the pcomplete hooks
5518 (set (make-local-variable 'pcomplete-command-completion-function
)
5519 'org-pcomplete-initial
)
5520 (set (make-local-variable 'pcomplete-command-name-function
)
5521 'org-command-at-point
)
5522 (set (make-local-variable 'pcomplete-default-completion-function
)
5524 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5525 'org-parse-arguments
)
5526 (set (make-local-variable 'pcomplete-termination-string
) "")
5527 (when (>= emacs-major-version
23)
5528 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5530 ;; If empty file that did not turn on org-mode automatically, make it to.
5531 (if (and org-insert-mode-line-in-empty-file
5532 (org-called-interactively-p 'any
)
5533 (= (point-min) (point-max)))
5534 (insert "# -*- mode: org -*-\n\n"))
5535 (unless org-inhibit-startup
5537 (and org-startup-with-beamer-mode
(org-beamer-mode))
5538 (when org-startup-align-all-tables
5539 (org-table-map-tables 'org-table-align
'quietly
))
5540 (when org-startup-with-inline-images
5541 (org-display-inline-images))
5542 (when org-startup-with-latex-preview
5543 (org-toggle-latex-fragment))
5544 (unless org-inhibit-startup-visibility-stuff
5545 (org-set-startup-visibility))
5546 (org-refresh-effort-properties)))
5547 ;; Try to set org-hide correctly
5548 (let ((foreground (org-find-invisible-foreground)))
5550 (set-face-foreground 'org-hide foreground
))))
5552 ;; Update `customize-package-emacs-version-alist'
5553 (add-to-list 'customize-package-emacs-version-alist
5554 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5555 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5556 ("8.2.6" .
"24.4") ("8.3" .
"25.1")))
5558 (defvar org-mode-transpose-word-syntax-table
5559 (let ((st (make-syntax-table text-mode-syntax-table
)))
5560 (mapc (lambda(c) (modify-syntax-entry
5561 (string-to-char (car c
)) "w p" st
))
5565 (when (fboundp 'abbrev-table-put
)
5566 (abbrev-table-put org-mode-abbrev-table
5567 :parents
(list text-mode-abbrev-table
)))
5569 (defun org-find-invisible-foreground ()
5570 (let ((candidates (remove
5573 (list (face-background 'default
)
5574 (face-background 'org-default
))
5577 (when (boundp alist
)
5578 (cdr (assoc 'background-color
(symbol-value alist
)))))
5579 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5580 (list (face-foreground 'org-hide
))))))
5581 (car (remove nil candidates
))))
5583 (defun org-current-time (&optional rounding-minutes past
)
5584 "Current time, possibly rounded to ROUNDING-MINUTES.
5585 When ROUNDING-MINUTES is not an integer, fall back on the car of
5586 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5587 the rounding returns a past time."
5588 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5589 (car org-time-stamp-rounding-minutes
)))
5590 (time (decode-time)) res
)
5595 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5597 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5598 (seconds-to-time (- (org-float-time res
) (* r
60)))
5602 "Return today date, considering `org-extend-today-until'."
5604 (time-subtract (current-time)
5605 (list 0 (* 3600 org-extend-today-until
) 0))))
5607 ;;;; Font-Lock stuff, including the activators
5609 (defvar org-mouse-map
(make-sparse-keymap))
5610 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5611 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5612 (when org-mouse-1-follows-link
5613 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5614 (when org-tab-follows-link
5615 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5616 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5618 (require 'font-lock
)
5620 (defconst org-non-link-chars
"]\t\n\r<>")
5621 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5622 "file+sys" "news" "shell" "elisp" "doi" "message"
5624 (defvar org-link-types-re nil
5625 "Matches a link that has a url-like prefix like \"http:\"")
5626 (defvar org-link-re-with-space nil
5627 "Matches a link with spaces, optional angular brackets around it.")
5628 (defvar org-link-re-with-space2 nil
5629 "Matches a link with spaces, optional angular brackets around it.")
5630 (defvar org-link-re-with-space3 nil
5631 "Matches a link with spaces, only for internal part in bracket links.")
5632 (defvar org-angle-link-re nil
5633 "Matches link with angular brackets, spaces are allowed.")
5634 (defvar org-plain-link-re nil
5635 "Matches plain link, without spaces.")
5636 (defvar org-bracket-link-regexp nil
5637 "Matches a link in double brackets.")
5638 (defvar org-bracket-link-analytic-regexp nil
5639 "Regular expression used to analyze links.
5640 Here is what the match groups contain after a match:
5646 (defvar org-bracket-link-analytic-regexp
++ nil
5647 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5648 (defvar org-any-link-re nil
5649 "Regular expression matching any link.")
5651 (defconst org-match-sexp-depth
3
5652 "Number of stacked braces for sub/superscript matching.")
5654 (defun org-create-multibrace-regexp (left right n
)
5655 "Create a regular expression which will match a balanced sexp.
5656 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5657 as single character strings.
5658 The regexp returned will match the entire expression including the
5659 delimiters. It will also define a single group which contains the
5660 match except for the outermost delimiters. The maximum depth of
5661 stacked delimiters is N. Escaping delimiters is not possible."
5662 (let* ((nothing (concat "[^" left right
"]*?"))
5665 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5668 re
(concat re or next
)
5669 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5670 (concat left
"\\(" re
"\\)" right
)))
5672 (defconst org-match-substring-regexp
5674 "\\(\\S-\\)\\([_^]\\)\\("
5675 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5677 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5679 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5680 "The regular expression matching a sub- or superscript.")
5682 (defconst org-match-substring-with-braces-regexp
5684 "\\(\\S-\\)\\([_^]\\)"
5685 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5686 "The regular expression matching a sub- or superscript, forcing braces.")
5688 (defun org-make-link-regexps ()
5689 "Update the link regular expressions.
5690 This should be called after the variable `org-link-types' has changed."
5691 (let ((types-re (regexp-opt org-link-types t
)))
5692 (setq org-link-types-re
5693 (concat "\\`" types-re
":")
5694 org-link-re-with-space
5695 (concat "<?" types-re
":"
5696 "\\([^" org-non-link-chars
" ]"
5697 "[^" org-non-link-chars
"]*"
5698 "[^" org-non-link-chars
" ]\\)>?")
5699 org-link-re-with-space2
5700 (concat "<?" types-re
":"
5701 "\\([^" org-non-link-chars
" ]"
5703 "[^" org-non-link-chars
" ]\\)>?")
5704 org-link-re-with-space3
5705 (concat "<?" types-re
":"
5706 "\\([^" org-non-link-chars
" ]"
5709 (concat "<" types-re
":"
5710 "\\([^" org-non-link-chars
" ]"
5711 "[^" org-non-link-chars
"]*"
5716 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5717 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5718 org-bracket-link-regexp
5719 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5720 org-bracket-link-analytic-regexp
5723 "\\(" types-re
":\\)?"
5726 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5728 org-bracket-link-analytic-regexp
++
5731 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5734 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5737 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5738 org-angle-link-re
"\\)\\|\\("
5739 org-plain-link-re
"\\)"))))
5741 (org-make-link-regexps)
5743 (defvar org-emph-face nil
)
5745 (defun org-do-emphasis-faces (limit)
5746 "Run through the buffer and emphasize strings."
5748 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5749 (let* ((border (char-after (match-beginning 3)))
5750 (bre (regexp-quote (char-to-string border
))))
5751 (if (and (not (= border
(char-after (match-beginning 4))))
5752 (not (save-match-data
5753 (string-match (concat bre
".*" bre
)
5754 (replace-regexp-in-string
5756 (substring (match-string 2) 1 -
1))))))
5759 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5760 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5764 (org-remove-flyspell-overlays-in
5765 (match-beginning 0) (match-end 0)))
5766 (add-text-properties (match-beginning 2) (match-end 2)
5767 '(font-lock-multiline t org-emphasis t
))
5768 (when org-hide-emphasis-markers
5769 (add-text-properties (match-end 4) (match-beginning 5)
5770 '(invisible org-link
))
5771 (add-text-properties (match-beginning 3) (match-end 3)
5772 '(invisible org-link
))))))
5773 (goto-char (1+ (match-beginning 0))))
5776 (defun org-emphasize (&optional char
)
5777 "Insert or change an emphasis, i.e. a font like bold or italic.
5778 If there is an active region, change that region to a new emphasis.
5779 If there is no region, just insert the marker characters and position
5780 the cursor between them.
5781 CHAR should be the marker character. If it is a space, it means to
5782 remove the emphasis of the selected region.
5783 If CHAR is not given (for example in an interactive call) it will be
5786 (let ((erc org-emphasis-regexp-components
)
5788 (string "") beg end move c s
)
5789 (if (org-region-active-p)
5790 (setq beg
(region-beginning) end
(region-end)
5791 string
(buffer-substring beg end
))
5795 (message "Emphasis marker or tag: [%s]"
5796 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5797 (setq char
(read-char-exclusive)))
5798 (if (equal char ?\
)
5799 (setq s
"" move nil
)
5800 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5801 (user-error "No such emphasis marker: \"%c\"" char
))
5802 (setq s
(char-to-string char
)))
5803 (while (and (> (length string
) 1)
5804 (equal (substring string
0 1) (substring string -
1))
5805 (assoc (substring string
0 1) org-emphasis-alist
))
5806 (setq string
(substring string
1 -
1)))
5807 (setq string
(concat s string s
))
5808 (if beg
(delete-region beg end
))
5810 (string-match (concat "[" (nth 0 erc
) "\n]")
5811 (char-to-string (char-before (point)))))
5814 (string-match (concat "[" (nth 1 erc
) "\n]")
5815 (char-to-string (char-after (point)))))
5816 (insert " ") (backward-char 1))
5818 (and move
(backward-char 1))))
5820 (defconst org-nonsticky-props
5821 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5823 (defsubst org-rear-nonsticky-at
(pos)
5824 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5826 (defun org-activate-plain-links (limit)
5827 "Add link properties for plain links."
5829 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5830 (not (member 'org-tag
5831 (get-text-property (1- (match-beginning 0)) 'face
)))
5832 (not (org-in-src-block-p)))
5833 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5834 (setq f
(get-text-property (match-beginning 0) 'face
))
5835 (setq hl
(org-match-string-no-properties 0))
5836 (if (or (eq f
'org-tag
)
5837 (and (listp f
) (memq 'org-tag f
)))
5839 (add-text-properties (match-beginning 0) (match-end 0)
5840 (list 'mouse-face
'highlight
5842 'htmlize-link
`(:uri
,hl
)
5843 'keymap org-mouse-map
))
5844 (org-rear-nonsticky-at (match-end 0)))
5847 (defun org-activate-code (limit)
5848 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5850 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5851 (remove-text-properties (match-beginning 0) (match-end 0)
5852 '(display t invisible t intangible t
))
5855 (defcustom org-src-fontify-natively t
5856 "When non-nil, fontify code in code blocks."
5859 :package-version
'(Org .
"8.3")
5860 :group
'org-appearance
5863 (defcustom org-allow-promoting-top-level-subtree nil
5864 "When non-nil, allow promoting a top level subtree.
5865 The leading star of the top level headline will be replaced
5869 :group
'org-appearance
)
5871 (defun org-fontify-meta-lines-and-blocks (limit)
5873 (org-fontify-meta-lines-and-blocks-1 limit
)
5874 (error (message "org-mode fontification error"))))
5876 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5877 "Fontify #+ lines and blocks."
5878 (let ((case-fold-search t
))
5879 (if (re-search-forward
5880 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5882 (let ((beg (match-beginning 0))
5883 (block-start (match-end 0))
5885 (lang (match-string 7))
5886 (beg1 (line-beginning-position 2))
5887 (dc1 (downcase (match-string 2)))
5888 (dc3 (downcase (match-string 3)))
5889 end end1 quoting block-type ovl
)
5891 ((member dc1
'("+html:" "+ascii:" "+latex:"))
5892 ;; a single line of backend-specific content
5893 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5894 (remove-text-properties (match-beginning 0) (match-end 0)
5895 '(display t invisible t intangible t
))
5896 (add-text-properties (match-beginning 1) (match-end 3)
5897 '(font-lock-fontified t face org-meta-line
))
5898 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5899 '(font-lock-fontified t face org-block
))
5900 ; for backend-specific code
5902 ((and (match-end 4) (equal dc3
"+begin"))
5904 (setq block-type
(downcase (match-string 5))
5905 quoting
(member block-type org-protecting-blocks
))
5906 (when (re-search-forward
5907 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5908 nil t
) ;; on purpose, we look further than LIMIT
5909 (setq end
(min (point-max) (match-end 0))
5910 end1
(min (point-max) (1- (match-beginning 0))))
5911 (setq block-end
(match-beginning 0))
5913 (org-remove-flyspell-overlays-in beg1 end1
)
5914 (remove-text-properties beg end
5915 '(display t invisible t intangible t
)))
5916 (add-text-properties
5917 beg end
'(font-lock-fontified t font-lock-multiline t
))
5918 (add-text-properties beg beg1
'(face org-meta-line
))
5919 (org-remove-flyspell-overlays-in beg beg1
)
5920 (add-text-properties ; For end_src
5921 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5922 (org-remove-flyspell-overlays-in end1 end
)
5924 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5925 (org-src-font-lock-fontify-block lang block-start block-end
)
5926 (add-text-properties beg1 block-end
'(src-block t
)))
5928 (add-text-properties beg1
(min (point-max) (1+ end1
))
5929 '(face org-block
))) ; end of source block
5930 ((not org-fontify-quote-and-verse-blocks
))
5931 ((string= block-type
"quote")
5932 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5933 ((string= block-type
"verse")
5934 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5935 (add-text-properties beg beg1
'(face org-block-begin-line
))
5936 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5937 '(face org-block-end-line
))
5939 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5940 (org-remove-flyspell-overlays-in
5942 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5943 (add-text-properties
5945 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5946 '(font-lock-fontified t invisible t
)
5947 '(font-lock-fontified t face org-document-info-keyword
)))
5948 (add-text-properties
5949 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5950 (if (string-equal dc1
"+title:")
5951 '(font-lock-fontified t face org-document-title
)
5952 '(font-lock-fontified t face org-document-info
))))
5953 ((or (equal dc1
"+results")
5954 (member dc1
'("+begin:" "+end:" "+caption:" "+label:"
5955 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5956 "+call:" "+header:" "+headers:" "+name:"))
5957 (and (match-end 4) (equal dc3
"+attr")))
5958 (org-remove-flyspell-overlays-in
5960 (if (equal "+caption:" dc1
) (match-end 2) (match-end 0)))
5961 (add-text-properties
5963 '(font-lock-fontified t face org-meta-line
))
5965 ((member dc3
'(" " ""))
5966 (org-remove-flyspell-overlays-in beg
(match-end 0))
5967 (add-text-properties
5969 '(font-lock-fontified t face font-lock-comment-face
)))
5970 (t ;; just any other in-buffer setting, but not indented
5971 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5972 (add-text-properties
5974 '(font-lock-fontified t face org-meta-line
))
5977 (defun org-fontify-drawers (limit)
5979 (when (re-search-forward org-drawer-regexp limit t
)
5980 (add-text-properties
5981 (match-beginning 0) (match-end 0)
5982 '(font-lock-fontified t face org-special-keyword
))
5983 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5986 (defun org-fontify-macros (limit)
5988 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
5989 (add-text-properties
5990 (match-beginning 0) (match-end 0)
5991 '(font-lock-fontified t face org-macro
))
5992 (when org-hide-macro-markers
5993 (add-text-properties (match-end 2) (match-beginning 2)
5995 (add-text-properties (match-beginning 1) (match-end 1)
5997 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6000 (defun org-activate-angle-links (limit)
6001 "Add text properties for angle links."
6002 (if (and (re-search-forward org-angle-link-re limit t
)
6003 (not (org-in-src-block-p)))
6005 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6006 (add-text-properties (match-beginning 0) (match-end 0)
6007 (list 'mouse-face
'highlight
6008 'keymap org-mouse-map
))
6009 (org-rear-nonsticky-at (match-end 0))
6012 (defun org-activate-footnote-links (limit)
6013 "Add text properties for footnotes."
6014 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6016 (let* ((beg (nth 1 fn
))
6019 (referencep (/= (line-beginning-position) beg
)))
6020 (when (and referencep
(nth 3 fn
))
6023 (search-forward (or label
"fn:"))
6024 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6025 (add-text-properties beg end
6026 (list 'mouse-face
'highlight
6027 'keymap org-mouse-map
6029 (if referencep
"Footnote reference"
6030 "Footnote definition")
6031 'font-lock-fontified t
6032 'font-lock-multiline t
6033 'face
'org-footnote
))))))
6035 (defun org-activate-bracket-links (limit)
6036 "Add text properties for bracketed links."
6037 (if (and (re-search-forward org-bracket-link-regexp limit t
)
6038 (not (org-in-src-block-p)))
6039 (let* ((hl (org-match-string-no-properties 1))
6040 (help (concat "LINK: " (save-match-data (org-link-unescape hl
))))
6041 (ip (org-maybe-intangible
6042 (list 'invisible
'org-link
6043 'keymap org-mouse-map
'mouse-face
'highlight
6044 'font-lock-multiline t
'help-echo help
6045 'htmlize-link
`(:uri
,hl
))))
6046 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
6047 'font-lock-multiline t
'help-echo help
6048 'htmlize-link
`(:uri
,hl
))))
6049 ;; We need to remove the invisible property here. Table narrowing
6050 ;; may have made some of this invisible.
6051 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6052 (remove-text-properties (match-beginning 0) (match-end 0)
6056 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6057 (org-rear-nonsticky-at (match-beginning 3))
6058 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6059 (org-rear-nonsticky-at (match-end 3))
6060 (add-text-properties (match-end 3) (match-end 0) ip
)
6061 (org-rear-nonsticky-at (match-end 0)))
6062 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6063 (org-rear-nonsticky-at (match-beginning 1))
6064 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6065 (org-rear-nonsticky-at (match-end 1))
6066 (add-text-properties (match-end 1) (match-end 0) ip
)
6067 (org-rear-nonsticky-at (match-end 0)))
6070 (defun org-activate-dates (limit)
6071 "Add text properties for dates."
6072 (if (and (re-search-forward org-tsr-regexp-both limit t
)
6073 (not (equal (char-before (match-beginning 0)) 91)))
6075 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6076 (add-text-properties (match-beginning 0) (match-end 0)
6077 (list 'mouse-face
'highlight
6078 'keymap org-mouse-map
))
6079 (org-rear-nonsticky-at (match-end 0))
6080 (when org-display-custom-times
6082 (org-display-custom-time (match-beginning 3) (match-end 3)))
6083 (org-display-custom-time (match-beginning 1) (match-end 1)))
6086 (defvar org-target-link-regexp nil
6087 "Regular expression matching radio targets in plain text.")
6088 (make-variable-buffer-local 'org-target-link-regexp
)
6090 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6091 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6092 border border border
))
6093 "Regular expression matching a link target.")
6095 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6096 "Regular expression matching a radio target.")
6098 (defconst org-any-target-regexp
6099 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6100 "Regular expression matching any target.")
6102 (defun org-activate-target-links (limit)
6103 "Add text properties for target matches."
6104 (when org-target-link-regexp
6105 (let ((case-fold-search t
))
6106 (if (re-search-forward org-target-link-regexp limit t
)
6108 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6109 (add-text-properties (match-beginning 1) (match-end 1)
6110 (list 'mouse-face
'highlight
6111 'keymap org-mouse-map
6112 'help-echo
"Radio target link"
6113 'org-linked-text t
))
6114 (org-rear-nonsticky-at (match-end 1))
6117 (defun org-update-radio-target-regexp ()
6118 "Find all radio targets in this file and update the regular expression.
6119 Also refresh fontification if needed."
6121 (let ((old-regexp org-target-link-regexp
)
6122 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6123 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6125 (org-with-wide-buffer
6126 (goto-char (point-min))
6128 (while (re-search-forward org-radio-target-regexp nil t
)
6129 ;; Make sure point is really within the object.
6131 (let ((obj (org-element-context)))
6132 (when (eq (org-element-type obj
) 'radio-target
)
6133 (add-to-list 'rtn
(org-element-property :value obj
)))))
6135 (setq org-target-link-regexp
6140 (replace-regexp-in-string
6141 " +" "\\s-+" (regexp-quote x
) t t
))
6145 (unless (equal old-regexp org-target-link-regexp
)
6147 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6148 ((not org-target-link-regexp
) old-regexp
)
6153 (substring re
(length before-re
)
6154 (- (length after-re
))))
6155 (list old-regexp org-target-link-regexp
)
6158 (org-with-wide-buffer
6159 (goto-char (point-min))
6160 (while (re-search-forward regexp nil t
)
6161 (org-element-cache-refresh (match-beginning 1)))))
6162 ;; Re fontify buffer.
6163 (when (memq 'radio org-highlight-links
)
6164 (org-restart-font-lock)))))
6166 (defun org-hide-wide-columns (limit)
6168 (setq s
(text-property-any (point) (or limit
(point-max))
6171 (setq e
(next-single-property-change s
'org-cwidth
))
6172 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
6176 (defvar org-latex-and-related-regexp nil
6177 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6179 (defun org-compute-latex-and-related-regexp ()
6180 "Compute regular expression for LaTeX, entities and sub/superscript.
6181 Result depends on variable `org-highlight-latex-and-related'."
6183 'org-latex-and-related-regexp
6185 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6186 ((eq org-use-sub-superscripts
'{})
6187 (list org-match-substring-with-braces-regexp
))
6188 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6190 (when (memq 'latex org-highlight-latex-and-related
)
6191 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6194 (and (member (car x
) matchers
) (nth 1 x
)))
6195 org-latex-regexps
)))))
6197 (when (memq 'entities org-highlight-latex-and-related
)
6198 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6199 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6201 (defun org-do-latex-and-related (limit)
6202 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6203 LIMIT bounds the search for syntax to highlight. Stop at first
6204 highlighted object, if any. Return t if some highlighting was
6205 done, nil otherwise."
6206 (when (org-string-nw-p org-latex-and-related-regexp
)
6208 (while (re-search-forward org-latex-and-related-regexp limit t
)
6209 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6211 '(org-code org-verbatim underline
))
6212 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6216 (font-lock-prepend-text-property
6217 (+ offset
(match-beginning 0)) (match-end 0)
6218 'face
'org-latex-and-related
)
6219 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6220 '(font-lock-multiline t
)))
6224 (defun org-restart-font-lock ()
6225 "Restart `font-lock-mode', to force refontification."
6226 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6228 (font-lock-mode 1)))
6230 (defun org-activate-tags (limit)
6231 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
6233 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6234 (add-text-properties (match-beginning 1) (match-end 1)
6235 (list 'mouse-face
'highlight
6236 'keymap org-mouse-map
))
6237 (org-rear-nonsticky-at (match-end 1))
6240 (defun org-outline-level ()
6241 "Compute the outline level of the heading at point.
6243 If this is called at a normal headline, the level is the number
6244 of stars. Use `org-reduced-level' to remove the effect of
6245 `org-odd-levels'. Unlike to `org-current-level', this function
6246 takes into consideration inlinetasks."
6247 (org-with-wide-buffer
6249 (if (re-search-backward org-outline-regexp-bol nil t
)
6250 (1- (- (match-end 0) (match-beginning 0)))
6253 (defvar org-font-lock-keywords nil
)
6255 (defsubst org-re-property
(property &optional literal allow-null
)
6256 "Return a regexp matching a PROPERTY line.
6258 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6259 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6260 non-nil, match properties even without a value.
6262 Match group 3 is set to the value when it exists. If there is no
6263 value and ALLOW-NULL is non-nil, it is set to the empty string."
6266 (format "\\(?1::\\(?2:%s\\):\\)"
6267 (if literal property
(regexp-quote property
)))
6269 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6270 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6272 (defconst org-property-re
6273 (org-re-property "\\S-+" 'literal t
)
6274 "Regular expression matching a property line.
6275 There are four matching groups:
6276 1: :PROPKEY: including the leading and trailing colon,
6277 2: PROPKEY without the leading and trailing colon,
6278 3: PROPVAL without leading or trailing spaces,
6279 4: the indentation of the current line,
6280 5: trailing whitespace.")
6282 (defvar org-font-lock-hook nil
6283 "Functions to be called for special font lock stuff.")
6285 (defvar org-font-lock-set-keywords-hook nil
6286 "Functions that can manipulate `org-font-lock-extra-keywords'.
6287 This is called after `org-font-lock-extra-keywords' is defined, but before
6288 it is installed to be used by font lock. This can be useful if something
6289 needs to be inserted at a specific position in the font-lock sequence.")
6291 (defun org-font-lock-hook (limit)
6292 "Run `org-font-lock-hook' within LIMIT."
6293 (run-hook-with-args 'org-font-lock-hook limit
))
6295 (defun org-set-font-lock-defaults ()
6296 "Set font lock defaults for the current buffer."
6297 (let* ((em org-fontify-emphasized-text
)
6298 (lk org-highlight-links
)
6299 (org-font-lock-extra-keywords
6302 '(org-font-lock-hook)
6304 `(,(if org-fontify-whole-heading-line
6305 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6306 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6307 (1 (org-get-level-face 1))
6308 (2 (org-get-level-face 2))
6309 (3 (org-get-level-face 3)))
6311 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6314 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6315 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6316 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6317 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6319 '(org-fontify-drawers)
6321 (list org-property-re
6322 '(1 'org-special-keyword t
)
6323 '(3 'org-property-value t
))
6325 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6326 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6327 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6328 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6329 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6330 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6331 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6333 (list org-any-target-regexp
'(0 'org-target t
))
6335 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6337 '(org-fontify-macros)
6338 '(org-hide-wide-columns (0 nil append
))
6340 (list (format org-heading-keyword-regexp-format
6342 '(2 (org-get-todo-face 2) t
))
6344 (if org-fontify-done-headline
6345 (list (format org-heading-keyword-regexp-format
6348 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6350 '(2 'org-headline-done t
))
6353 '(org-font-lock-add-priority-faces)
6355 '(org-font-lock-add-tag-faces)
6357 (if (and org-group-tags org-tag-groups-alist
)
6358 (list (concat org-outline-regexp-bol
".+\\(:"
6359 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6361 '(1 'org-tag-group prepend
)))
6363 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6364 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6365 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6366 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6367 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6370 (if (featurep 'xemacs
)
6371 '(org-do-emphasis-faces (0 nil append
))
6372 '(org-do-emphasis-faces)))
6374 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6375 1 'org-checkbox prepend
)
6376 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6377 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6378 (0 (org-get-checkbox-statistics-face) t
)))
6379 ;; Description list items
6380 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6381 1 'org-list-dt prepend
)
6382 ;; ARCHIVEd headings
6384 org-outline-regexp-bol
6385 "\\(.*:" org-archive-tag
":.*\\)")
6386 '(1 'org-archived prepend
))
6388 '(org-do-latex-and-related)
6389 '(org-fontify-entities)
6390 '(org-raise-scripts)
6392 '(org-activate-code (1 'org-code t
))
6395 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6398 '(9 'org-special-keyword t
))
6399 ;; Blocks and meta lines
6400 '(org-fontify-meta-lines-and-blocks))))
6401 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6402 (run-hooks 'org-font-lock-set-keywords-hook
)
6403 ;; Now set the full font-lock-keywords
6404 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6405 (org-set-local 'font-lock-defaults
6406 '(org-font-lock-keywords t nil nil backward-paragraph
))
6407 (kill-local-variable 'font-lock-keywords
) nil
))
6409 (defun org-toggle-pretty-entities ()
6410 "Toggle the composition display of entities as UTF8 characters."
6412 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6413 (org-restart-font-lock)
6414 (if org-pretty-entities
6415 (message "Entities are now displayed as UTF8 characters")
6418 (org-decompose-region (point-min) (point-max))
6419 (message "Entities are now displayed as plain text"))))
6421 (defvar org-custom-properties-overlays nil
6422 "List of overlays used for custom properties.")
6423 (make-variable-buffer-local 'org-custom-properties-overlays
)
6425 (defun org-toggle-custom-properties-visibility ()
6426 "Display or hide properties in `org-custom-properties'."
6428 (if org-custom-properties-overlays
6429 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6430 (setq org-custom-properties-overlays nil
))
6431 (when org-custom-properties
6432 (org-with-wide-buffer
6433 (goto-char (point-min))
6434 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6435 (while (re-search-forward regexp nil t
)
6436 (let ((end (cdr (save-match-data (org-get-property-block)))))
6437 (when (and end
(< (point) end
))
6438 ;; Hide first custom property in current drawer.
6439 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6440 (overlay-put o
'invisible t
)
6441 (overlay-put o
'org-custom-property t
)
6442 (push o org-custom-properties-overlays
))
6443 ;; Hide additional custom properties in the same drawer.
6444 (while (re-search-forward regexp end t
)
6445 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6446 (overlay-put o
'invisible t
)
6447 (overlay-put o
'org-custom-property t
)
6448 (push o org-custom-properties-overlays
)))))
6449 ;; Each entry is limited to a single property drawer.
6450 (outline-next-heading)))))))
6452 (defun org-fontify-entities (limit)
6453 "Find an entity to fontify."
6455 (when org-pretty-entities
6457 (while (re-search-forward
6458 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6460 (if (and (not (org-at-comment-p))
6461 (setq ee
(org-entity-get (match-string 1)))
6462 (= (length (nth 6 ee
)) 1))
6464 ((end (if (equal (match-string 2) "{}")
6467 (add-text-properties
6468 (match-beginning 0) end
6469 (list 'font-lock-fontified t
))
6470 (compose-region (match-beginning 0) end
6476 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6477 "Fontify string S like in Org-mode."
6480 (let ((org-odd-levels-only odd-levels
))
6488 (defun org-get-level-face (n)
6489 "Get the right face for match N in font-lock matching of headlines."
6490 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6491 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6492 (if org-cycle-level-faces
6493 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6494 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6496 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6498 (t (if org-level-color-stars-only nil org-f
))))
6501 (defun org-get-todo-face (kwd)
6502 "Get the right face for a TODO keyword KWD.
6503 If KWD is a number, get the corresponding match group."
6504 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6505 (or (org-face-from-face-or-color
6506 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6507 (and (member kwd org-done-keywords
) 'org-done
)
6510 (defun org-face-from-face-or-color (context inherit face-or-color
)
6511 "Create a face list that inherits INHERIT, but sets the foreground color.
6512 When FACE-OR-COLOR is not a string, just return it."
6513 (if (stringp face-or-color
)
6514 (list :inherit inherit
6515 (cdr (assoc context org-faces-easy-properties
))
6519 (defun org-font-lock-add-tag-faces (limit)
6520 "Add the special tag faces."
6521 (when (and org-tag-faces org-tags-special-faces-re
)
6522 (while (re-search-forward org-tags-special-faces-re limit t
)
6523 (add-text-properties (match-beginning 1) (match-end 1)
6524 (list 'face
(org-get-tag-face 1)
6525 'font-lock-fontified t
))
6526 (backward-char 1))))
6528 (defun org-font-lock-add-priority-faces (limit)
6529 "Add the special priority faces."
6530 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
6531 (when (save-match-data (org-at-heading-p))
6532 (add-text-properties
6533 (match-beginning 0) (match-end 0)
6534 (list 'face
(or (org-face-from-face-or-color
6535 'priority
'org-priority
6536 (cdr (assoc (char-after (match-beginning 1))
6537 org-priority-faces
)))
6539 'font-lock-fontified t
)))))
6541 (defun org-get-tag-face (kwd)
6542 "Get the right face for a TODO keyword KWD.
6543 If KWD is a number, get the corresponding match group."
6544 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6545 (or (org-face-from-face-or-color
6546 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
6549 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
6550 "Remove fontification and activation overlays from links."
6551 (font-lock-default-unfontify-region beg end
)
6552 (let* ((buffer-undo-list t
)
6553 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6554 (inhibit-modification-hooks t
)
6555 deactivate-mark buffer-file-name buffer-file-truename
)
6556 (org-decompose-region beg end
)
6557 (remove-text-properties beg end
6558 '(mouse-face t keymap t org-linked-text t
6559 invisible t intangible t
6561 (org-remove-font-lock-display-properties beg end
)))
6563 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6564 ((raise 0.3) (height 0.7))
6567 "Display properties for showing superscripts and subscripts.")
6569 (defun org-remove-font-lock-display-properties (beg end
)
6570 "Remove specific display properties that have been added by font lock.
6571 The will remove the raise properties that are used to show superscripts
6575 (setq next
(next-single-property-change beg
'display nil end
)
6576 prop
(get-text-property beg
'display
))
6577 (if (member prop org-script-display
)
6578 (put-text-property beg next
'display nil
))
6581 (defun org-raise-scripts (limit)
6582 "Add raise properties to sub/superscripts."
6583 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
6584 (if (re-search-forward
6585 (if (eq org-use-sub-superscripts t
)
6586 org-match-substring-regexp
6587 org-match-substring-with-braces-regexp
)
6589 (let* ((pos (point)) table-p comment-p
6590 (mpos (match-beginning 3))
6591 (emph-p (get-text-property mpos
'org-emphasis
))
6592 (link-p (get-text-property mpos
'mouse-face
))
6593 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6594 (goto-char (point-at-bol))
6595 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
6596 comment-p
(org-looking-at-p "^[ \t]*#[ +]"))
6599 (if (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6600 (if (or comment-p emph-p link-p keyw-p
)
6602 (put-text-property (match-beginning 3) (match-end 0)
6604 (if (equal (char-after (match-beginning 2)) ?^
)
6605 (nth (if table-p
3 1) org-script-display
)
6606 (nth (if table-p
2 0) org-script-display
)))
6607 (add-text-properties (match-beginning 2) (match-end 2)
6609 'org-dwidth t
'org-dwidth-n
1))
6610 (if (and (eq (char-after (match-beginning 3)) ?
{)
6611 (eq (char-before (match-end 3)) ?
}))
6613 (add-text-properties
6614 (match-beginning 3) (1+ (match-beginning 3))
6615 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6616 (add-text-properties
6617 (1- (match-end 3)) (match-end 3)
6618 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
6621 ;;;; Visibility cycling, including org-goto and indirect buffer
6625 (defvar org-cycle-global-status nil
)
6626 (make-variable-buffer-local 'org-cycle-global-status
)
6627 (put 'org-cycle-global-status
'org-state t
)
6628 (defvar org-cycle-subtree-status nil
)
6629 (make-variable-buffer-local 'org-cycle-subtree-status
)
6630 (put 'org-cycle-subtree-status
'org-state t
)
6632 (defvar org-inlinetask-min-level
)
6634 (defun org-unlogged-message (&rest args
)
6635 "Display a message, but avoid logging it in the *Messages* buffer."
6636 (let ((message-log-max nil
))
6637 (apply 'message args
)))
6640 (defun org-cycle (&optional arg
)
6641 "TAB-action and visibility cycling for Org-mode.
6643 This is the command invoked in Org-mode by the TAB key. Its main purpose
6644 is outline visibility cycling, but it also invokes other actions
6645 in special contexts.
6647 - When this function is called with a prefix argument, rotate the entire
6648 buffer through 3 states (global cycling)
6649 1. OVERVIEW: Show only top-level headlines.
6650 2. CONTENTS: Show all headlines of all levels, but no body text.
6651 3. SHOW ALL: Show everything.
6652 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6653 determined by the variable `org-startup-folded', and by any VISIBILITY
6654 properties in the buffer.
6655 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6656 including any drawers.
6658 - When inside a table, re-align the table and move to the next field.
6660 - When point is at the beginning of a headline, rotate the subtree started
6661 by this line through 3 different states (local cycling)
6662 1. FOLDED: Only the main headline is shown.
6663 2. CHILDREN: The main headline and the direct children are shown.
6664 From this state, you can move to one of the children
6665 and zoom in further.
6666 3. SUBTREE: Show the entire subtree, including body text.
6667 If there is no subtree, switch directly from CHILDREN to FOLDED.
6669 - When point is at the beginning of an empty headline and the variable
6670 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6671 of the headline by demoting and promoting it to likely levels. This
6672 speeds up creation document structure by pressing TAB once or several
6673 times right after creating a new headline.
6675 - When there is a numeric prefix, go up to a heading with level ARG, do
6676 a `show-subtree' and return to the previous cursor position. If ARG
6677 is negative, go up that many levels.
6679 - When point is not at the beginning of a headline, execute the global
6680 binding for TAB, which is re-indenting the line. See the option
6681 `org-cycle-emulate-tab' for details.
6683 - Special case: if point is at the beginning of the buffer and there is
6684 no headline in line 1, this function will act as if called with prefix arg
6685 (C-u TAB, same as S-TAB) also when called without prefix arg.
6686 But only if also the variable `org-cycle-global-at-bob' is t."
6688 (org-load-modules-maybe)
6689 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6690 (and org-cycle-level-after-item
/entry-creation
6691 (or (org-cycle-level)
6692 (org-cycle-item-indentation))))
6694 (or org-cycle-max-level
6695 (and (boundp 'org-inlinetask-min-level
)
6696 org-inlinetask-min-level
6697 (1- org-inlinetask-min-level
))))
6698 (nstars (and limit-level
6699 (if org-odd-levels-only
6700 (and limit-level
(1- (* limit-level
2)))
6703 (if (not (derived-mode-p 'org-mode
))
6705 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6706 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6707 (not (looking-at org-outline-regexp
))))
6710 (delq 'org-optimize-window-after-visibility-change
6711 (copy-sequence org-cycle-hook
))
6715 (if (or bob-special
(equal arg
'(4)))
6716 ;; special case: use global cycling
6722 (setq last-command
'dummy
)
6723 (org-set-startup-visibility)
6724 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6728 (org-unlogged-message "Entire buffer visible, including drawers"))
6730 ;; Try cdlatex TAB completion
6731 ((org-try-cdlatex-tab))
6733 ;; Table: enter it or move to the next field.
6734 ((org-at-table-p 'any
)
6735 (if (org-at-table.el-p
)
6736 (message "Use C-c ' to edit table.el tables")
6737 (if arg
(org-table-edit-field t
)
6738 (org-table-justify-field-maybe)
6739 (call-interactively 'org-table-next-field
))))
6741 ((run-hook-with-args-until-success
6742 'org-tab-after-check-for-table-hook
))
6744 ;; Global cycling: delegate to `org-cycle-internal-global'.
6745 ((eq arg t
) (org-cycle-internal-global))
6747 ;; Drawers: delegate to `org-flag-drawer'.
6749 (beginning-of-line 1)
6750 (looking-at org-drawer-regexp
))
6751 (org-flag-drawer ; toggle block visibility
6752 (not (get-char-property (match-end 0) 'invisible
))))
6754 ;; Show-subtree, ARG levels up from here.
6757 (org-back-to-heading)
6758 (outline-up-heading (if (< arg
0) (- arg
)
6759 (- (funcall outline-level
) arg
)))
6760 (org-show-subtree)))
6762 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6763 ((and (featurep 'org-inlinetask
)
6764 (org-inlinetask-at-task-p)
6765 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6766 (org-inlinetask-toggle-visibility))
6768 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6769 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
6770 (save-excursion (beginning-of-line 1)
6771 (looking-at org-outline-regexp
)))
6772 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6773 (org-cycle-internal-local))
6775 ;; From there: TAB emulation and template completion.
6776 (buffer-read-only (org-back-to-heading))
6778 ((run-hook-with-args-until-success
6779 'org-tab-after-check-for-cycling-hook
))
6781 ((org-try-structure-completion))
6783 ((run-hook-with-args-until-success
6784 'org-tab-before-tab-emulation-hook
))
6786 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6788 (not (looking-at org-outline-regexp
))))
6789 (call-interactively (global-key-binding "\t")))
6791 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6792 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6793 (or (and (eq org-cycle-emulate-tab
'white
)
6794 (= (match-end 0) (point-at-eol)))
6795 (and (eq org-cycle-emulate-tab
'whitestart
)
6796 (>= (match-end 0) pos
))))
6798 (eq org-cycle-emulate-tab t
))
6799 (call-interactively (global-key-binding "\t")))
6802 (org-back-to-heading)
6805 (defun org-cycle-internal-global ()
6806 "Do the global cycling action."
6807 ;; Hack to avoid display of messages for .org attachments in Gnus
6808 (let ((ga (string-match "\\*fontification" (buffer-name))))
6810 ((and (eq last-command this-command
)
6811 (eq org-cycle-global-status
'overview
))
6812 ;; We just created the overview - now do table of contents
6813 ;; This can be slow in very large buffers, so indicate action
6814 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6815 (unless ga
(org-unlogged-message "CONTENTS..."))
6817 (unless ga
(org-unlogged-message "CONTENTS...done"))
6818 (setq org-cycle-global-status
'contents
)
6819 (run-hook-with-args 'org-cycle-hook
'contents
))
6821 ((and (eq last-command this-command
)
6822 (eq org-cycle-global-status
'contents
))
6823 ;; We just showed the table of contents - now show everything
6824 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6826 (unless ga
(org-unlogged-message "SHOW ALL"))
6827 (setq org-cycle-global-status
'all
)
6828 (run-hook-with-args 'org-cycle-hook
'all
))
6831 ;; Default action: go to overview
6832 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6834 (unless ga
(org-unlogged-message "OVERVIEW"))
6835 (setq org-cycle-global-status
'overview
)
6836 (run-hook-with-args 'org-cycle-hook
'overview
)))))
6838 (defvar org-called-with-limited-levels nil
6839 "Non-nil when `org-with-limited-levels' is currently active.")
6841 (defun org-cycle-internal-local ()
6842 "Do the local cycling action."
6843 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6844 ;; First, determine end of headline (EOH), end of subtree or item
6845 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6850 (setq struct
(org-list-struct))
6851 (setq eoh
(point-at-eol))
6852 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6853 (setq has-children
(org-list-has-child-p (point) struct
)))
6854 (org-back-to-heading)
6855 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6856 (setq eos
(save-excursion (org-end-of-subtree t t
)
6857 (when (bolp) (backward-char)) (point)))
6860 (let ((level (funcall outline-level
)))
6861 (outline-next-heading)
6862 (and (org-at-heading-p t
)
6863 (> (funcall outline-level
) level
))))
6865 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6866 ;; Determine end invisible part of buffer (EOL)
6867 (beginning-of-line 2)
6868 ;; XEmacs doesn't have `next-single-char-property-change'
6869 (if (featurep 'xemacs
)
6870 (while (and (not (eobp)) ;; this is like `next-line'
6871 (get-char-property (1- (point)) 'invisible
))
6872 (beginning-of-line 2))
6873 (while (and (not (eobp)) ;; this is like `next-line'
6874 (get-char-property (1- (point)) 'invisible
))
6875 (goto-char (next-single-char-property-change (point) 'invisible
))
6876 (and (eolp) (beginning-of-line 2))))
6878 ;; Find out what to do next and set `this-command'
6881 ;; Nothing is hidden behind this heading
6882 (unless (org-before-first-heading-p)
6883 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
6884 (org-unlogged-message "EMPTY ENTRY")
6885 (setq org-cycle-subtree-status nil
)
6888 (outline-next-heading)
6889 (if (outline-invisible-p) (org-flag-heading nil
))))
6890 ((and (or (>= eol eos
)
6891 (not (string-match "\\S-" (buffer-substring eol eos
))))
6893 (not (setq children-skipped
6894 org-cycle-skip-children-state-if-no-children
))))
6895 ;; Entire subtree is hidden in one line: children view
6896 (unless (org-before-first-heading-p)
6897 (run-hook-with-args 'org-pre-cycle-hook
'children
))
6899 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6901 (org-with-limited-levels (show-children))
6902 ;; FIXME: This slows down the func way too much.
6903 ;; How keep drawers hidden in subtree anyway?
6904 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6905 ;; (org-cycle-hide-drawers 'subtree))
6907 ;; Fold every list in subtree to top-level items.
6908 (when (eq org-cycle-include-plain-lists
'integrate
)
6910 (org-back-to-heading)
6911 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6912 (beginning-of-line 1)
6913 (let* ((struct (org-list-struct))
6914 (prevs (org-list-prevs-alist struct
))
6915 (end (org-list-get-bottom-point struct
)))
6916 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6917 (org-list-get-all-items (point) struct prevs
))
6918 (goto-char (if (< end eos
) end eos
)))))))
6919 (org-unlogged-message "CHILDREN")
6922 (outline-next-heading)
6923 (if (outline-invisible-p) (org-flag-heading nil
)))
6924 (setq org-cycle-subtree-status
'children
)
6925 (unless (org-before-first-heading-p)
6926 (run-hook-with-args 'org-cycle-hook
'children
)))
6927 ((or children-skipped
6928 (and (eq last-command this-command
)
6929 (eq org-cycle-subtree-status
'children
)))
6930 ;; We just showed the children, or no children are there,
6931 ;; now show everything.
6932 (unless (org-before-first-heading-p)
6933 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
6934 (outline-flag-region eoh eos nil
)
6935 (org-unlogged-message
6936 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6937 (setq org-cycle-subtree-status
'subtree
)
6938 (unless (org-before-first-heading-p)
6939 (run-hook-with-args 'org-cycle-hook
'subtree
)))
6941 ;; Default action: hide the subtree.
6942 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6943 (outline-flag-region eoh eos t
)
6944 (org-unlogged-message "FOLDED")
6945 (setq org-cycle-subtree-status
'folded
)
6946 (unless (org-before-first-heading-p)
6947 (run-hook-with-args 'org-cycle-hook
'folded
))))))
6950 (defun org-global-cycle (&optional arg
)
6951 "Cycle the global visibility. For details see `org-cycle'.
6952 With \\[universal-argument] prefix arg, switch to startup visibility.
6953 With a numeric prefix, show all headlines up to that level."
6955 (let ((org-cycle-include-plain-lists
6956 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
6960 (hide-sublevels arg
)
6961 (setq org-cycle-global-status
'contents
))
6963 (org-set-startup-visibility)
6964 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6966 (org-cycle '(4))))))
6968 (defun org-set-startup-visibility ()
6969 "Set the visibility required by startup options and properties."
6971 ((eq org-startup-folded t
)
6973 ((eq org-startup-folded
'content
)
6975 ((or (eq org-startup-folded
'showeverything
)
6976 (eq org-startup-folded nil
))
6978 (unless (eq org-startup-folded
'showeverything
)
6979 (if org-hide-block-startup
(org-hide-block-all))
6980 (org-set-visibility-according-to-property 'no-cleanup
)
6981 (org-cycle-hide-archived-subtrees 'all
)
6982 (org-cycle-hide-drawers 'all
)
6983 (org-cycle-show-empty-lines t
)))
6985 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
6986 "Switch subtree visibilities according to :VISIBILITY: property."
6988 (let (org-show-entry-below)
6989 (org-with-wide-buffer
6990 (goto-char (point-min))
6991 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t
)
6992 (if (not (org-at-property-p)) (outline-next-heading)
6993 (let ((state (match-string 3)))
6995 (org-back-to-heading t
)
6999 ((equal state
"folded")
7001 ((equal state
"children")
7002 (org-show-hidden-entry)
7004 ((equal state
"content")
7007 (org-narrow-to-subtree)
7009 ((member state
'("all" "showall"))
7010 (show-subtree)))))))
7012 (org-cycle-hide-archived-subtrees 'all
)
7013 (org-cycle-hide-drawers 'all
)
7014 (org-cycle-show-empty-lines 'all
)))))
7016 ;; This function uses outline-regexp instead of the more fundamental
7017 ;; org-outline-regexp so that org-cycle-global works outside of Org
7018 ;; buffers, where outline-regexp is needed.
7019 (defun org-overview ()
7020 "Switch to overview mode, showing only top-level headlines.
7021 This shows all headlines with a level equal or greater than the level
7022 of the first headline in the buffer. This is important, because if the
7023 first headline is not level one, then (hide-sublevels 1) gives confusing
7029 (goto-char (point-min))
7030 (if (re-search-forward (concat "^" outline-regexp
) nil t
)
7032 (goto-char (match-beginning 0))
7033 (funcall outline-level
))))))
7034 (and level
(hide-sublevels level
)))))
7036 (defun org-content (&optional arg
)
7037 "Show all headlines in the buffer, like a table of contents.
7038 With numerical argument N, show content up to level N."
7042 ;; Visit all headings and show their offspring
7043 (and (integerp arg
) (org-overview))
7044 (goto-char (point-max))
7046 (while (and (progn (condition-case nil
7047 (outline-previous-visible-heading 1)
7048 (error (goto-char (point-min))))
7050 (looking-at org-outline-regexp
))
7052 (show-children (1- arg
))
7054 (if (bobp) (throw 'exit nil
))))))
7056 (defun org-optimize-window-after-visibility-change (state)
7057 "Adjust the window after a change in outline visibility.
7058 This function is the default value of the hook `org-cycle-hook'."
7059 (when (get-buffer-window (current-buffer))
7061 ((eq state
'content
) nil
)
7062 ((eq state
'all
) nil
)
7063 ((eq state
'folded
) nil
)
7064 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7065 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7067 (defun org-remove-empty-overlays-at (pos)
7068 "Remove outline overlays that do not contain non-white stuff."
7071 (and (eq 'outline
(overlay-get o
'invisible
))
7072 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7074 (delete-overlay o
)))
7077 (defun org-clean-visibility-after-subtree-move ()
7078 "Fix visibility issues after moving a subtree."
7079 ;; First, find a reasonable region to look at:
7080 ;; Start two siblings above, end three below
7081 (let* ((beg (save-excursion
7082 (and (org-get-last-sibling)
7083 (org-get-last-sibling))
7085 (end (save-excursion
7086 (and (org-get-next-sibling)
7087 (org-get-next-sibling)
7088 (org-get-next-sibling))
7089 (if (org-at-heading-p)
7092 (level (looking-at "\\*+"))
7093 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
7096 (narrow-to-region beg end
)
7098 ;; Properly fold already folded siblings
7099 (goto-char (point-min))
7100 (while (re-search-forward re nil t
)
7101 (if (and (not (outline-invisible-p))
7103 (goto-char (point-at-eol)) (outline-invisible-p)))
7105 (org-cycle-show-empty-lines 'overview
)
7106 (org-cycle-hide-drawers 'overview
)))))
7108 (defun org-cycle-show-empty-lines (state)
7109 "Show empty lines above all visible headlines.
7110 The region to be covered depends on STATE when called through
7111 `org-cycle-hook'. Lisp program can use t for STATE to get the
7112 entire buffer covered. Note that an empty line is only shown if there
7113 are at least `org-cycle-separator-lines' empty lines before the headline."
7114 (when (not (= org-cycle-separator-lines
0))
7116 (let* ((n (abs org-cycle-separator-lines
))
7118 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7119 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7120 (t (let ((ns (number-to-string (- n
2))))
7121 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7122 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7125 ((memq state
'(overview contents t
))
7126 (setq beg
(point-min) end
(point-max)))
7127 ((memq state
'(children folded
))
7128 (setq beg
(point) end
(progn (org-end-of-subtree t t
)
7129 (beginning-of-line 2)
7133 (while (re-search-forward re end t
)
7134 (unless (get-char-property (match-end 1) 'invisible
)
7135 (setq e
(match-end 1))
7136 (if (< org-cycle-separator-lines
0)
7137 (setq b
(save-excursion
7138 (goto-char (match-beginning 0))
7139 (org-back-over-empty-lines)
7141 (goto-char (max (point-min) (1- (point))))
7145 (setq b
(match-beginning 1)))
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-cycle-hide-inline-tasks (state)
7208 "Re-hide inline tasks when switching to 'contents or 'children
7212 (when (org-bound-and-true-p org-inlinetask-min-level
)
7213 (hide-sublevels (1- org-inlinetask-min-level
))))
7215 (when (featurep 'org-inlinetask
)
7217 (while (and (outline-next-heading)
7218 (org-inlinetask-at-task-p))
7219 (org-inlinetask-toggle-visibility)
7220 (org-inlinetask-goto-end)))))))
7222 (defun org-flag-drawer (flag &optional element
)
7223 "When FLAG is non-nil, hide the drawer we are at.
7224 Otherwise make it visible. When optional argument ELEMENT is
7225 a parsed drawer, as returned by `org-element-at-point', hide or
7226 show that drawer instead."
7227 (when (save-excursion
7229 (org-looking-at-p org-drawer-regexp
))
7230 (let ((drawer (or element
(org-element-at-point))))
7231 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7232 (let ((post (org-element-property :post-affiliated drawer
)))
7234 (outline-flag-region
7235 (progn (goto-char post
) (line-end-position))
7236 (progn (goto-char (org-element-property :end drawer
))
7237 (skip-chars-backward " \r\t\n")
7238 (line-end-position))
7240 ;; When the drawer is hidden away, make sure point lies in
7241 ;; a visible part of the buffer.
7242 (when (and flag
(> (line-beginning-position) post
))
7243 (goto-char post
)))))))
7245 (defun org-subtree-end-visible-p ()
7246 "Is the end of the current subtree visible?"
7247 (pos-visible-in-window-p
7248 (save-excursion (org-end-of-subtree t
) (point))))
7250 (defun org-first-headline-recenter ()
7251 "Move cursor to the first headline and recenter the headline."
7252 (goto-char (point-min))
7253 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7254 (set-window-start (selected-window) (point-at-bol))))
7256 ;;; Saving and restoring visibility
7258 (defun org-outline-overlay-data (&optional use-markers
)
7259 "Return a list of the locations of all outline overlays.
7260 These are overlays with the `invisible' property value `outline'.
7261 The return value is a list of cons cells, with start and stop
7262 positions for each overlay.
7263 If USE-MARKERS is set, return the positions as markers."
7270 (when (eq (overlay-get o
'invisible
) 'outline
)
7271 (setq beg
(overlay-start o
)
7272 end
(overlay-end o
))
7273 (and beg end
(> end beg
)
7275 (cons (copy-marker beg
)
7276 (copy-marker end t
))
7278 (overlays-in (point-min) (point-max))))))))
7280 (defun org-set-outline-overlay-data (data)
7281 "Create visibility overlays for all positions in DATA.
7282 DATA should have been made by `org-outline-overlay-data'."
7289 (outline-flag-region (car c
) (cdr c
) t
))
7292 ;;; Folding of blocks
7294 (defvar org-hide-block-overlays nil
7295 "Overlays hiding blocks.")
7296 (make-variable-buffer-local 'org-hide-block-overlays
)
7298 (defun org-block-map (function &optional start end
)
7299 "Call FUNCTION at the head of all source blocks in the current buffer.
7300 Optional arguments START and END can be used to limit the range."
7301 (let ((start (or start
(point-min)))
7302 (end (or end
(point-max))))
7305 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7308 (goto-char (match-beginning 0))
7309 (funcall function
)))))))
7311 (defun org-hide-block-toggle-all ()
7312 "Toggle the visibility of all blocks in the current buffer."
7313 (org-block-map 'org-hide-block-toggle
))
7315 (defun org-hide-block-all ()
7316 "Fold all blocks in the current buffer."
7318 (org-show-block-all)
7319 (org-block-map 'org-hide-block-toggle-maybe
))
7321 (defun org-show-block-all ()
7322 "Unfold all blocks in the current buffer."
7324 (mapc 'delete-overlay org-hide-block-overlays
)
7325 (setq org-hide-block-overlays nil
))
7327 (defun org-hide-block-toggle-maybe ()
7328 "Toggle visibility of block at point.
7329 Unlike to `org-hide-block-toggle', this function does not throw
7330 an error. Return a non-nil value when toggling is successful."
7332 (ignore-errors (org-hide-block-toggle)))
7334 (defun org-hide-block-toggle (&optional force
)
7335 "Toggle the visibility of the current block.
7336 When optional argument FORCE is `off', make block visible. If it
7337 is non-nil, hide it unconditionally. Throw an error when not at
7338 a block. Return a non-nil value when toggling is successful."
7340 (let ((element (org-element-at-point)))
7341 (unless (memq (org-element-type element
)
7342 '(center-block comment-block dynamic-block example-block
7343 export-block quote-block special-block
7344 src-block verse-block
))
7345 (user-error "Not at a block"))
7346 (let* ((start (save-excursion
7347 (goto-char (org-element-property :post-affiliated element
))
7348 (line-end-position)))
7349 (end (save-excursion
7350 (goto-char (org-element-property :end element
))
7351 (skip-chars-backward " \r\t\n")
7352 (line-end-position)))
7353 (overlays (overlays-at start
)))
7355 ;; Do nothing when not before or at the block opening line or
7356 ;; at the block closing line.
7357 ((let ((eol (line-end-position))) (and (> eol start
) (/= eol end
))) nil
)
7358 ((and (not (eq force
'off
))
7359 (not (memq t
(mapcar
7361 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7363 (let ((ov (make-overlay start end
)))
7364 (overlay-put ov
'invisible
'org-hide-block
)
7365 ;; Make the block accessible to `isearch'.
7367 ov
'isearch-open-invisible
7369 (when (memq ov org-hide-block-overlays
)
7370 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7371 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7372 (delete-overlay ov
))))
7373 (push ov org-hide-block-overlays
)
7374 ;; When the block is hidden away, make sure point is left in
7375 ;; a visible part of the buffer.
7376 (when (> (line-beginning-position) start
)
7378 (beginning-of-line))
7379 ;; Signal successful toggling.
7381 ((or (not force
) (eq force
'off
))
7382 (dolist (ov overlays t
)
7383 (when (memq ov org-hide-block-overlays
)
7384 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7385 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7386 (delete-overlay ov
))))))))
7388 ;; org-tab-after-check-for-cycling-hook
7389 (add-hook 'org-tab-first-hook
'org-hide-block-toggle-maybe
)
7390 ;; Remove overlays when changing major mode
7391 (add-hook 'org-mode-hook
7392 (lambda () (org-add-hook 'change-major-mode-hook
7393 'org-show-block-all
'append
'local
)))
7397 (defvar org-goto-window-configuration nil
)
7398 (defvar org-goto-marker nil
)
7399 (defvar org-goto-map
)
7400 (defun org-goto-map ()
7401 "Set the keymap `org-goto'."
7403 (let ((map (make-sparse-keymap)))
7404 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7405 mouse-drag-region universal-argument org-occur
))
7407 (while (setq cmd
(pop cmds
))
7408 (substitute-key-definition cmd cmd map global-map
)))
7409 (suppress-keymap map
)
7410 (org-defkey map
"\C-m" 'org-goto-ret
)
7411 (org-defkey map
[(return)] 'org-goto-ret
)
7412 (org-defkey map
[(left)] 'org-goto-left
)
7413 (org-defkey map
[(right)] 'org-goto-right
)
7414 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
7415 (org-defkey map
"\C-i" 'org-cycle
)
7416 (org-defkey map
[(tab)] 'org-cycle
)
7417 (org-defkey map
[(down)] 'outline-next-visible-heading
)
7418 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
7419 (if org-goto-auto-isearch
7420 (if (fboundp 'define-key-after
)
7421 (define-key-after map
[t] 'org-goto-local-auto-isearch)
7423 (org-defkey map "q" 'org-goto-quit)
7424 (org-defkey map "n" 'outline-next-visible-heading)
7425 (org-defkey map "p" 'outline-previous-visible-heading)
7426 (org-defkey map "f" 'outline-forward-same-level)
7427 (org-defkey map "b" 'outline-backward-same-level)
7428 (org-defkey map "u" 'outline-up-heading))
7429 (org-defkey map "/" 'org-occur)
7430 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7431 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7432 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7433 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7434 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7437 (defconst org-goto-help
7438 "Browse buffer copy, to find location or copy text.%s
7439 RET=jump to location C-g=quit and return to previous location
7440 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7442 (defvar org-goto-start-pos) ; dynamically scoped parameter
7444 (defun org-goto (&optional alternative-interface)
7445 "Look up a different location in the current file, keeping current visibility.
7447 When you want look-up or go to a different location in a
7448 document, the fastest way is often to fold the entire buffer and
7449 then dive into the tree. This method has the disadvantage, that
7450 the previous location will be folded, which may not be what you
7453 This command works around this by showing a copy of the current
7454 buffer in an indirect buffer, in overview mode. You can dive
7455 into the tree in that copy, use org-occur and incremental search
7456 to find a location. When pressing RET or `Q', the command
7457 returns to the original buffer in which the visibility is still
7458 unchanged. After RET it will also jump to the location selected
7459 in the indirect buffer and expose the headline hierarchy above.
7461 With a prefix argument, use the alternative interface: e.g. if
7462 `org-goto-interface' is 'outline use 'outline-path-completion."
7465 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7466 (org-refile-use-outline-path t)
7467 (org-refile-target-verify-function nil)
7469 (if (not alternative-interface)
7471 (if (eq org-goto-interface 'outline)
7472 'outline-path-completion
7474 (org-goto-start-pos (point))
7476 (if (eq interface 'outline)
7477 (car (org-get-location (current-buffer) org-goto-help))
7478 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7479 (org-refile-check-position pa)
7483 (org-mark-ring-push org-goto-start-pos)
7484 (goto-char selected-point)
7485 (if (or (outline-invisible-p) (org-invisible-p2))
7486 (org-show-context 'org-goto)))
7489 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7490 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7491 (defvar org-goto-local-auto-isearch-map) ; defined below
7493 (defun org-get-location (buf help)
7494 "Let the user select a location in the Org-mode buffer BUF.
7495 This function uses a recursive edit. It returns the selected position
7498 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7499 (isearch-hide-immediately nil)
7500 (isearch-search-fun-function
7501 (lambda () 'org-goto-local-search-headings))
7502 (org-goto-selected-point org-goto-exit-command))
7504 (save-window-excursion
7505 (delete-other-windows)
7506 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7507 (org-pop-to-buffer-same-window
7509 (make-indirect-buffer (current-buffer) "*org-goto*")
7510 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7511 (with-output-to-temp-buffer "*Org Help*"
7512 (princ (format help (if org-goto-auto-isearch
7513 " Just type for auto-isearch."
7514 " n/p/f/b/u to navigate, q to quit."))))
7515 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7516 (setq buffer-read-only nil)
7517 (let ((org-startup-truncated t)
7518 (org-startup-folded nil)
7519 (org-startup-align-all-tables nil))
7522 (setq buffer-read-only t)
7523 (if (and (boundp 'org-goto-start-pos)
7524 (integer-or-marker-p org-goto-start-pos))
7525 (let ((org-show-hierarchy-above t)
7526 (org-show-siblings t)
7527 (org-show-following-heading t))
7528 (goto-char org-goto-start-pos)
7529 (and (outline-invisible-p) (org-show-context)))
7530 (goto-char (point-min)))
7531 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7532 (message "Select location and press RET")
7533 (use-local-map org-goto-map)
7535 (kill-buffer "*org-goto*")
7536 (cons org-goto-selected-point org-goto-exit-command))))
7538 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7539 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7540 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7541 (if (fboundp 'isearch-other-control-char)
7543 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7544 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7545 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7546 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7547 (define-key org-goto-local-auto-isearch-map [return] nil))
7549 (defun org-goto-local-search-headings (string bound noerror)
7550 "Search and make sure that any matches are in headlines."
7552 (while (if isearch-forward
7553 (search-forward string bound noerror)
7554 (search-backward string bound noerror))
7555 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7556 (and (member :headline context)
7557 (not (member :tags context))))
7558 (throw 'return (point))))))
7560 (defun org-goto-local-auto-isearch ()
7563 (goto-char (point-min))
7564 (let ((keys (this-command-keys)))
7565 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7567 (isearch-process-search-char (string-to-char keys)))))
7569 (defun org-goto-ret (&optional arg)
7570 "Finish `org-goto' by going to the new location."
7572 (setq org-goto-selected-point (point)
7573 org-goto-exit-command 'return)
7576 (defun org-goto-left ()
7577 "Finish `org-goto' by going to the new location."
7579 (if (org-at-heading-p)
7581 (beginning-of-line 1)
7582 (setq org-goto-selected-point (point)
7583 org-goto-exit-command 'left)
7585 (user-error "Not on a heading")))
7587 (defun org-goto-right ()
7588 "Finish `org-goto' by going to the new location."
7590 (if (org-at-heading-p)
7592 (setq org-goto-selected-point (point)
7593 org-goto-exit-command 'right)
7595 (user-error "Not on a heading")))
7597 (defun org-goto-quit ()
7598 "Finish `org-goto' without cursor motion."
7600 (setq org-goto-selected-point nil)
7601 (setq org-goto-exit-command 'quit)
7604 ;;; Indirect buffer display of subtrees
7606 (defvar org-indirect-dedicated-frame nil
7607 "This is the frame being used for indirect tree display.")
7608 (defvar org-last-indirect-buffer nil)
7610 (defun org-tree-to-indirect-buffer (&optional arg)
7611 "Create indirect buffer and narrow it to current subtree.
7612 With a numerical prefix ARG, go up to this level and then take that tree.
7613 If ARG is negative, go up that many levels.
7615 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7616 indirect buffer previously made with this command, to avoid proliferation of
7617 indirect buffers. However, when you call the command with a \
7618 \\[universal-argument] prefix, or
7619 when `org-indirect-buffer-display' is `new-frame', the last buffer
7620 is kept so that you can work with several indirect buffers at the same time.
7621 If `org-indirect-buffer-display' is `dedicated-frame', the \
7622 \\[universal-argument] prefix also
7623 requests that a new frame be made for the new buffer, so that the dedicated
7624 frame is not changed."
7626 (let ((cbuf (current-buffer))
7627 (cwin (selected-window))
7629 beg end level heading ibuf)
7631 (org-back-to-heading t)
7633 (setq level (org-outline-level))
7634 (if (< arg 0) (setq arg (+ level arg)))
7635 (while (> (setq level (org-outline-level)) arg)
7636 (org-up-heading-safe)))
7638 heading (org-get-heading))
7639 (org-end-of-subtree t t)
7640 (if (org-at-heading-p) (backward-char 1))
7642 (if (and (buffer-live-p org-last-indirect-buffer)
7643 (not (eq org-indirect-buffer-display 'new-frame))
7645 (kill-buffer org-last-indirect-buffer))
7646 (setq ibuf (org-get-indirect-buffer cbuf heading)
7647 org-last-indirect-buffer ibuf)
7649 ((or (eq org-indirect-buffer-display 'new-frame)
7650 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7651 (select-frame (make-frame))
7652 (delete-other-windows)
7653 (org-pop-to-buffer-same-window ibuf)
7654 (org-set-frame-title heading))
7655 ((eq org-indirect-buffer-display 'dedicated-frame)
7657 (select-frame (or (and org-indirect-dedicated-frame
7658 (frame-live-p org-indirect-dedicated-frame)
7659 org-indirect-dedicated-frame)
7660 (setq org-indirect-dedicated-frame (make-frame)))))
7661 (delete-other-windows)
7662 (org-pop-to-buffer-same-window ibuf)
7663 (org-set-frame-title (concat "Indirect: " heading)))
7664 ((eq org-indirect-buffer-display 'current-window)
7665 (org-pop-to-buffer-same-window ibuf))
7666 ((eq org-indirect-buffer-display 'other-window)
7667 (pop-to-buffer ibuf))
7668 (t (error "Invalid value")))
7669 (if (featurep 'xemacs)
7670 (save-excursion (org-mode) (turn-on-font-lock)))
7671 (narrow-to-region beg end)
7674 (run-hook-with-args 'org-cycle-hook 'all)
7675 (and (window-live-p cwin) (select-window cwin))))
7677 (defun org-get-indirect-buffer (&optional buffer heading)
7678 (setq buffer (or buffer (current-buffer)))
7679 (let ((n 1) (base (buffer-name buffer)) bname)
7680 (while (buffer-live-p
7684 (if heading (concat heading "-" (number-to-string n))
7685 (number-to-string n))))))
7688 (make-indirect-buffer buffer bname 'clone)
7689 (error (make-indirect-buffer buffer bname)))))
7691 (defun org-set-frame-title (title)
7692 "Set the title of the current frame to the string TITLE."
7693 ;; FIXME: how to name a single frame in XEmacs???
7694 (unless (featurep 'xemacs)
7695 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7697 ;;;; Structure editing
7699 ;;; Inserting headlines
7701 (defun org-previous-line-empty-p (&optional next)
7702 "Is the previous line a blank line?
7703 When NEXT is non-nil, check the next line instead."
7706 (or (beginning-of-line (if next 2 0)) t)
7708 (looking-at "[ \t]*$")))))
7710 (defun org-insert-heading (&optional arg invisible-ok)
7711 "Insert a new heading or an item with the same depth at point.
7713 If point is at the beginning of a heading or a list item, insert
7714 a new heading or a new item above the current one. If point is
7715 at the beginning of a normal line, turn the line into a heading.
7717 If point is in the middle of a headline or a list item, split the
7718 headline or the item and create a new headline/item with the text
7719 in the current line after point \(see `org-M-RET-may-split-line'
7720 on how to modify this behavior).
7722 With one universal prefix argument, set the user option
7723 `org-insert-heading-respect-content' to t for the duration of
7724 the command. This modifies the behavior described above in this
7725 ways: on list items and at the beginning of normal lines, force
7726 the insertion of a heading after the current subtree.
7728 With two universal prefix arguments, insert the heading at the
7729 end of the grandparent subtree. For example, if point is within
7730 a 2nd-level heading, then it will insert a 2nd-level heading at
7731 the end of the 1st-level parent heading.
7733 If point is at the beginning of a headline, insert a sibling
7734 before the current headline. If point is not at the beginning,
7735 split the line and create a new headline with the text in the
7736 current line after point \(see `org-M-RET-may-split-line' on how
7737 to modify this behavior).
7739 If point is at the beginning of a normal line, turn this line
7742 When INVISIBLE-OK is set, stop at invisible headlines when going
7743 back. This is important for non-interactive uses of the
7746 (if (org-called-interactively-p 'any) (org-reveal))
7747 (let ((itemp (org-in-item-p))
7748 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7749 (respect-content (or org-insert-heading-respect-content
7751 (initial-content "")
7752 (adjust-empty-lines t))
7756 ((or (= (buffer-size) 0)
7757 (and (not (save-excursion
7758 (and (ignore-errors (org-back-to-heading invisible-ok))
7759 (org-at-heading-p))))
7760 (or arg (not itemp))))
7761 ;; At beginning of buffer or so high up that only a heading
7763 (cond ((and (bolp) (not respect-content)) (insert "* "))
7764 ((not respect-content)
7765 (unless may-split (end-of-line))
7767 ((re-search-forward org-outline-regexp-bol nil t)
7771 (t (goto-char (point-max))
7773 (run-hooks 'org-insert-heading-hook))
7775 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7778 ;; Maybe move at the end of the subtree
7779 (when (equal arg '(16))
7780 (org-up-heading-safe)
7781 (org-end-of-subtree t))
7786 (on-heading (org-at-heading-p))
7787 (empty-line-p (if on-heading
7788 (org-previous-line-empty-p)
7789 ;; We will decide later
7791 ;; Get a level string to fall back on
7793 (if (org-before-first-heading-p) "*"
7795 (org-back-to-heading t)
7796 (if (org-previous-line-empty-p) (setq empty-line-p t))
7797 (looking-at org-outline-regexp)
7798 (make-string (1- (length (match-string 0))) ?*))))
7803 (org-back-to-heading invisible-ok)
7804 (when (and (not on-heading)
7805 (featurep 'org-inlinetask)
7806 (integerp org-inlinetask-min-level)
7807 (>= (length (match-string 0))
7808 org-inlinetask-min-level))
7809 ;; Find a heading level before the inline task
7810 (while (and (setq level (org-up-heading-safe))
7811 (>= level org-inlinetask-min-level)))
7812 (if (org-at-heading-p)
7813 (org-back-to-heading invisible-ok)
7814 (error "This should not happen")))
7815 (unless (and (save-excursion
7817 (org-backward-heading-same-level
7819 (= (point) (match-beginning 0)))
7820 (not (org-previous-line-empty-p t)))
7821 (setq empty-line-p (or empty-line-p
7822 (org-previous-line-empty-p))))
7824 (error (or fix-level "* ")))))
7825 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7826 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7827 pos hide-previous previous-pos)
7829 ;; If we insert after content, move there and clean up whitespace
7830 (when (and respect-content
7831 (not (org-looking-at-p org-outline-regexp-bol)))
7832 (if (not (org-before-first-heading-p))
7833 (org-end-of-subtree nil t)
7834 (re-search-forward org-outline-regexp-bol)
7835 (beginning-of-line 0))
7836 (skip-chars-backward " \r\n")
7837 (and (not (looking-back "^\\*+"))
7838 (looking-at "[ \t]+") (replace-match ""))
7839 (unless (eobp) (forward-char 1))
7840 (when (looking-at "^\\*")
7841 (unless (bobp) (backward-char 1))
7844 ;; If we are splitting, grab the text that should be moved to the new headline
7846 (if (org-on-heading-p)
7847 ;; This is a heading, we split intelligently (keeping tags)
7848 (let ((pos (point)))
7849 (goto-char (point-at-bol))
7850 (unless (looking-at org-complex-heading-regexp)
7851 (error "This should not happen"))
7852 (when (and (match-beginning 4)
7853 (> pos (match-beginning 4))
7854 (< pos (match-end 4)))
7855 (setq initial-content (buffer-substring pos (match-end 4)))
7857 (delete-region (point) (match-end 4))
7858 (if (looking-at "[ \t]*$")
7860 (insert (make-string (length initial-content) ?\ )))
7861 (setq initial-content (org-trim initial-content)))
7864 (setq initial-content
7865 (org-trim (buffer-substring (point) (point-at-eol))))
7866 (delete-region (point) (point-at-eol))))
7868 ;; If we are at the beginning of the line, insert before it. Else after
7870 ((and (bolp) (looking-at "[ \t]*$")))
7871 ((and (bolp) (not (looking-at "[ \t]*$")))
7874 (goto-char (point-at-eol))
7877 ;; Insert the new heading
7880 (insert initial-content)
7881 (when adjust-empty-lines
7883 (and blank (not (org-previous-line-empty-p))))
7884 (org-N-empty-lines-before-current (if blank 1 0))))
7885 (run-hooks 'org-insert-heading-hook)))))))
7887 (defun org-N-empty-lines-before-current (N)
7888 "Make the number of empty lines before current exactly N.
7889 So this will delete or add empty lines."
7893 (skip-chars-backward " \r\t\n")
7894 (unless (bolp) (forward-line))
7895 (delete-region (point) p))
7896 (when (> N 0) (insert (make-string N ?\n)))))
7898 (defun org-get-heading (&optional no-tags no-todo)
7899 "Return the heading of the current entry, without the stars.
7900 When NO-TAGS is non-nil, don't include tags.
7901 When NO-TODO is non-nil, don't include TODO keywords."
7903 (org-back-to-heading t)
7905 ((and no-tags no-todo)
7906 (looking-at org-complex-heading-regexp)
7909 (looking-at (concat org-outline-regexp
7911 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7914 (looking-at org-todo-line-regexp)
7916 (t (looking-at org-heading-regexp)
7917 (match-string 2)))))
7919 (defvar orgstruct-mode) ; defined below
7921 (defun org-heading-components ()
7922 "Return the components of the current heading.
7923 This is a list with the following elements:
7924 - the level as an integer
7925 - the reduced level, different if `org-odd-levels-only' is set.
7926 - the TODO keyword, or nil
7927 - the priority character, like ?A, or nil if no priority is given
7928 - the headline text itself, or the tags string if no headline text
7929 - the tags string, or nil."
7931 (org-back-to-heading t)
7932 (if (let (case-fold-search)
7936 org-complex-heading-regexp)))
7938 (list (length (match-string 1))
7939 (org-reduced-level (length (match-string 1)))
7944 (list (length (match-string 1))
7945 (org-reduced-level (length (match-string 1)))
7946 (org-match-string-no-properties 2)
7947 (and (match-end 3) (aref (match-string 3) 2))
7948 (org-match-string-no-properties 4)
7949 (org-match-string-no-properties 5))))))
7951 (defun org-get-entry ()
7952 "Get the entry text, after heading, entire subtree."
7954 (org-back-to-heading t)
7955 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7957 (defun org-insert-heading-after-current ()
7958 "Insert a new heading with same level as current, after current subtree."
7960 (org-back-to-heading)
7961 (org-insert-heading)
7962 (org-move-subtree-down)
7965 (defun org-insert-heading-respect-content (&optional invisible-ok)
7966 "Insert heading with `org-insert-heading-respect-content' set to t."
7968 (org-insert-heading '(4) invisible-ok))
7970 (defun org-insert-todo-heading-respect-content (&optional force-state)
7971 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7973 (org-insert-todo-heading force-state '(4)))
7975 (defun org-insert-todo-heading (arg &optional force-heading)
7976 "Insert a new heading with the same level and TODO state as current heading.
7977 If the heading has no TODO state, or if the state is DONE, use the first
7978 state (TODO by default). Also with one prefix arg, force first state. With
7979 two prefix args, force inserting at the end of the parent subtree."
7981 (when (or force-heading (not (org-insert-item 'checkbox)))
7982 (org-insert-heading (or (and (equal arg '(16)) '(16))
7985 (org-back-to-heading)
7986 (outline-previous-heading)
7987 (looking-at org-todo-line-regexp))
7990 (if (or (equal arg '(4))
7991 (not (match-beginning 2))
7992 (member (match-string 2) org-done-keywords))
7993 (car org-todo-keywords-1)
7997 (run-hook-with-args-until-success
7998 'org-todo-get-default-hook new-mark-x nil)
8000 (beginning-of-line 1)
8001 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8002 (if org-treat-insert-todo-heading-as-state-change
8004 (insert new-mark " "))))
8005 (when org-provide-todo-statistics
8006 (org-update-parent-todo-statistics))))
8008 (defun org-insert-subheading (arg)
8009 "Insert a new subheading and demote it.
8010 Works for outline headings and for plain lists alike."
8012 (org-insert-heading arg)
8014 ((org-at-heading-p) (org-do-demote))
8015 ((org-at-item-p) (org-indent-item))))
8017 (defun org-insert-todo-subheading (arg)
8018 "Insert a new subheading with TODO keyword or checkbox and demote it.
8019 Works for outline headings and for plain lists alike."
8021 (org-insert-todo-heading arg)
8023 ((org-at-heading-p) (org-do-demote))
8024 ((org-at-item-p) (org-indent-item))))
8026 ;;; Promotion and Demotion
8028 (defvar org-after-demote-entry-hook nil
8029 "Hook run after an entry has been demoted.
8030 The cursor will be at the beginning of the entry.
8031 When a subtree is being demoted, the hook will be called for each node.")
8033 (defvar org-after-promote-entry-hook nil
8034 "Hook run after an entry has been promoted.
8035 The cursor will be at the beginning of the entry.
8036 When a subtree is being promoted, the hook will be called for each node.")
8038 (defun org-promote-subtree ()
8039 "Promote the entire subtree.
8040 See also `org-promote'."
8043 (org-with-limited-levels (org-map-tree 'org-promote)))
8044 (org-fix-position-after-promote))
8046 (defun org-demote-subtree ()
8047 "Demote the entire subtree. See `org-demote'.
8048 See also `org-promote'."
8051 (org-with-limited-levels (org-map-tree 'org-demote)))
8052 (org-fix-position-after-promote))
8055 (defun org-do-promote ()
8056 "Promote the current heading higher up the tree.
8057 If the region is active in `transient-mark-mode', promote all headings
8061 (if (org-region-active-p)
8062 (org-map-region 'org-promote (region-beginning) (region-end))
8064 (org-fix-position-after-promote))
8066 (defun org-do-demote ()
8067 "Demote the current heading lower down the tree.
8068 If the region is active in `transient-mark-mode', demote all headings
8072 (if (org-region-active-p)
8073 (org-map-region 'org-demote (region-beginning) (region-end))
8075 (org-fix-position-after-promote))
8077 (defun org-fix-position-after-promote ()
8078 "Make sure that after pro/demotion cursor position is right."
8079 (let ((pos (point)))
8080 (when (save-excursion
8081 (beginning-of-line 1)
8082 (looking-at org-todo-line-regexp)
8083 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8084 (cond ((eobp) (insert " "))
8085 ((eolp) (insert " "))
8086 ((equal (char-after) ?\ ) (forward-char 1))))))
8088 (defun org-current-level ()
8089 "Return the level of the current entry, or nil if before the first headline.
8090 The level is the number of stars at the beginning of the
8091 headline. Use `org-reduced-level' to remove the effect of
8092 `org-odd-levels'. Unlike to `org-outline-level', this function
8093 ignores inlinetasks."
8094 (let ((level (org-with-limited-levels (org-outline-level))))
8095 (and (> level 0) level)))
8097 (defun org-get-previous-line-level ()
8098 "Return the outline depth of the last headline before the current line.
8099 Returns 0 for the first headline in the buffer, and nil if before the
8101 (and (org-current-level)
8102 (or (and (/= (line-beginning-position) (point-min))
8103 (save-excursion (beginning-of-line 0) (org-current-level)))
8106 (defun org-reduced-level (l)
8107 "Compute the effective level of a heading.
8108 This takes into account the setting of `org-odd-levels-only'."
8111 (org-odd-levels-only (1+ (floor (/ l 2))))
8114 (defun org-level-increment ()
8115 "Return the number of stars that will be added or removed at a
8116 time to headlines when structure editing, based on the value of
8117 `org-odd-levels-only'."
8118 (if org-odd-levels-only 2 1))
8120 (defun org-get-valid-level (level &optional change)
8121 "Rectify a level change under the influence of `org-odd-levels-only'
8122 LEVEL is a current level, CHANGE is by how much the level should be
8123 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8124 even level numbers will become the next higher odd number."
8125 (if org-odd-levels-only
8126 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8127 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8128 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8129 (max 1 (+ level (or change 0)))))
8131 (if (boundp 'define-obsolete-function-alias)
8132 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8133 (define-obsolete-function-alias 'org-get-legal-level
8134 'org-get-valid-level)
8135 (define-obsolete-function-alias 'org-get-legal-level
8136 'org-get-valid-level "23.1")))
8138 (defun org-promote ()
8139 "Promote the current heading higher up the tree."
8140 (org-with-wide-buffer
8141 (org-back-to-heading t)
8142 (let* ((after-change-functions (remq 'flyspell-after-change-function
8143 after-change-functions))
8144 (level (save-match-data (funcall outline-level)))
8145 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8146 (diff (abs (- level (length up-head) -1))))
8148 ((and (= level 1) org-allow-promoting-top-level-subtree)
8149 (replace-match "# " nil t))
8151 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8152 (t (replace-match up-head nil t)))
8154 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8155 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8156 (run-hooks 'org-after-promote-entry-hook))))
8158 (defun org-demote ()
8159 "Demote the current heading lower down the tree."
8160 (org-with-wide-buffer
8161 (org-back-to-heading t)
8162 (let* ((after-change-functions (remq 'flyspell-after-change-function
8163 after-change-functions))
8164 (level (save-match-data (funcall outline-level)))
8165 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8166 (diff (abs (- level (length down-head) -1))))
8167 (replace-match down-head nil t)
8168 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8169 (when org-adapt-indentation (org-fixup-indentation diff))
8170 (run-hooks 'org-after-demote-entry-hook))))
8172 (defun org-cycle-level ()
8173 "Cycle the level of an empty headline through possible states.
8174 This goes first to child, then to parent, level, then up the hierarchy.
8175 After top level, it switches back to sibling level."
8177 (let ((org-adapt-indentation nil))
8178 (when (org-point-at-end-of-empty-headline)
8179 (setq this-command 'org-cycle-level) ; Only needed for caching
8180 (let ((cur-level (org-current-level))
8181 (prev-level (org-get-previous-line-level)))
8183 ;; If first headline in file, promote to top-level.
8185 (loop repeat (/ (- cur-level 1) (org-level-increment))
8186 do (org-do-promote)))
8187 ;; If same level as prev, demote one.
8188 ((= prev-level cur-level)
8190 ;; If parent is top-level, promote to top level if not already.
8192 (loop repeat (/ (- cur-level 1) (org-level-increment))
8193 do (org-do-promote)))
8194 ;; If top-level, return to prev-level.
8196 (loop repeat (/ (- prev-level 1) (org-level-increment))
8197 do (org-do-demote)))
8198 ;; If less than prev-level, promote one.
8199 ((< cur-level prev-level)
8201 ;; If deeper than prev-level, promote until higher than
8203 ((> cur-level prev-level)
8204 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8205 do (org-do-promote))))
8208 (defun org-map-tree (fun)
8209 "Call FUN for every heading underneath the current one."
8210 (org-back-to-heading)
8211 (let ((level (funcall outline-level)))
8215 (outline-next-heading)
8216 (> (funcall outline-level) level))
8220 (defun org-map-region (fun beg end)
8221 "Call FUN for every heading between BEG and END."
8222 (let ((org-ignore-region t))
8224 (setq end (copy-marker end))
8226 (if (and (re-search-forward org-outline-regexp-bol nil t)
8230 (outline-next-heading)
8235 (defun org-fixup-indentation (diff)
8236 "Change the indentation in the current entry by DIFF.
8238 DIFF is an integer. Indentation is done according to the
8241 - Planning information and property drawers are always indented
8242 according to the new level of the headline;
8244 - Footnote definitions and their contents are ignored;
8246 - Inlinetasks' boundaries are not shifted;
8248 - Empty lines are ignored;
8250 - Other lines' indentation are shifted by DIFF columns, unless
8251 it would introduce a structural change in the document, in
8252 which case no shifting is done at all.
8254 Assume point is at a heading or an inlinetask beginning."
8255 (org-with-wide-buffer
8256 (narrow-to-region (line-beginning-position)
8258 (if (org-with-limited-levels (org-at-heading-p))
8259 (org-with-limited-levels (outline-next-heading))
8260 (org-inlinetask-goto-end))
8263 ;; Indent properly planning info and property drawer.
8264 (when (org-looking-at-p org-planning-line-re)
8267 (when (looking-at org-property-drawer-re)
8268 (goto-char (match-end 0))
8270 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8272 (when (zerop diff) (throw 'no-shift nil))
8273 ;; If DIFF is negative, first check if a shift is possible at all
8274 ;; (e.g., it doesn't break structure). This can only happen if
8275 ;; some contents are not properly indented.
8276 (let ((case-fold-search t))
8278 (let ((diff (- diff))
8279 (forbidden-re (concat org-outline-regexp
8281 (substring org-footnote-definition-re 1))))
8285 ((org-looking-at-p "[ \t]*$") (forward-line))
8286 ((and (org-looking-at-p org-footnote-definition-re)
8287 (let ((e (org-element-at-point)))
8288 (and (eq (org-element-type e) 'footnote-definition)
8289 (goto-char (org-element-property :end e))))))
8290 ((org-looking-at-p org-outline-regexp) (forward-line))
8291 ;; Give up if shifting would move before column 0 or
8292 ;; if it would introduce a headline or a footnote
8295 (skip-chars-forward " \t")
8296 (let ((ind (current-column)))
8297 (when (or (< ind diff)
8298 (and (= ind diff) (org-looking-at-p forbidden-re)))
8299 (throw 'no-shift nil)))
8300 ;; Ignore contents of example blocks and source
8301 ;; blocks if their indentation is meant to be
8302 ;; preserved. Jump to block's closing line.
8304 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8305 (let ((e (org-element-at-point)))
8306 (and (memq (org-element-type e)
8307 '(example-block src-block))
8308 (or org-src-preserve-indentation
8309 (org-element-property :preserve-indent e))
8310 (goto-char (org-element-property :end e))
8311 (progn (skip-chars-backward " \r\t\n")
8314 (forward-line))))))))
8315 ;; Shift lines but footnote definitions, inlinetasks boundaries
8316 ;; by DIFF. Also skip contents of source or example blocks
8317 ;; when indentation is meant to be preserved.
8320 ((and (org-looking-at-p org-footnote-definition-re)
8321 (let ((e (org-element-at-point)))
8322 (and (eq (org-element-type e) 'footnote-definition)
8323 (goto-char (org-element-property :end e))))))
8324 ((org-looking-at-p org-outline-regexp) (forward-line))
8325 ((org-looking-at-p "[ \t]*$") (forward-line))
8327 (org-indent-line-to (+ (org-get-indentation) diff))
8329 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8330 (let ((e (org-element-at-point)))
8331 (and (memq (org-element-type e)
8332 '(example-block src-block))
8333 (or org-src-preserve-indentation
8334 (org-element-property :preserve-indent e))
8335 (goto-char (org-element-property :end e))
8336 (progn (skip-chars-backward " \r\t\n")
8339 (forward-line)))))))))
8341 (defun org-convert-to-odd-levels ()
8342 "Convert an org-mode file with all levels allowed to one with odd levels.
8343 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8346 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8347 (let ((outline-level 'org-outline-level)
8348 (org-odd-levels-only nil) n)
8350 (goto-char (point-min))
8351 (while (re-search-forward "^\\*\\*+ " nil t)
8352 (setq n (- (length (match-string 0)) 2))
8353 (while (>= (setq n (1- n)) 0)
8355 (end-of-line 1))))))
8357 (defun org-convert-to-oddeven-levels ()
8358 "Convert an org-mode file with only odd levels to one with odd/even levels.
8359 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8360 file contains a section with an even level, conversion would
8361 destroy the structure of the file. An error is signaled in this
8364 (goto-char (point-min))
8365 ;; First check if there are no even levels
8366 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8367 (org-show-context t)
8368 (error "Not all levels are odd in this file. Conversion not possible"))
8369 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8370 (let ((outline-regexp org-outline-regexp)
8371 (outline-level 'org-outline-level)
8372 (org-odd-levels-only nil) n)
8374 (goto-char (point-min))
8375 (while (re-search-forward "^\\*\\*+ " nil t)
8376 (setq n (/ (1- (length (match-string 0))) 2))
8377 (while (>= (setq n (1- n)) 0)
8379 (end-of-line 1))))))
8381 (defun org-tr-level (n)
8382 "Make N odd if required."
8383 (if org-odd-levels-only (1+ (/ n 2)) n))
8385 ;;; Vertical tree motion, cutting and pasting of subtrees
8387 (defun org-move-subtree-up (&optional arg)
8388 "Move the current subtree up past ARG headlines of the same level."
8390 (org-move-subtree-down (- (prefix-numeric-value arg))))
8392 (defun org-move-subtree-down (&optional arg)
8393 "Move the current subtree down past ARG headlines of the same level."
8395 (setq arg (prefix-numeric-value arg))
8396 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8397 'org-get-last-sibling))
8398 (ins-point (make-marker))
8400 (col (current-column))
8401 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8403 (org-back-to-heading)
8406 (setq ne-beg (org-back-over-empty-lines))
8409 (save-excursion (outline-end-of-heading)
8410 (setq folded (outline-invisible-p)))
8411 (progn (org-end-of-subtree nil t)
8412 (unless (eobp) (backward-char))))
8413 (outline-next-heading)
8414 (setq ne-end (org-back-over-empty-lines))
8417 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8418 ;; include less whitespace
8421 (forward-line (- ne-beg ne-end))
8422 (setq beg (point))))
8423 ;; Find insertion point, with error handling
8425 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8426 (progn (goto-char beg0)
8427 (user-error "Cannot move past superior level or buffer limit")))
8428 (setq cnt (1- cnt)))
8430 ;; Moving forward - still need to move over subtree
8431 (progn (org-end-of-subtree t t)
8433 (org-back-over-empty-lines)
8434 (or (bolp) (newline)))))
8435 (setq ne-ins (org-back-over-empty-lines))
8436 (move-marker ins-point (point))
8437 (setq txt (buffer-substring beg end))
8438 (org-save-markers-in-region beg end)
8439 (delete-region beg end)
8440 (org-remove-empty-overlays-at beg)
8441 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8442 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8443 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8444 (let ((bbb (point)))
8445 (insert-before-markers txt)
8446 (org-reinstall-markers-in-region bbb)
8447 (move-marker ins-point bbb))
8448 (or (bolp) (insert "\n"))
8449 (setq ins-end (point))
8450 (goto-char ins-point)
8451 (org-skip-whitespace)
8452 (when (and (< arg 0)
8453 (org-first-sibling-p)
8455 ;; Move whitespace back to beginning
8458 (let ((kill-whole-line t))
8459 (kill-line (- ne-ins ne-beg)) (point)))
8460 (insert (make-string (- ne-ins ne-beg) ?\n)))
8461 (move-marker ins-point nil)
8466 (org-cycle-hide-drawers 'children))
8467 (org-clean-visibility-after-subtree-move)
8468 ;; move back to the initial column we were at
8469 (move-to-column col)))
8471 (defvar org-subtree-clip ""
8472 "Clipboard for cut and paste of subtrees.
8473 This is actually only a copy of the kill, because we use the normal kill
8474 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8476 (defvar org-subtree-clip-folded nil
8477 "Was the last copied subtree folded?
8478 This is used to fold the tree back after pasting.")
8480 (defun org-cut-subtree (&optional n)
8481 "Cut the current subtree into the clipboard.
8482 With prefix arg N, cut this many sequential subtrees.
8483 This is a short-hand for marking the subtree and then cutting it."
8485 (org-copy-subtree n 'cut))
8487 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8488 "Copy the current subtree it in the clipboard.
8489 With prefix arg N, copy this many sequential subtrees.
8490 This is a short-hand for marking the subtree and then copying it.
8491 If CUT is non-nil, actually cut the subtree.
8492 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8493 of some markers in the region, even if CUT is non-nil. This is
8494 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8496 (let (beg end folded (beg0 (point)))
8497 (if (org-called-interactively-p 'any)
8498 (org-back-to-heading nil) ; take what looks like a subtree
8499 (org-back-to-heading t)) ; take what is really there
8501 (skip-chars-forward " \t\r\n")
8504 (outline-next-heading)
8505 (save-excursion (outline-end-of-heading)
8506 (setq folded (outline-invisible-p)))
8507 (ignore-errors (org-forward-heading-same-level (1- n) t))
8508 (org-end-of-subtree t t)))
8512 (setq org-subtree-clip-folded folded)
8513 (when (or cut force-store-markers)
8514 (org-save-markers-in-region beg end))
8515 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8516 (setq org-subtree-clip (current-kill 0))
8517 (message "%s: Subtree(s) with %d characters"
8518 (if cut "Cut" "Copied")
8519 (length org-subtree-clip)))))
8521 (defun org-paste-subtree (&optional level tree for-yank remove)
8522 "Paste the clipboard as a subtree, with modification of headline level.
8523 The entire subtree is promoted or demoted in order to match a new headline
8526 If the cursor is at the beginning of a headline, the same level as
8527 that headline is used to paste the tree.
8529 If not, the new level is derived from the *visible* headings
8530 before and after the insertion point, and taken to be the inferior headline
8531 level of the two. So if the previous visible heading is level 3 and the
8532 next is level 4 (or vice versa), level 4 will be used for insertion.
8533 This makes sure that the subtree remains an independent subtree and does
8534 not swallow low level entries.
8536 You can also force a different level, either by using a numeric prefix
8537 argument, or by inserting the heading marker by hand. For example, if the
8538 cursor is after \"*****\", then the tree will be shifted to level 5.
8540 If optional TREE is given, use this text instead of the kill ring.
8542 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8543 move back over whitespace before inserting, and move point to the end of
8544 the inserted text when done.
8546 When REMOVE is non-nil, remove the subtree from the clipboard."
8548 (setq tree (or tree (and kill-ring (current-kill 0))))
8549 (unless (org-kill-is-subtree-p tree)
8551 (substitute-command-keys
8552 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8553 (org-with-limited-levels
8554 (let* ((visp (not (outline-invisible-p)))
8556 (^re_ "\\(\\*+\\)[ \t]*")
8557 (old-level (if (string-match org-outline-regexp-bol txt)
8558 (- (match-end 0) (match-beginning 0) 1)
8560 (force-level (cond (level (prefix-numeric-value level))
8561 ((and (looking-at "[ \t]*$")
8563 "^\\*+$" (buffer-substring
8564 (point-at-bol) (point))))
8565 (- (match-end 0) (match-beginning 0)))
8567 (looking-at org-outline-regexp))
8568 (- (match-end 0) (point) 1))))
8569 (previous-level (save-excursion
8572 (outline-previous-visible-heading 1)
8573 (if (looking-at ^re_)
8574 (- (match-end 0) (match-beginning 0) 1)
8577 (next-level (save-excursion
8580 (or (looking-at org-outline-regexp)
8581 (outline-next-visible-heading 1))
8582 (if (looking-at ^re_)
8583 (- (match-end 0) (match-beginning 0) 1)
8586 (new-level (or force-level (max previous-level next-level)))
8587 (shift (if (or (= old-level -1)
8589 (= old-level new-level))
8591 (- new-level old-level)))
8592 (delta (if (> shift 0) -1 1))
8593 (func (if (> shift 0) 'org-demote 'org-promote))
8594 (org-odd-levels-only nil)
8596 ;; Remove the forced level indicator
8598 (delete-region (point-at-bol) (point)))
8600 (beginning-of-line (if (bolp) 1 2))
8602 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8603 (insert-before-markers txt)
8604 (unless (string-match "\n\\'" txt) (insert "\n"))
8605 (setq newend (point))
8606 (org-reinstall-markers-in-region beg)
8609 (skip-chars-forward " \t\n\r")
8611 (if (and (outline-invisible-p) visp)
8612 (save-excursion (outline-show-heading)))
8613 ;; Shift if necessary
8616 (narrow-to-region beg end)
8617 (while (not (= shift 0))
8618 (org-map-region func (point-min) (point-max))
8619 (setq shift (+ delta shift)))
8620 (goto-char (point-min))
8621 (setq newend (point-max))))
8622 (when (or (org-called-interactively-p 'interactive) for-yank)
8623 (message "Clipboard pasted as level %d subtree" new-level))
8624 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8626 (eq org-subtree-clip (current-kill 0))
8627 org-subtree-clip-folded)
8628 ;; The tree was folded before it was killed/copied
8630 (and for-yank (goto-char newend))
8631 (and remove (setq kill-ring (cdr kill-ring))))))
8633 (defun org-kill-is-subtree-p (&optional txt)
8634 "Check if the current kill is an outline subtree, or a set of trees.
8635 Returns nil if kill does not start with a headline, or if the first
8636 headline level is not the largest headline level in the tree.
8637 So this will actually accept several entries of equal levels as well,
8638 which is OK for `org-paste-subtree'.
8639 If optional TXT is given, check this string instead of the current kill."
8640 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8641 (re (org-get-limited-outline-regexp))
8642 (^re (concat "^" re))
8643 (start-level (and kill
8645 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8647 (- (match-end 2) (match-beginning 2) 1)))
8648 (start (1+ (or (match-beginning 2) -1))))
8649 (if (not start-level)
8651 nil) ;; does not even start with a heading
8653 (while (setq start (string-match ^re kill (1+ start)))
8654 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8658 (defvar org-markers-to-move nil
8659 "Markers that should be moved with a cut-and-paste operation.
8660 Those markers are stored together with their positions relative to
8661 the start of the region.")
8663 (defun org-save-markers-in-region (beg end)
8664 "Check markers in region.
8665 If these markers are between BEG and END, record their position relative
8666 to BEG, so that after moving the block of text, we can put the markers back
8668 This function gets called just before an entry or tree gets cut from the
8669 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8670 called immediately, to move the markers with the entries."
8671 (setq org-markers-to-move nil)
8672 (when (featurep 'org-clock)
8673 (org-clock-save-markers-for-cut-and-paste beg end))
8674 (when (featurep 'org-agenda)
8675 (org-agenda-save-markers-for-cut-and-paste beg end)))
8677 (defun org-check-and-save-marker (marker beg end)
8678 "Check if MARKER is between BEG and END.
8679 If yes, remember the marker and the distance to BEG."
8680 (when (and (marker-buffer marker)
8681 (equal (marker-buffer marker) (current-buffer)))
8682 (if (and (>= marker beg) (< marker end))
8683 (push (cons marker (- marker beg)) org-markers-to-move))))
8685 (defun org-reinstall-markers-in-region (beg)
8686 "Move all remembered markers to their position relative to BEG."
8688 (move-marker (car x) (+ beg (cdr x))))
8689 org-markers-to-move)
8690 (setq org-markers-to-move nil))
8692 (defun org-narrow-to-subtree ()
8693 "Narrow buffer to the current subtree."
8697 (org-with-limited-levels
8699 (progn (org-back-to-heading t) (point))
8700 (progn (org-end-of-subtree t t)
8701 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8704 (defun org-narrow-to-block ()
8705 "Narrow buffer to the current block."
8707 (let* ((case-fold-search t)
8708 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8709 "^[ \t]*#\\+end_.*")))
8711 (narrow-to-region (car blockp) (cdr blockp))
8712 (user-error "Not in a block"))))
8714 (defun org-clone-subtree-with-time-shift (n &optional shift)
8715 "Clone the task (subtree) at point N times.
8716 The clones will be inserted as siblings.
8718 In interactive use, the user will be prompted for the number of
8719 clones to be produced. If the entry has a timestamp, the user
8720 will also be prompted for a time shift, which may be a repeater
8721 as used in time stamps, for example `+3d'. To disable this,
8722 you can call the function with a universal prefix argument.
8724 When a valid repeater is given and the entry contains any time
8725 stamps, the clones will become a sequence in time, with time
8726 stamps in the subtree shifted for each clone produced. If SHIFT
8727 is nil or the empty string, time stamps will be left alone. The
8728 ID property of the original subtree is removed.
8730 If the original subtree did contain time stamps with a repeater,
8731 the following will happen:
8732 - the repeater will be removed in each clone
8733 - an additional clone will be produced, with the current, unshifted
8734 date(s) in the entry.
8735 - the original entry will be placed *after* all the clones, with
8737 - the start days in the repeater in the original entry will be shifted
8738 to past the last clone.
8739 In this way you can spell out a number of instances of a repeating task,
8740 and still retain the repeater to cover future instances of the task."
8741 (interactive "nNumber of clones to produce: ")
8744 (if (and (not (equal current-prefix-arg '(4)))
8746 (re-search-forward org-ts-regexp-both
8748 (org-end-of-subtree t)
8750 (read-from-minibuffer
8751 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8752 ""))) ;; No time shift
8754 (drawer-re org-drawer-regexp)
8755 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8756 beg end template task idprop
8757 shift-n shift-what doshift nmin nmax)
8758 (if (not (and (integerp n) (> n 0)))
8759 (user-error "Invalid number of replications %s" n))
8760 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8761 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8763 (user-error "Invalid shift specification %s" shift))
8765 (setq shift-n (string-to-number (match-string 1 shift))
8766 shift-what (cdr (assoc (match-string 2 shift)
8767 '(("d" . day) ("w" . week)
8768 ("m" . month) ("y" . year))))))
8769 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8770 (setq nmin 1 nmax n)
8771 (org-back-to-heading t)
8773 (setq idprop (org-entry-get nil "ID"))
8774 (org-end-of-subtree t t)
8775 (or (bolp) (insert "\n"))
8777 (setq template (buffer-substring beg end))
8779 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8780 (delete-region beg end)
8782 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8784 (loop for n from nmin to nmax do
8789 (goto-char (point-min))
8791 (and idprop (if org-clone-delete-id
8792 (org-entry-delete nil "ID")
8793 (org-id-get-create t)))
8795 (while (re-search-forward org-clock-re nil t)
8797 (goto-char (point-min))
8798 (while (re-search-forward drawer-re nil t)
8799 (org-remove-empty-drawer-at (point))))
8800 (goto-char (point-min))
8802 (while (re-search-forward org-ts-regexp-both nil t)
8803 (org-timestamp-change (* n shift-n) shift-what))
8804 (unless (= n n-no-remove)
8805 (goto-char (point-min))
8806 (while (re-search-forward org-ts-regexp nil t)
8808 (goto-char (match-beginning 0))
8809 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8810 (delete-region (match-beginning 1) (match-end 1)))))))
8811 (setq task (buffer-string)))
8817 (defun org-sort (with-case)
8818 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8819 Optional argument WITH-CASE means sort case-sensitively."
8822 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8823 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8825 (org-call-with-arg 'org-sort-entries with-case))))
8827 (defun org-sort-remove-invisible (s)
8828 "Remove invisible links from string S."
8829 (remove-text-properties 0 (length s) org-rm-props s)
8830 (while (string-match org-bracket-link-regexp s)
8831 (setq s (replace-match (if (match-end 2)
8833 (match-string 1 s)) t t s)))
8834 (let ((st (format " %s " s)))
8835 (while (string-match org-emph-re st)
8836 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8837 (setq s (substring st 1 -1)))
8840 (defvar org-priority-regexp) ; defined later in the file
8842 (defvar org-after-sorting-entries-or-items-hook nil
8843 "Hook that is run after a bunch of entries or items have been sorted.
8844 When children are sorted, the cursor is in the parent line when this
8845 hook gets called. When a region or a plain list is sorted, the cursor
8846 will be in the first entry of the sorted region/list.")
8848 (defun org-sort-entries
8849 (&optional with-case sorting-type getkey-func compare-func property)
8850 "Sort entries on a certain level of an outline tree.
8851 If there is an active region, the entries in the region are sorted.
8852 Else, if the cursor is before the first entry, sort the top-level items.
8853 Else, the children of the entry at point are sorted.
8855 Sorting can be alphabetically, numerically, by date/time as given by
8856 a time stamp, by a property, by priority order, or by a custom function.
8858 The command prompts for the sorting type unless it has been given to the
8859 function through the SORTING-TYPE argument, which needs to be a character,
8860 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8861 the precise meaning of each character:
8863 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8864 c By creation time, which is assumed to be the first inactive time stamp
8865 at the beginning of a line.
8866 d By deadline date/time.
8868 n Numerically, by converting the beginning of the entry/item to a number.
8869 o By order of TODO keywords.
8870 p By priority according to the cookie.
8871 r By the value of a property.
8872 s By scheduled date/time.
8873 t By date/time, either the first active time stamp in the entry, or, if
8874 none exist, by the first inactive one.
8876 Capital letters will reverse the sort order.
8878 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8879 called with point at the beginning of the record. It must return either
8880 a string or a number that should serve as the sorting key for that record.
8882 Comparing entries ignores case by default. However, with an optional argument
8883 WITH-CASE, the sorting considers case as well.
8885 Sorting is done against the visible part of the headlines, it ignores hidden
8888 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8890 (let ((case-func (if with-case 'identity 'downcase))
8892 ;; The clock marker is lost when using `sort-subr', let's
8893 ;; store the clocking string.
8894 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8896 (goto-char org-clock-marker)
8897 (looking-back "^.*") (match-string-no-properties 0))))
8898 start beg end stars re re2
8900 ;; Find beginning and end of region to sort
8902 ((org-region-active-p)
8903 ;; we will sort the region
8904 (setq end (region-end)
8906 (goto-char (region-beginning))
8907 (if (not (org-at-heading-p)) (outline-next-heading))
8908 (setq start (point)))
8909 ((or (org-at-heading-p)
8910 (ignore-errors (progn (org-back-to-heading) t)))
8911 ;; we will sort the children of the current headline
8912 (org-back-to-heading)
8914 end (progn (org-end-of-subtree t t)
8915 (or (bolp) (insert "\n"))
8916 (when (>= (org-back-over-empty-lines) 1)
8922 (outline-next-heading))
8924 ;; we will sort the top-level entries in this file
8925 (goto-char (point-min))
8926 (or (org-at-heading-p) (outline-next-heading))
8927 (setq start (point))
8928 (goto-char (point-max))
8929 (beginning-of-line 1)
8930 (when (looking-at ".*?\\S-")
8931 ;; File ends in a non-white line
8934 (setq end (point-max))
8935 (setq what "top-level")
8940 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8942 (looking-at "\\(\\*+\\)")
8943 (setq stars (match-string 1)
8944 re (concat "^" (regexp-quote stars) " +")
8945 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8946 txt (buffer-substring beg end))
8947 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8948 (if (and (not (equal stars "*")) (string-match re2 txt))
8949 (user-error "Region to sort contains a level above the first entry"))
8951 (unless sorting-type
8953 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8954 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8955 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8957 (setq sorting-type (read-char-exclusive))
8960 (and (= (downcase sorting-type) ?f)
8962 (org-icompleting-read "Sort using function: "
8963 obarray 'fboundp t nil nil))
8964 (setq getkey-func (intern getkey-func))))
8966 (and (= (downcase sorting-type) ?r)
8969 (org-icompleting-read "Property: "
8970 (mapcar 'list (org-buffer-property-keys t))
8973 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8974 (message "Sorting entries...")
8977 (narrow-to-region start end)
8978 (let ((dcst (downcase sorting-type))
8979 (case-fold-search nil)
8980 (now (current-time)))
8982 (/= dcst sorting-type)
8983 ;; This function moves to the beginning character of the "record" to
8986 (if (re-search-forward re nil t)
8987 (goto-char (match-beginning 0))
8988 (goto-char (point-max))))
8989 ;; This function moves to the last character of the "record" being
8994 (outline-forward-same-level 1)
8996 (goto-char (point-max))))))
8997 ;; This function returns the value that gets sorted against.
9001 (if (looking-at org-complex-heading-regexp)
9002 (string-to-number (org-sort-remove-invisible (match-string 4)))
9005 (if (looking-at org-complex-heading-regexp)
9006 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9009 (or (get-text-property (point) :org-clock-minutes) 0))
9011 (let ((end (save-excursion (outline-next-heading) (point))))
9012 (if (or (re-search-forward org-ts-regexp end t)
9013 (re-search-forward org-ts-regexp-both end t))
9014 (org-time-string-to-seconds (match-string 0))
9015 (org-float-time now))))
9017 (let ((end (save-excursion (outline-next-heading) (point))))
9018 (if (re-search-forward
9019 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9021 (org-time-string-to-seconds (match-string 0))
9022 (org-float-time now))))
9024 (let ((end (save-excursion (outline-next-heading) (point))))
9025 (if (re-search-forward org-scheduled-time-regexp end t)
9026 (org-time-string-to-seconds (match-string 1))
9027 (org-float-time now))))
9029 (let ((end (save-excursion (outline-next-heading) (point))))
9030 (if (re-search-forward org-deadline-time-regexp end t)
9031 (org-time-string-to-seconds (match-string 1))
9032 (org-float-time now))))
9034 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9035 (string-to-char (match-string 2))
9036 org-default-priority))
9038 (or (org-entry-get nil property) ""))
9040 (if (looking-at org-complex-heading-regexp)
9041 (let* ((m (match-string 2))
9042 (s (if (member m org-done-keywords) '- '+)))
9043 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9047 (setq tmp (funcall getkey-func))
9048 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9050 (error "Invalid key function `%s'" getkey-func)))
9051 (t (error "Invalid sorting type `%c'" sorting-type))))
9054 ((= dcst ?a) 'string<)
9055 ((= dcst ?f) compare-func)
9056 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9057 (run-hooks 'org-after-sorting-entries-or-items-hook)
9058 ;; Reset the clock marker if needed
9062 (search-forward cmstr nil t)
9063 (move-marker org-clock-marker (point))))
9064 (message "Sorting entries...done")))
9066 ;;; The orgstruct minor mode
9068 ;; Define a minor mode which can be used in other modes in order to
9069 ;; integrate the org-mode structure editing commands.
9071 ;; This is really a hack, because the org-mode structure commands use
9072 ;; keys which normally belong to the major mode. Here is how it
9073 ;; works: The minor mode defines all the keys necessary to operate the
9074 ;; structure commands, but wraps the commands into a function which
9075 ;; tests if the cursor is currently at a headline or a plain list
9076 ;; item. If that is the case, the structure command is used,
9077 ;; temporarily setting many Org-mode variables like regular
9078 ;; expressions for filling etc. However, when any of those keys is
9079 ;; used at a different location, function uses `key-binding' to look
9080 ;; up if the key has an associated command in another currently active
9081 ;; keymap (minor modes, major mode, global), and executes that
9082 ;; command. There might be problems if any of the keys is otherwise
9083 ;; used as a prefix key.
9085 (defcustom orgstruct-heading-prefix-regexp ""
9086 "Regexp that matches the custom prefix of Org headlines in
9087 orgstruct(++)-mode."
9090 :package-version '(Org . "8.3")
9092 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9094 (defcustom orgstruct-setup-hook nil
9095 "Hook run after orgstruct-mode-map is filled."
9098 :package-version '(Org . "8.0")
9101 (defvar orgstruct-initialized nil)
9103 (defvar org-local-vars nil
9104 "List of local variables, for use by `orgstruct-mode'.")
9107 (define-minor-mode orgstruct-mode
9108 "Toggle the minor mode `orgstruct-mode'.
9109 This mode is for using Org-mode structure commands in other
9110 modes. The following keys behave as if Org-mode were active, if
9111 the cursor is on a headline, or on a plain list item (both as
9112 defined by Org-mode)."
9113 nil " OrgStruct" (make-sparse-keymap)
9114 (funcall (if orgstruct-mode
9115 'add-to-invisibility-spec
9116 'remove-from-invisibility-spec)
9118 (when orgstruct-mode
9119 (org-load-modules-maybe)
9120 (unless orgstruct-initialized
9122 (setq orgstruct-initialized t))))
9125 (defun turn-on-orgstruct ()
9126 "Unconditionally turn on `orgstruct-mode'."
9129 (defvar org-fb-vars nil)
9130 (make-variable-buffer-local 'org-fb-vars)
9131 (defun orgstruct++-mode (&optional arg)
9132 "Toggle `orgstruct-mode', the enhanced version of it.
9133 In addition to setting orgstruct-mode, this also exports all
9134 indentation and autofilling variables from org-mode into the
9135 buffer. It will also recognize item context in multiline items."
9137 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9139 (progn (orgstruct-mode -1)
9141 (org-set-local (car v)
9142 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9145 (setq org-fb-vars nil)
9146 (unless org-local-vars
9147 (setq org-local-vars (org-get-local-variables)))
9152 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9153 (symbol-name (car x)))
9154 (setq var (car x) val (nth 1 x))
9155 (push (list var `(quote ,(eval var))) org-fb-vars)
9156 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9158 (org-set-local 'orgstruct-is-++ t))))
9160 (defvar orgstruct-is-++ nil
9161 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9162 (make-variable-buffer-local 'orgstruct-is-++)
9165 (defun turn-on-orgstruct++ ()
9166 "Unconditionally turn on `orgstruct++-mode'."
9167 (orgstruct++-mode 1))
9169 (defun orgstruct-error ()
9170 "Error when there is no default binding for a structure key."
9172 (funcall (if (fboundp 'user-error)
9175 "This key has no function outside structure elements"))
9177 (defun orgstruct-setup ()
9178 "Setup orgstruct keymap."
9179 (dolist (cell '((org-demote . t)
9183 (org-shiftmetaleft . t)
9184 (org-shiftmetaright . t)
9185 org-backward-element
9186 org-backward-heading-same-level
9191 org-forward-heading-same-level
9193 org-insert-heading-respect-content
9194 org-kill-note-or-show-branches
9199 org-narrow-to-subtree
9214 outline-next-visible-heading
9215 outline-previous-visible-heading
9219 (let ((f (or (car-safe cell) cell))
9220 (disable-when-heading-prefix (cdr-safe cell)))
9222 (let ((new-bindings))
9223 (dolist (binding (nconc (where-is-internal f org-mode-map)
9224 (where-is-internal f outline-mode-map)))
9225 (push binding new-bindings)
9226 ;; TODO use local-function-key-map
9227 (dolist (rep '(("<tab>" . "TAB")
9228 ("<return>" . "RET")
9229 ("<escape>" . "ESC")
9230 ("<delete>" . "DEL")))
9231 (setq binding (read-kbd-macro
9232 (let ((case-fold-search))
9233 (replace-regexp-in-string
9234 (regexp-quote (cdr rep))
9236 (key-description binding)))))
9237 (pushnew binding new-bindings :test 'equal)))
9238 (dolist (binding new-bindings)
9239 (let ((key (lookup-key orgstruct-mode-map binding)))
9240 (when (or (not key) (numberp key))
9242 (org-defkey orgstruct-mode-map
9244 (orgstruct-make-binding
9245 f binding disable-when-heading-prefix))))))))))
9246 (run-hooks 'orgstruct-setup-hook))
9248 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9249 "Create a function for binding in the structure minor mode.
9250 FUN is the command to call inside a table. KEY is the key that
9251 should be checked in for a command to execute outside of tables.
9252 Non-nil `disable-when-heading-prefix' means to disable the command
9253 if `orgstruct-heading-prefix-regexp' is not empty."
9254 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9257 (while (fboundp (intern nname))
9258 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9259 (setq name (intern nname)))
9261 (let ((bindings '((org-heading-regexp
9263 orgstruct-heading-prefix-regexp
9264 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9266 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9267 (org-outline-regexp-bol
9268 (concat "^" org-outline-regexp))
9269 (outline-regexp org-outline-regexp)
9270 (outline-heading-end-regexp "\n")
9271 (outline-level 'org-outline-level)
9272 (outline-heading-alist))))
9274 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9275 "Outside of structure, run the binding of `"
9276 (key-description key) "'."
9277 (when disable-when-heading-prefix
9279 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9280 "back to the default binding due to limitations of Org's implementation of\n"
9281 "`" (symbol-name fun) "'.")))
9284 ,(and disable-when-heading-prefix
9285 '(not (string= orgstruct-heading-prefix-regexp ""))))
9290 (org-context-p 'headline 'item
9292 '(org-insert-heading
9293 org-insert-heading-respect-content
9295 '(when orgstruct-is-++
9298 (let* ((orgstruct-mode)
9305 ("<\\([^>]*\\)tab>" . "\\1TAB")
9306 ("<\\([^>]*\\)return>" . "\\1RET")
9307 ("<\\([^>]*\\)escape>" . "\\1ESC")
9308 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9311 (setq key (read-kbd-macro
9312 (let ((case-fold-search))
9313 (replace-regexp-in-string
9316 (key-description key))))))
9317 (when (key-binding key)
9318 (throw 'exit (key-binding key))))))))
9319 (if (keymapp binding)
9320 (org-set-transient-map binding)
9321 (let ((func (or binding
9323 'orgstruct-error))))
9325 (call-interactively func)))))
9326 (org-run-like-in-org-mode
9330 (call-interactively ',fun)))))))))
9333 (defun org-contextualize-keys (alist contexts)
9334 "Return valid elements in ALIST depending on CONTEXTS.
9336 `org-agenda-custom-commands' or `org-capture-templates' are the
9337 values used for ALIST, and `org-agenda-custom-commands-contexts'
9338 or `org-capture-templates-contexts' are the associated contexts
9341 ;; normalize contexts
9343 (lambda(c) (cond ((listp (cadr c))
9344 (list (car c) (car c) (cadr c)))
9345 ((string= "" (cadr c))
9346 (list (car c) (car c) (caddr c)))
9349 ;; loop over all commands or templates
9350 (while (setq c (pop a))
9353 ((not (assoc (car c) contexts))
9355 ((and (assoc (car c) contexts)
9356 (setq vrules (org-contextualize-validate-key
9359 (when (not (equal (car vr) (cadr vr)))
9360 (setq repl vr))) vrules)
9361 (if (not repl) (push c r)
9362 (push (cadr repl) s)
9365 (cdr (or (assoc (cadr repl) alist)
9366 (error "Undefined key `%s' as contextual replacement for `%s'"
9367 (cadr repl) (car c)))))
9369 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9374 (let ((tpl (car x)))
9378 (equal y tpl)) s))) x)))
9381 (defun org-contextualize-validate-key (key contexts)
9382 "Check CONTEXTS for agenda or capture KEY."
9384 (while (setq r (pop contexts))
9388 (and (equal key (car r))
9389 (if (functionp rr) (funcall rr)
9390 (or (and (eq (car rr) 'in-file)
9392 (string-match (cdr rr) (buffer-file-name)))
9393 (and (eq (car rr) 'in-mode)
9394 (string-match (cdr rr) (symbol-name major-mode)))
9395 (and (eq (car rr) 'in-buffer)
9396 (string-match (cdr rr) (buffer-name)))
9397 (when (and (eq (car rr) 'not-in-file)
9399 (not (string-match (cdr rr) (buffer-file-name))))
9400 (when (eq (car rr) 'not-in-mode)
9401 (not (string-match (cdr rr) (symbol-name major-mode))))
9402 (when (eq (car rr) 'not-in-buffer)
9403 (not (string-match (cdr rr) (buffer-name)))))))
9406 (delete-dups (delq nil res))))
9408 (defun org-context-p (&rest contexts)
9409 "Check if local context is any of CONTEXTS.
9410 Possible values in the list of contexts are `table', `headline', and `item'."
9411 (let ((pos (point)))
9412 (goto-char (point-at-bol))
9413 (prog1 (or (and (memq 'table contexts)
9414 (looking-at "[ \t]*|"))
9415 (and (memq 'headline contexts)
9416 (looking-at org-outline-regexp))
9417 (and (memq 'item contexts)
9418 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9419 (and (memq 'item-body contexts)
9423 (defun org-get-local-variables ()
9424 "Return a list of all local variables in an Org mode buffer."
9426 (with-current-buffer (get-buffer-create "*Org tmp*")
9429 (setq varlist (buffer-local-variables)))
9430 (kill-buffer "*Org tmp*")
9437 (list (car x) (cdr x))))
9438 (if (and (not (get (car x) 'org-state))
9440 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9441 (symbol-name (car x))))
9445 (defun org-clone-local-variables (from-buffer &optional regexp)
9446 "Clone local variables from FROM-BUFFER.
9447 Optional argument REGEXP selects variables to clone."
9450 (and (symbolp (car pair))
9452 (string-match regexp (symbol-name (car pair))))
9453 (set (make-local-variable (car pair))
9455 (buffer-local-variables from-buffer)))
9458 (defun org-run-like-in-org-mode (cmd)
9459 "Run a command, pretending that the current buffer is in Org-mode.
9460 This will temporarily bind local variables that are typically bound in
9461 Org-mode to the values they have in Org-mode, and then interactively
9463 (org-load-modules-maybe)
9464 (unless org-local-vars
9465 (setq org-local-vars (org-get-local-variables)))
9467 (dolist (var org-local-vars)
9468 (when (or (not (boundp (car var)))
9469 (eq (symbol-value (car var))
9470 (default-value (car var))))
9471 (push (list (car var) `(quote ,(cadr var))) binds)))
9473 (call-interactively (quote ,cmd))))))
9475 (defun org-get-category (&optional pos force-refresh)
9476 "Get the category applying to position POS."
9478 (if force-refresh (org-refresh-category-properties))
9479 (let ((pos (or pos (point))))
9480 (or (get-text-property pos 'org-category)
9481 (progn (org-refresh-category-properties)
9482 (get-text-property pos 'org-category))))))
9484 ;;; Refresh properties
9486 (defun org-refresh-properties (dprop tprop)
9487 "Refresh buffer text properties.
9488 DPROP is the drawer property and TPROP is either the
9489 corresponding text property to set, or an alist with each element
9490 being a text property (as a symbol) and a function to apply to
9491 the value of the drawer property."
9492 (let ((case-fold-search t)
9493 (inhibit-read-only t))
9494 (org-with-silent-modifications
9498 (goto-char (point-min))
9499 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9500 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9502 (defun org-refresh-property (tprop p)
9503 "Refresh the buffer text property TPROP from the drawer property P.
9504 The refresh happens only for the current tree (not subtree)."
9506 (org-back-to-heading t)
9507 ;; tprop is a text property symbol
9510 (point) (or (outline-next-heading) (point-max)) tprop p)
9511 ;; tprop is an alist with (properties . function) elements
9515 (point-at-bol) (or (outline-next-heading) (point-max))
9517 (funcall (cdr al) p))))
9520 (defun org-refresh-category-properties ()
9521 "Refresh category text properties in the buffer."
9522 (let ((case-fold-search t)
9523 (inhibit-read-only t)
9525 ((null org-category)
9526 (if buffer-file-name
9527 (file-name-sans-extension
9528 (file-name-nondirectory buffer-file-name))
9530 ((symbolp org-category) (symbol-name org-category))
9532 beg end cat pos optionp)
9533 (org-with-silent-modifications
9537 (goto-char (point-min))
9538 (put-text-property (point) (point-max) 'org-category def-cat)
9539 (while (re-search-forward
9540 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9541 (setq pos (match-end 0)
9542 optionp (equal (char-after (match-beginning 0)) ?#)
9543 cat (org-trim (match-string 2)))
9545 (setq beg (point-at-bol) end (point-max))
9546 (org-back-to-heading t)
9547 (setq beg (point) end (org-end-of-subtree t t)))
9548 (put-text-property beg end 'org-category cat)
9549 (goto-char pos)))))))
9551 (defun org-refresh-stats-properties ()
9552 "Refresh stats text properties in the buffer."
9554 (org-with-silent-modifications
9558 (goto-char (point-min))
9559 (while (re-search-forward
9560 (concat org-outline-regexp-bol ".*"
9561 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9563 (setq stats (cond ((equal (match-string 3) "0") 0)
9565 (/ (* (string-to-number (match-string 2)) 100)
9566 (string-to-number (match-string 3))))
9567 (t (string-to-number (match-string 1)))))
9568 (org-back-to-heading t)
9569 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9570 'org-stats stats)))))))
9572 (defun org-refresh-effort-properties ()
9573 "Refresh effort properties"
9574 (org-refresh-properties
9576 '((effort . identity)
9577 (effort-minutes . org-duration-string-to-minutes))))
9581 ;;; Link abbreviations
9583 (defun org-link-expand-abbrev (link)
9584 "Apply replacements as defined in `org-link-abbrev-alist'."
9585 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9586 (let* ((key (match-string 1 link))
9587 (as (or (assoc key org-link-abbrev-alist-local)
9588 (assoc key org-link-abbrev-alist)))
9589 (tag (and (match-end 2) (match-string 3 link)))
9595 ((symbolp rpl) (funcall rpl tag))
9596 ((string-match "%(\\([^)]+\\))" rpl)
9599 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9600 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9601 ((string-match "%h" rpl)
9602 (replace-match (url-hexify-string (or tag "")) t t rpl))
9603 (t (concat rpl tag)))))
9606 ;;; Storing and inserting links
9608 (defvar org-insert-link-history nil
9609 "Minibuffer history for links inserted with `org-insert-link'.")
9611 (defvar org-stored-links nil
9612 "Contains the links stored with `org-store-link'.")
9614 (defvar org-store-link-plist nil
9615 "Plist with info about the most recently link created with `org-store-link'.")
9617 (defvar org-link-protocols nil
9618 "Link protocols added to Org-mode using `org-add-link-type'.")
9620 (defvar org-store-link-functions nil
9621 "List of functions that are called to create and store a link.
9622 Each function will be called in turn until one returns a non-nil
9623 value. Each function should check if it is responsible for creating
9624 this link (for example by looking at the major mode).
9625 If not, it must exit and return nil.
9626 If yes, it should return a non-nil value after a calling
9627 `org-store-link-props' with a list of properties and values.
9628 Special properties are:
9630 :type The link prefix, like \"http\". This must be given.
9631 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9632 This is obligatory as well.
9633 :description Optional default description for the second pair
9634 of brackets in an Org-mode link. The user can still change
9635 this when inserting this link into an Org-mode buffer.
9637 In addition to these, any additional properties can be specified
9638 and then used in capture templates.")
9640 (defun org-add-link-type (type &optional follow export)
9641 "Add TYPE to the list of `org-link-types'.
9642 Re-compute all regular expressions depending on `org-link-types'
9644 FOLLOW and EXPORT are two functions.
9646 FOLLOW should take the link path as the single argument and do whatever
9647 is necessary to follow the link, for example find a file or display
9650 EXPORT should format the link path for export to one of the export formats.
9651 It should be a function accepting three arguments:
9653 path the path of the link, the text after the prefix (like \"http:\")
9654 desc the description of the link, if any
9655 format the export format, a symbol like `html' or `latex' or `ascii'.
9657 The function may use the FORMAT information to return different values
9658 depending on the format. The return value will be put literally into
9659 the exported file. If the return value is nil, this means Org should
9660 do what it normally does with links which do not have EXPORT defined.
9662 Org mode has a built-in default for exporting links. If you are happy with
9663 this default, there is no need to define an export function for the link
9664 type. For a simple example of an export function, see `org-bbdb.el'."
9665 (add-to-list 'org-link-types type t)
9666 (org-make-link-regexps)
9667 (org-element-update-syntax)
9668 (if (assoc type org-link-protocols)
9669 (setcdr (assoc type org-link-protocols) (list follow export))
9670 (push (list type follow export) org-link-protocols)))
9672 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9673 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9676 (defun org-store-link (arg)
9677 "\\<org-mode-map>Store an org-link to the current location.
9678 This link is added to `org-stored-links' and can later be inserted
9679 into an org-buffer with \\[org-insert-link].
9681 For some link types, a prefix arg is interpreted.
9682 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9683 For file links, arg negates `org-context-in-file-links'.
9685 A double prefix arg force skipping storing functions that are not
9688 A triple prefix arg force storing a link for each line in the
9691 (org-load-modules-maybe)
9692 (if (and (equal arg '(64)) (org-region-active-p))
9694 (let ((end (region-end)))
9695 (goto-char (region-beginning))
9697 (while (< (point-at-eol) end)
9698 (move-end-of-line 1) (activate-mark)
9699 (let (current-prefix-arg)
9700 (call-interactively 'org-store-link))
9701 (move-beginning-of-line 2)
9702 (set-mark (point)))))
9703 (org-with-limited-levels
9704 (setq org-store-link-plist nil)
9705 (let (link cpltxt desc description search
9706 txt custom-id agenda-link sfuns sfunsn)
9709 ;; Store a link using an external link type
9710 ((and (not (equal arg '(16)))
9713 nil (mapcar (lambda (f)
9714 (let (fs) (if (funcall f) (push f fs))))
9715 org-store-link-functions))
9716 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9717 (or (and (cdr sfuns)
9720 "Which function for creating the link? "
9721 sfunsn nil t (car sfunsn)))))
9722 (funcall (caar sfuns)))
9723 (setq link (plist-get org-store-link-plist :link)
9724 desc (or (plist-get org-store-link-plist
9725 :description) link))))
9727 ;; Store a link from a source code buffer
9728 ((org-src-edit-buffer-p)
9730 (while (or (not label)
9734 (goto-char (point-min))
9736 (regexp-quote (format org-coderef-label-format label))
9738 (when label (message "Label exists already") (sit-for 2))
9739 (setq label (read-string "Code line label: " label)))
9741 (setq link (format org-coderef-label-format label))
9742 (setq gc (- 79 (length link)))
9743 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9745 (setq link (concat "(" label ")") desc nil)))
9747 ;; We are in the agenda, link to referenced location
9748 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9749 (let ((m (or (get-text-property (point) 'org-hd-marker)
9750 (get-text-property (point) 'org-marker))))
9752 (org-with-point-at m
9754 (if (org-called-interactively-p 'any)
9755 (call-interactively 'org-store-link)
9756 (org-store-link nil)))))))
9758 ((eq major-mode 'calendar-mode)
9759 (let ((cd (calendar-cursor-to-date)))
9762 (car org-time-stamp-formats)
9764 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9766 (org-store-link-props :type "calendar" :date cd)))
9768 ((eq major-mode 'help-mode)
9769 (setq link (concat "help:" (save-excursion
9770 (goto-char (point-min))
9771 (looking-at "^[^ ]+")
9773 (org-store-link-props :type "help"))
9775 ((eq major-mode 'w3-mode)
9776 (setq cpltxt (if (and (buffer-name)
9777 (not (string-match "Untitled" (buffer-name))))
9780 link (url-view-url t))
9781 (org-store-link-props :type "w3" :url (url-view-url t)))
9783 ((eq major-mode 'image-mode)
9784 (setq cpltxt (concat "file:"
9785 (abbreviate-file-name buffer-file-name))
9787 (org-store-link-props :type "image" :file buffer-file-name))
9789 ;; In dired, store a link to the file of the current line
9790 ((derived-mode-p 'dired-mode)
9791 (let ((file (dired-get-filename nil t)))
9793 (abbreviate-file-name
9794 (expand-file-name (dired-get-filename nil t)))
9795 ;; otherwise, no file so use current directory.
9797 (setq cpltxt (concat "file:" file)
9800 ((setq search (run-hook-with-args-until-success
9801 'org-create-file-search-functions))
9802 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9804 (setq cpltxt (or description link)))
9806 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9807 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9809 ;; Store a link using the target at point
9810 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9813 (abbreviate-file-name
9814 (buffer-file-name (buffer-base-buffer)))
9815 "::" (match-string 1))
9817 ((and (featurep 'org-id)
9818 (or (eq org-id-link-to-org-use-id t)
9819 (and (org-called-interactively-p 'any)
9820 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9821 (and (eq org-id-link-to-org-use-id
9822 'create-if-interactive-and-no-custom-id)
9824 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9825 ;; Store a link using the ID at point
9826 (setq link (condition-case nil
9827 (prog1 (org-id-store-link)
9828 (setq desc (or (plist-get org-store-link-plist
9832 ;; Probably before first headline, link only to file
9834 (abbreviate-file-name
9835 (buffer-file-name (buffer-base-buffer))))))))
9837 ;; Just link to current headline
9838 (setq cpltxt (concat "file:"
9839 (abbreviate-file-name
9840 (buffer-file-name (buffer-base-buffer)))))
9841 ;; Add a context search string
9842 (when (org-xor org-context-in-file-links arg)
9843 (let* ((ee (org-element-at-point))
9844 (et (org-element-type ee))
9845 (ev (plist-get (cadr ee) :value))
9846 (ek (plist-get (cadr ee) :key))
9847 (eok (and (stringp ek) (string-match "name" ek))))
9849 ((org-at-heading-p) nil)
9850 ((and (eq et 'keyword) eok) ev)
9851 ((org-region-active-p)
9852 (buffer-substring (region-beginning) (region-end)))))
9853 (when (or (null txt) (string-match "\\S-" txt))
9857 (org-make-org-heading-search-string txt)
9859 desc (or (and (eq et 'keyword) eok ev)
9860 (nth 4 (ignore-errors (org-heading-components)))
9862 (if (string-match "::\\'" cpltxt)
9863 (setq cpltxt (substring cpltxt 0 -2)))
9864 (setq link cpltxt))))
9866 ((buffer-file-name (buffer-base-buffer))
9867 ;; Just link to this file here.
9868 (setq cpltxt (concat "file:"
9869 (abbreviate-file-name
9870 (buffer-file-name (buffer-base-buffer)))))
9871 ;; Add a context string.
9872 (when (org-xor org-context-in-file-links arg)
9873 (setq txt (if (org-region-active-p)
9874 (buffer-substring (region-beginning) (region-end))
9875 (buffer-substring (point-at-bol) (point-at-eol))))
9876 ;; Only use search option if there is some text.
9877 (when (string-match "\\S-" txt)
9879 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9883 ((org-called-interactively-p 'interactive)
9884 (user-error "No method for storing a link from this buffer"))
9886 (t (setq link nil)))
9888 ;; We're done setting link and desc, clean up
9889 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9890 (setq link (or link cpltxt)
9891 desc (or desc cpltxt))
9892 (cond ((equal desc "NONE") (setq desc nil))
9893 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9894 (let ((d0 (match-string 3 desc))
9895 (p0 (match-string 5 desc)))
9897 (replace-regexp-in-string
9898 org-bracket-link-regexp
9900 (if (equal (length (match-string 0 desc))
9901 (length desc)) "*" "")) desc)))))
9904 (if (not (and (or (org-called-interactively-p 'any)
9905 executing-kbd-macro) link))
9906 (or agenda-link (and link (org-make-link-string link desc)))
9907 (push (list link desc) org-stored-links)
9908 (message "Stored: %s" (or desc link))
9910 (setq link (concat "file:" (abbreviate-file-name
9911 (buffer-file-name)) "::#" custom-id))
9912 (push (list link desc) org-stored-links))
9913 (car org-stored-links))))))
9915 (defun org-store-link-props (&rest plist)
9916 "Store link properties, extract names and addresses."
9918 (when (setq x (plist-get plist :from))
9919 (setq adr (mail-extract-address-components x))
9920 (setq plist (plist-put plist :fromname (car adr)))
9921 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9922 (when (setq x (plist-get plist :to))
9923 (setq adr (mail-extract-address-components x))
9924 (setq plist (plist-put plist :toname (car adr)))
9925 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9926 (let ((from (plist-get plist :from))
9927 (to (plist-get plist :to)))
9928 (when (and from to org-from-is-user-regexp)
9930 (plist-put plist :fromto
9931 (if (string-match org-from-is-user-regexp from)
9933 (concat "from %f"))))))
9934 (setq org-store-link-plist plist))
9936 (defun org-add-link-props (&rest plist)
9937 "Add these properties to the link property list."
9940 (setq key (pop plist) value (pop plist))
9941 (setq org-store-link-plist
9942 (plist-put org-store-link-plist key value)))))
9944 (defun org-email-link-description (&optional fmt)
9945 "Return the description part of an email link.
9946 This takes information from `org-store-link-plist' and formats it
9947 according to FMT (default from `org-email-link-description-format')."
9948 (setq fmt (or fmt org-email-link-description-format))
9949 (let* ((p org-store-link-plist)
9950 (to (plist-get p :toaddress))
9951 (from (plist-get p :fromaddress))
9954 (cons "%c" (plist-get p :fromto))
9955 (cons "%F" (plist-get p :from))
9956 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9957 (cons "%T" (plist-get p :to))
9958 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9959 (cons "%s" (plist-get p :subject))
9960 (cons "%d" (plist-get p :date))
9961 (cons "%m" (plist-get p :message-id)))))
9962 (when (string-match "%c" fmt)
9963 ;; Check if the user wrote this message
9964 (if (and org-from-is-user-regexp from to
9965 (save-match-data (string-match org-from-is-user-regexp from)))
9966 (setq fmt (replace-match "to %t" t t fmt))
9967 (setq fmt (replace-match "from %f" t t fmt))))
9968 (org-replace-escapes fmt table)))
9970 (defun org-make-org-heading-search-string (&optional string)
9971 "Make search string for the current headline or STRING."
9973 (and (derived-mode-p 'org-mode)
9975 (org-back-to-heading t)
9976 (org-element-property :raw-value (org-element-at-point))))))
9977 (lines org-context-in-file-links))
9978 (or string (setq s (concat "*" s))) ; Add * for headlines
9979 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9980 (when (and string (integerp lines) (> lines 0))
9981 (let ((slines (org-split-string s "\n")))
9982 (when (< lines (length slines))
9985 (reverse (nthcdr (- (length slines) lines)
9986 (reverse slines))) "\n")))))
9987 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9989 (defun org-make-link-string (link &optional description)
9990 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9991 (unless (string-match "\\S-" link)
9992 (error "Empty link"))
9993 (when (and description
9994 (stringp description)
9995 (not (string-match "\\S-" description)))
9996 (setq description nil))
9997 (when (stringp description)
9998 ;; Remove brackets from the description, they are fatal.
9999 (while (string-match "\\[" description)
10000 (setq description (replace-match "{" t t description)))
10001 (while (string-match "\\]" description)
10002 (setq description (replace-match "}" t t description))))
10003 (when (equal link description)
10004 ;; No description needed, it is identical
10005 (setq description nil))
10006 (when (and (not description)
10007 (not (string-match (org-image-file-name-regexp) link))
10008 (not (equal link (org-link-escape link))))
10009 (setq description (org-extract-attributes link)))
10011 (cond ((string-match (org-image-file-name-regexp) link) link)
10012 ((string-match org-link-types-re link)
10013 (concat (match-string 1 link)
10014 (org-link-escape (substring link (match-end 1)))))
10015 (t (org-link-escape link))))
10016 (concat "[[" link "]"
10017 (if description (concat "[" description "]") "")
10020 (defconst org-link-escape-chars
10023 "List of characters that should be escaped in a link when stored to Org.
10024 This is the list that is used for internal purposes.")
10026 (defconst org-link-escape-chars-browser
10029 "List of characters to be escaped before handing over to the browser.
10030 If you consider using this constant then you probably want to use
10031 the function `org-link-escape-browser' instead. See there why
10032 this constant is a candidate to be removed once Org drops support
10033 for Emacs 24.1 and 24.2.")
10035 (defun org-link-escape (text &optional table merge)
10036 "Return percent escaped representation of TEXT.
10037 TEXT is a string with the text to escape.
10038 Optional argument TABLE is a list with characters that should be
10039 escaped. When nil, `org-link-escape-chars' is used.
10040 If optional argument MERGE is set, merge TABLE into
10041 `org-link-escape-chars'."
10042 ;; Don't escape chars in internal links
10043 (if (string-match "^\\*[[:alnum:]]+" text)
10047 (mapc (lambda (defchr)
10048 (unless (member defchr table)
10049 (setq table (cons defchr table))))
10050 org-link-escape-chars))
10052 (setq table org-link-escape-chars)))
10055 (if (or (member char table)
10056 (and (or (< char 32) (= char ?\%) (> char 126))
10058 (mapconcat (lambda (sequence-element)
10059 (format "%%%.2X" sequence-element))
10060 (or (encode-coding-char char 'utf-8)
10061 (error "Unable to percent escape character: %s"
10062 (char-to-string char))) "")
10063 (char-to-string char))) text "")))
10065 (defun org-link-escape-browser (text)
10066 "Escape some characters before handing over to the browser.
10067 This function is a candidate to be removed together with the
10068 constant `org-link-escape-chars-browser' once Org drops support
10069 for Emacs 24.1 and 24.2. All calls to this function will have to
10070 be replaced with `url-encode-url' which is available since Emacs
10072 ;; Example with the Org link
10073 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10074 ;; to open the browser with +subject:"Release 8.2" filled into the
10075 ;; query field: In this case the variable TEXT contains the
10076 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10077 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10078 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10079 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10080 (if (fboundp 'url-encode-url)
10081 (url-encode-url text)
10082 (if (org-string-match-p
10083 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10085 (org-link-escape text org-link-escape-chars-browser)
10088 (defun org-link-unescape (str)
10089 "Unhex hexified Unicode strings as returned from the JavaScript function
10090 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10091 (unless (and (null str) (string= "" str))
10092 (let ((pos 0) (case-fold-search t) unhexed)
10093 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10094 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10095 (setq str (replace-match unhexed t t str))
10096 (setq pos (+ pos (length unhexed))))))
10099 (defun org-link-unescape-compound (hex)
10100 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10101 Note: this function also decodes single byte encodings like
10102 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10104 (let* ((bytes (cdr (split-string hex "%")))
10109 (let* ((val (string-to-number (pop bytes) 16))
10113 ((>= val 252) (cons 6 252))
10114 ((>= val 248) (cons 5 248))
10115 ((>= val 240) (cons 4 240))
10116 ((>= val 224) (cons 3 224))
10117 ((>= val 192) (cons 2 192))
10120 (if (>= val 192) (setq eat (car shift-xor)))
10121 (setq val (logxor val (cdr shift-xor)))
10122 (setq sum (+ (lsh sum (car shift-xor)) val))
10123 (if (> eat 0) (setq eat (- eat 1)))
10125 ((= 0 eat) ;multi byte
10126 (setq ret (concat ret (org-char-to-string sum)))
10128 ((not bytes) ; single byte(s)
10129 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10132 (defun org-link-unescape-single-byte-sequence (hex)
10133 "Unhexify hex-encoded single byte character sequences."
10134 (mapconcat (lambda (byte)
10135 (char-to-string (string-to-number byte 16)))
10136 (cdr (split-string hex "%")) ""))
10138 (defun org-xor (a b)
10142 (defun org-fixup-message-id-for-http (s)
10143 "Replace special characters in a message id, so it can be used in an http query."
10144 (when (string-match "%" s)
10145 (setq s (mapconcat (lambda (c)
10148 (char-to-string c)))
10150 (while (string-match "<" s)
10151 (setq s (replace-match "%3C" t t s)))
10152 (while (string-match ">" s)
10153 (setq s (replace-match "%3E" t t s)))
10154 (while (string-match "@" s)
10155 (setq s (replace-match "%40" t t s)))
10158 (defun org-link-prettify (link)
10159 "Return a human-readable representation of LINK.
10160 The car of LINK must be a raw link.
10161 The cdr of LINK must be either a link description or nil."
10162 (let ((desc (or (cadr link) "<no description>")))
10163 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10164 "<" (car link) ">")))
10167 (defun org-insert-link-global ()
10168 "Insert a link like Org-mode does.
10169 This command can be called in any mode to insert a link in Org-mode syntax."
10171 (org-load-modules-maybe)
10172 (org-run-like-in-org-mode 'org-insert-link))
10174 (defun org-insert-all-links (arg &optional pre post)
10175 "Insert all links in `org-stored-links'.
10176 When a universal prefix, do not delete the links from `org-stored-links'.
10177 When `ARG' is a number, insert the last N link(s).
10178 `PRE' and `POST' are optional arguments to define a string to
10179 prepend or to append."
10181 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10182 (links (copy-seq org-stored-links))
10184 (po (or post "\n"))
10186 (if (null org-stored-links)
10187 (message "No link to insert")
10188 (while (and (or (listp arg) (>= arg cnt))
10189 (setq l (if (listp arg)
10191 (pop org-stored-links))))
10192 (setq cnt (1+ cnt))
10194 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10197 (defun org-insert-last-stored-link (arg)
10198 "Insert the last link stored in `org-stored-links'."
10200 (org-insert-all-links arg "" "\n"))
10202 (defun org-link-fontify-links-to-this-file ()
10203 "Fontify links to the current file in `org-stored-links'."
10204 (let ((f (buffer-file-name)) a b)
10205 (setq a (mapcar (lambda(l)
10206 (let ((ll (car l)))
10207 (when (and (string-match "^file:\\(.+\\)::" ll)
10208 (equal f (expand-file-name (match-string 1 ll))))
10211 (when (featurep 'org-id)
10212 (setq b (mapcar (lambda(l)
10213 (let ((ll (car l)))
10214 (when (and (string-match "^id:\\(.+\\)$" ll)
10215 (equal f (expand-file-name
10216 (or (org-id-find-id-file
10217 (match-string 1 ll)) ""))))
10219 org-stored-links)))
10221 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10222 (delq nil (append a b)))))
10224 (defvar org-link-links-in-this-file nil)
10225 (defun org-insert-link (&optional complete-file link-location default-description)
10226 "Insert a link. At the prompt, enter the link.
10228 Completion can be used to insert any of the link protocol prefixes like
10229 http or ftp in use.
10231 The history can be used to select a link previously stored with
10232 `org-store-link'. When the empty string is entered (i.e. if you just
10233 press RET at the prompt), the link defaults to the most recently
10234 stored link. As SPC triggers completion in the minibuffer, you need to
10235 use M-SPC or C-q SPC to force the insertion of a space character.
10237 You will also be prompted for a description, and if one is given, it will
10238 be displayed in the buffer instead of the link.
10240 If there is already a link at point, this command will allow you to edit link
10241 and description parts.
10243 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10244 be selected using completion. The path to the file will be relative to the
10245 current directory if the file is in the current directory or a subdirectory.
10246 Otherwise, the link will be the absolute path as completed in the minibuffer
10247 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10248 option `org-link-file-path-type'.
10250 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10251 the current directory or below.
10253 With three \\[universal-argument] prefixes, negate the meaning of
10254 `org-keep-stored-link-after-insertion'.
10256 If `org-make-link-description-function' is non-nil, this function will be
10257 called with the link target, and the result will be the default
10260 If the LINK-LOCATION parameter is non-nil, this value will be
10261 used as the link location instead of reading one interactively.
10263 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10264 be used as the default description."
10266 (let* ((wcf (current-window-configuration))
10267 (origbuf (current-buffer))
10268 (region (if (org-region-active-p)
10269 (buffer-substring (region-beginning) (region-end))))
10270 (remove (and region (list (region-beginning) (region-end))))
10272 tmphist ; byte-compile incorrectly complains about this
10273 (link link-location)
10274 (abbrevs org-link-abbrev-alist-local)
10275 entry file all-prefixes auto-desc)
10277 (link-location) ; specified by arg, just use it.
10278 ((org-in-regexp org-bracket-link-regexp 1)
10279 ;; We do have a link at point, and we are going to edit it.
10280 (setq remove (list (match-beginning 0) (match-end 0)))
10281 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10282 (setq link (read-string "Link: "
10284 (org-match-string-no-properties 1)))))
10285 ((or (org-in-regexp org-angle-link-re)
10286 (org-in-regexp org-plain-link-re))
10287 ;; Convert to bracket link
10288 (setq remove (list (match-beginning 0) (match-end 0))
10289 link (read-string "Link: "
10290 (org-remove-angle-brackets (match-string 0)))))
10291 ((member complete-file '((4) (16)))
10292 ;; Completing read for file names.
10293 (setq link (org-file-complete-link complete-file)))
10295 ;; Read link, with completion for stored links.
10296 (org-link-fontify-links-to-this-file)
10297 (org-switch-to-buffer-other-window "*Org Links*")
10298 (with-current-buffer "*Org Links*"
10300 (insert "Insert a link.
10301 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10302 (when org-stored-links
10303 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10304 (insert (mapconcat 'org-link-prettify
10305 (reverse org-stored-links) "\n")))
10306 (goto-char (point-min)))
10307 (let ((cw (selected-window)))
10308 (select-window (get-buffer-window "*Org Links*" 'visible))
10309 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10310 (unless (pos-visible-in-window-p (point-max))
10311 (org-fit-window-to-buffer))
10312 (and (window-live-p cw) (select-window cw)))
10313 ;; Fake a link history, containing the stored links.
10314 (setq tmphist (append (mapcar 'car org-stored-links)
10315 org-insert-link-history))
10316 (setq all-prefixes (append (mapcar 'car abbrevs)
10317 (mapcar 'car org-link-abbrev-alist)
10322 (org-completing-read
10325 (mapcar (lambda (x) (concat x ":"))
10327 (mapcar 'car org-stored-links))
10330 (caar org-stored-links)))
10331 (if (not (string-match "\\S-" link))
10332 (user-error "No link selected"))
10334 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10336 (if (or (member link all-prefixes)
10337 (and (equal ":" (substring link -1))
10338 (member (substring link 0 -1) all-prefixes)
10339 (setq link (substring link 0 -1))))
10340 (setq link (with-current-buffer origbuf
10341 (org-link-try-special-completion link)))))
10342 (set-window-configuration wcf)
10343 (kill-buffer "*Org Links*"))
10344 (setq entry (assoc link org-stored-links))
10345 (or entry (push link org-insert-link-history))
10346 (setq desc (or desc (nth 1 entry)))))
10348 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10349 (not org-keep-stored-link-after-insertion))
10350 (setq org-stored-links (delq (assoc link org-stored-links)
10351 org-stored-links)))
10353 (if (and (string-match org-plain-link-re link)
10354 (not (string-match org-ts-regexp link)))
10355 ;; URL-like link, normalize the use of angular brackets.
10356 (setq link (org-remove-angle-brackets link)))
10358 ;; Check if we are linking to the current file with a search
10359 ;; option If yes, simplify the link by using only the search
10361 (when (and buffer-file-name
10362 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10363 (let* ((path (match-string 1 link))
10364 (case-fold-search nil)
10365 (search (match-string 2 link)))
10367 (if (equal (file-truename buffer-file-name) (file-truename path))
10368 ;; We are linking to this same file, with a search option
10369 (setq link search)))))
10371 ;; Check if we can/should use a relative path. If yes, simplify the link
10372 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10373 (let* ((type (match-string 1 link))
10374 (path (match-string 2 link))
10376 (case-fold-search nil))
10378 ((or (eq org-link-file-path-type 'absolute)
10379 (equal complete-file '(16)))
10380 (setq path (abbreviate-file-name (expand-file-name path))))
10381 ((eq org-link-file-path-type 'noabbrev)
10382 (setq path (expand-file-name path)))
10383 ((eq org-link-file-path-type 'relative)
10384 (setq path (file-relative-name path)))
10387 (if (string-match (concat "^" (regexp-quote
10389 (file-name-as-directory
10390 default-directory))))
10391 (expand-file-name path))
10392 ;; We are linking a file with relative path name.
10393 (setq path (substring (expand-file-name path)
10395 (setq path (abbreviate-file-name (expand-file-name path)))))))
10396 (setq link (concat type path))
10397 (if (equal desc origpath)
10398 (setq desc path))))
10400 (if org-make-link-description-function
10402 (or (condition-case nil
10403 (funcall org-make-link-description-function link desc)
10404 (error (progn (message "Can't get link description from `%s'"
10405 (symbol-name org-make-link-description-function))
10407 (read-string "Description: " default-description)))
10408 (if default-description (setq desc default-description)
10409 (setq desc (or (and auto-desc desc)
10410 (read-string "Description: " desc)))))
10412 (unless (string-match "\\S-" desc) (setq desc nil))
10413 (if remove (apply 'delete-region remove))
10414 (insert (org-make-link-string link desc))))
10416 (defun org-link-try-special-completion (type)
10417 "If there is completion support for link type TYPE, offer it."
10418 (let ((fun (intern (concat "org-" type "-complete-link"))))
10419 (if (functionp fun)
10421 (read-string "Link (no completion support): " (concat type ":")))))
10423 (defun org-file-complete-link (&optional arg)
10424 "Create a file link using completion."
10426 (setq file (org-iread-file-name "File: "))
10427 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10428 (pwd1 (file-name-as-directory (abbreviate-file-name
10429 (expand-file-name ".")))))
10434 (abbreviate-file-name (expand-file-name file)))))
10435 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10436 (setq link (concat "file:" (match-string 1 file))))
10437 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10438 (expand-file-name file))
10440 "file:" (match-string 1 (expand-file-name file)))))
10441 (t (setq link (concat "file:" file)))))
10444 (defun org-iread-file-name (&rest args)
10445 "Read-file-name using `ido-mode' speedup if available.
10446 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10447 See `read-file-name' for a description of parameters."
10448 (org-without-partial-completion
10449 (if (and org-completion-use-ido
10450 (fboundp 'ido-read-file-name)
10451 (boundp 'ido-mode) ido-mode
10452 (listp (second args)))
10453 (let ((ido-enter-matching-directory nil))
10454 (apply 'ido-read-file-name args))
10455 (apply 'read-file-name args))))
10457 (defun org-completing-read (&rest args)
10458 "Completing-read with SPACE being a normal character."
10459 (let ((enable-recursive-minibuffers t)
10460 (minibuffer-local-completion-map
10461 (copy-keymap minibuffer-local-completion-map)))
10462 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10463 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10464 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10465 (apply 'org-icompleting-read args)))
10467 (defun org-completing-read-no-i (&rest args)
10468 (let (org-completion-use-ido org-completion-use-iswitchb)
10469 (apply 'org-completing-read args)))
10471 (defun org-iswitchb-completing-read (prompt choices &rest args)
10472 "Use iswitch as a completing-read replacement to choose from choices.
10473 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10475 (let* ((iswitchb-use-virtual-buffers nil)
10476 (iswitchb-make-buflist-hook
10478 (setq iswitchb-temp-buflist choices))))
10479 (iswitchb-read-buffer prompt)))
10481 (defun org-icompleting-read (&rest args)
10482 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10483 (org-without-partial-completion
10484 (if (and org-completion-use-ido
10485 (fboundp 'ido-completing-read)
10486 (boundp 'ido-mode) ido-mode
10487 (listp (second args)))
10488 (let ((ido-enter-matching-directory nil))
10489 (apply 'ido-completing-read (concat (car args))
10490 (if (consp (car (nth 1 args)))
10491 (mapcar 'car (nth 1 args))
10494 (if (and org-completion-use-iswitchb
10495 (boundp 'iswitchb-mode) iswitchb-mode
10496 (listp (second args)))
10497 (apply 'org-iswitchb-completing-read (concat (car args))
10498 (if (consp (car (nth 1 args)))
10499 (mapcar 'car (nth 1 args))
10502 (apply 'completing-read args)))))
10504 (defun org-extract-attributes (s)
10505 "Extract the attributes cookie from a string and set as text property."
10506 (let (a attr (start 0) key value)
10508 (when (string-match "{{\\([^}]+\\)}}$" s)
10509 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10510 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10511 (setq key (match-string 1 a) value (match-string 2 a)
10512 start (match-end 0)
10513 attr (plist-put attr (intern key) value))))
10514 (org-add-props s nil 'org-attr attr))
10517 ;;; Opening/following a link
10519 (defvar org-link-search-failed nil)
10521 (defvar org-open-link-functions nil
10522 "Hook for functions finding a plain text link.
10523 These functions must take a single argument, the link content.
10524 They will be called for links that look like [[link text][description]]
10525 when LINK TEXT does not have a protocol like \"http:\" and does not look
10526 like a filename (e.g. \"./blue.png\").
10528 These functions will be called *before* Org attempts to resolve the
10529 link by doing text searches in the current buffer - so if you want a
10530 link \"[[target]]\" to still find \"<<target>>\", your function should
10531 handle this as a special case.
10533 When the function does handle the link, it must return a non-nil value.
10534 If it decides that it is not responsible for this link, it must return
10535 nil to indicate that that Org-mode can continue with other options
10536 like exact and fuzzy text search.")
10538 (defun org-next-link (&optional search-backward)
10539 "Move forward to the next link.
10540 If the link is in hidden text, expose it."
10542 (when (and org-link-search-failed (eq this-command last-command))
10543 (goto-char (point-min))
10544 (message "Link search wrapped back to beginning of buffer"))
10545 (setq org-link-search-failed nil)
10546 (let* ((pos (point))
10548 (a (assoc :link ct))
10549 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10550 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10551 ((looking-at org-any-link-re)
10552 ;; Don't stay stuck at link without an org-link face
10553 (forward-char (if search-backward -1 1))))
10554 (if (funcall srch-fun org-any-link-re nil t)
10556 (goto-char (match-beginning 0))
10557 (if (outline-invisible-p) (org-show-context)))
10559 (setq org-link-search-failed t)
10560 (message "No further link found"))))
10562 (defun org-previous-link ()
10563 "Move backward to the previous link.
10564 If the link is in hidden text, expose it."
10566 (funcall 'org-next-link t))
10568 (defun org-translate-link (s)
10569 "Translate a link string if a translation function has been defined."
10570 (if (and org-link-translation-function
10571 (fboundp org-link-translation-function)
10572 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10574 (setq s (funcall org-link-translation-function
10575 (match-string 1 s) (match-string 2 s)))
10576 (concat (car s) ":" (cdr s)))
10579 (defun org-translate-link-from-planner (type path)
10580 "Translate a link from Emacs Planner syntax so that Org can follow it.
10581 This is still an experimental function, your mileage may vary."
10583 ((member type '("http" "https" "news" "ftp"))
10584 ;; standard Internet links are the same.
10586 ((and (equal type "irc") (string-match "^//" path))
10587 ;; Planner has two / at the beginning of an irc link, we have 1.
10588 ;; We should have zero, actually....
10589 (setq path (substring path 1)))
10590 ((and (equal type "lisp") (string-match "^/" path))
10591 ;; Planner has a slash, we do not.
10592 (setq type "elisp" path (substring path 1)))
10593 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10594 ;; A typical message link. Planner has the id after the final slash,
10595 ;; we separate it with a hash mark
10596 (setq path (concat (match-string 1 path) "#"
10597 (org-remove-angle-brackets (match-string 2 path))))))
10600 (defun org-find-file-at-mouse (ev)
10601 "Open file link or URL at mouse."
10603 (mouse-set-point ev)
10604 (org-open-at-point 'in-emacs))
10606 (defun org-open-at-mouse (ev)
10607 "Open file link or URL at mouse.
10608 See the docstring of `org-open-file' for details."
10610 (mouse-set-point ev)
10611 (if (eq major-mode 'org-agenda-mode)
10612 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10613 (org-open-at-point))
10615 (defvar org-window-config-before-follow-link nil
10616 "The window configuration before following a link.
10617 This is saved in case the need arises to restore it.")
10619 (defvar org-open-link-marker (make-marker)
10620 "Marker pointing to the location where `org-open-at-point' was called.")
10623 (defun org-open-at-point-global ()
10624 "Follow a link like Org-mode does.
10625 This command can be called in any mode to follow a link that has
10628 (org-run-like-in-org-mode 'org-open-at-point))
10631 (defun org-open-link-from-string (s &optional arg reference-buffer)
10632 "Open a link in the string S, as if it was in Org-mode."
10633 (interactive "sLink: \nP")
10634 (let ((reference-buffer (or reference-buffer (current-buffer))))
10636 (let ((org-inhibit-startup (not reference-buffer)))
10639 (goto-char (point-min))
10640 (when reference-buffer
10641 (setq org-link-abbrev-alist-local
10642 (with-current-buffer reference-buffer
10643 org-link-abbrev-alist-local)))
10644 (org-open-at-point arg reference-buffer)))))
10646 (defvar org-open-at-point-functions nil
10647 "Hook that is run when following a link at point.
10649 Functions in this hook must return t if they identify and follow
10650 a link at point. If they don't find anything interesting at point,
10651 they must return nil.")
10653 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10654 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10655 (defun org-open-at-point (&optional arg reference-buffer)
10656 "Open link, timestamp, footnote or tags at point.
10658 When point is on a link, follow it. Normally, files will be
10659 opened by an appropriate application. If the optional prefix
10660 argument ARG is non-nil, Emacs will visit the file. With
10661 a double prefix argument, try to open outside of Emacs, in the
10662 application the system uses for this file type.
10664 When point is on a timestamp, open the agenda at the day
10667 When point is a footnote definition, move to the first reference
10668 found. If it is on a reference, move to the associated
10671 When point is on a headline, display a list of every link in the
10672 entry, so it is possible to pick one, or all, of them. If point
10673 is on a tag, call `org-tags-view' instead.
10675 When optional argument REFERENCE-BUFFER is non-nil, it should
10676 specify a buffer from where the link search should happen. This
10677 is used internally by `org-open-link-from-string'.
10679 On top of syntactically correct links, this function will open
10680 the link at point in comments or comment blocks and the first
10681 link in a property drawer line."
10683 ;; On a code block, open block's results.
10684 (unless (call-interactively 'org-babel-open-src-block-result)
10685 (org-load-modules-maybe)
10686 (move-marker org-open-link-marker (point))
10687 (setq org-window-config-before-follow-link (current-window-configuration))
10688 (org-remove-occur-highlights nil nil t)
10689 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10691 ;; Only consider supported types, even if they are not
10692 ;; the closest one.
10693 (org-element-lineage
10694 (org-element-context)
10695 '(comment comment-block footnote-definition footnote-reference
10696 headline inlinetask link node-property timestamp)
10698 (type (org-element-type context))
10699 (value (org-element-property :value context)))
10701 ((not context) (user-error "No link found"))
10702 ;; Exception: open timestamps and links in properties drawers
10704 ((memq type '(comment comment-block node-property))
10705 (cond ((org-in-regexp org-any-link-re)
10706 (org-open-link-from-string (match-string-no-properties 0)))
10707 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10708 (org-follow-timestamp-link))
10709 (t (user-error "No link found"))))
10710 ;; On a headline or an inlinetask, but not on a timestamp,
10711 ;; a link, a footnote reference or on tags.
10712 ((and (memq type '(headline inlinetask))
10714 (progn (save-excursion (beginning-of-line)
10715 (looking-at org-complex-heading-regexp))
10716 (or (not (match-beginning 5))
10717 (< (point) (match-beginning 5)))))
10718 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10720 (links-end (cdr data)))
10722 (dolist (link (if (stringp links) (list links) links))
10723 (search-forward link nil links-end)
10724 (goto-char (match-beginning 0))
10725 (org-open-at-point))
10726 (require 'org-attach)
10727 (org-attach-reveal 'if-exists))))
10728 ;; Do nothing on white spaces after an object, unless point
10729 ;; is right after it.
10732 (goto-char (org-element-property :end context))
10733 (skip-chars-backward " \t")
10735 (user-error "No link found"))
10736 ((eq type 'timestamp) (org-follow-timestamp-link))
10737 ;; On tags within a headline or an inlinetask.
10738 ((and (memq type '(headline inlinetask))
10739 (progn (save-excursion (beginning-of-line)
10740 (looking-at org-complex-heading-regexp))
10741 (and (match-beginning 5)
10742 (>= (point) (match-beginning 5)))))
10743 (org-tags-view arg (substring (match-string 5) 0 -1)))
10745 ;; When link is located within the description of another
10746 ;; link (e.g., an inline image), always open the parent
10748 (let*((link (let ((up (org-element-property :parent context)))
10749 (if (eq (org-element-type up) 'link) up context)))
10750 (type (org-element-property :type link))
10751 (path (org-link-unescape (org-element-property :path link))))
10752 ;; Switch back to REFERENCE-BUFFER needed when called in
10753 ;; a temporary buffer through `org-open-link-from-string'.
10754 (with-current-buffer (or reference-buffer (current-buffer))
10756 ((equal type "file")
10757 (if (string-match "[*?{]" (file-name-nondirectory path))
10759 ;; Look into `org-link-protocols' in order to find
10760 ;; a DEDICATED-FUNCTION to open file. The function
10761 ;; will be applied on raw link instead of parsed
10762 ;; link due to the limitation in `org-add-link-type'
10763 ;; ("open" function called with a single argument).
10764 ;; If no such function is found, fallback to
10765 ;; `org-open-file'.
10767 ;; Note : "file+emacs" and "file+sys" types are
10768 ;; hard-coded in order to escape the previous
10770 (let* ((option (org-element-property :search-option link))
10771 (app (org-element-property :application link))
10772 (dedicated-function
10773 (nth 1 (assoc app org-link-protocols))))
10774 (if dedicated-function
10775 (funcall dedicated-function
10777 (and option (concat "::" option))))
10778 (apply 'org-open-file
10781 ((equal app "emacs") 'emacs)
10782 ((equal app "sys") 'system))
10783 (cond ((not option) nil)
10784 ((org-string-match-p "\\`[0-9]+\\'" option)
10785 (list (string-to-number option)))
10787 (org-link-unescape option)))))))))
10788 ((assoc type org-link-protocols)
10789 (funcall (nth 1 (assoc type org-link-protocols)) path))
10790 ((equal type "help")
10791 (let ((f-or-v (intern path)))
10792 (cond ((fboundp f-or-v) (describe-function f-or-v))
10793 ((boundp f-or-v) (describe-variable f-or-v))
10794 (t (error "Not a known function or variable")))))
10795 ((member type '("http" "https" "ftp" "mailto" "news"))
10796 (browse-url (org-link-escape-browser (concat type ":" path))))
10797 ((equal type "doi")
10799 (org-link-escape-browser (concat org-doi-server-url path))))
10800 ((equal type "message") (browse-url (concat type ":" path)))
10801 ((equal type "shell")
10802 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10804 (if (or (and (org-string-nw-p
10805 org-confirm-shell-link-not-regexp)
10807 org-confirm-shell-link-not-regexp cmd))
10808 (not org-confirm-shell-link-function)
10809 (funcall org-confirm-shell-link-function
10810 (format "Execute \"%s\" in shell? "
10811 (org-add-props cmd nil
10812 'face 'org-warning))))
10814 (message "Executing %s" cmd)
10815 (shell-command cmd buf)
10816 (when (featurep 'midnight)
10817 (setq clean-buffer-list-kill-buffer-names
10819 clean-buffer-list-kill-buffer-names))))
10820 (user-error "Abort"))))
10821 ((equal type "elisp")
10823 (if (or (and (org-string-nw-p
10824 org-confirm-elisp-link-not-regexp)
10825 (org-string-match-p
10826 org-confirm-elisp-link-not-regexp cmd))
10827 (not org-confirm-elisp-link-function)
10828 (funcall org-confirm-elisp-link-function
10829 (format "Execute \"%s\" as elisp? "
10830 (org-add-props cmd nil
10831 'face 'org-warning))))
10832 (message "%s => %s" cmd
10833 (if (eq (string-to-char cmd) ?\()
10835 (call-interactively (read cmd))))
10836 (user-error "Abort"))))
10839 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10840 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10841 (unless (run-hook-with-args-until-success
10842 'org-open-link-functions path)
10843 (if (not arg) (org-mark-ring-push)
10844 (switch-to-buffer-other-window
10845 (org-get-buffer-for-internal-link (current-buffer))))
10846 (let ((cmd `(org-link-search
10847 ,(if (member type '("custom-id" "coderef"))
10848 (org-element-property :raw-link link)
10850 ,(cond ((equal arg '(4)) 'occur)
10851 ((equal arg '(16)) 'org-occur))
10852 ,(org-element-property :begin link))))
10853 (condition-case nil
10854 (let ((org-link-search-inhibit-query t))
10856 (error (progn (widen) (eval cmd)))))))
10857 (t (browse-url-at-point))))))
10858 ;; On a footnote reference or at a footnote definition's label.
10859 ((or (eq type 'footnote-reference)
10860 (and (eq type 'footnote-definition)
10862 ;; Do not validate action when point is on the
10863 ;; spaces right after the footnote label, in
10864 ;; order to be on par with behaviour on links.
10865 (skip-chars-forward " \t")
10867 (org-element-property :contents-begin context)))
10868 (if begin (< (point) begin)
10869 (= (org-element-property :post-affiliated context)
10870 (line-beginning-position)))))))
10871 (org-footnote-action))
10872 (t (user-error "No link found")))))
10873 (move-marker org-open-link-marker nil)
10874 (run-hook-with-args 'org-follow-link-hook)))
10876 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10877 "Offer links in the current entry and return the selected link.
10878 If there is only one link, return it.
10879 If NTH is an integer, return the NTH link found.
10880 If ZERO is a string, check also this string for a link, and if
10881 there is one, return it."
10882 (with-current-buffer buffer
10888 (in-emacs (if (integerp nth) nil nth))
10889 have-zero end links link c)
10890 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10891 (push (match-string 0 zero) links)
10892 (setq cnt (1- cnt) have-zero t))
10894 (org-back-to-heading t)
10895 (setq end (save-excursion (outline-next-heading) (point)))
10896 (while (re-search-forward org-any-link-re end t)
10897 (push (match-string 0) links))
10898 (setq links (org-uniquify (reverse links))))
10901 (message "No links"))
10902 ((equal (length links) 1)
10903 (setq link (car links)))
10904 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10905 (setq link (nth (if have-zero nth (1- nth)) links)))
10906 (t ; we have to select a link
10908 (save-window-excursion
10909 (delete-other-windows)
10910 (with-output-to-temp-buffer "*Select Link*"
10912 (if (not (string-match org-bracket-link-regexp l))
10913 (princ (format "[%c] %s\n" (incf cnt)
10914 (org-remove-angle-brackets l)))
10916 (princ (format "[%c] %s (%s)\n" (incf cnt)
10917 (match-string 3 l) (match-string 1 l)))
10918 (princ (format "[%c] %s\n" (incf cnt)
10919 (match-string 1 l))))))
10921 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10922 (message "Select link to open, RET to open all:")
10923 (setq c (read-char-exclusive))
10924 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10925 (when (equal c ?q) (user-error "Abort"))
10926 (if (equal c ?\C-m)
10928 (setq nth (- c ?0))
10929 (if have-zero (setq nth (1+ nth)))
10930 (unless (and (integerp nth) (>= (length links) nth))
10931 (user-error "Invalid link selection"))
10932 (setq link (nth (1- nth) links)))))
10933 (cons link end))))))
10935 ;; TODO: These functions are deprecated since `org-open-at-point'
10936 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10937 (defun org-open-file-with-system (path)
10938 "Open file at PATH using the system way of opening it."
10939 (org-open-file path 'system))
10940 (defun org-open-file-with-emacs (path)
10941 "Open file at PATH in Emacs."
10942 (org-open-file path 'emacs))
10947 (defvar org-create-file-search-functions nil
10948 "List of functions to construct the right search string for a file link.
10949 These functions are called in turn with point at the location to
10950 which the link should point.
10952 A function in the hook should first test if it would like to
10953 handle this file type, for example by checking the `major-mode'
10954 or the file extension. If it decides not to handle this file, it
10955 should just return nil to give other functions a chance. If it
10956 does handle the file, it must return the search string to be used
10957 when following the link. The search string will be part of the
10958 file link, given after a double colon, and `org-open-at-point'
10959 will automatically search for it. If special measures must be
10960 taken to make the search successful, another function should be
10961 added to the companion hook `org-execute-file-search-functions',
10964 A function in this hook may also use `setq' to set the variable
10965 `description' to provide a suggestion for the descriptive text to
10966 be used for this link when it gets inserted into an Org-mode
10967 buffer with \\[org-insert-link].")
10969 (defvar org-execute-file-search-functions nil
10970 "List of functions to execute a file search triggered by a link.
10972 Functions added to this hook must accept a single argument, the
10973 search string that was part of the file link, the part after the
10974 double colon. The function must first check if it would like to
10975 handle this search, for example by checking the `major-mode' or
10976 the file extension. If it decides not to handle this search, it
10977 should just return nil to give other functions a chance. If it
10978 does handle the search, it must return a non-nil value to keep
10979 other functions from trying.
10981 Each function can access the current prefix argument through the
10982 variable `current-prefix-arg'. Note that a single prefix is used
10983 to force opening a link in Emacs, so it may be good to only use a
10984 numeric or double prefix to guide the search function.
10986 In case this is needed, a function in this hook can also restore
10987 the window configuration before `org-open-at-point' was called using:
10989 (set-window-configuration org-window-config-before-follow-link)")
10991 (defun org-link-search (s &optional type avoid-pos stealth)
10992 "Search for a link search option.
10993 If S is surrounded by forward slashes, it is interpreted as a
10994 regular expression. In org-mode files, this will create an `org-occur'
10995 sparse tree. In ordinary files, `occur' will be used to list matches.
10996 If the current buffer is in `dired-mode', grep will be used to search
10997 in all files. If AVOID-POS is given, ignore matches near that position.
10999 When optional argument STEALTH is non-nil, do not modify
11000 visibility around point, thus ignoring
11001 `org-show-hierarchy-above', `org-show-following-heading' and
11002 `org-show-siblings' variables."
11003 (let ((case-fold-search t)
11004 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11005 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11006 (append '(("") (" ") ("\t") ("\n"))
11007 org-emphasis-alist)
11010 (pre nil) (post nil)
11011 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
11013 ;; First check if there are any special search functions
11014 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11015 ;; Now try the builtin stuff
11016 ((and (equal (string-to-char s0) ?#)
11019 (goto-char (point-min))
11022 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
11023 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
11024 (setq type 'dedicated
11025 pos (match-beginning 0))))
11026 ;; There is an exact target for this
11028 (org-back-to-heading t)))
11030 (goto-char (point-min))
11033 (concat "<<" (regexp-quote s0) ">>") nil t)
11034 (setq type 'dedicated
11035 pos (match-beginning 0))))
11036 ;; There is an exact target for this
11039 (goto-char (point-min))
11042 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11043 (setq type 'dedicated pos (match-beginning 0))))
11044 ;; Found an element with a matching #+name affiliated keyword.
11046 ((and (string-match "^(\\(.*\\))$" s0)
11048 (goto-char (point-min))
11051 (concat "[^[]" (regexp-quote
11052 (format org-coderef-label-format
11053 (match-string 1 s0))))
11055 (setq type 'dedicated
11056 pos (1+ (match-beginning 0))))))
11057 ;; There is a coderef target for this
11059 ((string-match "^/\\(.*\\)/$" s)
11060 ;; A regular expression
11062 ((derived-mode-p 'org-mode)
11063 (org-occur (match-string 1 s)))
11064 (t (org-do-occur (match-string 1 s)))))
11065 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
11066 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11067 (goto-char (point-min))
11069 ((let (case-fold-search)
11070 (re-search-forward (format org-complex-heading-regexp-format
11073 ;; OK, found a match
11074 (setq type 'dedicated)
11075 (goto-char (match-beginning 0)))
11076 ((and (not org-link-search-inhibit-query)
11077 (eq org-link-search-must-match-exact-headline 'query-to-create)
11078 (y-or-n-p "No match - create this as a new heading? "))
11079 (goto-char (point-max))
11080 (or (bolp) (newline))
11081 (insert "* " s "\n")
11082 (beginning-of-line 0))
11085 (error "No match"))))
11087 ;; A normal search string
11088 (when (equal (string-to-char s) ?*)
11089 ;; Anchor on headlines, post may include tags.
11090 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
11091 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
11092 s (substring s 1)))
11093 (remove-text-properties
11095 '(face nil mouse-face nil keymap nil fontified nil) s)
11096 ;; Make a series of regular expressions to find a match
11097 (setq words (org-split-string s "[ \n\r\t]+")
11099 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11100 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11102 re2a_ (concat "\\(" (mapconcat 'downcase words
11103 "[ \t\r\n]+") "\\)[ \t\r\n]")
11104 re2a (concat "[ \t\r\n]" re2a_)
11105 re4_ (concat "\\(" (mapconcat 'downcase words
11106 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11107 re4 (concat "[^a-zA-Z_]" re4_)
11109 re1 (concat pre re2 post)
11110 re3 (concat pre (if pre re4_ re4) post)
11111 re5 (concat pre ".*" re4)
11112 re2 (concat pre re2)
11113 re2a (concat pre (if pre re2a_ re2a))
11114 re4 (concat pre (if pre re4_ re4))
11115 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
11116 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
11119 ((eq type 'org-occur) (org-occur reall))
11120 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11121 (t (goto-char (point-min))
11123 (if (or (and (org-search-not-self 1 re0 nil t)
11124 (setq type 'dedicated))
11125 (org-search-not-self 1 re1 nil t)
11126 (org-search-not-self 1 re2 nil t)
11127 (org-search-not-self 1 re2a nil t)
11128 (org-search-not-self 1 re3 nil t)
11129 (org-search-not-self 1 re4 nil t)
11130 (org-search-not-self 1 re5 nil t))
11131 (goto-char (match-beginning 1))
11133 (error "No match"))))))
11134 (and (derived-mode-p 'org-mode)
11136 (org-show-context 'link-search))
11139 (defun org-search-not-self (group &rest args)
11140 "Execute `re-search-forward', but only accept matches that do not
11141 enclose the position of `org-open-link-marker'."
11142 (let ((m org-open-link-marker))
11144 (while (apply 're-search-forward args)
11145 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11146 (goto-char (match-end group))
11147 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11148 (> (match-beginning 0) (marker-position m))
11149 (< (match-end 0) (marker-position m)))
11151 (or (not (org-in-regexp
11152 org-bracket-link-analytic-regexp 1))
11153 (not (match-end 4)) ; no description
11154 (and (<= (match-beginning 4) (point))
11155 (>= (match-end 4) (point))))))
11156 (throw 'exit (point))))))))
11158 (defun org-get-buffer-for-internal-link (buffer)
11159 "Return a buffer to be used for displaying the link target of internal links."
11161 ((not org-display-internal-link-with-indirect-buffer)
11163 ((string-match "(Clone)$" (buffer-name buffer))
11164 (message "Buffer is already a clone, not making another one")
11165 ;; we also do not modify visibility in this case
11167 (t ; make a new indirect buffer for displaying the link
11168 (let* ((bn (buffer-name buffer))
11169 (ibn (concat bn "(Clone)"))
11170 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11171 (with-current-buffer ib (org-overview))
11174 (defun org-do-occur (regexp &optional cleanup)
11175 "Call the Emacs command `occur'.
11176 If CLEANUP is non-nil, remove the printout of the regular expression
11177 in the *Occur* buffer. This is useful if the regex is long and not useful
11181 (let ((cwin (selected-window)) win beg end)
11182 (when (setq win (get-buffer-window "*Occur*"))
11183 (select-window win))
11184 (goto-char (point-min))
11185 (when (re-search-forward "match[a-z]+" nil t)
11186 (setq beg (match-end 0))
11187 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11188 (setq end (1- (match-beginning 0)))))
11189 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11190 (goto-char (point-min))
11191 (select-window cwin))))
11193 ;;; The mark ring for links jumps
11195 (defvar org-mark-ring nil
11196 "Mark ring for positions before jumps in Org-mode.")
11197 (defvar org-mark-ring-last-goto nil
11198 "Last position in the mark ring used to go back.")
11199 ;; Fill and close the ring
11200 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11201 (loop for i from 1 to org-mark-ring-length do
11202 (push (make-marker) org-mark-ring))
11203 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11206 (defun org-mark-ring-push (&optional pos buffer)
11207 "Put the current position or POS into the mark ring and rotate it."
11209 (setq pos (or pos (point)))
11210 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11211 (move-marker (car org-mark-ring)
11213 (or buffer (current-buffer)))
11215 (substitute-command-keys
11216 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11218 (defun org-mark-ring-goto (&optional n)
11219 "Jump to the previous position in the mark ring.
11220 With prefix arg N, jump back that many stored positions. When
11221 called several times in succession, walk through the entire ring.
11222 Org-mode commands jumping to a different position in the current file,
11223 or to another Org-mode file, automatically push the old position
11227 (if (eq last-command this-command)
11228 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11229 (setq p org-mark-ring))
11230 (setq org-mark-ring-last-goto p)
11232 (org-pop-to-buffer-same-window (marker-buffer m))
11234 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11236 (defun org-remove-angle-brackets (s)
11237 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11238 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11240 (defun org-add-angle-brackets (s)
11241 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11242 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11244 (defun org-remove-double-quotes (s)
11245 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11246 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11249 ;;; Following specific links
11251 (defun org-follow-timestamp-link ()
11252 "Open an agenda view for the time-stamp date/range at point."
11254 ((org-at-date-range-p t)
11255 (let ((org-agenda-start-on-weekday)
11256 (t1 (match-string 1))
11257 (t2 (match-string 2)) tt1 tt2)
11258 (setq tt1 (time-to-days (org-time-string-to-time t1))
11259 tt2 (time-to-days (org-time-string-to-time t2)))
11260 (let ((org-agenda-buffer-tmp-name
11261 (format "*Org Agenda(a:%s)"
11262 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11263 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11264 ((org-at-timestamp-p t)
11265 (let ((org-agenda-buffer-tmp-name
11266 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11267 (org-agenda-list nil (time-to-days (org-time-string-to-time
11268 (substring (match-string 1) 0 10)))
11270 (t (error "This should not happen"))))
11273 ;;; Following file links
11274 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11275 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11276 (declare-function mailcap-mime-info
11277 "mailcap" (string &optional request no-decode))
11278 (defvar org-wait nil)
11279 (defun org-open-file (path &optional in-emacs line search)
11280 "Open the file at PATH.
11281 First, this expands any special file name abbreviations. Then the
11282 configuration variable `org-file-apps' is checked if it contains an
11283 entry for this file type, and if yes, the corresponding command is launched.
11285 If no application is found, Emacs simply visits the file.
11287 With optional prefix argument IN-EMACS, Emacs will visit the file.
11288 With a double \\[universal-argument] \\[universal-argument] \
11289 prefix arg, Org tries to avoid opening in Emacs
11290 and to use an external application to visit the file.
11292 Optional LINE specifies a line to go to, optional SEARCH a string
11293 to search for. If LINE or SEARCH is given, the file will be
11294 opened in Emacs, unless an entry from org-file-apps that makes
11295 use of groups in a regexp matches.
11297 If you want to change the way frames are used when following a
11298 link, please customize `org-link-frame-setup'.
11300 If the file does not exist, an error is thrown."
11301 (let* ((file (if (equal path "")
11303 (substitute-in-file-name (expand-file-name path))))
11304 (file-apps (append org-file-apps (org-default-apps)))
11305 (apps (org-remove-if
11306 'org-file-apps-entry-match-against-dlink-p file-apps))
11307 (apps-dlink (org-remove-if-not
11308 'org-file-apps-entry-match-against-dlink-p file-apps))
11309 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11310 (dirp (if remp nil (file-directory-p file)))
11311 (file (if (and dirp org-open-directory-means-index-dot-org)
11312 (concat (file-name-as-directory file) "index.org")
11314 (a-m-a-p (assq 'auto-mode apps))
11315 (dfile (downcase file))
11316 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11317 (link (cond ((and (eq line nil)
11321 (concat file "::" (number-to-string line)))
11323 (concat file "::" search))))
11324 (dlink (downcase link))
11325 (old-buffer (current-buffer))
11327 (old-mode major-mode)
11328 ext cmd link-match-data)
11329 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11330 (setq ext (match-string 1 dfile))
11331 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11332 (setq ext (match-string 1 dfile))))
11334 ((member in-emacs '((16) system))
11335 (setq cmd (cdr (assoc 'system apps))))
11336 (in-emacs (setq cmd 'emacs))
11338 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11339 (and dirp (cdr (assoc 'directory apps)))
11340 ; first, try matching against apps-dlink
11341 ; if we get a match here, store the match data for later
11342 (let ((match (assoc-default dlink apps-dlink
11345 (progn (setq link-match-data (match-data))
11347 (progn (setq in-emacs (or in-emacs line search))
11348 nil))) ; if we have no match in apps-dlink,
11349 ; always open the file in emacs if line or search
11350 ; is given (for backwards compatibility)
11351 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11353 (cdr (assoc ext apps))
11354 (cdr (assoc t apps))))))
11355 (when (eq cmd 'system)
11356 (setq cmd (cdr (assoc 'system apps))))
11357 (when (eq cmd 'default)
11358 (setq cmd (cdr (assoc t apps))))
11359 (when (eq cmd 'mailcap)
11361 (mailcap-parse-mailcaps)
11362 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11363 (command (mailcap-mime-info mime-type)))
11364 (if (stringp command)
11366 (setq cmd 'emacs))))
11367 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11368 (not (file-exists-p file))
11369 (not org-open-non-existing-files))
11370 (user-error "No such file: %s" file))
11372 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11373 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11374 (while (string-match "['\"]%s['\"]" cmd)
11375 (setq cmd (replace-match "%s" t t cmd)))
11376 (while (string-match "%s" cmd)
11377 (setq cmd (replace-match
11379 (shell-quote-argument
11380 (convert-standard-filename file)))
11383 ;; Replace "%1", "%2" etc. in command with group matches from regex
11385 (let ((match-index 1)
11386 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11387 (set-match-data link-match-data)
11388 (while (<= match-index number-of-groups)
11389 (let ((regex (concat "%" (number-to-string match-index)))
11390 (replace-with (match-string match-index dlink)))
11391 (while (string-match regex cmd)
11392 (setq cmd (replace-match replace-with t t cmd))))
11393 (setq match-index (+ match-index 1)))))
11395 (save-window-excursion
11396 (message "Running %s...done" cmd)
11397 (start-process-shell-command cmd nil cmd)
11398 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11401 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11403 (if line (progn (org-goto-line line)
11404 (if (derived-mode-p 'org-mode)
11406 (if search (org-link-search search))))
11408 (let ((file (convert-standard-filename file)))
11410 (set-match-data link-match-data)
11412 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11413 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11414 (or (not (equal old-buffer (current-buffer)))
11415 (not (equal old-pos (point))))
11416 (org-mark-ring-push old-pos old-buffer))))
11418 (defun org-file-apps-entry-match-against-dlink-p (entry)
11419 "This function returns non-nil if `entry' uses a regular
11420 expression which should be matched against the whole link by
11423 It assumes that is the case when the entry uses a regular
11424 expression which has at least one grouping construct and the
11425 action is either a lisp form or a command string containing
11426 '%1', i.e. using at least one subexpression match as a
11428 (let ((selector (car entry))
11429 (action (cdr entry)))
11430 (if (stringp selector)
11431 (and (> (regexp-opt-depth selector) 0)
11432 (or (and (stringp action)
11433 (string-match "%[0-9]" action))
11437 (defun org-default-apps ()
11438 "Return the default applications for this operating system."
11440 ((eq system-type 'darwin)
11441 org-file-apps-defaults-macosx)
11442 ((eq system-type 'windows-nt)
11443 org-file-apps-defaults-windowsnt)
11444 (t org-file-apps-defaults-gnu)))
11446 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11447 "Convert extensions to regular expressions in the cars of LIST.
11448 Also, weed out any non-string entries, because the return value is used
11449 only for regexp matching.
11450 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11451 point to the symbol `emacs', indicating that the file should
11452 be opened in Emacs."
11455 (mapcar (lambda (x)
11456 (if (not (stringp (car x)))
11458 (if (string-match "\\W" (car x))
11460 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11463 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11465 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11466 (defun org-file-remote-p (file)
11467 "Test whether FILE specifies a location on a remote system.
11468 Return non-nil if the location is indeed remote.
11470 For example, the filename \"/user@host:/foo\" specifies a location
11471 on the system \"/user@host:\"."
11472 (cond ((fboundp 'file-remote-p)
11473 (file-remote-p file))
11474 ((fboundp 'tramp-handle-file-remote-p)
11475 (tramp-handle-file-remote-p file))
11476 ((and (boundp 'ange-ftp-name-format)
11477 (string-match (car ange-ftp-name-format) file))
11483 (defun org-get-org-file ()
11484 "Read a filename, with default directory `org-directory'."
11485 (let ((default (or org-default-notes-file remember-data-file)))
11486 (read-file-name (format "File name [%s]: " default)
11487 (file-name-as-directory org-directory)
11490 (defun org-notes-order-reversed-p ()
11491 "Check if the current file should receive notes in reversed order."
11493 ((not org-reverse-note-order) nil)
11494 ((eq t org-reverse-note-order) t)
11495 ((not (listp org-reverse-note-order)) nil)
11497 (let ((all org-reverse-note-order)
11499 (while (setq entry (pop all))
11500 (if (string-match (car entry) buffer-file-name)
11501 (throw 'exit (cdr entry))))
11504 (defvar org-refile-target-table nil
11505 "The list of refile targets, created by `org-refile'.")
11507 (defvar org-agenda-new-buffers nil
11508 "Buffers created to visit agenda files.")
11510 (defvar org-refile-cache nil
11511 "Cache for refile targets.")
11513 (defvar org-refile-markers nil
11514 "All the markers used for caching refile locations.")
11516 (defun org-refile-marker (pos)
11517 "Get a new refile marker, but only if caching is in use."
11518 (if (not org-refile-use-cache)
11520 (let ((m (make-marker)))
11521 (move-marker m pos)
11522 (push m org-refile-markers)
11525 (defun org-refile-cache-clear ()
11526 "Clear the refile cache and disable all the markers."
11527 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11528 (setq org-refile-markers nil)
11529 (setq org-refile-cache nil)
11530 (message "Refile cache has been cleared"))
11532 (defun org-refile-cache-check-set (set)
11533 "Check if all the markers in the cache still have live buffers."
11536 (while (and set (setq marker (nth 3 (pop set))))
11537 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11538 (when (and marker (null (marker-buffer marker)))
11539 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11541 (throw 'exit nil)))
11544 (defun org-refile-cache-put (set &rest identifiers)
11545 "Push the refile targets SET into the cache, under IDENTIFIERS."
11546 (let* ((key (sha1 (prin1-to-string identifiers)))
11547 (entry (assoc key org-refile-cache)))
11550 (push (cons key set) org-refile-cache))))
11552 (defun org-refile-cache-get (&rest identifiers)
11553 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11555 ((not org-refile-cache) nil)
11556 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11558 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11559 org-refile-cache))))
11560 (and set (org-refile-cache-check-set set) set)))))
11562 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11563 "Produce a table with refile targets."
11564 (let ((case-fold-search nil)
11565 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11566 (entries (or org-refile-targets '((nil . (:level . 1)))))
11567 targets tgs txt re files f desc descre fast-path-p level pos0)
11568 (message "Getting targets...")
11569 (with-current-buffer (or default-buffer (current-buffer))
11570 (while (setq entry (pop entries))
11571 (setq files (car entry) desc (cdr entry))
11572 (setq fast-path-p nil)
11574 ((null files) (setq files (list (current-buffer))))
11575 ((eq files 'org-agenda-files)
11576 (setq files (org-agenda-files 'unrestricted)))
11577 ((and (symbolp files) (fboundp files))
11578 (setq files (funcall files)))
11579 ((and (symbolp files) (boundp files))
11580 (setq files (symbol-value files))))
11581 (if (stringp files) (setq files (list files)))
11583 ((eq (car desc) :tag)
11584 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11585 ((eq (car desc) :todo)
11586 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11587 ((eq (car desc) :regexp)
11588 (setq descre (cdr desc)))
11589 ((eq (car desc) :level)
11590 (setq descre (concat "^\\*\\{" (number-to-string
11591 (if org-odd-levels-only
11592 (1- (* 2 (cdr desc)))
11595 ((eq (car desc) :maxlevel)
11596 (setq fast-path-p t)
11597 (setq descre (concat "^\\*\\{1," (number-to-string
11598 (if org-odd-levels-only
11599 (1- (* 2 (cdr desc)))
11602 (t (error "Bad refiling target description %s" desc)))
11603 (while (setq f (pop files))
11604 (with-current-buffer
11605 (if (bufferp f) f (org-get-agenda-file-buffer f))
11607 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11609 (if (bufferp f) (setq f (buffer-file-name
11610 (buffer-base-buffer f))))
11611 (setq f (and f (expand-file-name f)))
11612 (if (eq org-refile-use-outline-path 'file)
11613 (push (list (file-name-nondirectory f) f nil nil) tgs))
11617 (goto-char (point-min))
11618 (while (re-search-forward descre nil t)
11619 (goto-char (setq pos0 (point-at-bol)))
11621 (when org-refile-target-verify-function
11623 (or (funcall org-refile-target-verify-function)
11625 (when (and (looking-at org-complex-heading-regexp)
11626 (not (member (match-string 4) excluded-entries))
11628 (setq level (org-reduced-level
11629 (- (match-end 1) (match-beginning 1)))
11630 txt (org-link-display-format (match-string 4))
11631 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11632 re (format org-complex-heading-regexp-format
11633 (regexp-quote (match-string 4))))
11634 (when org-refile-use-outline-path
11635 (setq txt (mapconcat
11638 (if (eq org-refile-use-outline-path
11640 (list (file-name-nondirectory
11642 (buffer-base-buffer))))
11643 (if (eq org-refile-use-outline-path
11645 (list (buffer-file-name
11646 (buffer-base-buffer)))))
11647 (org-get-outline-path fast-path-p
11651 (push (list txt f re (org-refile-marker (point)))
11653 (when (= (point) pos0)
11654 ;; verification function has not moved point
11655 (goto-char (point-at-eol))))))))
11656 (when org-refile-use-cache
11657 (org-refile-cache-put tgs (buffer-file-name) descre))
11658 (setq targets (append tgs targets))))))
11659 (message "Getting targets...done")
11660 (nreverse targets)))
11662 (defun org-protect-slash (s)
11663 (while (string-match "/" s)
11664 (setq s (replace-match "\\" t t s)))
11667 (defvar org-olpa (make-vector 20 nil))
11669 (defun org-get-outline-path (&optional fastp level heading)
11670 "Return the outline path to the current entry, as a list.
11672 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11673 routine which makes outline path derivations for an entire file,
11674 avoiding backtracing. Refile target collection makes use of that."
11678 (error "Outline path failure, more than 19 levels"))
11679 (loop for i from level upto 19 do
11680 (aset org-olpa i nil))
11682 (delq nil (append org-olpa nil))
11683 (aset org-olpa level heading)))
11684 (let (rtn case-fold-search)
11688 (while (org-up-heading-safe)
11689 (when (looking-at org-complex-heading-regexp)
11691 (replace-regexp-in-string
11692 ;; Remove statistical/checkboxes cookies
11693 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11694 (org-match-string-no-properties 4)))
11698 (defun org-format-outline-path (path &optional width prefix separator)
11699 "Format the outline path PATH for display.
11700 WIDTH is the maximum number of characters that is available.
11701 PREFIX is a prefix to be included in the returned string,
11702 such as the file name.
11703 SEPARATOR is inserted between the different parts of the path,
11704 the default is \"/\"."
11705 (setq width (or width 79))
11706 (if prefix (setq width (- width (length prefix))))
11709 (let* ((nsteps (length path))
11710 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11711 (maxwidth (if (<= total-width width)
11712 10000 ;; everything fits
11713 ;; we need to shorten the level headings
11714 (/ (- width nsteps) nsteps)))
11715 (org-odd-levels-only nil)
11717 (total (1+ (length prefix))))
11718 (setq maxwidth (max maxwidth 10))
11720 (if prefix (or separator "/"))
11724 (if (and (= n nsteps) (< maxwidth 10000))
11725 (setq maxwidth (- total-width total)))
11726 (if (< (length h) maxwidth)
11727 (progn (setq total (+ total (length h) 1)) h)
11728 (setq h (substring h 0 (- maxwidth 2))
11729 total (+ total maxwidth 1))
11730 (if (string-match "[ \t]+\\'" h)
11731 (setq h (substring h 0 (match-beginning 0))))
11732 (setq h (concat h "..")))
11733 (org-add-props h nil 'face
11734 (nth (% (1- n) org-n-level-faces)
11737 path (or separator "/"))))))
11739 (defun org-display-outline-path (&optional file current separator just-return-string)
11740 "Display the current outline path in the echo area.
11742 If FILE is non-nil, prepend the output with the file name.
11743 If CURRENT is non-nil, append the current heading to the output.
11744 SEPARATOR is passed through to `org-format-outline-path'. It separates
11745 the different parts of the path and defaults to \"/\".
11746 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11748 (let* (case-fold-search
11749 (bfn (buffer-file-name (buffer-base-buffer)))
11750 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11752 (if current (setq path (append path
11754 (org-back-to-heading t)
11755 (if (looking-at org-complex-heading-regexp)
11756 (list (match-string 4)))))))
11758 (org-format-outline-path
11761 (and file bfn (concat (file-name-nondirectory bfn) separator))
11763 (if just-return-string
11764 (org-no-properties res)
11765 (org-unlogged-message "%s" res))))
11767 (defvar org-refile-history nil
11768 "History for refiling operations.")
11770 (defvar org-after-refile-insert-hook nil
11771 "Hook run after `org-refile' has inserted its stuff at the new location.
11772 Note that this is still *before* the stuff will be removed from
11773 the *old* location.")
11775 (defvar org-capture-last-stored-marker)
11776 (defvar org-refile-keep nil
11777 "Non-nil means `org-refile' will copy instead of refile.")
11780 "Like `org-refile', but copy."
11782 (let ((org-refile-keep t))
11783 (funcall 'org-refile nil nil nil "Copy")))
11785 (defun org-refile (&optional arg default-buffer rfloc msg)
11786 "Move the entry or entries at point to another heading.
11787 The list of target headings is compiled using the information in
11788 `org-refile-targets', which see.
11790 At the target location, the entry is filed as a subitem of the
11791 target heading. Depending on `org-reverse-note-order', the new
11792 subitem will either be the first or the last subitem.
11794 If there is an active region, all entries in that region will be
11795 refiled. However, the region must fulfill the requirement that
11796 the first heading sets the top-level of the moved text.
11798 With prefix arg ARG, the command will only visit the target
11799 location and not actually move anything.
11801 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11802 refiling operation has put the subtree.
11804 With a numeric prefix argument of `2', refile to the running clock.
11806 With a numeric prefix argument of `3', emulate `org-refile-keep'
11807 being set to `t' and copy to the target location, don't move it.
11808 Beware that keeping refiled entries may result in duplicated ID
11811 RFLOC can be a refile location obtained in a different way.
11813 MSG is a string to replace \"Refile\" in the default prompt with
11814 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11816 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11818 If you are using target caching (see `org-refile-use-cache'), you
11819 have to clear the target cache in order to find new targets.
11820 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11821 prefix argument (`C-u C-u C-u C-c C-w')."
11823 (if (member arg '(0 (64)))
11824 (org-refile-cache-clear)
11825 (let* ((actionmsg (cond (msg msg)
11826 ((equal arg 3) "Refile (and keep)")
11828 (cbuf (current-buffer))
11829 (regionp (org-region-active-p))
11830 (region-start (and regionp (region-beginning)))
11831 (region-end (and regionp (region-end)))
11832 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11833 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11834 pos it nbuf file re level reversed)
11835 (setq last-command nil)
11837 (goto-char region-start)
11838 (or (bolp) (goto-char (point-at-bol)))
11839 (setq region-start (point))
11840 (unless (or (org-kill-is-subtree-p
11841 (buffer-substring region-start region-end))
11842 (prog1 org-refile-active-region-within-subtree
11843 (let ((s (point-at-eol)))
11844 (org-toggle-heading)
11845 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11846 (user-error "The region is not a (sequence of) subtree(s)")))
11847 (if (equal arg '(16))
11848 (org-refile-goto-last-stored)
11851 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11853 (setq it (list (or org-clock-heading "running clock")
11855 (marker-buffer org-clock-hd-marker))
11857 (marker-position org-clock-hd-marker)))
11860 (let (heading-text)
11862 (unless (and arg (listp arg))
11863 (org-back-to-heading t)
11865 (replace-regexp-in-string
11866 org-bracket-link-regexp
11868 (nth 4 (org-heading-components)))))
11869 (org-refile-get-location
11870 (cond ((and arg (listp arg)) "Goto")
11871 (regionp (concat actionmsg " region to"))
11872 (t (concat actionmsg " subtree \""
11873 heading-text "\" to")))
11875 (and (not (equal '(4) arg))
11876 org-refile-allow-creating-parent-nodes)
11878 (setq file (nth 1 it)
11883 (equal (buffer-file-name) file)
11885 (and (>= pos region-start)
11886 (<= pos region-end))
11887 (and (>= pos (point))
11888 (< pos (save-excursion
11889 (org-end-of-subtree t t))))))
11890 (error "Cannot refile to position inside the tree or region"))
11891 (setq nbuf (or (find-buffer-visiting file)
11892 (find-file-noselect file)))
11893 (if (and arg (not (equal arg 3)))
11895 (org-pop-to-buffer-same-window nbuf)
11897 (org-show-context 'org-goto))
11900 (org-kill-new (buffer-substring region-start region-end))
11901 (org-save-markers-in-region region-start region-end))
11902 (org-copy-subtree 1 nil t))
11903 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11904 (find-file-noselect file)))
11905 (setq reversed (org-notes-order-reversed-p))
11912 (looking-at org-outline-regexp)
11913 (setq level (org-get-valid-level (funcall outline-level) 1))
11916 (or (outline-next-heading) (point-max))
11917 (or (save-excursion (org-get-next-sibling))
11918 (org-end-of-subtree t t)
11922 (goto-char (point-max))
11923 (goto-char (point-min))
11924 (or (outline-next-heading) (goto-char (point-max)))))
11925 (if (not (bolp)) (newline))
11926 (org-paste-subtree level nil nil t)
11927 (when org-log-refile
11928 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11929 (unless (eq org-log-refile 'note)
11930 (save-excursion (org-add-log-note))))
11931 (and org-auto-align-tags
11932 (let ((org-loop-over-headlines-in-active-region nil))
11933 (org-set-tags nil t)))
11934 (let ((bookmark-name (plist-get org-bookmark-names-plist
11936 (when bookmark-name
11937 (with-demoted-errors
11938 (bookmark-set bookmark-name))))
11939 ;; If we are refiling for capture, make sure that the
11940 ;; last-capture pointers point here
11941 (when (org-bound-and-true-p org-refile-for-capture)
11942 (let ((bookmark-name (plist-get org-bookmark-names-plist
11943 :last-capture-marker)))
11944 (when bookmark-name
11945 (with-demoted-errors
11946 (bookmark-set bookmark-name))))
11947 (move-marker org-capture-last-stored-marker (point)))
11948 (if (fboundp 'deactivate-mark) (deactivate-mark))
11949 (run-hooks 'org-after-refile-insert-hook))))
11950 (unless org-refile-keep
11952 (delete-region (point) (+ (point) (- region-end region-start)))
11954 (and (org-back-to-heading t) (point))
11955 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11956 (when (featurep 'org-inlinetask)
11957 (org-inlinetask-remove-END-maybe))
11958 (setq org-markers-to-move nil)
11959 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11961 (defun org-refile-goto-last-stored ()
11962 "Go to the location where the last refile was stored."
11964 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11965 (message "This is the location of the last refile"))
11967 (defun org-refile--get-location (refloc tbl)
11968 "When user refile to REFLOC, find the associated target in TBL.
11969 Also check `org-refile-target-table'."
11973 (lambda (r) (or (assoc r tbl)
11974 (assoc r org-refile-target-table)))
11975 (list (replace-regexp-in-string "/$" "" refloc)
11976 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11978 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11980 "Prompt the user for a refile location, using PROMPT.
11981 PROMPT should not be suffixed with a colon and a space, because
11982 this function appends the default value from
11983 `org-refile-history' automatically, if that is not empty.
11984 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11985 this is used for the GOTO interface."
11986 (let ((org-refile-targets org-refile-targets)
11987 (org-refile-use-outline-path org-refile-use-outline-path)
11989 (when (and (derived-mode-p 'org-mode)
11990 (not org-refile-use-cache)
11994 (setq excluded-entries
11995 (append excluded-entries (list (org-get-heading t t)))))))
11996 (setq org-refile-target-table
11997 (org-refile-get-targets default-buffer excluded-entries)))
11998 (unless org-refile-target-table
11999 (user-error "No refile targets"))
12000 (let* ((cbuf (current-buffer))
12001 (partial-completion-mode nil)
12002 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12003 (cfunc (if (and org-refile-use-outline-path
12004 org-outline-path-complete-in-steps)
12005 'org-olpath-completing-read
12006 'org-icompleting-read))
12007 (extra (if org-refile-use-outline-path "/" ""))
12008 (cbnex (concat (buffer-name) extra))
12009 (filename (and cfn (expand-file-name cfn)))
12012 (if (and (not (member org-refile-use-outline-path
12013 '(file full-file-path)))
12014 (not (equal filename (nth 1 x))))
12015 (cons (concat (car x) extra " ("
12016 (file-name-nondirectory (nth 1 x)) ")")
12018 (cons (concat (car x) extra) (cdr x))))
12019 org-refile-target-table))
12020 (completion-ignore-case t)
12022 (prompt (concat prompt
12023 (or (and (car org-refile-history)
12024 (concat " (default " (car org-refile-history) ")"))
12025 (and (assoc cbnex tbl) (setq cdef cbnex)
12026 (concat " (default " cbnex ")"))) ": "))
12027 pa answ parent-target child parent old-hist)
12028 (setq old-hist org-refile-history)
12029 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12030 nil 'org-refile-history (or cdef (car org-refile-history))))
12031 (if (setq pa (org-refile--get-location answ tbl))
12033 (org-refile-check-position pa)
12034 (when (or (not org-refile-history)
12035 (not (eq old-hist org-refile-history))
12036 (not (equal (car pa) (car org-refile-history))))
12037 (setq org-refile-history
12038 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12040 (cdr org-refile-history))))
12041 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12042 (pop org-refile-history)))
12044 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12046 (setq parent (match-string 1 answ)
12047 child (match-string 2 answ))
12048 (setq parent-target (org-refile--get-location parent tbl))
12049 (when (and parent-target
12050 (or (eq new-nodes t)
12051 (and (eq new-nodes 'confirm)
12052 (y-or-n-p (format "Create new node \"%s\"? "
12054 (org-refile-new-child parent-target child)))
12055 (user-error "Invalid target location")))))
12057 (declare-function org-string-nw-p "org-macs" (s))
12058 (defun org-refile-check-position (refile-pointer)
12059 "Check if the refile pointer matches the headline to which it points."
12060 (let* ((file (nth 1 refile-pointer))
12061 (re (nth 2 refile-pointer))
12062 (pos (nth 3 refile-pointer))
12064 (if (and (not (markerp pos)) (not file))
12065 (user-error "Please indicate a target file in the refile path")
12066 (when (org-string-nw-p re)
12067 (setq buffer (if (markerp pos)
12068 (marker-buffer pos)
12069 (or (find-buffer-visiting file)
12070 (find-file-noselect file))))
12071 (with-current-buffer buffer
12076 (beginning-of-line 1)
12077 (unless (org-looking-at-p re)
12078 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12080 (defun org-refile-new-child (parent-target child)
12081 "Use refile target PARENT-TARGET to add new CHILD below it."
12082 (unless parent-target
12083 (error "Cannot find parent for new node"))
12084 (let ((file (nth 1 parent-target))
12085 (pos (nth 3 parent-target))
12087 (with-current-buffer (or (find-buffer-visiting file)
12088 (find-file-noselect file))
12094 (goto-char (point-max))
12095 (if (not (bolp)) (newline)))
12096 (when (looking-at org-outline-regexp)
12097 (setq level (funcall outline-level))
12098 (org-end-of-subtree t t))
12099 (org-back-over-empty-lines)
12100 (insert "\n" (make-string
12101 (if pos (org-get-valid-level level 1) 1) ?*)
12103 (beginning-of-line 0)
12104 (list (concat (car parent-target) "/" child) file "" (point)))))))
12106 (defun org-olpath-completing-read (prompt collection &rest args)
12107 "Read an outline path like a file name."
12108 (let ((thetable collection)
12109 (org-completion-use-ido nil) ; does not work with ido.
12110 (org-completion-use-iswitchb nil)) ; or iswitchb
12112 'org-icompleting-read prompt
12113 (lambda (string predicate &optional flag)
12114 (let (rtn r f (l (length string)))
12118 (try-completion string thetable))
12121 (setq rtn (all-completions string thetable predicate))
12124 (setq r (substring x l))
12125 (if (string-match " ([^)]*)$" x)
12126 (setq f (match-string 0 x))
12128 (if (string-match "/" r)
12129 (concat string (substring r 0 (match-end 0)) f)
12134 (assoc string thetable)))))
12137 ;;;; Dynamic blocks
12139 (defun org-find-dblock (name)
12140 "Find the first dynamic block with name NAME in the buffer.
12141 If not found, stay at current position and return nil."
12142 (let ((case-fold-search t) pos)
12144 (goto-char (point-min))
12145 (setq pos (and (re-search-forward
12146 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12147 (match-beginning 0))))
12148 (if pos (goto-char pos))
12151 (defun org-create-dblock (plist)
12152 "Create a dynamic block section, with parameters taken from PLIST.
12153 PLIST must contain a :name entry which is used as the name of the block."
12154 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12157 (let ((col (current-column))
12158 (name (plist-get plist :name)))
12159 (insert "#+BEGIN: " name)
12161 (if (eq (car plist) :name)
12162 (setq plist (cddr plist))
12163 (insert " " (prin1-to-string (pop plist)))))
12164 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12165 (beginning-of-line -2)))
12167 (defun org-prepare-dblock ()
12168 "Prepare dynamic block for refresh.
12169 This empties the block, puts the cursor at the insert position and returns
12170 the property list including an extra property :name with the block name."
12171 (unless (looking-at org-dblock-start-re)
12172 (user-error "Not at a dynamic block"))
12173 (let* ((begdel (1+ (match-end 0)))
12174 (name (org-no-properties (match-string 1)))
12175 (params (append (list :name name)
12176 (read (concat "(" (match-string 3) ")")))))
12178 (beginning-of-line 1)
12179 (skip-chars-forward " \t")
12180 (setq params (plist-put params :indentation-column (current-column))))
12181 (unless (re-search-forward org-dblock-end-re nil t)
12182 (error "Dynamic block not terminated"))
12185 (list :content (buffer-substring
12186 begdel (match-beginning 0)))))
12187 (delete-region begdel (match-beginning 0))
12192 (defun org-map-dblocks (&optional command)
12193 "Apply COMMAND to all dynamic blocks in the current buffer.
12194 If COMMAND is not given, use `org-update-dblock'."
12195 (let ((cmd (or command 'org-update-dblock)))
12197 (goto-char (point-min))
12198 (while (re-search-forward org-dblock-start-re nil t)
12199 (goto-char (match-beginning 0))
12201 (condition-case nil
12203 (error (message "Error during update of dynamic block"))))
12204 (unless (re-search-forward org-dblock-end-re nil t)
12205 (error "Dynamic block not terminated"))))))
12207 (defun org-dblock-update (&optional arg)
12208 "User command for updating dynamic blocks.
12209 Update the dynamic block at point. With prefix ARG, update all dynamic
12210 blocks in the buffer."
12213 (org-update-all-dblocks)
12214 (or (looking-at org-dblock-start-re)
12215 (org-beginning-of-dblock))
12216 (org-update-dblock)))
12218 (defun org-update-dblock ()
12219 "Update the dynamic block at point.
12220 This means to empty the block, parse for parameters and then call
12221 the correct writing function."
12224 (let* ((win (selected-window))
12226 (line (org-current-line))
12227 (params (org-prepare-dblock))
12228 (name (plist-get params :name))
12229 (indent (plist-get params :indentation-column))
12230 (cmd (intern (concat "org-dblock-write:" name))))
12231 (message "Updating dynamic block `%s' at line %d..." name line)
12232 (funcall cmd params)
12233 (message "Updating dynamic block `%s' at line %d...done" name line)
12235 (when (and indent (> indent 0))
12236 (setq indent (make-string indent ?\ ))
12238 (select-window win)
12239 (org-beginning-of-dblock)
12241 (while (not (looking-at org-dblock-end-re))
12243 (beginning-of-line 2))
12244 (when (looking-at org-dblock-end-re)
12245 (and (looking-at "[ \t]+")
12246 (replace-match ""))
12247 (insert indent)))))))
12249 (defun org-beginning-of-dblock ()
12250 "Find the beginning of the dynamic block at point.
12251 Error if there is no such block at point."
12252 (let ((pos (point))
12255 (if (and (re-search-backward org-dblock-start-re nil t)
12256 (setq beg (match-beginning 0))
12257 (re-search-forward org-dblock-end-re nil t)
12258 (> (match-end 0) pos))
12261 (error "Not in a dynamic block"))))
12263 (defun org-update-all-dblocks ()
12264 "Update all dynamic blocks in the buffer.
12265 This function can be used in a hook."
12267 (when (derived-mode-p 'org-mode)
12268 (org-map-dblocks 'org-update-dblock)))
12273 (declare-function org-export-backend-name "org-export" (cl-x))
12274 (declare-function org-export-backend-options "org-export" (cl-x))
12275 (defun org-get-export-keywords ()
12276 "Return a list of all currently understood export keywords.
12277 Export keywords include options, block names, attributes and
12278 keywords relative to each registered export back-end."
12281 (org-bound-and-true-p org-export--registered-backends)
12282 (delq nil keywords))
12283 ;; Back-end name (for keywords, like #+LATEX:)
12284 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12285 (dolist (option-entry (org-export-backend-options backend))
12286 ;; Back-end options.
12287 (push (nth 1 option-entry) keywords)))))
12289 (defconst org-options-keywords
12290 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12291 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12292 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12293 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12294 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12296 (defcustom org-structure-template-alist
12297 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12298 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12299 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12300 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12301 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12302 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12303 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12305 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12307 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12310 ("I" "#+INCLUDE: %file ?"))
12311 "Structure completion elements.
12312 This is a list of abbreviation keys and values. The value gets inserted
12313 if you type `<' followed by the key and then press the completion key,
12314 usually `TAB'. %file will be replaced by a file name after prompting
12315 for the file using completion. The cursor will be placed at the position
12316 of the `?` in the template.
12317 There are two templates for each key, the first uses the original Org syntax,
12318 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12319 the default when the /org-mtags.el/ module has been loaded. See also the
12320 variable `org-mtags-prefer-muse-templates'."
12321 :group 'org-completion
12324 (string :tag "Key")
12325 (string :tag "Template")))
12327 :package-version '(Org . "8.3"))
12329 (defun org-try-structure-completion ()
12330 "Try to complete a structure template before point.
12331 This looks for strings like \"<e\" on an otherwise empty line and
12333 (let ((l (buffer-substring (point-at-bol) (point)))
12335 (when (and (looking-at "[ \t]*$")
12336 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12337 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12338 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12339 (match-beginning 1)) a)
12342 (defun org-complete-expand-structure-template (start cell)
12343 "Expand a structure template."
12344 (let ((rpl (nth 1 cell))
12346 (delete-region start (point))
12347 (when (string-match "\\`[ \t]*#\\+" rpl)
12350 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12351 (setq ind (buffer-substring (point-at-bol) (point))))
12353 (setq start (point))
12354 (if (string-match "%file" rpl)
12355 (setq rpl (replace-match
12359 (abbreviate-file-name (read-file-name "Include file: ")))
12362 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12363 (concat "\n" ind)))
12365 (if (re-search-backward "\\?" start t) (delete-char 1))))
12367 ;;;; TODO, DEADLINE, Comments
12369 (defun org-toggle-comment ()
12370 "Change the COMMENT state of an entry."
12373 (org-back-to-heading)
12374 (looking-at org-complex-heading-regexp)
12375 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12376 (skip-chars-forward " \t")
12377 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12378 (if (org-in-commented-heading-p t)
12379 (delete-region (point)
12380 (progn (search-forward " " (line-end-position) 'move)
12381 (skip-chars-forward " \t")
12383 (insert org-comment-string)
12384 (unless (eolp) (insert " ")))))
12386 (defvar org-last-todo-state-is-todo nil
12387 "This is non-nil when the last TODO state change led to a TODO state.
12388 If the last change removed the TODO tag or switched to DONE, then
12391 (defvar org-setting-tags nil) ; dynamically skipped
12393 (defvar org-todo-setup-filter-hook nil
12394 "Hook for functions that pre-filter todo specs.
12395 Each function takes a todo spec and returns either nil or the spec
12396 transformed into canonical form." )
12398 (defvar org-todo-get-default-hook nil
12399 "Hook for functions that get a default item for todo.
12400 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12401 nil or a string to be used for the todo mark." )
12403 (defvar org-agenda-headline-snapshot-before-repeat)
12405 (defun org-current-effective-time ()
12406 "Return current time adjusted for `org-extend-today-until' variable."
12407 (let* ((ct (org-current-time))
12408 (dct (decode-time ct))
12411 (org-use-last-clock-out-time-as-effective-time
12412 (or (org-clock-get-last-clock-out-time) ct))
12413 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12414 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12418 (defun org-todo-yesterday (&optional arg)
12419 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12421 (if (eq major-mode 'org-agenda-mode)
12422 (apply 'org-agenda-todo-yesterday arg)
12423 (let* ((org-use-effective-time t)
12424 (hour (third (decode-time
12425 (org-current-time))))
12426 (org-extend-today-until (1+ hour)))
12429 (defvar org-block-entry-blocking ""
12430 "First entry preventing the TODO state change.")
12432 (defun org-cancel-repeater ()
12433 "Cancel a repeater by setting its numeric value to zero."
12436 (org-back-to-heading t)
12437 (let ((bound1 (point))
12438 (bound0 (save-excursion (outline-next-heading) (point))))
12439 (when (re-search-forward
12440 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12441 org-deadline-time-regexp "\\)\\|\\("
12442 org-ts-regexp "\\)")
12444 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12445 (replace-match "0" t nil nil 1))))))
12447 (defun org-todo (&optional arg)
12448 "Change the TODO state of an item.
12449 The state of an item is given by a keyword at the start of the heading,
12451 *** TODO Write paper
12454 The different keywords are specified in the variable `org-todo-keywords'.
12455 By default the available states are \"TODO\" and \"DONE\".
12456 So for this example: when the item starts with TODO, it is changed to DONE.
12457 When it starts with DONE, the DONE is removed. And when neither TODO nor
12458 DONE are present, add TODO at the beginning of the heading.
12460 With \\[universal-argument] prefix arg, use completion to determine the new \
12462 With numeric prefix arg, switch to that state.
12463 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12464 keywords (nextset).
12465 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12466 With a numeric prefix arg of 0, inhibit note taking for the change.
12467 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12469 When called through ELisp, arg is also interpreted in the following way:
12470 'none -> empty state
12471 \"\"(empty string) -> switch to empty state
12472 'done -> switch to DONE
12473 'nextset -> switch to the next set of keywords
12474 'previousset -> switch to the previous set of keywords
12475 \"WAITING\" -> switch to the specified keyword, but only if it
12476 really is a member of `org-todo-keywords'."
12478 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12479 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12480 'region-start-level 'region))
12481 org-loop-over-headlines-in-active-region)
12484 org-loop-over-headlines-in-active-region
12485 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12486 (if (equal arg '(16)) (setq arg 'nextset))
12487 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12488 (let ((org-blocker-hook org-blocker-hook)
12491 (when (equal arg '(64))
12492 (setq arg nil org-blocker-hook nil))
12493 (when (and org-blocker-hook
12494 (or org-inhibit-blocking
12495 (org-entry-get nil "NOBLOCKING")))
12496 (setq org-blocker-hook nil))
12499 (org-back-to-heading t)
12500 (when (org-in-commented-heading-p t)
12501 (org-toggle-comment)
12503 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12504 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12505 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12506 (let* ((match-data (match-data))
12507 (startpos (point-at-bol))
12508 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12509 (org-log-done org-log-done)
12510 (org-log-repeat org-log-repeat)
12511 (org-todo-log-states org-todo-log-states)
12512 (org-inhibit-logging
12514 (progn (setq arg nil) 'note) org-inhibit-logging))
12515 (this (match-string 1))
12516 (hl-pos (match-beginning 0))
12517 (head (org-get-todo-sequence-head this))
12518 (ass (assoc head org-todo-kwd-alist))
12519 (interpret (nth 1 ass))
12520 (done-word (nth 3 ass))
12521 (final-done-word (nth 4 ass))
12522 (org-last-state (or this ""))
12523 (completion-ignore-case t)
12524 (member (member this org-todo-keywords-1))
12525 (tail (cdr member))
12527 ((and org-todo-key-trigger
12528 (or (and (equal arg '(4))
12529 (eq org-use-fast-todo-selection 'prefix))
12530 (and (not arg) org-use-fast-todo-selection
12531 (not (eq org-use-fast-todo-selection
12533 ;; Use fast selection
12534 (org-fast-todo-selection))
12535 ((and (equal arg '(4))
12536 (or (not org-use-fast-todo-selection)
12537 (not org-todo-key-trigger)))
12538 ;; Read a state with completion
12539 (org-icompleting-read
12540 "State: " (mapcar 'list org-todo-keywords-1)
12544 (if tail (car tail) nil)
12545 (car org-todo-keywords-1)))
12547 (if (equal member org-todo-keywords-1)
12550 (nth (- (length org-todo-keywords-1)
12552 org-todo-keywords-1)
12553 (org-last org-todo-keywords-1))))
12554 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12555 (setq arg nil))) ; hack to fall back to cycling
12557 ;; user or caller requests a specific state
12559 ((equal arg "") nil)
12560 ((eq arg 'none) nil)
12561 ((eq arg 'done) (or done-word (car org-done-keywords)))
12563 (or (car (cdr (member head org-todo-heads)))
12564 (car org-todo-heads)))
12565 ((eq arg 'previousset)
12566 (let ((org-todo-heads (reverse org-todo-heads)))
12567 (or (car (cdr (member head org-todo-heads)))
12568 (car org-todo-heads))))
12569 ((car (member arg org-todo-keywords-1)))
12571 (user-error "State `%s' not valid in this file" arg))
12572 ((nth (1- (prefix-numeric-value arg))
12573 org-todo-keywords-1))))
12574 ((null member) (or head (car org-todo-keywords-1)))
12575 ((equal this final-done-word) nil) ;; -> make empty
12576 ((null tail) nil) ;; -> first entry
12577 ((memq interpret '(type priority))
12578 (if (eq this-command last-command)
12580 (if (> (length tail) 0)
12581 (or done-word (car org-done-keywords))
12586 (run-hook-with-args-until-success
12587 'org-todo-get-default-hook org-state org-last-state)
12589 (next (if org-state (concat " " org-state " ") " "))
12590 (change-plist (list :type 'todo-state-change :from this :to org-state
12591 :position startpos))
12593 (when org-blocker-hook
12594 (setq org-last-todo-state-is-todo
12595 (not (member this org-done-keywords)))
12596 (unless (save-excursion
12598 (org-with-wide-buffer
12599 (run-hook-with-args-until-failure
12600 'org-blocker-hook change-plist))))
12601 (if (org-called-interactively-p 'interactive)
12602 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12603 this org-state org-block-entry-blocking)
12605 (message "TODO state change from %s to %s blocked (by \"%s\")"
12606 this org-state org-block-entry-blocking)
12607 (throw 'exit nil))))
12608 (store-match-data match-data)
12609 (replace-match next t t)
12610 (cond ((equal this org-state)
12611 (message "TODO state was already %s" (org-trim next)))
12612 ((pos-visible-in-window-p hl-pos)
12613 (message "TODO state changed to %s" (org-trim next))))
12615 (setq head (org-get-todo-sequence-head org-state)
12616 ass (assoc head org-todo-kwd-alist)
12617 interpret (nth 1 ass)
12618 done-word (nth 3 ass)
12619 final-done-word (nth 4 ass)))
12620 (when (memq arg '(nextset previousset))
12621 (message "Keyword-Set %d/%d: %s"
12622 (- (length org-todo-sets) -1
12623 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12624 (length org-todo-sets)
12625 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12626 (setq org-last-todo-state-is-todo
12627 (not (member org-state org-done-keywords)))
12628 (setq now-done-p (and (member org-state org-done-keywords)
12629 (not (member this org-done-keywords))))
12630 (and logging (org-local-logging logging))
12631 (when (and (or org-todo-log-states org-log-done)
12632 (not (eq org-inhibit-logging t))
12633 (not (memq arg '(nextset previousset))))
12634 ;; we need to look at recording a time and note
12635 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12636 (nth 2 (assoc this org-todo-log-states))))
12637 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12638 (setq dolog 'time))
12639 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12641 (member org-state org-not-done-keywords)
12642 (not (member this org-not-done-keywords))))
12643 ;; This is now a todo state and was not one before
12644 ;; If there was a CLOSED time stamp, get rid of it.
12645 (org-add-planning-info nil nil 'closed))
12646 (when (and now-done-p org-log-done)
12647 ;; It is now done, and it was not done before
12648 (org-add-planning-info 'closed (org-current-effective-time))
12649 (if (and (not dolog) (eq 'note org-log-done))
12650 (org-add-log-setup 'done org-state this 'findpos 'note)))
12651 (when (and org-state dolog)
12652 ;; This is a non-nil state, and we need to log it
12653 (org-add-log-setup 'state org-state this 'findpos dolog)))
12654 ;; Fixup tag positioning
12655 (org-todo-trigger-tag-changes org-state)
12656 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12657 (when org-provide-todo-statistics
12658 (org-update-parent-todo-statistics))
12659 (run-hooks 'org-after-todo-state-change-hook)
12660 (if (and arg (not (member org-state org-done-keywords)))
12661 (setq head (org-get-todo-sequence-head org-state)))
12662 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12663 ;; Do we need to trigger a repeat?
12665 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12666 ;; This is for the agenda, take a snapshot of the headline.
12668 (setq org-agenda-headline-snapshot-before-repeat
12669 (org-get-heading))))
12670 (org-auto-repeat-maybe org-state))
12671 ;; Fixup cursor location if close to the keyword
12672 (if (and (outline-on-heading-p)
12674 (save-excursion (beginning-of-line 1)
12675 (looking-at org-todo-line-regexp))
12676 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12678 (goto-char (or (match-end 2) (match-end 1)))
12679 (and (looking-at " ") (just-one-space))))
12680 (when org-trigger-hook
12682 (run-hook-with-args 'org-trigger-hook change-plist)))
12683 (when commentp (org-toggle-comment))))))))
12685 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12686 "Block turning an entry into a TODO, using the hierarchy.
12687 This checks whether the current task should be blocked from state
12688 changes. Such blocking occurs when:
12690 1. The task has children which are not all in a completed state.
12692 2. A task has a parent with the property :ORDERED:, and there
12693 are siblings prior to the current task with incomplete
12696 3. The parent of the task is blocked because it has siblings that should
12697 be done first, or is child of a block grandparent TODO entry."
12699 (if (not org-enforce-todo-dependencies)
12700 t ; if locally turned off don't block
12702 ;; If this is not a todo state change, or if this entry is already DONE,
12704 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12705 (member (plist-get change-plist :from)
12706 (cons 'done org-done-keywords))
12707 (member (plist-get change-plist :to)
12708 (cons 'todo org-not-done-keywords))
12709 (not (plist-get change-plist :to)))
12710 (throw 'dont-block t))
12711 ;; If this task has children, and any are undone, it's blocked
12713 (org-back-to-heading t)
12714 (let ((this-level (funcall outline-level)))
12715 (outline-next-heading)
12716 (let ((child-level (funcall outline-level)))
12717 (while (and (not (eobp))
12718 (> child-level this-level))
12719 ;; this todo has children, check whether they are all
12721 (if (and (not (org-entry-is-done-p))
12722 (org-entry-is-todo-p))
12723 (progn (setq org-block-entry-blocking (org-get-heading))
12724 (throw 'dont-block nil)))
12725 (outline-next-heading)
12726 (setq child-level (funcall outline-level))))))
12727 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12728 ;; any previous siblings are undone, it's blocked
12730 (org-back-to-heading t)
12731 (let* ((pos (point))
12732 (parent-pos (and (org-up-heading-safe) (point))))
12733 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12734 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12736 (re-search-forward org-not-done-heading-regexp pos t))
12737 (setq org-block-entry-blocking (match-string 0))
12738 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12739 ;; Search further up the hierarchy, to see if an ancestor is blocked
12741 (goto-char parent-pos)
12742 (if (not (looking-at org-not-done-heading-regexp))
12743 (throw 'dont-block t)) ; do not block, parent is not a TODO
12745 (setq 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 (org-get-heading)))
12751 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12753 (defcustom org-track-ordered-property-with-tag nil
12754 "Should the ORDERED property also be shown as a tag?
12755 The ORDERED property decides if an entry should require subtasks to be
12756 completed in sequence. Since a property is not very visible, setting
12757 this option means that toggling the ORDERED property with the command
12758 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12759 not relevant for the behavior, but it makes things more visible.
12761 Note that toggling the tag with tags commands will not change the property
12762 and therefore not influence behavior!
12764 This can be t, meaning the tag ORDERED should be used, It can also be a
12765 string to select a different tag for this task."
12768 (const :tag "No tracking" nil)
12769 (const :tag "Track with ORDERED tag" t)
12770 (string :tag "Use other tag")))
12772 (defun org-toggle-ordered-property ()
12773 "Toggle the ORDERED property of the current entry.
12774 For better visibility, you can track the value of this property with a tag.
12775 See variable `org-track-ordered-property-with-tag'."
12777 (let* ((t1 org-track-ordered-property-with-tag)
12778 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12780 (org-back-to-heading)
12781 (if (org-entry-get nil "ORDERED")
12783 (org-delete-property "ORDERED")
12784 (and tag (org-toggle-tag tag 'off))
12785 (message "Subtasks can be completed in arbitrary order"))
12786 (org-entry-put nil "ORDERED" "t")
12787 (and tag (org-toggle-tag tag 'on))
12788 (message "Subtasks must be completed in sequence")))))
12790 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12791 (defun org-block-todo-from-checkboxes (change-plist)
12792 "Block turning an entry into a TODO, using checkboxes.
12793 This checks whether the current task should be blocked from state
12794 changes because there are unchecked boxes in this entry."
12795 (if (not org-enforce-todo-checkbox-dependencies)
12796 t ; if locally turned off don't block
12798 ;; If this is not a todo state change, or if this entry is already DONE,
12800 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12801 (member (plist-get change-plist :from)
12802 (cons 'done org-done-keywords))
12803 (member (plist-get change-plist :to)
12804 (cons 'todo org-not-done-keywords))
12805 (not (plist-get change-plist :to)))
12806 (throw 'dont-block t))
12807 ;; If this task has checkboxes that are not checked, it's blocked
12809 (org-back-to-heading t)
12810 (let ((beg (point)) end)
12811 (outline-next-heading)
12814 (if (org-list-search-forward
12815 (concat (org-item-beginning-re)
12816 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12820 (if (boundp 'org-blocked-by-checkboxes)
12821 (setq org-blocked-by-checkboxes t))
12822 (throw 'dont-block nil)))))
12823 t))) ; do not block
12825 (defun org-entry-blocked-p ()
12826 "Is the current entry blocked?"
12827 (org-with-silent-modifications
12828 (if (org-entry-get nil "NOBLOCKING")
12829 nil ;; Never block this entry
12830 (not (run-hook-with-args-until-failure
12832 (list :type 'todo-state-change
12837 (defun org-update-statistics-cookies (all)
12838 "Update the statistics cookie, either from TODO or from checkboxes.
12839 This should be called with the cursor in a line with a statistics cookie."
12843 (org-update-checkbox-count 'all)
12844 (org-map-entries 'org-update-parent-todo-statistics))
12845 (if (not (org-at-heading-p))
12846 (org-update-checkbox-count)
12847 (let ((pos (point-marker))
12849 (ignore-errors (org-back-to-heading t))
12850 (if (not (org-at-heading-p))
12851 (org-update-checkbox-count)
12852 (setq l1 (org-outline-level))
12853 (setq end (save-excursion
12854 (outline-next-heading)
12855 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12857 (if (and (save-excursion
12859 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12860 (not (save-excursion (re-search-forward
12861 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12862 (org-update-checkbox-count)
12863 (if (and l2 (> l2 l1))
12866 (org-update-parent-todo-statistics))
12868 (beginning-of-line 1)
12869 (while (re-search-forward
12870 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12872 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12874 (move-marker pos nil)))))
12876 (defvar org-entry-property-inherited-from) ;; defined below
12877 (defun org-update-parent-todo-statistics ()
12878 "Update any statistics cookie in the parent of the current headline.
12879 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12880 the entire subtree and this will travel up the hierarchy and update
12881 statistics everywhere."
12882 (let* ((prop (save-excursion (org-up-heading-safe)
12883 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12884 (recursive (or (not org-hierarchical-todo-statistics)
12885 (and prop (string-match "\\<recursive\\>" prop))))
12886 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12889 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12890 level ltoggle l1 new ndel
12891 (cnt-all 0) (cnt-done 0) is-percent kwd
12892 checkbox-beg ov ovs ove cookie-present)
12895 (beginning-of-line 1)
12896 (setq ltoggle (funcall outline-level))
12897 ;; Three situations are to consider:
12899 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12900 ;; to the top-level ancestor on the headline;
12902 ;; 2. If parent has "recursive" property, repeat up to the
12903 ;; headline setting that property, taking inheritance into
12906 ;; 3. Else, move up to direct parent and proceed only once.
12907 (while (and (setq level (org-up-heading-safe))
12908 (or recursive first)
12910 (setq first nil cookie-present nil)
12914 (downcase (or (org-entry-get nil "COOKIE_DATA")
12917 (while (re-search-forward box-re (point-at-eol) t)
12918 (setq cnt-all 0 cnt-done 0 cookie-present t)
12919 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12921 (unless (outline-next-heading) (throw 'exit nil))
12922 (while (and (looking-at org-complex-heading-regexp)
12923 (> (setq l1 (length (match-string 1))) level))
12924 (setq kwd (and (or recursive (= l1 ltoggle))
12926 (if (or (eq org-provide-todo-statistics 'all-headlines)
12927 (and (eq org-provide-todo-statistics t)
12928 (or (member kwd org-done-keywords)))
12929 (and (listp org-provide-todo-statistics)
12930 (stringp (car org-provide-todo-statistics))
12931 (or (member kwd org-provide-todo-statistics)
12932 (member kwd org-done-keywords)))
12933 (and (listp org-provide-todo-statistics)
12934 (listp (car org-provide-todo-statistics))
12935 (or (member kwd (car org-provide-todo-statistics))
12936 (and (member kwd org-done-keywords)
12937 (member kwd (cadr org-provide-todo-statistics))))))
12938 (setq cnt-all (1+ cnt-all))
12939 (if (eq org-provide-todo-statistics t)
12940 (and kwd (setq cnt-all (1+ cnt-all)))))
12941 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12942 (member kwd org-done-keywords))
12943 (and (listp org-provide-todo-statistics)
12944 (listp (car org-provide-todo-statistics))
12945 (member kwd org-done-keywords)
12946 (member kwd (cadr org-provide-todo-statistics)))
12947 (and (listp org-provide-todo-statistics)
12948 (stringp (car org-provide-todo-statistics))
12949 (member kwd org-done-keywords)))
12950 (setq cnt-done (1+ cnt-done)))
12951 (outline-next-heading)))
12954 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12955 (format "[%d/%d]" cnt-done cnt-all))
12956 ndel (- (match-end 0) checkbox-beg))
12957 ;; handle overlays when updating cookie from column view
12958 (when (setq ov (car (overlays-at checkbox-beg)))
12959 (setq ovs (overlay-start ov) ove (overlay-end ov))
12960 (delete-overlay ov))
12961 (goto-char checkbox-beg)
12963 (delete-region (point) (+ (point) ndel))
12964 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12965 (when ov (move-overlay ov ovs ove)))
12966 (when cookie-present
12967 (run-hook-with-args 'org-after-todo-statistics-hook
12968 cnt-done (- cnt-all cnt-done))))))
12969 (run-hooks 'org-todo-statistics-hook)))
12971 (defvar org-after-todo-statistics-hook nil
12972 "Hook that is called after a TODO statistics cookie has been updated.
12973 Each function is called with two arguments: the number of not-done entries
12974 and the number of done entries.
12976 For example, the following function, when added to this hook, will switch
12977 an entry to DONE when all children are done, and back to TODO when new
12978 entries are set to a TODO status. Note that this hook is only called
12979 when there is a statistics cookie in the headline!
12981 (defun org-summary-todo (n-done n-not-done)
12982 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12983 (let (org-log-done org-log-states) ; turn off logging
12984 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12987 (defvar org-todo-statistics-hook nil
12988 "Hook that is run whenever Org thinks TODO statistics should be updated.
12989 This hook runs even if there is no statistics cookie present, in which case
12990 `org-after-todo-statistics-hook' would not run.")
12992 (defun org-todo-trigger-tag-changes (state)
12993 "Apply the changes defined in `org-todo-state-tags-triggers'."
12994 (let ((l org-todo-state-tags-triggers)
12996 (when (or (not state) (equal state ""))
12997 (setq changes (append changes (cdr (assoc "" l)))))
12998 (when (and (stringp state) (> (length state) 0))
12999 (setq changes (append changes (cdr (assoc state l)))))
13000 (when (member state org-not-done-keywords)
13001 (setq changes (append changes (cdr (assoc 'todo l)))))
13002 (when (member state org-done-keywords)
13003 (setq changes (append changes (cdr (assoc 'done l)))))
13004 (dolist (c changes)
13005 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13007 (defun org-local-logging (value)
13008 "Get logging settings from a property VALUE."
13010 ;; directly set the variables, they are already local.
13011 (setq org-log-done nil
13013 org-todo-log-states nil)
13014 (setq words (org-split-string value))
13015 (while (setq w (pop words))
13017 ((setq a (assoc w org-startup-options))
13018 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13019 (set (nth 1 a) (nth 2 a))))
13020 ((setq a (org-extract-log-state-settings w))
13021 (and (member (car a) org-todo-keywords-1)
13022 (push a org-todo-log-states)))))))
13024 (defun org-get-todo-sequence-head (kwd)
13025 "Return the head of the TODO sequence to which KWD belongs.
13026 If KWD is not set, check if there is a text property remembering the
13031 (or (get-text-property (point-at-bol) 'org-todo-head)
13033 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13034 nil (point-at-eol)))
13035 (get-text-property p 'org-todo-head))))
13036 ((not (member kwd org-todo-keywords-1))
13037 (car org-todo-keywords-1))
13038 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13040 (defun org-fast-todo-selection ()
13041 "Fast TODO keyword selection with single keys.
13042 Returns the new TODO keyword, or nil if no state change should occur."
13043 (let* ((fulltable org-todo-key-alist)
13044 (done-keywords org-done-keywords) ;; needed for the faces.
13045 (maxlen (apply 'max (mapcar
13047 (if (stringp (car x)) (string-width (car x)) 0))
13050 (fwidth (+ maxlen 3 1 3))
13051 (ncol (/ (- (window-width) 4) fwidth))
13055 (save-window-excursion
13057 (set-buffer (get-buffer-create " *Org todo*"))
13058 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13060 (org-set-local 'org-done-keywords done-keywords)
13061 (setq tbl fulltable cnt 0)
13062 (while (setq e (pop tbl))
13064 ((equal e '(:startgroup))
13065 (push '() groups) (setq ingroup t)
13066 (when (not (= cnt 0))
13070 ((equal e '(:endgroup))
13071 (setq ingroup nil cnt 0)
13073 ((equal e '(:newline))
13074 (when (not (= cnt 0))
13078 (while (equal (car tbl) '(:newline))
13080 (setq tbl (cdr tbl)))))
13082 (setq tg (car e) c (cdr e))
13083 (if ingroup (push tg (car groups)))
13084 (setq tg (org-add-props tg nil 'face
13085 (org-get-todo-face tg)))
13086 (if (and (= cnt 0) (not ingroup)) (insert " "))
13087 (insert "[" c "] " tg (make-string
13088 (- fwidth 4 (length tg)) ?\ ))
13089 (when (= (setq cnt (1+ cnt)) ncol)
13091 (if ingroup (insert " "))
13094 (goto-char (point-min))
13095 (if (not expert) (org-fit-window-to-buffer))
13096 (message "[a-z..]:Set [SPC]:clear")
13097 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13100 (and (= c ?q) (not (rassoc c fulltable))))
13101 (setq quit-flag t))
13103 ((setq e (rassoc c fulltable) tg (car e))
13105 (t (setq quit-flag t)))))))
13107 (defun org-entry-is-todo-p ()
13108 (member (org-get-todo-state) org-not-done-keywords))
13110 (defun org-entry-is-done-p ()
13111 (member (org-get-todo-state) org-done-keywords))
13113 (defun org-get-todo-state ()
13114 "Return the TODO keyword of the current subtree."
13116 (org-back-to-heading t)
13117 (and (looking-at org-todo-line-regexp)
13119 (match-string 2))))
13121 (defun org-at-date-range-p (&optional inactive-ok)
13122 "Is the cursor inside a date range?"
13126 (let ((pos (point)))
13127 (skip-chars-backward "^[<\r\n")
13128 (skip-chars-backward "<[")
13129 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13130 (>= (match-end 0) pos)
13132 (skip-chars-backward "^<[\r\n")
13133 (skip-chars-backward "<[")
13134 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13135 (>= (match-end 0) pos)
13139 (defun org-get-repeat (&optional tagline)
13140 "Check if there is a deadline/schedule with repeater in this entry."
13143 (org-back-to-heading t)
13144 (and (re-search-forward (if tagline
13145 (concat tagline "\\s-*" org-repeat-re)
13147 (org-entry-end-position) t)
13148 (match-string-no-properties 1)))))
13150 (defvar org-last-changed-timestamp)
13151 (defvar org-last-inserted-timestamp)
13152 (defvar org-log-post-message)
13153 (defvar org-log-note-purpose)
13154 (defvar org-log-note-how nil)
13155 (defvar org-log-note-extra)
13156 (defun org-auto-repeat-maybe (done-word)
13157 "Check if the current headline contains a repeated deadline/schedule.
13158 If yes, set TODO state back to what it was and change the base date
13159 of repeating deadline/scheduled time stamps to new date.
13160 This function is run automatically after each state change to a DONE state."
13161 ;; last-state is dynamically scoped into this function
13162 (let* ((repeat (org-get-repeat))
13163 (aa (assoc org-last-state org-todo-kwd-alist))
13164 (interpret (nth 1 aa))
13166 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13167 (msg "Entry repeats: ")
13169 (org-todo-log-states nil)
13170 re type n what ts time to-state)
13171 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13172 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13173 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13174 org-todo-repeat-to-state))
13175 (unless (and to-state (member to-state org-todo-keywords-1))
13176 (setq to-state (if (eq interpret 'type) org-last-state head)))
13177 (org-todo to-state)
13178 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13179 (org-entry-put nil "LAST_REPEAT" (format-time-string
13180 (org-time-stamp-format t t))))
13181 (when org-log-repeat
13182 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13183 (memq 'org-add-log-note post-command-hook))
13184 ;; OK, we are already setup for some record
13185 (if (eq org-log-repeat 'note)
13186 ;; make sure we take a note, not only a time stamp
13187 (setq org-log-note-how 'note))
13188 ;; Set up for taking a record
13189 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13191 'findpos org-log-repeat)))
13192 (org-back-to-heading t)
13193 (org-add-planning-info nil nil 'closed)
13194 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13195 org-deadline-time-regexp "\\)\\|\\("
13196 org-ts-regexp "\\)"))
13197 (while (re-search-forward
13198 re (save-excursion (outline-next-heading) (point)) t)
13199 (setq type (if (match-end 1) org-scheduled-string
13200 (if (match-end 3) org-deadline-string "Plain:"))
13201 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13202 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13203 (setq n (string-to-number (match-string 2 ts))
13204 what (match-string 3 ts))
13205 (if (equal what "w") (setq n (* n 7) what "d"))
13206 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13207 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13208 ;; Preparation, see if we need to modify the start date for the change
13209 (when (match-end 1)
13210 (setq time (save-match-data (org-time-string-to-time ts)))
13212 ((equal (match-string 1 ts) ".")
13213 ;; Shift starting date to today
13214 (org-timestamp-change
13215 (- (org-today) (time-to-days time))
13217 ((equal (match-string 1 ts) "+")
13218 (let ((nshiftmax 10) (nshift 0))
13219 (while (or (= nshift 0)
13220 (<= (time-to-days time)
13221 (time-to-days (current-time))))
13222 (when (= (incf nshift) nshiftmax)
13223 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13224 (user-error "Abort")))
13225 (org-timestamp-change n (cdr (assoc what whata)))
13226 (org-at-timestamp-p t)
13227 (setq ts (match-string 1))
13228 (setq time (save-match-data (org-time-string-to-time ts)))))
13229 (org-timestamp-change (- n) (cdr (assoc what whata)))
13230 ;; rematch, so that we have everything in place for the real shift
13231 (org-at-timestamp-p t)
13232 (setq ts (match-string 1))
13233 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13234 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13235 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13236 (setq org-log-post-message msg)
13237 (message "%s" msg))))
13239 (defun org-show-todo-tree (arg)
13240 "Make a compact tree which shows all headlines marked with TODO.
13241 The tree will show the lines where the regexp matches, and all higher
13242 headlines above the match.
13243 With a \\[universal-argument] prefix, prompt for a regexp to match.
13244 With a numeric prefix N, construct a sparse tree for the Nth element
13245 of `org-todo-keywords-1'."
13247 (let ((case-fold-search nil)
13249 (cond ((null arg) org-not-done-regexp)
13251 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13252 (mapcar 'list org-todo-keywords-1))))
13254 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13256 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13257 (regexp-quote (nth (1- (prefix-numeric-value arg))
13258 org-todo-keywords-1)))
13259 (t (user-error "Invalid prefix argument: %s" arg)))))
13260 (message "%d TODO entries found"
13261 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13263 (defun org-deadline (arg &optional time)
13264 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13265 With one universal prefix argument, remove any deadline from the item.
13266 With two universal prefix arguments, prompt for a warning delay.
13267 With argument TIME, set the deadline at the corresponding date. TIME
13268 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13270 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13271 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13272 'region-start-level 'region))
13273 org-loop-over-headlines-in-active-region)
13275 `(org-deadline ',arg ,time)
13276 org-loop-over-headlines-in-active-region
13277 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13278 (let* ((old-date (org-entry-get nil "DEADLINE"))
13279 (old-date-time (if old-date (org-time-string-to-time old-date)))
13280 (repeater (and old-date
13282 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13284 (match-string 1 old-date))))
13287 (when (and old-date org-log-redeadline)
13288 (org-add-log-setup 'deldeadline nil old-date 'findpos
13289 org-log-redeadline))
13290 (org-remove-timestamp-with-keyword org-deadline-string)
13291 (message "Item no longer has a deadline."))
13294 (org-back-to-heading t)
13295 (if (re-search-forward
13296 org-deadline-time-regexp
13297 (save-excursion (outline-next-heading) (point)) t)
13298 (let* ((rpl0 (match-string 1))
13299 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13301 (concat org-deadline-string
13307 (org-read-date nil t nil "Warn starting from" old-date-time)))
13308 (time-to-days old-date-time))))
13310 (user-error "No deadline information to update"))))
13312 (org-add-planning-info 'deadline time 'closed)
13313 (when (and old-date org-log-redeadline
13314 (not (equal old-date
13315 (substring org-last-inserted-timestamp 1 -1))))
13316 (org-add-log-setup 'redeadline nil old-date 'findpos
13317 org-log-redeadline))
13320 (org-back-to-heading t)
13321 (when (re-search-forward (concat org-deadline-string " "
13322 org-last-inserted-timestamp)
13324 (outline-next-heading) (point)) t)
13325 (goto-char (1- (match-end 0)))
13326 (insert " " repeater)
13327 (setq org-last-inserted-timestamp
13328 (concat (substring org-last-inserted-timestamp 0 -1)
13330 (substring org-last-inserted-timestamp -1))))))
13331 (message "Deadline on %s" org-last-inserted-timestamp))))))
13333 (defun org-schedule (arg &optional time)
13334 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13335 With one universal prefix argument, remove any scheduling date from the item.
13336 With two universal prefix arguments, prompt for a delay cookie.
13337 With argument TIME, scheduled at the corresponding date. TIME can
13338 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13340 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13341 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13342 'region-start-level 'region))
13343 org-loop-over-headlines-in-active-region)
13345 `(org-schedule ',arg ,time)
13346 org-loop-over-headlines-in-active-region
13347 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13348 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13349 (old-date-time (if old-date (org-time-string-to-time old-date)))
13350 (repeater (and old-date
13352 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13354 (match-string 1 old-date))))
13358 (when (and old-date org-log-reschedule)
13359 (org-add-log-setup 'delschedule nil old-date 'findpos
13360 org-log-reschedule))
13361 (org-remove-timestamp-with-keyword org-scheduled-string)
13362 (message "Item is no longer scheduled.")))
13365 (org-back-to-heading t)
13366 (if (re-search-forward
13367 org-scheduled-time-regexp
13368 (save-excursion (outline-next-heading) (point)) t)
13369 (let* ((rpl0 (match-string 1))
13370 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13372 (concat org-scheduled-string
13378 (org-read-date nil t nil "Delay until" old-date-time)))
13379 (time-to-days old-date-time))))
13381 (user-error "No scheduled information to update"))))
13383 (org-add-planning-info 'scheduled time 'closed)
13384 (when (and old-date org-log-reschedule
13385 (not (equal old-date
13386 (substring org-last-inserted-timestamp 1 -1))))
13387 (org-add-log-setup 'reschedule nil old-date 'findpos
13388 org-log-reschedule))
13391 (org-back-to-heading t)
13392 (when (re-search-forward (concat org-scheduled-string " "
13393 org-last-inserted-timestamp)
13395 (outline-next-heading) (point)) t)
13396 (goto-char (1- (match-end 0)))
13397 (insert " " repeater)
13398 (setq org-last-inserted-timestamp
13399 (concat (substring org-last-inserted-timestamp 0 -1)
13401 (substring org-last-inserted-timestamp -1))))))
13402 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13404 (defun org-get-scheduled-time (pom &optional inherit)
13405 "Get the scheduled time as a time tuple, of a format suitable
13406 for calling org-schedule with, or if there is no scheduling,
13408 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13410 (apply 'encode-time (org-parse-time-string time)))))
13412 (defun org-get-deadline-time (pom &optional inherit)
13413 "Get the deadline as a time tuple, of a format suitable for
13414 calling org-deadline with, or if there is no scheduling, returns
13416 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13418 (apply 'encode-time (org-parse-time-string time)))))
13420 (defun org-remove-timestamp-with-keyword (keyword)
13421 "Remove all time stamps with KEYWORD in the current entry."
13422 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13425 (org-back-to-heading t)
13427 (outline-next-heading)
13428 (while (re-search-backward re beg t)
13430 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13431 (equal (char-before) ?\ ))
13432 (backward-delete-char 1)
13433 (if (string-match "^[ \t]*$" (buffer-substring
13434 (point-at-bol) (point-at-eol)))
13435 (delete-region (point-at-bol)
13436 (min (point-max) (1+ (point-at-eol))))))))))
13438 (defvar org-time-was-given) ; dynamically scoped parameter
13439 (defvar org-end-time-was-given) ; dynamically scoped parameter
13441 (defun org-at-planning-p ()
13442 "Non-nil when point is on a planning info line."
13443 ;; This is as accurate and faster than `org-element-at-point' since
13444 ;; planning info location is fixed in the section.
13445 (org-with-wide-buffer
13446 (beginning-of-line)
13447 (and (org-looking-at-p org-planning-line-re)
13450 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13451 (org-back-to-heading t)
13452 (org-with-limited-levels (org-back-to-heading t)))
13453 (line-beginning-position 2))))))
13455 (defun org-add-planning-info (what &optional time &rest remove)
13456 "Insert new timestamp with keyword in the planning line.
13457 WHAT indicates what kind of time stamp to add. It is a symbol
13458 among `closed', `deadline', `scheduled' and nil. TIME indicates
13459 the time to use. If none is given, the user is prompted for
13460 a date. REMOVE indicates what kind of entries to remove. An old
13461 WHAT entry will also be removed."
13462 (let (org-time-was-given org-end-time-was-given default-time default-input)
13464 (when (and (memq what '(scheduled deadline))
13466 (and (stringp time)
13467 (string-match "^[-+]+[0-9]" time))))
13468 ;; Try to get a default date/time from existing timestamp
13470 (org-back-to-heading t)
13471 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13472 (when (re-search-forward (if (eq what 'scheduled)
13473 org-scheduled-time-regexp
13474 org-deadline-time-regexp)
13476 (setq ts (match-string 1)
13477 default-time (apply 'encode-time (org-parse-time-string ts))
13478 default-input (and ts (org-get-compact-tod ts)))))))
13482 ;; This is a string (relative or absolute), set
13484 (apply #'encode-time
13485 (org-read-date-analyze
13486 time default-time (decode-time default-time)))
13487 ;; If necessary, get the time from the user
13488 (or time (org-read-date nil 'to-time nil nil
13489 default-time default-input)))))
13491 (org-with-wide-buffer
13492 (org-back-to-heading t)
13494 (unless (bolp) (insert "\n"))
13495 (cond ((org-looking-at-p org-planning-line-re)
13496 ;; Move to current indentation.
13497 (skip-chars-forward " \t")
13498 ;; Check if we have to remove something.
13499 (dolist (type (if what (cons what remove) remove))
13500 (when (save-excursion
13503 (closed org-closed-time-regexp)
13504 (deadline org-deadline-time-regexp)
13505 (scheduled org-scheduled-time-regexp)
13506 (otherwise (error "Invalid planning type: %s" type)))
13507 (line-end-position) t))
13509 (when (looking-at "--+<[^>]+>") (replace-match ""))
13510 (when (and (not what) (eq type 'closed))
13512 (beginning-of-line)
13513 (if (looking-at "[ \t]*$")
13514 (delete-region (point) (1+ (point-at-eol)))))))
13515 ;; Remove leading white spaces.
13516 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13517 ((not what) (throw 'exit nil)) ; Nothing to do.
13518 (t (insert-before-markers "\n")
13520 (when org-adapt-indentation
13521 (org-indent-to-column (1+ (org-outline-level))))))
13523 ;; Insert planning keyword.
13525 (closed org-closed-string)
13526 (deadline org-deadline-string)
13527 (scheduled org-scheduled-string)
13528 (otherwise (error "Invalid planning type: %s" what)))
13530 ;; Insert associated timestamp.
13531 (let ((ts (org-insert-time-stamp
13533 (or org-time-was-given
13534 (and (eq what 'closed) org-log-done-with-time))
13536 nil nil (list org-end-time-was-given))))
13537 (unless (eolp) (insert " "))
13540 (defvar org-log-note-marker (make-marker))
13541 (defvar org-log-note-purpose nil)
13542 (defvar org-log-note-state nil)
13543 (defvar org-log-note-previous-state nil)
13544 (defvar org-log-note-extra nil)
13545 (defvar org-log-note-window-configuration nil)
13546 (defvar org-log-note-return-to (make-marker))
13547 (defvar org-log-note-effective-time nil
13548 "Remembered current time so that dynamically scoped
13549 `org-extend-today-until' affects tha timestamps in state change
13552 (defvar org-log-post-message nil
13553 "Message to be displayed after a log note has been stored.
13554 The auto-repeater uses this.")
13556 (defun org-add-note ()
13557 "Add a note to the current entry.
13558 This is done in the same way as adding a state change note."
13560 (org-add-log-setup 'note nil nil 'findpos nil))
13562 (defun org-log-beginning (&optional create)
13563 "Return expected start of log notes in current entry.
13564 When optional argument CREATE is non-nil, the function creates
13565 a drawer to store notes, if necessary. Returned position ignores
13567 (org-with-wide-buffer
13568 (org-end-of-meta-data)
13569 (let ((end (if (org-at-heading-p) (point)
13570 (save-excursion (outline-next-heading) (point))))
13571 (drawer (org-log-into-drawer)))
13574 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13575 (case-fold-search t))
13577 ;; Try to find existing drawer.
13578 (while (re-search-forward regexp end t)
13579 (let ((element (org-element-at-point)))
13580 (when (eq (org-element-type element) 'drawer)
13581 (let ((cend (org-element-property :contents-end element)))
13582 (when (and (not org-log-states-order-reversed) cend)
13584 (throw 'exit nil))))
13585 ;; No drawer found. Create one, if permitted.
13587 (unless (bolp) (insert "\n"))
13588 (let ((beg (point)))
13589 (insert ":" drawer ":\n:END:\n")
13590 (org-indent-region beg (point)))
13591 (end-of-line -1)))))
13592 (org-log-state-notes-insert-after-drawers
13593 (while (and (looking-at org-drawer-regexp)
13594 (progn (goto-char (match-end 0))
13595 (re-search-forward org-property-end-re end t)))
13597 (if (bolp) (point) (line-beginning-position 2))))
13599 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13600 "Set up the post command hook to take a note.
13601 If this is about to TODO state change, the new state is expected in STATE.
13602 When FINDPOS is non-nil, find the correct position for the note in
13603 the current entry. If not, assume that it can be inserted at point.
13604 HOW is an indicator what kind of note should be created.
13605 EXTRA is additional text that will be inserted into the notes buffer."
13606 (org-with-wide-buffer
13608 (goto-char (org-log-beginning t))
13609 (unless org-log-states-order-reversed
13610 (org-skip-over-state-notes)
13611 (skip-chars-backward " \t\n\r")
13613 (move-marker org-log-note-marker (point))
13614 ;; Preserve position even if a property drawer is inserted in the
13616 (set-marker-insertion-type org-log-note-marker t)
13617 (setq org-log-note-purpose purpose
13618 org-log-note-state state
13619 org-log-note-previous-state prev-state
13620 org-log-note-how how
13621 org-log-note-extra extra
13622 org-log-note-effective-time (org-current-effective-time))
13623 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13625 (defun org-skip-over-state-notes ()
13626 "Skip past the list of State notes in an entry."
13627 (when (ignore-errors (goto-char (org-in-item-p)))
13628 (let* ((struct (org-list-struct))
13629 (prevs (org-list-prevs-alist struct))
13631 (concat "[ \t]*- +"
13632 (replace-regexp-in-string
13634 (org-replace-escapes
13635 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13636 `(("%d" . ,org-ts-regexp-inactive)
13637 ("%D" . ,org-ts-regexp)
13638 ("%s" . "\"\\S-+\"")
13639 ("%S" . "\"\\S-+\"")
13640 ("%t" . ,org-ts-regexp-inactive)
13641 ("%T" . ,org-ts-regexp)
13643 ("%U" . ".*?")))))))
13644 (while (org-looking-at-p regexp)
13645 (goto-char (or (org-list-get-next-item (point) struct prevs)
13646 (org-list-get-item-end (point) struct)))))))
13648 (defun org-add-log-note (&optional purpose)
13649 "Pop up a window for taking a note, and add this note later at point."
13650 (remove-hook 'post-command-hook 'org-add-log-note)
13651 (setq org-log-note-window-configuration (current-window-configuration))
13652 (delete-other-windows)
13653 (move-marker org-log-note-return-to (point))
13654 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13655 (goto-char org-log-note-marker)
13656 (org-switch-to-buffer-other-window "*Org Note*")
13658 (if (memq org-log-note-how '(time state))
13659 (let (current-prefix-arg) (org-store-log-note))
13660 (let ((org-inhibit-startup t)) (org-mode))
13661 (insert (format "# Insert note for %s.
13662 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13664 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13665 ((eq org-log-note-purpose 'done) "closed todo item")
13666 ((eq org-log-note-purpose 'state)
13667 (format "state change from \"%s\" to \"%s\""
13668 (or org-log-note-previous-state "")
13669 (or org-log-note-state "")))
13670 ((eq org-log-note-purpose 'reschedule)
13672 ((eq org-log-note-purpose 'delschedule)
13673 "no longer scheduled")
13674 ((eq org-log-note-purpose 'redeadline)
13675 "changing deadline")
13676 ((eq org-log-note-purpose 'deldeadline)
13677 "removing deadline")
13678 ((eq org-log-note-purpose 'refile)
13680 ((eq org-log-note-purpose 'note)
13682 (t (error "This should not happen")))))
13683 (if org-log-note-extra (insert org-log-note-extra))
13684 (org-set-local 'org-finish-function 'org-store-log-note)
13685 (run-hooks 'org-log-buffer-setup-hook)))
13687 (defvar org-note-abort nil) ; dynamically scoped
13688 (defun org-store-log-note ()
13689 "Finish taking a log note, and insert it to where it belongs."
13690 (let ((txt (buffer-string)))
13691 (kill-buffer (current-buffer))
13692 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13693 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13694 (setq txt (replace-match "" t t txt)))
13695 (if (string-match "\\s-+\\'" txt)
13696 (setq txt (replace-match "" t t txt)))
13697 (setq lines (org-split-string txt "\n"))
13698 (when (and note (string-match "\\S-" note))
13700 (org-replace-escapes
13702 (list (cons "%u" (user-login-name))
13703 (cons "%U" user-full-name)
13704 (cons "%t" (format-time-string
13705 (org-time-stamp-format 'long 'inactive)
13706 org-log-note-effective-time))
13707 (cons "%T" (format-time-string
13708 (org-time-stamp-format 'long nil)
13709 org-log-note-effective-time))
13710 (cons "%d" (format-time-string
13711 (org-time-stamp-format nil 'inactive)
13712 org-log-note-effective-time))
13713 (cons "%D" (format-time-string
13714 (org-time-stamp-format nil nil)
13715 org-log-note-effective-time))
13716 (cons "%s" (if org-log-note-state
13717 (concat "\"" org-log-note-state "\"")
13719 (cons "%S" (if org-log-note-previous-state
13720 (concat "\"" org-log-note-previous-state "\"")
13722 (when lines (setq note (concat note " \\\\")))
13724 (when (or current-prefix-arg org-note-abort)
13725 (when (org-log-into-drawer)
13726 (org-remove-empty-drawer-at org-log-note-marker))
13729 (with-current-buffer (marker-buffer org-log-note-marker)
13731 (goto-char org-log-note-marker)
13732 (move-marker org-log-note-marker nil)
13733 ;; Make sure point is at the beginning of an empty line.
13734 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13735 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13736 ;; In an existing list, add a new item at the top level.
13737 ;; Otherwise, indent line like a regular one.
13738 (let ((itemp (org-in-item-p)))
13740 (org-indent-line-to
13741 (let ((struct (save-excursion
13742 (goto-char itemp) (org-list-struct))))
13743 (org-list-get-ind (org-list-get-top-point struct) struct)))
13744 (org-indent-line)))
13745 (insert (org-list-bullet-string "-") (pop lines))
13746 (let ((ind (org-list-item-body-column (line-beginning-position))))
13747 (dolist (line lines)
13749 (org-indent-line-to ind)
13751 (message "Note stored")
13752 (org-back-to-heading t)
13753 (org-cycle-hide-drawers 'children))
13754 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13755 ;; from within `org-add-log-note' because `buffer-undo-list'
13756 ;; is then modified outside of `org-with-remote-undo'.
13757 (when (eq this-command 'org-agenda-todo)
13758 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13759 ;; Don't add undo information when called from `org-agenda-todo'
13760 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13761 (set-window-configuration org-log-note-window-configuration)
13762 (with-current-buffer (marker-buffer org-log-note-return-to)
13763 (goto-char org-log-note-return-to))
13764 (move-marker org-log-note-return-to nil)
13765 (and org-log-post-message (message "%s" org-log-post-message))))
13767 (defun org-remove-empty-drawer-at (pos)
13768 "Remove an empty drawer at position POS.
13769 POS may also be a marker."
13770 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13771 (org-with-wide-buffer
13773 (let ((drawer (org-element-at-point)))
13774 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13775 (not (org-element-property :contents-begin drawer)))
13776 (delete-region (org-element-property :begin drawer)
13777 (progn (goto-char (org-element-property :end drawer))
13778 (skip-chars-backward " \r\t\n")
13782 (defvar org-ts-type nil)
13783 (defun org-sparse-tree (&optional arg type)
13784 "Create a sparse tree, prompt for the details.
13785 This command can create sparse trees. You first need to select the type
13786 of match used to create the tree:
13788 t Show all TODO entries.
13789 T Show entries with a specific TODO keyword.
13790 m Show entries selected by a tags/property match.
13791 p Enter a property name and its value (both with completion on existing
13792 names/values) and show entries with that property.
13793 r Show entries matching a regular expression (`/' can be used as well).
13794 b Show deadlines and scheduled items before a date.
13795 a Show deadlines and scheduled items after a date.
13796 d Show deadlines due within `org-deadline-warning-days'.
13797 D Show deadlines and scheduled items between a date range."
13799 (setq type (or type org-sparse-tree-default-date-type))
13800 (setq org-ts-type type)
13801 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13802 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13803 [c]ycle through date types: %s"
13805 (all "all timestamps")
13806 (scheduled "only scheduled")
13807 (deadline "only deadline")
13808 (active "only active timestamps")
13809 (inactive "only inactive timestamps")
13810 (closed "with a closed time-stamp")
13811 (otherwise "scheduled/deadline")))
13812 (let ((answer (read-char-exclusive)))
13818 (memq type '(nil all scheduled deadline active inactive closed)))))
13819 (?d (call-interactively 'org-check-deadlines))
13820 (?b (call-interactively 'org-check-before-date))
13821 (?a (call-interactively 'org-check-after-date))
13822 (?D (call-interactively 'org-check-dates-range))
13823 (?t (call-interactively 'org-show-todo-tree))
13824 (?T (org-show-todo-tree '(4)))
13825 (?m (call-interactively 'org-match-sparse-tree))
13827 (let* ((kwd (org-icompleting-read
13828 "Property: " (mapcar 'list (org-buffer-property-keys))))
13829 (value (org-icompleting-read
13830 "Value: " (mapcar 'list (org-property-values kwd)))))
13831 (unless (string-match "\\`{.*}\\'" value)
13832 (setq value (concat "\"" value "\"")))
13833 (org-match-sparse-tree arg (concat kwd "=" value))))
13834 ((?r ?R ?/) (call-interactively 'org-occur))
13835 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13837 (defvar org-occur-highlights nil
13838 "List of overlays used for occur matches.")
13839 (make-variable-buffer-local 'org-occur-highlights)
13840 (defvar org-occur-parameters nil
13841 "Parameters of the active org-occur calls.
13842 This is a list, each call to org-occur pushes as cons cell,
13843 containing the regular expression and the callback, onto the list.
13844 The list can contain several entries if `org-occur' has been called
13845 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13846 will only contain one set of parameters. When the highlights are
13847 removed (for example with `C-c C-c', or with the next edit (depending
13848 on `org-remove-highlights-with-change'), this variable is emptied
13850 (make-variable-buffer-local 'org-occur-parameters)
13852 (defun org-occur (regexp &optional keep-previous callback)
13853 "Make a compact tree which shows all matches of REGEXP.
13854 The tree will show the lines where the regexp matches, and all higher
13855 headlines above the match. It will also show the heading after the match,
13856 to make sure editing the matching entry is easy.
13857 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13858 call to `org-occur' will be kept, to allow stacking of calls to this
13860 If CALLBACK is non-nil, it is a function which is called to confirm
13861 that the match should indeed be shown."
13862 (interactive "sRegexp: \nP")
13863 (when (equal regexp "")
13864 (user-error "Regexp cannot be empty"))
13865 (unless keep-previous
13866 (org-remove-occur-highlights nil nil t))
13867 (push (cons regexp callback) org-occur-parameters)
13870 (goto-char (point-min))
13871 (if (or (not keep-previous) ; do not want to keep
13872 (not org-occur-highlights)) ; no previous matches
13875 (while (re-search-forward regexp nil t)
13876 (when (or (not callback)
13877 (save-match-data (funcall callback)))
13878 (setq cnt (1+ cnt))
13879 (when org-highlight-sparse-tree-matches
13880 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13881 (org-show-context 'occur-tree))))
13882 (when org-remove-highlights-with-change
13883 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13885 (unless org-sparse-tree-open-archived-trees
13886 (org-hide-archived-subtrees (point-min) (point-max)))
13887 (run-hooks 'org-occur-hook)
13888 (if (org-called-interactively-p 'interactive)
13889 (message "%d match(es) for regexp %s" cnt regexp))
13892 (defun org-occur-next-match (&optional n reset)
13893 "Function for `next-error-function' to find sparse tree matches.
13894 N is the number of matches to move, when negative move backwards.
13895 RESET is entirely ignored - this function always goes back to the
13896 starting point when no match is found."
13897 (let* ((limit (if (< n 0) (point-min) (point-max)))
13898 (search-func (if (< n 0)
13899 'previous-single-char-property-change
13900 'next-single-char-property-change))
13905 (while (setq p1 (funcall search-func (point) 'org-type))
13906 (when (equal p1 limit)
13908 (user-error "No more matches"))
13909 (when (equal (get-char-property p1 'org-type) 'org-occur)
13913 (throw 'exit (point))))
13916 (user-error "No more matches"))))
13918 (defun org-show-context (&optional key)
13919 "Make sure point and context are visible.
13920 How much context is shown depends upon the variables
13921 `org-show-hierarchy-above', `org-show-following-heading',
13922 `org-show-entry-below' and `org-show-siblings'."
13923 (let ((heading-p (org-at-heading-p t))
13924 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13925 (following-p (org-get-alist-option org-show-following-heading key))
13926 (entry-p (org-get-alist-option org-show-entry-below key))
13927 (siblings-p (org-get-alist-option org-show-siblings key)))
13928 ;; Show heading or entry text
13929 (if (and heading-p (not entry-p))
13930 (org-flag-heading nil) ; only show the heading
13931 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13932 (org-show-hidden-entry))) ; show entire entry
13934 ;; Show next sibling, or heading below text
13936 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13937 (org-flag-heading nil))))
13938 (when siblings-p (org-show-siblings))
13940 ;; show all higher headings, possibly with siblings
13942 (while (and (ignore-errors (progn (org-up-heading-all 1) t))
13944 (org-flag-heading nil)
13945 (when siblings-p (org-show-siblings)))))))
13947 (defvar org-reveal-start-hook nil
13948 "Hook run before revealing a location.")
13950 (defun org-reveal (&optional siblings)
13951 "Show current entry, hierarchy above it, and the following headline.
13952 This can be used to show a consistent set of context around locations
13953 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13954 not t for the search context.
13956 With optional argument SIBLINGS, on each level of the hierarchy all
13957 siblings are shown. This repairs the tree structure to what it would
13958 look like when opened with hierarchical calls to `org-cycle'.
13959 With double optional argument \\[universal-argument] \\[universal-argument], \
13960 go to the parent and show the
13963 (run-hooks 'org-reveal-start-hook)
13964 (let ((org-show-hierarchy-above t)
13965 (org-show-following-heading t)
13966 (org-show-siblings (if siblings t org-show-siblings)))
13967 (org-show-context nil))
13968 (when (equal siblings '(16))
13970 (when (org-up-heading-safe)
13972 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13974 (defun org-highlight-new-match (beg end)
13975 "Highlight from BEG to END and mark the highlight is an occur headline."
13976 (let ((ov (make-overlay beg end)))
13977 (overlay-put ov 'face 'secondary-selection)
13978 (overlay-put ov 'org-type 'org-occur)
13979 (push ov org-occur-highlights)))
13981 (defun org-remove-occur-highlights (&optional beg end noremove)
13982 "Remove the occur highlights from the buffer.
13983 BEG and END are ignored. If NOREMOVE is nil, remove this function
13984 from the `before-change-functions' in the current buffer."
13986 (unless org-inhibit-highlight-removal
13987 (mapc 'delete-overlay org-occur-highlights)
13988 (setq org-occur-highlights nil)
13989 (setq org-occur-parameters nil)
13991 (remove-hook 'before-change-functions
13992 'org-remove-occur-highlights 'local))))
13996 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13997 "Regular expression matching the priority indicator.")
13999 (defvar org-remove-priority-next-time nil)
14001 (defun org-priority-up ()
14002 "Increase the priority of the current item."
14004 (org-priority 'up))
14006 (defun org-priority-down ()
14007 "Decrease the priority of the current item."
14009 (org-priority 'down))
14011 (defun org-priority (&optional action show)
14012 "Change the priority of an item.
14013 ACTION can be `set', `up', `down', or a character."
14015 (if (equal action '(4))
14016 (org-show-priority)
14017 (unless org-enable-priority-commands
14018 (user-error "Priority commands are disabled"))
14019 (setq action (or action 'set))
14020 (let (current new news have remove)
14022 (org-back-to-heading t)
14023 (if (looking-at org-priority-regexp)
14024 (setq current (string-to-char (match-string 2))
14027 ((eq action 'remove)
14028 (setq remove t new ?\ ))
14029 ((or (eq action 'set)
14030 (if (featurep 'xemacs) (characterp action) (integerp action)))
14031 (if (not (eq action 'set))
14033 (message "Priority %c-%c, SPC to remove: "
14034 org-highest-priority org-lowest-priority)
14036 (setq new (read-char-exclusive))))
14037 (if (and (= (upcase org-highest-priority) org-highest-priority)
14038 (= (upcase org-lowest-priority) org-lowest-priority))
14039 (setq new (upcase new)))
14040 (cond ((equal new ?\ ) (setq remove t))
14041 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14042 (user-error "Priority must be between `%c' and `%c'"
14043 org-highest-priority org-lowest-priority))))
14046 (1- current) ; normal cycling
14047 ;; last priority was empty
14048 (if (eq last-command this-command)
14049 org-lowest-priority ; wrap around empty to lowest
14051 (if org-priority-start-cycle-with-default
14052 org-default-priority
14053 (1- org-default-priority))))))
14056 (1+ current) ; normal cycling
14057 ;; last priority was empty
14058 (if (eq last-command this-command)
14059 org-highest-priority ; wrap around empty to highest
14061 (if org-priority-start-cycle-with-default
14062 org-default-priority
14063 (1+ org-default-priority))))))
14064 (t (user-error "Invalid action")))
14065 (if (or (< (upcase new) org-highest-priority)
14066 (> (upcase new) org-lowest-priority))
14067 (if (and (memq action '(up down))
14068 (not have) (not (eq last-command this-command)))
14069 ;; `new' is from default priority
14071 "The default can not be set, see `org-default-priority' why")
14072 ;; normal cycling: `new' is beyond highest/lowest priority
14073 ;; and is wrapped around to the empty priority
14075 (setq news (format "%c" new))
14078 (replace-match "" t t nil 1)
14079 (replace-match news t t nil 2))
14081 (user-error "No priority cookie found in line")
14082 (let ((case-fold-search nil))
14083 (looking-at org-todo-line-regexp))
14086 (goto-char (match-end 2))
14087 (insert " [#" news "]"))
14088 (goto-char (match-beginning 3))
14089 (insert "[#" news "] "))))
14090 (org-set-tags nil 'align))
14092 (message "Priority removed")
14093 (message "Priority of current item set to %s" news)))))
14095 (defun org-show-priority ()
14096 "Show the priority of the current item.
14097 This priority is composed of the main priority given with the [#A] cookies,
14098 and by additional input from the age of a schedules or deadline entry."
14100 (let ((pri (if (eq major-mode 'org-agenda-mode)
14101 (org-get-at-bol 'priority)
14104 (beginning-of-line)
14105 (and (looking-at org-heading-regexp)
14106 (org-get-priority (match-string 0))))))))
14107 (message "Priority is %d" (if pri pri -1000))))
14109 (defun org-get-priority (s)
14110 "Find priority cookie and return priority."
14112 (if (functionp org-get-priority-function)
14113 (funcall org-get-priority-function)
14114 (if (not (string-match org-priority-regexp s))
14115 (* 1000 (- org-lowest-priority org-default-priority))
14116 (* 1000 (- org-lowest-priority
14117 (string-to-char (match-string 2 s))))))))
14121 (defvar org-agenda-archives-mode)
14122 (defvar org-map-continue-from nil
14123 "Position from where mapping should continue.
14124 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14126 (defvar org-scanner-tags nil
14127 "The current tag list while the tags scanner is running.")
14128 (defvar org-trust-scanner-tags nil
14129 "Should `org-get-tags-at' use the tags for the scanner.
14130 This is for internal dynamical scoping only.
14131 When this is non-nil, the function `org-get-tags-at' will return the value
14132 of `org-scanner-tags' instead of building the list by itself. This
14133 can lead to large speed-ups when the tags scanner is used in a file with
14134 many entries, and when the list of tags is retrieved, for example to
14135 obtain a list of properties. Building the tags list for each entry in such
14136 a file becomes an N^2 operation - but with this variable set, it scales
14139 (defun org-scan-tags (action matcher todo-only &optional start-level)
14140 "Scan headline tags with inheritance and produce output ACTION.
14142 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14143 or `agenda' to produce an entry list for an agenda view. It can also be
14144 a Lisp form or a function that should be called at each matched headline, in
14145 this case the return value is a list of all return values from these calls.
14147 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14148 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14149 only lines with a not-done TODO keyword are included in the output.
14150 This should be the same variable that was scoped into
14151 and set by `org-make-tags-matcher' when it constructed MATCHER.
14153 START-LEVEL can be a string with asterisks, reducing the scope to
14154 headlines matching this string."
14155 (require 'org-agenda)
14156 (let* ((re (concat "^"
14158 ;; Get the correct level to match
14159 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14160 org-outline-regexp)
14162 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14163 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14164 (props (list 'face 'default
14165 'done-face 'org-agenda-done
14166 'undone-face 'default
14167 'mouse-face 'highlight
14168 'org-not-done-regexp org-not-done-regexp
14169 'org-todo-regexp org-todo-regexp
14170 'org-complex-heading-regexp org-complex-heading-regexp
14172 (format "mouse-2 or RET jump to org file %s"
14173 (abbreviate-file-name
14174 (or (buffer-file-name (buffer-base-buffer))
14175 (buffer-name (buffer-base-buffer)))))))
14176 (org-map-continue-from nil)
14177 lspos tags tags-list
14178 (tags-alist (list (cons 0 org-file-tags)))
14179 (llast 0) rtn rtn1 level category i txt
14180 todo marker entry priority)
14181 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14182 (setq action (list 'lambda nil action)))
14184 (goto-char (point-min))
14185 (when (eq action 'sparse-tree)
14187 (org-remove-occur-highlights))
14188 (while (let (case-fold-search)
14189 (re-search-forward re nil t))
14190 (setq org-map-continue-from nil)
14192 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14193 tags (if (match-end 4) (org-match-string-no-properties 4)))
14194 (goto-char (setq lspos (match-beginning 0)))
14195 (setq level (org-reduced-level (org-outline-level))
14196 category (org-get-category))
14197 (setq i llast llast level)
14198 ;; remove tag lists from same and sublevels
14199 (while (>= i level)
14200 (when (setq entry (assoc i tags-alist))
14201 (setq tags-alist (delete entry tags-alist)))
14203 ;; add the next tags
14205 (setq tags (org-split-string tags ":")
14207 (cons (cons level tags) tags-alist)))
14208 ;; compile tags for current headline
14210 (if org-use-tag-inheritance
14211 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14213 org-scanner-tags tags-list)
14214 (when org-use-tag-inheritance
14215 (setcdr (car tags-alist)
14216 (mapcar (lambda (x)
14217 (setq x (copy-sequence x))
14218 (org-add-prop-inherited x))
14219 (cdar tags-alist))))
14220 (when (and tags org-use-tag-inheritance
14221 (or (not (eq t org-use-tag-inheritance))
14222 org-tags-exclude-from-inheritance))
14223 ;; selective inheritance, remove uninherited ones
14224 (setcdr (car tags-alist)
14225 (org-remove-uninherited-tags (cdar tags-alist))))
14228 ;; eval matcher only when the todo condition is OK
14229 (and (or (not todo-only) (member todo org-not-done-keywords))
14230 (let ((case-fold-search t) (org-trust-scanner-tags t))
14233 ;; Call the skipper, but return t if it does not skip,
14234 ;; so that the `and' form continues evaluating
14236 (unless (eq action 'sparse-tree) (org-agenda-skip))
14239 ;; Check if timestamps are deselecting this entry
14240 (or (not todo-only)
14241 (and (member todo org-not-done-keywords)
14242 (or (not org-agenda-tags-todo-honor-ignore-options)
14243 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14245 ;; select this headline
14247 ((eq action 'sparse-tree)
14248 (and org-highlight-sparse-tree-matches
14249 (org-get-heading) (match-end 0)
14250 (org-highlight-new-match
14251 (match-beginning 1) (match-end 1)))
14252 (org-show-context 'tags-tree))
14253 ((eq action 'agenda)
14254 (setq txt (org-agenda-format-item
14257 (if (eq org-tags-match-list-sublevels 'indented)
14258 (make-string (1- level) ?.) "")
14262 priority (org-get-priority txt))
14264 (setq marker (org-agenda-new-marker))
14265 (org-add-props txt props
14266 'org-marker marker 'org-hd-marker marker 'org-category category
14268 'priority priority 'type "tagsmatch")
14270 ((functionp action)
14271 (setq org-map-continue-from nil)
14273 (setq rtn1 (funcall action))
14275 (t (user-error "Invalid action")))
14277 ;; if we are to skip sublevels, jump to end of subtree
14278 (unless org-tags-match-list-sublevels
14279 (org-end-of-subtree t)
14280 (backward-char 1))))
14281 ;; Get the correct position from where to continue
14282 (if org-map-continue-from
14283 (goto-char org-map-continue-from)
14284 (and (= (point) lspos) (end-of-line 1)))))
14285 (when (and (eq action 'sparse-tree)
14286 (not org-sparse-tree-open-archived-trees))
14287 (org-hide-archived-subtrees (point-min) (point-max)))
14290 (defun org-remove-uninherited-tags (tags)
14291 "Remove all tags that are not inherited from the list TAGS."
14293 ((eq org-use-tag-inheritance t)
14294 (if org-tags-exclude-from-inheritance
14295 (org-delete-all org-tags-exclude-from-inheritance tags)
14297 ((not org-use-tag-inheritance) nil)
14298 ((stringp org-use-tag-inheritance)
14301 (if (and (string-match org-use-tag-inheritance x)
14302 (not (member x org-tags-exclude-from-inheritance)))
14305 ((listp org-use-tag-inheritance)
14308 (if (member x org-use-tag-inheritance) x nil))
14311 (defun org-match-sparse-tree (&optional todo-only match)
14312 "Create a sparse tree according to tags string MATCH.
14313 MATCH can contain positive and negative selection of tags, like
14314 \"+WORK+URGENT-WITHBOSS\".
14315 If optional argument TODO-ONLY is non-nil, only select lines that are
14318 (org-agenda-prepare-buffers (list (current-buffer)))
14319 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14321 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14323 (defvar org-cached-props nil)
14324 (defun org-cached-entry-get (pom property)
14325 (if (or (eq t org-use-property-inheritance)
14326 (and (stringp org-use-property-inheritance)
14327 (let ((case-fold-search t))
14328 (org-string-match-p org-use-property-inheritance property)))
14329 (and (listp org-use-property-inheritance)
14330 (member-ignore-case property org-use-property-inheritance)))
14331 ;; Caching is not possible, check it directly.
14332 (org-entry-get pom property 'inherit)
14333 ;; Get all properties, so we can do complicated checks easily.
14334 (cdr (assoc-string property
14335 (or org-cached-props
14336 (setq org-cached-props (org-entry-properties pom)))
14339 (defun org-global-tags-completion-table (&optional files)
14340 "Return the list of all tags in all agenda buffer/files.
14341 Optional FILES argument is a list of files which can be used
14342 instead of the agenda files."
14349 (set-buffer (find-file-noselect file))
14350 (append (org-get-buffer-tags)
14351 (mapcar (lambda (x) (if (stringp (car-safe x))
14352 (list (car-safe x)) nil))
14354 (if (and files (car files))
14356 (org-agenda-files))))))))
14358 (defun org-make-tags-matcher (match)
14359 "Create the TAGS/TODO matcher form for the selection string MATCH.
14361 The variable `todo-only' is scoped dynamically into this function.
14362 It will be set to t if the matcher restricts matching to TODO entries,
14363 otherwise will not be touched.
14365 Returns a cons of the selection string MATCH and the constructed
14366 lisp form implementing the matcher. The matcher is to be evaluated
14367 at an Org entry, with point on the headline, and returns t if the
14368 entry matches the selection string MATCH. The returned lisp form
14369 references two variables with information about the entry, which
14370 must be bound around the form's evaluation: todo, the TODO keyword
14371 at the entry (or nil of none); and tags-list, the list of all tags
14372 at the entry including inherited ones. Additionally, the category
14373 of the entry (if any) must be specified as the text property
14374 'org-category on the headline.
14376 See also `org-scan-tags'.
14378 (declare (special todo-only))
14379 (unless (boundp 'todo-only)
14380 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14382 ;; Get a new match request, with completion against the global
14383 ;; tags table and the local tags in current buffer
14384 (let ((org-last-tags-completion-table
14386 (delq nil (append (org-get-buffer-tags)
14387 (org-global-tags-completion-table))))))
14388 (setq match (org-completing-read-no-i
14389 "Match: " 'org-tags-completion-function nil nil nil
14390 'org-tags-history))))
14392 ;; Parse the string and create a lisp form
14393 (let ((match0 match)
14394 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14396 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14397 orterms term orlist re-p str-p level-p level-op time-p
14398 prop-p pn pv po gv rest (start 0) (ss 0))
14399 ;; Expand group tags
14400 (setq match (org-tags-expand match))
14402 ;; Check if there is a TODO part of this match, which would be the
14403 ;; part after a "/". TO make sure that this slash is not part of
14404 ;; a property value to be matched against, we also check that there
14405 ;; is no " after that slash.
14406 ;; First, find the last slash
14407 (while (string-match "/+" match ss)
14408 (setq start (match-beginning 0) ss (match-end 0)))
14409 (if (and (string-match "/+" match start)
14410 (not (save-match-data (string-match "\"" match start))))
14411 ;; match contains also a todo-matching request
14413 (setq tagsmatch (substring match 0 (match-beginning 0))
14414 todomatch (substring match (match-end 0)))
14415 (if (string-match "^!" todomatch)
14416 (setq todo-only t todomatch (substring todomatch 1)))
14417 (if (string-match "^\\s-*$" todomatch)
14418 (setq todomatch nil)))
14419 ;; only matching tags
14420 (setq tagsmatch match todomatch nil))
14422 ;; Make the tags matcher
14423 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14424 (setq tagsmatcher t)
14425 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14426 (while (setq term (pop orterms))
14427 (while (and (equal (substring term -1) "\\") orterms)
14428 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14429 (while (string-match re term)
14430 (setq rest (substring term (match-end 0))
14431 minus (and (match-end 1)
14432 (equal (match-string 1 term) "-"))
14433 tag (save-match-data (replace-regexp-in-string
14435 (match-string 2 term)))
14436 re-p (equal (string-to-char tag) ?{)
14437 level-p (match-end 4)
14438 prop-p (match-end 5)
14440 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14442 (setq level-op (org-op-to-function (match-string 3 term)))
14443 `(,level-op level ,(string-to-number
14444 (match-string 4 term))))
14446 (setq pn (match-string 5 term)
14447 po (match-string 6 term)
14448 pv (match-string 7 term)
14449 re-p (equal (string-to-char pv) ?{)
14450 str-p (equal (string-to-char pv) ?\")
14451 time-p (save-match-data
14452 (string-match "^\"[[<].*[]>]\"$" pv))
14453 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14454 (if time-p (setq pv (org-matcher-time pv)))
14455 (setq po (org-op-to-function po (if time-p 'time str-p)))
14457 ((equal pn "CATEGORY")
14458 (setq gv '(get-text-property (point) 'org-category)))
14462 (setq gv `(org-cached-entry-get nil ,pn))))
14465 `(not (string-match ,pv (or ,gv "")))
14466 `(string-match ,pv (or ,gv "")))
14468 `(,po (or ,gv "") ,pv)
14469 `(,po (string-to-number (or ,gv ""))
14470 ,(string-to-number pv) ))))
14471 (t `(member ,tag tags-list)))
14472 mm (if minus (list 'not mm) mm)
14474 (push mm tagsmatcher))
14475 (push (if (> (length tagsmatcher) 1)
14476 (cons 'and tagsmatcher)
14479 (setq tagsmatcher nil))
14480 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14482 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14483 ;; Make the todo matcher
14484 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14485 (setq todomatcher t)
14486 (setq orterms (org-split-string todomatch "|") orlist nil)
14487 (while (setq term (pop orterms))
14488 (while (string-match re term)
14489 (setq minus (and (match-end 1)
14490 (equal (match-string 1 term) "-"))
14491 kwd (match-string 2 term)
14492 re-p (equal (string-to-char kwd) ?{)
14493 term (substring term (match-end 0))
14495 `(string-match ,(substring kwd 1 -1) todo)
14496 (list 'equal 'todo kwd))
14497 mm (if minus (list 'not mm) mm))
14498 (push mm todomatcher))
14499 (push (if (> (length todomatcher) 1)
14500 (cons 'and todomatcher)
14503 (setq todomatcher nil))
14504 (setq todomatcher (if (> (length orlist) 1)
14505 (cons 'or orlist) (car orlist))))
14507 ;; Return the string and lisp forms of the matcher
14508 (setq matcher (if todomatcher
14509 (list 'and tagsmatcher todomatcher)
14512 (setq matcher (list 'and '(member todo org-not-done-keywords)
14514 (cons match0 matcher)))
14516 (defun org-tags-expand (match &optional single-as-list downcased)
14517 "Expand group tags in MATCH.
14519 This replaces every group tag in MATCH with a regexp tag search.
14520 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14521 will be replaced like this:
14523 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14524 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14525 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14527 Replacing by a regexp preserves the structure of the match.
14528 E.g., this expansion
14530 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14532 will match anything tagged with \"Lab\" and \"Home\", or tagged
14533 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14535 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14536 assumed to be a single group tag, and the function will return
14537 the list of tags in this group.
14539 When DOWNCASE is non-nil, expand downcased TAGS."
14541 (let* ((case-fold-search t)
14542 (stable org-mode-syntax-table)
14543 (tal (or org-tag-groups-alist-for-agenda
14544 org-tag-groups-alist))
14546 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14547 (tml (mapcar 'car tal))
14548 (rtnmatch match) rpl)
14549 ;; @ and _ are allowed as word-components in tags
14550 (modify-syntax-entry ?@ "w" stable)
14551 (modify-syntax-entry ?_ "w" stable)
14553 (with-syntax-table stable
14555 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14556 (regexp-opt tml) "\\>\\)") rtnmatch)))
14557 (let* ((dir (match-string 1 rtnmatch))
14558 (tag (match-string 2 rtnmatch))
14559 (tag (if downcased (downcase tag) tag)))
14560 (setq tml (delete tag tml))
14561 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14562 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14563 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14564 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14565 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14567 (or (reverse rpl) (list rtnmatch))
14569 (if single-as-list (list (if downcased (downcase match) match))
14572 (defun org-op-to-function (op &optional stringp)
14573 "Turn an operator into the appropriate function."
14576 ((equal op "<" ) '(< string< org-time<))
14577 ((equal op ">" ) '(> org-string> org-time>))
14578 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14579 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14580 ((member op '("=" "==")) '(= string= org-time=))
14581 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14582 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14584 (defun org<> (a b) (not (= a b)))
14585 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14586 (defun org-string>= (a b) (not (string< a b)))
14587 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14588 (defun org-string<> (a b) (not (string= a b)))
14589 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14590 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14591 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14592 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14593 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14594 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14596 "Convert S to a floating point time.
14597 If S is already a number, just return it. If it is a string, parse
14598 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14602 (condition-case nil
14603 (float-time (apply 'encode-time (org-parse-time-string s)))
14607 (defun org-time-today ()
14608 "Time in seconds today at 0:00.
14609 Returns the float number of seconds since the beginning of the
14610 epoch to the beginning of today (00:00)."
14611 (float-time (apply 'encode-time
14612 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14614 (defun org-matcher-time (s)
14615 "Interpret a time comparison value."
14618 ((string= s "<now>") (float-time))
14619 ((string= s "<today>") (org-time-today))
14620 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14621 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14622 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14623 (+ (org-time-today)
14624 (* (string-to-number (match-string 1 s))
14625 (cdr (assoc (match-string 2 s)
14626 '(("d" . 86400.0) ("w" . 604800.0)
14627 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14630 (defun org-match-any-p (re list)
14631 "Does re match any element of list?"
14632 (setq list (mapcar (lambda (x) (string-match re x)) list))
14635 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14636 (defvar org-tags-overlay (make-overlay 1 1))
14637 (org-detach-overlay org-tags-overlay)
14639 (defun org-get-local-tags-at (&optional pos)
14640 "Get a list of tags defined in the current headline."
14641 (org-get-tags-at pos 'local))
14643 (defun org-get-local-tags ()
14644 "Get a list of tags defined in the current headline."
14645 (org-get-tags-at nil 'local))
14647 (defun org-get-tags-at (&optional pos local)
14648 "Get a list of all headline tags applicable at POS.
14649 POS defaults to point. If tags are inherited, the list contains
14650 the targets in the same sequence as the headlines appear, i.e.
14651 the tags of the current headline come last.
14652 When LOCAL is non-nil, only return tags from the current headline,
14653 ignore inherited ones."
14655 (if (and org-trust-scanner-tags
14656 (or (not pos) (equal pos (point)))
14659 (let (tags ltags lastpos parent)
14663 (goto-char (or pos (point)))
14666 (condition-case nil
14668 (org-back-to-heading t)
14669 (while (not (equal lastpos (point)))
14670 (setq lastpos (point))
14672 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14673 (setq ltags (org-split-string
14674 (org-match-string-no-properties 1) ":"))
14676 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14679 (org-remove-uninherited-tags ltags)
14682 (or org-use-tag-inheritance (throw 'done t))
14683 (if local (throw 'done t))
14684 (or (org-up-heading-safe) (error nil))
14689 (reverse (delete-dups
14691 (org-remove-uninherited-tags
14692 org-file-tags) tags)))))))))
14694 (defun org-add-prop-inherited (s)
14695 (add-text-properties 0 (length s) '(inherited t) s)
14698 (defun org-toggle-tag (tag &optional onoff)
14699 "Toggle the tag TAG for the current line.
14700 If ONOFF is `on' or `off', don't toggle but set to this state."
14703 (org-back-to-heading t)
14704 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14707 (setq current (match-string 1))
14708 (replace-match ""))
14710 (setq current (nreverse (org-split-string current ":")))
14714 (or (member tag current) (push tag current)))
14716 (or (not (member tag current)) (setq current (delete tag current))))
14717 (t (if (member tag current)
14718 (setq current (delete tag current))
14720 (push tag current))))
14724 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14725 (org-set-tags nil t))
14726 (delete-horizontal-space))
14727 (run-hooks 'org-after-tags-change-hook))
14730 (defun org-align-tags-here (to-col)
14731 ;; Assumes that this is a headline
14732 "Align tags on the current headline to TO-COL."
14733 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14734 (beginning-of-line 1)
14735 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14736 (< pos (match-beginning 2)))
14738 (setq tags-l (- (match-end 2) (match-beginning 2)))
14739 (goto-char (match-beginning 1))
14741 (delete-region (point) (1+ (match-beginning 2)))
14742 (setq ncol (max (current-column)
14746 (- (abs to-col) tags-l))))
14748 (insert (make-string (- ncol (current-column)) ?\ ))
14749 (setq ncol (current-column))
14750 (when indent-tabs-mode (tabify p (point-at-eol)))
14751 (org-move-to-column (min ncol col)))
14754 (defun org-set-tags-command (&optional arg just-align)
14755 "Call the set-tags command for the current entry."
14757 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14758 (org-set-tags arg just-align)
14760 (unless (and (org-region-active-p)
14761 org-loop-over-headlines-in-active-region)
14762 (org-back-to-heading t))
14763 (org-set-tags arg just-align))))
14765 (defun org-set-tags-to (data)
14766 "Set the tags of the current entry to DATA, replacing the current tags.
14767 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14768 If DATA is nil or the empty string, any tags will be removed."
14769 (interactive "sTags: ")
14773 ((equal data "") "")
14775 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14778 (concat ":" (mapconcat 'identity data ":") ":"))))
14781 (org-back-to-heading t)
14782 (when (looking-at org-complex-heading-regexp)
14785 (goto-char (match-beginning 5))
14787 (delete-region (point) (point-at-eol))
14788 (org-set-tags nil 'align))
14789 (goto-char (point-at-eol))
14791 (org-set-tags nil 'align)))
14792 (beginning-of-line 1)
14793 (if (looking-at ".*?\\([ \t]+\\)$")
14794 (delete-region (match-beginning 1) (match-end 1))))))
14796 (defun org-align-all-tags ()
14797 "Align the tags i all headings."
14800 (or (ignore-errors (org-back-to-heading t))
14801 (outline-next-heading))
14802 (if (org-at-heading-p)
14804 (message "No headings"))))
14806 (defvar org-indent-indentation-per-level)
14807 (defun org-set-tags (&optional arg just-align)
14808 "Set the tags for the current headline.
14809 With prefix ARG, realign all tags in headings in the current buffer.
14810 When JUST-ALIGN is non-nil, only align tags."
14812 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14813 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14814 'region-start-level 'region))
14815 org-loop-over-headlines-in-active-region)
14817 ;; We don't use ARG and JUST-ALIGN here because these args
14818 ;; are not useful when looping over headlines.
14820 org-loop-over-headlines-in-active-region
14821 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14822 (let* ((re org-outline-regexp-bol)
14823 (current (unless arg (org-get-tags-string)))
14824 (col (current-column))
14825 (org-setting-tags t)
14826 table current-tags inherited-tags ; computed below when needed
14827 tags p0 c0 c1 rpl di tc level)
14830 (goto-char (point-min))
14831 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14832 (while (re-search-forward re nil t)
14833 (org-set-tags nil t)
14835 (message "All tags realigned to column %d" org-tags-column))
14837 (setq tags current)
14838 ;; Get a new set of tags from the user
14840 (setq table (append org-tag-persistent-alist
14841 (or org-tag-alist (org-get-buffer-tags))
14843 org-complete-tags-always-offer-all-agenda-tags
14844 (org-global-tags-completion-table
14845 (org-agenda-files))))
14846 org-last-tags-completion-table table
14847 current-tags (org-split-string current ":")
14848 inherited-tags (nreverse
14849 (nthcdr (length current-tags)
14850 (nreverse (org-get-tags-at))))
14852 (if (or (eq t org-use-fast-tag-selection)
14853 (and org-use-fast-tag-selection
14854 (delq nil (mapcar 'cdr table))))
14855 (org-fast-tag-selection
14856 current-tags inherited-tags table
14857 (if org-fast-tag-selection-include-todo
14858 org-todo-key-alist))
14859 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14861 (org-icompleting-read "Tags: "
14862 'org-tags-completion-function
14863 nil nil current 'org-tags-history))))))
14864 (while (string-match "[-+&]+" tags)
14865 ;; No boolean logic, just a list
14866 (setq tags (replace-match ":" t t tags))))
14868 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14870 (if org-tags-sort-function
14871 (setq tags (mapconcat 'identity
14872 (sort (org-split-string
14873 tags (org-re "[^[:alnum:]_@#%]+"))
14874 org-tags-sort-function) ":")))
14876 (if (string-match "\\`[\t ]*\\'" tags)
14878 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14879 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14881 ;; Insert new tags at the correct column
14882 (beginning-of-line 1)
14883 (setq level (or (and (looking-at org-outline-regexp)
14884 (- (match-end 0) (point) 1))
14887 ((and (equal current "") (equal tags "")))
14888 ((re-search-forward
14889 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14891 (if (equal tags "")
14893 (goto-char (match-beginning 0))
14894 (setq c0 (current-column)
14895 ;; compute offset for the case of org-indent-mode active
14896 di (if (org-bound-and-true-p org-indent-mode)
14897 (* (1- org-indent-indentation-per-level) (1- level))
14899 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14900 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14901 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14902 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14903 (replace-match rpl t t)
14904 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14906 (t (error "Tags alignment failed")))
14907 (org-move-to-column col)
14909 (run-hooks 'org-after-tags-change-hook))))))
14911 (defun org-change-tag-in-region (beg end tag off)
14912 "Add or remove TAG for each entry in the region.
14913 This works in the agenda, and also in an org-mode buffer."
14915 (list (region-beginning) (region-end)
14916 (let ((org-last-tags-completion-table
14917 (if (derived-mode-p 'org-mode)
14919 (delq nil (append (org-get-buffer-tags)
14920 (org-global-tags-completion-table))))
14921 (org-global-tags-completion-table))))
14922 (org-icompleting-read
14923 "Tag: " 'org-tags-completion-function nil nil nil
14924 'org-tags-history))
14926 (message "[s]et or
[r]emove? ")
14927 (equal (read-char-exclusive) ?r))))
14928 (if (fboundp 'deactivate-mark) (deactivate-mark))
14929 (let ((agendap (equal major-mode 'org-agenda-mode))
14930 l1 l2 m buf pos newhead (cnt 0))
14932 (setq l2 (1- (org-current-line)))
14934 (setq l1 (org-current-line))
14935 (loop for l from l1 to l2 do
14937 (setq m (get-text-property (point) 'org-hd-marker))
14938 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14940 (setq buf (if agendap (marker-buffer m) (current-buffer))
14941 pos (if agendap m (point)))
14942 (with-current-buffer buf
14946 (setq cnt (1+ cnt))
14947 (org-toggle-tag tag (if off 'off 'on))
14948 (setq newhead (org-get-heading)))))
14949 (and agendap (org-agenda-change-all-lines newhead m))))
14950 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14952 (defun org-tags-completion-function (string predicate &optional flag)
14953 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14954 (confirm (lambda (x) (stringp (car x)))))
14955 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14956 (setq s1 (match-string 1 string)
14957 s2 (match-string 2 string))
14958 (setq s1 "" s2 string))
14962 (setq rtn (try-completion s2 ctable confirm))
14965 (concat s1 s2 (substring rtn (length s2))
14966 (if (and org-add-colon-after-tag-completion
14967 (assoc rtn ctable))
14972 (all-completions s2 ctable confirm))
14975 (assoc s2 ctable)))))
14977 (defun org-fast-tag-insert (kwd tags face &optional end)
14978 "Insert KDW, and the TAGS, the latter with face FACE.
14980 (insert (format "%-12s" (concat kwd ":"))
14981 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14984 (defun org-fast-tag-show-exit (flag)
14987 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14988 (replace-match ""))
14991 (org-move-to-column (- (window-width) 19) t)
14992 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14994 (defun org-set-current-tags-overlay (current prefix)
14995 "Add an overlay to CURRENT tag with PREFIX."
14996 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14997 (if (featurep 'xemacs)
14998 (org-overlay-display org-tags-overlay (concat prefix s)
14999 'secondary-selection)
15000 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15001 (org-overlay-display org-tags-overlay (concat prefix s)))))
15003 (defvar org-last-tag-selection-key nil)
15004 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15005 "Fast tag selection with single keys.
15006 CURRENT is the current list of tags in the headline, INHERITED is the
15007 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15008 possibly with grouping information. TODO-TABLE is a similar table with
15009 TODO keywords, should these have keys assigned to them.
15010 If the keys are nil, a-z are automatically assigned.
15011 Returns the new tags string, or nil to not change the current settings."
15012 (let* ((fulltable (append table todo-table))
15013 (maxlen (apply 'max (mapcar
15015 (if (stringp (car x)) (string-width (car x)) 0))
15017 (buf (current-buffer))
15018 (expert (eq org-fast-tag-selection-single-key 'expert))
15020 (fwidth (+ maxlen 3 1 3))
15021 (ncol (/ (- (window-width) 4) fwidth))
15024 tg cnt e c char c1 c2 ntable tbl rtn
15025 ov-start ov-end ov-prefix
15026 (exit-after-next org-fast-tag-selection-single-key)
15027 (done-keywords org-done-keywords)
15030 (beginning-of-line 1)
15032 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15033 (setq ov-start (match-beginning 1)
15034 ov-end (match-end 1)
15036 (setq ov-start (1- (point-at-eol))
15037 ov-end (1+ ov-start))
15038 (skip-chars-forward "^\n\r")
15041 (buffer-substring (1- (point)) (point))
15042 (if (> (current-column) org-tags-column)
15044 (make-string (- org-tags-column (current-column)) ?\ ))))))
15045 (move-overlay org-tags-overlay ov-start ov-end)
15046 (save-window-excursion
15048 (set-buffer (get-buffer-create " *Org tags*"))
15049 (delete-other-windows)
15050 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15051 (org-switch-to-buffer-other-window " *Org tags*"))
15053 (org-set-local 'org-done-keywords done-keywords)
15054 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15055 (org-fast-tag-insert "Current" current c-face "\n\n")
15056 (org-fast-tag-show-exit exit-after-next)
15057 (org-set-current-tags-overlay current ov-prefix)
15058 (setq tbl fulltable char ?a cnt 0)
15059 (while (setq e (pop tbl))
15061 ((equal (car e) :startgroup)
15062 (push '() groups) (setq ingroup t)
15063 (when (not (= cnt 0))
15066 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15067 ((equal (car e) :endgroup)
15068 (setq ingroup nil cnt 0)
15069 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15070 ((equal e '(:newline))
15071 (when (not (= cnt 0))
15075 (while (equal (car tbl) '(:newline))
15077 (setq tbl (cdr tbl)))))
15078 ((equal e '(:grouptags)) nil)
15080 (setq tg (copy-sequence (car e)) c2 nil)
15083 ;; automatically assign a character.
15084 (setq c1 (string-to-char
15085 (downcase (substring
15086 tg (if (= (string-to-char tg) ?@) 1 0)))))
15087 (if (or (rassoc c1 ntable) (rassoc c1 table))
15088 (while (or (rassoc char ntable) (rassoc char table))
15089 (setq char (1+ char)))
15091 (setq c (or c2 char)))
15092 (if ingroup (push tg (car groups)))
15093 (setq tg (org-add-props tg nil 'face
15095 ((not (assoc tg table))
15096 (org-get-todo-face tg))
15097 ((member tg current) c-face)
15098 ((member tg inherited) i-face))))
15099 (if (equal (caar tbl) :grouptags)
15100 (org-add-props tg nil 'face 'org-tag-group))
15101 (if (and (= cnt 0) (not ingroup)) (insert " "))
15102 (insert "[" c "] " tg (make-string
15103 (- fwidth 4 (length tg)) ?\ ))
15104 (push (cons tg c) ntable)
15105 (when (= (setq cnt (1+ cnt)) ncol)
15107 (if ingroup (insert " "))
15109 (setq ntable (nreverse ntable))
15111 (goto-char (point-min))
15112 (if (not expert) (org-fit-window-to-buffer))
15116 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15117 (if (not groups) "no " "")
15118 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15119 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15120 (setq org-last-tag-selection-key c)
15122 ((= c ?\r) (throw 'exit t))
15124 (setq groups (not groups))
15125 (goto-char (point-min))
15126 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15129 (org-fast-tag-show-exit
15130 (setq exit-after-next (not exit-after-next)))
15132 (delete-other-windows)
15133 (set-window-buffer (split-window-vertically) " *Org tags*")
15134 (org-switch-to-buffer-other-window " *Org tags*")
15135 (org-fit-window-to-buffer)))
15137 (and (= c ?q) (not (rassoc c ntable))))
15138 (org-detach-overlay org-tags-overlay)
15139 (setq quit-flag t))
15142 (if exit-after-next (setq exit-after-next 'now)))
15144 (condition-case nil
15145 (setq tg (org-icompleting-read
15148 (with-current-buffer buf
15149 (org-get-buffer-tags)))))
15150 (quit (setq tg "")))
15151 (when (string-match "\\S-" tg)
15152 (add-to-list 'buffer-tags (list tg))
15153 (if (member tg current)
15154 (setq current (delete tg current))
15155 (push tg current)))
15156 (if exit-after-next (setq exit-after-next 'now)))
15157 ((setq e (rassoc c todo-table) tg (car e))
15158 (with-current-buffer buf
15159 (save-excursion (org-todo tg)))
15160 (if exit-after-next (setq exit-after-next 'now)))
15161 ((setq e (rassoc c ntable) tg (car e))
15162 (if (member tg current)
15163 (setq current (delete tg current))
15164 (loop for g in groups do
15167 (setq current (delete x current)))
15170 (if exit-after-next (setq exit-after-next 'now))))
15172 ;; Create a sorted list
15176 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15177 (if (eq exit-after-next 'now) (throw 'exit t))
15178 (goto-char (point-min))
15179 (beginning-of-line 2)
15180 (delete-region (point) (point-at-eol))
15181 (org-fast-tag-insert "Current" current c-face)
15182 (org-set-current-tags-overlay current ov-prefix)
15183 (while (re-search-forward
15184 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15185 (setq tg (match-string 1))
15186 (add-text-properties
15187 (match-beginning 1) (match-end 1)
15190 ((member tg current) c-face)
15191 ((member tg inherited) i-face)
15192 (t (get-text-property (match-beginning 1) 'face))))))
15193 (goto-char (point-min)))))
15194 (org-detach-overlay org-tags-overlay)
15196 (mapconcat 'identity current ":")
15199 (defun org-get-tags-string ()
15200 "Get the TAGS string in the current headline."
15201 (unless (org-at-heading-p t)
15202 (user-error "Not on a heading"))
15204 (beginning-of-line 1)
15205 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15206 (org-match-string-no-properties 1)
15209 (defun org-get-tags ()
15210 "Get the list of tags specified in the current headline."
15211 (org-split-string (org-get-tags-string) ":"))
15213 (defun org-get-buffer-tags ()
15214 "Get a table of all tags used in the buffer, for completion."
15215 (org-with-wide-buffer
15216 (goto-char (point-min))
15217 (let ((tag-re (concat org-outline-regexp-bol
15218 "\\(?:.*?[ \t]\\)?"
15219 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15221 (while (re-search-forward tag-re nil t)
15222 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15224 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15226 ;;;; The mapping API
15228 (defun org-map-entries (func &optional match scope &rest skip)
15229 "Call FUNC at each headline selected by MATCH in SCOPE.
15231 FUNC is a function or a lisp form. The function will be called without
15232 arguments, with the cursor positioned at the beginning of the headline.
15233 The return values of all calls to the function will be collected and
15234 returned as a list.
15236 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15237 does not need to preserve point. After evaluation, the cursor will be
15238 moved to the end of the line (presumably of the headline of the
15239 processed entry) and search continues from there. Under some
15240 circumstances, this may not produce the wanted results. For example,
15241 if you have removed (e.g. archived) the current (sub)tree it could
15242 mean that the next entry will be skipped entirely. In such cases, you
15243 can specify the position from where search should continue by making
15244 FUNC set the variable `org-map-continue-from' to the desired buffer
15247 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15248 Only headlines that are matched by this query will be considered during
15249 the iteration. When MATCH is nil or t, all headlines will be
15250 visited by the iteration.
15252 SCOPE determines the scope of this command. It can be any of:
15254 nil The current buffer, respecting the restriction if any
15255 tree The subtree started with the entry at point
15256 region The entries within the active region, if any
15258 The entries within the active region, but only those at
15259 the same level than the first one.
15260 file The current buffer, without restriction
15262 The current buffer, and any archives associated with it
15263 agenda All agenda files
15264 agenda-with-archives
15265 All agenda files with any archive files associated with them
15267 If this is a list, all files in the list will be scanned
15269 The remaining args are treated as settings for the skipping facilities of
15270 the scanner. The following items can be given here:
15272 archive skip trees with the archive tag
15273 comment skip trees with the COMMENT keyword
15274 function or Emacs Lisp form:
15275 will be used as value for `org-agenda-skip-function', so
15276 whenever the function returns a position, FUNC will not be
15277 called for that entry and search will continue from the
15280 If your function needs to retrieve the tags including inherited tags
15281 at the *current* entry, you can use the value of the variable
15282 `org-scanner-tags' which will be much faster than getting the value
15283 with `org-get-tags-at'. If your function gets properties with
15284 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15285 to t around the call to `org-entry-properties' to get the same speedup.
15286 Note that if your function moves around to retrieve tags and properties at
15287 a *different* entry, you cannot use these techniques."
15288 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15289 (not (org-region-active-p)))
15290 (let* ((org-agenda-archives-mode nil) ; just to make sure
15291 (org-agenda-skip-archived-trees (memq 'archive skip))
15292 (org-agenda-skip-comment-trees (memq 'comment skip))
15293 (org-agenda-skip-function
15294 (car (org-delete-all '(comment archive) skip)))
15295 (org-tags-match-list-sublevels t)
15296 (start-level (eq scope 'region-start-level))
15298 org-todo-keywords-for-agenda
15299 org-done-keywords-for-agenda
15300 org-todo-keyword-alist-for-agenda
15301 org-tag-alist-for-agenda
15305 ((eq match t) (setq matcher t))
15306 ((eq match nil) (setq matcher t))
15307 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15311 (cond ((eq scope 'tree)
15312 (org-back-to-heading t)
15313 (org-narrow-to-subtree)
15315 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15316 (org-region-active-p))
15317 ;; If needed, set start-level to a string like "2"
15320 (goto-char (region-beginning))
15321 (unless (org-at-heading-p) (outline-next-heading))
15322 (setq start-level (org-current-level))))
15323 (narrow-to-region (region-beginning)
15325 (goto-char (region-end))
15326 (unless (and (bolp) (org-at-heading-p))
15327 (outline-next-heading))
15333 (org-agenda-prepare-buffers
15334 (list (buffer-file-name (current-buffer))))
15335 (setq res (org-scan-tags func matcher todo-only start-level)))
15336 ;; Get the right scope
15338 ((and scope (listp scope) (symbolp (car scope)))
15339 (setq scope (eval scope)))
15340 ((eq scope 'agenda)
15341 (setq scope (org-agenda-files t)))
15342 ((eq scope 'agenda-with-archives)
15343 (setq scope (org-agenda-files t))
15344 (setq scope (org-add-archive-files scope)))
15346 (setq scope (list (buffer-file-name))))
15347 ((eq scope 'file-with-archives)
15348 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15349 (org-agenda-prepare-buffers scope)
15350 (while (setq file (pop scope))
15351 (with-current-buffer (org-find-base-buffer-visiting file)
15355 (goto-char (point-min))
15356 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15361 (defconst org-special-properties
15362 '("ALLTAGS" "BLOCKED" "CATEGORY" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE"
15363 "FILE" "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA"
15365 "The special properties valid in Org mode.
15366 These are properties that are not defined in the property drawer,
15367 but in some other way.")
15369 (defconst org-default-properties
15370 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15371 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15372 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15373 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15374 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15375 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15376 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15377 "Some properties that are used by Org mode for various purposes.
15378 Being in this list makes sure that they are offered for completion.")
15380 (defun org--update-property-plist (key val props)
15381 "Associate KEY to VAL in alist PROPS.
15382 Modifications are made by side-effect. Return new alist."
15383 (let* ((appending (string= (substring key -1) "+"))
15384 (key (if appending (substring key 0 -1) key))
15385 (old (assoc-string key props t)))
15386 (if (not old) (cons (cons key val) props)
15387 (setcdr old (if appending (concat (cdr old) " " val) val))
15390 (defun org-get-property-block (&optional beg force)
15391 "Return the (beg . end) range of the body of the property drawer.
15392 BEG is the beginning of the current subtree, or of the part
15393 before the first headline. If it is not given, it will be found.
15394 If the drawer does not exist, create it if FORCE is non-nil, or
15396 (org-with-wide-buffer
15397 (when beg (goto-char beg))
15398 (unless (org-before-first-heading-p)
15399 (let ((beg (cond (beg)
15400 ((or (not (featurep 'org-inlinetask))
15401 (org-inlinetask-in-task-p))
15402 (org-back-to-heading t))
15403 (t (org-with-limited-levels (org-back-to-heading t))))))
15405 (when (org-looking-at-p org-planning-line-re) (forward-line))
15406 (cond ((looking-at org-property-drawer-re)
15408 (cons (point) (progn (goto-char (match-end 0))
15409 (line-beginning-position))))
15412 (org-insert-property-drawer)
15413 (let ((pos (save-excursion (search-forward ":END:")
15414 (line-beginning-position))))
15415 (cons pos pos))))))))
15417 (defun org-at-property-p ()
15418 "Non-nil when point is inside a property drawer.
15419 See `org-property-re' for match data, if applicable."
15421 (beginning-of-line)
15422 (and (looking-at org-property-re)
15423 (let ((property-drawer (save-match-data (org-get-property-block))))
15424 (and property-drawer (< (point) (cdr property-drawer)))))))
15426 (defun org-property-action ()
15427 "Do an action on properties."
15429 (unless (org-at-property-p) (user-error "Not at a property"))
15430 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15431 (let ((c (read-char-exclusive)))
15433 (?s (call-interactively #'org-set-property))
15434 (?d (call-interactively #'org-delete-property))
15435 (?D (call-interactively #'org-delete-property-globally))
15436 (?c (call-interactively #'org-compute-property-at-point))
15437 (otherwise (user-error "No such property action %c" c)))))
15439 (defun org-inc-effort ()
15440 "Increment the value of the effort property in the current entry."
15442 (org-set-effort nil t))
15444 (defvar org-clock-effort) ; Defined in org-clock.el.
15445 (defvar org-clock-current-task) ; Defined in org-clock.el.
15446 (defun org-set-effort (&optional value increment)
15447 "Set the effort property of the current entry.
15448 With numerical prefix arg, use the nth allowed value, 0 stands for the
15449 10th allowed value.
15451 When INCREMENT is non-nil, set the property to the next allowed value."
15453 (if (equal value 0) (setq value 10))
15454 (let* ((completion-ignore-case t)
15455 (prop org-effort-property)
15456 (cur (org-entry-get nil prop))
15457 (allowed (org-property-get-allowed-values nil prop 'table))
15458 (existing (mapcar 'list (org-property-values prop)))
15459 (heading (nth 4 (org-heading-components)))
15462 ((stringp value) value)
15463 ((and allowed (integerp value))
15464 (or (car (nth (1- value) allowed))
15465 (car (org-last allowed))))
15466 ((and allowed increment)
15467 (or (caadr (member (list cur) allowed))
15468 (user-error "Allowed effort values are not set")))
15470 (message "Select 1-9,0, [RET%s]: %s"
15471 (if cur (concat "=" cur) "")
15472 (mapconcat 'car allowed " "))
15473 (setq rpl (read-char-exclusive))
15474 (if (equal rpl ?\r)
15476 (setq rpl (- rpl ?0))
15477 (if (equal rpl 0) (setq rpl 10))
15478 (if (and (> rpl 0) (<= rpl (length allowed)))
15479 (car (nth (1- rpl) allowed))
15480 (org-completing-read "Effort: " allowed nil))))
15482 (let (org-completion-use-ido org-completion-use-iswitchb)
15483 (org-completing-read
15484 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15485 (concat "[" cur "]") "")
15487 existing nil nil "" nil cur))))))
15488 (unless (equal (org-entry-get nil prop) val)
15489 (org-entry-put nil prop val))
15490 (org-refresh-property
15491 '((effort . identity)
15492 (effort-minutes . org-duration-string-to-minutes))
15494 (when (string= heading org-clock-current-task)
15495 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15496 (org-clock-update-mode-line))
15497 (message "%s is now %s" prop val)))
15499 (defun org-entry-properties (&optional pom which)
15500 "Get all properties of the current entry.
15502 When POM is a buffer position, get all properties from the entry
15505 This includes the TODO keyword, the tags, time strings for
15506 deadline, scheduled, and clocking, and any additional properties
15507 defined in the entry.
15509 If WHICH is nil or `all', get all properties. If WHICH is
15510 `special' or `standard', only get that subclass. If WHICH is
15511 a string, only get that property.
15513 Return value is an alist. Keys are properties, as upcased
15515 (org-with-point-at pom
15516 (when (and (derived-mode-p 'org-mode)
15517 (ignore-errors (org-back-to-heading t)))
15519 (let* ((beg (point))
15520 (specific (and (stringp which) (upcase which)))
15521 (which (cond ((not specific) which)
15522 ((member specific org-special-properties) 'special)
15525 ;; Get the special properties, like TODO and TAGS.
15526 (when (memq which '(nil all special))
15527 (when (or (not specific) (string= specific "CLOCKSUM"))
15528 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15530 (push (cons "CLOCKSUM"
15531 (org-columns-number-to-string
15532 (/ (float clocksum) 60.) 'add_times))
15534 (when specific (throw 'exit props)))
15535 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15536 (let ((clocksumt (get-text-property (point)
15537 :org-clock-minutes-today)))
15539 (push (cons "CLOCKSUM_T"
15540 (org-columns-number-to-string
15541 (/ (float clocksumt) 60.) 'add_times))
15543 (when specific (throw 'exit props)))
15544 (when (or (not specific) (string= specific "ITEM"))
15545 (when (looking-at org-complex-heading-regexp)
15548 (org-match-string-no-properties 1)
15549 (let ((title (org-match-string-no-properties 4)))
15550 (when (org-string-nw-p title)
15551 (concat " " (org-remove-tabs title))))))
15553 (when specific (throw 'exit props)))
15554 (when (or (not specific) (string= specific "TODO"))
15555 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15556 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15557 (when specific (throw 'exit props)))
15558 (when (or (not specific) (string= specific "PRIORITY"))
15559 (when (looking-at org-priority-regexp)
15560 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15561 (when specific (throw 'exit props)))
15562 (when (or (not specific) (string= specific "FILE"))
15563 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15565 (when specific (throw 'exit props)))
15566 (when (or (not specific) (string= specific "TAGS"))
15567 (let ((value (org-string-nw-p (org-get-tags-string))))
15568 (when value (push (cons "TAGS" value) props)))
15569 (when specific (throw 'exit props)))
15570 (when (or (not specific) (string= specific "ALLTAGS"))
15571 (let ((value (org-get-tags-at)))
15573 (push (cons "ALLTAGS"
15574 (format ":%s:" (mapconcat #'identity value ":")))
15576 (when specific (throw 'exit props)))
15577 (when (or (not specific) (string= specific "BLOCKED"))
15578 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15579 (when specific (throw 'exit props)))
15580 (when (or (not specific)
15581 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15583 (when (org-looking-at-p org-planning-line-re)
15585 (let ((bol (line-beginning-position))
15586 ;; Backward compatibility: time keywords used to
15587 ;; be configurable (before 8.3). Make sure we
15588 ;; get the correct keyword.
15589 (key-assoc `(("CLOSED" . ,org-closed-string)
15590 ("DEADLINE" . ,org-deadline-string)
15591 ("SCHEDULED" . ,org-scheduled-string))))
15592 (dolist (pair (if specific (list (assoc specific key-assoc))
15595 (when (search-backward (cdr pair) bol t)
15596 (goto-char (match-end 0))
15597 (skip-chars-forward " \t")
15598 (and (looking-at org-ts-regexp-both)
15599 (push (cons (car pair)
15600 (org-match-string-no-properties 0))
15602 (when specific (throw 'exit props)))
15603 (when (or (not specific)
15604 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15607 (let ((regexp (if (or (string= specific "TIMESTAMP")
15608 (assoc "TIMESTAMP_IA" ts))
15610 org-ts-regexp-both)))
15612 (while (re-search-forward regexp end t)
15614 (let ((object (org-element-context)))
15615 ;; Accept to match timestamps in node
15616 ;; properties, too.
15617 (when (memq (org-element-type object)
15618 '(node-property timestamp))
15620 (org-element-property :type object)))
15622 ((and (memq type '(active active-range))
15623 (not (equal specific "TIMESTAMP_IA")))
15624 (unless (assoc "TIMESTAMP" ts)
15625 (push (cons "TIMESTAMP"
15626 (org-element-property
15627 :raw-value object))
15629 (when specific (throw 'exit ts))))
15630 ((and (memq type '(inactive inactive-range))
15631 (not (string= specific "TIMESTAMP")))
15632 (unless (assoc "TIMESTAMP_IA" ts)
15633 (push (cons "TIMESTAMP_IA"
15634 (org-element-property
15635 :raw-value object))
15637 (when specific (throw 'exit ts))))))
15638 ;; Both timestamp types are found,
15639 ;; move to next part.
15640 (when (= (length ts) 2) (throw 'next ts)))))
15643 ;; First look for timestamps within headline.
15644 (let ((ts (funcall find-ts (line-end-position) nil)))
15645 (if (= (length ts) 2) (setq props (nconc ts props))
15647 ;; Then find timestamps in the section, skipping
15649 (when (org-looking-at-p org-planning-line-re)
15651 (let ((end (save-excursion (outline-next-heading))))
15652 (setq props (nconc (funcall find-ts end ts) props))))))))
15653 ;; Get the standard properties, like :PROP:.
15654 (when (memq which '(nil all standard))
15655 ;; If we are looking after a specific property, delegate
15656 ;; to `org-entry-get', which is faster. However, make an
15657 ;; exception for "CATEGORY", since it can be also set
15658 ;; through keywords (i.e. #+CATEGORY).
15659 (if (and specific (not (equal specific "CATEGORY")))
15660 (let ((value (org-entry-get beg specific nil t)))
15661 (throw 'exit (and value (list (cons specific value)))))
15662 (let ((range (org-get-property-block beg)))
15664 (let ((end (cdr range)) seen-base)
15665 (goto-char (car range))
15666 ;; Unlike to `org--update-property-plist', we
15667 ;; handle the case where base values is found
15668 ;; after its extension. We also forbid standard
15669 ;; properties to be named as special properties.
15670 (while (re-search-forward org-property-re end t)
15671 (let* ((key (upcase (org-match-string-no-properties 2)))
15672 (extendp (org-string-match-p "\\+\\'" key))
15673 (key-base (if extendp (substring key 0 -1) key))
15674 (value (org-match-string-no-properties 3)))
15676 ((member-ignore-case key-base org-special-properties))
15679 (org--update-property-plist key value props)))
15680 ((member key seen-base))
15681 (t (push key seen-base)
15682 (let ((p (assoc-string key props t)))
15683 (if p (setcdr p (concat value " " (cdr p)))
15684 (push (cons key value) props))))))))))))
15685 (unless (assoc "CATEGORY" props)
15686 (push (cons "CATEGORY" (org-get-category beg)) props)
15687 (when (string= specific "CATEGORY") (throw 'exit props)))
15689 (append (get-text-property beg 'org-summaries) props))))))
15691 (defun org-entry-get (pom property &optional inherit literal-nil)
15692 "Get value of PROPERTY for entry or content at point-or-marker POM.
15694 If INHERIT is non-nil and the entry does not have the property,
15695 then also check higher levels of the hierarchy. If INHERIT is
15696 the symbol `selective', use inheritance only if the setting in
15697 `org-use-property-inheritance' selects PROPERTY for inheritance.
15699 If the property is present but empty, the return value is the
15700 empty string. If the property is not present at all, nil is
15701 returned. In any other case, return the value as a string.
15702 Search is case-insensitive.
15704 If LITERAL-NIL is set, return the string value \"nil\" as
15705 a string, do not interpret it as the list atom nil. This is used
15706 for inheritance when a \"nil\" value can supersede a non-nil
15707 value higher up the hierarchy."
15708 (org-with-point-at pom
15711 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15712 (org-entry-get-with-inheritance property literal-nil))
15713 ((member-ignore-case property org-special-properties)
15714 ;; We need a special property. Use `org-entry-properties' to
15715 ;; retrieve it, but specify the wanted property.
15716 (cdr (assoc-string property (org-entry-properties nil property))))
15718 (let ((range (org-get-property-block)))
15720 (let* ((case-fold-search t)
15724 (or (assoc-string property org-file-properties t)
15725 (assoc-string property org-global-properties t)
15727 property org-global-properties-fixed t))))
15728 ;; Make sure to not re-use GLOBAL as
15729 ;; `org--update-property-plist' would alter it by
15731 (and global (list (cons property (cdr global))))))
15734 (when (re-search-forward (org-re-property key nil t) end t)
15736 (org--update-property-plist
15737 key (org-match-string-no-properties 3) props))))))
15738 (goto-char (car range))
15739 ;; Find base value.
15740 (save-excursion (funcall find-value property))
15741 ;; Find additional values.
15742 (let ((property+ (concat property "+")))
15743 (while (funcall find-value property+)))
15744 ;; Return final value.
15745 (let ((val (cdr (assoc-string property props t))))
15746 (if literal-nil val (org-not-nil val))))))))))
15748 (defun org-property-or-variable-value (var &optional inherit)
15749 "Check if there is a property fixing the value of VAR.
15750 If yes, return this value. If not, return the current value of the variable."
15751 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15752 (if (and prop (stringp prop) (string-match "\\S-" prop))
15754 (symbol-value var))))
15756 (defun org-entry-delete (pom property)
15757 "Delete the property PROPERTY from entry at point-or-marker POM."
15758 (unless (member property org-special-properties)
15759 (org-with-point-at pom
15760 (let ((range (org-get-property-block)))
15762 (let ((begin (car range))
15763 (end (copy-marker (cdr range))))
15765 (when (re-search-forward (org-re-property property nil t) end t)
15766 (delete-region (match-beginning 0) (line-beginning-position 2))
15767 ;; If drawer is empty, remove it altogether.
15768 (when (= begin end)
15769 (delete-region (line-beginning-position 0)
15770 (line-beginning-position 2)))
15771 (set-marker end nil))))))))
15773 ;; Multi-values properties are properties that contain multiple values
15774 ;; These values are assumed to be single words, separated by whitespace.
15775 (defun org-entry-add-to-multivalued-property (pom property value)
15776 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15777 (let* ((old (org-entry-get pom property))
15778 (values (and old (org-split-string old "[ \t]"))))
15779 (setq value (org-entry-protect-space value))
15780 (unless (member value values)
15781 (setq values (append values (list value)))
15782 (org-entry-put pom property
15783 (mapconcat 'identity values " ")))))
15785 (defun org-entry-remove-from-multivalued-property (pom property value)
15786 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15787 (let* ((old (org-entry-get pom property))
15788 (values (and old (org-split-string old "[ \t]"))))
15789 (setq value (org-entry-protect-space value))
15790 (when (member value values)
15791 (setq values (delete value values))
15792 (org-entry-put pom property
15793 (mapconcat 'identity values " ")))))
15795 (defun org-entry-member-in-multivalued-property (pom property value)
15796 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15797 (let* ((old (org-entry-get pom property))
15798 (values (and old (org-split-string old "[ \t]"))))
15799 (setq value (org-entry-protect-space value))
15800 (member value values)))
15802 (defun org-entry-get-multivalued-property (pom property)
15803 "Return a list of values in a multivalued property."
15804 (let* ((value (org-entry-get pom property))
15805 (values (and value (org-split-string value "[ \t]"))))
15806 (mapcar 'org-entry-restore-space values)))
15808 (defun org-entry-put-multivalued-property (pom property &rest values)
15809 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15810 VALUES should be a list of strings. Spaces will be protected."
15811 (org-entry-put pom property
15812 (mapconcat 'org-entry-protect-space values " "))
15813 (let* ((value (org-entry-get pom property))
15814 (values (and value (org-split-string value "[ \t]"))))
15815 (mapcar 'org-entry-restore-space values)))
15817 (defun org-entry-protect-space (s)
15818 "Protect spaces and newline in string S."
15819 (while (string-match " " s)
15820 (setq s (replace-match "%20" t t s)))
15821 (while (string-match "\n" s)
15822 (setq s (replace-match "%0A" t t s)))
15825 (defun org-entry-restore-space (s)
15826 "Restore spaces and newline in string S."
15827 (while (string-match "%20" s)
15828 (setq s (replace-match " " t t s)))
15829 (while (string-match "%0A" s)
15830 (setq s (replace-match "\n" t t s)))
15833 (defvar org-entry-property-inherited-from (make-marker)
15834 "Marker pointing to the entry from where a property was inherited.
15835 Each call to `org-entry-get-with-inheritance' will set this marker to the
15836 location of the entry where the inheritance search matched. If there was
15837 no match, the marker will point nowhere.
15838 Note that also `org-entry-get' calls this function, if the INHERIT flag
15841 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15842 "Get PROPERTY of entry or content at point, search higher levels if needed.
15843 The search will stop at the first ancestor which has the property defined.
15844 If the value found is \"nil\", return nil to show that the property
15845 should be considered as undefined (this is the meaning of nil here).
15846 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15847 (move-marker org-entry-property-inherited-from nil)
15849 (org-with-wide-buffer
15852 (when (setq value (org-entry-get nil property nil literal-nil))
15853 (org-back-to-heading t)
15854 (move-marker org-entry-property-inherited-from (point))
15856 (or (org-up-heading-safe) (throw 'exit nil)))))
15859 (cdr (or (assoc-string property org-file-properties t)
15860 (assoc-string property org-global-properties t)
15861 (assoc-string property org-global-properties-fixed t)))))
15862 (if literal-nil value (org-not-nil value))))
15864 (defvar org-property-changed-functions nil
15865 "Hook called when the value of a property has changed.
15866 Each hook function should accept two arguments, the name of the property
15867 and the new value.")
15869 (defun org-entry-put (pom property value)
15870 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15872 If the value is `nil', it is converted to the empty string. If
15873 it is not a string, an error is raised.
15875 PROPERTY can be any regular property (see
15876 `org-special-properties'). It can also be \"TODO\",
15877 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
15879 For the last two properties, VALUE may have any of the special
15880 values \"earlier\" and \"later\". The function then increases or
15881 decreases scheduled or deadline date by one day."
15882 (cond ((null value) (setq value ""))
15883 ((not (stringp value)) (error "Properties values should be strings")))
15884 (org-with-point-at pom
15885 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
15886 (org-back-to-heading t)
15887 (org-with-limited-levels (org-back-to-heading t)))
15888 (let ((beg (point)))
15890 ((equal property "TODO")
15891 (cond ((not (org-string-nw-p value)) (setq value 'none))
15892 ((not (member value org-todo-keywords-1))
15893 (user-error "\"%s\" is not a valid TODO state" value)))
15895 (org-set-tags nil 'align))
15896 ((equal property "PRIORITY")
15897 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
15898 (org-set-tags nil 'align))
15899 ((equal property "SCHEDULED")
15901 (if (and (org-looking-at-p org-planning-line-re)
15903 org-scheduled-time-regexp (line-end-position) t))
15904 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15905 ((string= value "later") (org-timestamp-change 1 'day))
15906 ((string= value "") (org-schedule '(4)))
15907 (t (org-schedule nil value)))
15908 (if (member value '("earlier" "later" ""))
15909 (call-interactively #'org-schedule)
15910 (org-schedule nil value))))
15911 ((equal property "DEADLINE")
15913 (if (and (org-looking-at-p org-planning-line-re)
15915 org-deadline-time-regexp (line-end-position) t))
15916 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
15917 ((string= value "later") (org-timestamp-change 1 'day))
15918 ((string= value "") (org-deadline '(4)))
15919 (t (org-deadline nil value)))
15920 (if (member value '("earlier" "later" ""))
15921 (call-interactively #'org-deadline)
15922 (org-deadline nil value))))
15923 ((member property org-special-properties)
15924 (error "The %s property cannot be set with `org-entry-put'" property))
15926 (let* ((range (org-get-property-block beg 'force))
15928 (case-fold-search t))
15929 (goto-char (car range))
15930 (if (re-search-forward (org-re-property property nil t) end t)
15931 (progn (delete-region (match-beginning 0) (match-end 0))
15932 (goto-char (match-beginning 0)))
15936 (insert ":" property ":")
15937 (when value (insert " " value))
15938 (org-indent-line)))))
15939 (run-hook-with-args 'org-property-changed-functions property value)))
15941 (defun org-buffer-property-keys (&optional specials defaults columns)
15942 "Get all property keys in the current buffer.
15944 When SPECIALS is non-nil, also list the special properties that
15945 reflect things like tags and TODO state.
15947 When DEFAULTS is non-nil, also include properties that has
15948 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
15949 DESCRIPTION, LOCATION, and LOGGING and others.
15951 When COLUMNS in non-nil, also include property names given in
15952 COLUMN formats in the current buffer."
15953 (let ((case-fold-search t)
15955 (and specials org-special-properties)
15956 (and defaults (cons org-effort-property org-default-properties))
15958 (org-with-wide-buffer
15959 (goto-char (point-min))
15960 (while (re-search-forward org-property-start-re nil t)
15961 (let ((range (org-get-property-block)))
15964 (when (and (not (org-before-first-heading-p))
15965 (y-or-n-p (format "Malformed drawer at %d, repair?"
15966 (line-beginning-position))))
15967 (org-get-property-block nil t))
15969 (goto-char (car range))
15970 (let ((begin (car range))
15972 ;; Make sure that found property block is not located
15973 ;; before current point, as it would generate an infloop.
15974 ;; It can happen, for example, in the following
15981 ;; *************** Inlinetask
15986 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
15987 (while (< (point) end)
15988 (let ((p (progn (looking-at org-property-re)
15989 (org-match-string-no-properties 2))))
15990 ;; Only add true property name, not extension symbol.
15991 (add-to-list 'props
15992 (if (not (org-string-match-p "\\+\\'" p)) p
15993 (substring p 0 -1))))
15995 (outline-next-heading)))
15997 (goto-char (point-min))
15998 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
15999 (let ((element (org-element-at-point)))
16000 (when (memq (org-element-type element) '(keyword node-property))
16001 (let ((value (org-element-property :value element))
16003 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16004 (setq start (match-end 0))
16005 (let ((p (org-match-string-no-properties 1 value)))
16006 (unless (member-ignore-case p org-special-properties)
16007 (add-to-list 'props p))))))))))
16008 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16010 (defun org-property-values (key)
16011 "List all non-nil values of property KEY in current buffer."
16012 (org-with-wide-buffer
16013 (goto-char (point-min))
16014 (let ((case-fold-search t)
16015 (re (org-re-property key))
16017 (while (re-search-forward re nil t)
16018 (add-to-list 'values (org-entry-get (point) key)))
16021 (defun org-insert-property-drawer ()
16022 "Insert a property drawer into the current entry."
16023 (org-with-wide-buffer
16024 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16025 (org-back-to-heading t)
16026 (org-with-limited-levels (org-back-to-heading t)))
16028 (when (org-looking-at-p org-planning-line-re) (forward-line))
16029 (unless (org-looking-at-p org-property-drawer-re)
16030 (let ((inhibit-read-only t))
16031 (unless (bolp) (insert "\n"))
16032 (let ((begin (point)))
16033 (insert ":PROPERTIES:\n:END:\n")
16034 (org-indent-region begin (point)))))))
16036 (defun org-insert-drawer (&optional arg drawer)
16037 "Insert a drawer at point.
16039 When optional argument ARG is non-nil, insert a property drawer.
16041 Optional argument DRAWER, when non-nil, is a string representing
16042 drawer's name. Otherwise, the user is prompted for a name.
16044 If a region is active, insert the drawer around that region
16047 Point is left between drawer's boundaries."
16049 (let* ((drawer (if arg "PROPERTIES"
16050 (or drawer (read-from-minibuffer "Drawer: ")))))
16052 ;; With C-u, fall back on `org-insert-property-drawer'
16053 (arg (org-insert-property-drawer))
16054 ;; Check validity of suggested drawer's name.
16055 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16056 (user-error "Invalid drawer name"))
16057 ;; With an active region, insert a drawer at point.
16058 ((not (org-region-active-p))
16060 (unless (bolp) (insert "\n"))
16061 (insert (format ":%s:\n\n:END:\n" drawer))
16062 (forward-line -2)))
16063 ;; Otherwise, insert the drawer at point
16065 (let ((rbeg (region-beginning))
16066 (rend (copy-marker (region-end))))
16070 (beginning-of-line)
16071 (when (save-excursion
16072 (re-search-forward org-outline-regexp-bol rend t))
16073 (user-error "Drawers cannot contain headlines"))
16074 ;; Position point at the beginning of the first
16075 ;; non-blank line in region. Insert drawer's opening
16076 ;; there, then indent it.
16077 (org-skip-whitespace)
16078 (beginning-of-line)
16079 (insert ":" drawer ":\n")
16081 (indent-for-tab-command)
16082 ;; Move point to the beginning of the first blank line
16083 ;; after the last non-blank line in region. Insert
16084 ;; drawer's closing, then indent it.
16086 (skip-chars-backward " \r\t\n")
16088 (deactivate-mark t)
16089 (indent-for-tab-command)
16090 (unless (eolp) (insert "\n")))
16091 ;; Clear marker, whatever the outcome of insertion is.
16092 (set-marker rend nil)))))))
16094 (defvar org-property-set-functions-alist nil
16095 "Property set function alist.
16096 Each entry should have the following format:
16098 (PROPERTY . READ-FUNCTION)
16100 The read function will be called with the same argument as
16101 `org-completing-read'.")
16103 (defun org-set-property-function (property)
16104 "Get the function that should be used to set PROPERTY.
16105 This is computed according to `org-property-set-functions-alist'."
16106 (or (cdr (assoc property org-property-set-functions-alist))
16107 'org-completing-read))
16109 (defun org-read-property-value (property)
16110 "Read PROPERTY value from user."
16111 (let* ((completion-ignore-case t)
16112 (allowed (org-property-get-allowed-values nil property 'table))
16113 (cur (org-entry-get nil property))
16114 (prompt (concat property " value"
16115 (if (and cur (string-match "\\S-" cur))
16116 (concat " [" cur "]") "") ": "))
16117 (set-function (org-set-property-function property))
16119 (funcall set-function prompt allowed nil
16120 (not (get-text-property 0 'org-unrestricted
16122 (let (org-completion-use-ido org-completion-use-iswitchb)
16123 (funcall set-function prompt
16124 (mapcar 'list (org-property-values property))
16125 nil nil "" nil cur)))))
16128 (defvar org-last-set-property nil)
16129 (defvar org-last-set-property-value nil)
16130 (defun org-read-property-name ()
16131 "Read a property name."
16132 (let* ((completion-ignore-case t)
16133 (keys (org-buffer-property-keys nil t t))
16134 (default-prop (or (save-excursion
16136 (beginning-of-line)
16137 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16138 (null (string= (match-string 1) "END"))
16139 (match-string 1))))
16140 org-last-set-property))
16141 (property (org-icompleting-read
16143 (if default-prop (concat " [" default-prop "]") "")
16145 (mapcar 'list keys)
16148 (if (member property keys)
16150 (or (cdr (assoc (downcase property)
16151 (mapcar (lambda (x) (cons (downcase x) x))
16155 (defun org-set-property-and-value (use-last)
16156 "Allow to set [PROPERTY]: [value] direction from prompt.
16157 When use-default, don't even ask, just use the last
16158 \"[PROPERTY]: [value]\" string from the history."
16160 (let* ((completion-ignore-case t)
16161 (pv (or (and use-last org-last-set-property-value)
16162 (org-completing-read
16163 "Enter a \"[Property]: [value]\" pair: "
16164 nil nil nil nil nil
16165 org-last-set-property-value)))
16167 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16168 (setq prop (match-string 1 pv)
16169 val (match-string 2 pv))
16170 (org-set-property prop val))))
16172 (defun org-set-property (property value)
16173 "In the current entry, set PROPERTY to VALUE.
16174 When called interactively, this will prompt for a property name, offering
16175 completion on existing and default properties. And then it will prompt
16176 for a value, offering completion either on allowed values (via an inherited
16177 xxx_ALL property) or on existing values in other instances of this property
16178 in the current file."
16179 (interactive (list nil nil))
16180 (let* ((property (or property (org-read-property-name)))
16181 (value (or value (org-read-property-value property)))
16182 (fn (cdr (assoc property org-properties-postprocess-alist))))
16183 (setq org-last-set-property property)
16184 (setq org-last-set-property-value (concat property ": " value))
16185 ;; Possibly postprocess the inserted value:
16186 (when fn (setq value (funcall fn value)))
16187 (unless (equal (org-entry-get nil property) value)
16188 (org-entry-put nil property value))))
16190 (defun org-delete-property (property)
16191 "In the current entry, delete PROPERTY."
16193 (let* ((completion-ignore-case t)
16194 (cat (org-entry-get (point) "CATEGORY"))
16195 (props0 (org-entry-properties nil 'standard))
16196 (props (if cat props0
16197 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16198 (prop (if (< 1 (length props))
16199 (org-icompleting-read "Property: " props nil t)
16203 (message "No property to delete in this entry")
16204 (org-entry-delete nil property)
16205 (message "Property \"%s\" deleted" property)))
16207 (defun org-delete-property-globally (property)
16208 "Remove PROPERTY globally, from all entries."
16210 (let* ((completion-ignore-case t)
16211 (prop (org-icompleting-read
16212 "Globally remove property: "
16213 (mapcar 'list (org-buffer-property-keys)))))
16218 (goto-char (point-min))
16220 (while (re-search-forward
16221 (org-re-property property)
16223 (setq cnt (1+ cnt))
16224 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16225 (message "Property \"%s\" removed from %d entries" property cnt)))))
16227 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16229 (defun org-compute-property-at-point ()
16230 "Compute the property at point.
16231 This looks for an enclosing column format, extracts the operator and
16232 then applies it to the property in the column format's scope."
16234 (unless (org-at-property-p)
16235 (user-error "Not at a property"))
16236 (let ((prop (org-match-string-no-properties 2)))
16237 (org-columns-get-format-and-top-level)
16238 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16239 (user-error "No operator defined for property %s" prop))
16240 (org-columns-compute prop)))
16242 (defvar org-property-allowed-value-functions nil
16243 "Hook for functions supplying allowed values for a specific property.
16244 The functions must take a single argument, the name of the property, and
16245 return a flat list of allowed values. If \":ETC\" is one of
16246 the values, this means that these values are intended as defaults for
16247 completion, but that other values should be allowed too.
16248 The functions must return nil if they are not responsible for this
16251 (defun org-property-get-allowed-values (pom property &optional table)
16252 "Get allowed values for the property PROPERTY.
16253 When TABLE is non-nil, return an alist that can directly be used for
16257 ((equal property "TODO")
16258 (setq vals (org-with-point-at pom
16259 (append org-todo-keywords-1 '("")))))
16260 ((equal property "PRIORITY")
16261 (let ((n org-lowest-priority))
16262 (while (>= n org-highest-priority)
16263 (push (char-to-string n) vals)
16265 ((member property org-special-properties))
16266 ((setq vals (run-hook-with-args-until-success
16267 'org-property-allowed-value-functions property)))
16269 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16270 (when (and vals (string-match "\\S-" vals))
16271 (setq vals (car (read-from-string (concat "(" vals ")"))))
16272 (setq vals (mapcar (lambda (x)
16273 (cond ((stringp x) x)
16274 ((numberp x) (number-to-string x))
16275 ((symbolp x) (symbol-name x))
16278 (when (member ":ETC" vals)
16279 (setq vals (remove ":ETC" vals))
16280 (org-add-props (car vals) '(org-unrestricted t)))
16281 (if table (mapcar 'list vals) vals)))
16283 (defun org-property-previous-allowed-value (&optional previous)
16284 "Switch to the next allowed value for this property."
16286 (org-property-next-allowed-value t))
16288 (defun org-property-next-allowed-value (&optional previous)
16289 "Switch to the next allowed value for this property."
16291 (unless (org-at-property-p)
16292 (user-error "Not at a property"))
16293 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16294 (key (match-string 2))
16295 (value (match-string 3))
16296 (allowed (or (org-property-get-allowed-values (point) key)
16297 (and (member value '("[ ]" "[-]" "[X]"))
16299 (heading (save-match-data (nth 4 (org-heading-components))))
16302 (user-error "Allowed values for this property have not been defined"))
16303 (if previous (setq allowed (reverse allowed)))
16304 (if (member value allowed)
16305 (setq nval (car (cdr (member value allowed)))))
16306 (setq nval (or nval (car allowed)))
16307 (if (equal nval value)
16308 (user-error "Only one allowed value for this property"))
16309 (org-at-property-p)
16310 (replace-match (concat " :" key ": " nval) t t)
16312 (beginning-of-line 1)
16313 (skip-chars-forward " \t")
16314 (when (equal prop org-effort-property)
16315 (org-refresh-property
16316 '((effort . identity)
16317 (effort-minutes . org-duration-string-to-minutes))
16319 (when (string= org-clock-current-task heading)
16320 (setq org-clock-effort nval)
16321 (org-clock-update-mode-line)))
16322 (run-hook-with-args 'org-property-changed-functions key nval)))
16324 (defun org-find-olp (path &optional this-buffer)
16325 "Return a marker pointing to the entry at outline path OLP.
16326 If anything goes wrong, throw an error.
16327 You can wrap this call to catch the error like this:
16329 (condition-case msg
16330 (org-mobile-locate-entry (match-string 4))
16331 (error (nth 1 msg)))
16333 The return value will then be either a string with the error message,
16334 or a marker if everything is OK.
16336 If THIS-BUFFER is set, the outline path does not contain a file,
16338 (let* ((file (if this-buffer buffer-file-name (pop path)))
16339 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16343 limit re end found pos heading cnt flevel)
16344 (unless buffer (error "File not found :%s" file))
16345 (with-current-buffer buffer
16349 (setq limit (point-max))
16350 (goto-char (point-min))
16351 (while (setq heading (pop path))
16352 (setq re (format org-complex-heading-regexp-format
16353 (regexp-quote heading)))
16354 (setq cnt 0 pos (point))
16355 (while (re-search-forward re end t)
16356 (setq level (- (match-end 1) (match-beginning 1)))
16357 (if (and (>= level lmin) (<= level lmax))
16358 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16359 (when (= cnt 0) (error "Heading not found on level %d: %s"
16361 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16364 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16365 (setq end (save-excursion (org-end-of-subtree t t))))
16366 (when (org-at-heading-p)
16367 (point-marker)))))))
16369 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16370 "Find node HEADING in BUFFER.
16371 Return a marker to the heading if it was found, or nil if not.
16372 If POS-ONLY is set, return just the position instead of a marker.
16374 The heading text must match exact, but it may have a TODO keyword,
16375 a priority cookie and tags in the standard locations."
16376 (with-current-buffer (or buffer (current-buffer))
16380 (goto-char (point-min))
16381 (let (case-fold-search)
16382 (if (re-search-forward
16383 (format org-complex-heading-regexp-format
16384 (regexp-quote heading)) nil t)
16386 (match-beginning 0)
16387 (move-marker (make-marker) (match-beginning 0)))))))))
16389 (defun org-find-exact-heading-in-directory (heading &optional dir)
16390 "Find Org node headline HEADING in all .org files in directory DIR.
16391 When the target headline is found, return a marker to this location."
16392 (let ((files (directory-files (or dir default-directory)
16393 t "\\`[^.#].*\\.org\\'"))
16394 file visiting m buffer)
16396 (while (setq file (pop files))
16397 (message "trying %s" file)
16398 (setq visiting (org-find-base-buffer-visiting file))
16399 (setq buffer (or visiting (find-file-noselect file)))
16400 (setq m (org-find-exact-headline-in-buffer
16402 (when (and (not m) (not visiting)) (kill-buffer buffer))
16403 (and m (throw 'found m))))))
16405 (defun org-find-entry-with-id (ident)
16406 "Locate the entry that contains the ID property with exact value IDENT.
16407 IDENT can be a string, a symbol or a number, this function will search for
16408 the string representation of it.
16409 Return the position where this entry starts, or nil if there is no such entry."
16410 (interactive "sID: ")
16412 ((stringp ident) ident)
16413 ((symbol-name ident) (symbol-name ident))
16414 ((numberp ident) (number-to-string ident))
16415 (t (error "IDENT %s must be a string, symbol or number" ident))))
16416 (case-fold-search nil))
16420 (goto-char (point-min))
16421 (when (re-search-forward
16422 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16424 (org-back-to-heading t)
16429 (defvar org-last-changed-timestamp nil)
16430 (defvar org-last-inserted-timestamp nil
16431 "The last time stamp inserted with `org-insert-time-stamp'.")
16432 (defvar org-ts-what) ; dynamically scoped parameter
16434 (defun org-time-stamp (arg &optional inactive)
16435 "Prompt for a date/time and insert a time stamp.
16436 If the user specifies a time like HH:MM or if this command is
16437 called with at least one prefix argument, the time stamp contains
16438 the date and the time. Otherwise, only the date is be included.
16440 All parts of a date not specified by the user is filled in from
16441 the current date/time. So if you just press return without
16442 typing anything, the time stamp will represent the current
16445 If there is already a timestamp at the cursor, it will be
16448 With two universal prefix arguments, insert an active timestamp
16449 with the current time without prompting the user.
16451 When called from lisp, the timestamp is inactive if INACTIVE is
16456 ;; Default time is either today, or, when entering a range,
16457 ;; the range start.
16458 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16460 (re-search-backward
16461 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16462 (- (point) 20) t)))
16463 (apply 'encode-time (org-parse-time-string (match-string 1)))
16465 (default-input (and ts (org-get-compact-tod ts)))
16466 (repeater (save-excursion
16468 (beginning-of-line)
16469 (when (re-search-forward
16470 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16471 (save-excursion (progn (end-of-line) (point))) t)
16472 (match-string 0)))))
16473 org-time-was-given org-end-time-was-given time)
16475 ((and (org-at-timestamp-p t)
16476 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16477 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16479 (setq time (let ((this-command this-command))
16480 (org-read-date arg 'totime nil nil
16481 default-time default-input inactive)))
16482 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16483 ((org-at-timestamp-p t)
16484 (setq time (let ((this-command this-command))
16485 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16486 (when (org-at-timestamp-p t) ; just to get the match data
16487 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16489 (setq org-last-changed-timestamp
16490 (org-insert-time-stamp
16491 time (or org-time-was-given arg)
16492 inactive nil nil (list org-end-time-was-given)))
16493 (when repeater (goto-char (1- (point))) (insert " " repeater)
16494 (setq org-last-changed-timestamp
16495 (concat (substring org-last-inserted-timestamp 0 -1)
16496 " " repeater ">"))))
16497 (message "Timestamp updated"))
16499 (org-insert-time-stamp (current-time) t inactive))
16501 (setq time (let ((this-command this-command))
16502 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16503 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16504 nil nil (list org-end-time-was-given))))))
16506 ;; FIXME: can we use this for something else, like computing time differences?
16507 (defun org-get-compact-tod (s)
16508 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16509 (let* ((t1 (match-string 1 s))
16510 (h1 (string-to-number (match-string 2 s)))
16511 (m1 (string-to-number (match-string 3 s)))
16512 (t2 (and (match-end 4) (match-string 5 s)))
16513 (h2 (and t2 (string-to-number (match-string 6 s))))
16514 (m2 (and t2 (string-to-number (match-string 7 s))))
16518 (setq dh (- h2 h1) dm (- m2 m1))
16519 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16520 (concat t1 "+" (number-to-string dh)
16521 (and (/= 0 dm) (format ":%02d" dm)))))))
16523 (defun org-time-stamp-inactive (&optional arg)
16524 "Insert an inactive time stamp.
16525 An inactive time stamp is enclosed in square brackets instead of angle
16526 brackets. It is inactive in the sense that it does not trigger agenda entries,
16527 does not link to the calendar and cannot be changed with the S-cursor keys.
16528 So these are more for recording a certain time/date."
16530 (org-time-stamp arg 'inactive))
16532 (defvar org-date-ovl (make-overlay 1 1))
16533 (overlay-put org-date-ovl 'face 'org-date-selected)
16534 (org-detach-overlay org-date-ovl)
16536 (defvar org-ans1) ; dynamically scoped parameter
16537 (defvar org-ans2) ; dynamically scoped parameter
16539 (defvar org-plain-time-of-day-regexp) ; defined below
16541 (defvar org-overriding-default-time nil) ; dynamically scoped
16542 (defvar org-read-date-overlay nil)
16543 (defvar org-dcst nil) ; dynamically scoped
16544 (defvar org-read-date-history nil)
16545 (defvar org-read-date-final-answer nil)
16546 (defvar org-read-date-analyze-futurep nil)
16547 (defvar org-read-date-analyze-forced-year nil)
16548 (defvar org-read-date-inactive)
16550 (defvar org-read-date-minibuffer-local-map
16551 (let* ((map (make-sparse-keymap)))
16552 (set-keymap-parent map minibuffer-local-map)
16553 (org-defkey map (kbd ".")
16554 (lambda () (interactive)
16555 ;; Are we at the beginning of the prompt?
16556 (if (looking-back "^[^:]+: ")
16557 (org-eval-in-calendar '(calendar-goto-today))
16559 (org-defkey map (kbd "C-.")
16560 (lambda () (interactive)
16561 (org-eval-in-calendar '(calendar-goto-today))))
16562 (org-defkey map [(meta shift left)]
16563 (lambda () (interactive)
16564 (org-eval-in-calendar '(calendar-backward-month 1))))
16565 (org-defkey map [(meta shift right)]
16566 (lambda () (interactive)
16567 (org-eval-in-calendar '(calendar-forward-month 1))))
16568 (org-defkey map [(meta shift up)]
16569 (lambda () (interactive)
16570 (org-eval-in-calendar '(calendar-backward-year 1))))
16571 (org-defkey map [(meta shift down)]
16572 (lambda () (interactive)
16573 (org-eval-in-calendar '(calendar-forward-year 1))))
16574 (org-defkey map [?\e (shift left)]
16575 (lambda () (interactive)
16576 (org-eval-in-calendar '(calendar-backward-month 1))))
16577 (org-defkey map [?\e (shift right)]
16578 (lambda () (interactive)
16579 (org-eval-in-calendar '(calendar-forward-month 1))))
16580 (org-defkey map [?\e (shift up)]
16581 (lambda () (interactive)
16582 (org-eval-in-calendar '(calendar-backward-year 1))))
16583 (org-defkey map [?\e (shift down)]
16584 (lambda () (interactive)
16585 (org-eval-in-calendar '(calendar-forward-year 1))))
16586 (org-defkey map [(shift up)]
16587 (lambda () (interactive)
16588 (org-eval-in-calendar '(calendar-backward-week 1))))
16589 (org-defkey map [(shift down)]
16590 (lambda () (interactive)
16591 (org-eval-in-calendar '(calendar-forward-week 1))))
16592 (org-defkey map [(shift left)]
16593 (lambda () (interactive)
16594 (org-eval-in-calendar '(calendar-backward-day 1))))
16595 (org-defkey map [(shift right)]
16596 (lambda () (interactive)
16597 (org-eval-in-calendar '(calendar-forward-day 1))))
16598 (org-defkey map "!"
16599 (lambda () (interactive)
16600 (org-eval-in-calendar '(diary-view-entries))
16602 (org-defkey map ">"
16603 (lambda () (interactive)
16604 (org-eval-in-calendar '(calendar-scroll-left 1))))
16605 (org-defkey map "<"
16606 (lambda () (interactive)
16607 (org-eval-in-calendar '(calendar-scroll-right 1))))
16608 (org-defkey map "\C-v"
16609 (lambda () (interactive)
16610 (org-eval-in-calendar
16611 '(calendar-scroll-left-three-months 1))))
16612 (org-defkey map "\M-v"
16613 (lambda () (interactive)
16614 (org-eval-in-calendar
16615 '(calendar-scroll-right-three-months 1))))
16617 "Keymap for minibuffer commands when using `org-read-date'.")
16620 (defvar org-defdecode)
16621 (defvar org-with-time)
16623 (defun org-read-date (&optional org-with-time to-time from-string prompt
16624 default-time default-input inactive)
16625 "Read a date, possibly a time, and make things smooth for the user.
16626 The prompt will suggest to enter an ISO date, but you can also enter anything
16627 which will at least partially be understood by `parse-time-string'.
16628 Unrecognized parts of the date will default to the current day, month, year,
16629 hour and minute. If this command is called to replace a timestamp at point,
16630 or to enter the second timestamp of a range, the default time is taken
16631 from the existing stamp. Furthermore, the command prefers the future,
16632 so if you are giving a date where the year is not given, and the day-month
16633 combination is already past in the current year, it will assume you
16634 mean next year. For details, see the manual. A few examples:
16636 3-2-5 --> 2003-02-05
16637 feb 15 --> currentyear-02-15
16638 2/15 --> currentyear-02-15
16639 sep 12 9 --> 2009-09-12
16640 12:45 --> today 12:45
16641 22 sept 0:34 --> currentyear-09-22 0:34
16642 12 --> currentyear-currentmonth-12
16643 Fri --> nearest Friday after today
16644 -Tue --> last Tuesday
16647 Furthermore you can specify a relative date by giving, as the *first* thing
16648 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16649 change in days weeks, months, years.
16650 With a single plus or minus, the date is relative to today. With a double
16651 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16652 +4d --> four days from today
16653 +4 --> same as above
16654 +2w --> two weeks from today
16655 ++5 --> five days from default date
16657 The function understands only English month and weekday abbreviations.
16659 While prompting, a calendar is popped up - you can also select the
16660 date with the mouse (button 1). The calendar shows a period of three
16661 months. To scroll it to other months, use the keys `>' and `<'.
16662 If you don't like the calendar, turn it off with
16663 \(setq org-read-date-popup-calendar nil)
16665 With optional argument TO-TIME, the date will immediately be converted
16666 to an internal time.
16667 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16668 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16669 still enter a time, and this function will inform the calling routine
16670 about this change. The calling routine may then choose to change the
16671 format used to insert the time stamp into the buffer to include the time.
16672 With optional argument FROM-STRING, read from this string instead from
16673 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16674 the time/date that is used for everything that is not specified by the
16676 (require 'parse-time)
16677 (let* ((org-time-stamp-rounding-minutes
16678 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16679 (org-dcst org-display-custom-times)
16680 (ct (org-current-time))
16681 (org-def (or org-overriding-default-time default-time ct))
16682 (org-defdecode (decode-time org-def))
16684 (when (< (nth 2 org-defdecode) org-extend-today-until)
16685 (setcar (nthcdr 2 org-defdecode) -1)
16686 (setcar (nthcdr 1 org-defdecode) 59)
16687 (setq org-def (apply 'encode-time org-defdecode)
16688 org-defdecode (decode-time org-def)))))
16689 (cur-frame (selected-frame))
16690 (mouse-autoselect-window nil) ; Don't let the mouse jump
16691 (calendar-frame-setup nil)
16692 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16693 (calendar-move-hook nil)
16694 (calendar-view-diary-initially-flag nil)
16695 (calendar-view-holidays-initially-flag nil)
16696 (timestr (format-time-string
16697 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16698 (prompt (concat (if prompt (concat prompt " ") "")
16699 (format "Date+time [%s]: " timestr)))
16700 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16703 (from-string (setq ans from-string))
16704 (org-read-date-popup-calendar
16706 (save-window-excursion
16708 (when (eq calendar-setup 'calendar-only)
16710 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16711 (select-frame cal-frame))
16712 (org-eval-in-calendar '(setq cursor-type nil) t)
16715 (calendar-forward-day (- (time-to-days org-def)
16716 (calendar-absolute-from-gregorian
16717 (calendar-current-date))))
16718 (org-eval-in-calendar nil t)
16719 (let* ((old-map (current-local-map))
16720 (map (copy-keymap calendar-mode-map))
16721 (minibuffer-local-map
16722 (copy-keymap org-read-date-minibuffer-local-map)))
16723 (org-defkey map (kbd "RET") 'org-calendar-select)
16724 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16725 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16728 (use-local-map map)
16729 (setq org-read-date-inactive inactive)
16730 (add-hook 'post-command-hook 'org-read-date-display)
16731 (setq org-ans0 (read-string prompt default-input
16732 'org-read-date-history nil))
16733 ;; org-ans0: from prompt
16734 ;; org-ans1: from mouse click
16735 ;; org-ans2: from calendar motion
16736 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16737 (remove-hook 'post-command-hook 'org-read-date-display)
16738 (use-local-map old-map)
16739 (when org-read-date-overlay
16740 (delete-overlay org-read-date-overlay)
16741 (setq org-read-date-overlay nil)))))
16742 (bury-buffer "*Calendar*")
16744 (delete-frame cal-frame)
16745 (select-frame-set-input-focus cur-frame))))))
16747 (t ; Naked prompt only
16749 (setq ans (read-string prompt default-input
16750 'org-read-date-history timestr))
16751 (when org-read-date-overlay
16752 (delete-overlay org-read-date-overlay)
16753 (setq org-read-date-overlay nil)))))
16755 (setq final (org-read-date-analyze ans org-def org-defdecode))
16757 (when org-read-date-analyze-forced-year
16758 (message "Year was forced into %s"
16759 (if org-read-date-force-compatible-dates
16760 "compatible range (1970-2037)"
16761 "range representable on this machine"))
16764 ;; One round trip to get rid of 34th of August and stuff like that....
16765 (setq final (decode-time (apply 'encode-time final)))
16767 (setq org-read-date-final-answer ans)
16770 (apply 'encode-time final)
16771 (if (and (boundp 'org-time-was-given) org-time-was-given)
16772 (format "%04d-%02d-%02d %02d:%02d"
16773 (nth 5 final) (nth 4 final) (nth 3 final)
16774 (nth 2 final) (nth 1 final))
16775 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16777 (defun org-read-date-display ()
16778 "Display the current date prompt interpretation in the minibuffer."
16779 (when org-read-date-display-live
16780 (when org-read-date-overlay
16781 (delete-overlay org-read-date-overlay))
16782 (when (minibufferp (current-buffer))
16785 (while (not (equal (buffer-substring
16786 (max (point-min) (- (point) 4)) (point))
16789 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16790 " " (or org-ans1 org-ans2)))
16791 (org-end-time-was-given nil)
16792 (f (org-read-date-analyze ans org-def org-defdecode))
16794 org-time-stamp-custom-formats
16795 org-time-stamp-formats))
16796 (fmt (if (or org-with-time
16797 (and (boundp 'org-time-was-given) org-time-was-given))
16800 (txt (format-time-string fmt (apply 'encode-time f)))
16801 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16802 (txt (concat "=> " txt)))
16803 (when (and org-end-time-was-given
16804 (string-match org-plain-time-of-day-regexp txt))
16805 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16806 org-end-time-was-given
16807 (substring txt (match-end 0)))))
16808 (when org-read-date-analyze-futurep
16809 (setq txt (concat txt " (=>F)")))
16810 (setq org-read-date-overlay
16811 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16812 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16814 (defun org-read-date-analyze (ans org-def org-defdecode)
16815 "Analyze the combined answer of the date prompt."
16816 ;; FIXME: cleanup and comment
16817 (let ((nowdecode (decode-time (current-time)))
16818 delta deltan deltaw deltadef year month day
16819 hour minute second wday pm h2 m2 tl wday1
16820 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16821 (setq org-read-date-analyze-futurep nil
16822 org-read-date-analyze-forced-year nil)
16823 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16826 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16827 (setq ans (replace-match "" t t ans)
16829 deltaw (nth 1 delta)
16830 deltadef (nth 2 delta)))
16832 ;; Check if there is an iso week date in there. If yes, store the
16833 ;; info and postpone interpreting it until the rest of the parsing
16835 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16836 (setq iso-year (if (match-end 1)
16837 (org-small-year-to-year
16838 (string-to-number (match-string 1 ans))))
16839 iso-weekday (if (match-end 3)
16840 (string-to-number (match-string 3 ans)))
16841 iso-week (string-to-number (match-string 2 ans)))
16842 (setq ans (replace-match "" t t ans)))
16844 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16845 (when (string-match
16846 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16847 (setq year (if (match-end 2)
16848 (string-to-number (match-string 2 ans))
16849 (progn (setq kill-year t)
16850 (string-to-number (format-time-string "%Y"))))
16851 month (string-to-number (match-string 3 ans))
16852 day (string-to-number (match-string 4 ans)))
16853 (if (< year 100) (setq year (+ 2000 year)))
16854 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16857 ;; Help matching dotted european dates
16858 (when (string-match
16859 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16860 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16862 (string-to-number (format-time-string "%Y")))
16863 day (string-to-number (match-string 1 ans))
16864 month (string-to-number (match-string 2 ans))
16865 ans (replace-match (format "%04d-%02d-%02d" year month day)
16868 ;; Help matching american dates, like 5/30 or 5/30/7
16869 (when (string-match
16870 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16871 (setq year (if (match-end 4)
16872 (string-to-number (match-string 4 ans))
16873 (progn (setq kill-year t)
16874 (string-to-number (format-time-string "%Y"))))
16875 month (string-to-number (match-string 1 ans))
16876 day (string-to-number (match-string 2 ans)))
16877 (if (< year 100) (setq year (+ 2000 year)))
16878 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16880 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16881 ;; If there is a time with am/pm, and *no* time without it, we convert
16882 ;; so that matching will be successful.
16883 (loop for i from 1 to 2 do ; twice, for end time as well
16884 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16885 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16886 (setq hour (string-to-number (match-string 1 ans))
16887 minute (if (match-end 3)
16888 (string-to-number (match-string 3 ans))
16891 (string-to-char (downcase (match-string 4 ans)))))
16892 (if (and (= hour 12) (not pm))
16894 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16895 (setq ans (replace-match (format "%02d:%02d" hour minute)
16898 ;; Check if a time range is given as a duration
16899 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16900 (setq hour (string-to-number (match-string 1 ans))
16901 h2 (+ hour (string-to-number (match-string 3 ans)))
16902 minute (string-to-number (match-string 2 ans))
16903 m2 (+ minute (if (match-end 5) (string-to-number
16904 (match-string 5 ans))0)))
16905 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16906 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16909 ;; Check if there is a time range
16910 (when (boundp 'org-end-time-was-given)
16911 (setq org-time-was-given nil)
16912 (when (and (string-match org-plain-time-of-day-regexp ans)
16914 (setq org-end-time-was-given (match-string 8 ans))
16915 (setq ans (concat (substring ans 0 (match-beginning 7))
16916 (substring ans (match-end 7))))))
16918 (setq tl (parse-time-string ans)
16919 day (or (nth 3 tl) (nth 3 org-defdecode))
16922 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
16923 ;; Day was specified. Make sure DAY+MONTH
16924 ;; combination happens in the future.
16927 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
16928 (nth 4 nowdecode)))
16929 (t (nth 4 org-defdecode)))
16931 (cond ((and (not kill-year) (nth 5 tl)))
16932 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
16933 ;; Month was guessed in the future and is at least
16934 ;; equal to NOWDECODE's. Fix year accordingly.
16936 (if (or (> month (nth 4 nowdecode))
16937 (>= day (nth 3 nowdecode)))
16939 (1+ (nth 5 nowdecode))))
16940 ;; Month was specified. Make sure MONTH+YEAR
16941 ;; combination happens in the future.
16944 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
16945 ((< month (nth 5 nowdecode)) (1+ (nth 5 nowdecode)))
16946 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
16947 (t (nth 5 nowdecode))))
16948 (t (nth 5 org-defdecode)))
16949 hour (or (nth 2 tl) (nth 2 org-defdecode))
16950 minute (or (nth 1 tl) (nth 1 org-defdecode))
16951 second (or (nth 0 tl) 0)
16954 (when (and (eq org-read-date-prefer-future 'time)
16955 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16956 (equal day (nth 3 nowdecode))
16957 (equal month (nth 4 nowdecode))
16958 (equal year (nth 5 nowdecode))
16960 (or (< (nth 2 tl) (nth 2 nowdecode))
16961 (and (= (nth 2 tl) (nth 2 nowdecode))
16963 (< (nth 1 tl) (nth 1 nowdecode)))))
16967 ;; Special date definitions below
16970 ;; There was an iso week
16973 (setq year (or iso-year year)
16974 day (or iso-weekday wday 1)
16975 wday nil ; to make sure that the trigger below does not match
16976 iso-date (calendar-gregorian-from-absolute
16977 (calendar-iso-to-absolute
16978 (list iso-week day year))))
16979 ; FIXME: Should we also push ISO weeks into the future?
16980 ; (when (and org-read-date-prefer-future
16982 ; (< (calendar-absolute-from-gregorian iso-date)
16983 ; (time-to-days (current-time))))
16984 ; (setq year (1+ year)
16985 ; iso-date (calendar-gregorian-from-absolute
16986 ; (calendar-iso-to-absolute
16987 ; (list iso-week day year)))))
16988 (setq month (car iso-date)
16989 year (nth 2 iso-date)
16990 day (nth 1 iso-date)))
16994 (let ((now (decode-time (current-time))))
16995 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16996 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16997 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16998 ((equal deltaw "m") (setq month (+ month deltan)))
16999 ((equal deltaw "y") (setq year (+ year deltan)))))
17000 ((and wday (not (nth 3 tl)))
17001 ;; Weekday was given, but no day, so pick that day in the week
17002 ;; on or after the derived date.
17003 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17004 (unless (equal wday wday1)
17005 (setq day (+ day (% (- wday wday1 -7) 7))))))
17006 (if (and (boundp 'org-time-was-given)
17008 (setq org-time-was-given t))
17009 (if (< year 100) (setq year (+ 2000 year)))
17010 ;; Check of the date is representable
17011 (if org-read-date-force-compatible-dates
17014 (setq year 1970 org-read-date-analyze-forced-year t))
17016 (setq year 2037 org-read-date-analyze-forced-year t)))
17017 (condition-case nil
17018 (ignore (encode-time second minute hour day month year))
17020 (setq year (nth 5 org-defdecode))
17021 (setq org-read-date-analyze-forced-year t))))
17022 (setq org-read-date-analyze-futurep futurep)
17023 (list second minute hour day month year)))
17025 (defvar parse-time-weekdays)
17026 (defun org-read-date-get-relative (s today default)
17027 "Check string S for special relative date string.
17028 TODAY and DEFAULT are internal times, for today and for a default.
17029 Return shift list (N what def-flag)
17030 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17031 N is the number of WHATs to shift.
17032 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17033 the DEFAULT date rather than TODAY."
17034 (require 'parse-time)
17038 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17040 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17041 "\\([ \t]\\|$\\)") s)
17042 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17043 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17044 (string-to-char (substring (match-string 1 s) -1))
17046 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17047 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17048 (what (if (match-end 3) (match-string 3 s) "d"))
17049 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17050 (date (if rel default today))
17051 (wday (nth 6 (decode-time date)))
17055 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17056 (if (= delta 0) (setq delta 7))
17059 (setq delta (- delta 7))
17060 (if (= delta 0) (setq delta -7))))
17061 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17062 (list delta "d" rel))
17063 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17065 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17066 "Turn a user-specified date into the internal representation.
17067 The internal representation needed by the calendar is (month day year).
17068 This is a wrapper to handle the brain-dead convention in calendar that
17069 user function argument order change dependent on argument order."
17070 (if (boundp 'calendar-date-style)
17072 ((eq calendar-date-style 'american)
17073 (list arg1 arg2 arg3))
17074 ((eq calendar-date-style 'european)
17075 (list arg2 arg1 arg3))
17076 ((eq calendar-date-style 'iso)
17077 (list arg2 arg3 arg1)))
17078 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17079 (if (org-bound-and-true-p european-calendar-style)
17080 (list arg2 arg1 arg3)
17081 (list arg1 arg2 arg3)))))
17083 (defun org-eval-in-calendar (form &optional keepdate)
17084 "Eval FORM in the calendar window and return to current window.
17085 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17086 otherwise stick to the current value of `org-ans2'."
17087 (let ((sf (selected-frame))
17088 (sw (selected-window)))
17089 (select-window (get-buffer-window "*Calendar*" t))
17091 (when (and (not keepdate) (calendar-cursor-to-date))
17092 (let* ((date (calendar-cursor-to-date))
17093 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17094 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17095 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17097 (org-select-frame-set-input-focus sf)))
17099 (defun org-calendar-select ()
17100 "Return to `org-read-date' with the date currently selected.
17101 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17103 (when (calendar-cursor-to-date)
17104 (let* ((date (calendar-cursor-to-date))
17105 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17106 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17107 (if (active-minibuffer-window) (exit-minibuffer))))
17109 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17110 "Insert a date stamp for the date given by the internal TIME.
17111 See `format-time-string' for the format of TIME.
17112 WITH-HM means use the stamp format that includes the time of the day.
17113 INACTIVE means use square brackets instead of angular ones, so that the
17114 stamp will not contribute to the agenda.
17115 PRE and POST are optional strings to be inserted before and after the
17117 The command returns the inserted time stamp."
17118 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17120 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17121 (insert-before-markers (or pre ""))
17122 (when (listp extra)
17123 (setq extra (car extra))
17124 (if (and (stringp extra)
17125 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17126 (setq extra (format "-%02d:%02d"
17127 (string-to-number (match-string 1 extra))
17128 (string-to-number (match-string 2 extra))))
17131 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17132 (insert-before-markers (setq stamp (format-time-string fmt time)))
17133 (insert-before-markers (or post ""))
17134 (setq org-last-inserted-timestamp stamp)))
17136 (defun org-toggle-time-stamp-overlays ()
17137 "Toggle the use of custom time stamp formats."
17139 (setq org-display-custom-times (not org-display-custom-times))
17140 (unless org-display-custom-times
17141 (let ((p (point-min)) (bmp (buffer-modified-p)))
17142 (while (setq p (next-single-property-change p 'display))
17143 (if (and (get-text-property p 'display)
17144 (eq (get-text-property p 'face) 'org-date))
17145 (remove-text-properties
17146 p (setq p (next-single-property-change p 'display))
17148 (set-buffer-modified-p bmp)))
17149 (if (featurep 'xemacs)
17150 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17151 (org-restart-font-lock)
17152 (setq org-table-may-need-update t)
17153 (if org-display-custom-times
17154 (message "Time stamps are overlaid with custom format")
17155 (message "Time stamp overlays removed")))
17157 (defun org-display-custom-time (beg end)
17158 "Overlay modified time stamp format over timestamp between BEG and END."
17159 (let* ((ts (buffer-substring beg end))
17160 t1 w1 with-hm tf time str w2 (off 0))
17162 (setq t1 (org-parse-time-string ts t))
17163 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17164 (setq off (- (match-end 0) (match-beginning 0)))))
17165 (setq end (- end off))
17166 (setq w1 (- end beg)
17167 with-hm (and (nth 1 t1) (nth 2 t1))
17168 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17169 time (org-fix-decoded-time t1)
17171 (format-time-string
17172 (substring tf 1 -1) (apply 'encode-time time))
17173 nil 'mouse-face 'highlight)
17175 (if (not (= w2 w1))
17176 (add-text-properties (1+ beg) (+ 2 beg)
17177 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17178 (if (featurep 'xemacs)
17180 (put-text-property beg end 'invisible t)
17181 (put-text-property beg end 'end-glyph (make-glyph str)))
17182 (put-text-property beg end 'display str))))
17184 (defun org-fix-decoded-time (time)
17185 "Set 0 instead of nil for the first 6 elements of time.
17186 Don't touch the rest."
17188 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17190 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17192 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17193 "Difference between TIMESTAMP-STRING and now in days.
17194 If SECONDS is non-nil, return the difference in seconds."
17195 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17196 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17197 (funcall fdiff (current-time)))))
17199 (defun org-deadline-close (timestamp-string &optional ndays)
17200 "Is the time in TIMESTAMP-STRING close to the current date?"
17201 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17202 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17203 (not (org-entry-is-done-p))))
17205 (defun org-get-wdays (ts &optional delay zero-delay)
17206 "Get the deadline lead time appropriate for timestring TS.
17207 When DELAY is non-nil, get the delay time for scheduled items
17208 instead of the deadline lead time. When ZERO-DELAY is non-nil
17209 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17210 don't try to find the delay cookie in the scheduled timestamp."
17211 (let ((tv (if delay org-scheduled-delay-days
17212 org-deadline-warning-days)))
17214 ((or (and delay (< tv 0))
17215 (and delay zero-delay (<= tv 0))
17216 (and (not delay) (<= tv 0)))
17217 ;; Enforce this value no matter what
17219 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17220 ;; lead time is specified.
17221 (floor (* (string-to-number (match-string 1 ts))
17222 (cdr (assoc (match-string 2 ts)
17223 '(("d" . 1) ("w" . 7)
17224 ("m" . 30.4) ("y" . 365.25)
17225 ("h" . 0.041667)))))))
17226 ;; go for the default.
17229 (defun org-calendar-select-mouse (ev)
17230 "Return to `org-read-date' with the date currently selected.
17231 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17233 (mouse-set-point ev)
17234 (when (calendar-cursor-to-date)
17235 (let* ((date (calendar-cursor-to-date))
17236 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17237 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17238 (if (active-minibuffer-window) (exit-minibuffer))))
17240 (defun org-check-deadlines (ndays)
17241 "Check if there are any deadlines due or past due.
17242 A deadline is considered due if it happens within `org-deadline-warning-days'
17243 days from today's date. If the deadline appears in an entry marked DONE,
17244 it is not shown. The prefix arg NDAYS can be used to test that many
17245 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17247 (let* ((org-warn-days
17249 ((equal ndays '(4)) 100000)
17250 (ndays (prefix-numeric-value ndays))
17251 (t (abs org-deadline-warning-days))))
17252 (case-fold-search nil)
17253 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17255 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17257 (message "%d deadlines past-due or due within %d days"
17258 (org-occur regexp nil callback)
17261 (defsubst org-re-timestamp (type)
17262 "Return a regexp for timestamp TYPE.
17263 Allowed values for TYPE are:
17265 all: all timestamps
17266 active: only active timestamps (<...>)
17267 inactive: only inactive timestamps ([...])
17268 scheduled: only scheduled timestamps
17269 deadline: only deadline timestamps
17270 closed: only closed time-stamps
17272 When TYPE is nil, fall back on returning a regexp that matches
17273 both scheduled and deadline timestamps."
17275 (all org-ts-regexp-both)
17276 (active org-ts-regexp)
17277 (inactive org-ts-regexp-inactive)
17278 (scheduled org-scheduled-time-regexp)
17279 (deadline org-deadline-time-regexp)
17280 (closed org-closed-time-regexp)
17283 (regexp-opt (list org-deadline-string org-scheduled-string))
17284 " *<\\([^>]+\\)>"))))
17286 (defun org-check-before-date (date)
17287 "Check if there are deadlines or scheduled entries before DATE."
17288 (interactive (list (org-read-date)))
17289 (let ((case-fold-search nil)
17290 (regexp (org-re-timestamp org-ts-type))
17293 (and ,(if (memq org-ts-type '(active inactive all))
17294 '(eq (org-element-type (org-element-context) 'timestamp))
17295 '(org-at-planning-p))
17297 (org-time-string-to-time (match-string 1))
17298 (org-time-string-to-time date))))))
17299 (message "%d entries before %s"
17300 (org-occur regexp nil callback) date)))
17302 (defun org-check-after-date (date)
17303 "Check if there are deadlines or scheduled entries after DATE."
17304 (interactive (list (org-read-date)))
17305 (let ((case-fold-search nil)
17306 (regexp (org-re-timestamp org-ts-type))
17309 (and ,(if (memq org-ts-type '(active inactive all))
17310 '(eq (org-element-type (org-element-context) 'timestamp))
17311 '(org-at-planning-p))
17313 (org-time-string-to-time (match-string 1))
17314 (org-time-string-to-time date)))))))
17315 (message "%d entries after %s"
17316 (org-occur regexp nil callback) date)))
17318 (defun org-check-dates-range (start-date end-date)
17319 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17320 (interactive (list (org-read-date nil nil nil "Range starts")
17321 (org-read-date nil nil nil "Range end")))
17322 (let ((case-fold-search nil)
17323 (regexp (org-re-timestamp org-ts-type))
17326 (let ((match (match-string 1)))
17328 ,(if (memq org-ts-type '(active inactive all))
17329 '(eq (org-element-type (org-element-context) 'timestamp))
17330 '(org-at-planning-p))
17332 (org-time-string-to-time match)
17333 (org-time-string-to-time start-date)))
17335 (org-time-string-to-time match)
17336 (org-time-string-to-time end-date)))))))
17337 (message "%d entries between %s and %s"
17338 (org-occur regexp nil callback) start-date end-date)))
17340 (defun org-evaluate-time-range (&optional to-buffer)
17341 "Evaluate a time range by computing the difference between start and end.
17342 Normally the result is just printed in the echo area, but with prefix arg
17343 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17344 If the time range is actually in a table, the result is inserted into the
17346 For time difference computation, a year is assumed to be exactly 365
17347 days in order to avoid rounding problems."
17350 (org-clock-update-time-maybe)
17352 (unless (org-at-date-range-p t)
17353 (goto-char (point-at-bol))
17354 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17355 (if (not (org-at-date-range-p t))
17356 (user-error "Not at a time-stamp range, and none found in current line")))
17357 (let* ((ts1 (match-string 1))
17358 (ts2 (match-string 2))
17359 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17360 (match-end (match-end 0))
17361 (time1 (org-time-string-to-time ts1))
17362 (time2 (org-time-string-to-time ts2))
17363 (t1 (org-float-time time1))
17364 (t2 (org-float-time time2))
17365 (diff (abs (- t2 t1)))
17366 (negative (< (- t2 t1) 0))
17367 ;; (ys (floor (* 365 24 60 60)))
17370 (fy "%dy %dd %02d:%02d")
17372 (fd "%dd %02d:%02d")
17377 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17379 d (floor (/ diff ds)) diff (mod diff ds)
17380 h (floor (/ diff hs)) diff (mod diff hs)
17381 m (floor (/ diff 60)))
17382 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17384 d (floor (+ (/ diff ds) 0.5))
17386 (if (not to-buffer)
17387 (message "%s" (org-make-tdiff-string y d h m))
17388 (if (org-at-table-p)
17390 (goto-char match-end)
17392 (and (looking-at " *|") (goto-char (match-end 0))))
17393 (goto-char match-end))
17395 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17396 (replace-match ""))
17397 (if negative (insert " -"))
17398 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17399 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17400 (insert " " (format fh h m))))
17401 (if align (org-table-align))
17402 (message "Time difference inserted")))))
17404 (defun org-make-tdiff-string (y d h m)
17407 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17409 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17411 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17413 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17415 (apply 'format fmt (nreverse l))))
17417 (defun org-time-string-to-time (s &optional buffer pos)
17418 "Convert a timestamp string into internal time."
17419 (condition-case errdata
17420 (apply 'encode-time (org-parse-time-string s))
17421 (error (error "Bad timestamp `%s'%s\nError was: %s"
17422 s (if (not (and buffer pos))
17424 (format " at %d in buffer `%s'" pos buffer))
17427 (defun org-time-string-to-seconds (s)
17428 "Convert a timestamp string to a number of seconds."
17429 (org-float-time (org-time-string-to-time s)))
17431 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17432 "Convert a time stamp to an absolute day number.
17433 If there is a specifier for a cyclic time stamp, get the closest
17435 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17436 The variable `date' is bound by the calendar when this is called."
17438 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17439 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17442 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17443 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17444 (time-to-days (current-time))) (match-string 0 s)
17447 (condition-case errdata
17448 (apply 'encode-time (org-parse-time-string s))
17449 (error (error "Bad timestamp `%s'%s\nError was: %s"
17450 s (if (not (and buffer pos))
17452 (format " at %d in buffer `%s'" pos buffer))
17453 (cdr errdata))))))))
17455 (defun org-days-to-iso-week (days)
17456 "Return the iso week number."
17458 (car (calendar-iso-from-absolute days)))
17460 (defun org-small-year-to-year (year)
17461 "Convert 2-digit years into 4-digit years.
17462 YEAR is expanded into one of the 30 next years, if possible, or
17463 into a past one. Any year larger than 99 is returned unchanged."
17464 (if (>= year 100) year
17465 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17466 (century (/ current 100))
17467 (offset (- year (% current 100))))
17468 (cond ((> offset 30) (+ (* (1- century) 100) year))
17469 ((> offset -70) (+ (* century 100) year))
17470 (t (+ (* (1+ century) 100) year))))))
17472 (defun org-time-from-absolute (d)
17473 "Return the time corresponding to date D.
17474 D may be an absolute day number, or a calendar-type list (month day year)."
17475 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17476 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17478 (defun org-calendar-holiday ()
17479 "List of holidays, for Diary display in Org-mode."
17480 (require 'holidays)
17482 (if (fboundp 'calendar-check-holidays)
17483 'calendar-check-holidays 'check-calendar-holidays) date)))
17484 (if hl (mapconcat 'identity hl "; "))))
17486 (defun org-diary-sexp-entry (sexp entry date)
17487 "Process a SEXP diary ENTRY for DATE."
17488 (require 'diary-lib)
17489 (let ((result (if calendar-debug-sexp
17490 (let ((stack-trace-on-error t))
17491 (eval (car (read-from-string sexp))))
17492 (condition-case nil
17493 (eval (car (read-from-string sexp)))
17496 (message "Bad sexp at line %d in %s: %s"
17498 (buffer-file-name) sexp)
17500 (cond ((stringp result) (split-string result "; "))
17501 ((and (consp result)
17502 (not (consp (cdr result)))
17503 (stringp (cdr result))) (cdr result))
17504 ((and (consp result)
17505 (stringp (car result))) result)
17508 (defun org-diary-to-ical-string (frombuf)
17509 "Get iCalendar entries from diary entries in buffer FROMBUF.
17510 This uses the icalendar.el library."
17511 (let* ((tmpdir (if (featurep 'xemacs)
17513 temporary-file-directory))
17514 (tmpfile (make-temp-name
17515 (expand-file-name "orgics" tmpdir)))
17517 (with-current-buffer frombuf
17518 (icalendar-export-region (point-min) (point-max) tmpfile)
17519 (setq buf (find-buffer-visiting tmpfile))
17521 (goto-char (point-min))
17522 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17523 (setq b (match-beginning 0)))
17524 (goto-char (point-max))
17525 (if (re-search-backward "^END:VEVENT" nil t)
17526 (setq e (match-end 0)))
17527 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17529 (delete-file tmpfile)
17532 (defun org-closest-date (start current change prefer show-all)
17533 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17534 When PREFER is `past', return a date that is either CURRENT or past.
17535 When PREFER is `future', return a date that is either CURRENT or future.
17536 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17537 ;; Make the proper lists from the dates
17539 (let ((a1 '(("h" . hour)
17544 (shour (nth 2 (org-parse-time-string start)))
17545 dn dw sday cday n1 n2 n0
17546 d m y y1 y2 date1 date2 nmonths nm ny m2)
17548 (setq start (org-date-to-gregorian start)
17549 current (org-date-to-gregorian
17552 (time-to-days (current-time))))
17553 sday (calendar-absolute-from-gregorian start)
17554 cday (calendar-absolute-from-gregorian current))
17556 (if (<= cday sday) (throw 'exit sday))
17558 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17559 (setq dn (string-to-number (match-string 1 change))
17560 dw (cdr (assoc (match-string 2 change) a1)))
17561 (user-error "Invalid change specifier: %s" change))
17562 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17565 (let ((missing-hours
17566 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17568 (setq n1 (if (zerop missing-hours) cday
17569 (- cday (1+ (floor (/ missing-hours 24)))))
17570 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17572 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17575 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17576 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17577 (setq date1 (list m d y1)
17578 n1 (calendar-absolute-from-gregorian date1)
17579 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17580 n2 (calendar-absolute-from-gregorian date2)))
17582 ;; approx number of month between the two dates
17583 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17584 ;; How often does dn fit in there?
17585 (setq d (nth 1 start) m (car start) y (nth 2 start)
17586 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17588 ny (floor (/ m 12))
17591 (while (> m 12) (setq m (- m 12) y (1+ y)))
17592 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17593 (setq m2 (+ m dn) y2 y)
17594 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17595 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17596 (while (<= n2 cday)
17597 (setq n1 n2 m m2 y y2)
17598 (setq m2 (+ m dn) y2 y)
17599 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17600 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17601 ;; Make sure n1 is the earlier date
17602 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17605 ((eq prefer 'past) (if (= cday n2) n2 n1))
17606 ((eq prefer 'future) (if (= cday n1) n1 n2))
17607 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17609 ((eq prefer 'past) (if (= cday n2) n2 n1))
17610 ((eq prefer 'future) (if (= cday n1) n1 n2))
17611 (t (if (= cday n1) n1 n2)))))))
17613 (defun org-date-to-gregorian (date)
17614 "Turn any specification of DATE into a Gregorian date for the calendar."
17615 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17616 ((and (listp date) (= (length date) 3)) date)
17618 (setq date (org-parse-time-string date))
17619 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17621 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17623 (defun org-parse-time-string (s &optional nodefault)
17624 "Parse the standard Org-mode time string.
17625 This should be a lot faster than the normal `parse-time-string'.
17626 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17627 hour and minute fields will be nil if not given."
17628 (cond ((string-match org-ts-regexp0 s)
17630 (if (or (match-beginning 8) (not nodefault))
17631 (string-to-number (or (match-string 8 s) "0")))
17632 (if (or (match-beginning 7) (not nodefault))
17633 (string-to-number (or (match-string 7 s) "0")))
17634 (string-to-number (match-string 4 s))
17635 (string-to-number (match-string 3 s))
17636 (string-to-number (match-string 2 s))
17638 ((string-match "^<[^>]+>$" s)
17639 (decode-time (seconds-to-time (org-matcher-time s))))
17640 (t (error "Not a standard Org-mode time string: %s" s))))
17642 (defun org-timestamp-up (&optional arg)
17643 "Increase the date item at the cursor by one.
17644 If the cursor is on the year, change the year. If it is on the month,
17645 the day or the time, change that.
17646 With prefix ARG, change by that many units."
17648 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17650 (defun org-timestamp-down (&optional arg)
17651 "Decrease the date item at the cursor by one.
17652 If the cursor is on the year, change the year. If it is on the month,
17653 the day or the time, change that.
17654 With prefix ARG, change by that many units."
17656 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17658 (defun org-timestamp-up-day (&optional arg)
17659 "Increase the date in the time stamp by one day.
17660 With prefix ARG, change that many days."
17662 (if (and (not (org-at-timestamp-p t))
17663 (org-at-heading-p))
17665 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17667 (defun org-timestamp-down-day (&optional arg)
17668 "Decrease the date in the time stamp by one day.
17669 With prefix ARG, change that many days."
17671 (if (and (not (org-at-timestamp-p t))
17672 (org-at-heading-p))
17674 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17676 (defun org-at-timestamp-p (&optional inactive-ok)
17677 "Determine if the cursor is in or at a timestamp."
17679 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17681 (ans (or (looking-at tsr)
17683 (skip-chars-backward "^[<\n\r\t")
17684 (if (> (point) (point-min)) (backward-char 1))
17685 (and (looking-at tsr)
17686 (> (- (match-end 0) pos) -1))))))
17688 (boundp 'org-ts-what)
17691 ((= pos (match-beginning 0)) 'bracket)
17692 ;; Point is considered to be "on the bracket" whether
17693 ;; it's really on it or right after it.
17694 ((= pos (1- (match-end 0))) 'bracket)
17695 ((= pos (match-end 0)) 'after)
17696 ((org-pos-in-match-range pos 2) 'year)
17697 ((org-pos-in-match-range pos 3) 'month)
17698 ((org-pos-in-match-range pos 7) 'hour)
17699 ((org-pos-in-match-range pos 8) 'minute)
17700 ((or (org-pos-in-match-range pos 4)
17701 (org-pos-in-match-range pos 5)) 'day)
17702 ((and (> pos (or (match-end 8) (match-end 5)))
17703 (< pos (match-end 0)))
17704 (- pos (or (match-end 8) (match-end 5))))
17708 (defun org-toggle-timestamp-type ()
17709 "Toggle the type (<active> or [inactive]) of a time stamp."
17711 (when (org-at-timestamp-p t)
17712 (let ((beg (match-beginning 0)) (end (match-end 0))
17713 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17716 (while (re-search-forward "[][<>]" end t)
17717 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17719 (message "Timestamp is now %sactive"
17720 (if (equal (char-after beg) ?<) "" "in")))))
17722 (defun org-at-clock-log-p nil
17723 "Is the cursor on the clock log line?"
17725 (move-beginning-of-line 1)
17726 (looking-at org-clock-line-re)))
17728 (defvar org-clock-history) ; defined in org-clock.el
17729 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17730 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17731 "Change the date in the time stamp at point.
17732 The date will be changed by N times WHAT. WHAT can be `day', `month',
17733 `year', `minute', `second'. If WHAT is not given, the cursor position
17734 in the timestamp determines what will be changed.
17735 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17736 (let ((origin (point)) origin-cat
17738 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17741 ts time time0 fixnext clrgx)
17742 (if (not (org-at-timestamp-p t))
17743 (user-error "Not at a timestamp"))
17744 (if (and (not what) (eq org-ts-what 'bracket))
17745 (org-toggle-timestamp-type)
17746 ;; Point isn't on brackets. Remember the part of the time-stamp
17747 ;; the point was in. Indeed, size of time-stamps may change,
17748 ;; but point must be kept in the same category nonetheless.
17749 (setq origin-cat org-ts-what)
17750 (if (and (not what) (not (eq org-ts-what 'day))
17751 org-display-custom-times
17752 (get-text-property (point) 'display)
17753 (not (get-text-property (1- (point)) 'display)))
17754 (setq org-ts-what 'day))
17755 (setq org-ts-what (or what org-ts-what)
17756 inactive (= (char-after (match-beginning 0)) ?\[)
17757 ts (match-string 0))
17759 (when (string-match
17760 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17762 (setq extra (match-string 1 ts))
17763 (if suppress-tmp-delay
17764 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17765 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17767 (setq time0 (org-parse-time-string ts))
17769 (eq org-ts-what 'minute)
17770 (not current-prefix-arg))
17771 ;; This looks like s-up and s-down. Change by one rounding step.
17772 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17773 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17774 (setcar (cdr time0) (+ (nth 1 time0)
17775 (if (> n 0) (- rem) (- dm rem))))))
17777 (encode-time (or (car time0) 0)
17778 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17779 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17780 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17781 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17782 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17784 (when (and (member org-ts-what '(hour minute))
17786 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17787 (setq extra (org-modify-ts-extra
17789 (if (eq org-ts-what 'hour) 2 5)
17791 (when (integerp org-ts-what)
17792 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17793 (if (eq what 'calendar)
17794 (let ((cal-date (org-get-date-from-calendar)))
17795 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17796 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17797 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17798 (setcar time0 (or (car time0) 0))
17799 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17800 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17801 (setq time (apply 'encode-time time0))))
17802 ;; Insert the new time-stamp, and ensure point stays in the same
17803 ;; category as before (i.e. not after the last position in that
17805 (let ((pos (point)))
17806 ;; Stay before inserted string. `save-excursion' is of no use.
17807 (setq org-last-changed-timestamp
17808 (org-insert-time-stamp time with-hm inactive nil nil extra))
17811 (looking-at org-ts-regexp3)
17813 ;; `day' category ends before `hour' if any, or at
17814 ;; the end of the day name.
17815 ((eq origin-cat 'day)
17816 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17817 ((eq origin-cat 'hour) (min (match-end 7) origin))
17818 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17819 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17820 ;; `year' and `month' have both fixed size: point
17821 ;; couldn't have moved into another part.
17823 ;; Update clock if on a CLOCK line.
17824 (org-clock-update-time-maybe)
17825 ;; Maybe adjust the closest clock in `org-clock-history'
17826 (when org-clock-adjust-closest
17827 (if (not (and (org-at-clock-log-p)
17828 (< 1 (length (delq nil (mapcar 'marker-position
17829 org-clock-history))))))
17830 (message "No clock to adjust")
17831 (cond ((save-excursion ; fix previous clock?
17832 (re-search-backward org-ts-regexp0 nil t)
17833 (org-looking-back (concat org-clock-string " \\[")))
17834 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17835 ((save-excursion ; fix next clock?
17836 (re-search-backward org-ts-regexp0 nil t)
17837 (looking-at (concat org-ts-regexp0 "\\] =>")))
17838 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17839 (save-window-excursion
17840 ;; Find closest clock to point, adjust the previous/next one in history
17841 (let* ((p (save-excursion (org-back-to-heading t)))
17842 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17844 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17845 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17847 (message "No clock to adjust")
17849 (org-goto-marker-or-bmk clfixpos)
17851 (when (re-search-forward clrgx nil t)
17852 (goto-char (match-beginning 1))
17853 (let (org-clock-adjust-closest)
17854 (org-timestamp-change n org-ts-what updown))
17855 (message "Clock adjusted in %s for heading: %s"
17856 (file-name-nondirectory (buffer-file-name))
17857 (org-get-heading t t)))))))))
17858 ;; Try to recenter the calendar window, if any.
17859 (if (and org-calendar-follow-timestamp-change
17860 (get-buffer-window "*Calendar*" t)
17861 (memq org-ts-what '(day month year)))
17862 (org-recenter-calendar (time-to-days time))))))
17864 (defun org-modify-ts-extra (s pos n dm)
17865 "Change the different parts of the lead-time and repeat fields in timestamp."
17866 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17868 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17870 ((or (org-pos-in-match-range pos 2)
17871 (org-pos-in-match-range pos 3))
17872 (setq m (string-to-number (match-string 3 s))
17873 h (string-to-number (match-string 2 s)))
17874 (if (org-pos-in-match-range pos 2)
17876 (setq n (* dm (org-no-warnings (signum n))))
17877 (when (not (= 0 (setq rem (% m dm))))
17878 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17880 (if (< m 0) (setq m (+ m 60) h (1- h)))
17881 (if (> m 59) (setq m (- m 60) h (1+ h)))
17882 (setq h (min 24 (max 0 h)))
17883 (setq ng 1 new (format "-%02d:%02d" h m)))
17884 ((org-pos-in-match-range pos 6)
17885 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17886 ((org-pos-in-match-range pos 5)
17887 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17889 ((org-pos-in-match-range pos 9)
17890 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17891 ((org-pos-in-match-range pos 8)
17892 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17896 (substring s 0 (match-beginning ng))
17898 (substring s (match-end ng))))))
17901 (defun org-recenter-calendar (date)
17902 "If the calendar is visible, recenter it to DATE."
17903 (let ((cwin (get-buffer-window "*Calendar*" t)))
17905 (let ((calendar-move-hook nil))
17906 (with-selected-window cwin
17907 (calendar-goto-date (if (listp date) date
17908 (calendar-gregorian-from-absolute date))))))))
17910 (defun org-goto-calendar (&optional arg)
17911 "Go to the Emacs calendar at the current date.
17912 If there is a time stamp in the current line, go to that date.
17913 A prefix ARG can be used to force the current date."
17915 (let ((tsr org-ts-regexp) diff
17916 (calendar-move-hook nil)
17917 (calendar-view-holidays-initially-flag nil)
17918 (calendar-view-diary-initially-flag nil))
17919 (if (or (org-at-timestamp-p)
17921 (beginning-of-line 1)
17922 (looking-at (concat ".*" tsr))))
17923 (let ((d1 (time-to-days (current-time)))
17925 (org-time-string-to-time (match-string 1)))))
17926 (setq diff (- d2 d1))))
17928 (calendar-goto-today)
17929 (if (and diff (not arg)) (calendar-forward-day diff))))
17931 (defun org-get-date-from-calendar ()
17932 "Return a list (month day year) of date at point in calendar."
17933 (with-current-buffer "*Calendar*"
17935 (calendar-cursor-to-date))))
17937 (defun org-date-from-calendar ()
17938 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17939 If there is already a time stamp at the cursor position, update it."
17941 (if (org-at-timestamp-p t)
17942 (org-timestamp-change 0 'calendar)
17943 (let ((cal-date (org-get-date-from-calendar)))
17944 (org-insert-time-stamp
17945 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17947 (defcustom org-effort-durations
17951 ("w" . ,(* 60 8 5))
17952 ("m" . ,(* 60 8 5 4))
17953 ("y" . ,(* 60 8 5 40)))
17954 "Conversion factor to minutes for an effort modifier.
17956 Each entry has the form (MODIFIER . MINUTES).
17958 In an effort string, a number followed by MODIFIER is multiplied
17959 by the specified number of MINUTES to obtain an effort in
17962 For example, if the value of this variable is ((\"hours\" . 60)), then an
17963 effort string \"2hours\" is equivalent to 120 minutes."
17966 :package-version '(Org . "8.3")
17967 :type '(alist :key-type (string :tag "Modifier")
17968 :value-type (number :tag "Minutes")))
17970 (defun org-minutes-to-clocksum-string (m)
17971 "Format number of minutes as a clocksum string.
17972 The format is determined by `org-time-clocksum-format',
17973 `org-time-clocksum-use-fractional' and
17974 `org-time-clocksum-fractional-format' and
17975 `org-time-clocksum-use-effort-durations'."
17976 (let ((clocksum "")
17977 (m (round m)) ; Don't allow fractions of minutes
17979 (setq h (if org-time-clocksum-use-effort-durations
17980 (cdr (assoc "h" org-effort-durations)) 60)
17981 d (if org-time-clocksum-use-effort-durations
17982 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17983 w (if org-time-clocksum-use-effort-durations
17984 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17985 mo (if org-time-clocksum-use-effort-durations
17986 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17987 y (if org-time-clocksum-use-effort-durations
17988 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17989 ;; fractional format
17990 (if org-time-clocksum-use-fractional
17992 ;; single format string
17993 ((stringp org-time-clocksum-fractional-format)
17994 (format org-time-clocksum-fractional-format (/ m (float h))))
17995 ;; choice of fractional formats for different time units
17996 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17997 (> (/ (truncate m) (* y d h)) 0))
17998 (format fmt (/ m (* y d (float h)))))
17999 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18000 (> (/ (truncate m) (* mo d h)) 0))
18001 (format fmt (/ m (* mo d (float h)))))
18002 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18003 (> (/ (truncate m) (* w d h)) 0))
18004 (format fmt (/ m (* w d (float h)))))
18005 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18006 (> (/ (truncate m) (* d h)) 0))
18007 (format fmt (/ m (* d (float h)))))
18008 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18009 (> (/ (truncate m) h) 0))
18010 (format fmt (/ m (float h))))
18011 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18013 ;; fall back to smallest time unit with a format
18014 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18015 (format fmt (/ m (float h))))
18016 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18017 (format fmt (/ m (* d (float h)))))
18018 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18019 (format fmt (/ m (* w d (float h)))))
18020 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18021 (format fmt (/ m (* mo d (float h)))))
18022 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18023 (format fmt (/ m (* y d (float h))))))
18024 ;; standard (non-fractional) format, with single format string
18025 (if (stringp org-time-clocksum-format)
18026 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18027 ;; separate formats components
18028 (and (setq fmt (plist-get org-time-clocksum-format :years))
18029 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18030 (plist-get org-time-clocksum-format :require-years))
18031 (setq clocksum (concat clocksum (format fmt n))
18032 m (- m (* n y d h))))
18033 (and (setq fmt (plist-get org-time-clocksum-format :months))
18034 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18035 (plist-get org-time-clocksum-format :require-months))
18036 (setq clocksum (concat clocksum (format fmt n))
18037 m (- m (* n mo d h))))
18038 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18039 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18040 (plist-get org-time-clocksum-format :require-weeks))
18041 (setq clocksum (concat clocksum (format fmt n))
18042 m (- m (* n w d h))))
18043 (and (setq fmt (plist-get org-time-clocksum-format :days))
18044 (or (> (setq n (/ (truncate m) (* d h))) 0)
18045 (plist-get org-time-clocksum-format :require-days))
18046 (setq clocksum (concat clocksum (format fmt n))
18047 m (- m (* n d h))))
18048 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18049 (or (> (setq n (/ (truncate m) h)) 0)
18050 (plist-get org-time-clocksum-format :require-hours))
18051 (setq clocksum (concat clocksum (format fmt n))
18053 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18054 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18055 (setq clocksum (concat clocksum (format fmt m))))
18056 ;; return formatted time duration
18059 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18060 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18061 "Org mode version 8.0")
18063 (defun org-hours-to-clocksum-string (n)
18064 (org-minutes-to-clocksum-string (* n 60)))
18066 (defun org-hh:mm-string-to-minutes (s)
18067 "Convert a string H:MM to a number of minutes.
18068 If the string is just a number, interpret it as minutes.
18069 In fact, the first hh:mm or number in the string will be taken,
18070 there can be extra stuff in the string.
18071 If no number is found, the return value is 0."
18074 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18075 (+ (* (string-to-number (match-string 1 s)) 60)
18076 (string-to-number (match-string 2 s))))
18077 ((string-match "\\([0-9]+\\)" s)
18078 (string-to-number (match-string 1 s)))
18081 (defcustom org-image-actual-width t
18082 "Should we use the actual width of images when inlining them?
18084 When set to `t', always use the image width.
18086 When set to a number, use imagemagick (when available) to set
18087 the image's width to this value.
18089 When set to a number in a list, try to get the width from any
18090 #+ATTR.* keyword if it matches a width specification like
18092 #+ATTR_HTML: :width 300px
18094 and fall back on that number if none is found.
18096 When set to nil, try to get the width from an #+ATTR.* keyword
18097 and fall back on the original width if none is found.
18099 This requires Emacs >= 24.1, build with imagemagick support."
18100 :group 'org-appearance
18102 :package-version '(Org . "8.0")
18104 (const :tag "Use the image width" t)
18105 (integer :tag "Use a number of pixels")
18106 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18107 (const :tag "Use #+ATTR* or don't resize" nil)))
18109 (defcustom org-agenda-inhibit-startup nil
18110 "Inhibit startup when preparing agenda buffers.
18111 When this variable is `t', the initialization of the Org agenda
18112 buffers is inhibited: e.g. the visibility state is not set, the
18113 tables are not re-aligned, etc."
18116 :group 'org-agenda)
18118 (define-obsolete-variable-alias
18119 'org-agenda-ignore-drawer-properties
18120 'org-agenda-ignore-properties "25.1")
18122 (defcustom org-agenda-ignore-properties nil
18123 "Avoid updating text properties when building the agenda.
18124 Properties are used to prepare buffers for effort estimates,
18125 appointments, statistics and subtree-local categories.
18126 If you don't use these in the agenda, you can add them to this
18127 list and agenda building will be a bit faster.
18128 The value is a list, with zero or more of the symbols `effort', `appt',
18129 `stats' or `category'."
18130 :type '(set :greedy t
18136 :package-version '(Org . "8.3")
18137 :group 'org-agenda)
18139 (defun org-duration-string-to-minutes (s &optional output-to-string)
18140 "Convert a duration string S to minutes.
18142 A bare number is interpreted as minutes, modifiers can be set by
18143 customizing `org-effort-durations' (which see).
18145 Entries containing a colon are interpreted as H:MM by
18146 `org-hh:mm-string-to-minutes'."
18148 (re (concat "\\([0-9.]+\\) *\\("
18149 (regexp-opt (mapcar 'car org-effort-durations))
18151 (while (string-match re s)
18152 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18153 (string-to-number (match-string 1 s))))
18154 (setq s (replace-match "" nil t s)))
18155 (setq result (floor result))
18156 (incf result (org-hh:mm-string-to-minutes s))
18157 (if output-to-string (number-to-string result) result)))
18161 (defun org-save-all-org-buffers ()
18162 "Save all Org-mode buffers without user confirmation."
18164 (message "Saving all Org-mode buffers...")
18165 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18166 (when (featurep 'org-id) (org-id-locations-save))
18167 (message "Saving all Org-mode buffers... done"))
18169 (defun org-revert-all-org-buffers ()
18170 "Revert all Org-mode buffers.
18171 Prompt for confirmation when there are unsaved changes.
18172 Be sure you know what you are doing before letting this function
18173 overwrite your changes.
18175 This function is useful in a setup where one tracks org files
18176 with a version control system, to revert on one machine after pulling
18177 changes from another. I believe the procedure must be like this:
18179 1. M-x org-save-all-org-buffers
18180 2. Pull changes from the other machine, resolve conflicts
18181 3. M-x org-revert-all-org-buffers"
18183 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18184 (user-error "Abort"))
18186 (save-window-excursion
18189 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18190 (with-current-buffer b buffer-file-name))
18191 (org-pop-to-buffer-same-window b)
18192 (revert-buffer t 'no-confirm)))
18194 (when (and (featurep 'org-id) org-id-track-globally)
18195 (org-id-locations-load)))))
18200 (defun org-switchb (&optional arg)
18201 "Switch between Org buffers.
18202 With one prefix argument, restrict available buffers to files.
18203 With two prefix arguments, restrict available buffers to agenda files.
18205 Defaults to `iswitchb' for buffer name completion.
18206 Set `org-completion-use-ido' to make it use ido instead."
18208 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18209 ((equal arg '(16)) (org-buffer-list 'agenda))
18210 (t (org-buffer-list))))
18211 (org-completion-use-iswitchb org-completion-use-iswitchb)
18212 (org-completion-use-ido org-completion-use-ido))
18213 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18214 (setq org-completion-use-iswitchb t))
18215 (org-pop-to-buffer-same-window
18216 (org-icompleting-read "Org buffer: "
18217 (mapcar 'list (mapcar 'buffer-name blist))
18220 ;;; Define some older names previously used for this functionality
18222 (defalias 'org-ido-switchb 'org-switchb)
18224 (defalias 'org-iswitchb 'org-switchb)
18226 (defun org-buffer-list (&optional predicate exclude-tmp)
18227 "Return a list of Org buffers.
18228 PREDICATE can be `export', `files' or `agenda'.
18230 export restrict the list to Export buffers.
18231 files restrict the list to buffers visiting Org files.
18232 agenda restrict the list to buffers visiting agenda files.
18234 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18236 (agenda-files (and (eq predicate 'agenda)
18237 (mapcar 'file-truename (org-agenda-files t))))
18240 ((eq predicate 'files)
18241 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18242 ((eq predicate 'export)
18243 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18244 ((eq predicate 'agenda)
18246 (with-current-buffer b
18247 (and (derived-mode-p 'org-mode)
18248 (setq bfn (buffer-file-name b))
18249 (member (file-truename bfn) agenda-files)))))
18250 (t (lambda (b) (with-current-buffer b
18251 (or (derived-mode-p 'org-mode)
18252 (string-match "\*Org .*Export"
18253 (buffer-name b)))))))))
18257 (if (and (funcall filter b)
18258 (or (not exclude-tmp)
18259 (not (string-match "tmp" (buffer-name b)))))
18264 (defun org-agenda-files (&optional unrestricted archives)
18265 "Get the list of agenda files.
18266 Optional UNRESTRICTED means return the full list even if a restriction
18267 is currently in place.
18268 When ARCHIVES is t, include all archive files that are really being
18269 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18270 `org-agenda-archives-mode' is t."
18273 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18274 ((stringp org-agenda-files) (org-read-agenda-file-list))
18275 ((listp org-agenda-files) org-agenda-files)
18276 (t (error "Invalid value of `org-agenda-files'")))))
18277 (setq files (apply 'append
18278 (mapcar (lambda (f)
18279 (if (file-directory-p f)
18281 f t org-agenda-file-regexp)
18284 (when org-agenda-skip-unavailable-files
18285 (setq files (delq nil
18288 (and (file-readable-p file) file)))
18290 (when (or (eq archives t)
18291 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18292 (setq files (org-add-archive-files files)))
18295 (defun org-agenda-file-p (&optional file)
18296 "Return non-nil, if FILE is an agenda file.
18297 If FILE is omitted, use the file associated with the current
18299 (let ((fname (or file (buffer-file-name))))
18301 (member (file-truename fname)
18302 (mapcar #'file-truename (org-agenda-files t))))))
18304 (defun org-edit-agenda-file-list ()
18305 "Edit the list of agenda files.
18306 Depending on setup, this either uses customize to edit the variable
18307 `org-agenda-files', or it visits the file that is holding the list. In the
18308 latter case, the buffer is set up in a way that saving it automatically kills
18309 the buffer and restores the previous window configuration."
18311 (if (stringp org-agenda-files)
18312 (let ((cw (current-window-configuration)))
18313 (find-file org-agenda-files)
18314 (org-set-local 'org-window-configuration cw)
18315 (org-add-hook 'after-save-hook
18317 (set-window-configuration
18318 (prog1 org-window-configuration
18319 (kill-buffer (current-buffer))))
18320 (org-install-agenda-files-menu)
18321 (message "New agenda file list installed"))
18323 (message "%s" (substitute-command-keys
18324 "Edit list and finish with \\[save-buffer]")))
18325 (customize-variable 'org-agenda-files)))
18327 (defun org-store-new-agenda-file-list (list)
18328 "Set new value for the agenda file list and save it correctly."
18329 (if (stringp org-agenda-files)
18330 (let ((fe (org-read-agenda-file-list t)) b u)
18331 (while (setq b (find-buffer-visiting org-agenda-files))
18333 (with-temp-file org-agenda-files
18336 (lambda (f) ;; Keep un-expanded entries.
18337 (if (setq u (assoc f fe))
18342 (let ((org-mode-hook nil) (org-inhibit-startup t)
18343 (org-insert-mode-line-in-empty-file nil))
18344 (setq org-agenda-files list)
18345 (customize-save-variable 'org-agenda-files org-agenda-files))))
18347 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18348 "Read the list of agenda files from a file.
18349 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18350 filenames, used by `org-store-new-agenda-file-list' to write back
18351 un-expanded file names."
18352 (when (file-directory-p org-agenda-files)
18353 (error "`org-agenda-files' cannot be a single directory"))
18354 (when (stringp org-agenda-files)
18356 (insert-file-contents org-agenda-files)
18359 (let ((e (expand-file-name (substitute-in-file-name f)
18361 (if pair-with-expansion
18364 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18367 (defun org-cycle-agenda-files ()
18368 "Cycle through the files in `org-agenda-files'.
18369 If the current buffer visits an agenda file, find the next one in the list.
18370 If the current buffer does not, find the first agenda file."
18372 (let* ((fs (org-agenda-files t))
18373 (files (append fs (list (car fs))))
18374 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18376 (unless files (user-error "No agenda files"))
18378 (while (setq file (pop files))
18379 (if (equal (file-truename file) tcf)
18381 (find-file (car files))
18383 (find-file (car fs)))
18384 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18386 (defun org-agenda-file-to-front (&optional to-end)
18387 "Move/add the current file to the top of the agenda file list.
18388 If the file is not present in the list, it is added to the front. If it is
18389 present, it is moved there. With optional argument TO-END, add/move to the
18392 (let ((org-agenda-skip-unavailable-files nil)
18393 (file-alist (mapcar (lambda (x)
18394 (cons (file-truename x) x))
18395 (org-agenda-files t)))
18396 (ctf (file-truename
18397 (or buffer-file-name
18398 (user-error "Please save the current buffer to a file"))))
18400 (setq x (assoc ctf file-alist) had x)
18402 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18404 (setq file-alist (append (delq x file-alist) (list x)))
18405 (setq file-alist (cons x (delq x file-alist))))
18406 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18407 (org-install-agenda-files-menu)
18408 (message "File %s to %s of agenda file list"
18409 (if had "moved" "added") (if to-end "end" "front"))))
18411 (defun org-remove-file (&optional file)
18412 "Remove current file from the list of files in variable `org-agenda-files'.
18413 These are the files which are being checked for agenda entries.
18414 Optional argument FILE means use this file instead of the current."
18416 (let* ((org-agenda-skip-unavailable-files nil)
18417 (file (or file buffer-file-name
18418 (user-error "Current buffer does not visit a file")))
18419 (true-file (file-truename file))
18420 (afile (abbreviate-file-name file))
18421 (files (delq nil (mapcar
18423 (if (equal true-file
18426 (org-agenda-files t)))))
18427 (if (not (= (length files) (length (org-agenda-files t))))
18429 (org-store-new-agenda-file-list files)
18430 (org-install-agenda-files-menu)
18431 (message "Removed from Org Agenda list: %s" afile))
18432 (message "File was not in list: %s (not removed)" afile))))
18434 (defun org-file-menu-entry (file)
18435 (vector file (list 'find-file file) t))
18437 (defun org-check-agenda-file (file)
18438 "Make sure FILE exists. If not, ask user what to do."
18439 (when (not (file-exists-p file))
18440 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18441 (abbreviate-file-name file))
18442 (let ((r (downcase (read-char-exclusive))))
18445 (org-remove-file file)
18446 (throw 'nextfile t))
18447 (t (user-error "Abort"))))))
18449 (defun org-get-agenda-file-buffer (file)
18450 "Get an agenda buffer visiting FILE.
18451 If the buffer needs to be created, add it to the list of buffers
18452 which might be released later."
18453 (let ((buf (org-find-base-buffer-visiting file)))
18455 buf ; just return it
18456 ;; Make a new buffer and remember it
18457 (setq buf (find-file-noselect file))
18458 (if buf (push buf org-agenda-new-buffers))
18461 (defun org-release-buffers (blist)
18462 "Release all buffers in list, asking the user for confirmation when needed.
18463 When a buffer is unmodified, it is just killed. When modified, it is saved
18464 \(if the user agrees) and then killed."
18466 (while (setq buf (pop blist))
18467 (setq file (buffer-file-name buf))
18468 (when (and (buffer-modified-p buf)
18470 (y-or-n-p (format "Save file %s? " file)))
18471 (with-current-buffer buf (save-buffer)))
18472 (kill-buffer buf))))
18474 (defun org-agenda-prepare-buffers (files)
18475 "Create buffers for all agenda files, protect archived trees and comments."
18477 (let ((pa '(:org-archived t))
18478 (pc '(:org-comment t))
18479 (pall '(:org-archived t :org-comment t))
18480 (inhibit-read-only t)
18481 (org-inhibit-startup org-agenda-inhibit-startup)
18482 (rea (concat ":" org-archive-tag ":"))
18484 (setq org-tag-alist-for-agenda nil
18485 org-tag-groups-alist-for-agenda nil)
18488 (while (setq file (pop files))
18492 (org-check-agenda-file file)
18493 (set-buffer (org-get-agenda-file-buffer file)))
18495 (org-set-regexps-and-options 'tags-only)
18497 (or (memq 'category org-agenda-ignore-properties)
18498 (org-refresh-category-properties))
18499 (or (memq 'stats org-agenda-ignore-properties)
18500 (org-refresh-stats-properties))
18501 (or (memq 'effort org-agenda-ignore-properties)
18502 (org-refresh-effort-properties))
18503 (or (memq 'appt org-agenda-ignore-properties)
18504 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18505 (setq org-todo-keywords-for-agenda
18506 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18507 (setq org-done-keywords-for-agenda
18508 (append org-done-keywords-for-agenda org-done-keywords))
18509 (setq org-todo-keyword-alist-for-agenda
18510 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18511 (setq org-tag-alist-for-agenda
18513 (append org-tag-alist-for-agenda
18515 org-tag-persistent-alist)))
18517 (setq org-tag-groups-alist-for-agenda
18518 (org-uniquify-alist
18519 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18520 (org-with-silent-modifications
18522 (remove-text-properties (point-min) (point-max) pall)
18523 (when org-agenda-skip-archived-trees
18524 (goto-char (point-min))
18525 (while (re-search-forward rea nil t)
18526 (if (org-at-heading-p t)
18527 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18528 (goto-char (point-min))
18529 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18530 (while (re-search-forward re nil t)
18531 (when (save-match-data (org-in-commented-heading-p t))
18532 (add-text-properties
18533 (match-beginning 0) (org-end-of-subtree t) pc)))))
18534 (goto-char pos)))))
18535 (setq org-todo-keywords-for-agenda
18536 (org-uniquify org-todo-keywords-for-agenda))
18537 (setq org-todo-keyword-alist-for-agenda
18538 (org-uniquify org-todo-keyword-alist-for-agenda))))
18541 ;;;; CDLaTeX minor mode
18543 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18544 "Keymap for the minor `org-cdlatex-mode'.")
18546 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18547 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18548 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18549 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18550 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18552 (defvar org-cdlatex-texmathp-advice-is-done nil
18553 "Flag remembering if we have applied the advice to texmathp already.")
18555 (define-minor-mode org-cdlatex-mode
18556 "Toggle the minor `org-cdlatex-mode'.
18557 This mode supports entering LaTeX environment and math in LaTeX fragments
18559 \\{org-cdlatex-mode-map}"
18561 (when org-cdlatex-mode
18563 (run-hooks 'cdlatex-mode-hook)
18564 (cdlatex-compute-tables))
18565 (unless org-cdlatex-texmathp-advice-is-done
18566 (setq org-cdlatex-texmathp-advice-is-done t)
18567 (defadvice texmathp (around org-math-always-on activate)
18568 "Always return t in org-mode buffers.
18569 This is because we want to insert math symbols without dollars even outside
18570 the LaTeX math segments. If Orgmode thinks that point is actually inside
18571 an embedded LaTeX fragment, let texmathp do its job.
18572 \\[org-cdlatex-mode-map]"
18576 ((not (derived-mode-p 'org-mode)) ad-do-it)
18577 ((eq this-command 'cdlatex-math-symbol)
18578 (setq ad-return-value t
18579 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18581 (let ((p (org-inside-LaTeX-fragment-p)))
18582 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18583 (setq ad-return-value t
18584 texmathp-why '("Org-mode embedded math" . 0))
18585 (if p ad-do-it)))))))))
18587 (defun turn-on-org-cdlatex ()
18588 "Unconditionally turn on `org-cdlatex-mode'."
18589 (org-cdlatex-mode 1))
18591 (defun org-try-cdlatex-tab ()
18592 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18593 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18594 - inside a LaTeX fragment, or
18595 - after the first word in a line, where an abbreviation expansion could
18596 insert a LaTeX environment."
18597 (when org-cdlatex-mode
18599 ;; Before any word on the line: No expansion possible.
18600 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18601 ;; Just after first word on the line: Expand it. Make sure it
18602 ;; cannot happen on headlines, though.
18604 (skip-chars-backward "a-zA-Z0-9*")
18605 (skip-chars-backward " \t")
18606 (and (bolp) (not (org-at-heading-p))))
18608 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18610 (defun org-cdlatex-underscore-caret (&optional arg)
18611 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18612 Revert to the normal definition outside of these fragments."
18614 (if (org-inside-LaTeX-fragment-p)
18615 (call-interactively 'cdlatex-sub-superscript)
18616 (let (org-cdlatex-mode)
18617 (call-interactively (key-binding (vector last-input-event))))))
18619 (defun org-cdlatex-math-modify (&optional arg)
18620 "Execute `cdlatex-math-modify' in LaTeX fragments.
18621 Revert to the normal definition outside of these fragments."
18623 (if (org-inside-LaTeX-fragment-p)
18624 (call-interactively 'cdlatex-math-modify)
18625 (let (org-cdlatex-mode)
18626 (call-interactively (key-binding (vector last-input-event))))))
18628 (defun org-cdlatex-environment-indent (&optional environment item)
18629 "Execute `cdlatex-environment' and indent the inserted environment."
18631 (cdlatex-environment environment item)
18632 (let ((element (org-element-at-point)))
18633 (org-indent-region (org-element-property :begin element)
18634 (org-element-property :end element))))
18637 ;;;; LaTeX fragments
18639 (defun org-inside-LaTeX-fragment-p ()
18640 "Test if point is inside a LaTeX fragment.
18641 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18642 sequence appearing also before point.
18643 Even though the matchers for math are configurable, this function assumes
18644 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18645 delimiters are skipped when they have been removed by customization.
18646 The return value is nil, or a cons cell with the delimiter and the
18647 position of this delimiter.
18649 This function does a reasonably good job, but can locally be fooled by
18650 for example currency specifications. For example it will assume being in
18651 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18652 fragments that are properly closed, but during editing, we have to live
18653 with the uncertainty caused by missing closing delimiters. This function
18654 looks only before point, not after."
18656 (let ((pos (point))
18657 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18659 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18661 dd-on str (start 0) m re)
18664 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18665 re (nth 1 (assoc "$" org-latex-regexps)))
18666 (while (string-match re str start)
18668 ((= (match-end 0) (length str))
18669 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18670 ((= (match-end 0) (- (length str) 5))
18672 (t (setq start (match-end 0))))))
18673 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18675 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18676 (and (match-beginning 2) (throw 'exit nil))
18678 (while (re-search-backward "\\$\\$" lim t)
18679 (setq dd-on (not dd-on)))
18681 (if dd-on (cons "$$" m))))))
18683 (defun org-inside-latex-macro-p ()
18684 "Is point inside a LaTeX macro or its arguments?"
18687 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18689 (defvar org-latex-fragment-image-overlays nil
18690 "List of overlays carrying the images of latex fragments.")
18691 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18693 (defun org-remove-latex-fragment-image-overlays ()
18694 "Remove all overlays with LaTeX fragment images in current buffer."
18695 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18696 (setq org-latex-fragment-image-overlays nil))
18698 (define-obsolete-function-alias
18699 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18700 (defun org-toggle-latex-fragment (&optional subtree)
18701 "Preview the LaTeX fragment at point, or all locally or globally.
18702 If the cursor is in a LaTeX fragment, create the image and overlay
18703 it over the source code. If there is no fragment at point, display
18704 all fragments in the current text, from one headline to the next. With
18705 prefix SUBTREE, display all fragments in the current subtree. With a
18706 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18707 the cursor is before the first headline,
18708 display all fragments in the buffer.
18709 The images can be removed again with \\[org-toggle-latex-fragment]."
18711 (unless (buffer-file-name (buffer-base-buffer))
18712 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18713 (if org-latex-fragment-image-overlays
18714 (progn (org-remove-latex-fragment-image-overlays)
18715 (message "LaTeX fragments images removed"))
18716 (when (display-graphic-p)
18717 (org-remove-latex-fragment-image-overlays)
18718 (org-with-wide-buffer
18721 ((equal subtree '(16))
18722 (setq beg (point-min) end (point-max)
18723 msg "Creating images for buffer...%s"))
18724 ((equal subtree '(4))
18725 (org-back-to-heading)
18726 (setq beg (point) end (org-end-of-subtree t)
18727 msg "Creating images for subtree...%s"))
18728 ((let ((context (org-element-context)))
18729 (when (memq (org-element-type context)
18730 '(latex-environment latex-fragment))
18731 (setq beg (org-element-property :begin context)
18732 end (org-element-property :end context)
18733 msg "Creating image...%s"))))
18734 ((org-before-first-heading-p)
18735 (setq beg (point-min) end (point-max)
18736 msg "Creating images for buffer...%s"))
18738 (org-back-to-heading)
18739 (setq beg (point) end (progn (outline-next-heading) (point))
18740 msg "Creating images for entry...%s")))
18742 (narrow-to-region beg end)
18745 (concat org-latex-preview-ltxpng-directory
18746 (file-name-sans-extension
18747 (file-name-nondirectory
18748 (buffer-file-name (buffer-base-buffer)))))
18749 default-directory 'overlays msg 'forbuffer
18750 org-latex-create-formula-image-program)
18751 (message msg "done. Use `C-c C-x C-l' to remove images."))))))
18753 (defun org-format-latex
18754 (prefix &optional dir overlays msg forbuffer processing-type)
18755 "Replace LaTeX fragments with links to an image, and produce images.
18756 Some of the options can be changed using the variable
18757 `org-format-latex-options'."
18758 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18759 (unless (eq processing-type 'verbatim)
18760 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18763 (goto-char (point-min))
18764 (while (re-search-forward math-regexp nil t)
18765 (unless (and overlays
18766 (eq (get-char-property (point) 'org-overlay-type)
18767 'org-latex-overlay))
18768 (let* ((context (org-element-context))
18769 (type (org-element-type context)))
18770 (when (memq type '(latex-environment latex-fragment))
18771 (let ((block-type (eq type 'latex-environment))
18772 (value (org-element-property :value context))
18773 (beg (org-element-property :begin context))
18774 (end (save-excursion
18775 (goto-char (org-element-property :end context))
18776 (skip-chars-backward " \r\t\n")
18778 (case processing-type
18780 ;; Prepare for MathJax processing.
18781 (if (eq (char-after beg) ?$)
18783 (delete-region beg end)
18784 (insert "\\(" (substring value 1 -1) "\\)"))
18786 ((dvipng imagemagick)
18787 ;; Process to an image.
18790 (let* ((face (face-at-point))
18791 ;; Get the colors from the face at point.
18793 (let ((color (plist-get org-format-latex-options
18795 (if (and forbuffer (eq color 'auto))
18796 (face-attribute face :foreground nil 'default)
18799 (let ((color (plist-get org-format-latex-options
18801 (if (and forbuffer (eq color 'auto))
18802 (face-attribute face :background nil 'default)
18804 (hash (sha1 (prin1-to-string
18805 (list org-format-latex-header
18806 org-latex-default-packages-alist
18807 org-latex-packages-alist
18808 org-format-latex-options
18809 forbuffer value fg bg))))
18810 (absprefix (expand-file-name prefix dir))
18811 (linkfile (format "%s_%s.png" prefix hash))
18812 (movefile (format "%s_%s.png" absprefix hash))
18813 (sep (and block-type "\n\n"))
18814 (link (concat sep "[[file:" linkfile "]]" sep))
18816 (org-combine-plists
18817 org-format-latex-options
18818 `(:foreground ,fg :background ,bg))))
18819 (when msg (message msg cnt))
18820 (unless checkdir-flag ; Ensure the directory exists.
18821 (setq checkdir-flag t)
18822 (let ((todir (file-name-directory absprefix)))
18823 (unless (file-directory-p todir)
18824 (make-directory todir t))))
18825 (unless (file-exists-p movefile)
18826 (org-create-formula-image
18827 value movefile options forbuffer processing-type))
18830 (dolist (o (overlays-in beg end))
18831 (when (eq (overlay-get o 'org-overlay-type)
18832 'org-latex-overlay)
18833 (delete-overlay o)))
18834 (let ((ov (make-overlay beg end)))
18837 'org-latex-overlay)
18838 (if (featurep 'xemacs)
18840 (overlay-put ov 'invisible t)
18844 (vector 'png :file movefile))))
18851 (push ov org-latex-fragment-image-overlays))
18853 (delete-region beg end)
18855 (org-add-props link
18856 (list 'org-latex-src
18857 (replace-regexp-in-string "\"" "" value)
18858 'org-latex-src-embed-type
18859 (if block-type 'paragraph 'character)))))))
18861 ;; Process to MathML.
18862 (unless (org-format-latex-mathml-available-p)
18863 (user-error "LaTeX to MathML converter not configured"))
18865 (when msg (message msg cnt))
18867 (delete-region beg end)
18868 (insert (org-format-latex-as-mathml
18869 value block-type prefix dir)))
18871 (error "Unknown conversion type %s for LaTeX fragments"
18872 processing-type)))))))))))
18874 (defun org-create-math-formula (latex-frag &optional mathml-file)
18875 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18876 Use `org-latex-to-mathml-convert-command'. If the conversion is
18877 sucessful, return the portion between \"<math...> </math>\"
18878 elements otherwise return nil. When MATHML-FILE is specified,
18879 write the results in to that file. When invoked as an
18880 interactive command, prompt for LATEX-FRAG, with initial value
18881 set to the current active region and echo the results for user
18883 (interactive (list (let ((frag (when (org-region-active-p)
18884 (buffer-substring-no-properties
18885 (region-beginning) (region-end)))))
18886 (read-string "LaTeX Fragment: " frag nil frag))))
18887 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18888 (let* ((tmp-in-file (file-relative-name
18889 (make-temp-name (expand-file-name "ltxmathml-in"))))
18890 (ignore (write-region latex-frag nil tmp-in-file))
18891 (tmp-out-file (file-relative-name
18892 (make-temp-name (expand-file-name "ltxmathml-out"))))
18894 org-latex-to-mathml-convert-command
18895 `((?j . ,(shell-quote-argument
18896 (expand-file-name org-latex-to-mathml-jar-file)))
18897 (?I . ,(shell-quote-argument tmp-in-file))
18898 (?o . ,(shell-quote-argument tmp-out-file)))))
18899 mathml shell-command-output)
18900 (when (org-called-interactively-p 'any)
18901 (unless (org-format-latex-mathml-available-p)
18902 (user-error "LaTeX to MathML converter not configured")))
18903 (message "Running %s" cmd)
18904 (setq shell-command-output (shell-command-to-string cmd))
18906 (when (file-readable-p tmp-out-file)
18907 (with-current-buffer (find-file-noselect tmp-out-file t)
18908 (goto-char (point-min))
18909 (when (re-search-forward
18912 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18914 (regexp-quote "</math>")) nil t)
18915 (prog1 (match-string 0) (kill-buffer))))))
18919 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18921 (write-region mathml nil mathml-file))
18922 (when (org-called-interactively-p 'any)
18924 ((message "LaTeX to MathML conversion failed")
18925 (message shell-command-output)))
18926 (delete-file tmp-in-file)
18927 (when (file-exists-p tmp-out-file)
18928 (delete-file tmp-out-file))
18931 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18932 prefix &optional dir)
18933 "Use `org-create-math-formula' but check local cache first."
18934 (let* ((absprefix (expand-file-name prefix dir))
18935 (print-length nil) (print-level nil)
18936 (formula-id (concat
18941 org-latex-to-mathml-convert-command)))))
18942 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18943 (formula-cache-dir (file-name-directory formula-cache)))
18945 (unless (file-directory-p formula-cache-dir)
18946 (make-directory formula-cache-dir t))
18948 (unless (file-exists-p formula-cache)
18949 (org-create-math-formula latex-frag formula-cache))
18951 (if (file-exists-p formula-cache)
18952 ;; Successful conversion. Return the link to MathML file.
18954 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18955 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18956 'org-latex-src-embed-type (if latex-frag-type
18957 'paragraph 'character)))
18958 ;; Failed conversion. Return the LaTeX fragment verbatim
18961 (defun org-create-formula-image (string tofile options buffer &optional type)
18962 "Create an image from LaTeX source using dvipng or convert.
18963 This function calls either `org-create-formula-image-with-dvipng'
18964 or `org-create-formula-image-with-imagemagick' depending on the
18965 value of `org-latex-create-formula-image-program' or on the value
18966 of the optional TYPE variable.
18968 Note: ultimately these two function should be combined as they
18969 share a good deal of logic."
18970 (org-check-external-command
18971 "latex" "needed to convert LaTeX fragments to images")
18973 (case (or type org-latex-create-formula-image-program)
18975 (org-check-external-command
18976 "dvipng" "needed to convert LaTeX fragments to images")
18977 'org-create-formula-image-with-dvipng)
18979 (org-check-external-command
18980 "convert" "you need to install imagemagick")
18981 'org-create-formula-image-with-imagemagick)
18983 "Invalid value of `org-latex-create-formula-image-program'")))
18984 string tofile options buffer))
18986 (declare-function org-export-get-backend "ox" (name))
18987 (declare-function org-export--get-global-options "ox" (&optional backend))
18988 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18989 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18990 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18991 (defun org-create-formula--latex-header ()
18992 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18993 (let ((info (org-combine-plists (org-export--get-global-options
18994 (org-export-get-backend 'latex))
18995 (org-export--get-inbuffer-options
18996 (org-export-get-backend 'latex)))))
18997 (org-latex-guess-babel-language
18998 (org-latex-guess-inputenc
18999 (org-splice-latex-header
19000 org-format-latex-header
19001 org-latex-default-packages-alist
19002 org-latex-packages-alist t
19003 (plist-get info :latex-header)))
19006 (defun org--get-display-dpi ()
19007 "Get the DPI of the display.
19009 Assumes that the display has the same pixel width in the
19010 horizontal and vertical directions."
19011 (if (display-graphic-p)
19012 (round (/ (display-pixel-height)
19013 (/ (display-mm-height) 25.4)))
19014 (error "Attempt to calculate the dpi of a non-graphic display")))
19016 ;; This function borrows from Ganesh Swami's latex2png.el
19017 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19018 "This calls dvipng."
19019 (require 'ox-latex)
19020 (let* ((tmpdir (if (featurep 'xemacs)
19022 temporary-file-directory))
19023 (texfilebase (make-temp-name
19024 (expand-file-name "orgtex" tmpdir)))
19025 (texfile (concat texfilebase ".tex"))
19026 (dvifile (concat texfilebase ".dvi"))
19027 (pngfile (concat texfilebase ".png"))
19028 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19029 ;; This assumes that the display has the same pixel width in
19030 ;; the horizontal and vertical directions
19031 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19032 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19034 (bg (or (plist-get options (if buffer :background :html-background))
19036 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19037 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19038 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19039 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19040 (let ((latex-header (org-create-formula--latex-header)))
19041 (with-temp-file texfile
19042 (insert latex-header)
19043 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19044 (let ((dir default-directory))
19047 (call-process "latex" nil nil nil texfile))
19049 (if (not (file-exists-p dvifile))
19050 (progn (message "Failed to create dvi file from %s" texfile) nil)
19052 (if (featurep 'xemacs)
19053 (call-process "dvipng" nil nil nil
19058 (call-process "dvipng" nil nil nil
19061 ;;"-x" scale "-y" scale
19065 (if (not (file-exists-p pngfile))
19066 (if org-format-latex-signal-error
19067 (error "Failed to create png file from %s" texfile)
19068 (message "Failed to create png file from %s" texfile)
19070 ;; Use the requested file name and clean up
19071 (copy-file pngfile tofile 'replace)
19072 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19073 (if (file-exists-p (concat texfilebase e))
19074 (delete-file (concat texfilebase e))))
19077 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19078 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19079 "This calls convert, which is included into imagemagick."
19080 (require 'ox-latex)
19081 (let* ((tmpdir (if (featurep 'xemacs)
19083 temporary-file-directory))
19084 (texfilebase (make-temp-name
19085 (expand-file-name "orgtex" tmpdir)))
19086 (texfile (concat texfilebase ".tex"))
19087 (pdffile (concat texfilebase ".pdf"))
19088 (pngfile (concat texfilebase ".png"))
19089 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19090 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19091 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19093 (bg (or (plist-get options (if buffer :background :html-background))
19095 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19096 (setq fg (org-latex-color-format fg)))
19097 (if (eq bg 'default) (setq bg (org-latex-color :background))
19098 (setq bg (org-latex-color-format
19099 (if (string= bg "Transparent") "white" bg))))
19100 (let ((latex-header (org-create-formula--latex-header)))
19101 (with-temp-file texfile
19102 (insert latex-header)
19103 (insert "\n\\begin{document}\n"
19104 "\\definecolor{fg}{rgb}{" fg "}\n"
19105 "\\definecolor{bg}{rgb}{" bg "}\n"
19106 "\n\\pagecolor{bg}\n"
19110 "\n\\end{document}\n")))
19111 (org-latex-compile texfile t)
19112 (if (not (file-exists-p pdffile))
19113 (progn (message "Failed to create pdf file from %s" texfile) nil)
19115 (if (featurep 'xemacs)
19116 (call-process "convert" nil nil nil
19122 ;; "-sharpen" "0x1.0"
19124 (call-process "convert" nil nil nil
19130 ;; "-sharpen" "0x1.0"
19132 (if (not (file-exists-p pngfile))
19133 (if org-format-latex-signal-error
19134 (error "Failed to create png file from %s" texfile)
19135 (message "Failed to create png file from %s" texfile)
19137 ;; Use the requested file name and clean up
19138 (copy-file pngfile tofile 'replace)
19139 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19140 (if (file-exists-p (concat texfilebase e))
19141 (delete-file (concat texfilebase e))))
19144 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19145 "Fill a LaTeX header template TPL.
19146 In the template, the following place holders will be recognized:
19148 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19149 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19150 [PACKAGES] \\usepackage statements for PKG
19151 [NO-PACKAGES] do not include PKG
19152 [EXTRA] the string EXTRA
19153 [NO-EXTRA] do not include EXTRA
19155 For backward compatibility, if both the positive and the negative place
19156 holder is missing, the positive one (without the \"NO-\") will be
19157 assumed to be present at the end of the template.
19158 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19160 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19161 (let (rpl (end ""))
19162 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19163 (setq rpl (if (or (match-end 1) (not def-pkg))
19164 "" (org-latex-packages-to-string def-pkg snippets-p t))
19165 tpl (replace-match rpl t t tpl))
19166 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19168 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19169 (setq rpl (if (or (match-end 1) (not pkg))
19170 "" (org-latex-packages-to-string pkg snippets-p t))
19171 tpl (replace-match rpl t t tpl))
19174 (org-latex-packages-to-string pkg snippets-p)))))
19176 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19177 (setq rpl (if (or (match-end 1) (not extra))
19178 "" (concat extra "\n"))
19179 tpl (replace-match rpl t t tpl))
19180 (if (and extra (string-match "\\S-" extra))
19181 (setq end (concat end "\n" extra))))
19183 (if (string-match "\\S-" end)
19184 (concat tpl "\n" end)
19187 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19188 "Turn an alist of packages into a string with the \\usepackage macros."
19189 (setq pkg (mapconcat (lambda(p)
19192 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19193 (format "%% Package %s omitted" (cadr p)))
19194 ((equal "" (car p))
19195 (format "\\usepackage{%s}" (cadr p)))
19197 (format "\\usepackage[%s]{%s}"
19198 (car p) (cadr p)))))
19201 (if newline (concat pkg "\n") pkg))
19203 (defun org-dvipng-color (attr)
19204 "Return a RGB color specification for dvipng."
19205 (apply 'format "rgb %s %s %s"
19206 (mapcar 'org-normalize-color
19207 (if (featurep 'xemacs)
19208 (color-rgb-components
19209 (face-property 'default
19210 (cond ((eq attr :foreground) 'foreground)
19211 ((eq attr :background) 'background))))
19212 (color-values (face-attribute 'default attr nil))))))
19214 (defun org-dvipng-color-format (color-name)
19215 "Convert COLOR-NAME to a RGB color value for dvipng."
19216 (apply 'format "rgb %s %s %s"
19217 (mapcar 'org-normalize-color
19218 (color-values color-name))))
19220 (defun org-latex-color (attr)
19221 "Return a RGB color for the LaTeX color package."
19222 (apply 'format "%s,%s,%s"
19223 (mapcar 'org-normalize-color
19224 (if (featurep 'xemacs)
19225 (color-rgb-components
19226 (face-property 'default
19227 (cond ((eq attr :foreground) 'foreground)
19228 ((eq attr :background) 'background))))
19229 (color-values (face-attribute 'default attr nil))))))
19231 (defun org-latex-color-format (color-name)
19232 "Convert COLOR-NAME to a RGB color value."
19233 (apply 'format "%s,%s,%s"
19234 (mapcar 'org-normalize-color
19235 (color-values color-name))))
19237 (defun org-normalize-color (value)
19238 "Return string to be used as color value for an RGB component."
19239 (format "%g" (/ value 65535.0)))
19245 (defvar org-inline-image-overlays nil)
19246 (make-variable-buffer-local 'org-inline-image-overlays)
19248 (defun org-toggle-inline-images (&optional include-linked)
19249 "Toggle the display of inline images.
19250 INCLUDE-LINKED is passed to `org-display-inline-images'."
19252 (if org-inline-image-overlays
19254 (org-remove-inline-images)
19255 (when (org-called-interactively-p 'interactive)
19256 (message "Inline image display turned off")))
19257 (org-display-inline-images include-linked)
19258 (when (org-called-interactively-p 'interactive)
19259 (message (if org-inline-image-overlays
19260 (format "%d images displayed inline"
19261 (length org-inline-image-overlays))
19262 "No images to display inline")))))
19264 (defun org-redisplay-inline-images ()
19265 "Refresh the display of inline images."
19267 (if (not org-inline-image-overlays)
19268 (org-toggle-inline-images)
19269 (org-toggle-inline-images)
19270 (org-toggle-inline-images)))
19272 (defun org-display-inline-images (&optional include-linked refresh beg end)
19273 "Display inline images.
19275 An inline image is a link which follows either of these
19278 1. Its path is a file with an extension matching return value
19279 from `image-file-name-regexp' and it has no contents.
19281 2. Its description consists in a single link of the previous
19284 When optional argument INCLUDE-LINKED is non-nil, also links with
19285 a text description part will be inlined. This can be nice for
19286 a quick look at those images, but it does not reflect what
19287 exported files will look like.
19289 When optional argument REFRESH is non-nil, refresh existing
19290 images between BEG and END. This will create new image displays
19291 only if necessary. BEG and END default to the buffer
19294 (when (display-graphic-p)
19296 (org-remove-inline-images)
19297 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19298 (org-with-wide-buffer
19299 (goto-char (or beg (point-min)))
19300 (let ((case-fold-search t)
19301 (file-extension-re (org-image-file-name-regexp)))
19302 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19303 (let ((link (save-match-data (org-element-context))))
19304 ;; Check if we're at an inline image.
19305 (when (and (equal (org-element-property :type link) "file")
19307 (not (org-element-property :contents-begin link)))
19308 (let ((parent (org-element-property :parent link)))
19309 (or (not (eq (org-element-type parent) 'link))
19310 (not (cdr (org-element-contents parent)))))
19311 (org-string-match-p file-extension-re
19312 (org-element-property :path link)))
19313 (let ((file (expand-file-name (org-element-property :path link))))
19314 (when (file-exists-p file)
19316 ;; Apply `org-image-actual-width' specifications.
19318 ((not (image-type-available-p 'imagemagick)) nil)
19319 ((eq org-image-actual-width t) nil)
19320 ((listp org-image-actual-width)
19322 ;; First try to find a width among
19323 ;; attributes associated to the paragraph
19324 ;; containing link.
19327 (while (and (setq e (org-element-property
19329 (not (eq (org-element-type e)
19334 (goto-char (org-element-property :begin paragraph))
19337 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19338 (org-element-property
19339 :post-affiliated paragraph)
19341 (string-to-number (match-string 1))))))
19342 ;; Otherwise, fall-back to provided number.
19343 (car org-image-actual-width)))
19344 ((numberp org-image-actual-width)
19345 org-image-actual-width)))
19346 (old (get-char-property-and-overlay
19347 (org-element-property :begin link)
19348 'org-image-overlay)))
19349 (if (and (car-safe old) refresh)
19350 (image-refresh (overlay-get (cdr old) 'display))
19351 (let ((image (create-image file
19352 (and width 'imagemagick)
19357 ;; If inline image is the description
19358 ;; of another link, be sure to
19359 ;; consider the latter as the one to
19360 ;; apply the overlay on.
19362 (org-element-property :parent link)))
19363 (if (eq (org-element-type parent) 'link)
19367 (org-element-property :begin link)
19370 (org-element-property :end link))
19371 (skip-chars-backward " \t")
19373 (overlay-put ov 'display image)
19374 (overlay-put ov 'face 'default)
19375 (overlay-put ov 'org-image-overlay t)
19377 ov 'modification-hooks
19378 (list 'org-display-inline-remove-overlay))
19379 (push ov org-inline-image-overlays)))))))))))))))
19381 (define-obsolete-function-alias
19382 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19384 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19385 "Remove inline-display overlay if a corresponding region is modified."
19386 (let ((inhibit-modification-hooks t))
19387 (when (and ov after)
19388 (delete ov org-inline-image-overlays)
19389 (delete-overlay ov))))
19391 (defun org-remove-inline-images ()
19392 "Remove inline display of images."
19394 (mapc 'delete-overlay org-inline-image-overlays)
19395 (setq org-inline-image-overlays nil))
19399 ;; Outline functions from `outline-mode-prefix-map'
19400 ;; that can be remapped in Org:
19401 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19402 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19403 (define-key org-mode-map [remap outline-forward-same-level]
19404 'org-forward-heading-same-level)
19405 (define-key org-mode-map [remap outline-backward-same-level]
19406 'org-backward-heading-same-level)
19407 (define-key org-mode-map [remap show-branches]
19408 'org-kill-note-or-show-branches)
19409 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19410 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19411 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19412 (define-key org-mode-map [remap outline-next-visible-heading]
19413 'org-next-visible-heading)
19414 (define-key org-mode-map [remap outline-previous-visible-heading]
19415 'org-previous-visible-heading)
19417 ;; Outline functions from `outline-mode-prefix-map' that can not
19418 ;; be remapped in Org:
19420 ;; - the column "key binding" shows whether the Outline function is still
19421 ;; available in Org mode on the same key that it has been bound to in
19423 ;; - "overridden": key used for a different functionality in Org mode
19424 ;; - else: key still bound to the same Outline function in Org mode
19426 ;; | Outline function | key binding | Org replacement |
19427 ;; |------------------------------------+-------------+--------------------------|
19428 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19429 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19430 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19431 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19432 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19433 ;; | `show-entry' | overridden | no replacement |
19434 ;; | `show-children' | `C-c C-i' | visibility cycling |
19435 ;; | `show-branches' | `C-c C-k' | still same function |
19436 ;; | `show-subtree' | overridden | visibility cycling |
19437 ;; | `show-all' | overridden | no replacement |
19438 ;; | `hide-subtree' | overridden | visibility cycling |
19439 ;; | `hide-body' | overridden | no replacement |
19440 ;; | `hide-entry' | overridden | visibility cycling |
19441 ;; | `hide-leaves' | overridden | no replacement |
19442 ;; | `hide-sublevels' | overridden | no replacement |
19443 ;; | `hide-other' | overridden | no replacement |
19445 ;; Make `C-c C-x' a prefix key
19446 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19448 ;; TAB key with modifiers
19449 (org-defkey org-mode-map "\C-i" 'org-cycle)
19450 (org-defkey org-mode-map [(tab)] 'org-cycle)
19451 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19452 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19453 ;; The following line is necessary under Suse GNU/Linux
19454 (unless (featurep 'xemacs)
19455 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19456 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19457 (define-key org-mode-map [backtab] 'org-shifttab)
19459 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19460 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19461 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19463 ;; Cursor keys with modifiers
19464 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19465 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19466 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19467 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19469 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19470 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19471 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19472 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19473 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19474 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19476 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19477 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19478 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19479 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19481 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19482 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19483 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19484 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19487 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19488 (mapc (lambda (pair)
19489 (define-key org-babel-map (car pair) (cdr pair)))
19490 org-babel-key-bindings)
19492 ;;; Extra keys for tty access.
19493 ;; We only set them when really needed because otherwise the
19494 ;; menus don't show the simple keys
19496 (when (or org-use-extra-keys
19497 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19498 (not window-system))
19499 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19500 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19501 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19502 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19503 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19504 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19505 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19506 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19507 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19508 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19509 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19510 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19511 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19512 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19513 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19514 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19515 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19516 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19517 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19518 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19519 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19520 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19521 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19522 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19523 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19524 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19525 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19526 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19528 ;; All the other keys
19530 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19531 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19532 (if (boundp 'narrow-map)
19533 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19534 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19535 (if (boundp 'narrow-map)
19536 (org-defkey narrow-map "b" 'org-narrow-to-block)
19537 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19538 (if (boundp 'narrow-map)
19539 (org-defkey narrow-map "e" 'org-narrow-to-element)
19540 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19541 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19542 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19543 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19544 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19545 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19546 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19547 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19548 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19549 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19550 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19551 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19552 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19553 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19554 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19555 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19556 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19557 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19558 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19559 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19560 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19561 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19562 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19563 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19564 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19565 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19566 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19567 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19568 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19569 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19570 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19571 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19572 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19573 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19574 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19575 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19576 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19577 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19578 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19579 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19580 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19581 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19582 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19583 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19584 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19585 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19586 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19587 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19588 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19589 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19590 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19591 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19592 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19593 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19594 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19595 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19596 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19597 (org-defkey org-mode-map "\C-c^" 'org-sort)
19598 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19599 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19600 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19601 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19602 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19603 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19604 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19605 (org-defkey org-mode-map "\C-m" 'org-return)
19606 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19607 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19608 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19609 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19610 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19611 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19612 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19613 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19614 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19615 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19616 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19617 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19618 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19619 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19620 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19621 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19622 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19623 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19624 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19625 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19626 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19627 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19628 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19629 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19630 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19632 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19633 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19634 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19636 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19637 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19638 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19639 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19640 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19641 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19642 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19643 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19644 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19645 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19646 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19647 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19648 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19649 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19650 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19651 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19652 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19653 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19654 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19655 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19656 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19657 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19658 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19660 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19661 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19662 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19663 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19664 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19666 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19668 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19670 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19671 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19673 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19676 (when (featurep 'xemacs)
19677 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19680 (defconst org-speed-commands-default
19682 ("Outline Navigation")
19683 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19684 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19685 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19686 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19687 ("F" . org-next-block)
19688 ("B" . org-previous-block)
19689 ("u" . (org-speed-move-safe 'outline-up-heading))
19691 ("g" . (org-refile t))
19692 ("Outline Visibility")
19694 ("C" . org-shifttab)
19695 (" " . org-display-outline-path)
19696 ("s" . org-narrow-to-subtree)
19697 ("=" . org-columns)
19698 ("Outline Structure Editing")
19700 ("D" . org-metadown)
19701 ("r" . org-metaright)
19702 ("l" . org-metaleft)
19703 ("R" . org-shiftmetaright)
19704 ("L" . org-shiftmetaleft)
19705 ("i" . (progn (forward-char 1) (call-interactively
19706 'org-insert-heading-respect-content)))
19709 ("a" . org-archive-subtree-default-with-confirmation)
19710 ("@" . org-mark-subtree)
19711 ("#" . org-toggle-comment)
19713 ("I" . org-clock-in)
19714 ("O" . org-clock-out)
19715 ("Meta Data Editing")
19717 ("," . (org-priority))
19718 ("0" . (org-priority ?\ ))
19719 ("1" . (org-priority ?A))
19720 ("2" . (org-priority ?B))
19721 ("3" . (org-priority ?C))
19722 (":" . org-set-tags-command)
19723 ("e" . org-set-effort)
19724 ("E" . org-inc-effort)
19725 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19726 (org-entry-put (point) "APPT_WARNTIME" m)))
19727 ("Agenda Views etc")
19729 ("/" . org-sparse-tree)
19731 ("o" . org-open-at-point)
19732 ("?" . org-speed-command-help)
19733 ("<" . (org-agenda-set-restriction-lock 'subtree))
19734 (">" . (org-agenda-remove-restriction-lock))
19736 "The default speed commands.")
19738 (defun org-print-speed-command (e)
19739 (if (> (length (car e)) 1)
19744 (princ (make-string (length (car e)) ?-))
19748 (if (symbolp (cdr e))
19749 (princ (symbol-name (cdr e)))
19753 (defun org-speed-command-help ()
19754 "Show the available speed commands."
19756 (if (not org-use-speed-commands)
19757 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19758 (with-output-to-temp-buffer "*Help*"
19759 (princ "User-defined Speed commands\n===========================\n")
19760 (mapc 'org-print-speed-command org-speed-commands-user)
19762 (princ "Built-in Speed commands\n=======================\n")
19763 (mapc 'org-print-speed-command org-speed-commands-default))
19764 (with-current-buffer "*Help*"
19765 (setq truncate-lines t))))
19767 (defun org-speed-move-safe (cmd)
19768 "Execute CMD, but make sure that the cursor always ends up in a headline.
19769 If not, return to the original position and throw an error."
19771 (let ((pos (point)))
19772 (call-interactively cmd)
19773 (unless (and (bolp) (org-at-heading-p))
19775 (error "Boundary reached while executing %s" cmd))))
19777 (defvar org-self-insert-command-undo-counter 0)
19779 (defvar org-table-auto-blank-field) ; defined in org-table.el
19780 (defvar org-speed-command nil)
19782 (define-obsolete-function-alias
19783 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19785 (defun org-speed-command-activate (keys)
19786 "Hook for activating single-letter speed commands.
19787 `org-speed-commands-default' specifies a minimal command set.
19788 Use `org-speed-commands-user' for further customization."
19789 (when (or (and (bolp) (looking-at org-outline-regexp))
19790 (and (functionp org-use-speed-commands)
19791 (funcall org-use-speed-commands)))
19792 (cdr (assoc keys (append org-speed-commands-user
19793 org-speed-commands-default)))))
19795 (define-obsolete-function-alias
19796 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19798 (defun org-babel-speed-command-activate (keys)
19799 "Hook for activating single-letter code block commands."
19800 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19801 (cdr (assoc keys org-babel-key-bindings))))
19803 (defcustom org-speed-command-hook
19804 '(org-speed-command-default-hook org-babel-speed-command-hook)
19805 "Hook for activating speed commands at strategic locations.
19806 Hook functions are called in sequence until a valid handler is
19809 Each hook takes a single argument, a user-pressed command key
19810 which is also a `self-insert-command' from the global map.
19812 Within the hook, examine the cursor position and the command key
19813 and return nil or a valid handler as appropriate. Handler could
19814 be one of an interactive command, a function, or a form.
19816 Set `org-use-speed-commands' to non-nil value to enable this
19817 hook. The default setting is `org-speed-command-activate'."
19818 :group 'org-structure
19822 (defun org-self-insert-command (N)
19823 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19824 If the cursor is in a table looking at whitespace, the whitespace is
19825 overwritten, and the table is not marked as requiring realignment."
19827 (org-check-before-invisible-edit 'insert)
19829 ((and org-use-speed-commands
19830 (let ((kv (this-command-keys-vector)))
19831 (setq org-speed-command
19832 (run-hook-with-args-until-success
19833 'org-speed-command-hook
19834 (make-string 1 (aref kv (1- (length kv))))))))
19836 ((commandp org-speed-command)
19837 (setq this-command org-speed-command)
19838 (call-interactively org-speed-command))
19839 ((functionp org-speed-command)
19840 (funcall org-speed-command))
19841 ((and org-speed-command (listp org-speed-command))
19842 (eval org-speed-command))
19843 (t (let (org-use-speed-commands)
19844 (call-interactively 'org-self-insert-command)))))
19848 ;; check if we blank the field, and if that triggers align
19849 (and (featurep 'org-table) org-table-auto-blank-field
19851 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
19852 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19853 ;; got extra space, this field does not determine column width
19854 (let (org-table-may-need-update) (org-table-blank-field))
19855 ;; no extra space, this field may determine column width
19856 (org-table-blank-field)))
19859 (looking-at "[^|\n]* |"))
19860 (let (org-table-may-need-update)
19861 (goto-char (1- (match-end 0)))
19862 (backward-delete-char 1)
19863 (goto-char (match-beginning 0))
19864 (self-insert-command N)))
19866 (setq org-table-may-need-update t)
19867 (self-insert-command N)
19868 (org-fix-tags-on-the-fly)
19869 (if org-self-insert-cluster-for-undo
19870 (if (not (eq last-command 'org-self-insert-command))
19871 (setq org-self-insert-command-undo-counter 1)
19872 (if (>= org-self-insert-command-undo-counter 20)
19873 (setq org-self-insert-command-undo-counter 1)
19874 (and (> org-self-insert-command-undo-counter 0)
19875 buffer-undo-list (listp buffer-undo-list)
19876 (not (cadr buffer-undo-list)) ; remove nil entry
19877 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19878 (setq org-self-insert-command-undo-counter
19879 (1+ org-self-insert-command-undo-counter))))))))
19881 (defun org-check-before-invisible-edit (kind)
19882 "Check is editing if kind KIND would be dangerous with invisible text around.
19883 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19884 ;; First, try to get out of here as quickly as possible, to reduce overhead
19885 (if (and org-catch-invisible-edits
19886 (or (not (boundp 'visible-mode)) (not visible-mode))
19887 (or (get-char-property (point) 'invisible)
19888 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19889 ;; OK, we need to take a closer look
19890 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19891 (invisible-before-point (if (bobp) nil (get-char-property
19892 (1- (point)) 'invisible)))
19893 (border-and-ok-direction
19895 ;; Check if we are acting predictably before invisible text
19896 (and invisible-at-point (not invisible-before-point)
19897 (memq kind '(insert delete-backward)))
19898 ;; Check if we are acting predictably after invisible text
19899 ;; This works not well, and I have turned it off. It seems
19900 ;; better to always show and stop after invisible text.
19901 ;; (and (not invisible-at-point) invisible-before-point
19902 ;; (memq kind '(insert delete)))
19904 (when (or (memq invisible-at-point '(outline org-hide-block t))
19905 (memq invisible-before-point '(outline org-hide-block t)))
19906 (if (eq org-catch-invisible-edits 'error)
19907 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19908 (if (and org-custom-properties-overlays
19909 (y-or-n-p "Display invisible properties in this buffer? "))
19910 (org-toggle-custom-properties-visibility)
19911 ;; Make the area visible
19913 (if invisible-before-point
19914 (goto-char (previous-single-char-property-change
19915 (point) 'invisible)))
19918 ((eq org-catch-invisible-edits 'show)
19919 ;; That's it, we do the edit after showing
19921 "Unfolding invisible region around point before editing")
19923 ((and (eq org-catch-invisible-edits 'smart)
19924 border-and-ok-direction)
19925 (message "Unfolding invisible region around point before editing"))
19927 ;; Don't do the edit, make the user repeat it in full visibility
19928 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19930 (defun org-fix-tags-on-the-fly ()
19931 (when (and (equal (char-after (point-at-bol)) ?*)
19932 (org-at-heading-p))
19933 (org-align-tags-here org-tags-column)))
19935 (defun org-delete-backward-char (N)
19936 "Like `delete-backward-char', insert whitespace at field end in tables.
19937 When deleting backwards, in tables this function will insert whitespace in
19938 front of the next \"|\" separator, to keep the table aligned. The table will
19939 still be marked for re-alignment if the field did fill the entire column,
19940 because, in this case the deletion might narrow the column."
19943 (org-check-before-invisible-edit 'delete-backward)
19944 (if (and (org-table-p)
19946 (string-match "|" (buffer-substring (point-at-bol) (point)))
19947 (looking-at ".*?|"))
19948 (let ((pos (point))
19949 (noalign (looking-at "[^|\n\r]* |"))
19950 (c org-table-may-need-update))
19951 (backward-delete-char N)
19952 (if (not overwrite-mode)
19954 (skip-chars-forward "^|")
19956 (goto-char (1- pos))))
19957 ;; noalign: if there were two spaces at the end, this field
19958 ;; does not determine the width of the column.
19959 (if noalign (setq org-table-may-need-update c)))
19960 (backward-delete-char N)
19961 (org-fix-tags-on-the-fly))))
19963 (defun org-delete-char (N)
19964 "Like `delete-char', but insert whitespace at field end in tables.
19965 When deleting characters, in tables this function will insert whitespace in
19966 front of the next \"|\" separator, to keep the table aligned. The table will
19967 still be marked for re-alignment if the field did fill the entire column,
19968 because, in this case the deletion might narrow the column."
19971 (org-check-before-invisible-edit 'delete)
19972 (if (and (org-table-p)
19974 (not (= (char-after) ?|))
19976 (if (looking-at ".*?|")
19977 (let ((pos (point))
19978 (noalign (looking-at "[^|\n\r]* |"))
19979 (c org-table-may-need-update))
19981 (concat (substring (match-string 0) 1 -1) " |") nil t)
19983 ;; noalign: if there were two spaces at the end, this field
19984 ;; does not determine the width of the column.
19985 (if noalign (setq org-table-may-need-update c)))
19988 (org-fix-tags-on-the-fly))))
19990 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19991 (put 'org-self-insert-command 'delete-selection
19993 (not (run-hook-with-args-until-success
19994 'self-insert-uses-region-functions))))
19995 (put 'orgtbl-self-insert-command 'delete-selection
19997 (not (run-hook-with-args-until-success
19998 'self-insert-uses-region-functions))))
19999 (put 'org-delete-char 'delete-selection 'supersede)
20000 (put 'org-delete-backward-char 'delete-selection 'supersede)
20001 (put 'org-yank 'delete-selection 'yank)
20003 ;; Make `flyspell-mode' delay after some commands
20004 (put 'org-self-insert-command 'flyspell-delayed t)
20005 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20006 (put 'org-delete-char 'flyspell-delayed t)
20007 (put 'org-delete-backward-char 'flyspell-delayed t)
20009 ;; Make pabbrev-mode expand after org-mode commands
20010 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20011 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20013 (defun org-remap (map &rest commands)
20014 "In MAP, remap the functions given in COMMANDS.
20015 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20018 (setq old (pop commands) new (pop commands))
20019 (if (fboundp 'command-remapping)
20020 (org-defkey map (vector 'remap old) new)
20021 (substitute-key-definition old new map global-map)))))
20023 (defun org-transpose-words ()
20024 "Transpose words for Org.
20025 This uses the `org-mode-transpose-word-syntax-table' syntax
20026 table, which interprets characters in `org-emphasis-alist' as
20027 word constituents."
20029 (with-syntax-table org-mode-transpose-word-syntax-table
20030 (call-interactively 'transpose-words)))
20031 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20033 (when (eq org-enable-table-editor 'optimized)
20034 ;; If the user wants maximum table support, we need to hijack
20035 ;; some standard editing functions
20036 (org-remap org-mode-map
20037 'self-insert-command 'org-self-insert-command
20038 'delete-char 'org-delete-char
20039 'delete-backward-char 'org-delete-backward-char)
20040 (org-defkey org-mode-map "|" 'org-force-self-insert))
20042 (defvar org-ctrl-c-ctrl-c-hook nil
20043 "Hook for functions attaching themselves to `C-c C-c'.
20045 This can be used to add additional functionality to the C-c C-c
20046 key which executes context-dependent commands. This hook is run
20047 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20048 run after the last test.
20050 Each function will be called with no arguments. The function
20051 must check if the context is appropriate for it to act. If yes,
20052 it should do its thing and then return a non-nil value. If the
20053 context is wrong, just do nothing and return nil.")
20055 (defvar org-ctrl-c-ctrl-c-final-hook nil
20056 "Hook for functions attaching themselves to `C-c C-c'.
20058 This can be used to add additional functionality to the C-c C-c
20059 key which executes context-dependent commands. This hook is run
20060 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20061 before the first test.
20063 Each function will be called with no arguments. The function
20064 must check if the context is appropriate for it to act. If yes,
20065 it should do its thing and then return a non-nil value. If the
20066 context is wrong, just do nothing and return nil.")
20068 (defvar org-tab-first-hook nil
20069 "Hook for functions to attach themselves to TAB.
20070 See `org-ctrl-c-ctrl-c-hook' for more information.
20071 This hook runs as the first action when TAB is pressed, even before
20072 `org-cycle' messes around with the `outline-regexp' to cater for
20073 inline tasks and plain list item folding.
20074 If any function in this hook returns t, any other actions that
20075 would have been caused by TAB (such as table field motion or visibility
20076 cycling) will not occur.")
20078 (defvar org-tab-after-check-for-table-hook nil
20079 "Hook for functions to attach themselves to TAB.
20080 See `org-ctrl-c-ctrl-c-hook' for more information.
20081 This hook runs after it has been established that the cursor is not in a
20082 table, but before checking if the cursor is in a headline or if global cycling
20084 If any function in this hook returns t, not other actions like visibility
20085 cycling will be done.")
20087 (defvar org-tab-after-check-for-cycling-hook nil
20088 "Hook for functions to attach themselves to TAB.
20089 See `org-ctrl-c-ctrl-c-hook' for more information.
20090 This hook runs after it has been established that not table field motion and
20091 not visibility should be done because of current context. This is probably
20092 the place where a package like yasnippets can hook in.")
20094 (defvar org-tab-before-tab-emulation-hook nil
20095 "Hook for functions to attach themselves to TAB.
20096 See `org-ctrl-c-ctrl-c-hook' for more information.
20097 This hook runs after every other options for TAB have been exhausted, but
20098 before indentation and \t insertion takes place.")
20100 (defvar org-metaleft-hook nil
20101 "Hook for functions attaching themselves to `M-left'.
20102 See `org-ctrl-c-ctrl-c-hook' for more information.")
20103 (defvar org-metaright-hook nil
20104 "Hook for functions attaching themselves to `M-right'.
20105 See `org-ctrl-c-ctrl-c-hook' for more information.")
20106 (defvar org-metaup-hook nil
20107 "Hook for functions attaching themselves to `M-up'.
20108 See `org-ctrl-c-ctrl-c-hook' for more information.")
20109 (defvar org-metadown-hook nil
20110 "Hook for functions attaching themselves to `M-down'.
20111 See `org-ctrl-c-ctrl-c-hook' for more information.")
20112 (defvar org-shiftmetaleft-hook nil
20113 "Hook for functions attaching themselves to `M-S-left'.
20114 See `org-ctrl-c-ctrl-c-hook' for more information.")
20115 (defvar org-shiftmetaright-hook nil
20116 "Hook for functions attaching themselves to `M-S-right'.
20117 See `org-ctrl-c-ctrl-c-hook' for more information.")
20118 (defvar org-shiftmetaup-hook nil
20119 "Hook for functions attaching themselves to `M-S-up'.
20120 See `org-ctrl-c-ctrl-c-hook' for more information.")
20121 (defvar org-shiftmetadown-hook nil
20122 "Hook for functions attaching themselves to `M-S-down'.
20123 See `org-ctrl-c-ctrl-c-hook' for more information.")
20124 (defvar org-metareturn-hook nil
20125 "Hook for functions attaching themselves to `M-RET'.
20126 See `org-ctrl-c-ctrl-c-hook' for more information.")
20127 (defvar org-shiftup-hook nil
20128 "Hook for functions attaching themselves to `S-up'.
20129 See `org-ctrl-c-ctrl-c-hook' for more information.")
20130 (defvar org-shiftup-final-hook nil
20131 "Hook for functions attaching themselves to `S-up'.
20132 This one runs after all other options except shift-select have been excluded.
20133 See `org-ctrl-c-ctrl-c-hook' for more information.")
20134 (defvar org-shiftdown-hook nil
20135 "Hook for functions attaching themselves to `S-down'.
20136 See `org-ctrl-c-ctrl-c-hook' for more information.")
20137 (defvar org-shiftdown-final-hook nil
20138 "Hook for functions attaching themselves to `S-down'.
20139 This one runs after all other options except shift-select have been excluded.
20140 See `org-ctrl-c-ctrl-c-hook' for more information.")
20141 (defvar org-shiftleft-hook nil
20142 "Hook for functions attaching themselves to `S-left'.
20143 See `org-ctrl-c-ctrl-c-hook' for more information.")
20144 (defvar org-shiftleft-final-hook nil
20145 "Hook for functions attaching themselves to `S-left'.
20146 This one runs after all other options except shift-select have been excluded.
20147 See `org-ctrl-c-ctrl-c-hook' for more information.")
20148 (defvar org-shiftright-hook nil
20149 "Hook for functions attaching themselves to `S-right'.
20150 See `org-ctrl-c-ctrl-c-hook' for more information.")
20151 (defvar org-shiftright-final-hook nil
20152 "Hook for functions attaching themselves to `S-right'.
20153 This one runs after all other options except shift-select have been excluded.
20154 See `org-ctrl-c-ctrl-c-hook' for more information.")
20156 (defun org-modifier-cursor-error ()
20157 "Throw an error, a modified cursor command was applied in wrong context."
20158 (user-error "This command is active in special context like tables, headlines or items"))
20160 (defun org-shiftselect-error ()
20161 "Throw an error because Shift-Cursor command was applied in wrong context."
20162 (if (and (boundp 'shift-select-mode) shift-select-mode)
20163 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20164 (user-error "This command works only in special context like headlines or timestamps")))
20166 (defun org-call-for-shift-select (cmd)
20167 (let ((this-command-keys-shift-translated t))
20168 (call-interactively cmd)))
20170 (defun org-shifttab (&optional arg)
20171 "Global visibility cycling or move to previous table field.
20172 Call `org-table-previous-field' within a table.
20173 When ARG is nil, cycle globally through visibility states.
20174 When ARG is a numeric prefix, show contents of this level."
20177 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20179 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20180 (message "Content view to level: %d" arg)
20181 (org-content (prefix-numeric-value arg2))
20182 (org-cycle-show-empty-lines t)
20183 (setq org-cycle-global-status 'overview)))
20184 (t (call-interactively 'org-global-cycle))))
20186 (defun org-shiftmetaleft ()
20187 "Promote subtree or delete table column.
20188 Calls `org-promote-subtree', `org-outdent-item-tree', or
20189 `org-table-delete-column', depending on context. See the
20190 individual commands for more information."
20193 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20194 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20195 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20196 ((if (not (org-region-active-p)) (org-at-item-p)
20197 (save-excursion (goto-char (region-beginning))
20199 (call-interactively 'org-outdent-item-tree))
20200 (t (org-modifier-cursor-error))))
20202 (defun org-shiftmetaright ()
20203 "Demote subtree or insert table column.
20204 Calls `org-demote-subtree', `org-indent-item-tree', or
20205 `org-table-insert-column', depending on context. See the
20206 individual commands for more information."
20209 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20210 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20211 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20212 ((if (not (org-region-active-p)) (org-at-item-p)
20213 (save-excursion (goto-char (region-beginning))
20215 (call-interactively 'org-indent-item-tree))
20216 (t (org-modifier-cursor-error))))
20218 (defun org-shiftmetaup (&optional arg)
20219 "Drag the line at point up.
20220 In a table, kill the current row.
20221 On a clock timestamp, update the value of the timestamp like `S-<up>'
20222 but also adjust the previous clocked item in the clock history.
20223 Everywhere else, drag the line at point up."
20226 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20227 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20228 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20229 (call-interactively 'org-timestamp-up)))
20230 (t (call-interactively 'org-drag-line-backward))))
20232 (defun org-shiftmetadown (&optional arg)
20233 "Drag the line at point down.
20234 In a table, insert an empty row at the current line.
20235 On a clock timestamp, update the value of the timestamp like `S-<down>'
20236 but also adjust the previous clocked item in the clock history.
20237 Everywhere else, drag the line at point down."
20240 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20241 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20242 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20243 (call-interactively 'org-timestamp-down)))
20244 (t (call-interactively 'org-drag-line-forward))))
20246 (defsubst org-hidden-tree-error ()
20248 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20250 (defun org-metaleft (&optional arg)
20251 "Promote heading or move table column to left.
20252 Calls `org-do-promote' or `org-table-move-column', depending on context.
20253 With no specific context, calls the Emacs default `backward-word'.
20254 See the individual commands for more information."
20257 ((run-hook-with-args-until-success 'org-metaleft-hook))
20258 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20259 ((org-with-limited-levels
20260 (or (org-at-heading-p)
20261 (and (org-region-active-p)
20263 (goto-char (region-beginning))
20264 (org-at-heading-p)))))
20265 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20266 (call-interactively 'org-do-promote))
20267 ;; At an inline task.
20268 ((org-at-heading-p)
20269 (call-interactively 'org-inlinetask-promote))
20270 ((or (org-at-item-p)
20271 (and (org-region-active-p)
20273 (goto-char (region-beginning))
20275 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20276 (call-interactively 'org-outdent-item))
20277 (t (call-interactively 'backward-word))))
20279 (defun org-metaright (&optional arg)
20280 "Demote a subtree, a list item or move table column to right.
20281 In front of a drawer or a block keyword, indent it correctly.
20282 With no specific context, calls the Emacs default `forward-word'.
20283 See the individual commands for more information."
20286 ((run-hook-with-args-until-success 'org-metaright-hook))
20287 ((org-at-table-p) (call-interactively 'org-table-move-column))
20288 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20289 ((org-at-block-p) (call-interactively 'org-indent-block))
20290 ((org-with-limited-levels
20291 (or (org-at-heading-p)
20292 (and (org-region-active-p)
20294 (goto-char (region-beginning))
20295 (org-at-heading-p)))))
20296 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20297 (call-interactively 'org-do-demote))
20298 ;; At an inline task.
20299 ((org-at-heading-p)
20300 (call-interactively 'org-inlinetask-demote))
20301 ((or (org-at-item-p)
20302 (and (org-region-active-p)
20304 (goto-char (region-beginning))
20306 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20307 (call-interactively 'org-indent-item))
20308 (t (call-interactively 'forward-word))))
20310 (defun org-check-for-hidden (what)
20311 "Check if there are hidden headlines/items in the current visual line.
20312 WHAT can be either `headlines' or `items'. If the current line is
20313 an outline or item heading and it has a folded subtree below it,
20314 this function returns t, nil otherwise."
20316 ((eq what 'headlines) org-outline-regexp-bol)
20317 ((eq what 'items) (org-item-beginning-re))
20318 (t (error "This should not happen"))))
20322 (unless (org-region-active-p)
20323 (setq beg (point-at-bol))
20324 (beginning-of-line 2)
20325 (while (and (not (eobp)) ;; this is like `next-line'
20326 (get-char-property (1- (point)) 'invisible))
20327 (beginning-of-line 2))
20330 (goto-char (point-at-eol))
20331 (setq end (max end (point)))
20332 (while (re-search-forward re end t)
20333 (if (get-char-property (match-beginning 0) 'invisible)
20337 (defun org-metaup (&optional arg)
20338 "Move subtree up or move table row up.
20339 Calls `org-move-subtree-up' or `org-table-move-row' or
20340 `org-move-item-up', depending on context. See the individual commands
20341 for more information."
20344 ((run-hook-with-args-until-success 'org-metaup-hook))
20345 ((org-region-active-p)
20346 (let* ((a (min (region-beginning) (region-end)))
20347 (b (1- (max (region-beginning) (region-end))))
20348 (c (save-excursion (goto-char a)
20349 (move-beginning-of-line 0)))
20350 (d (save-excursion (goto-char a)
20351 (move-end-of-line 0) (point))))
20352 (transpose-regions a b c d)
20354 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20355 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20356 ((org-at-item-p) (call-interactively 'org-move-item-up))
20357 (t (org-drag-element-backward))))
20359 (defun org-metadown (&optional arg)
20360 "Move subtree down or move table row down.
20361 Calls `org-move-subtree-down' or `org-table-move-row' or
20362 `org-move-item-down', depending on context. See the individual
20363 commands for more information."
20366 ((run-hook-with-args-until-success 'org-metadown-hook))
20367 ((org-region-active-p)
20368 (let* ((a (min (region-beginning) (region-end)))
20369 (b (max (region-beginning) (region-end)))
20370 (c (save-excursion (goto-char b)
20371 (move-beginning-of-line 1)))
20372 (d (save-excursion (goto-char b)
20373 (move-end-of-line 1) (1+ (point)))))
20374 (transpose-regions a b c d)
20376 ((org-at-table-p) (call-interactively 'org-table-move-row))
20377 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20378 ((org-at-item-p) (call-interactively 'org-move-item-down))
20379 (t (org-drag-element-forward))))
20381 (defun org-shiftup (&optional arg)
20382 "Increase item in timestamp or increase priority of current headline.
20383 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20384 depending on context. See the individual commands for more information."
20387 ((run-hook-with-args-until-success 'org-shiftup-hook))
20388 ((and org-support-shift-select (org-region-active-p))
20389 (org-call-for-shift-select 'previous-line))
20390 ((org-at-timestamp-p t)
20391 (call-interactively (if org-edit-timestamp-down-means-later
20392 'org-timestamp-down 'org-timestamp-up)))
20393 ((and (not (eq org-support-shift-select 'always))
20394 org-enable-priority-commands
20395 (org-at-heading-p))
20396 (call-interactively 'org-priority-up))
20397 ((and (not org-support-shift-select) (org-at-item-p))
20398 (call-interactively 'org-previous-item))
20399 ((org-clocktable-try-shift 'up arg))
20400 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20401 (org-support-shift-select
20402 (org-call-for-shift-select 'previous-line))
20403 (t (org-shiftselect-error))))
20405 (defun org-shiftdown (&optional arg)
20406 "Decrease item in timestamp or decrease priority of current headline.
20407 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20408 depending on context. See the individual commands for more information."
20411 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20412 ((and org-support-shift-select (org-region-active-p))
20413 (org-call-for-shift-select 'next-line))
20414 ((org-at-timestamp-p t)
20415 (call-interactively (if org-edit-timestamp-down-means-later
20416 'org-timestamp-up 'org-timestamp-down)))
20417 ((and (not (eq org-support-shift-select 'always))
20418 org-enable-priority-commands
20419 (org-at-heading-p))
20420 (call-interactively 'org-priority-down))
20421 ((and (not org-support-shift-select) (org-at-item-p))
20422 (call-interactively 'org-next-item))
20423 ((org-clocktable-try-shift 'down arg))
20424 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20425 (org-support-shift-select
20426 (org-call-for-shift-select 'next-line))
20427 (t (org-shiftselect-error))))
20429 (defun org-shiftright (&optional arg)
20430 "Cycle the thing at point or in the current line, depending on context.
20431 Depending on context, this does one of the following:
20433 - switch a timestamp at point one day into the future
20434 - on a headline, switch to the next TODO keyword.
20435 - on an item, switch entire list to the next bullet type
20436 - on a property line, switch to the next allowed value
20437 - on a clocktable definition line, move time block into the future"
20440 ((run-hook-with-args-until-success 'org-shiftright-hook))
20441 ((and org-support-shift-select (org-region-active-p))
20442 (org-call-for-shift-select 'forward-char))
20443 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20444 ((and (not (eq org-support-shift-select 'always))
20445 (org-at-heading-p))
20446 (let ((org-inhibit-logging
20447 (not org-treat-S-cursor-todo-selection-as-state-change))
20448 (org-inhibit-blocking
20449 (not org-treat-S-cursor-todo-selection-as-state-change)))
20450 (org-call-with-arg 'org-todo 'right)))
20451 ((or (and org-support-shift-select
20452 (not (eq org-support-shift-select 'always))
20453 (org-at-item-bullet-p))
20454 (and (not org-support-shift-select) (org-at-item-p)))
20455 (org-call-with-arg 'org-cycle-list-bullet nil))
20456 ((and (not (eq org-support-shift-select 'always))
20457 (org-at-property-p))
20458 (call-interactively 'org-property-next-allowed-value))
20459 ((org-clocktable-try-shift 'right arg))
20460 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20461 (org-support-shift-select
20462 (org-call-for-shift-select 'forward-char))
20463 (t (org-shiftselect-error))))
20465 (defun org-shiftleft (&optional arg)
20466 "Cycle the thing at point or in the current line, depending on context.
20467 Depending on context, this does one of the following:
20469 - switch a timestamp at point one day into the past
20470 - on a headline, switch to the previous TODO keyword.
20471 - on an item, switch entire list to the previous bullet type
20472 - on a property line, switch to the previous allowed value
20473 - on a clocktable definition line, move time block into the past"
20476 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20477 ((and org-support-shift-select (org-region-active-p))
20478 (org-call-for-shift-select 'backward-char))
20479 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20480 ((and (not (eq org-support-shift-select 'always))
20481 (org-at-heading-p))
20482 (let ((org-inhibit-logging
20483 (not org-treat-S-cursor-todo-selection-as-state-change))
20484 (org-inhibit-blocking
20485 (not org-treat-S-cursor-todo-selection-as-state-change)))
20486 (org-call-with-arg 'org-todo 'left)))
20487 ((or (and org-support-shift-select
20488 (not (eq org-support-shift-select 'always))
20489 (org-at-item-bullet-p))
20490 (and (not org-support-shift-select) (org-at-item-p)))
20491 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20492 ((and (not (eq org-support-shift-select 'always))
20493 (org-at-property-p))
20494 (call-interactively 'org-property-previous-allowed-value))
20495 ((org-clocktable-try-shift 'left arg))
20496 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20497 (org-support-shift-select
20498 (org-call-for-shift-select 'backward-char))
20499 (t (org-shiftselect-error))))
20501 (defun org-shiftcontrolright ()
20502 "Switch to next TODO set."
20505 ((and org-support-shift-select (org-region-active-p))
20506 (org-call-for-shift-select 'forward-word))
20507 ((and (not (eq org-support-shift-select 'always))
20508 (org-at-heading-p))
20509 (org-call-with-arg 'org-todo 'nextset))
20510 (org-support-shift-select
20511 (org-call-for-shift-select 'forward-word))
20512 (t (org-shiftselect-error))))
20514 (defun org-shiftcontrolleft ()
20515 "Switch to previous TODO set."
20518 ((and org-support-shift-select (org-region-active-p))
20519 (org-call-for-shift-select 'backward-word))
20520 ((and (not (eq org-support-shift-select 'always))
20521 (org-at-heading-p))
20522 (org-call-with-arg 'org-todo 'previousset))
20523 (org-support-shift-select
20524 (org-call-for-shift-select 'backward-word))
20525 (t (org-shiftselect-error))))
20527 (defun org-shiftcontrolup (&optional n)
20528 "Change timestamps synchronously up in CLOCK log lines.
20529 Optional argument N tells to change by that many units."
20531 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20532 (let (org-support-shift-select)
20533 (org-clock-timestamps-up n))
20534 (user-error "Not at a clock log")))
20536 (defun org-shiftcontroldown (&optional n)
20537 "Change timestamps synchronously down in CLOCK log lines.
20538 Optional argument N tells to change by that many units."
20540 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20541 (let (org-support-shift-select)
20542 (org-clock-timestamps-down n))
20543 (user-error "Not at a clock log")))
20545 (defun org-increase-number-at-point (&optional inc)
20546 "Increment the number at point.
20547 With an optional prefix numeric argument INC, increment using
20548 this numeric value."
20550 (if (not (number-at-point))
20551 (user-error "Not on a number")
20552 (unless inc (setq inc 1))
20553 (let ((pos (point))
20554 (beg (skip-chars-backward "-+^/*0-9eE."))
20555 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20556 (setq nap (buffer-substring-no-properties
20557 (+ pos beg) (+ pos beg end)))
20558 (delete-region (+ pos beg) (+ pos beg end))
20559 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20560 (when (org-at-table-p)
20562 (org-table-end-of-field 1))))
20564 (defun org-decrease-number-at-point (&optional inc)
20565 "Decrement the number at point.
20566 With an optional prefix numeric argument INC, decrement using
20567 this numeric value."
20569 (org-increase-number-at-point (- inc)))
20571 (defun org-ctrl-c-ret ()
20572 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20575 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20576 (t (call-interactively 'org-insert-heading))))
20578 (defun org-find-visible ()
20580 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20581 (get-char-property s 'invisible)))
20583 (defun org-find-invisible ()
20585 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20586 (not (get-char-property s 'invisible))))
20589 (defun org-copy-visible (beg end)
20590 "Copy the visible parts of the region."
20595 (narrow-to-region beg end)
20596 (setq s (goto-char (point-min)))
20597 (while (not (= (point) (point-max)))
20598 (goto-char (org-find-invisible))
20599 (push (buffer-substring s (point)) snippets)
20600 (setq s (goto-char (org-find-visible))))))
20601 (kill-new (apply 'concat (nreverse snippets)))))
20603 (defun org-copy-special ()
20604 "Copy region in table or copy current subtree.
20605 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20606 See the individual commands for more information."
20608 (call-interactively
20609 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20611 (defun org-cut-special ()
20612 "Cut region in table or cut current subtree.
20613 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20614 See the individual commands for more information."
20616 (call-interactively
20617 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20619 (defun org-paste-special (arg)
20620 "Paste rectangular region into table, or past subtree relative to level.
20621 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20622 See the individual commands for more information."
20624 (if (org-at-table-p)
20625 (org-table-paste-rectangle)
20626 (org-paste-subtree arg)))
20628 (defsubst org-in-fixed-width-region-p ()
20629 "Is point in a fixed-width region?"
20631 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20633 (defun org-edit-special (&optional arg)
20634 "Call a special editor for the element at point.
20635 When at a table, call the formula editor with `org-table-edit-formulas'.
20636 When in a source code block, call `org-edit-src-code'.
20637 When in a fixed-width region, call `org-edit-fixed-width-region'.
20638 When in an export block, call `org-edit-export-block'.
20639 When at an #+INCLUDE keyword, visit the included file.
20640 On a link, call `ffap' to visit the link at point.
20641 Otherwise, return a user error."
20643 (let ((element (org-element-at-point)))
20644 (assert (not buffer-read-only) nil
20645 "Buffer is read-only: %s" (buffer-name))
20646 (case (org-element-type element)
20648 (if (not arg) (org-edit-src-code)
20649 (let* ((info (org-babel-get-src-block-info))
20650 (lang (nth 0 info))
20651 (params (nth 2 info))
20652 (session (cdr (assq :session params))))
20653 (if (not session) (org-edit-src-code)
20654 ;; At a src-block with a session and function called with
20655 ;; an ARG: switch to the buffer related to the inferior
20658 (funcall (intern (concat "org-babel-prep-session:" lang))
20659 session params))))))
20661 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20662 (org-open-link-from-string
20665 (let ((value (org-element-property :value element)))
20666 (cond ((not (org-string-nw-p value))
20667 (user-error "No file to edit"))
20668 ((string-match "\\`\"\\(.*?\\)\"" value)
20669 (match-string 1 value))
20670 ((string-match "\\`[^ \t\"]\\S-*" value)
20671 (match-string 0 value))
20672 (t (user-error "No valid file specified")))))))
20673 (user-error "No special environment to edit here")))
20675 (if (eq (org-element-property :type element) 'table.el)
20676 (org-edit-table.el)
20677 (call-interactively 'org-table-edit-formulas)))
20678 ;; Only Org tables contain `table-row' type elements.
20679 (table-row (call-interactively 'org-table-edit-formulas))
20680 ((example-block src-block) (org-edit-src-code))
20681 (export-block (org-edit-export-block))
20682 (fixed-width (org-edit-fixed-width-region))
20684 ;; No notable element at point. Though, we may be at a link,
20685 ;; which is an object. Thus, scan deeper.
20686 (if (eq (org-element-type (org-element-context element)) 'link)
20687 (call-interactively 'ffap)
20688 (user-error "No special environment to edit here"))))))
20690 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20691 (defun org-ctrl-c-ctrl-c (&optional arg)
20692 "Set tags in headline, or update according to changed information at point.
20694 This command does many different things, depending on context:
20696 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20697 this is what we do.
20699 - If the cursor is on a statistics cookie, update it.
20701 - If the cursor is in a headline, prompt for tags and insert them
20702 into the current line, aligned to `org-tags-column'. When called
20703 with prefix arg, realign all tags in the current buffer.
20705 - If the cursor is in one of the special #+KEYWORD lines, this
20706 triggers scanning the buffer for these lines and updating the
20709 - If the cursor is inside a table, realign the table. This command
20710 works even if the automatic table editor has been turned off.
20712 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20715 - If the cursor is at a footnote reference or definition, jump to
20716 the corresponding definition or references, respectively.
20718 - If the cursor is a the beginning of a dynamic block, update it.
20720 - If the current buffer is a capture buffer, close note and file it.
20722 - If the cursor is on a <<<target>>>, update radio targets and
20723 corresponding links in this buffer.
20725 - If the cursor is on a numbered item in a plain list, renumber the
20728 - If the cursor is on a checkbox, toggle it.
20730 - If the cursor is on a code block, evaluate it. The variable
20731 `org-confirm-babel-evaluate' can be used to control prompting
20732 before code block evaluation, by default every code block
20733 evaluation requires confirmation. Code block evaluation can be
20734 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20737 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20738 org-occur-highlights)
20739 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20740 (org-remove-occur-highlights)
20741 (message "Temporary highlights/overlays removed from current buffer"))
20742 ((and (local-variable-p 'org-finish-function (current-buffer))
20743 (fboundp org-finish-function))
20744 (funcall org-finish-function))
20745 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20747 (let* ((context (org-element-context)) (type (org-element-type context)))
20748 ;; Test if point is within a blank line.
20749 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20750 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20751 (user-error "C-c C-c can do nothing useful at this location"))
20753 ;; When at a link, act according to the parent instead.
20754 (link (setq context (org-element-property :parent context))
20755 (setq type (org-element-type context)))
20756 ;; Unsupported object types: refer to the first supported
20757 ;; element or object containing it.
20758 ((bold code entity export-snippet inline-babel-call inline-src-block
20759 italic latex-fragment line-break macro strike-through subscript
20760 superscript underline verbatim)
20761 (while (and (setq context (org-element-property :parent context))
20762 (not (memq (setq type (org-element-type context))
20763 '(radio-target paragraph verse-block
20765 ;; For convenience: at the first line of a paragraph on the
20766 ;; same line as an item, apply function on that item instead.
20767 (when (eq type 'paragraph)
20768 (let ((parent (org-element-property :parent context)))
20769 (when (and (eq (org-element-type parent) 'item)
20770 (= (point-at-bol) (org-element-property :begin parent)))
20771 (setq context parent type 'item))))
20772 ;; Act according to type of element or object at point.
20774 (clock (org-clock-update-time-maybe))
20777 (goto-char (org-element-property :post-affiliated context))
20778 (org-update-dblock)))
20779 (footnote-definition
20780 (goto-char (org-element-property :post-affiliated context))
20781 (call-interactively 'org-footnote-action))
20782 (footnote-reference (call-interactively 'org-footnote-action))
20783 ((headline inlinetask)
20784 (save-excursion (goto-char (org-element-property :begin context))
20785 (call-interactively 'org-set-tags)))
20787 ;; At an item: a double C-u set checkbox to "[-]"
20788 ;; unconditionally, whereas a single one will toggle its
20789 ;; presence. Without an universal argument, if the item
20790 ;; has a checkbox, toggle it. Otherwise repair the list.
20791 (let* ((box (org-element-property :checkbox context))
20792 (struct (org-element-property :structure context))
20793 (old-struct (copy-tree struct))
20794 (parents (org-list-parents-alist struct))
20795 (prevs (org-list-prevs-alist struct))
20796 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20797 (org-list-set-checkbox
20798 (org-element-property :begin context) struct
20799 (cond ((equal arg '(16)) "[-]")
20800 ((and (not box) (equal arg '(4))) "[ ]")
20801 ((or (not box) (equal arg '(4))) nil)
20802 ((eq box 'on) "[ ]")
20804 ;; Mimic `org-list-write-struct' but with grabbing
20805 ;; a return value from `org-list-struct-fix-box'.
20806 (org-list-struct-fix-ind struct parents 2)
20807 (org-list-struct-fix-item-end struct)
20808 (org-list-struct-fix-bul struct prevs)
20809 (org-list-struct-fix-ind struct parents)
20811 (org-list-struct-fix-box struct parents prevs orderedp)))
20812 (if (and box (equal struct old-struct))
20813 (if (equal arg '(16))
20814 (message "Checkboxes already reset")
20815 (user-error "Cannot toggle this checkbox: %s"
20817 "all subitems checked"
20818 "unchecked subitems")))
20819 (org-list-struct-apply-struct struct old-struct)
20820 (org-update-checkbox-count-maybe))
20822 (message "Checkboxes were removed due to empty box at line %d"
20823 (org-current-line block-item))))))
20825 (let ((org-inhibit-startup-visibility-stuff t)
20826 (org-startup-align-all-tables nil))
20827 (when (boundp 'org-table-coordinate-overlays)
20828 (mapc 'delete-overlay org-table-coordinate-overlays)
20829 (setq org-table-coordinate-overlays nil))
20830 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20831 (message "Local setup has been refreshed"))
20833 ;; At a plain list, with a double C-u argument, set
20834 ;; checkboxes of each item to "[-]", whereas a single one
20835 ;; will toggle their presence according to the state of the
20836 ;; first item in the list. Without an argument, repair the
20838 (let* ((begin (org-element-property :contents-begin context))
20839 (beginm (move-marker (make-marker) begin))
20840 (struct (org-element-property :structure context))
20841 (old-struct (copy-tree struct))
20842 (first-box (save-excursion
20844 (looking-at org-list-full-item-re)
20845 (match-string-no-properties 3)))
20846 (new-box (cond ((equal arg '(16)) "[-]")
20847 ((equal arg '(4)) (unless first-box "[ ]"))
20848 ((equal first-box "[X]") "[ ]")
20852 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20853 (org-list-get-all-items
20854 begin struct (org-list-prevs-alist struct))))
20855 ((and first-box (eq (point) begin))
20856 ;; For convenience, when point is at bol on the first
20857 ;; item of the list and no argument is provided, simply
20858 ;; toggle checkbox of that item, if any.
20859 (org-list-set-checkbox begin struct new-box)))
20860 (org-list-write-struct
20861 struct (org-list-parents-alist struct) old-struct)
20862 (org-update-checkbox-count-maybe)
20863 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20864 ((property-drawer node-property)
20865 (call-interactively 'org-property-action))
20866 ((radio-target target)
20867 (call-interactively 'org-update-radio-target-regexp))
20869 (call-interactively 'org-update-statistics-cookies))
20870 ((table table-cell table-row)
20871 ;; At a table, recalculate every field and align it. Also
20872 ;; send the table if necessary. If the table has
20873 ;; a `table.el' type, just give up. At a table row or
20874 ;; cell, maybe recalculate line but always align table.
20875 (if (eq (org-element-property :type context) 'table.el)
20876 (message "Use C-c ' to edit table.el tables")
20877 (let ((org-enable-table-editor t))
20878 (if (or (eq type 'table)
20879 ;; Check if point is at a TBLFM line.
20880 (and (eq type 'table-row)
20881 (= (point) (org-element-property :end context))))
20883 (if (org-at-TBLFM-p)
20884 (progn (require 'org-table)
20885 (org-table-calc-current-TBLFM))
20886 (goto-char (org-element-property :contents-begin context))
20887 (org-call-with-arg 'org-table-recalculate (or arg t))
20888 (orgtbl-send-table 'maybe)))
20889 (org-table-maybe-eval-formula)
20890 (cond (arg (call-interactively 'org-table-recalculate))
20891 ((org-table-maybe-recalculate-line))
20892 (t (org-table-align)))))))
20893 (timestamp (org-timestamp-change 0 'day))
20895 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20897 "C-c C-c can do nothing useful at this location")))))))))
20899 (defun org-mode-restart ()
20901 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20902 (funcall major-mode)
20903 (hack-local-variables)
20904 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20905 (org-indent-mode -1)))
20906 (message "%s restarted" major-mode))
20908 (defun org-kill-note-or-show-branches ()
20909 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20911 (if (not org-finish-function)
20914 (call-interactively 'show-branches))
20915 (let ((org-note-abort t))
20916 (funcall org-finish-function))))
20918 (defun org-open-line (n)
20919 "Insert a new row in tables, call `open-line' elsewhere.
20920 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20923 ((not org-special-ctrl-o)
20926 (org-table-insert-row))
20930 (defun org-return (&optional indent)
20931 "Goto next table row or insert a newline.
20933 Calls `org-table-next-row' or `newline', depending on context.
20935 When optional INDENT argument is non-nil, call
20936 `newline-and-indent' instead of `newline'.
20938 When `org-return-follows-link' is non-nil and point is on
20939 a timestamp or a link, call `org-open-at-point'. However, it
20940 will not happen if point is in a table or on a \"dead\"
20941 object (e.g., within a comment). In these case, you need to use
20942 `org-open-at-point' directly."
20944 (if (and (save-excursion
20945 (beginning-of-line)
20946 (looking-at org-todo-line-regexp))
20947 (match-beginning 3)
20948 (>= (point) (match-beginning 3)))
20949 ;; Point is on headline tags. Do not break them: add a newline
20950 ;; after the headline instead.
20951 (progn (org-show-entry)
20953 (if indent (newline-and-indent) (newline)))
20954 (let* ((context (if org-return-follows-link (org-element-context)
20955 (org-element-at-point)))
20956 (type (org-element-type context)))
20958 ;; In a table, call `org-table-next-row'.
20959 ((or (and (eq type 'table)
20960 (>= (point) (org-element-property :contents-begin context))
20961 (< (point) (org-element-property :contents-end context)))
20962 (org-element-lineage context '(table-row table-cell) t))
20963 (org-table-justify-field-maybe)
20964 (call-interactively #'org-table-next-row))
20965 ;; On a link or a timestamp but not on white spaces after it,
20966 ;; call `org-open-line' if `org-return-follows-link' allows it.
20967 ((and org-return-follows-link
20968 (memq type '(link timestamp))
20970 (save-excursion (goto-char (org-element-property :end context))
20971 (skip-chars-backward " \t")
20973 (call-interactively #'org-open-at-point))
20974 ;; In a list, make sure indenting keeps trailing text within.
20977 (org-element-lineage context '(item plain-list) t))
20978 (let ((trailing-data
20979 (delete-and-extract-region (point) (line-end-position))))
20980 (newline-and-indent)
20981 (save-excursion (insert trailing-data))))
20982 (t (if indent (newline-and-indent) (newline)))))))
20984 (defun org-return-indent ()
20985 "Goto next table row or insert a newline and indent.
20986 Calls `org-table-next-row' or `newline-and-indent', depending on
20987 context. See the individual commands for more information."
20991 (defun org-ctrl-c-star ()
20992 "Compute table, or change heading status of lines.
20993 Calls `org-table-recalculate' or `org-toggle-heading',
20994 depending on context."
20998 (call-interactively 'org-table-recalculate))
21000 ;; Convert all lines in region to list items
21001 (call-interactively 'org-toggle-heading))))
21003 (defun org-ctrl-c-minus ()
21004 "Insert separator line in table or modify bullet status of line.
21005 Also turns a plain line or a region of lines into list items.
21006 Calls `org-table-insert-hline', `org-toggle-item', or
21007 `org-cycle-list-bullet', depending on context."
21011 (call-interactively 'org-table-insert-hline))
21012 ((org-region-active-p)
21013 (call-interactively 'org-toggle-item))
21015 (call-interactively 'org-cycle-list-bullet))
21017 (call-interactively 'org-toggle-item))))
21019 (defun org-toggle-item (arg)
21020 "Convert headings or normal lines to items, items to normal lines.
21021 If there is no active region, only the current line is considered.
21023 If the first non blank line in the region is a headline, convert
21024 all headlines to items, shifting text accordingly.
21026 If it is an item, convert all items to normal lines.
21028 If it is normal text, change region into a list of items.
21029 With a prefix argument ARG, change the region in a single item."
21033 ;; Shift text in current section to IND, from point to END.
21034 ;; The function leaves point to END line.
21036 (let ((min-i 1000) (end (copy-marker end)))
21037 ;; First determine the minimum indentation (MIN-I) of
21041 (while (< (point) end)
21042 (let ((i (org-get-indentation)))
21044 ;; Skip blank lines and inline tasks.
21045 ((looking-at "^[ \t]*$"))
21046 ((looking-at org-outline-regexp-bol))
21047 ;; We can't find less than 0 indentation.
21048 ((zerop i) (throw 'exit (setq min-i 0)))
21049 ((< i min-i) (setq min-i i))))
21051 ;; Then indent each line so that a line indented to
21052 ;; MIN-I becomes indented to IND. Ignore blank lines
21053 ;; and inline tasks in the process.
21054 (let ((delta (- ind min-i)))
21055 (while (< (point) end)
21056 (unless (or (looking-at "^[ \t]*$")
21057 (looking-at org-outline-regexp-bol))
21058 (org-indent-line-to (+ (org-get-indentation) delta)))
21059 (forward-line)))))))
21062 ;; Return beginning of first non-blank line, starting from
21067 (skip-chars-forward " \r\t\n")
21070 ;; Determine boundaries of changes.
21071 (if (org-region-active-p)
21072 (setq beg (funcall skip-blanks (region-beginning))
21073 end (copy-marker (region-end)))
21074 (setq beg (funcall skip-blanks (point-at-bol))
21075 end (copy-marker (point-at-eol))))
21076 ;; Depending on the starting line, choose an action on the text
21077 ;; between BEG and END.
21078 (org-with-limited-levels
21082 ;; Case 1. Start at an item: de-itemize. Note that it only
21083 ;; happens when a region is active: `org-ctrl-c-minus'
21084 ;; would call `org-cycle-list-bullet' otherwise.
21086 (while (< (point) end)
21087 (when (org-at-item-p)
21088 (skip-chars-forward " \t")
21089 (delete-region (point) (match-end 0)))
21091 ;; Case 2. Start at an heading: convert to items.
21092 ((org-at-heading-p)
21093 (let* ((bul (org-list-bullet-string "-"))
21094 (bul-len (length bul))
21095 (done (org-entry-is-done-p))
21096 (todo (org-entry-is-todo-p))
21097 ;; Indentation of the first heading. It should be
21098 ;; relative to the indentation of its parent, if any.
21099 (start-ind (save-excursion
21101 ((not org-adapt-indentation) 0)
21102 ((not (outline-previous-heading)) 0)
21103 (t (length (match-string 0))))))
21104 ;; Level of first heading. Further headings will be
21105 ;; compared to it to determine hierarchy in the list.
21106 (ref-level (org-reduced-level (org-outline-level))))
21107 (when (or done todo) (org-todo ""))
21108 (while (< (point) end)
21109 (let* ((level (org-reduced-level (org-outline-level)))
21110 (delta (max 0 (- level ref-level))))
21111 ;; If current headline is less indented than the first
21112 ;; one, set it as reference, in order to preserve
21114 (when (< level ref-level) (setq ref-level level))
21115 (replace-match bul t t)
21116 (org-indent-line-to (+ start-ind (* delta bul-len)))
21117 (when (or done todo)
21118 (let* ((struct (org-list-struct))
21119 (old (copy-tree struct)))
21120 (org-list-set-checkbox (line-beginning-position)
21122 (if done "[X]" "[ ]"))
21123 (org-list-write-struct struct
21124 (org-list-parents-alist struct)
21126 ;; Ensure all text down to END (or SECTION-END) belongs
21127 ;; to the newly created item.
21128 (let ((section-end (save-excursion
21129 (or (outline-next-heading) (point)))))
21131 (funcall shift-text
21132 (+ start-ind (* (1+ delta) bul-len))
21133 (min end section-end)))))))
21134 ;; Case 3. Normal line with ARG: make the first line of region
21135 ;; an item, and shift indentation of others lines to
21136 ;; set them as item's body.
21137 (arg (let* ((bul (org-list-bullet-string "-"))
21138 (bul-len (length bul))
21139 (ref-ind (org-get-indentation)))
21140 (skip-chars-forward " \t")
21143 (while (< (point) end)
21144 ;; Ensure that lines less indented than first one
21145 ;; still get included in item body.
21146 (funcall shift-text
21147 (+ ref-ind bul-len)
21148 (min end (save-excursion (or (outline-next-heading)
21151 ;; Case 4. Normal line without ARG: turn each non-item line
21154 (while (< (point) end)
21155 (unless (or (org-at-heading-p) (org-at-item-p))
21156 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21158 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21159 (forward-line))))))))
21161 (defun org-toggle-heading (&optional nstars)
21162 "Convert headings to normal text, or items or text to headings.
21163 If there is no active region, only convert the current line.
21165 With a \\[universal-argument] prefix, convert the whole list at
21166 point into heading.
21170 - If the first non blank line is a headline, remove the stars
21171 from all headlines in the region.
21173 - If it is a normal line, turn each and every normal line (i.e.,
21174 not an heading or an item) in the region into headings. If you
21175 want to convert only the first line of this region, use one
21176 universal prefix argument.
21178 - If it is a plain list item, turn all plain list items into headings.
21180 When converting a line into a heading, the number of stars is chosen
21181 such that the lines become children of the current entry. However,
21182 when a numeric prefix argument is given, its value determines the
21183 number of stars to add."
21187 ;; Return beginning of first non-blank line, starting from
21192 (while (org-at-comment-p) (forward-line))
21193 (skip-chars-forward " \r\t\n")
21196 ;; Determine boundaries of changes. If a universal prefix has
21197 ;; been given, put the list in a region. If region ends at a bol,
21198 ;; do not consider the last line to be in the region.
21200 (when (and current-prefix-arg (org-at-item-p))
21201 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21202 (org-mark-element))
21204 (if (org-region-active-p)
21205 (setq beg (funcall skip-blanks (region-beginning))
21206 end (copy-marker (save-excursion
21207 (goto-char (region-end))
21208 (if (bolp) (point) (point-at-eol)))))
21209 (setq beg (funcall skip-blanks (point-at-bol))
21210 end (copy-marker (point-at-eol))))
21211 ;; Ensure inline tasks don't count as headings.
21212 (org-with-limited-levels
21216 ;; Case 1. Started at an heading: de-star headings.
21217 ((org-at-heading-p)
21218 (while (< (point) end)
21219 (when (org-at-heading-p t)
21220 (looking-at org-outline-regexp) (replace-match "")
21223 ;; Case 2. Started at an item: change items into headlines.
21224 ;; One star will be added by `org-list-to-subtree'.
21226 (while (< (point) end)
21227 (when (org-at-item-p)
21228 ;; Pay attention to cases when region ends before list.
21229 (let* ((struct (org-list-struct))
21230 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21232 (narrow-to-region (point) list-end)
21233 (insert (org-list-to-subtree (org-list-parse-list t)))))
21236 ;; Case 3. Started at normal text: make every line an heading,
21237 ;; skipping headlines and items.
21240 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21242 (cond (nstars "") ; stars from prefix only
21243 ((equal stars "") "*") ; before first heading
21244 (org-odd-levels-only "**") ; inside heading, odd
21245 (t "*"))) ; inside heading, oddeven
21246 (rpl (concat stars add-stars " "))
21247 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21248 (while (< (point) (if (equal nstars '(4)) lend end))
21249 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21250 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21251 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21252 (forward-line)))))))
21253 (unless toggled (message "Cannot toggle heading from here"))))
21255 (defun org-meta-return (&optional arg)
21256 "Insert a new heading or wrap a region in a table.
21257 Calls `org-insert-heading' or `org-table-wrap-region', depending
21258 on context. See the individual commands for more information."
21260 (org-check-before-invisible-edit 'insert)
21261 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21262 (let* ((element (org-element-at-point))
21263 (type (org-element-type element)))
21264 (when (eq type 'table-row)
21265 (setq element (org-element-property :parent element))
21266 (setq type 'table))
21267 (if (and (eq type 'table)
21268 (eq (org-element-property :type element) 'org)
21269 (>= (point) (org-element-property :contents-begin element))
21270 (< (point) (org-element-property :contents-end element)))
21271 (call-interactively 'org-table-wrap-region)
21272 (call-interactively 'org-insert-heading)))))
21276 (defsubst org-in-subtree-not-table-p ()
21277 "Are we in a subtree and not in a table?"
21278 (and (not (org-before-first-heading-p))
21279 (not (org-at-table-p))))
21281 ;; Define the Org-mode menus
21282 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21284 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21285 ["Next Field" org-cycle (org-at-table-p)]
21286 ["Previous Field" org-shifttab (org-at-table-p)]
21287 ["Next Row" org-return (org-at-table-p)]
21289 ["Blank Field" org-table-blank-field (org-at-table-p)]
21290 ["Edit Field" org-table-edit-field (org-at-table-p)]
21291 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21294 ["Move Column Left" org-metaleft (org-at-table-p)]
21295 ["Move Column Right" org-metaright (org-at-table-p)]
21296 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21297 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21299 ["Move Row Up" org-metaup (org-at-table-p)]
21300 ["Move Row Down" org-metadown (org-at-table-p)]
21301 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21302 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21303 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21305 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21307 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21308 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21309 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21310 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21313 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21314 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21315 ["Edit Formulas" org-edit-special (org-at-table-p)]
21317 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21318 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21319 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21321 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21323 ["Sum Column/Rectangle" org-table-sum
21324 (or (org-at-table-p) (org-region-active-p))]
21325 ["Which Column?" org-table-current-column (org-at-table-p)])
21327 org-table-toggle-formula-debugger
21328 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21329 ["Show Col/Row Numbers"
21330 org-table-toggle-coordinate-overlays
21332 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21334 ["Create" org-table-create (and (not (org-at-table-p))
21335 org-enable-table-editor)]
21336 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21337 ["Import from File" org-table-import (not (org-at-table-p))]
21338 ["Export to File" org-table-export (org-at-table-p)]
21340 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21343 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21344 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21346 (easy-menu-define org-org-menu org-mode-map "Org menu"
21349 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21350 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21351 ["Sparse Tree..." org-sparse-tree t]
21352 ["Reveal Context" org-reveal t]
21353 ["Show All" show-all t]
21355 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21357 ["New Heading" org-insert-heading t]
21358 ("Navigate Headings"
21359 ["Up" outline-up-heading t]
21360 ["Next" outline-next-visible-heading t]
21361 ["Previous" outline-previous-visible-heading t]
21362 ["Next Same Level" outline-forward-same-level t]
21363 ["Previous Same Level" outline-backward-same-level t]
21365 ["Jump" org-goto t])
21367 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21369 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21370 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21372 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21373 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21374 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21376 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21378 ["Copy visible text" org-copy-visible t]
21380 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21381 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21382 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21383 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21385 ["Sort Region/Children" org-sort t]
21387 ["Convert to odd levels" org-convert-to-odd-levels t]
21388 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21390 ["Emphasis..." org-emphasize t]
21391 ["Edit Source Example" org-edit-special t]
21393 ["Footnote new/jump" org-footnote-action t]
21394 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21396 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21398 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21399 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21400 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21404 ["Store Link (Global)" org-store-link t]
21405 ["Find existing link to here" org-occur-link-in-agenda-files t]
21406 ["Insert Link" org-insert-link t]
21407 ["Follow Link" org-open-at-point t]
21409 ["Next link" org-next-link t]
21410 ["Previous link" org-previous-link t]
21412 ["Descriptive Links"
21413 org-toggle-link-display
21415 :selected org-descriptive-links
21418 org-toggle-link-display
21420 :selected (not org-descriptive-links)])
21423 ["TODO/DONE/-" org-todo t]
21425 ["Next keyword" org-shiftright (org-at-heading-p)]
21426 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21427 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21428 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21429 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21430 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21431 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21433 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21434 :selected org-enforce-todo-dependencies :style toggle :active t]
21435 "Settings for tree at point"
21436 ["Do Children sequentially" org-toggle-ordered-property :style radio
21437 :selected (org-entry-get nil "ORDERED")
21438 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21439 ["Do Children parallel" org-toggle-ordered-property :style radio
21440 :selected (not (org-entry-get nil "ORDERED"))
21441 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21443 ["Set Priority" org-priority t]
21444 ["Priority Up" org-shiftup t]
21445 ["Priority Down" org-shiftdown t]
21447 ["Get news from all feeds" org-feed-update-all t]
21448 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21449 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21450 ("TAGS and Properties"
21451 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21452 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21454 ["Set property" org-set-property (not (org-before-first-heading-p))]
21455 ["Column view of properties" org-columns t]
21456 ["Insert Column View DBlock" org-insert-columns-dblock t])
21457 ("Dates and Scheduling"
21458 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21459 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21461 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21462 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21463 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21464 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21465 ["Compute Time Range" org-evaluate-time-range t]
21466 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21467 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21469 ["Custom time format" org-toggle-time-stamp-overlays
21470 :style radio :selected org-display-custom-times]
21472 ["Goto Calendar" org-goto-calendar t]
21473 ["Date from Calendar" org-date-from-calendar t]
21475 ["Start/Restart Timer" org-timer-start t]
21476 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21477 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21478 ["Insert Timer String" org-timer t]
21479 ["Insert Timer Item" org-timer-item t])
21481 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21482 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21483 ["Clock out" org-clock-out t]
21484 ["Clock cancel" org-clock-cancel t]
21486 ["Mark as default task" org-clock-mark-default-task t]
21487 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21488 ["Goto running clock" org-clock-goto t]
21490 ["Display times" org-clock-display t]
21491 ["Create clock table" org-clock-report t]
21493 ["Record DONE time"
21494 (progn (setq org-log-done (not org-log-done))
21495 (message "Switching to %s will %s record a timestamp"
21496 (car org-done-keywords)
21497 (if org-log-done "automatically" "not")))
21498 :style toggle :selected org-log-done])
21500 ["Agenda Command..." org-agenda t]
21501 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21502 ("File List for Agenda")
21503 ("Special views current file"
21504 ["TODO Tree" org-show-todo-tree t]
21505 ["Check Deadlines" org-check-deadlines t]
21506 ["Timeline" org-timeline t]
21507 ["Tags/Property tree" org-match-sparse-tree t])
21509 ["Export/Publish..." org-export-dispatch t]
21511 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21512 :selected org-cdlatex-mode]
21513 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21514 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21515 ["Modify math symbol" org-cdlatex-math-modify
21516 (org-inside-LaTeX-fragment-p)]
21517 ["Insert citation" org-reftex-citation t]
21519 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21522 ["Push Files and Views" org-mobile-push t]
21523 ["Get Captured and Flagged" org-mobile-pull t]
21524 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21526 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21529 ["Show Version" org-version t]
21530 ["Info Documentation" org-info t])
21532 ["Browse Org Group" org-customize t]
21534 ["Expand This Menu" org-create-customize-menu
21535 (fboundp 'customize-menu-create)])
21536 ["Send bug report" org-submit-bug-report t]
21539 ["Refresh setup current buffer" org-mode-restart t]
21540 ["Reload Org (after update)" org-reload t]
21541 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21544 (defun org-info (&optional node)
21545 "Read documentation for Org-mode in the info system.
21546 With optional NODE, go directly to that node."
21548 (info (format "(org)%s" (or node ""))))
21551 (defun org-submit-bug-report ()
21552 "Submit a bug report on Org-mode via mail.
21554 Don't hesitate to report any problems or inaccurate documentation.
21556 If you don't have setup sending mail from (X)Emacs, please copy the
21557 output buffer into your mail program, as it gives us important
21558 information about your Org-mode version and configuration."
21560 (require 'reporter)
21561 (org-load-modules-maybe)
21562 (org-require-autoloaded-modules)
21563 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21564 (reporter-submit-bug-report
21565 "emacs-orgmode@gnu.org"
21566 (org-version nil 'full)
21568 (save-window-excursion
21569 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21570 (delete-other-windows)
21572 (insert "You are about to submit a bug report to the Org-mode mailing list.
21574 We would like to add your full Org-mode and Outline configuration to the
21575 bug report. This greatly simplifies the work of the maintainer and
21576 other experts on the mailing list.
21578 HOWEVER, some variables you have customized may contain private
21579 information. The names of customers, colleagues, or friends, might
21580 appear in the form of file names, tags, todo states, or search strings.
21581 If you answer yes to the prompt, you might want to check and remove
21582 such private information before sending the email.")
21583 (add-text-properties (point-min) (point-max) '(face org-warning))
21584 (when (yes-or-no-p "Include your Org-mode configuration ")
21588 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21589 (or (and (symbol-value v)
21590 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21592 (get v 'custom-type) (get v 'standard-value)
21593 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21595 (kill-buffer (get-buffer "*Warn about privacy*"))
21598 "Remember to cover the basics, that is, what you expected to happen and
21599 what in fact did happen. You don't know how to make a good report? See
21601 http://orgmode.org/manual/Feedback.html#Feedback
21603 Your bug report will be posted to the Org-mode mailing list.
21604 ------------------------------------------------------------------------")
21606 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21607 (replace-match "\\1Bug: \\3 [\\2]")))))
21610 (defun org-install-agenda-files-menu ()
21611 (let ((bl (buffer-list)))
21614 (set-buffer (pop bl))
21615 (if (derived-mode-p 'org-mode) (setq bl nil)))
21616 (when (derived-mode-p 'org-mode)
21618 '("Org") "File List for Agenda"
21621 ["Edit File List" (org-edit-agenda-file-list) t]
21622 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21623 ["Remove Current File from List" org-remove-file t]
21624 ["Cycle through agenda files" org-cycle-agenda-files t]
21625 ["Occur in all agenda files" org-occur-in-agenda-files t]
21627 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21631 (defun org-require-autoloaded-modules ()
21634 '(org-agenda org-archive org-attach org-clock org-colview org-id
21635 org-table org-timer)))
21638 (defun org-reload (&optional uncompiled)
21639 "Reload all org lisp files.
21640 With prefix arg UNCOMPILED, load the uncompiled versions."
21642 (require 'loadhist)
21643 (let* ((org-dir (org-find-library-dir "org"))
21644 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21645 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21646 (remove-re (mapconcat 'identity
21647 (mapcar (lambda (f) (concat "^" f "$"))
21648 (list (if (featurep 'xemacs)
21650 "org-colview-xemacs")
21651 "org" "org-loaddefs" "org-version"))
21653 (feats (delete-dups
21654 (mapcar 'file-name-sans-extension
21655 (mapcar 'file-name-nondirectory
21657 (mapcar 'feature-file
21664 (if (and (string-match feature-re f)
21665 (not (string-match remove-re f)))
21669 (list "org-version" "org")))
21670 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21671 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21672 load-uncore load-misses)
21675 (mapcar (lambda (f)
21676 (or (org-load-noerror-mustsuffix (concat org-dir f))
21677 (and (string= org-dir contrib-dir)
21678 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21679 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21680 (add-to-list 'load-uncore f 'append)
21685 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21686 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21688 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21689 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21690 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21693 (defun org-customize ()
21694 "Call the customize function with org as argument."
21696 (org-load-modules-maybe)
21697 (org-require-autoloaded-modules)
21698 (customize-browse 'org))
21700 (defun org-create-customize-menu ()
21701 "Create a full customization menu for Org-mode, insert it into the menu."
21703 (org-load-modules-maybe)
21704 (org-require-autoloaded-modules)
21705 (if (fboundp 'customize-menu-create)
21708 '("Org") "Customize"
21709 `(["Browse Org group" org-customize t]
21711 ,(customize-menu-create 'org)
21712 ["Set" Custom-set t]
21713 ["Save" Custom-save t]
21714 ["Reset to Current" Custom-reset-current t]
21715 ["Reset to Saved" Custom-reset-saved t]
21716 ["Reset to Standard Settings" Custom-reset-standard t]))
21717 (message "\"Org\"-menu now contains full customization menu"))
21718 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21720 ;;;; Miscellaneous stuff
21722 ;;; Generally useful functions
21724 (defsubst org-get-at-eol (property n)
21725 "Get text property PROPERTY at the end of line less N characters."
21726 (get-text-property (- (point-at-eol) n) property))
21728 (defun org-find-text-property-in-string (prop s)
21729 "Return the first non-nil value of property PROP in string S."
21730 (or (get-text-property 0 prop s)
21731 (get-text-property (or (next-single-property-change 0 prop s) 0)
21734 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21735 "Display the given MESSAGE as a warning."
21736 (if (fboundp 'display-warning)
21737 (display-warning 'org message
21738 (if (featurep 'xemacs) 'warning :warning))
21739 (let ((buf (get-buffer-create "*Org warnings*")))
21740 (with-current-buffer buf
21741 (goto-char (point-max))
21742 (insert "Warning (Org): " message)
21745 (display-buffer buf)
21748 (defun org-eval (form)
21749 "Eval FORM and return result."
21750 (condition-case error
21752 (error (format "%%![Error: %s]" error))))
21754 (defun org-in-clocktable-p ()
21755 "Check if the cursor is in a clocktable."
21756 (let ((pos (point)) start)
21759 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21760 (setq start (match-beginning 0))
21761 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21762 (>= (match-end 0) pos)
21765 (defun org-in-verbatim-emphasis ()
21767 (and (org-in-regexp org-emph-re 2)
21768 (>= (point) (match-beginning 3))
21769 (<= (point) (match-end 4))
21770 (member (match-string 3) '("=" "~")))))
21772 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21773 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21774 (if (and marker (marker-buffer marker)
21775 (buffer-live-p (marker-buffer marker)))
21777 (org-pop-to-buffer-same-window (marker-buffer marker))
21778 (if (or (> marker (point-max)) (< marker (point-min)))
21781 (org-show-context 'org-goto))
21783 (bookmark-jump bookmark)
21784 (error "Cannot find location"))))
21786 (defun org-quote-csv-field (s)
21787 "Quote field for inclusion in CSV material."
21788 (if (string-match "[\",]" s)
21789 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21792 (defun org-force-self-insert (N)
21793 "Needed to enforce self-insert under remapping."
21795 (self-insert-command N))
21797 (defun org-string-width (s)
21798 "Compute width of string, ignoring invisible characters.
21799 This ignores character with invisibility property `org-link', and also
21800 characters with property `org-cwidth', because these will become invisible
21801 upon the next fontification round."
21803 (when (or (eq t buffer-invisibility-spec)
21804 (assq 'org-link buffer-invisibility-spec))
21805 (while (setq b (text-property-any 0 (length s)
21806 'invisible 'org-link s))
21807 (setq s (concat (substring s 0 b)
21808 (substring s (or (next-single-property-change
21809 b 'invisible s) (length s)))))))
21810 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21811 (setq s (concat (substring s 0 b)
21812 (substring s (or (next-single-property-change
21813 b 'org-cwidth s) (length s))))))
21814 (setq l (string-width s) b -1)
21815 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21816 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21819 (defun org-shorten-string (s maxlength)
21820 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21821 If the string is shorter or has length MAXLENGTH, just return the
21822 original string. If it is longer, the functions finds a space in the
21823 string, breaks this string off at that locations and adds three dots
21824 as ellipsis. Including the ellipsis, the string will not be longer
21825 than MAXLENGTH. If finding a good breaking point in the string does
21826 not work, the string is just chopped off in the middle of a word
21828 (if (<= (length s) maxlength)
21830 (let* ((n (max (- maxlength 4) 1))
21831 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21832 (if (string-match re s)
21833 (concat (match-string 1 s) "...")
21834 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21836 (defun org-get-indentation (&optional line)
21837 "Get the indentation of the current line, interpreting tabs.
21838 When LINE is given, assume it represents a line and compute its indentation."
21840 (if (string-match "^ *" (org-remove-tabs line))
21843 (beginning-of-line 1)
21844 (skip-chars-forward " \t")
21845 (current-column))))
21847 (defun org-get-string-indentation (s)
21848 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21849 (let ((n -1) (i 0) (w tab-width) c)
21851 (while (< (setq n (1+ n)) (length s))
21852 (setq c (aref s n))
21853 (cond ((= c ?\ ) (setq i (1+ i)))
21854 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21855 (t (throw 'exit t)))))
21858 (defun org-remove-tabs (s &optional width)
21859 "Replace tabulators in S with spaces.
21860 Assumes that s is a single line, starting in column 0."
21861 (setq width (or width tab-width))
21862 (while (string-match "\t" s)
21863 (setq s (replace-match
21865 (- (* width (/ (+ (match-beginning 0) width) width))
21866 (match-beginning 0)) ?\ )
21870 (defun org-fix-indentation (line ind)
21871 "Fix indentation in LINE.
21872 IND is a cons cell with target and minimum indentation.
21873 If the current indentation in LINE is smaller than the minimum,
21874 leave it alone. If it is larger than ind, set it to the target."
21875 (let* ((l (org-remove-tabs line))
21876 (i (org-get-indentation l))
21877 (i1 (car ind)) (i2 (cdr ind)))
21878 (if (>= i i2) (setq l (substring line i2)))
21880 (concat (make-string i1 ?\ ) l)
21883 (defun org-remove-indentation (code &optional n)
21884 "Remove the maximum common indentation from the lines in CODE.
21885 N may optionally be the number of spaces to remove."
21888 (org-do-remove-indentation n)
21891 (defun org-do-remove-indentation (&optional n)
21892 "Remove the maximum common indentation from the buffer."
21893 (untabify (point-min) (point-max))
21894 (let ((min 10000) re)
21897 (goto-char (point-min))
21898 (while (re-search-forward "^ *[^ \n]" nil t)
21899 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21900 (unless (or (= min 0) (= min 10000))
21901 (setq re (format "^ \\{%d\\}" min))
21902 (goto-char (point-min))
21903 (while (re-search-forward re nil t)
21908 (defun org-fill-template (template alist)
21909 "Find each %key of ALIST in TEMPLATE and replace it."
21910 (let ((case-fold-search nil)
21912 (setq alist (sort (copy-sequence alist)
21913 (lambda (a b) (< (length (car a)) (length (car b))))))
21914 (while (setq entry (pop alist))
21916 (replace-regexp-in-string
21917 (concat "%" (regexp-quote (car entry)))
21918 (or (cdr entry) "") template t t)))
21921 (defun org-base-buffer (buffer)
21922 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21925 (or (buffer-base-buffer buffer)
21928 (defun org-wrap (string &optional width lines)
21929 "Wrap string to either a number of lines, or a width in characters.
21930 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21931 that costs. If there is a word longer than WIDTH, the text is actually
21932 wrapped to the length of that word.
21933 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21934 many lines, whatever width that takes.
21935 The return value is a list of lines, without newlines at the end."
21936 (let* ((words (org-split-string string "[ \t\n]+"))
21937 (maxword (apply 'max (mapcar 'org-string-width words)))
21940 (org-do-wrap words (max maxword width)))
21943 (setq ll (org-do-wrap words maxword))
21944 (if (<= (length ll) lines)
21947 (while (> (length ll) lines)
21949 (setq ll (org-do-wrap words w)))
21951 (t (error "Cannot wrap this")))))
21953 (defun org-do-wrap (words width)
21954 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21957 (setq line (pop words))
21958 (while (and words (< (+ (length line) (length (car words))) width))
21959 (setq line (concat line " " (pop words))))
21960 (setq lines (push line lines)))
21963 (defun org-split-string (string &optional separators)
21964 "Splits STRING into substrings at SEPARATORS.
21965 No empty strings are returned if there are matches at the beginning
21966 and end of string."
21967 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21971 (while (and (string-match rexp string
21973 (= start (match-beginning 0))
21974 (< start (length string)))
21976 (< (match-beginning 0) (length string)))
21978 (or (eq (match-beginning 0) 0)
21979 (and (eq (match-beginning 0) (match-end 0))
21980 (eq (match-beginning 0) start))
21982 (cons (substring string start (match-beginning 0))
21984 (setq start (match-end 0)))
21985 (or (eq start (length string))
21987 (cons (substring string start)
21991 (defun org-quote-vert (s)
21992 "Replace \"|\" with \"\\vert\"."
21993 (while (string-match "|" s)
21994 (setq s (replace-match "\\vert" t t s)))
21997 (defun org-uuidgen-p (s)
21998 "Is S an ID created by UUIDGEN?"
21999 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22001 (defun org-in-src-block-p (&optional inside)
22002 "Whether point is in a code source block.
22003 When INSIDE is non-nil, don't consider we are within a src block
22004 when point is at #+BEGIN_SRC or #+END_SRC."
22005 (let ((case-fold-search t) ov)
22006 (or (and (eq (get-char-property (point) 'src-block) t))
22010 (beginning-of-line)
22011 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22013 (defun org-context ()
22014 "Return a list of contexts of the current cursor position.
22015 If several contexts apply, all are returned.
22016 Each context entry is a list with a symbol naming the context, and
22017 two positions indicating start and end of the context. Possible
22020 :headline anywhere in a headline
22021 :headline-stars on the leading stars in a headline
22022 :todo-keyword on a TODO keyword (including DONE) in a headline
22023 :tags on the TAGS in a headline
22024 :priority on the priority cookie in a headline
22025 :item on the first line of a plain list item
22026 :item-bullet on the bullet/number of a plain list item
22027 :checkbox on the checkbox in a plain list item
22028 :table in an org-mode table
22029 :table-special on a special filed in a table
22030 :table-table in a table.el table
22031 :clocktable in a clocktable
22032 :src-block in a source block
22033 :link on a hyperlink
22034 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22035 :target on a <<target>>
22036 :radio-target on a <<<radio-target>>>
22037 :latex-fragment on a LaTeX fragment
22038 :latex-preview on a LaTeX fragment with overlaid preview image
22040 This function expects the position to be visible because it uses font-lock
22041 faces as a help to recognize the following contexts: :table-special, :link,
22043 (let* ((f (get-text-property (point) 'face))
22044 (faces (if (listp f) f (list f)))
22045 (case-fold-search t)
22046 (p (point)) clist o)
22047 ;; First the large context
22049 ((org-at-heading-p t)
22050 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22052 (beginning-of-line 1)
22053 (looking-at org-todo-line-tags-regexp))
22054 (push (org-point-in-group p 1 :headline-stars) clist)
22055 (push (org-point-in-group p 2 :todo-keyword) clist)
22056 (push (org-point-in-group p 4 :tags) clist))
22058 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22059 (if (looking-at "\\[#[A-Z0-9]\\]")
22060 (push (org-point-in-group p 0 :priority) clist)))
22063 (push (org-point-in-group p 2 :item-bullet) clist)
22064 (push (list :item (point-at-bol)
22065 (save-excursion (org-end-of-item) (point)))
22067 (and (org-at-item-checkbox-p)
22068 (push (org-point-in-group p 0 :checkbox) clist)))
22071 (push (list :table (org-table-begin) (org-table-end)) clist)
22072 (if (memq 'org-formula faces)
22073 (push (list :table-special
22074 (previous-single-property-change p 'face)
22075 (next-single-property-change p 'face)) clist)))
22076 ((org-at-table-p 'any)
22077 (push (list :table-table) clist)))
22080 (let ((case-fold-search t))
22081 ;; New the "medium" contexts: clocktables, source blocks
22082 (cond ((org-in-clocktable-p)
22083 (push (list :clocktable
22084 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22085 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22086 (match-beginning 1))
22087 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22088 (match-end 0))) clist))
22089 ((org-in-src-block-p)
22090 (push (list :src-block
22091 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22092 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22093 (match-beginning 1))
22094 (and (search-forward "#+END_SRC" nil t)
22095 (match-beginning 0))) clist))))
22098 ;; Now the small context
22100 ((org-at-timestamp-p)
22101 (push (org-point-in-group p 0 :timestamp) clist))
22102 ((memq 'org-link faces)
22104 (previous-single-property-change p 'face)
22105 (next-single-property-change p 'face)) clist))
22106 ((memq 'org-special-keyword faces)
22107 (push (list :keyword
22108 (previous-single-property-change p 'face)
22109 (next-single-property-change p 'face)) clist))
22111 (push (org-point-in-group p 0 :target) clist)
22112 (goto-char (1- (match-beginning 0)))
22113 (if (looking-at org-radio-target-regexp)
22114 (push (org-point-in-group p 0 :radio-target) clist))
22116 ((setq o (car (delq nil
22119 (if (memq x org-latex-fragment-image-overlays) x))
22120 (overlays-at (point))))))
22121 (push (list :latex-fragment
22122 (overlay-start o) (overlay-end o)) clist)
22123 (push (list :latex-preview
22124 (overlay-start o) (overlay-end o)) clist))
22125 ((org-inside-LaTeX-fragment-p)
22126 ;; FIXME: positions wrong.
22127 (push (list :latex-fragment (point) (point)) clist)))
22129 (setq clist (nreverse (delq nil clist)))
22132 (defun org-in-regexp (re &optional nlines visually)
22133 "Check if point is inside a match of RE.
22135 Normally only the current line is checked, but you can include
22136 NLINES extra lines after point into the search. If VISUALLY is
22137 set, require that the cursor is not after the match but really
22138 on, so that the block visually is on the match."
22140 (let ((pos (point))
22141 (eol (point-at-eol (+ 1 (or nlines 0))))
22142 (inc (if visually 1 0)))
22144 (beginning-of-line (- 1 (or nlines 0)))
22145 (while (re-search-forward re eol t)
22146 (if (and (<= (match-beginning 0) pos)
22147 (>= (+ inc (match-end 0)) pos))
22148 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22149 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22152 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22153 "Non-nil when point is between matches of START-RE and END-RE.
22155 Also return a non-nil value when point is on one of the matches.
22157 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22158 buffer positions. Default values are the positions of headlines
22159 surrounding the point.
22161 The functions returns a cons cell whose car (resp. cdr) is the
22162 position before START-RE (resp. after END-RE)."
22164 (let ((pos (point))
22165 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22166 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22169 ;; Point is on a block when on START-RE or if START-RE can be
22170 ;; found before it...
22171 (and (or (org-in-regexp start-re)
22172 (re-search-backward start-re limit-up t))
22173 (setq beg (match-beginning 0))
22174 ;; ... and END-RE after it...
22175 (goto-char (match-end 0))
22176 (re-search-forward end-re limit-down t)
22177 (> (setq end (match-end 0)) pos)
22178 ;; ... without another START-RE in-between.
22179 (goto-char (match-beginning 0))
22180 (not (re-search-backward start-re (1+ beg) t))
22182 (cons beg end))))))
22184 (defun org-in-block-p (names)
22185 "Non-nil when point belongs to a block whose name belongs to NAMES.
22187 NAMES is a list of strings containing names of blocks.
22189 Return first block name matched, or nil. Beware that in case of
22190 nested blocks, the returned name may not belong to the closest
22194 (let ((case-fold-search t)
22195 (lim-up (save-excursion (outline-previous-heading)))
22196 (lim-down (save-excursion (outline-next-heading))))
22197 (mapc (lambda (name)
22198 (let ((n (regexp-quote name)))
22199 (when (org-between-regexps-p
22200 (concat "^[ \t]*#\\+begin_" n)
22201 (concat "^[ \t]*#\\+end_" n)
22207 (defun org-occur-in-agenda-files (regexp &optional nlines)
22208 "Call `multi-occur' with buffers for all agenda files."
22209 (interactive "sOrg-files matching: \np")
22210 (let* ((files (org-agenda-files))
22211 (tnames (mapcar 'file-truename files))
22212 (extra org-agenda-text-search-extra-files)
22214 (when (eq (car extra) 'agenda-archives)
22215 (setq extra (cdr extra))
22216 (setq files (org-add-archive-files files)))
22217 (while (setq f (pop extra))
22218 (unless (member (file-truename f) tnames)
22219 (add-to-list 'files f 'append)
22220 (add-to-list 'tnames (file-truename f) 'append)))
22222 (mapcar (lambda (x)
22223 (with-current-buffer
22224 (or (get-file-buffer x) (find-file-noselect x))
22230 (if (boundp 'occur-mode-find-occurrence-hook)
22232 (add-hook 'occur-mode-find-occurrence-hook
22234 (when (derived-mode-p 'org-mode)
22237 (defadvice occur-mode-goto-occurrence
22238 (after org-occur-reveal activate)
22239 (and (derived-mode-p 'org-mode) (org-reveal)))
22240 (defadvice occur-mode-goto-occurrence-other-window
22241 (after org-occur-reveal activate)
22242 (and (derived-mode-p 'org-mode) (org-reveal)))
22243 (defadvice occur-mode-display-occurrence
22244 (after org-occur-reveal activate)
22245 (when (derived-mode-p 'org-mode)
22246 (let ((pos (occur-mode-find-occurrence)))
22247 (with-current-buffer (marker-buffer pos)
22252 (defun org-occur-link-in-agenda-files ()
22253 "Create a link and search for it in the agendas.
22254 The link is not stored in `org-stored-links', it is just created
22255 for the search purpose."
22257 (let ((link (condition-case nil
22258 (org-store-link nil)
22259 (error "Unable to create a link to here"))))
22260 (org-occur-in-agenda-files (regexp-quote link))))
22262 (defun org-reverse-string (string)
22263 "Return the reverse of STRING."
22264 (apply 'string (reverse (string-to-list string))))
22266 ;; defsubst org-uniquify must be defined before first use
22268 (defun org-uniquify-alist (alist)
22269 "Merge elements of ALIST with the same key.
22271 For example, in this alist:
22273 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22274 => '((a 1 3) (b 2))
22276 merge (a 1) and (a 3) into (a 1 3).
22278 The function returns the new ALIST."
22283 (if (not (assoc (car e) rtn))
22285 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22286 (setq rtn (assq-delete-all (car e) rtn))
22291 (defun org-delete-all (elts list)
22292 "Remove all elements in ELTS from LIST."
22294 (setq list (delete (pop elts) list)))
22297 (defun org-count (cl-item cl-seq)
22298 "Count the number of occurrences of ITEM in SEQ.
22299 Taken from `count' in cl-seq.el with all keyword arguments removed."
22300 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22301 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22302 (while (< cl-start cl-end)
22303 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22304 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22305 (setq cl-start (1+ cl-start)))
22308 (defun org-remove-if (predicate seq)
22309 "Remove everything from SEQ that fulfills PREDICATE."
22313 (if (not (funcall predicate e)) (push e res)))
22316 (defun org-remove-if-not (predicate seq)
22317 "Remove everything from SEQ that does not fulfill PREDICATE."
22321 (if (funcall predicate e) (push e res)))
22324 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22325 "Reduce two-argument FUNCTION across SEQ.
22326 Taken from `reduce' in cl-seq.el with all keyword arguments but
22327 \":initial-value\" removed."
22328 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22329 (cadr (memq :initial-value cl-keys)))
22330 (cl-seq (pop cl-seq))
22331 (t (funcall cl-func)))))
22333 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22336 (defun org-every (pred seq)
22337 "Return true if PREDICATE is true of every element of SEQ.
22338 Adapted from `every' in cl.el."
22340 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22343 (defun org-some (pred seq)
22344 "Return true if PREDICATE is true of any element of SEQ.
22345 Adapted from `some' in cl.el."
22347 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22350 (defun org-back-over-empty-lines ()
22351 "Move backwards over whitespace, to the beginning of the first empty line.
22352 Returns the number of empty lines passed."
22353 (let ((pos (point)))
22354 (if (cdr (assoc 'heading org-blank-before-new-entry))
22355 (skip-chars-backward " \t\n\r")
22357 (forward-line -1)))
22358 (beginning-of-line 2)
22359 (goto-char (min (point) pos))
22360 (count-lines (point) pos)))
22362 (defun org-skip-whitespace ()
22363 (skip-chars-forward " \t\n\r"))
22365 (defun org-point-in-group (point group &optional context)
22366 "Check if POINT is in match-group GROUP.
22367 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22368 match. If the match group does not exist or point is not inside it,
22370 (and (match-beginning group)
22371 (>= point (match-beginning group))
22372 (<= point (match-end group))
22374 (list context (match-beginning group) (match-end group))
22377 (defun org-switch-to-buffer-other-window (&rest args)
22378 "Switch to buffer in a second window on the current frame.
22379 In particular, do not allow pop-up frames.
22380 Returns the newly created buffer."
22382 (apply 'switch-to-buffer-other-window args)))
22384 (defun org-combine-plists (&rest plists)
22385 "Create a single property list from all plists in PLISTS.
22386 The process starts by copying the first list, and then setting properties
22387 from the other lists. Settings in the last list are the most significant
22388 ones and overrule settings in the other lists."
22389 (let ((rtn (copy-sequence (pop plists)))
22392 (setq ls (pop plists))
22394 (setq p (pop ls) v (pop ls))
22395 (setq rtn (plist-put rtn p v))))
22398 (defun org-replace-escapes (string table)
22399 "Replace %-escapes in STRING with values in TABLE.
22400 TABLE is an association list with keys like \"%a\" and string values.
22401 The sequences in STRING may contain normal field width and padding information,
22402 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22403 so values can contain further %-escapes if they are define later in TABLE."
22404 (let ((tbl (copy-alist table))
22405 (case-fold-search nil)
22408 (while (setq e (pop tbl))
22409 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22410 (when (and (cdr e) (string-match re (cdr e)))
22411 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22413 (add-text-properties 0 3 (list 'sref sref) safe)
22414 (setcdr e (replace-match safe t t (cdr e)))))
22415 (while (string-match re string)
22416 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22418 (setq string (replace-match rpl t t string))))
22419 (while (setq pchg (next-property-change pchg string))
22420 (let ((sref (get-text-property pchg 'sref string)))
22421 (when (and sref (string-match "SREF" string pchg))
22422 (setq string (replace-match sref t t string)))))
22425 (defun org-sublist (list start end)
22426 "Return a section of LIST, from START to END.
22427 Counting starts at 1."
22428 (let (rtn (c start))
22429 (setq list (nthcdr (1- start) list))
22430 (while (and list (<= c end))
22431 (push (pop list) rtn)
22435 (defun org-find-base-buffer-visiting (file)
22436 "Like `find-buffer-visiting' but always return the base buffer and
22437 not an indirect buffer."
22438 (let ((buf (or (get-file-buffer file)
22439 (find-buffer-visiting file))))
22441 (or (buffer-base-buffer buf) buf)
22444 (defun org-image-file-name-regexp (&optional extensions)
22445 "Return regexp matching the file names of images.
22446 If EXTENSIONS is given, only match these."
22447 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22448 (image-file-name-regexp)
22449 (let ((image-file-name-extensions
22451 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22452 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22454 (regexp-opt (nconc (mapcar 'upcase
22455 image-file-name-extensions)
22456 image-file-name-extensions)
22460 (defun org-file-image-p (file &optional extensions)
22461 "Return non-nil if FILE is an image."
22463 (string-match (org-image-file-name-regexp extensions) file)))
22465 (defun org-get-cursor-date (&optional with-time)
22466 "Return the date at cursor in as a time.
22467 This works in the calendar and in the agenda, anywhere else it just
22468 returns the current time.
22469 If WITH-TIME is non-nil, returns the time of the event at point (in
22470 the agenda) or the current time of the day."
22471 (let (date day defd tp tm hod mod)
22473 (setq tp (get-text-property (point) 'time))
22474 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22475 (setq hod (string-to-number (match-string 1 tp))
22476 mod (string-to-number (match-string 2 tp))))
22477 (or tp (setq hod (nth 2 (decode-time (current-time)))
22478 mod (nth 1 (decode-time (current-time))))))
22480 ((eq major-mode 'calendar-mode)
22481 (setq date (calendar-cursor-to-date)
22482 defd (encode-time 0 (or mod 0) (or hod 0)
22483 (nth 1 date) (nth 0 date) (nth 2 date))))
22484 ((eq major-mode 'org-agenda-mode)
22485 (setq day (get-text-property (point) 'day))
22487 (setq date (calendar-gregorian-from-absolute day)
22488 defd (encode-time 0 (or mod 0) (or hod 0)
22489 (nth 1 date) (nth 0 date) (nth 2 date))))))
22490 (or defd (current-time))))
22492 (defun org-mark-subtree (&optional up)
22493 "Mark the current subtree.
22494 This puts point at the start of the current subtree, and mark at
22495 the end. If a numeric prefix UP is given, move up into the
22496 hierarchy of headlines by UP levels before marking the subtree."
22498 (org-with-limited-levels
22499 (cond ((org-at-heading-p) (beginning-of-line))
22500 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22501 (t (outline-previous-visible-heading 1))))
22502 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22503 (if (org-called-interactively-p 'any)
22504 (call-interactively 'org-mark-element)
22505 (org-mark-element)))
22510 (defun org--get-expected-indentation (element contentsp)
22511 "Expected indentation column for current line, according to ELEMENT.
22512 ELEMENT is an element containing point. CONTENTSP is non-nil
22513 when indentation is to be computed according to contents of
22515 (let ((type (org-element-type element))
22516 (start (org-element-property :begin element)))
22517 (org-with-wide-buffer
22521 (footnote-definition 0)
22522 ((headline inlinetask nil)
22523 (if (not org-adapt-indentation) 0
22524 (let ((level (org-current-level)))
22525 (if level (1+ level) 0))))
22527 (org-list-item-body-column
22528 (org-element-property :post-affiliated element)))
22531 (goto-char (org-element-property :post-affiliated element))
22532 (org-get-indentation)))
22535 (org-get-indentation))))
22536 ((memq type '(headline inlinetask nil))
22537 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22538 (org--get-expected-indentation element t)
22540 ((eq type 'footnote-definition) 0)
22541 ;; First paragraph of a footnote definition or an item.
22542 ;; Indent like parent.
22543 ((< (line-beginning-position) start)
22544 (org--get-expected-indentation
22545 (org-element-property :parent element) t))
22546 ;; At first line: indent according to previous sibling, if any,
22547 ;; ignoring footnote definitions and inline tasks, or parent's
22549 ((= (line-beginning-position) start)
22552 (if (= (point-min) start) (throw 'exit 0)
22553 (goto-char (1- start))
22554 (let* ((previous (org-element-at-point))
22556 (while (and parent (<= (org-element-property :end parent) start))
22557 (setq previous parent
22558 parent (org-element-property :parent parent)))
22560 ((not previous) (throw 'exit 0))
22561 ((> (org-element-property :end previous) start)
22562 (throw 'exit (org--get-expected-indentation previous t)))
22563 ((memq (org-element-type previous)
22564 '(footnote-definition inlinetask))
22565 (setq start (org-element-property :begin previous)))
22566 (t (goto-char (org-element-property :begin previous))
22568 (if (bolp) (org-get-indentation)
22569 ;; At first paragraph in an item or
22570 ;; a footnote definition.
22571 (org--get-expected-indentation
22572 (org-element-property :parent previous) t))))))))))
22573 ;; Otherwise, move to the first non-blank line above.
22575 (beginning-of-line)
22576 (let ((pos (point)))
22577 (skip-chars-backward " \r\t\n")
22579 ;; Two blank lines end a footnote definition or a plain
22580 ;; list. When we indent an empty line after them, the
22581 ;; containing list or footnote definition is over, so it
22582 ;; qualifies as a previous sibling. Therefore, we indent
22583 ;; like its first line.
22584 ((and (memq type '(footnote-definition plain-list))
22585 (> (count-lines (point) pos) 2))
22587 (org-get-indentation))
22588 ;; Line above is the first one of a paragraph at the
22589 ;; beginning of an item or a footnote definition. Indent
22591 ((< (line-beginning-position) start)
22592 (org--get-expected-indentation
22593 (org-element-property :parent element) t))
22594 ;; POS is after contents in a greater element. Indent like
22595 ;; the beginning of the element.
22597 ;; As a special case, if point is at the end of a footnote
22598 ;; definition or an item, indent like the very last element
22600 ((and (not (eq type 'paragraph))
22601 (let ((cend (org-element-property :contents-end element)))
22602 (and cend (<= cend pos))))
22603 (if (memq type '(footnote-definition item plain-list))
22604 (org--get-expected-indentation (org-element-at-point) nil)
22606 (org-get-indentation)))
22607 ;; In any other case, indent like the current line.
22608 (t (org-get-indentation)))))))))
22610 (defun org--align-node-property ()
22611 "Align node property at point.
22612 Alignment is done according to `org-property-format', which see."
22613 (when (save-excursion
22614 (beginning-of-line)
22615 (looking-at org-property-re))
22617 (concat (match-string 4)
22619 (format org-property-format (match-string 1) (match-string 3))))
22622 (defun org-indent-line ()
22623 "Indent line depending on context.
22625 Indentation is done according to the following rules:
22627 - Footnote definitions, headlines and inline tasks have to
22630 - On the very first line of an element, consider, in order, the
22631 next rules until one matches:
22633 1. If there's a sibling element before, ignoring footnote
22634 definitions and inline tasks, indent like its first line.
22636 2. If element has a parent, indent like its contents. More
22637 precisely, if parent is an item, indent after the
22638 description part, if any, or the bullet (see
22639 `org-list-description-max-indent'). Else, indent like
22640 parent's first line.
22642 3. Otherwise, indent relatively to current level, if
22643 `org-adapt-indentation' is non-nil, or to left margin.
22645 - On a blank line at the end of an element, indent according to
22646 the type of the element. More precisely
22648 1. If element is a plain list, an item, or a footnote
22649 definition, indent like the very last element within.
22651 2. If element is a paragraph, indent like its last non blank
22654 3. Otherwise, indent like its very first line.
22656 - In the code part of a source block, use language major mode
22657 to indent current line if `org-src-tab-acts-natively' is
22658 non-nil. If it is nil, do nothing.
22660 - Otherwise, indent like the first non-blank line above.
22662 The function doesn't indent an item as it could break the whole
22663 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22664 \\[org-shiftmetaright].
22666 Also align node properties according to `org-property-format'."
22670 (let ((indent-line-function
22671 (cadadr (assq 'indent-line-function org-fb-vars))))
22672 (indent-according-to-mode)))
22673 ((org-at-heading-p) 'noindent)
22675 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22676 (type (org-element-type element)))
22677 (cond ((and (memq type '(plain-list item))
22678 (= (line-beginning-position)
22679 (org-element-property :post-affiliated element)))
22681 ((and (eq type 'src-block)
22682 org-src-tab-acts-natively
22683 (> (line-beginning-position)
22684 (org-element-property :post-affiliated element))
22685 (< (line-beginning-position)
22686 (org-with-wide-buffer
22687 (goto-char (org-element-property :end element))
22688 (skip-chars-backward " \r\t\n")
22689 (line-beginning-position))))
22690 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22692 (let ((column (org--get-expected-indentation element nil)))
22693 ;; Preserve current column.
22694 (if (<= (current-column) (current-indentation))
22695 (org-indent-line-to column)
22696 (save-excursion (org-indent-line-to column))))
22697 ;; Align node property. Also preserve current column.
22698 (when (eq type 'node-property)
22699 (let ((column (current-column)))
22700 (org--align-node-property)
22701 (org-move-to-column column)))))))))
22703 (defun org-indent-region (start end)
22704 "Indent each non-blank line in the region.
22705 Called from a program, START and END specify the region to
22706 indent. The function will not indent contents of example blocks,
22707 verse blocks and export blocks as leading white spaces are
22708 assumed to be significant there."
22712 (skip-chars-forward " \r\t\n")
22713 (unless (eobp) (beginning-of-line))
22716 ;; Set IND as indentation for all lines between point and
22717 ;; POS or END, whichever comes first. Blank lines are
22718 ;; ignored. Leave point after POS once done.
22719 (let ((limit (copy-marker (min end pos))))
22720 (while (< (point) limit)
22721 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22723 (set-marker limit nil))))
22724 (end (copy-marker end)))
22725 (while (< (point) end)
22726 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22727 (let* ((element (org-element-at-point))
22728 (type (org-element-type element))
22729 (element-end (copy-marker (org-element-property :end element)))
22730 (ind (org--get-expected-indentation element nil)))
22732 ((or (memq type '(paragraph table table-row))
22733 (not (or (org-element-property :contents-begin element)
22735 '(example-block export-block src-block)))))
22736 ;; Elements here are indented as a single block. Also
22737 ;; align node properties.
22738 (when (eq type 'node-property)
22739 (org--align-node-property)
22740 (beginning-of-line))
22741 (funcall indent-to ind element-end))
22743 ;; Elements in this category consist of three parts:
22744 ;; before the contents, the contents, and after the
22745 ;; contents. The contents are treated specially,
22746 ;; according to the element type, or not indented at
22747 ;; all. Other parts are indented as a single block.
22748 (let* ((post (copy-marker
22749 (org-element-property :post-affiliated element)))
22753 ((not (org-element-property :contents-begin element))
22754 ;; Fake contents for source blocks.
22755 (org-with-wide-buffer
22759 ((memq type '(footnote-definition item plain-list))
22760 ;; Contents in these elements could start on
22761 ;; the same line as the beginning of the
22762 ;; element. Make sure we start indenting
22763 ;; from the second line.
22764 (org-with-wide-buffer
22767 (skip-chars-forward " \r\t\n")
22768 (if (eobp) (point) (line-beginning-position))))
22769 (t (org-element-property :contents-begin element)))))
22771 (or (org-element-property :contents-end element)
22772 ;; Fake contents for source blocks.
22773 (org-with-wide-buffer
22774 (goto-char element-end)
22775 (skip-chars-backward " \r\t\n")
22776 (line-beginning-position)))
22778 ;; Do not change items indentation individually as it
22779 ;; might break the list as a whole. On the other
22780 ;; hand, when at a plain list, indent it as a whole.
22781 (cond ((eq type 'plain-list)
22782 (let ((offset (- ind (org-get-indentation))))
22783 (unless (zerop offset)
22784 (indent-rigidly (org-element-property :begin element)
22785 (org-element-property :end element)
22788 ((eq type 'item) (goto-char cbeg))
22789 (t (funcall indent-to ind cbeg)))
22790 (when (< (point) end)
22792 ((example-block export-block verse-block))
22794 ;; In a source block, indent source code
22795 ;; according to language major mode, but only if
22796 ;; `org-src-tab-acts-natively' is non-nil.
22797 (when (and (< (point) end) org-src-tab-acts-natively)
22799 (org-babel-do-in-edit-buffer
22800 (indent-region (point-min) (point-max))))))
22801 (t (org-indent-region (point) (min cend end))))
22802 (goto-char (min cend end))
22803 (when (< (point) end) (funcall indent-to ind element-end)))
22804 (set-marker post nil)
22805 (set-marker cbeg nil)
22806 (set-marker cend nil))))
22807 (set-marker element-end nil))))
22808 (set-marker end nil))))
22810 (defun org-indent-drawer ()
22811 "Indent the drawer at point."
22813 (unless (save-excursion
22814 (beginning-of-line)
22815 (org-looking-at-p org-drawer-regexp))
22816 (user-error "Not at a drawer"))
22817 (let ((element (org-element-at-point)))
22818 (unless (memq (org-element-type element) '(drawer property-drawer))
22819 (user-error "Not at a drawer"))
22820 (org-with-wide-buffer
22821 (org-indent-region (org-element-property :begin element)
22822 (org-element-property :end element))))
22823 (message "Drawer at point indented"))
22825 (defun org-indent-block ()
22826 "Indent the block at point."
22828 (unless (save-excursion
22829 (beginning-of-line)
22830 (let ((case-fold-search t))
22831 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22832 (user-error "Not at a block"))
22833 (let ((element (org-element-at-point)))
22834 (unless (memq (org-element-type element)
22835 '(comment-block center-block dynamic-block example-block
22836 export-block quote-block special-block
22837 src-block verse-block))
22838 (user-error "Not at a block"))
22839 (org-with-wide-buffer
22840 (org-indent-region (org-element-property :begin element)
22841 (org-element-property :end element))))
22842 (message "Block at point indented"))
22847 ;; We use our own fill-paragraph and auto-fill functions.
22849 ;; `org-fill-paragraph' relies on adaptive filling and context
22850 ;; checking. Appropriate `fill-prefix' is computed with
22851 ;; `org-adaptive-fill-function'.
22853 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22854 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22855 ;; `org-adaptive-fill-function' value. Internally,
22856 ;; `org-comment-line-break-function' breaks the line.
22858 ;; `org-setup-filling' installs filling and auto-filling related
22859 ;; variables during `org-mode' initialization.
22861 (defvar org-element-paragraph-separate) ; org-element.el
22862 (defun org-setup-filling ()
22863 (require 'org-element)
22864 ;; Prevent auto-fill from inserting unwanted new items.
22865 (when (boundp 'fill-nobreak-predicate)
22867 'fill-nobreak-predicate
22869 (append fill-nobreak-predicate
22870 '(org-fill-line-break-nobreak-p
22871 org-fill-paragraph-with-timestamp-nobreak-p)))))
22872 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22873 (org-set-local 'paragraph-start paragraph-ending)
22874 (org-set-local 'paragraph-separate paragraph-ending))
22875 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22876 (org-set-local 'auto-fill-inhibit-regexp nil)
22877 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22878 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22879 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22881 (defun org-fill-line-break-nobreak-p ()
22882 "Non-nil when a new line at point would create an Org line break."
22884 (skip-chars-backward "[ \t]")
22885 (skip-chars-backward "\\\\")
22886 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22888 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22889 "Non-nil when a new line at point would split a timestamp."
22890 (and (org-at-timestamp-p t)
22891 (not (looking-at org-ts-regexp-both))))
22893 (declare-function message-in-body-p "message" ())
22894 (defvar orgtbl-line-start-regexp) ; From org-table.el
22895 (defun org-adaptive-fill-function ()
22896 "Compute a fill prefix for the current line.
22897 Return fill prefix, as a string, or nil if current line isn't
22898 meant to be filled. For convenience, if `adaptive-fill-regexp'
22899 matches in paragraphs or comments, use it."
22901 (when (derived-mode-p 'message-mode)
22903 (beginning-of-line)
22904 (cond ((or (not (message-in-body-p))
22905 (looking-at orgtbl-line-start-regexp))
22907 ((looking-at message-cite-prefix-regexp)
22908 (throw 'exit (match-string-no-properties 0)))
22909 ((looking-at org-outline-regexp)
22910 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
22911 (org-with-wide-buffer
22912 (unless (org-at-heading-p)
22913 (let* ((p (line-beginning-position))
22914 (element (save-excursion
22915 (beginning-of-line)
22916 (org-element-at-point)))
22917 (type (org-element-type element))
22918 (post-affiliated (org-element-property :post-affiliated element)))
22919 (unless (< p post-affiliated)
22923 (beginning-of-line)
22924 (looking-at "[ \t]*")
22925 (concat (match-string 0) "# ")))
22926 (footnote-definition "")
22928 (make-string (org-list-item-body-column post-affiliated) ?\s))
22930 ;; Fill prefix is usually the same as the current line,
22931 ;; unless the paragraph is at the beginning of an item.
22932 (let ((parent (org-element-property :parent element)))
22934 (beginning-of-line)
22935 (cond ((eq (org-element-type parent) 'item)
22936 (make-string (org-list-item-body-column
22937 (org-element-property :begin parent))
22939 ((and adaptive-fill-regexp
22941 ;; `adaptive-fill-function' to let
22942 ;; `fill-context-prefix' handle
22943 ;; `adaptive-fill-regexp' variable.
22944 (let (adaptive-fill-function)
22945 (fill-context-prefix
22947 (org-element-property :end element)))))
22948 ((looking-at "[ \t]+") (match-string 0))
22951 ;; Only fill contents if P is within block boundaries.
22952 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22955 (cend (save-excursion
22956 (goto-char (org-element-property :end element))
22957 (skip-chars-backward " \r\t\n")
22958 (line-beginning-position))))
22959 (when (and (>= p cbeg) (< p cend))
22960 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22964 (declare-function message-goto-body "message" ())
22965 (defvar message-cite-prefix-regexp) ; From message.el
22966 (defun org-fill-paragraph (&optional justify)
22967 "Fill element at point, when applicable.
22969 This function only applies to comment blocks, comments, example
22970 blocks and paragraphs. Also, as a special case, re-align table
22971 when point is at one.
22973 If JUSTIFY is non-nil (interactively, with prefix argument),
22974 justify as well. If `sentence-end-double-space' is non-nil, then
22975 period followed by one space does not end a sentence, so don't
22976 break a line there. The variable `fill-column' controls the
22979 For convenience, when point is at a plain list, an item or
22980 a footnote definition, try to fill the first paragraph within."
22982 (if (and (derived-mode-p 'message-mode)
22983 (or (not (message-in-body-p))
22984 (save-excursion (move-beginning-of-line 1)
22985 (looking-at message-cite-prefix-regexp))))
22986 ;; First ensure filling is correct in message-mode.
22987 (let ((fill-paragraph-function
22988 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22989 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22990 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22991 (paragraph-separate
22992 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22993 (fill-paragraph nil))
22994 (with-syntax-table org-mode-transpose-word-syntax-table
22995 ;; Move to end of line in order to get the first paragraph
22996 ;; within a plain list or a footnote definition.
22997 (let ((element (save-excursion
22999 (or (ignore-errors (org-element-at-point))
23000 (user-error "An element cannot be parsed line %d"
23001 (line-number-at-pos (point)))))))
23002 ;; First check if point is in a blank line at the beginning of
23003 ;; the buffer. In that case, ignore filling.
23004 (case (org-element-type element)
23005 ;; Use major mode filling function is src blocks.
23006 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23007 ;; Align Org tables, leave table.el tables as-is.
23008 (table-row (org-table-align) t)
23010 (when (eq (org-element-property :type element) 'org)
23012 (goto-char (org-element-property :post-affiliated element))
23013 (org-table-align)))
23016 ;; Paragraphs may contain `line-break' type objects.
23017 (let ((beg (max (point-min)
23018 (org-element-property :contents-begin element)))
23019 (end (min (point-max)
23020 (org-element-property :contents-end element))))
23021 ;; Do nothing if point is at an affiliated keyword.
23022 (if (< (line-end-position) beg) t
23023 (when (derived-mode-p 'message-mode)
23024 ;; In `message-mode', do not fill following citation
23025 ;; in current paragraph nor text before message body.
23026 (let ((body-start (save-excursion (message-goto-body))))
23027 (when body-start (setq beg (max body-start beg))))
23028 (when (save-excursion
23030 (concat "^" message-cite-prefix-regexp) end t))
23031 (setq end (match-beginning 0))))
23032 ;; Fill paragraph, taking line breaks into account.
23035 (let ((cuts (list beg)))
23036 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23037 (when (eq 'line-break
23039 (save-excursion (backward-char)
23040 (org-element-context))))
23041 (push (point) cuts)))
23042 (dolist (c (delq end cuts))
23043 (fill-region-as-paragraph c end justify)
23046 ;; Contents of `comment-block' type elements should be
23047 ;; filled as plain text, but only if point is within block
23050 (let* ((case-fold-search t)
23051 (beg (save-excursion
23052 (goto-char (org-element-property :begin element))
23053 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23056 (end (save-excursion
23057 (goto-char (org-element-property :end element))
23058 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23059 (line-beginning-position))))
23060 (if (or (< (point) beg) (> (point) end)) t
23061 (fill-region-as-paragraph
23062 (save-excursion (end-of-line)
23063 (re-search-backward "^[ \t]*$" beg 'move)
23064 (line-beginning-position))
23065 (save-excursion (beginning-of-line)
23066 (re-search-forward "^[ \t]*$" end 'move)
23067 (line-beginning-position))
23071 (let ((begin (org-element-property :post-affiliated element))
23072 (end (org-element-property :end element)))
23073 (when (and (>= (point) begin) (<= (point) end))
23074 (let ((begin (save-excursion
23076 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23077 (progn (forward-line) (point))
23079 (end (save-excursion
23081 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23082 (1- (line-beginning-position))
23083 (skip-chars-backward " \r\t\n")
23084 (line-end-position)))))
23085 ;; Do not fill comments when at a blank line.
23086 (when (> end begin)
23089 (beginning-of-line)
23090 (looking-at "[ \t]*#")
23091 (let ((comment-prefix (match-string 0)))
23092 (goto-char (match-end 0))
23093 (if (looking-at adaptive-fill-regexp)
23094 (concat comment-prefix (match-string 0))
23095 (concat comment-prefix " "))))))
23097 (fill-region-as-paragraph begin end justify))))))
23099 ;; Ignore every other element.
23102 (defun org-auto-fill-function ()
23103 "Auto-fill function."
23104 ;; Check if auto-filling is meaningful.
23105 (let ((fc (current-fill-column)))
23106 (when (and fc (> (current-column) fc))
23107 (let* ((fill-prefix (org-adaptive-fill-function))
23108 ;; Enforce empty fill prefix, if required. Otherwise, it
23109 ;; will be computed again.
23110 (adaptive-fill-mode (not (equal fill-prefix ""))))
23111 (when fill-prefix (do-auto-fill))))))
23113 (defun org-comment-line-break-function (&optional soft)
23114 "Break line at point and indent, continuing comment if within one.
23115 The inserted newline is marked hard if variable
23116 `use-hard-newlines' is true, unless optional argument SOFT is
23118 (if soft (insert-and-inherit ?\n) (newline 1))
23119 (save-excursion (forward-char -1) (delete-horizontal-space))
23120 (delete-horizontal-space)
23121 (indent-to-left-margin)
23122 (insert-before-markers-and-inherit fill-prefix))
23125 ;;; Fixed Width Areas
23127 (defun org-toggle-fixed-width ()
23128 "Toggle fixed-width markup.
23130 Add or remove fixed-width markup on current line, whenever it
23131 makes sense. Return an error otherwise.
23133 If a region is active and if it contains only fixed-width areas
23134 or blank lines, remove all fixed-width markup in it. If the
23135 region contains anything else, convert all non-fixed-width lines
23136 to fixed-width ones.
23138 Blank lines at the end of the region are ignored unless the
23139 region only contains such lines."
23141 (if (not (org-region-active-p))
23144 ;; Remove fixed width marker only in a fixed-with element.
23146 ;; Add fixed width maker in paragraphs, in blank lines after
23147 ;; elements or at the beginning of a headline or an inlinetask,
23148 ;; and before any one-line elements (e.g., a clock).
23150 (beginning-of-line)
23151 (let* ((element (org-element-at-point))
23152 (type (org-element-type element)))
23154 ((and (eq type 'fixed-width)
23155 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23157 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23158 ((and (memq type '(babel-call clock comment diary-sexp headline
23159 horizontal-rule keyword paragraph
23161 (<= (org-element-property :post-affiliated element) (point)))
23162 (skip-chars-forward " \t")
23164 ((and (org-looking-at-p "[ \t]*$")
23165 (or (eq type 'inlinetask)
23167 (skip-chars-forward " \r\t\n")
23168 (<= (org-element-property :end element) (point)))))
23169 (delete-region (point) (line-end-position))
23172 (t (user-error "Cannot insert a fixed-width line here")))))
23174 (let* ((begin (save-excursion
23175 (goto-char (region-beginning))
23176 (line-beginning-position)))
23179 (goto-char (region-end))
23180 (unless (eolp) (beginning-of-line))
23181 (if (save-excursion (re-search-backward "\\S-" begin t))
23182 (progn (skip-chars-backward " \r\t\n") (point))
23188 (skip-chars-forward " \r\t\n")
23189 (when (eobp) (throw 'not-all-p nil))
23190 (while (< (point) end)
23191 (let ((element (org-element-at-point)))
23192 (if (eq (org-element-type element) 'fixed-width)
23193 (goto-char (org-element-property :end element))
23194 (throw 'not-all-p nil))))
23196 (if all-fixed-width-p
23199 (while (< (point) end)
23200 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23203 (if (= (line-end-position) (match-end 0)) 0 1)))
23205 (let ((min-ind (point-max)))
23206 ;; Find minimum indentation across all lines.
23209 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23212 (while (< (point) end)
23213 (unless (org-looking-at-p "[ \t]*$")
23214 (let ((ind (org-get-indentation)))
23215 (setq min-ind (min min-ind ind))
23216 (when (zerop ind) (throw 'zerop t))))
23218 ;; Loop over all lines and add fixed-width markup everywhere
23219 ;; but in fixed-width lines.
23222 (while (< (point) end)
23224 ((org-at-heading-p)
23227 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23230 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23231 (let* ((element (org-element-at-point))
23232 (element-end (org-element-property :end element)))
23233 (if (eq (org-element-type element) 'fixed-width)
23234 (progn (goto-char element-end)
23235 (skip-chars-backward " \r\t\n")
23237 (let ((limit (min end element-end)))
23238 (while (< (point) limit)
23239 (org-move-to-column min-ind t)
23241 (forward-line))))))
23243 (org-move-to-column min-ind t)
23245 (forward-line)))))))
23246 (set-marker end nil))))
23251 ;; Org comments syntax is quite complex. It requires the entire line
23252 ;; to be just a comment. Also, even with the right syntax at the
23253 ;; beginning of line, some some elements (i.e. verse-block or
23254 ;; example-block) don't accept comments. Usual Emacs comment commands
23255 ;; cannot cope with those requirements. Therefore, Org replaces them.
23257 ;; Org still relies on `comment-dwim', but cannot trust
23258 ;; `comment-only-p'. So, `comment-region-function' and
23259 ;; `uncomment-region-function' both point
23260 ;; to`org-comment-or-uncomment-region'. Eventually,
23261 ;; `org-insert-comment' takes care of insertion of comments at the
23262 ;; beginning of line.
23264 ;; `org-setup-comments-handling' install comments related variables
23265 ;; during `org-mode' initialization.
23267 (defun org-setup-comments-handling ()
23269 (org-set-local 'comment-use-syntax nil)
23270 (org-set-local 'comment-start "# ")
23271 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23272 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23273 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23274 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23276 (defun org-insert-comment ()
23277 "Insert an empty comment above current line.
23278 If the line is empty, insert comment at its beginning. When
23279 point is within a source block, comment according to the related
23281 (if (let ((element (org-element-at-point)))
23282 (and (eq (org-element-type element) 'src-block)
23284 (goto-char (org-element-property :post-affiliated element))
23285 (line-end-position))
23288 (goto-char (org-element-property :end element))
23289 (skip-chars-backward " \r\t\n")
23290 (line-beginning-position))
23292 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23293 (beginning-of-line)
23294 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23299 (defvar comment-empty-lines) ; From newcomment.el.
23300 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23301 "Comment or uncomment each non-blank line in the region.
23302 Uncomment each non-blank line between BEG and END if it only
23303 contains commented lines. Otherwise, comment them. If region is
23304 strictly within a source block, use appropriate comment syntax."
23305 (if (let ((element (org-element-at-point)))
23306 (and (eq (org-element-type element) 'src-block)
23308 (goto-char (org-element-property :post-affiliated element))
23309 (line-end-position))
23311 (>= (save-excursion
23312 (goto-char (org-element-property :end element))
23313 (skip-chars-backward " \r\t\n")
23314 (line-beginning-position))
23316 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23319 (narrow-to-region (save-excursion (goto-char beg)
23320 (skip-chars-forward " \r\t\n" end)
23321 (line-beginning-position))
23322 (save-excursion (goto-char end)
23323 (skip-chars-backward " \r\t\n" beg)
23324 (line-end-position)))
23326 ;; UNCOMMENTP is non-nil when every non blank line between
23327 ;; BEG and END is a comment.
23329 (goto-char (point-min))
23330 (while (and (not (eobp))
23331 (let ((element (org-element-at-point)))
23332 (and (eq (org-element-type element) 'comment)
23333 (goto-char (min (point-max)
23334 (org-element-property
23335 :end element)))))))
23338 ;; Only blank lines and comments in region: uncomment it.
23340 (goto-char (point-min))
23341 (while (not (eobp))
23342 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23343 (replace-match "" nil nil nil 1))
23345 ;; Comment each line in region.
23346 (let ((min-indent (point-max)))
23347 ;; First find the minimum indentation across all lines.
23349 (goto-char (point-min))
23350 (while (and (not (eobp)) (not (zerop min-indent)))
23351 (unless (looking-at "[ \t]*$")
23352 (setq min-indent (min min-indent (current-indentation))))
23354 ;; Then loop over all lines.
23356 (goto-char (point-min))
23357 (while (not (eobp))
23358 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23359 ;; Don't get fooled by invisible text (e.g. link path)
23360 ;; when moving to column MIN-INDENT.
23361 (let ((buffer-invisibility-spec nil))
23362 (org-move-to-column min-indent t))
23363 (insert comment-start))
23364 (forward-line)))))))))
23366 (defun org-comment-dwim (arg)
23367 "Call `comment-dwim' within a source edit buffer if needed."
23369 (if (org-in-src-block-p)
23370 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23371 (call-interactively 'comment-dwim)))
23376 ;; This section contains tools to operate on timestamp objects, as
23377 ;; returned by, e.g. `org-element-context'.
23379 (defun org-timestamp-has-time-p (timestamp)
23380 "Non-nil when TIMESTAMP has a time specified."
23381 (org-element-property :hour-start timestamp))
23383 (defun org-timestamp-format (timestamp format &optional end utc)
23384 "Format a TIMESTAMP element into a string.
23386 FORMAT is a format specifier to be passed to
23387 `format-time-string'.
23389 When optional argument END is non-nil, use end of date-range or
23390 time-range, if possible.
23392 When optional argument UTC is non-nil, time will be expressed as
23394 (format-time-string
23396 (apply 'encode-time
23399 (lambda (prop) (or (org-element-property prop timestamp) 0))
23400 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23401 '(:minute-start :hour-start :day-start :month-start
23405 (defun org-timestamp-split-range (timestamp &optional end)
23406 "Extract a timestamp object from a date or time range.
23408 TIMESTAMP is a timestamp object. END, when non-nil, means extract
23409 the end of the range. Otherwise, extract its start.
23411 Return a new timestamp object sharing the same parent as
23413 (let ((type (org-element-property :type timestamp)))
23414 (if (memq type '(active inactive diary)) timestamp
23415 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
23417 (org-element-put-property
23418 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23419 ;; Copy start properties over end properties if END is
23420 ;; non-nil. Otherwise, copy end properties over `start' ones.
23421 (let ((p-alist '((:minute-start . :minute-end)
23422 (:hour-start . :hour-end)
23423 (:day-start . :day-end)
23424 (:month-start . :month-end)
23425 (:year-start . :year-end))))
23426 (dolist (p-cell p-alist)
23427 (org-element-put-property
23429 (funcall (if end 'car 'cdr) p-cell)
23430 (org-element-property
23431 (funcall (if end 'cdr 'car) p-cell) split-ts)))
23432 ;; Eventually refresh `:raw-value'.
23433 (org-element-put-property split-ts :raw-value nil)
23434 (org-element-put-property
23435 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23437 (defun org-timestamp-translate (timestamp &optional boundary)
23438 "Translate TIMESTAMP object to custom format.
23440 Format string is defined in `org-time-stamp-custom-formats',
23443 When optional argument BOUNDARY is non-nil, it is either the
23444 symbol `start' or `end'. In this case, only translate the
23445 starting or ending part of TIMESTAMP if it is a date or time
23446 range. Otherwise, translate both parts.
23448 Return timestamp as-is if `org-display-custom-times' is nil or if
23449 it has a `diary' type."
23450 (let ((type (org-element-property :type timestamp)))
23451 (if (or (not org-display-custom-times) (eq type 'diary))
23452 (org-element-interpret-data timestamp)
23453 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23454 org-time-stamp-custom-formats)))
23455 (if (and (not boundary) (memq type '(active-range inactive-range)))
23456 (concat (org-timestamp-format timestamp fmt)
23458 (org-timestamp-format timestamp fmt t))
23459 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23465 (defun org-reftex-citation ()
23466 "Use reftex-citation to insert a citation into the buffer.
23467 This looks for a line like
23469 #+BIBLIOGRAPHY: foo plain option:-d
23471 and derives from it that foo.bib is the bibliography file relevant
23472 for this document. It then installs the necessary environment for RefTeX
23473 to work in this buffer and calls `reftex-citation' to insert a citation
23476 Export of such citations to both LaTeX and HTML is handled by the contributed
23477 package ox-bibtex by Taru Karttunen."
23479 (let ((reftex-docstruct-symbol 'rds)
23480 (reftex-cite-format "\\cite{%l}")
23485 (let ((case-fold-search t)
23486 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23487 (if (not (save-excursion
23488 (or (re-search-forward re nil t)
23489 (re-search-backward re nil t))))
23490 (user-error "No bibliography defined in file")
23491 (setq bib (concat (match-string 1) ".bib")
23492 rds (list (list 'bib bib)))))))
23493 (call-interactively 'reftex-citation)))
23495 ;;;; Functions extending outline functionality
23497 (defun org-beginning-of-line (&optional arg)
23498 "Go to the beginning of the current line. If that is invisible, continue
23499 to a visible line beginning. This makes the function of C-a more intuitive.
23500 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23501 first attempt, and only move to after the tags when the cursor is already
23502 beyond the end of the headline."
23504 (let ((pos (point))
23505 (special (if (consp org-special-ctrl-a/e)
23506 (car org-special-ctrl-a/e)
23507 org-special-ctrl-a/e))
23508 deactivate-mark refpos)
23509 (if (org-bound-and-true-p visual-line-mode)
23510 (beginning-of-visual-line 1)
23511 (beginning-of-line 1))
23512 (if (and arg (fboundp 'move-beginning-of-line))
23513 (call-interactively 'move-beginning-of-line)
23517 (if (org-truely-invisible-p)
23518 (while (and (not (bobp)) (org-truely-invisible-p))
23520 (beginning-of-line 1))
23521 (forward-char 1))))
23524 ((and (looking-at org-complex-heading-regexp)
23525 (= (char-after (match-end 1)) ?\ ))
23526 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23530 (cond ((> pos refpos) refpos)
23531 ((= pos (point)) refpos)
23533 (cond ((> pos (point)) (point))
23534 ((not (eq last-command this-command)) (point))
23537 ;; Being at an item and not looking at an the item means point
23538 ;; was previously moved to beginning of a visual line, which
23539 ;; doesn't contain the item. Therefore, do nothing special,
23541 (when (looking-at org-list-full-item-re)
23542 ;; Set special position at first white space character after
23543 ;; bullet, and check-box, if any.
23544 (let ((after-bullet
23545 (let ((box (match-end 3)))
23546 (if (not box) (match-end 1)
23547 (let ((after (char-after box)))
23548 (if (and after (= after ? )) (1+ box) box))))))
23549 ;; Special case: Move point to special position when
23550 ;; currently after it or at beginning of line.
23552 (when (or (> pos after-bullet) (= (point) pos))
23553 (goto-char after-bullet))
23554 ;; Reversed case: Move point to special position when
23555 ;; point was already at beginning of line and command is
23557 (when (and (= (point) pos) (eq last-command this-command))
23558 (goto-char after-bullet))))))))
23560 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23561 (setq disable-point-adjustment
23562 (or (not (invisible-p (point)))
23563 (not (invisible-p (max (point-min) (1- (point))))))))
23565 (defun org-end-of-line (&optional arg)
23566 "Go to the end of the line.
23567 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23568 tags on the first attempt, and only move to after the tags when
23569 the cursor is already beyond the end of the headline."
23571 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23572 org-special-ctrl-a/e))
23573 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23574 'end-of-visual-line)
23575 ((fboundp 'move-end-of-line) 'move-end-of-line)
23578 (if (or (not special) arg) (call-interactively move-fun)
23579 (let* ((element (save-excursion (beginning-of-line)
23580 (org-element-at-point)))
23581 (type (org-element-type element)))
23583 ((memq type '(headline inlinetask))
23584 (let ((pos (point)))
23585 (beginning-of-line 1)
23586 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23588 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23589 (goto-char (match-beginning 1))
23590 (goto-char (match-end 0)))
23591 (if (or (< pos (match-end 0))
23592 (not (eq this-command last-command)))
23593 (goto-char (match-end 0))
23594 (goto-char (match-beginning 1))))
23595 (call-interactively move-fun))))
23596 ((outline-invisible-p (line-end-position))
23597 ;; If element is hidden, `move-end-of-line' would put point
23598 ;; after it. Use `end-of-line' to stay on current line.
23599 (call-interactively 'end-of-line))
23600 (t (call-interactively move-fun)))))
23601 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23602 (setq disable-point-adjustment
23603 (or (not (invisible-p (point)))
23604 (not (invisible-p (max (point-min) (1- (point))))))))
23606 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23607 (define-key org-mode-map "\C-e" 'org-end-of-line)
23609 (defun org-backward-sentence (&optional arg)
23610 "Go to beginning of sentence, or beginning of table field.
23611 This will call `backward-sentence' or `org-table-beginning-of-field',
23612 depending on context."
23615 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23616 (t (call-interactively 'backward-sentence))))
23618 (defun org-forward-sentence (&optional arg)
23619 "Go to end of sentence, or end of table field.
23620 This will call `forward-sentence' or `org-table-end-of-field',
23621 depending on context."
23624 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23625 (t (call-interactively 'forward-sentence))))
23627 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23628 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23630 (defun org-kill-line (&optional arg)
23631 "Kill line, to tags or end of line."
23634 ((or (not org-special-ctrl-k)
23636 (not (org-at-heading-p)))
23637 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23638 org-ctrl-k-protect-subtree)
23639 (if (or (eq org-ctrl-k-protect-subtree 'error)
23640 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23641 (user-error "C-k aborted as it would kill a hidden subtree")))
23642 (call-interactively
23643 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23644 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23645 (kill-region (point) (match-beginning 1))
23646 (org-set-tags nil t))
23647 (t (kill-region (point) (point-at-eol)))))
23649 (define-key org-mode-map "\C-k" 'org-kill-line)
23651 (defun org-yank (&optional arg)
23652 "Yank. If the kill is a subtree, treat it specially.
23653 This command will look at the current kill and check if is a single
23654 subtree, or a series of subtrees[1]. If it passes the test, and if the
23655 cursor is at the beginning of a line or after the stars of a currently
23656 empty headline, then the yank is handled specially. How exactly depends
23657 on the value of the following variables, both set by default.
23659 `org-yank-folded-subtrees'
23660 When set, the subtree(s) will be folded after insertion, but only
23661 if doing so would now swallow text after the yanked text.
23663 `org-yank-adjusted-subtrees'
23664 When set, the subtree will be promoted or demoted in order to
23665 fit into the local outline tree structure, which means that the
23666 level will be adjusted so that it becomes the smaller one of the
23667 two *visible* surrounding headings.
23669 Any prefix to this command will cause `yank' to be called directly with
23670 no special treatment. In particular, a simple \\[universal-argument] prefix \
23672 plainly yank the text as it is.
23674 \[1] The test checks if the first non-white line is a heading
23675 and if there are no other headings with fewer stars."
23677 (org-yank-generic 'yank arg))
23679 (defun org-yank-generic (command arg)
23680 "Perform some yank-like command.
23682 This function implements the behavior described in the `org-yank'
23683 documentation. However, it has been generalized to work for any
23684 interactive command with similar behavior."
23686 ;; pretend to be command COMMAND
23687 (setq this-command command)
23690 (call-interactively command)
23692 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23693 (and (org-kill-is-subtree-p)
23695 (and (looking-at "[ \t]*$")
23698 (buffer-substring (point-at-bol) (point)))))))
23701 ((and subtreep org-yank-folded-subtrees)
23702 (let ((beg (point))
23704 (if (and subtreep org-yank-adjusted-subtrees)
23705 (org-paste-subtree nil nil 'for-yank)
23706 (call-interactively command))
23710 (when (and (bolp) subtreep
23711 (not (setq swallowp
23712 (org-yank-folding-would-swallow-text beg end))))
23713 (org-with-limited-levels
23714 (or (looking-at org-outline-regexp)
23715 (re-search-forward org-outline-regexp-bol end t))
23716 (while (and (< (point) end) (looking-at org-outline-regexp))
23718 (org-cycle-show-empty-lines 'folded)
23719 (condition-case nil
23720 (outline-forward-same-level 1)
23721 (error (goto-char end))))))
23724 "Inserted text not folded because that would swallow text"))
23727 (skip-chars-forward " \t\n\r")
23728 (beginning-of-line 1)
23729 (push-mark beg 'nomsg)))
23730 ((and subtreep org-yank-adjusted-subtrees)
23731 (let ((beg (point-at-bol)))
23732 (org-paste-subtree nil nil 'for-yank)
23733 (push-mark beg 'nomsg)))
23735 (call-interactively command))))))
23737 (defun org-yank-folding-would-swallow-text (beg end)
23738 "Would hide-subtree at BEG swallow any text after END?"
23740 (org-with-limited-levels
23743 (when (or (looking-at org-outline-regexp)
23744 (re-search-forward org-outline-regexp-bol end t))
23745 (setq level (org-outline-level)))
23747 (skip-chars-forward " \t\r\n\v\f")
23749 (and (bolp) (looking-at org-outline-regexp)
23750 (<= (org-outline-level) level)))
23751 nil ; Nothing would be swallowed
23752 t))))) ; something would swallow
23754 (define-key org-mode-map "\C-y" 'org-yank)
23756 (defun org-truely-invisible-p ()
23757 "Check if point is at a character currently not visible.
23758 This version does not only check the character property, but also
23760 ;; Early versions of noutline don't have `outline-invisible-p'.
23761 (if (org-bound-and-true-p visible-mode)
23763 (outline-invisible-p)))
23765 (defun org-invisible-p2 ()
23766 "Check if point is at a character currently not visible."
23768 (if (and (eolp) (not (bobp))) (backward-char 1))
23769 ;; Early versions of noutline don't have `outline-invisible-p'.
23770 (outline-invisible-p)))
23772 (defun org-back-to-heading (&optional invisible-ok)
23773 "Call `outline-back-to-heading', but provide a better error message."
23774 (condition-case nil
23775 (outline-back-to-heading invisible-ok)
23776 (error (error "Before first headline at position %d in buffer %s"
23777 (point) (current-buffer)))))
23779 (defun org-before-first-heading-p ()
23780 "Before first heading?"
23783 (null (re-search-backward org-outline-regexp-bol nil t))))
23785 (defun org-at-heading-p (&optional ignored)
23786 (outline-on-heading-p t))
23787 ;; Compatibility alias with Org versions < 7.8.03
23788 (defalias 'org-on-heading-p 'org-at-heading-p)
23790 (defun org-in-commented-heading-p (&optional no-inheritance)
23791 "Non-nil if point is under a commented heading.
23792 This function also checks ancestors of the current headline,
23793 unless optional argument NO-INHERITANCE is non-nil."
23795 ((org-before-first-heading-p) nil)
23796 ((let ((headline (nth 4 (org-heading-components))))
23798 (let ((case-fold-search nil))
23799 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23801 (no-inheritance nil)
23803 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23805 (defun org-at-comment-p nil
23806 "Is cursor in a commented line?"
23809 (beginning-of-line)
23810 (looking-at "^[ \t]*# "))))
23812 (defun org-at-drawer-p nil
23813 "Is cursor at a drawer keyword?"
23815 (move-beginning-of-line 1)
23816 (looking-at org-drawer-regexp)))
23818 (defun org-at-block-p nil
23819 "Is cursor at a block keyword?"
23821 (move-beginning-of-line 1)
23822 (looking-at org-block-regexp)))
23824 (defun org-point-at-end-of-empty-headline ()
23825 "If point is at the end of an empty headline, return t, else nil.
23826 If the heading only contains a TODO keyword, it is still still considered
23828 (and (looking-at "[ \t]*$")
23829 (when org-todo-line-regexp
23831 (beginning-of-line 1)
23832 (let ((case-fold-search nil))
23833 (looking-at org-todo-line-regexp)
23834 (string= (match-string 3) ""))))))
23836 (defun org-at-heading-or-item-p ()
23837 (or (org-at-heading-p) (org-at-item-p)))
23839 (defun org-at-target-p ()
23840 (or (org-in-regexp org-radio-target-regexp)
23841 (org-in-regexp org-target-regexp)))
23842 ;; Compatibility alias with Org versions < 7.8.03
23843 (defalias 'org-on-target-p 'org-at-target-p)
23845 (defun org-up-heading-all (arg)
23846 "Move to the heading line of which the present line is a subheading.
23847 This function considers both visible and invisible heading lines.
23848 With argument, move up ARG levels."
23849 (if (fboundp 'outline-up-heading-all)
23850 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23851 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23853 (defun org-up-heading-safe ()
23854 "Move to the heading line of which the present line is a subheading.
23855 This version will not throw an error. It will return the level of the
23856 headline found, or nil if no higher level is found.
23858 Also, this function will be a lot faster than `outline-up-heading',
23859 because it relies on stars being the outline starters. This can really
23860 make a significant difference in outlines with very many siblings."
23861 (when (ignore-errors (org-back-to-heading t))
23862 (let ((level-up (1- (funcall outline-level))))
23863 (and (> level-up 0)
23864 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23865 (funcall outline-level)))))
23867 (defun org-first-sibling-p ()
23868 "Is this heading the first child of its parents?"
23870 (let ((re org-outline-regexp-bol)
23872 (unless (org-at-heading-p t)
23873 (user-error "Not at a heading"))
23874 (setq level (funcall outline-level))
23876 (if (not (re-search-backward re nil t))
23878 (setq l (funcall outline-level))
23881 (defun org-goto-sibling (&optional previous)
23882 "Goto the next sibling, even if it is invisible.
23883 When PREVIOUS is set, go to the previous sibling instead. Returns t
23884 when a sibling was found. When none is found, return nil and don't
23886 (let ((fun (if previous 're-search-backward 're-search-forward))
23888 (re org-outline-regexp-bol)
23890 (when (ignore-errors (org-back-to-heading t))
23891 (setq level (funcall outline-level))
23893 (or previous (forward-char 1))
23894 (while (funcall fun re nil t)
23895 (setq l (funcall outline-level))
23896 (when (< l level) (goto-char pos) (throw 'exit nil))
23897 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23901 (defun org-show-siblings ()
23902 "Show all siblings of the current headline."
23904 (while (org-goto-sibling) (org-flag-heading nil)))
23906 (while (org-goto-sibling 'previous)
23907 (org-flag-heading nil))))
23909 (defun org-goto-first-child ()
23910 "Goto the first child, even if it is invisible.
23911 Return t when a child was found. Otherwise don't move point and
23913 (let (level (pos (point)) (re org-outline-regexp-bol))
23914 (when (ignore-errors (org-back-to-heading t))
23915 (setq level (outline-level))
23917 (if (and (re-search-forward re nil t) (> (outline-level) level))
23918 (progn (goto-char (match-beginning 0)) t)
23919 (goto-char pos) nil))))
23921 (defun org-show-hidden-entry ()
23922 "Show an entry where even the heading is hidden."
23926 (defun org-flag-heading (flag &optional entry)
23927 "Flag the current heading. FLAG non-nil means make invisible.
23928 When ENTRY is non-nil, show the entire entry."
23930 (org-back-to-heading t)
23931 ;; Check if we should show the entire entry
23936 (and (outline-next-heading)
23937 (org-flag-heading nil))))
23938 (outline-flag-region (max (point-min) (1- (point)))
23939 (save-excursion (outline-end-of-heading) (point))
23942 (defun org-get-next-sibling ()
23943 "Move to next heading of the same level, and return point.
23944 If there is no such heading, return nil.
23945 This is like outline-next-sibling, but invisible headings are ok."
23946 (let ((level (funcall outline-level)))
23947 (outline-next-heading)
23948 (while (and (not (eobp)) (> (funcall outline-level) level))
23949 (outline-next-heading))
23950 (if (or (eobp) (< (funcall outline-level) level))
23954 (defun org-get-last-sibling ()
23955 "Move to previous heading of the same level, and return point.
23956 If there is no such heading, return nil."
23957 (let ((opoint (point))
23958 (level (funcall outline-level)))
23959 (outline-previous-heading)
23960 (when (and (/= (point) opoint) (outline-on-heading-p t))
23961 (while (and (> (funcall outline-level) level)
23963 (outline-previous-heading))
23964 (if (< (funcall outline-level) level)
23968 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23969 "Goto to the end of a subtree."
23970 ;; This contains an exact copy of the original function, but it uses
23971 ;; `org-back-to-heading', to make it work also in invisible
23972 ;; trees. And is uses an invisible-ok argument.
23973 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23974 ;; Furthermore, when used inside Org, finding the end of a large subtree
23975 ;; with many children and grandchildren etc, this can be much faster
23976 ;; than the outline version.
23977 (org-back-to-heading invisible-ok)
23979 (level (funcall outline-level)))
23980 (if (and (derived-mode-p 'org-mode) (< level 1000))
23981 ;; A true heading (not a plain list item), in Org-mode
23982 ;; This means we can easily find the end by looking
23983 ;; only for the right number of stars. Using a regexp to do
23984 ;; this is so much faster than using a Lisp loop.
23985 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23987 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23988 ;; something else, do it the slow way
23989 (while (and (not (eobp))
23990 (or first (> (funcall outline-level) level)))
23992 (outline-next-heading)))
23994 (if (memq (preceding-char) '(?\n ?\^M))
23996 ;; Go to end of line before heading
23998 (if (memq (preceding-char) '(?\n ?\^M))
23999 ;; leave blank line before heading
24000 (forward-char -1))))))
24003 (defun org-end-of-meta-data (&optional full)
24004 "Skip planning line and properties drawer in current entry.
24005 When optional argument FULL is non-nil, also skip empty lines,
24006 clocking lines and regular drawers at the beginning of the
24008 (org-back-to-heading t)
24010 (when (org-looking-at-p org-planning-line-re) (forward-line))
24011 (when (looking-at org-property-drawer-re)
24012 (goto-char (match-end 0))
24014 (when (and full (not (org-at-heading-p)))
24016 (let ((end (save-excursion (outline-next-heading) (point)))
24017 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24018 (while (not (eobp))
24019 (cond ((org-looking-at-p org-drawer-regexp)
24020 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24023 ((org-looking-at-p re) (forward-line))
24024 (t (throw 'exit t))))))))
24026 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24027 "Move forward to the ARG'th subheading at same level as this one.
24028 Stop at the first and last subheadings of a superior heading.
24029 Normally this only looks at visible headings, but when INVISIBLE-OK is
24030 non-nil it will also look at invisible ones."
24032 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24033 (if (and arg (< arg 0))
24034 (goto-char (point-min))
24035 (outline-next-heading))
24037 (let ((level (- (match-end 0) (match-beginning 0) 1))
24038 (f (if (and arg (< arg 0))
24039 're-search-backward
24040 're-search-forward))
24041 (count (if arg (abs arg) 1))
24043 (while (and (prog1 (> count 0)
24044 (forward-char (if (and arg (< arg 0)) -1 1)))
24045 (funcall f org-outline-regexp-bol nil 'move))
24046 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24047 (cond ((< l level) (setq count 0))
24051 (goto-char (line-beginning-position))
24052 (not (outline-invisible-p)))))
24053 (setq count (1- count))
24055 (setq result (point)))))))
24056 (goto-char result))
24057 (beginning-of-line 1)))
24059 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24060 "Move backward to the ARG'th subheading at same level as this one.
24061 Stop at the first and last subheadings of a superior heading."
24063 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24065 (defun org-next-visible-heading (arg)
24066 "Move to the next visible heading.
24068 This function wraps `outline-next-visible-heading' with
24069 `org-with-limited-levels' in order to skip over inline tasks and
24070 respect customization of `org-odd-levels-only'."
24072 (org-with-limited-levels
24073 (outline-next-visible-heading arg)))
24075 (defun org-previous-visible-heading (arg)
24076 "Move to the next visible heading.
24078 This function wraps `outline-previous-visible-heading' with
24079 `org-with-limited-levels' in order to skip over inline tasks and
24080 respect customization of `org-odd-levels-only'."
24082 (org-with-limited-levels
24083 (outline-previous-visible-heading arg)))
24085 (defun org-next-block (arg &optional backward block-regexp)
24086 "Jump to the next block.
24087 With a prefix argument ARG, jump forward ARG many source blocks.
24088 When BACKWARD is non-nil, jump to the previous block.
24089 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24091 (let ((re (or block-regexp org-block-regexp))
24092 (re-search-fn (or (and backward 're-search-backward)
24093 're-search-forward)))
24094 (if (looking-at re) (forward-char 1))
24095 (condition-case nil
24096 (funcall re-search-fn re nil nil arg)
24097 (error (user-error "No %s code blocks"
24098 (if backward "previous" "further" ))))
24099 (goto-char (match-beginning 0)) (org-show-context)))
24101 (defun org-previous-block (arg &optional block-regexp)
24102 "Jump to the previous block.
24103 With a prefix argument ARG, jump backward ARG many source blocks.
24104 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24106 (org-next-block arg t block-regexp))
24108 (defun org-forward-paragraph ()
24109 "Move forward to beginning of next paragraph or equivalent.
24111 The function moves point to the beginning of the next visible
24112 structural element, which can be a paragraph, a table, a list
24113 item, etc. It also provides some special moves for convenience:
24115 - On an affiliated keyword, jump to the beginning of the
24117 - On an item or a footnote definition, move to the second
24118 element inside, if any.
24119 - On a table or a property drawer, jump after it.
24120 - On a verse or source block, stop after blank lines."
24122 (when (eobp) (user-error "Cannot move further down"))
24123 (let* ((deactivate-mark nil)
24124 (element (org-element-at-point))
24125 (type (org-element-type element))
24126 (post-affiliated (org-element-property :post-affiliated element))
24127 (contents-begin (org-element-property :contents-begin element))
24128 (contents-end (org-element-property :contents-end element))
24129 (end (let ((end (org-element-property :end element)) (parent element))
24130 (while (and (setq parent (org-element-property :parent parent))
24131 (= (org-element-property :contents-end parent) end))
24132 (setq end (org-element-property :end parent)))
24134 (cond ((not element)
24135 (skip-chars-forward " \r\t\n")
24136 (or (eobp) (beginning-of-line)))
24137 ;; On affiliated keywords, move to element's beginning.
24138 ((< (point) post-affiliated)
24139 (goto-char post-affiliated))
24140 ;; At a table row, move to the end of the table. Similarly,
24141 ;; at a node property, move to the end of the property
24143 ((memq type '(node-property table-row))
24144 (goto-char (org-element-property
24145 :end (org-element-property :parent element))))
24146 ((memq type '(property-drawer table)) (goto-char end))
24147 ;; Consider blank lines as separators in verse and source
24148 ;; blocks to ease editing.
24149 ((memq type '(src-block verse-block))
24150 (when (eq type 'src-block)
24152 (save-excursion (goto-char end)
24153 (skip-chars-backward " \r\t\n")
24154 (line-beginning-position))))
24155 (beginning-of-line)
24156 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24157 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24159 (skip-chars-forward " \r\t\n")
24160 (if (= (point) contents-end) (goto-char end)
24161 (beginning-of-line))))
24162 ;; With no contents, just skip element.
24163 ((not contents-begin) (goto-char end))
24164 ;; If contents are invisible, skip the element altogether.
24165 ((outline-invisible-p (line-end-position))
24168 (org-with-limited-levels (outline-next-visible-heading 1)))
24169 ;; At a plain list, make sure we move to the next item
24170 ;; instead of skipping the whole list.
24171 (plain-list (forward-char)
24172 (org-forward-paragraph))
24173 (otherwise (goto-char end))))
24174 ((>= (point) contents-end) (goto-char end))
24175 ((>= (point) contents-begin)
24176 ;; This can only happen on paragraphs and plain lists.
24178 (paragraph (goto-char end))
24179 ;; At a plain list, try to move to second element in
24180 ;; first item, if possible.
24181 (plain-list (end-of-line)
24182 (org-forward-paragraph))))
24183 ;; When contents start on the middle of a line (e.g. in
24184 ;; items and footnote definitions), try to reach first
24185 ;; element starting after current line.
24186 ((> (line-end-position) contents-begin)
24188 (org-forward-paragraph))
24189 (t (goto-char contents-begin)))))
24191 (defun org-backward-paragraph ()
24192 "Move backward to start of previous paragraph or equivalent.
24194 The function moves point to the beginning of the current
24195 structural element, which can be a paragraph, a table, a list
24196 item, etc., or to the beginning of the previous visible one if
24197 point is already there. It also provides some special moves for
24200 - On an affiliated keyword, jump to the first one.
24201 - On a table or a property drawer, move to its beginning.
24202 - On a verse or source block, stop before blank lines."
24204 (when (bobp) (user-error "Cannot move further up"))
24205 (let* ((deactivate-mark nil)
24206 (element (org-element-at-point))
24207 (type (org-element-type element))
24208 (contents-begin (org-element-property :contents-begin element))
24209 (contents-end (org-element-property :contents-end element))
24210 (post-affiliated (org-element-property :post-affiliated element))
24211 (begin (org-element-property :begin element)))
24213 ((not element) (goto-char (point-min)))
24216 (org-backward-paragraph))
24217 ((<= (point) post-affiliated) (goto-char begin))
24218 ((memq type '(node-property table-row))
24219 (goto-char (org-element-property
24220 :post-affiliated (org-element-property :parent element))))
24221 ((memq type '(property-drawer table)) (goto-char begin))
24222 ((memq type '(src-block verse-block))
24223 (when (eq type 'src-block)
24224 (setq contents-begin
24225 (save-excursion (goto-char begin) (forward-line) (point))))
24226 (if (= (point) contents-begin) (goto-char post-affiliated)
24227 ;; Inside a verse block, see blank lines as paragraph
24229 (let ((origin (point)))
24230 (skip-chars-backward " \r\t\n" contents-begin)
24231 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24232 (skip-chars-forward " \r\t\n" origin)
24233 (if (= (point) origin) (goto-char contents-begin)
24234 (beginning-of-line))))))
24235 ((not contents-begin) (goto-char (or post-affiliated begin)))
24236 ((eq type 'paragraph)
24237 (goto-char contents-begin)
24238 ;; When at first paragraph in an item or a footnote definition,
24239 ;; move directly to beginning of line.
24240 (let ((parent-contents
24241 (org-element-property
24242 :contents-begin (org-element-property :parent element))))
24243 (when (and parent-contents (= parent-contents contents-begin))
24244 (beginning-of-line))))
24245 ;; At the end of a greater element, move to the beginning of the
24246 ;; last element within.
24247 ((>= (point) contents-end)
24248 (goto-char (1- contents-end))
24249 (org-backward-paragraph))
24250 (t (goto-char (or post-affiliated begin))))
24251 ;; Ensure we never leave point invisible.
24252 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24254 (defun org-forward-element ()
24255 "Move forward by one element.
24256 Move to the next element at the same level, when possible."
24258 (cond ((eobp) (user-error "Cannot move further down"))
24259 ((org-with-limited-levels (org-at-heading-p))
24260 (let ((origin (point)))
24261 (goto-char (org-end-of-subtree nil t))
24262 (unless (org-with-limited-levels (org-at-heading-p))
24264 (user-error "Cannot move further down"))))
24266 (let* ((elem (org-element-at-point))
24267 (end (org-element-property :end elem))
24268 (parent (org-element-property :parent elem)))
24269 (cond ((and parent (= (org-element-property :contents-end parent) end))
24270 (goto-char (org-element-property :end parent)))
24271 ((integer-or-marker-p end) (goto-char end))
24272 (t (message "No element at point")))))))
24274 (defun org-backward-element ()
24275 "Move backward by one element.
24276 Move to the previous element at the same level, when possible."
24278 (cond ((bobp) (user-error "Cannot move further up"))
24279 ((org-with-limited-levels (org-at-heading-p))
24280 ;; At a headline, move to the previous one, if any, or stay
24282 (let ((origin (point)))
24283 (org-with-limited-levels (org-backward-heading-same-level 1))
24284 ;; When current headline has no sibling above, move to its
24286 (when (= (point) origin)
24287 (or (org-with-limited-levels (org-up-heading-safe))
24288 (progn (goto-char origin)
24289 (user-error "Cannot move further up"))))))
24291 (let* ((elem (org-element-at-point))
24292 (beg (org-element-property :begin elem)))
24294 ;; Move to beginning of current element if point isn't
24296 ((null beg) (message "No element at point"))
24297 ((/= (point) beg) (goto-char beg))
24299 (skip-chars-backward " \r\t\n")
24301 (let ((prev (org-element-at-point)))
24302 (goto-char (org-element-property :begin prev))
24303 (while (and (setq prev (org-element-property :parent prev))
24304 (<= (org-element-property :end prev) beg))
24305 (goto-char (org-element-property :begin prev)))))))))))
24307 (defun org-up-element ()
24308 "Move to upper element."
24310 (if (org-with-limited-levels (org-at-heading-p))
24311 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24312 (let* ((elem (org-element-at-point))
24313 (parent (org-element-property :parent elem)))
24314 (if parent (goto-char (org-element-property :begin parent))
24315 (if (org-with-limited-levels (org-before-first-heading-p))
24316 (user-error "No surrounding element")
24317 (org-with-limited-levels (org-back-to-heading)))))))
24319 (defvar org-element-greater-elements)
24320 (defun org-down-element ()
24321 "Move to inner element."
24323 (let ((element (org-element-at-point)))
24325 ((memq (org-element-type element) '(plain-list table))
24326 (goto-char (org-element-property :contents-begin element))
24328 ((memq (org-element-type element) org-element-greater-elements)
24329 ;; If contents are hidden, first disclose them.
24330 (when (outline-invisible-p (line-end-position)) (org-cycle))
24331 (goto-char (or (org-element-property :contents-begin element)
24332 (user-error "No content for this element"))))
24333 (t (user-error "No inner element")))))
24335 (defun org-drag-element-backward ()
24336 "Move backward element at point."
24338 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24339 (let* ((elem (org-element-at-point))
24342 (goto-char (org-element-property :begin elem))
24343 (skip-chars-backward " \r\t\n")
24345 (let* ((beg (org-element-property :begin elem))
24346 (prev (org-element-at-point))
24348 (while (and (setq up (org-element-property :parent up))
24349 (<= (org-element-property :end up) beg))
24352 ;; Error out if no previous element or previous element is
24353 ;; a parent of the current one.
24354 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24355 (user-error "Cannot drag element backward")
24356 (let ((pos (point)))
24357 (org-element-swap-A-B prev-elem elem)
24358 (goto-char (+ (org-element-property :begin prev-elem)
24359 (- pos (org-element-property :begin elem)))))))))
24361 (defun org-drag-element-forward ()
24362 "Move forward element at point."
24364 (let* ((pos (point))
24365 (elem (org-element-at-point)))
24366 (when (= (point-max) (org-element-property :end elem))
24367 (user-error "Cannot drag element forward"))
24368 (goto-char (org-element-property :end elem))
24369 (let ((next-elem (org-element-at-point)))
24370 (when (or (org-element-nested-p elem next-elem)
24371 (and (eq (org-element-type next-elem) 'headline)
24372 (not (eq (org-element-type elem) 'headline))))
24374 (user-error "Cannot drag element forward"))
24375 ;; Compute new position of point: it's shifted by NEXT-ELEM
24376 ;; body's length (without final blanks) and by the length of
24377 ;; blanks between ELEM and NEXT-ELEM.
24378 (let ((size-next (- (save-excursion
24379 (goto-char (org-element-property :end next-elem))
24380 (skip-chars-backward " \r\t\n")
24382 ;; Small correction if buffer doesn't end
24383 ;; with a newline character.
24384 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24385 (org-element-property :begin next-elem)))
24386 (size-blank (- (org-element-property :end elem)
24388 (goto-char (org-element-property :end elem))
24389 (skip-chars-backward " \r\t\n")
24392 (org-element-swap-A-B elem next-elem)
24393 (goto-char (+ pos size-next size-blank))))))
24395 (defun org-drag-line-forward (arg)
24396 "Drag the line at point ARG lines forward."
24398 (dotimes (n (abs arg))
24399 (let ((c (current-column)))
24402 (beginning-of-line 2)
24403 (transpose-lines 1)
24404 (beginning-of-line 0))
24405 (transpose-lines 1)
24406 (beginning-of-line -1))
24407 (org-move-to-column c))))
24409 (defun org-drag-line-backward (arg)
24410 "Drag the line at point ARG lines backward."
24412 (org-drag-line-forward (- arg)))
24414 (defun org-mark-element ()
24415 "Put point at beginning of this element, mark at end.
24417 Interactively, if this command is repeated or (in Transient Mark
24418 mode) if the mark is active, it marks the next element after the
24419 ones already marked."
24421 (let (deactivate-mark)
24422 (if (and (org-called-interactively-p 'any)
24423 (or (and (eq last-command this-command) (mark t))
24424 (and transient-mark-mode mark-active)))
24428 (goto-char (org-element-property :end (org-element-at-point)))))
24429 (let ((element (org-element-at-point)))
24431 (push-mark (org-element-property :end element) t t)
24432 (goto-char (org-element-property :begin element))))))
24434 (defun org-narrow-to-element ()
24435 "Narrow buffer to current element."
24437 (let ((elem (org-element-at-point)))
24439 ((eq (car elem) 'headline)
24441 (org-element-property :begin elem)
24442 (org-element-property :end elem)))
24443 ((memq (car elem) org-element-greater-elements)
24445 (org-element-property :contents-begin elem)
24446 (org-element-property :contents-end elem)))
24449 (org-element-property :begin elem)
24450 (org-element-property :end elem))))))
24452 (defun org-transpose-element ()
24453 "Transpose current and previous elements, keeping blank lines between.
24454 Point is moved after both elements."
24456 (org-skip-whitespace)
24457 (let ((end (org-element-property :end (org-element-at-point))))
24458 (org-drag-element-backward)
24461 (defun org-unindent-buffer ()
24462 "Un-indent the visible part of the buffer.
24463 Relative indentation (between items, inside blocks, etc.) isn't
24466 (unless (eq major-mode 'org-mode)
24467 (user-error "Cannot un-indent a buffer not in Org mode"))
24468 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24469 unindent-tree ; For byte-compiler.
24475 (if (memq (org-element-type element) '(headline section))
24476 (funcall unindent-tree (org-element-contents element))
24480 (org-element-property :begin element)
24481 (org-element-property :end element))
24482 (org-do-remove-indentation)))))
24483 (reverse contents))))))
24484 (funcall unindent-tree (org-element-contents parse-tree))))
24486 (defun org-show-subtree ()
24487 "Show everything after this heading at deeper levels."
24489 (outline-flag-region
24492 (org-end-of-subtree t t))
24495 (defun org-show-entry ()
24496 "Show the body directly following this heading.
24497 Show the heading too, if it is currently invisible."
24501 (org-back-to-heading t)
24502 (outline-flag-region
24503 (max (point-min) (1- (point)))
24505 (if (re-search-forward
24506 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24507 (match-beginning 1)
24510 (org-cycle-hide-drawers 'children))))
24512 (defun org-make-options-regexp (kwds &optional extra)
24513 "Make a regular expression for keyword lines.
24514 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24515 when non-nil, is a regexp matching keywords names."
24516 (concat "^[ \t]*#\\+\\("
24518 (and extra (concat (and kwds "\\|") extra))
24519 "\\):[ \t]*\\(.*\\)"))
24521 ;; Make isearch reveal the necessary context
24522 (defun org-isearch-end ()
24523 "Reveal context after isearch exits."
24524 (when isearch-success ; only if search was successful
24525 (if (featurep 'xemacs)
24526 ;; Under XEmacs, the hook is run in the correct place,
24527 ;; we directly show the context.
24528 (org-show-context 'isearch)
24529 ;; In Emacs the hook runs *before* restoring the overlays.
24530 ;; So we have to use a one-time post-command-hook to do this.
24531 ;; (Emacs 22 has a special variable, see function `org-mode')
24532 (unless (and (boundp 'isearch-mode-end-hook-quit)
24533 isearch-mode-end-hook-quit)
24534 ;; Only when the isearch was not quitted.
24535 (org-add-hook 'post-command-hook 'org-isearch-post-command
24536 'append 'local)))))
24538 (defun org-isearch-post-command ()
24539 "Remove self from hook, and show context."
24540 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24541 (org-show-context 'isearch))
24544 ;;;; Integration with and fixes for other packages
24548 (defvar org-imenu-markers nil
24549 "All markers currently used by Imenu.")
24550 (make-variable-buffer-local 'org-imenu-markers)
24552 (defun org-imenu-new-marker (&optional pos)
24553 "Return a new marker for use by Imenu, and remember the marker."
24554 (let ((m (make-marker)))
24555 (move-marker m (or pos (point)))
24556 (push m org-imenu-markers)
24559 (defun org-imenu-get-tree ()
24560 "Produce the index for Imenu."
24561 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24562 (setq org-imenu-markers nil)
24563 (let* ((n org-imenu-depth)
24564 (re (concat "^" (org-get-limited-outline-regexp)))
24565 (subs (make-vector (1+ n) nil))
24567 m level head0 head)
24571 (goto-char (point-max))
24572 (while (re-search-backward re nil t)
24573 (setq level (org-reduced-level (funcall outline-level)))
24574 (when (and (<= level n)
24575 (looking-at org-complex-heading-regexp)
24576 (setq head0 (org-match-string-no-properties 4)))
24577 (setq head (org-link-display-format head0)
24578 m (org-imenu-new-marker))
24579 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24580 (if (>= level last-level)
24581 (push (cons head m) (aref subs level))
24582 (push (cons head (aref subs (1+ level))) (aref subs level))
24583 (loop for i from (1+ level) to n do (aset subs i nil)))
24584 (setq last-level level)))))
24587 (eval-after-load "imenu"
24589 (add-hook 'imenu-after-jump-hook
24591 (if (derived-mode-p 'org-mode)
24592 (org-show-context 'org-goto))))))
24594 (defun org-link-display-format (link)
24595 "Replace a link with its the description.
24596 If there is no description, use the link target."
24598 (if (string-match org-bracket-link-analytic-regexp link)
24599 (replace-match (if (match-end 5)
24600 (match-string 5 link)
24601 (concat (match-string 1 link)
24602 (match-string 3 link)))
24606 (defun org-toggle-link-display ()
24607 "Toggle the literal or descriptive display of links."
24609 (if org-descriptive-links
24610 (progn (org-remove-from-invisibility-spec '(org-link))
24611 (org-restart-font-lock)
24612 (setq org-descriptive-links nil))
24613 (progn (add-to-invisibility-spec '(org-link))
24614 (org-restart-font-lock)
24615 (setq org-descriptive-links t))))
24617 ;; Speedbar support
24619 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24620 "Overlay marking the agenda restriction line in speedbar.")
24621 (overlay-put org-speedbar-restriction-lock-overlay
24622 'face 'org-agenda-restriction-lock)
24623 (overlay-put org-speedbar-restriction-lock-overlay
24624 'help-echo "Agendas are currently limited to this item.")
24625 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24627 (defun org-speedbar-set-agenda-restriction ()
24628 "Restrict future agenda commands to the location at point in speedbar.
24629 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24631 (require 'org-agenda)
24632 (let (p m tp np dir txt)
24634 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24636 (setq m (get-text-property p 'org-imenu-marker))
24637 (with-current-buffer (marker-buffer m)
24639 (org-agenda-set-restriction-lock 'subtree)))
24640 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24641 'speedbar-function 'speedbar-find-file))
24642 (setq tp (previous-single-property-change
24643 (1+ p) 'speedbar-function)
24644 np (next-single-property-change
24645 tp 'speedbar-function)
24646 dir (speedbar-line-directory)
24647 txt (buffer-substring-no-properties (or tp (point-min))
24648 (or np (point-max))))
24649 (with-current-buffer (find-file-noselect
24650 (let ((default-directory dir))
24651 (expand-file-name txt)))
24652 (unless (derived-mode-p 'org-mode)
24653 (user-error "Cannot restrict to non-Org-mode file"))
24654 (org-agenda-set-restriction-lock 'file)))
24655 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24656 (move-overlay org-speedbar-restriction-lock-overlay
24657 (point-at-bol) (point-at-eol))
24658 (setq current-prefix-arg nil)
24659 (org-agenda-maybe-redo)))
24661 (defvar speedbar-file-key-map)
24662 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24663 (eval-after-load "speedbar"
24665 (speedbar-add-supported-extension ".org")
24666 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24667 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24668 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24669 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24670 (add-hook 'speedbar-visiting-tag-hook
24671 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24673 ;;; Fixes and Hacks for problems with other packages
24675 (defun org--flyspell-object-check-p (element)
24676 "Non-nil when Flyspell can check object at point.
24677 ELEMENT is the element at point."
24678 (let ((object (save-excursion
24679 (when (org-looking-at-p "\\>") (backward-char))
24680 (org-element-context element))))
24681 (case (org-element-type object)
24682 ;; Prevent checks in links due to keybinding conflict with
24684 ((code entity export-snippet inline-babel-call
24685 inline-src-block line-break latex-fragment link macro
24686 statistics-cookie target timestamp verbatim)
24688 (footnote-reference
24689 ;; Only in inline footnotes, within the definition.
24690 (and (eq (org-element-property :type object) 'inline)
24692 (goto-char (org-element-property :begin object))
24693 (search-forward ":" nil t 2))
24697 (defun org-mode-flyspell-verify ()
24698 "Function used for `flyspell-generic-check-word-predicate'."
24699 (if (org-at-heading-p)
24700 ;; At a headline or an inlinetask, check title only. This is
24701 ;; faster than relying on `org-element-at-point'.
24702 (and (save-excursion (beginning-of-line)
24703 (and (let ((case-fold-search t))
24704 (not (looking-at "\\*+ END[ \t]*$")))
24705 (looking-at org-complex-heading-regexp)))
24706 (match-beginning 4)
24707 (>= (point) (match-beginning 4))
24708 (or (not (match-beginning 5))
24709 (< (point) (match-beginning 5))))
24710 (let* ((element (org-element-at-point))
24711 (post-affiliated (org-element-property :post-affiliated element)))
24713 ;; Ignore checks in all affiliated keywords but captions.
24714 ((< (point) post-affiliated)
24715 (and (save-excursion
24716 (beginning-of-line)
24717 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24718 (> (point) (match-end 0))
24719 (org--flyspell-object-check-p element)))
24720 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24721 ((let ((log (org-log-into-drawer)))
24723 (let ((drawer (org-element-lineage element '(drawer))))
24725 (eq (compare-strings
24727 (org-element-property :drawer-name drawer) nil nil t)
24731 (case (org-element-type element)
24732 ((comment quote-section) t)
24734 ;; Allow checks between block markers, not on them.
24735 (and (> (line-beginning-position) post-affiliated)
24738 (skip-chars-forward " \r\t\n")
24739 (< (point) (org-element-property :end element)))))
24740 ;; Arbitrary list of keywords where checks are meaningful.
24741 ;; Make sure point is on the value part of the element.
24743 (and (member (org-element-property :key element)
24744 '("DESCRIPTION" "TITLE"))
24746 (beginning-of-line) (search-forward ":") (point))
24748 ;; Check is globally allowed in paragraphs verse blocks and
24749 ;; table rows (after affiliated keywords) but some objects
24750 ;; must not be affected.
24751 ((paragraph table-row verse-block)
24752 (let ((cbeg (org-element-property :contents-begin element))
24753 (cend (org-element-property :contents-end element)))
24754 (and cbeg (>= (point) cbeg) (< (point) cend)
24755 (org--flyspell-object-check-p element))))))))))
24756 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24758 (defun org-remove-flyspell-overlays-in (beg end)
24759 "Remove flyspell overlays in region."
24760 (and (org-bound-and-true-p flyspell-mode)
24761 (fboundp 'flyspell-delete-region-overlays)
24762 (flyspell-delete-region-overlays beg end)))
24764 (defvar flyspell-delayed-commands)
24765 (eval-after-load "flyspell"
24766 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24768 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24769 (eval-after-load "bookmark"
24770 '(if (boundp 'bookmark-after-jump-hook)
24771 ;; We can use the hook
24772 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24773 ;; Hook not available, use advice
24774 (defadvice bookmark-jump (after org-make-visible activate)
24775 "Make the position visible."
24776 (org-bookmark-jump-unhide))))
24778 ;; Make sure saveplace shows the location if it was hidden
24779 (eval-after-load "saveplace"
24780 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24781 "Make the position visible."
24782 (org-bookmark-jump-unhide)))
24784 ;; Make sure ecb shows the location if it was hidden
24785 (eval-after-load "ecb"
24786 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24787 "Make hierarchy visible when jumping into location from ECB tree buffer."
24788 (if (derived-mode-p 'org-mode)
24789 (org-show-context))))
24791 (defun org-bookmark-jump-unhide ()
24792 "Unhide the current position, to show the bookmark location."
24793 (and (derived-mode-p 'org-mode)
24794 (or (outline-invisible-p)
24795 (save-excursion (goto-char (max (point-min) (1- (point))))
24796 (outline-invisible-p)))
24797 (org-show-context 'bookmark-jump)))
24799 (defun org-mark-jump-unhide ()
24800 "Make the point visible with `org-show-context' after jumping to the mark."
24801 (when (and (derived-mode-p 'org-mode)
24802 (outline-invisible-p))
24803 (org-show-context 'mark-goto)))
24805 (eval-after-load "simple"
24806 '(defadvice pop-to-mark-command (after org-make-visible activate)
24807 "Make the point visible with `org-show-context'."
24808 (org-mark-jump-unhide)))
24810 (eval-after-load "simple"
24811 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24812 "Make the point visible with `org-show-context'."
24813 (org-mark-jump-unhide)))
24815 (eval-after-load "simple"
24816 '(defadvice pop-global-mark (after org-make-visible activate)
24817 "Make the point visible with `org-show-context'."
24818 (org-mark-jump-unhide)))
24820 ;; Make session.el ignore our circular variable
24821 (defvar session-globals-exclude)
24822 (eval-after-load "session"
24823 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24829 (run-hooks 'org-load-hook)
24831 ;;; org.el ends here