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))
185 (declare-function org-element-update-syntax
"org-element" ())
187 (defsubst org-uniquify
(list)
188 "Non-destructively remove duplicate elements from LIST."
189 (let ((res (copy-sequence list
))) (delete-dups res
)))
191 (defsubst org-get-at-bol
(property)
192 "Get text property PROPERTY at the beginning of line."
193 (get-text-property (point-at-bol) property
))
195 (defsubst org-trim
(s)
196 "Remove whitespace at the beginning and the end of string S."
197 (replace-regexp-in-string
199 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s
)))
201 ;; load languages based on value of `org-babel-load-languages'
202 (defvar org-babel-load-languages
)
205 (defun org-babel-do-load-languages (sym value
)
206 "Load the languages defined in `org-babel-load-languages'."
207 (set-default sym value
)
209 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
212 (require (intern (concat "ob-" lang
))))
214 (funcall 'fmakunbound
215 (intern (concat "org-babel-execute:" lang
)))
216 (funcall 'fmakunbound
217 (intern (concat "org-babel-expand-body:" lang
)))))))
218 org-babel-load-languages
))
220 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
222 (defun org-babel-load-file (file &optional compile
)
223 "Load Emacs Lisp source code blocks in the Org-mode FILE.
224 This function exports the source code using `org-babel-tangle'
225 and then loads the resulting file using `load-file'. With prefix
226 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
227 file to byte-code before it is loaded."
228 (interactive "fFile to load: \nP")
229 (let* ((age (lambda (file)
231 (time-subtract (current-time)
232 (nth 5 (or (file-attributes (file-truename file
))
233 (file-attributes file
)))))))
234 (base-name (file-name-sans-extension file
))
235 (exported-file (concat base-name
".el")))
236 ;; tangle if the org-mode file is newer than the elisp file
237 (unless (and (file-exists-p exported-file
)
238 (> (funcall age file
) (funcall age exported-file
)))
239 ;; Tangle-file traversal returns reversed list of tangled files
240 ;; and we want to evaluate the first target.
242 (car (last (org-babel-tangle-file file exported-file
"emacs-lisp")))))
245 (progn (byte-compile-file exported-file
'load
)
246 "Compiled and loaded")
247 (progn (load-file exported-file
) "Loaded"))
250 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
251 "Languages which can be evaluated in Org-mode buffers.
252 This list can be used to load support for any of the languages
253 below, note that each language will depend on a different set of
254 system executables and/or Emacs modes. When a language is
255 \"loaded\", then code blocks in that language can be evaluated
256 with `org-babel-execute-src-block' bound by default to C-c
257 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
258 be set to remove code block evaluation from the C-c C-c
259 keybinding. By default only Emacs Lisp (which has no
260 requirements) is loaded."
262 :set
'org-babel-do-load-languages
264 :type
'(alist :tag
"Babel Languages"
267 (const :tag
"Awk" awk
)
270 (const :tag
"Asymptote" asymptote
)
271 (const :tag
"Calc" calc
)
272 (const :tag
"Clojure" clojure
)
273 (const :tag
"CSS" css
)
274 (const :tag
"Ditaa" ditaa
)
275 (const :tag
"Dot" dot
)
276 (const :tag
"Emacs Lisp" emacs-lisp
)
277 (const :tag
"Forth" forth
)
278 (const :tag
"Fortran" fortran
)
279 (const :tag
"Gnuplot" gnuplot
)
280 (const :tag
"Haskell" haskell
)
283 (const :tag
"Java" java
)
284 (const :tag
"Javascript" js
)
285 (const :tag
"LaTeX" latex
)
286 (const :tag
"Ledger" ledger
)
287 (const :tag
"Lilypond" lilypond
)
288 (const :tag
"Lisp" lisp
)
289 (const :tag
"Makefile" makefile
)
290 (const :tag
"Maxima" maxima
)
291 (const :tag
"Matlab" matlab
)
292 (const :tag
"Mscgen" mscgen
)
293 (const :tag
"Ocaml" ocaml
)
294 (const :tag
"Octave" octave
)
295 (const :tag
"Org" org
)
296 (const :tag
"Perl" perl
)
297 (const :tag
"Pico Lisp" picolisp
)
298 (const :tag
"PlantUML" plantuml
)
299 (const :tag
"Python" python
)
300 (const :tag
"Ruby" ruby
)
301 (const :tag
"Sass" sass
)
302 (const :tag
"Scala" scala
)
303 (const :tag
"Scheme" scheme
)
304 (const :tag
"Screen" screen
)
305 (const :tag
"Shell Script" shell
)
306 (const :tag
"Shen" shen
)
307 (const :tag
"Sql" sql
)
308 (const :tag
"Sqlite" sqlite
)
309 (const :tag
"ebnf2ps" ebnf2ps
))
310 :value-type
(boolean :tag
"Activate" :value t
)))
312 ;;;; Customization variables
313 (defcustom org-clone-delete-id nil
314 "Remove ID property of clones of a subtree.
315 When non-nil, clones of a subtree don't inherit the ID property.
316 Otherwise they inherit the ID property with a new unique
326 (defun org-version (&optional here full message
)
327 "Show the org-mode version.
328 Interactively, or when MESSAGE is non-nil, show it in echo area.
329 With prefix argument, or when HERE is non-nil, insert it at point.
330 In non-interactive uses, a reduced version string is output unless
332 (interactive (list current-prefix-arg t
(not current-prefix-arg
)))
333 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
334 (save-load-suffixes (when (boundp 'load-suffixes
) load-suffixes
))
335 (load-suffixes (list ".el"))
336 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
338 (and (fboundp 'org-release
) (fboundp 'org-git-version
))
339 (org-load-noerror-mustsuffix (concat org-dir
"org-version"))))
340 (load-suffixes save-load-suffixes
)
341 (org-version (org-release))
342 (git-version (org-git-version))
343 (version (format "Org-mode version %s (%s @ %s)"
347 (if (string= org-dir org-install-dir
)
349 (concat "mixed installation! " org-install-dir
" and " org-dir
))
350 "org-loaddefs.el can not be found!")))
351 (version1 (if full version org-version
)))
352 (when here
(insert version1
))
353 (when message
(message "%s" version1
))
356 (defconst org-version
(org-version))
363 (defconst org-block-regexp
364 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
365 "Regular expression for hiding blocks.")
367 (defconst org-dblock-start-re
368 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
369 "Matches the start line of a dynamic block, with parameters.")
371 (defconst org-dblock-end-re
"^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
372 "Matches the end of a dynamic block.")
374 ;;;; Clock and Planning
376 (defconst org-clock-string
"CLOCK:"
377 "String used as prefix for timestamps clocking work hours on an item.")
379 (defvar org-closed-string
"CLOSED:"
380 "String used as the prefix for timestamps logging closing a TODO entry.")
382 (defvar org-deadline-string
"DEADLINE:"
383 "String to mark deadline entries.
384 A deadline is this string, followed by a time stamp. Should be a word,
385 terminated by a colon. You can insert a schedule keyword and
386 a timestamp with \\[org-deadline].")
388 (defvar org-scheduled-string
"SCHEDULED:"
389 "String to mark scheduled TODO entries.
390 A schedule is this string, followed by a time stamp. Should be a word,
391 terminated by a colon. You can insert a schedule keyword and
392 a timestamp with \\[org-schedule].")
394 (defconst org-ds-keyword-length
398 (list org-deadline-string org-scheduled-string
399 org-clock-string org-closed-string
))))
400 "Maximum length of the DEADLINE and SCHEDULED keywords.")
402 (defconst org-planning-line-re
405 (list org-closed-string org-deadline-string org-scheduled-string
)
407 "Matches a line with planning info.
408 Matched keyword is in group 1.")
410 (defconst org-clock-line-re
411 (concat "^[ \t]*" org-clock-string
)
412 "Matches a line with clock info.")
414 (defconst org-deadline-regexp
(concat "\\<" org-deadline-string
)
415 "Matches the DEADLINE keyword.")
417 (defconst org-deadline-time-regexp
418 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
419 "Matches the DEADLINE keyword together with a time stamp.")
421 (defconst org-deadline-time-hour-regexp
422 (concat "\\<" org-deadline-string
423 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
424 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
426 (defconst org-deadline-line-regexp
427 (concat "\\<\\(" org-deadline-string
"\\).*")
428 "Matches the DEADLINE keyword and the rest of the line.")
430 (defconst org-scheduled-regexp
(concat "\\<" org-scheduled-string
)
431 "Matches the SCHEDULED keyword.")
433 (defconst org-scheduled-time-regexp
434 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
435 "Matches the SCHEDULED keyword together with a time stamp.")
437 (defconst org-scheduled-time-hour-regexp
438 (concat "\\<" org-scheduled-string
439 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
440 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
442 (defconst org-closed-time-regexp
443 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
444 "Matches the CLOSED keyword together with a time stamp.")
446 (defconst org-keyword-time-regexp
449 (list org-scheduled-string org-deadline-string org-closed-string
452 " *[[<]\\([^]>]+\\)[]>]")
453 "Matches any of the 4 keywords, together with the time stamp.")
455 (defconst org-keyword-time-not-clock-regexp
459 (list org-scheduled-string org-deadline-string org-closed-string
) t
)
460 " *[[<]\\([^]>]+\\)[]>]")
461 "Matches any of the 3 keywords, together with the time stamp.")
463 (defconst org-maybe-keyword-time-regexp
466 (list org-scheduled-string org-deadline-string org-closed-string
470 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]"
473 "Matches a timestamp, possibly preceded by a keyword.")
475 (defconst org-all-time-keywords
476 (mapcar (lambda (w) (substring w
0 -
1))
477 (list org-scheduled-string org-deadline-string
478 org-clock-string org-closed-string
))
479 "List of time keywords.")
483 (defconst org-drawer-regexp
"^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
484 "Matches first or last line of a hidden block.
485 Group 1 contains drawer's name or \"END\".")
487 (defconst org-property-start-re
"^[ \t]*:PROPERTIES:[ \t]*$"
488 "Regular expression matching the first line of a property drawer.")
490 (defconst org-property-end-re
"^[ \t]*:END:[ \t]*$"
491 "Regular expression matching the last line of a property drawer.")
493 (defconst org-clock-drawer-start-re
"^[ \t]*:CLOCK:[ \t]*$"
494 "Regular expression matching the first line of a clock drawer.")
496 (defconst org-clock-drawer-end-re
"^[ \t]*:END:[ \t]*$"
497 "Regular expression matching the last line of a clock drawer.")
499 (defconst org-property-drawer-re
500 (concat "^[ \t]*:PROPERTIES:[ \t]*\n"
501 "\\(?:[ \t]*:\\S-+:\\(?: .*\\)?[ \t]*\n\\)*"
502 "[ \t]*:END:[ \t]*$")
503 "Matches an entire property drawer.")
505 (defconst org-clock-drawer-re
506 (concat "\\(" org-clock-drawer-start-re
"\\)[^\000]*?\\("
507 org-clock-drawer-end-re
"\\)\n?")
508 "Matches an entire clock drawer.")
512 (defconst org-heading-keyword-regexp-format
513 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
514 "Printf format for a regexp matching a headline with some keyword.
515 This regexp will match the headline of any node which has the
516 exact keyword that is put into the format. The keyword isn't in
517 any group by default, but the stars and the body are.")
519 (defconst org-heading-keyword-maybe-regexp-format
520 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
521 "Printf format for a regexp matching a headline, possibly with some keyword.
522 This regexp can match any headline with the specified keyword, or
523 without a keyword. The keyword isn't in any group by default,
524 but the stars and the body are.")
526 (defconst org-archive-tag
"ARCHIVE"
527 "The tag that marks a subtree as archived.
528 An archived subtree does not open during visibility cycling, and does
529 not contribute to the agenda listings.")
531 (defconst org-comment-string
"COMMENT"
532 "Entries starting with this keyword will never be exported.
533 An entry can be toggled between COMMENT and normal with
534 \\[org-toggle-comment].")
537 ;;;; LaTeX Environments and Fragments
539 (defconst org-latex-regexps
540 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
541 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
542 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
543 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
544 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
545 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
546 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil
)
547 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil
))
548 "Regular expressions for matching embedded LaTeX.")
552 (defconst org-effort-property
"Effort"
553 "The property that is being used to keep track of effort estimates.
554 Effort estimates given in this property need to have the format H:MM.")
558 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
559 "Detect an org-type or table-type table.")
561 (defconst org-table-line-regexp
"^[ \t]*|"
562 "Detect an org-type table line.")
564 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
565 "Detect an org-type table line.")
567 (defconst org-table-hline-regexp
"^[ \t]*|-"
568 "Detect an org-type table hline.")
570 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
571 "Detect a table-type table hline.")
573 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
574 "Detect the first line outside a table when searching from within it.
575 This works for both table types.")
577 (defconst org-TBLFM-regexp
"^[ \t]*#\\+TBLFM: "
578 "Detect a #+TBLFM line.")
582 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
583 "Regular expression for fast time stamp matching.")
585 (defconst org-ts-regexp-inactive
586 "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)\\]"
587 "Regular expression for fast inactive time stamp matching.")
589 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
590 "Regular expression for fast time stamp matching.")
592 (defconst org-ts-regexp0
593 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
594 "Regular expression matching time strings for analysis.
595 This one does not require the space after the date, so it can be used
596 on a string that terminates immediately after the date.")
598 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
599 "Regular expression matching time strings for analysis.")
601 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
602 "Regular expression matching time stamps, with groups.")
604 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
605 "Regular expression matching time stamps (also [..]), with groups.")
607 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
608 "Regular expression matching a time stamp range.")
610 (defconst org-tr-regexp-both
611 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
612 "Regular expression matching a time stamp range.")
614 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
615 org-ts-regexp
"\\)?")
616 "Regular expression matching a time stamp or time stamp range.")
618 (defconst org-tsr-regexp-both
619 (concat org-ts-regexp-both
"\\(--?-?"
620 org-ts-regexp-both
"\\)?")
621 "Regular expression matching a time stamp or time stamp range.
622 The time stamps may be either active or inactive.")
624 (defconst org-repeat-re
625 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
626 "Regular expression for specifying repeated events.
627 After a match, group 1 contains the repeat expression.")
629 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
630 "Formats for `format-time-string' which are used for time stamps.")
633 ;;; The custom variables
636 "Outline-based notes management and organizer."
641 (defcustom org-mode-hook nil
642 "Mode hook for Org-mode, run after the mode was turned on."
646 (defcustom org-load-hook nil
647 "Hook that is run after org.el has been loaded."
651 (defcustom org-log-buffer-setup-hook nil
652 "Hook that is run after an Org log buffer is created."
657 (defvar org-modules
) ; defined below
658 (defvar org-modules-loaded nil
659 "Have the modules been loaded already?")
661 (defun org-load-modules-maybe (&optional force
)
662 "Load all extensions listed in `org-modules'."
663 (when (or force
(not org-modules-loaded
))
665 (condition-case nil
(require ext
)
666 (error (message "Problems while trying to load feature `%s'" ext
))))
668 (setq org-modules-loaded t
)))
670 (defun org-set-modules (var value
)
671 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
673 (when (featurep 'org
)
674 (org-load-modules-maybe 'force
)
675 (org-element-cache-reset 'all
)))
677 (defcustom org-modules
'(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail
)
678 "Modules that should always be loaded together with org.el.
680 If a description starts with <C>, the file is not part of Emacs
681 and loading it will require that you have downloaded and properly
682 installed the Org mode distribution.
684 You can also use this system to load external packages (i.e. neither Org
685 core modules, nor modules from the CONTRIB directory). Just add symbols
686 to the end of the list. If the package is called org-xyz.el, then you need
687 to add the symbol `xyz', and the package must have a call to:
691 For export specific modules, see also `org-export-backends'."
693 :set
'org-set-modules
695 :package-version
'(Org .
"8.0")
698 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
699 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
700 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
701 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
702 (const :tag
" docview: Links to doc-view buffers" org-docview
)
703 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
704 (const :tag
" habit: Track your consistency with habits" org-habit
)
705 (const :tag
" id: Global IDs for identifying entries" org-id
)
706 (const :tag
" info: Links to Info nodes" org-info
)
707 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
708 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
709 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
710 (const :tag
" mouse: Additional mouse support" org-mouse
)
711 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
712 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
713 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
715 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
716 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
717 (const :tag
"C bullets: Add overlays to headlines stars" org-bullets
)
718 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
719 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
720 (const :tag
"C collector: Collect properties into tables" org-collector
)
721 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
722 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
723 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
724 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
725 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
726 (const :tag
"C eval: Include command output as text" org-eval
)
727 (const :tag
"C eww: Store link to url of eww" org-eww
)
728 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
729 (const :tag
"C favtable: Lookup table of favorite references and links" org-favtable
)
730 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
731 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
732 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
733 (const :tag
"C jira: Add a jira:ticket protocol to Org-mode" org-jira
)
734 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
735 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
736 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
737 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
738 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
739 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
740 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
741 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
742 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
743 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
744 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
745 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
746 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
747 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
748 (const :tag
"C track: Keep up with Org-mode development" org-track
)
749 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
750 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
751 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
752 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
753 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
755 (defvar org-export-registered-backends
) ; From ox.el.
756 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
757 (declare-function org-export-backend-name
"ox" (backend))
758 (defcustom org-export-backends
'(ascii html icalendar latex
)
759 "List of export back-ends that should be always available.
761 If a description starts with <C>, the file is not part of Emacs
762 and loading it will require that you have downloaded and properly
763 installed the Org mode distribution.
765 Unlike to `org-modules', libraries in this list will not be
766 loaded along with Org, but only once the export framework is
769 This variable needs to be set before org.el is loaded. If you
770 need to make a change while Emacs is running, use the customize
771 interface or run the following code, where VAL stands for the new
772 value of the variable, after updating it:
775 \(setq org-export-registered-backends
778 \(let ((name (org-export-backend-name backend)))
782 \(and (org-export-derived-backend-p b name)
783 \(throw 'parentp t)))))))
784 org-export-registered-backends))
785 \(let ((new-list (mapcar #'org-export-backend-name
786 org-export-registered-backends)))
787 \(dolist (backend val)
789 \((not (load (format \"ox-%s\" backend) t t))
790 \(message \"Problems while trying to load export back-end `%s'\"
792 \((not (memq backend new-list)) (push backend new-list))))
793 \(set-default 'org-export-backends new-list)))
795 Adding a back-end to this list will also pull the back-end it
800 :package-version
'(Org .
"8.0")
801 :initialize
'custom-initialize-set
802 :set
(lambda (var val
)
803 (if (not (featurep 'ox
)) (set-default var val
)
804 ;; Any back-end not required anymore (not present in VAL and not
805 ;; a parent of any back-end in the new value) is removed from the
806 ;; list of registered back-ends.
807 (setq org-export-registered-backends
810 (let ((name (org-export-backend-name backend
)))
814 (and (org-export-derived-backend-p b name
)
815 (throw 'parentp t
)))))))
816 org-export-registered-backends
))
817 ;; Now build NEW-LIST of both new back-ends and required
819 (let ((new-list (mapcar #'org-export-backend-name
820 org-export-registered-backends
)))
821 (dolist (backend val
)
823 ((not (load (format "ox-%s" backend
) t t
))
824 (message "Problems while trying to load export back-end `%s'"
826 ((not (memq backend new-list
)) (push backend new-list
))))
827 ;; Set VAR to that list with fixed dependencies.
828 (set-default var new-list
))))
829 :type
'(set :greedy t
830 (const :tag
" ascii Export buffer to ASCII format" ascii
)
831 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
832 (const :tag
" html Export buffer to HTML format" html
)
833 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
834 (const :tag
" latex Export buffer to LaTeX format" latex
)
835 (const :tag
" man Export buffer to MAN format" man
)
836 (const :tag
" md Export buffer to Markdown format" md
)
837 (const :tag
" odt Export buffer to ODT format" odt
)
838 (const :tag
" org Export buffer to Org format" org
)
839 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
840 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
841 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
842 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
843 (const :tag
"C groff Export buffer to Groff format" groff
)
844 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
845 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
846 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
847 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
852 (condition-case nil
(require (intern (format "ox-%s" backend
)))
853 (error (message "Problems while trying to load export back-end `%s'"
855 org-export-backends
))
857 (defcustom org-support-shift-select nil
858 "Non-nil means make shift-cursor commands select text when possible.
860 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
861 start selecting a region, or enlarge regions started in this way.
862 In Org-mode, in special contexts, these same keys are used for
863 other purposes, important enough to compete with shift selection.
864 Org tries to balance these needs by supporting `shift-select-mode'
865 outside these special contexts, under control of this variable.
867 The default of this variable is nil, to avoid confusing behavior. Shifted
868 cursor keys will then execute Org commands in the following contexts:
869 - on a headline, changing TODO state (left/right) and priority (up/down)
870 - on a time stamp, changing the time
871 - in a plain list item, changing the bullet type
872 - in a property definition line, switching between allowed values
873 - in the BEGIN line of a clock table (changing the time block).
874 Outside these contexts, the commands will throw an error.
876 When this variable is t and the cursor is not in a special
877 context, Org-mode will support shift-selection for making and
878 enlarging regions. To make this more effective, the bullet
879 cycling will no longer happen anywhere in an item line, but only
880 if the cursor is exactly on the bullet.
882 If you set this variable to the symbol `always', then the keys
883 will not be special in headlines, property lines, and item lines,
884 to make shift selection work there as well. If this is what you
885 want, you can use the following alternative commands: `C-c C-t'
886 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
887 can be used to switch TODO sets, `C-c -' to cycle item bullet
888 types, and properties can be edited by hand or in column view.
890 However, when the cursor is on a timestamp, shift-cursor commands
891 will still edit the time stamp - this is just too good to give up.
893 XEmacs user should have this variable set to nil, because
894 `shift-select-mode' is in Emacs 23 or later only."
897 (const :tag
"Never" nil
)
898 (const :tag
"When outside special context" t
)
899 (const :tag
"Everywhere except timestamps" always
)))
901 (defcustom org-loop-over-headlines-in-active-region nil
902 "Shall some commands act upon headlines in the active region?
904 When set to `t', some commands will be performed in all headlines
905 within the active region.
907 When set to `start-level', some commands will be performed in all
908 headlines within the active region, provided that these headlines
909 are of the same level than the first one.
911 When set to a string, those commands will be performed on the
912 matching headlines within the active region. Such string must be
913 a tags/property/todo match as it is used in the agenda tags view.
915 The list of commands is: `org-schedule', `org-deadline',
916 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
917 `org-archive-to-archive-sibling'. The archiving commands skip
918 already archived entries."
919 :type
'(choice (const :tag
"Don't loop" nil
)
920 (const :tag
"All headlines in active region" t
)
921 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
922 (string :tag
"Tags/Property/Todo matcher"))
927 (defgroup org-startup nil
928 "Options concerning startup of Org-mode."
932 (defcustom org-startup-folded t
933 "Non-nil means entering Org-mode will switch to OVERVIEW.
934 This can also be configured on a per-file basis by adding one of
935 the following lines anywhere in the buffer:
937 #+STARTUP: fold (or `overview', this is equivalent)
938 #+STARTUP: nofold (or `showall', this is equivalent)
940 #+STARTUP: showeverything
942 By default, this option is ignored when Org opens agenda files
943 for the first time. If you want the agenda to honor the startup
944 option, set `org-agenda-inhibit-startup' to nil."
947 (const :tag
"nofold: show all" nil
)
948 (const :tag
"fold: overview" t
)
949 (const :tag
"content: all headlines" content
)
950 (const :tag
"show everything, even drawers" showeverything
)))
952 (defcustom org-startup-truncated t
953 "Non-nil means entering Org-mode will set `truncate-lines'.
954 This is useful since some lines containing links can be very long and
955 uninteresting. Also tables look terrible when wrapped."
959 (defcustom org-startup-indented nil
960 "Non-nil means turn on `org-indent-mode' on startup.
961 This can also be configured on a per-file basis by adding one of
962 the following lines anywhere in the buffer:
966 :group
'org-structure
968 (const :tag
"Not" nil
)
969 (const :tag
"Globally (slow on startup in large files)" t
)))
971 (defcustom org-use-sub-superscripts t
972 "Non-nil means interpret \"_\" and \"^\" for display.
974 If you want to control how Org exports those characters, see
975 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
976 used to be an alias for `org-export-with-sub-superscripts' in
977 Org <8.0, it is not anymore.
979 When this option is turned on, you can use TeX-like syntax for
980 sub- and superscripts within the buffer. Several characters after
981 \"_\" or \"^\" will be considered as a single item - so grouping
982 with {} is normally not needed. For example, the following things
983 will be parsed as single sub- or superscripts:
985 10^24 or 10^tau several digits will be considered 1 item.
986 10^-12 or 10^-tau a leading sign with digits or a word
987 x^2-y^3 will be read as x^2 - y^3, because items are
988 terminated by almost any nonword/nondigit char.
989 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
991 Still, ambiguity is possible. So when in doubt, use {} to enclose
992 the sub/superscript. If you set this variable to the symbol `{}',
993 the braces are *required* in order to trigger interpretations as
994 sub/superscript. This can be helpful in documents that need \"_\"
995 frequently in plain text."
998 :package-version
'(Org .
"8.0")
1000 (const :tag
"Always interpret" t
)
1001 (const :tag
"Only with braces" {})
1002 (const :tag
"Never interpret" nil
)))
1004 (defcustom org-startup-with-beamer-mode nil
1005 "Non-nil means turn on `org-beamer-mode' on startup.
1006 This can also be configured on a per-file basis by adding one of
1007 the following lines anywhere in the buffer:
1014 (defcustom org-startup-align-all-tables nil
1015 "Non-nil means align all tables when visiting a file.
1016 This is useful when the column width in tables is forced with <N> cookies
1017 in table fields. Such tables will look correct only after the first re-align.
1018 This can also be configured on a per-file basis by adding one of
1019 the following lines anywhere in the buffer:
1025 (defcustom org-startup-with-inline-images nil
1026 "Non-nil means show inline images when loading a new Org file.
1027 This can also be configured on a per-file basis by adding one of
1028 the following lines anywhere in the buffer:
1029 #+STARTUP: inlineimages
1030 #+STARTUP: noinlineimages"
1035 (defcustom org-startup-with-latex-preview nil
1036 "Non-nil means preview LaTeX fragments when loading a new Org file.
1038 This can also be configured on a per-file basis by adding one of
1039 the following lines anywhere in the buffer:
1040 #+STARTUP: latexpreview
1041 #+STARTUP: nolatexpreview"
1044 :package-version
'(Org .
"8.0")
1047 (defcustom org-insert-mode-line-in-empty-file nil
1048 "Non-nil means insert the first line setting Org-mode in empty files.
1049 When the function `org-mode' is called interactively in an empty file, this
1050 normally means that the file name does not automatically trigger Org-mode.
1051 To ensure that the file will always be in Org-mode in the future, a
1052 line enforcing Org-mode will be inserted into the buffer, if this option
1057 (defcustom org-replace-disputed-keys nil
1058 "Non-nil means use alternative key bindings for some keys.
1059 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
1060 These keys are also used by other packages like shift-selection-mode'
1061 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
1062 If you want to use Org-mode together with one of these other modes,
1063 or more generally if you would like to move some Org-mode commands to
1064 other keys, set this variable and configure the keys with the variable
1065 `org-disputed-keys'.
1067 This option is only relevant at load-time of Org-mode, and must be set
1068 *before* org.el is loaded. Changing it requires a restart of Emacs to
1073 (defcustom org-use-extra-keys nil
1074 "Non-nil means use extra key sequence definitions for certain commands.
1075 This happens automatically if you run XEmacs or if `window-system'
1076 is nil. This variable lets you do the same manually. You must
1077 set it before loading org.
1079 Example: on Carbon Emacs 22 running graphically, with an external
1080 keyboard on a Powerbook, the default way of setting M-left might
1081 not work for either Alt or ESC. Setting this variable will make
1086 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1088 (defcustom org-disputed-keys
1089 '(([(shift up
)] .
[(meta p
)])
1090 ([(shift down
)] .
[(meta n
)])
1091 ([(shift left
)] .
[(meta -
)])
1092 ([(shift right
)] .
[(meta +)])
1093 ([(control shift right
)] .
[(meta shift
+)])
1094 ([(control shift left
)] .
[(meta shift -
)]))
1095 "Keys for which Org-mode and other modes compete.
1096 This is an alist, cars are the default keys, second element specifies
1097 the alternative to use when `org-replace-disputed-keys' is t.
1099 Keys can be specified in any syntax supported by `define-key'.
1100 The value of this option takes effect only at Org-mode's startup,
1101 therefore you'll have to restart Emacs to apply it after changing."
1105 (defun org-key (key)
1106 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1107 Or return the original if not disputed.
1108 Also apply the translations defined in `org-xemacs-key-equivalents'."
1109 (when org-replace-disputed-keys
1110 (let* ((nkey (key-description key
))
1111 (x (org-find-if (lambda (x)
1112 (equal (key-description (car x
)) nkey
))
1113 org-disputed-keys
)))
1114 (setq key
(if x
(cdr x
) key
))))
1115 (when (featurep 'xemacs
)
1116 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1119 (defun org-find-if (predicate seq
)
1122 (if (funcall predicate
(car seq
))
1123 (throw 'exit
(car seq
))
1126 (defun org-defkey (keymap key def
)
1127 "Define a key, possibly translated, as returned by `org-key'."
1128 (define-key keymap
(org-key key
) def
))
1130 (defcustom org-ellipsis nil
1131 "The ellipsis to use in the Org-mode outline.
1132 When nil, just use the standard three dots.
1133 When a string, use that string instead.
1134 When a face, use the standard 3 dots, but with the specified face.
1135 The change affects only Org-mode (which will then use its own display table).
1136 Changing this requires executing \\[org-mode] in a buffer to become
1139 :type
'(choice (const :tag
"Default" nil
)
1140 (face :tag
"Face" :value org-warning
)
1141 (string :tag
"String" :value
"...#")))
1143 (defvar org-display-table nil
1144 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1146 (defgroup org-keywords nil
1147 "Keywords in Org-mode."
1151 (defcustom org-closed-keep-when-no-todo nil
1152 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1154 :group
'org-keywords
1156 :package-version
'(Org .
"8.0")
1159 (defgroup org-structure nil
1160 "Options concerning the general structure of Org-mode files."
1161 :tag
"Org Structure"
1164 (defgroup org-reveal-location nil
1165 "Options about how to make context of a location visible."
1166 :tag
"Org Reveal Location"
1167 :group
'org-structure
)
1169 (defcustom org-show-context-detail
'((isearch . lineage
)
1170 (bookmark-jump . lineage
)
1171 (default . ancestors
))
1172 "Alist between context and visibility span when revealing a location.
1174 \\<org-mode-map>Some actions may move point into invisible
1175 locations. As a consequence, Org always expose a neighborhood
1176 around point. How much is shown depends on the initial action,
1177 or context. Valid contexts are
1179 agenda when exposing an entry from the agenda
1180 org-goto when using the command `org-goto' (\\[org-goto])
1181 occur-tree when using the command `org-occur' (\\[org-sparse-tree] /)
1182 tags-tree when constructing a sparse tree based on tags matches
1183 link-search when exposing search matches associated with a link
1184 mark-goto when exposing the jump goal of a mark
1185 bookmark-jump when exposing a bookmark location
1186 isearch when exiting from an incremental search
1187 default default for all contexts not set explicitly
1189 Allowed visibility spans are
1191 minimal show current headline; if point is not on headline,
1194 local show current headline, entry and next headline
1196 ancestors show current headline and its direct ancestors; if
1197 point is not on headline, also show entry
1199 lineage show current headline, its direct ancestors and all
1200 their children; if point is not on headline, also show
1201 entry and first child
1203 tree show current headline, its direct ancestors and all
1204 their children; if point is not on headline, also show
1205 entry and all children
1207 canonical show current headline, its direct ancestors along with
1208 their entries and children; if point is not located on
1209 the headline, also show current entry and all children
1211 As special cases, a nil or t value means show all contexts in
1212 `minimal' or `canonical' view, respectively.
1214 Some views can make displayed information very compact, but also
1215 make it harder to edit the location of the match. In such
1216 a case, use the command `org-reveal' (\\[org-reveal]) to show
1218 :group
'org-reveal-location
1220 :package-version
'(Org .
"8.3")
1222 (const :tag
"Canonical" t
)
1223 (const :tag
"Minimal" nil
)
1224 (repeat :greedy t
:tag
"Individual contexts"
1226 (choice :tag
"Context"
1233 (const bookmark-jump
)
1236 (choice :tag
"Detail level"
1242 (const canonical
))))))
1244 (defcustom org-indirect-buffer-display
'other-window
1245 "How should indirect tree buffers be displayed?
1246 This applies to indirect buffers created with the commands
1247 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1249 current-window Display in the current window
1250 other-window Just display in another window.
1251 dedicated-frame Create one new frame, and re-use it each time.
1252 new-frame Make a new frame each time. Note that in this case
1253 previously-made indirect buffers are kept, and you need to
1254 kill these buffers yourself."
1255 :group
'org-structure
1256 :group
'org-agenda-windows
1258 (const :tag
"In current window" current-window
)
1259 (const :tag
"In current frame, other window" other-window
)
1260 (const :tag
"Each time a new frame" new-frame
)
1261 (const :tag
"One dedicated frame" dedicated-frame
)))
1263 (defcustom org-use-speed-commands nil
1264 "Non-nil means activate single letter commands at beginning of a headline.
1265 This may also be a function to test for appropriate locations where speed
1266 commands should be active.
1268 For example, to activate speed commands when the point is on any
1269 star at the beginning of the headline, you can do this:
1271 (setq org-use-speed-commands
1272 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1273 :group
'org-structure
1275 (const :tag
"Never" nil
)
1276 (const :tag
"At beginning of headline stars" t
)
1279 (defcustom org-speed-commands-user nil
1280 "Alist of additional speed commands.
1281 This list will be checked before `org-speed-commands-default'
1282 when the variable `org-use-speed-commands' is non-nil
1283 and when the cursor is at the beginning of a headline.
1284 The car if each entry is a string with a single letter, which must
1285 be assigned to `self-insert-command' in the global map.
1286 The cdr is either a command to be called interactively, a function
1287 to be called, or a form to be evaluated.
1288 An entry that is just a list with a single string will be interpreted
1289 as a descriptive headline that will be added when listing the speed
1290 commands in the Help buffer using the `?' speed command."
1291 :group
'org-structure
1292 :type
'(repeat :value
("k" . ignore
)
1293 (choice :value
("k" . ignore
)
1294 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1295 (cons :tag
"Letter and Command"
1296 (string :tag
"Command letter")
1301 (defcustom org-bookmark-names-plist
1302 '(:last-capture
"org-capture-last-stored"
1303 :last-refile
"org-refile-last-stored"
1304 :last-capture-marker
"org-capture-last-stored-marker")
1305 "Names for bookmarks automatically set by some Org commands.
1306 This can provide strings as names for a number of bookmarks Org sets
1307 automatically. The following keys are currently implemented:
1309 :last-capture-marker
1311 When a key does not show up in the property list, the corresponding bookmark
1313 :group
'org-structure
1316 (defgroup org-cycle nil
1317 "Options concerning visibility cycling in Org-mode."
1319 :group
'org-structure
)
1321 (defcustom org-cycle-skip-children-state-if-no-children t
1322 "Non-nil means skip CHILDREN state in entries that don't have any."
1326 (defcustom org-cycle-max-level nil
1327 "Maximum level which should still be subject to visibility cycling.
1328 Levels higher than this will, for cycling, be treated as text, not a headline.
1329 When `org-odd-levels-only' is set, a value of N in this variable actually
1330 means 2N-1 stars as the limiting headline.
1331 When nil, cycle all levels.
1332 Note that the limiting level of cycling is also influenced by
1333 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1334 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1338 (const :tag
"No limit" nil
)
1339 (integer :tag
"Maximum level")))
1341 (defcustom org-hide-block-startup nil
1342 "Non-nil means entering Org-mode will fold all blocks.
1343 This can also be set in on a per-file basis with
1345 #+STARTUP: hideblocks
1346 #+STARTUP: showblocks"
1351 (defcustom org-cycle-global-at-bob nil
1352 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1353 This makes it possible to do global cycling without having to use S-TAB or
1354 \\[universal-argument] TAB. For this special case to work, the first line
1355 of the buffer must not be a headline -- it may be empty or some other text.
1356 When used in this way, `org-cycle-hook' is disabled temporarily to make
1357 sure the cursor stays at the beginning of the buffer. When this option is
1358 nil, don't do anything special at the beginning of the buffer."
1362 (defcustom org-cycle-level-after-item
/entry-creation t
1363 "Non-nil means cycle entry level or item indentation in new empty entries.
1365 When the cursor is at the end of an empty headline, i.e., with only stars
1366 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1367 and then all possible ancestor states, before returning to the original state.
1368 This makes data entry extremely fast: M-RET to create a new headline,
1369 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1371 When the cursor is at the end of an empty plain list item, one TAB will
1372 make it a subitem, two or more tabs will back up to make this an item
1373 higher up in the item hierarchy."
1377 (defcustom org-cycle-emulate-tab t
1378 "Where should `org-cycle' emulate TAB.
1380 white Only in completely white lines
1381 whitestart Only at the beginning of lines, before the first non-white char
1382 t Everywhere except in headlines
1383 exc-hl-bol Everywhere except at the start of a headline
1384 If TAB is used in a place where it does not emulate TAB, the current subtree
1385 visibility is cycled."
1387 :type
'(choice (const :tag
"Never" nil
)
1388 (const :tag
"Only in completely white lines" white
)
1389 (const :tag
"Before first char in a line" whitestart
)
1390 (const :tag
"Everywhere except in headlines" t
)
1391 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1393 (defcustom org-cycle-separator-lines
2
1394 "Number of empty lines needed to keep an empty line between collapsed trees.
1395 If you leave an empty line between the end of a subtree and the following
1396 headline, this empty line is hidden when the subtree is folded.
1397 Org-mode will leave (exactly) one empty line visible if the number of
1398 empty lines is equal or larger to the number given in this variable.
1399 So the default 2 means at least 2 empty lines after the end of a subtree
1400 are needed to produce free space between a collapsed subtree and the
1403 If the number is negative, and the number of empty lines is at least -N,
1404 all empty lines are shown.
1406 Special case: when 0, never leave empty lines in collapsed view."
1409 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1411 (defcustom org-pre-cycle-hook nil
1412 "Hook that is run before visibility cycling is happening.
1413 The function(s) in this hook must accept a single argument which indicates
1414 the new state that will be set right after running this hook. The
1415 argument is a symbol. Before a global state change, it can have the values
1416 `overview', `content', or `all'. Before a local state change, it can have
1417 the values `folded', `children', or `subtree'."
1421 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1422 org-cycle-hide-drawers
1423 org-cycle-show-empty-lines
1424 org-optimize-window-after-visibility-change
)
1425 "Hook that is run after `org-cycle' has changed the buffer visibility.
1426 The function(s) in this hook must accept a single argument which indicates
1427 the new state that was set by the most recent `org-cycle' command. The
1428 argument is a symbol. After a global state change, it can have the values
1429 `overview', `contents', or `all'. After a local state change, it can have
1430 the values `folded', `children', or `subtree'."
1434 :package-version
'(Org .
"8.3"))
1436 (defgroup org-edit-structure nil
1437 "Options concerning structure editing in Org-mode."
1438 :tag
"Org Edit Structure"
1439 :group
'org-structure
)
1441 (defcustom org-odd-levels-only nil
1442 "Non-nil means skip even levels and only use odd levels for the outline.
1443 This has the effect that two stars are being added/taken away in
1444 promotion/demotion commands. It also influences how levels are
1445 handled by the exporters.
1446 Changing it requires restart of `font-lock-mode' to become effective
1447 for fontification also in regions already fontified.
1448 You may also set this on a per-file basis by adding one of the following
1449 lines to the buffer:
1453 :group
'org-edit-structure
1454 :group
'org-appearance
1457 (defcustom org-adapt-indentation t
1458 "Non-nil means adapt indentation to outline node level.
1460 When this variable is set, Org assumes that you write outlines by
1461 indenting text in each node to align with the headline (after the
1462 stars). The following issues are influenced by this variable:
1464 - The indentation is increased by one space in a demotion
1465 command, and decreased by one in a promotion command. However,
1466 in the latter case, if shifting some line in the entry body
1467 would alter document structure (e.g., insert a new headline),
1468 indentation is not changed at all.
1470 - Property drawers and planning information is inserted indented
1471 when this variable is set. When nil, they will not be indented.
1473 - TAB indents a line relative to current level. The lines below
1474 a headline will be indented when this variable is set.
1476 Note that this is all about true indentation, by adding and
1477 removing space characters. See also `org-indent.el' which does
1478 level-dependent indentation in a virtual way, i.e. at display
1480 :group
'org-edit-structure
1483 (defcustom org-special-ctrl-a
/e nil
1484 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1486 When t, `C-a' will bring back the cursor to the beginning of the
1487 headline text, i.e. after the stars and after a possible TODO
1488 keyword. In an item, this will be the position after bullet and
1489 check-box, if any. When the cursor is already at that position,
1490 another `C-a' will bring it to the beginning of the line.
1492 `C-e' will jump to the end of the headline, ignoring the presence
1493 of tags in the headline. A second `C-e' will then jump to the
1494 true end of the line, after any tags. This also means that, when
1495 this variable is non-nil, `C-e' also will never jump beyond the
1496 end of the heading of a folded section, i.e. not after the
1499 When set to the symbol `reversed', the first `C-a' or `C-e' works
1500 normally, going to the true line boundary first. Only a directly
1501 following, identical keypress will bring the cursor to the
1504 This may also be a cons cell where the behavior for `C-a' and
1505 `C-e' is set separately."
1506 :group
'org-edit-structure
1508 (const :tag
"off" nil
)
1509 (const :tag
"on: after stars/bullet and before tags first" t
)
1510 (const :tag
"reversed: true line boundary first" reversed
)
1511 (cons :tag
"Set C-a and C-e separately"
1512 (choice :tag
"Special C-a"
1513 (const :tag
"off" nil
)
1514 (const :tag
"on: after stars/bullet first" t
)
1515 (const :tag
"reversed: before stars/bullet first" reversed
))
1516 (choice :tag
"Special C-e"
1517 (const :tag
"off" nil
)
1518 (const :tag
"on: before tags first" t
)
1519 (const :tag
"reversed: after tags first" reversed
)))))
1520 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1522 (defcustom org-special-ctrl-k nil
1523 "Non-nil means `C-k' will behave specially in headlines.
1524 When nil, `C-k' will call the default `kill-line' command.
1525 When t, the following will happen while the cursor is in the headline:
1527 - When the cursor is at the beginning of a headline, kill the entire
1528 line and possible the folded subtree below the line.
1529 - When in the middle of the headline text, kill the headline up to the tags.
1530 - When after the headline text, kill the tags."
1531 :group
'org-edit-structure
1534 (defcustom org-ctrl-k-protect-subtree nil
1535 "Non-nil means, do not delete a hidden subtree with C-k.
1536 When set to the symbol `error', simply throw an error when C-k is
1537 used to kill (part-of) a headline that has hidden text behind it.
1538 Any other non-nil value will result in a query to the user, if it is
1539 OK to kill that hidden subtree. When nil, kill without remorse."
1540 :group
'org-edit-structure
1543 (const :tag
"Do not protect hidden subtrees" nil
)
1544 (const :tag
"Protect hidden subtrees with a security query" t
)
1545 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1547 (defcustom org-special-ctrl-o t
1548 "Non-nil means, make `C-o' insert a row in tables."
1549 :group
'org-edit-structure
1552 (defcustom org-catch-invisible-edits nil
1553 "Check if in invisible region before inserting or deleting a character.
1556 nil Do not check, so just do invisible edits.
1557 error Throw an error and do nothing.
1558 show Make point visible, and do the requested edit.
1559 show-and-error Make point visible, then throw an error and abort the edit.
1560 smart Make point visible, and do insertion/deletion if it is
1561 adjacent to visible text and the change feels predictable.
1562 Never delete a previously invisible character or add in the
1563 middle or right after an invisible region. Basically, this
1564 allows insertion and backward-delete right before ellipses.
1565 FIXME: maybe in this case we should not even show?"
1566 :group
'org-edit-structure
1569 (const :tag
"Do not check" nil
)
1570 (const :tag
"Throw error when trying to edit" error
)
1571 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1572 (const :tag
"Show invisible part and do the edit" show
)
1573 (const :tag
"Be smart and do the right thing" smart
)))
1575 (defcustom org-yank-folded-subtrees t
1576 "Non-nil means when yanking subtrees, fold them.
1577 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1578 it starts with a heading and all other headings in it are either children
1579 or siblings, then fold all the subtrees. However, do this only if no
1580 text after the yank would be swallowed into a folded tree by this action."
1581 :group
'org-edit-structure
1584 (defcustom org-yank-adjusted-subtrees nil
1585 "Non-nil means when yanking subtrees, adjust the level.
1586 With this setting, `org-paste-subtree' is used to insert the subtree, see
1587 this function for details."
1588 :group
'org-edit-structure
1591 (defcustom org-M-RET-may-split-line
'((default . t
))
1592 "Non-nil means M-RET will split the line at the cursor position.
1593 When nil, it will go to the end of the line before making a
1595 You may also set this option in a different way for different
1596 contexts. Valid contexts are:
1598 headline when creating a new headline
1599 item when creating a new item
1600 table in a table field
1601 default the value to be used for all contexts not explicitly
1603 :group
'org-structure
1606 (const :tag
"Always" t
)
1607 (const :tag
"Never" nil
)
1608 (repeat :greedy t
:tag
"Individual contexts"
1610 (choice :tag
"Context"
1618 (defcustom org-insert-heading-respect-content nil
1619 "Non-nil means insert new headings after the current subtree.
1620 When nil, the new heading is created directly after the current line.
1621 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1622 this variable on for the duration of the command."
1623 :group
'org-structure
1626 (defcustom org-blank-before-new-entry
'((heading . auto
)
1627 (plain-list-item . auto
))
1628 "Should `org-insert-heading' leave a blank line before new heading/item?
1629 The value is an alist, with `heading' and `plain-list-item' as CAR,
1630 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1631 which case Org will look at the surrounding headings/items and try to
1632 make an intelligent decision whether to insert a blank line or not.
1634 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1635 the setting here is ignored and no empty line is inserted to avoid breaking
1636 the list structure."
1637 :group
'org-edit-structure
1639 (cons (const heading
)
1640 (choice (const :tag
"Never" nil
)
1641 (const :tag
"Always" t
)
1642 (const :tag
"Auto" auto
)))
1643 (cons (const plain-list-item
)
1644 (choice (const :tag
"Never" nil
)
1645 (const :tag
"Always" t
)
1646 (const :tag
"Auto" auto
)))))
1648 (defcustom org-insert-heading-hook nil
1649 "Hook being run after inserting a new heading."
1650 :group
'org-edit-structure
1653 (defcustom org-enable-fixed-width-editor t
1654 "Non-nil means lines starting with \":\" are treated as fixed-width.
1655 This currently only means they are never auto-wrapped.
1656 When nil, such lines will be treated like ordinary lines."
1657 :group
'org-edit-structure
1660 (defcustom org-goto-auto-isearch t
1661 "Non-nil means typing characters in `org-goto' starts incremental search.
1662 When nil, you can use these keybindings to navigate the buffer:
1664 q Quit the org-goto interface
1665 n Go to the next visible heading
1666 p Go to the previous visible heading
1667 f Go one heading forward on same level
1668 b Go one heading backward on same level
1669 u Go one heading up"
1670 :group
'org-edit-structure
1673 (defgroup org-sparse-trees nil
1674 "Options concerning sparse trees in Org-mode."
1675 :tag
"Org Sparse Trees"
1676 :group
'org-structure
)
1678 (defcustom org-highlight-sparse-tree-matches t
1679 "Non-nil means highlight all matches that define a sparse tree.
1680 The highlights will automatically disappear the next time the buffer is
1681 changed by an edit command."
1682 :group
'org-sparse-trees
1685 (defcustom org-remove-highlights-with-change t
1686 "Non-nil means any change to the buffer will remove temporary highlights.
1687 Such highlights are created by `org-occur' and `org-clock-display'.
1688 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1689 The highlights created by `org-toggle-latex-fragment' always need
1690 `C-c C-x C-l' to be removed."
1691 :group
'org-sparse-trees
1696 (defcustom org-occur-hook
'(org-first-headline-recenter)
1697 "Hook that is run after `org-occur' has constructed a sparse tree.
1698 This can be used to recenter the window to show as much of the structure
1700 :group
'org-sparse-trees
1703 (defgroup org-imenu-and-speedbar nil
1704 "Options concerning imenu and speedbar in Org-mode."
1705 :tag
"Org Imenu and Speedbar"
1706 :group
'org-structure
)
1708 (defcustom org-imenu-depth
2
1709 "The maximum level for Imenu access to Org-mode headlines.
1710 This also applied for speedbar access."
1711 :group
'org-imenu-and-speedbar
1714 (defgroup org-table nil
1715 "Options concerning tables in Org-mode."
1719 (defcustom org-enable-table-editor
'optimized
1720 "Non-nil means lines starting with \"|\" are handled by the table editor.
1721 When nil, such lines will be treated like ordinary lines.
1723 When equal to the symbol `optimized', the table editor will be optimized to
1725 - Automatic overwrite mode in front of whitespace in table fields.
1726 This makes the structure of the table stay in tact as long as the edited
1727 field does not exceed the column width.
1728 - Minimize the number of realigns. Normally, the table is aligned each time
1729 TAB or RET are pressed to move to another field. With optimization this
1730 happens only if changes to a field might have changed the column width.
1731 Optimization requires replacing the functions `self-insert-command',
1732 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1733 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1734 very good at guessing when a re-align will be necessary, but you can always
1735 force one with \\[org-ctrl-c-ctrl-c].
1737 If you would like to use the optimized version in Org-mode, but the
1738 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1740 This variable can be used to turn on and off the table editor during a session,
1741 but in order to toggle optimization, a restart is required.
1743 See also the variable `org-table-auto-blank-field'."
1746 (const :tag
"off" nil
)
1748 (const :tag
"on, optimized" optimized
)))
1750 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1751 (version<= emacs-version
"24.1"))
1752 "Non-nil means cluster self-insert commands for undo when possible.
1753 If this is set, then, like in the Emacs command loop, 20 consecutive
1754 characters will be undone together.
1755 This is configurable, because there is some impact on typing performance."
1759 (defcustom org-table-tab-recognizes-table.el t
1760 "Non-nil means TAB will automatically notice a table.el table.
1761 When it sees such a table, it moves point into it and - if necessary -
1762 calls `table-recognize-table'."
1763 :group
'org-table-editing
1766 (defgroup org-link nil
1767 "Options concerning links in Org-mode."
1771 (defvar org-link-abbrev-alist-local nil
1772 "Buffer-local version of `org-link-abbrev-alist', which see.
1773 The value of this is taken from the #+LINK lines.")
1774 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1776 (defcustom org-link-abbrev-alist nil
1777 "Alist of link abbreviations.
1778 The car of each element is a string, to be replaced at the start of a link.
1779 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1780 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1782 [[linkkey:tag][description]]
1784 The 'linkkey' must be a word word, starting with a letter, followed
1785 by letters, numbers, '-' or '_'.
1787 If REPLACE is a string, the tag will simply be appended to create the link.
1788 If the string contains \"%s\", the tag will be inserted there. If the string
1789 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1790 at that point (see the function `url-hexify-string'). If the string contains
1791 the specifier \"%(my-function)\", then the custom function `my-function' will
1792 be invoked: this function takes the tag as its only argument and must return
1795 REPLACE may also be a function that will be called with the tag as the
1796 only argument to create the link, which should be returned as a string.
1798 See the manual for examples."
1802 (string :tag
"Protocol")
1804 (string :tag
"Format")
1807 (defcustom org-descriptive-links t
1808 "Non-nil means Org will display descriptive links.
1809 E.g. [[http://orgmode.org][Org website]] will be displayed as
1810 \"Org Website\", hiding the link itself and just displaying its
1811 description. When set to `nil', Org will display the full links
1814 You can interactively set the value of this variable by calling
1815 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1819 (defcustom org-link-file-path-type
'adaptive
1820 "How the path name in file links should be stored.
1823 relative Relative to the current directory, i.e. the directory of the file
1824 into which the link is being inserted.
1825 absolute Absolute path, if possible with ~ for home directory.
1826 noabbrev Absolute path, no abbreviation of home directory.
1827 adaptive Use relative path for files in the current directory and sub-
1828 directories of it. For other files, use an absolute path."
1836 (defvaralias 'org-activate-links
'org-highlight-links
)
1837 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1838 "Types of links that should be highlighted in Org-mode files.
1840 This is a list of symbols, each one of them leading to the
1841 highlighting of a certain link type.
1843 You can still open links that are not highlighted.
1845 In principle, it does not hurt to turn on highlighting for all
1846 link types. There may be a small gain when turning off unused
1847 link types. The types are:
1849 bracket The recommended [[link][description]] or [[link]] links with hiding.
1850 angle Links in angular brackets that may contain whitespace like
1851 <bbdb:Carsten Dominik>.
1852 plain Plain links in normal text, no whitespace, like http://google.com.
1853 radio Text that is matched by a radio target, see manual for details.
1854 tag Tag settings in a headline (link to tag search).
1855 date Time stamps (link to calendar).
1856 footnote Footnote labels.
1858 If you set this variable during an Emacs session, use `org-mode-restart'
1859 in the Org buffer so that the change takes effect."
1861 :group
'org-appearance
1862 :type
'(set :greedy t
1863 (const :tag
"Double bracket links" bracket
)
1864 (const :tag
"Angular bracket links" angle
)
1865 (const :tag
"Plain text links" plain
)
1866 (const :tag
"Radio target matches" radio
)
1867 (const :tag
"Tags" tag
)
1868 (const :tag
"Timestamps" date
)
1869 (const :tag
"Footnotes" footnote
)))
1871 (defcustom org-make-link-description-function nil
1872 "Function to use for generating link descriptions from links.
1873 When nil, the link location will be used. This function must take
1874 two parameters: the first one is the link, the second one is the
1875 description generated by `org-insert-link'. The function should
1876 return the description to use."
1878 :type
'(choice (const nil
) (function)))
1880 (defgroup org-link-store nil
1881 "Options concerning storing links in Org-mode."
1882 :tag
"Org Store Link"
1885 (defcustom org-url-hexify-p t
1886 "When non-nil, hexify URL when creating a link."
1889 :group
'org-link-store
)
1891 (defcustom org-email-link-description-format
"Email %c: %.30s"
1892 "Format of the description part of a link to an email or usenet message.
1893 The following %-escapes will be replaced by corresponding information:
1895 %F full \"From\" field
1896 %f name, taken from \"From\" field, address if no name
1897 %T full \"To\" field
1898 %t first name in \"To\" field, address if no name
1899 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1900 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1905 You may use normal field width specification between the % and the letter.
1906 This is for example useful to limit the length of the subject.
1908 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1909 :group
'org-link-store
1912 (defcustom org-from-is-user-regexp
1914 (when (and user-mail-address
(not (string= user-mail-address
"")))
1915 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1916 (when (and user-full-name
(not (string= user-full-name
"")))
1917 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1918 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1919 "Regexp matched against the \"From:\" header of an email or usenet message.
1920 It should match if the message is from the user him/herself."
1921 :group
'org-link-store
1924 (defcustom org-context-in-file-links t
1925 "Non-nil means file links from `org-store-link' contain context.
1926 A search string will be added to the file name with :: as separator and
1927 used to find the context when the link is activated by the command
1928 `org-open-at-point'. When this option is t, the entire active region
1929 will be placed in the search string of the file link. If set to a
1930 positive integer, only the first n lines of context will be stored.
1932 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1933 negates this setting for the duration of the command."
1934 :group
'org-link-store
1935 :type
'(choice boolean integer
))
1937 (defcustom org-keep-stored-link-after-insertion nil
1938 "Non-nil means keep link in list for entire session.
1940 The command `org-store-link' adds a link pointing to the current
1941 location to an internal list. These links accumulate during a session.
1942 The command `org-insert-link' can be used to insert links into any
1943 Org-mode file (offering completion for all stored links). When this
1944 option is nil, every link which has been inserted once using \\[org-insert-link]
1945 will be removed from the list, to make completing the unused links
1947 :group
'org-link-store
1950 (defgroup org-link-follow nil
1951 "Options concerning following links in Org-mode."
1952 :tag
"Org Follow Link"
1955 (defcustom org-link-translation-function nil
1956 "Function to translate links with different syntax to Org syntax.
1957 This can be used to translate links created for example by the Planner
1958 or emacs-wiki packages to Org syntax.
1959 The function must accept two parameters, a TYPE containing the link
1960 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1961 which is everything after the link protocol. It should return a cons
1962 with possibly modified values of type and path.
1963 Org contains a function for this, so if you set this variable to
1964 `org-translate-link-from-planner', you should be able follow many
1965 links created by planner."
1966 :group
'org-link-follow
1967 :type
'(choice (const nil
) (function)))
1969 (defcustom org-follow-link-hook nil
1970 "Hook that is run after a link has been followed."
1971 :group
'org-link-follow
1974 (defcustom org-tab-follows-link nil
1975 "Non-nil means on links TAB will follow the link.
1976 Needs to be set before org.el is loaded.
1977 This really should not be used, it does not make sense, and the
1978 implementation is bad."
1979 :group
'org-link-follow
1982 (defcustom org-return-follows-link nil
1983 "Non-nil means on links RET will follow the link.
1984 In tables, the special behavior of RET has precedence."
1985 :group
'org-link-follow
1988 (defcustom org-mouse-1-follows-link
1989 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1990 "Non-nil means mouse-1 on a link will follow the link.
1991 A longer mouse click will still set point. Does not work on XEmacs.
1992 Needs to be set before org.el is loaded."
1993 :group
'org-link-follow
1995 :package-version
'(Org .
"8.3")
1997 (const :tag
"A double click follows the link" double
)
1998 (const :tag
"Unconditionally follow the link with mouse-1" t
)
1999 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
2001 (defcustom org-mark-ring-length
4
2002 "Number of different positions to be recorded in the ring.
2003 Changing this requires a restart of Emacs to work correctly."
2004 :group
'org-link-follow
2007 (defcustom org-link-search-must-match-exact-headline
'query-to-create
2008 "Non-nil means internal links in Org files must exactly match a headline.
2009 When nil, the link search tries to match a phrase with all words
2010 in the search text."
2011 :group
'org-link-follow
2014 (const :tag
"Use fuzzy text search" nil
)
2015 (const :tag
"Match only exact headline" t
)
2016 (const :tag
"Match exact headline or query to create it"
2019 (defcustom org-link-frame-setup
2020 '((vm . vm-visit-folder-other-frame
)
2021 (vm-imap . vm-visit-imap-folder-other-frame
)
2022 (gnus . org-gnus-no-new-news
)
2023 (file . find-file-other-window
)
2024 (wl . wl-other-frame
))
2025 "Setup the frame configuration for following links.
2026 When following a link with Emacs, it may often be useful to display
2027 this link in another window or frame. This variable can be used to
2028 set this up for the different types of links.
2031 `vm-visit-folder-other-window'
2032 `vm-visit-folder-other-frame'
2033 For Gnus, use any of
2036 `org-gnus-no-new-news'
2037 For FILE, use any of
2039 `find-file-other-window'
2040 `find-file-other-frame'
2041 For Wanderlust use any of
2044 For the calendar, use the variable `calendar-setup'.
2045 For BBDB, it is currently only possible to display the matches in
2047 :group
'org-link-follow
2051 (const vm-visit-folder
)
2052 (const vm-visit-folder-other-window
)
2053 (const vm-visit-folder-other-frame
)))
2054 (cons (const vm-imap
)
2056 (const vm-visit-imap-folder
)
2057 (const vm-visit-imap-folder-other-window
)
2058 (const vm-visit-imap-folder-other-frame
)))
2062 (const gnus-other-frame
)
2063 (const org-gnus-no-new-news
)))
2067 (const find-file-other-window
)
2068 (const find-file-other-frame
)))
2072 (const wl-other-frame
)))))
2074 (defcustom org-display-internal-link-with-indirect-buffer nil
2075 "Non-nil means use indirect buffer to display infile links.
2076 Activating internal links (from one location in a file to another location
2077 in the same file) normally just jumps to the location. When the link is
2078 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
2080 another window. When this option is set, the other window actually displays
2081 an indirect buffer clone of the current buffer, to avoid any visibility
2082 changes to the current buffer."
2083 :group
'org-link-follow
2086 (defcustom org-open-non-existing-files nil
2087 "Non-nil means `org-open-file' will open non-existing files.
2088 When nil, an error will be generated.
2089 This variable applies only to external applications because they
2090 might choke on non-existing files. If the link is to a file that
2091 will be opened in Emacs, the variable is ignored."
2092 :group
'org-link-follow
2095 (defcustom org-open-directory-means-index-dot-org nil
2096 "Non-nil means a link to a directory really means to index.org.
2097 When nil, following a directory link will run dired or open a finder/explorer
2098 window on that directory."
2099 :group
'org-link-follow
2102 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2103 "Non-nil means ask for confirmation before executing shell links.
2104 Shell links can be dangerous: just think about a link
2106 [[shell:rm -rf ~/*][Google Search]]
2108 This link would show up in your Org-mode document as \"Google Search\",
2109 but really it would remove your entire home directory.
2110 Therefore we advise against setting this variable to nil.
2111 Just change it to `y-or-n-p' if you want to confirm with a
2112 single keystroke rather than having to type \"yes\"."
2113 :group
'org-link-follow
2115 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2116 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2117 (const :tag
"no confirmation (dangerous)" nil
)))
2118 (put 'org-confirm-shell-link-function
2119 'safe-local-variable
2120 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2122 (defcustom org-confirm-shell-link-not-regexp
""
2123 "A regexp to skip confirmation for shell links."
2124 :group
'org-link-follow
2128 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2129 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2130 Elisp links can be dangerous: just think about a link
2132 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2134 This link would show up in your Org-mode document as \"Google Search\",
2135 but really it would remove your entire home directory.
2136 Therefore we advise against setting this variable to nil.
2137 Just change it to `y-or-n-p' if you want to confirm with a
2138 single keystroke rather than having to type \"yes\"."
2139 :group
'org-link-follow
2141 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2142 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2143 (const :tag
"no confirmation (dangerous)" nil
)))
2144 (put 'org-confirm-shell-link-function
2145 'safe-local-variable
2146 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2148 (defcustom org-confirm-elisp-link-not-regexp
""
2149 "A regexp to skip confirmation for Elisp links."
2150 :group
'org-link-follow
2154 (defconst org-file-apps-defaults-gnu
2158 "Default file applications on a UNIX or GNU/Linux system.
2159 See `org-file-apps'.")
2161 (defconst org-file-apps-defaults-macosx
2164 (system .
"open %s")
2166 ("eps.gz" .
"gv %s")
2168 ("fig" .
"xfig %s"))
2169 "Default file applications on a MacOS X system.
2170 The system \"open\" is known as a default, but we use X11 applications
2171 for some files for which the OS does not have a good default.
2172 See `org-file-apps'.")
2174 (defconst org-file-apps-defaults-windowsnt
2178 (list (if (featurep 'xemacs
)
2179 'mswindows-shell-execute
2183 (list (if (featurep 'xemacs
)
2184 'mswindows-shell-execute
2187 "Default file applications on a Windows NT system.
2188 The system \"open\" is used for most files.
2189 See `org-file-apps'.")
2191 (defcustom org-file-apps
2192 '((auto-mode . emacs
)
2193 ("\\.mm\\'" . default
)
2194 ("\\.x?html?\\'" . default
)
2195 ("\\.pdf\\'" . default
))
2196 "External applications for opening `file:path' items in a document.
2197 Org-mode uses system defaults for different file types, but
2198 you can use this variable to set the application for a given file
2199 extension. The entries in this list are cons cells where the car identifies
2200 files and the cdr the corresponding command. Possible values for the
2202 \"string\" A string as a file identifier can be interpreted in different
2203 ways, depending on its contents:
2205 - Alphanumeric characters only:
2206 Match links with this file extension.
2207 Example: (\"pdf\" . \"evince %s\")
2208 to open PDFs with evince.
2210 - Regular expression: Match links where the
2211 filename matches the regexp. If you want to
2212 use groups here, use shy groups.
2214 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2215 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2216 to open *.html and *.xhtml with firefox.
2218 - Regular expression which contains (non-shy) groups:
2219 Match links where the whole link, including \"::\", and
2220 anything after that, matches the regexp.
2221 In a custom command string, %1, %2, etc. are replaced with
2222 the parts of the link that were matched by the groups.
2223 For backwards compatibility, if a command string is given
2224 that does not use any of the group matches, this case is
2225 handled identically to the second one (i.e. match against
2227 In a custom lisp form, you can access the group matches with
2228 (match-string n link).
2230 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2231 to open [[file:document.pdf::5]] with evince at page 5.
2233 `directory' Matches a directory
2234 `remote' Matches a remote file, accessible through tramp or efs.
2235 Remote files most likely should be visited through Emacs
2236 because external applications cannot handle such paths.
2237 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2238 so all files Emacs knows how to handle. Using this with
2239 command `emacs' will open most files in Emacs. Beware that this
2240 will also open html files inside Emacs, unless you add
2241 (\"html\" . default) to the list as well.
2242 t Default for files not matched by any of the other options.
2243 `system' The system command to open files, like `open' on Windows
2244 and Mac OS X, and mailcap under GNU/Linux. This is the command
2245 that will be selected if you call `C-c C-o' with a double
2246 \\[universal-argument] \\[universal-argument] prefix.
2248 Possible values for the command are:
2249 `emacs' The file will be visited by the current Emacs process.
2250 `default' Use the default application for this file type, which is the
2251 association for t in the list, most likely in the system-specific
2253 This can be used to overrule an unwanted setting in the
2254 system-specific variable.
2255 `system' Use the system command for opening files, like \"open\".
2256 This command is specified by the entry whose car is `system'.
2257 Most likely, the system-specific version of this variable
2258 does define this command, but you can overrule/replace it
2260 string A command to be executed by a shell; %s will be replaced
2261 by the path to the file.
2262 sexp A Lisp form which will be evaluated. The file path will
2263 be available in the Lisp variable `file'.
2264 For more examples, see the system specific constants
2265 `org-file-apps-defaults-macosx'
2266 `org-file-apps-defaults-windowsnt'
2267 `org-file-apps-defaults-gnu'."
2268 :group
'org-link-follow
2270 (cons (choice :value
""
2271 (string :tag
"Extension")
2272 (const :tag
"System command to open files" system
)
2273 (const :tag
"Default for unrecognized files" t
)
2274 (const :tag
"Remote file" remote
)
2275 (const :tag
"Links to a directory" directory
)
2276 (const :tag
"Any files that have Emacs modes"
2279 (const :tag
"Visit with Emacs" emacs
)
2280 (const :tag
"Use default" default
)
2281 (const :tag
"Use the system command" system
)
2282 (string :tag
"Command")
2283 (sexp :tag
"Lisp form")))))
2285 (defcustom org-doi-server-url
"http://dx.doi.org/"
2286 "The URL of the DOI server."
2289 :group
'org-link-follow
)
2291 (defgroup org-refile nil
2292 "Options concerning refiling entries in Org-mode."
2296 (defcustom org-directory
"~/org"
2297 "Directory with org files.
2298 This is just a default location to look for Org files. There is no need
2299 at all to put your files into this directory. It is only used in the
2300 following situations:
2302 1. When a capture template specifies a target file that is not an
2303 absolute path. The path will then be interpreted relative to
2305 2. When a capture note is filed away in an interactive way (when exiting the
2306 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2307 with `org-directory' as the default path."
2312 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2313 "Default target for storing notes.
2314 Used as a fall back file for org-capture.el, for templates that
2315 do not specify a target file."
2319 (const :tag
"Default from remember-data-file" nil
)
2322 (defcustom org-goto-interface
'outline
2323 "The default interface to be used for `org-goto'.
2325 outline The interface shows an outline of the relevant file
2326 and the correct heading is found by moving through
2327 the outline or by searching with incremental search.
2328 outline-path-completion Headlines in the current buffer are offered via
2329 completion. This is the interface also used by
2330 the refile command."
2333 (const :tag
"Outline" outline
)
2334 (const :tag
"Outline-path-completion" outline-path-completion
)))
2336 (defcustom org-goto-max-level
5
2337 "Maximum target level when running `org-goto' with refile interface."
2341 (defcustom org-reverse-note-order nil
2342 "Non-nil means store new notes at the beginning of a file or entry.
2343 When nil, new notes will be filed to the end of a file or entry.
2344 This can also be a list with cons cells of regular expressions that
2345 are matched against file names, and values."
2349 (const :tag
"Reverse always" t
)
2350 (const :tag
"Reverse never" nil
)
2351 (repeat :tag
"By file name regexp"
2352 (cons regexp boolean
))))
2354 (defcustom org-log-refile nil
2355 "Information to record when a task is refiled.
2357 Possible values are:
2359 nil Don't add anything
2360 time Add a time stamp to the task
2361 note Prompt for a note and add it with template `org-log-note-headings'
2363 This option can also be set with on a per-file-basis with
2365 #+STARTUP: nologrefile
2366 #+STARTUP: logrefile
2367 #+STARTUP: lognoterefile
2369 You can have local logging settings for a subtree by setting the LOGGING
2370 property to one or more of these keywords.
2372 When bulk-refiling from the agenda, the value `note' is forbidden and
2373 will temporarily be changed to `time'."
2375 :group
'org-progress
2378 (const :tag
"No logging" nil
)
2379 (const :tag
"Record timestamp" time
)
2380 (const :tag
"Record timestamp with note." note
)))
2382 (defcustom org-refile-targets nil
2383 "Targets for refiling entries with \\[org-refile].
2384 This is a list of cons cells. Each cell contains:
2385 - a specification of the files to be considered, either a list of files,
2386 or a symbol whose function or variable value will be used to retrieve
2387 a file name or a list of file names. If you use `org-agenda-files' for
2388 that, all agenda files will be scanned for targets. Nil means consider
2389 headings in the current buffer.
2390 - A specification of how to find candidate refile targets. This may be
2392 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2393 This tag has to be present in all target headlines, inheritance will
2395 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2397 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2398 headlines that are refiling targets.
2399 - a cons cell (:level . N). Any headline of level N is considered a target.
2400 Note that, when `org-odd-levels-only' is set, level corresponds to
2401 order in hierarchy, not to the number of stars.
2402 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2403 Note that, when `org-odd-levels-only' is set, level corresponds to
2404 order in hierarchy, not to the number of stars.
2406 Each element of this list generates a set of possible targets.
2407 The union of these sets is presented (with completion) to
2408 the user by `org-refile'.
2410 You can set the variable `org-refile-target-verify-function' to a function
2411 to verify each headline found by the simple criteria above.
2413 When this variable is nil, all top-level headlines in the current buffer
2414 are used, equivalent to the value `((nil . (:level . 1))'."
2418 (choice :value org-agenda-files
2419 (const :tag
"All agenda files" org-agenda-files
)
2420 (const :tag
"Current buffer" nil
)
2421 (function) (variable) (file))
2422 (choice :tag
"Identify target headline by"
2423 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2424 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2425 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2426 (cons :tag
"Level number" (const :value
:level
) (integer))
2427 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2429 (defcustom org-refile-target-verify-function nil
2430 "Function to verify if the headline at point should be a refile target.
2431 The function will be called without arguments, with point at the
2432 beginning of the headline. It should return t and leave point
2433 where it is if the headline is a valid target for refiling.
2435 If the target should not be selected, the function must return nil.
2436 In addition to this, it may move point to a place from where the search
2437 should be continued. For example, the function may decide that the entire
2438 subtree of the current entry should be excluded and move point to the end
2445 (defcustom org-refile-use-cache nil
2446 "Non-nil means cache refile targets to speed up the process.
2447 The cache for a particular file will be updated automatically when
2448 the buffer has been killed, or when any of the marker used for flagging
2449 refile targets no longer points at a live buffer.
2450 If you have added new entries to a buffer that might themselves be targets,
2451 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2452 find that easier, `C-u C-u C-u C-c C-w'."
2457 (defcustom org-refile-use-outline-path nil
2458 "Non-nil means provide refile targets as paths.
2459 So a level 3 headline will be available as level1/level2/level3.
2461 When the value is `file', also include the file name (without directory)
2462 into the path. In this case, you can also stop the completion after
2463 the file name, to get entries inserted as top level in the file.
2465 When `full-file-path', include the full file path."
2468 (const :tag
"Not" nil
)
2469 (const :tag
"Yes" t
)
2470 (const :tag
"Start with file name" file
)
2471 (const :tag
"Start with full file path" full-file-path
)))
2473 (defcustom org-outline-path-complete-in-steps t
2474 "Non-nil means complete the outline path in hierarchical steps.
2475 When Org-mode uses the refile interface to select an outline path
2476 \(see variable `org-refile-use-outline-path'), the completion of
2477 the path can be done is a single go, or if can be done in steps down
2478 the headline hierarchy. Going in steps is probably the best if you
2479 do not use a special completion package like `ido' or `icicles'.
2480 However, when using these packages, going in one step can be very
2481 fast, while still showing the whole path to the entry."
2485 (defcustom org-refile-allow-creating-parent-nodes nil
2486 "Non-nil means allow to create new nodes as refile targets.
2487 New nodes are then created by adding \"/new node name\" to the completion
2488 of an existing node. When the value of this variable is `confirm',
2489 new node creation must be confirmed by the user (recommended).
2490 When nil, the completion must match an existing entry.
2492 Note that, if the new heading is not seen by the criteria
2493 listed in `org-refile-targets', multiple instances of the same
2494 heading would be created by trying again to file under the new
2498 (const :tag
"Never" nil
)
2499 (const :tag
"Always" t
)
2500 (const :tag
"Prompt for confirmation" confirm
)))
2502 (defcustom org-refile-active-region-within-subtree nil
2503 "Non-nil means also refile active region within a subtree.
2505 By default `org-refile' doesn't allow refiling regions if they
2506 don't contain a set of subtrees, but it might be convenient to
2507 do so sometimes: in that case, the first line of the region is
2508 converted to a headline before refiling."
2513 (defgroup org-todo nil
2514 "Options concerning TODO items in Org-mode."
2518 (defgroup org-progress nil
2519 "Options concerning Progress logging in Org-mode."
2523 (defvar org-todo-interpretation-widgets
2524 '((:tag
"Sequence (cycling hits every state)" sequence
)
2525 (:tag
"Type (cycling directly to DONE)" type
))
2526 "The available interpretation symbols for customizing `org-todo-keywords'.
2527 Interested libraries should add to this list.")
2529 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2530 "List of TODO entry keyword sequences and their interpretation.
2531 \\<org-mode-map>This is a list of sequences.
2533 Each sequence starts with a symbol, either `sequence' or `type',
2534 indicating if the keywords should be interpreted as a sequence of
2535 action steps, or as different types of TODO items. The first
2536 keywords are states requiring action - these states will select a headline
2537 for inclusion into the global TODO list Org-mode produces. If one of
2538 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2539 signify that no further action is necessary. If \"|\" is not found,
2540 the last keyword is treated as the only DONE state of the sequence.
2542 The command \\[org-todo] cycles an entry through these states, and one
2543 additional state where no keyword is present. For details about this
2544 cycling, see the manual.
2546 TODO keywords and interpretation can also be set on a per-file basis with
2547 the special #+SEQ_TODO and #+TYP_TODO lines.
2549 Each keyword can optionally specify a character for fast state selection
2550 \(in combination with the variable `org-use-fast-todo-selection')
2551 and specifiers for state change logging, using the same syntax that
2552 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2553 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2554 indicates to record a time stamp each time this state is selected.
2556 Each keyword may also specify if a timestamp or a note should be
2557 recorded when entering or leaving the state, by adding additional
2558 characters in the parenthesis after the keyword. This looks like this:
2559 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2560 record only the time of the state change. With X and Y being either
2561 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2562 Y when leaving the state if and only if the *target* state does not
2563 define X. You may omit any of the fast-selection key or X or /Y,
2564 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2566 For backward compatibility, this variable may also be just a list
2567 of keywords. In this case the interpretation (sequence or type) will be
2568 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2570 :group
'org-keywords
2572 (repeat :tag
"Old syntax, just keywords"
2573 (string :tag
"Keyword"))
2574 (repeat :tag
"New syntax"
2577 :tag
"Interpretation"
2578 ;;Quick and dirty way to see
2579 ;;`org-todo-interpretations'. This takes the
2580 ;;place of item arguments
2588 org-todo-interpretation-widgets
))
2591 (string :tag
"Keyword"))))))
2593 (defvar org-todo-keywords-1 nil
2594 "All TODO and DONE keywords active in a buffer.")
2595 (make-variable-buffer-local 'org-todo-keywords-1
)
2596 (defvar org-todo-keywords-for-agenda nil
)
2597 (defvar org-done-keywords-for-agenda nil
)
2598 (defvar org-todo-keyword-alist-for-agenda nil
)
2599 (defvar org-tag-alist-for-agenda nil
2600 "Alist of all tags from all agenda files.")
2601 (defvar org-tag-groups-alist-for-agenda nil
2602 "Alist of all groups tags from all current agenda files.")
2603 (defvar org-tag-groups-alist nil
)
2604 (make-variable-buffer-local 'org-tag-groups-alist
)
2605 (defvar org-agenda-contributing-files nil
)
2606 (defvar org-not-done-keywords nil
)
2607 (make-variable-buffer-local 'org-not-done-keywords
)
2608 (defvar org-done-keywords nil
)
2609 (make-variable-buffer-local 'org-done-keywords
)
2610 (defvar org-todo-heads nil
)
2611 (make-variable-buffer-local 'org-todo-heads
)
2612 (defvar org-todo-sets nil
)
2613 (make-variable-buffer-local 'org-todo-sets
)
2614 (defvar org-todo-log-states nil
)
2615 (make-variable-buffer-local 'org-todo-log-states
)
2616 (defvar org-todo-kwd-alist nil
)
2617 (make-variable-buffer-local 'org-todo-kwd-alist
)
2618 (defvar org-todo-key-alist nil
)
2619 (make-variable-buffer-local 'org-todo-key-alist
)
2620 (defvar org-todo-key-trigger nil
)
2621 (make-variable-buffer-local 'org-todo-key-trigger
)
2623 (defcustom org-todo-interpretation
'sequence
2624 "Controls how TODO keywords are interpreted.
2625 This variable is in principle obsolete and is only used for
2626 backward compatibility, if the interpretation of todo keywords is
2627 not given already in `org-todo-keywords'. See that variable for
2630 :group
'org-keywords
2631 :type
'(choice (const sequence
)
2634 (defcustom org-use-fast-todo-selection t
2635 "Non-nil means use the fast todo selection scheme with C-c C-t.
2636 This variable describes if and under what circumstances the cycling
2637 mechanism for TODO keywords will be replaced by a single-key, direct
2640 When nil, fast selection is never used.
2642 When the symbol `prefix', it will be used when `org-todo' is called
2643 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2644 `C-u t' in an agenda buffer.
2646 When t, fast selection is used by default. In this case, the prefix
2647 argument forces cycling instead.
2649 In all cases, the special interface is only used if access keys have
2650 actually been assigned by the user, i.e. if keywords in the configuration
2651 are followed by a letter in parenthesis, like TODO(t)."
2654 (const :tag
"Never" nil
)
2655 (const :tag
"By default" t
)
2656 (const :tag
"Only with C-u C-c C-t" prefix
)))
2658 (defcustom org-provide-todo-statistics t
2659 "Non-nil means update todo statistics after insert and toggle.
2660 ALL-HEADLINES means update todo statistics by including headlines
2661 with no TODO keyword as well, counting them as not done.
2662 A list of TODO keywords means the same, but skip keywords that are
2664 When set to a list of two lists, the first list contains keywords
2665 to consider as TODO keywords, the second list contains keywords
2666 to consider as DONE keywords.
2668 When this is set, todo statistics is updated in the parent of the
2669 current entry each time a todo state is changed."
2672 (const :tag
"Yes, only for TODO entries" t
)
2673 (const :tag
"Yes, including all entries" all-headlines
)
2674 (repeat :tag
"Yes, for TODOs in this list"
2675 (string :tag
"TODO keyword"))
2676 (list :tag
"Yes, for TODOs and DONEs in these lists"
2677 (repeat (string :tag
"TODO keyword"))
2678 (repeat (string :tag
"DONE keyword")))
2679 (other :tag
"No TODO statistics" nil
)))
2681 (defcustom org-hierarchical-todo-statistics t
2682 "Non-nil means TODO statistics covers just direct children.
2683 When nil, all entries in the subtree are considered.
2684 This has only an effect if `org-provide-todo-statistics' is set.
2685 To set this to nil for only a single subtree, use a COOKIE_DATA
2686 property and include the word \"recursive\" into the value."
2690 (defcustom org-after-todo-state-change-hook nil
2691 "Hook which is run after the state of a TODO item was changed.
2692 The new state (a string with a TODO keyword, or nil) is available in the
2693 Lisp variable `org-state'."
2697 (defvar org-blocker-hook nil
2698 "Hook for functions that are allowed to block a state change.
2700 Functions in this hook should not modify the buffer.
2701 Each function gets as its single argument a property list,
2702 see `org-trigger-hook' for more information about this list.
2704 If any of the functions in this hook returns nil, the state change
2707 (defvar org-trigger-hook nil
2708 "Hook for functions that are triggered by a state change.
2710 Each function gets as its single argument a property list with at
2711 least the following elements:
2713 (:type type-of-change :position pos-at-entry-start
2714 :from old-state :to new-state)
2716 Depending on the type, more properties may be present.
2718 This mechanism is currently implemented for:
2722 :type todo-state-change
2723 :from previous state (keyword as a string), or nil, or a symbol
2724 'todo' or 'done', to indicate the general type of state.
2725 :to new state, like in :from")
2727 (defcustom org-enforce-todo-dependencies nil
2728 "Non-nil means undone TODO entries will block switching the parent to DONE.
2729 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2730 be blocked if any prior sibling is not yet done.
2731 Finally, if the parent is blocked because of ordered siblings of its own,
2732 the child will also be blocked."
2733 :set
(lambda (var val
)
2736 (add-hook 'org-blocker-hook
2737 'org-block-todo-from-children-or-siblings-or-parent
)
2738 (remove-hook 'org-blocker-hook
2739 'org-block-todo-from-children-or-siblings-or-parent
)))
2743 (defcustom org-enforce-todo-checkbox-dependencies nil
2744 "Non-nil means unchecked boxes will block switching the parent to DONE.
2745 When this is nil, checkboxes have no influence on switching TODO states.
2746 When non-nil, you first need to check off all check boxes before the TODO
2747 entry can be switched to DONE.
2748 This variable needs to be set before org.el is loaded, and you need to
2749 restart Emacs after a change to make the change effective. The only way
2750 to change is while Emacs is running is through the customize interface."
2751 :set
(lambda (var val
)
2754 (add-hook 'org-blocker-hook
2755 'org-block-todo-from-checkboxes
)
2756 (remove-hook 'org-blocker-hook
2757 'org-block-todo-from-checkboxes
)))
2761 (defcustom org-treat-insert-todo-heading-as-state-change nil
2762 "Non-nil means inserting a TODO heading is treated as state change.
2763 So when the command \\[org-insert-todo-heading] is used, state change
2764 logging will apply if appropriate. When nil, the new TODO item will
2765 be inserted directly, and no logging will take place."
2769 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2770 "Non-nil means switching TODO states with S-cursor counts as state change.
2771 This is the default behavior. However, setting this to nil allows a
2772 convenient way to select a TODO state and bypass any logging associated
2777 (defcustom org-todo-state-tags-triggers nil
2778 "Tag changes that should be triggered by TODO state changes.
2779 This is a list. Each entry is
2781 (state-change (tag . flag) .......)
2783 State-change can be a string with a state, and empty string to indicate the
2784 state that has no TODO keyword, or it can be one of the symbols `todo'
2785 or `done', meaning any not-done or done state, respectively."
2789 (cons (choice :tag
"When changing to"
2790 (const :tag
"Not-done state" todo
)
2791 (const :tag
"Done state" done
)
2792 (string :tag
"State"))
2794 (cons :tag
"Tag action"
2796 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2798 (defcustom org-log-done nil
2799 "Information to record when a task moves to the DONE state.
2801 Possible values are:
2803 nil Don't add anything, just change the keyword
2804 time Add a time stamp to the task
2805 note Prompt for a note and add it with template `org-log-note-headings'
2807 This option can also be set with on a per-file-basis with
2809 #+STARTUP: nologdone
2811 #+STARTUP: lognotedone
2813 You can have local logging settings for a subtree by setting the LOGGING
2814 property to one or more of these keywords."
2816 :group
'org-progress
2818 (const :tag
"No logging" nil
)
2819 (const :tag
"Record CLOSED timestamp" time
)
2820 (const :tag
"Record CLOSED timestamp with note." note
)))
2822 ;; Normalize old uses of org-log-done.
2824 ((eq org-log-done t
) (setq org-log-done
'time
))
2825 ((and (listp org-log-done
) (memq 'done org-log-done
))
2826 (setq org-log-done
'note
)))
2828 (defcustom org-log-reschedule nil
2829 "Information to record when the scheduling date of a tasks is modified.
2831 Possible values are:
2833 nil Don't add anything, just change the date
2834 time Add a time stamp to the task
2835 note Prompt for a note and add it with template `org-log-note-headings'
2837 This option can also be set with on a per-file-basis with
2839 #+STARTUP: nologreschedule
2840 #+STARTUP: logreschedule
2841 #+STARTUP: lognotereschedule"
2843 :group
'org-progress
2845 (const :tag
"No logging" nil
)
2846 (const :tag
"Record timestamp" time
)
2847 (const :tag
"Record timestamp with note." note
)))
2849 (defcustom org-log-redeadline nil
2850 "Information to record when the deadline date of a tasks is modified.
2852 Possible values are:
2854 nil Don't add anything, just change the date
2855 time Add a time stamp to the task
2856 note Prompt for a note and add it with template `org-log-note-headings'
2858 This option can also be set with on a per-file-basis with
2860 #+STARTUP: nologredeadline
2861 #+STARTUP: logredeadline
2862 #+STARTUP: lognoteredeadline
2864 You can have local logging settings for a subtree by setting the LOGGING
2865 property to one or more of these keywords."
2867 :group
'org-progress
2869 (const :tag
"No logging" nil
)
2870 (const :tag
"Record timestamp" time
)
2871 (const :tag
"Record timestamp with note." note
)))
2873 (defcustom org-log-note-clock-out nil
2874 "Non-nil means record a note when clocking out of an item.
2875 This can also be configured on a per-file basis by adding one of
2876 the following lines anywhere in the buffer:
2878 #+STARTUP: lognoteclock-out
2879 #+STARTUP: nolognoteclock-out"
2881 :group
'org-progress
2884 (defcustom org-log-done-with-time t
2885 "Non-nil means the CLOSED time stamp will contain date and time.
2886 When nil, only the date will be recorded."
2887 :group
'org-progress
2890 (defcustom org-log-note-headings
2891 '((done .
"CLOSING NOTE %t")
2892 (state .
"State %-12s from %-12S %t")
2893 (note .
"Note taken on %t")
2894 (reschedule .
"Rescheduled from %S on %t")
2895 (delschedule .
"Not scheduled, was %S on %t")
2896 (redeadline .
"New deadline from %S on %t")
2897 (deldeadline .
"Removed deadline, was %S on %t")
2898 (refile .
"Refiled on %t")
2900 "Headings for notes added to entries.
2901 The value is an alist, with the car being a symbol indicating the note
2902 context, and the cdr is the heading to be used. The heading may also be the
2904 %t in the heading will be replaced by a time stamp.
2905 %T will be an active time stamp instead the default inactive one
2906 %d will be replaced by a short-format time stamp.
2907 %D will be replaced by an active short-format time stamp.
2908 %s will be replaced by the new TODO state, in double quotes.
2909 %S will be replaced by the old TODO state, in double quotes.
2910 %u will be replaced by the user name.
2911 %U will be replaced by the full user name.
2913 In fact, it is not a good idea to change the `state' entry, because
2914 agenda log mode depends on the format of these entries."
2916 :group
'org-progress
2917 :type
'(list :greedy t
2918 (cons (const :tag
"Heading when closing an item" done
) string
)
2920 "Heading when changing todo state (todo sequence only)"
2922 (cons (const :tag
"Heading when just taking a note" note
) string
)
2923 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2924 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2925 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2926 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2927 (cons (const :tag
"Heading when refiling" refile
) string
)
2928 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2930 (unless (assq 'note org-log-note-headings
)
2931 (push '(note .
"%t") org-log-note-headings
))
2933 (defcustom org-log-into-drawer nil
2934 "Non-nil means insert state change notes and time stamps into a drawer.
2935 When nil, state changes notes will be inserted after the headline and
2936 any scheduling and clock lines, but not inside a drawer.
2938 The value of this variable should be the name of the drawer to use.
2939 LOGBOOK is proposed as the default drawer for this purpose, you can
2940 also set this to a string to define the drawer of your choice.
2942 A value of t is also allowed, representing \"LOGBOOK\".
2944 A value of t or nil can also be set with on a per-file-basis with
2946 #+STARTUP: logdrawer
2947 #+STARTUP: nologdrawer
2949 If this variable is set, `org-log-state-notes-insert-after-drawers'
2952 You can set the property LOG_INTO_DRAWER to overrule this setting for
2955 Do not check directly this variable in a Lisp program. Call
2956 function `org-log-into-drawer' instead."
2958 :group
'org-progress
2960 (const :tag
"Not into a drawer" nil
)
2961 (const :tag
"LOGBOOK" t
)
2962 (string :tag
"Other")))
2964 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2966 (defun org-log-into-drawer ()
2967 "Name of the log drawer, as a string, or nil.
2968 This is the value of `org-log-into-drawer'. However, if the
2969 current entry has or inherits a LOG_INTO_DRAWER property, it will
2970 be used instead of the default value."
2971 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2972 (cond ((equal p
"nil") nil
)
2973 ((equal p
"t") "LOGBOOK")
2976 ((stringp org-log-into-drawer
) org-log-into-drawer
)
2977 (org-log-into-drawer "LOGBOOK"))))
2979 (defcustom org-log-state-notes-insert-after-drawers nil
2980 "Non-nil means insert state change notes after any drawers in entry.
2981 Only the drawers that *immediately* follow the headline and the
2982 deadline/scheduled line are skipped.
2983 When nil, insert notes right after the heading and perhaps the line
2984 with deadline/scheduling if present.
2986 This variable will have no effect if `org-log-into-drawer' is
2989 :group
'org-progress
2992 (defcustom org-log-states-order-reversed t
2993 "Non-nil means the latest state note will be directly after heading.
2994 When nil, the state change notes will be ordered according to time.
2996 This option can also be set with on a per-file-basis with
2998 #+STARTUP: logstatesreversed
2999 #+STARTUP: nologstatesreversed"
3001 :group
'org-progress
3004 (defcustom org-todo-repeat-to-state nil
3005 "The TODO state to which a repeater should return the repeating task.
3006 By default this is the first task in a TODO sequence, or the previous state
3007 in a TODO_TYP set. But you can specify another task here.
3008 alternatively, set the :REPEAT_TO_STATE: property of the entry."
3011 :type
'(choice (const :tag
"Head of sequence" nil
)
3012 (string :tag
"Specific state")))
3014 (defcustom org-log-repeat
'time
3015 "Non-nil means record moving through the DONE state when triggering repeat.
3016 An auto-repeating task is immediately switched back to TODO when
3017 marked DONE. If you are not logging state changes (by adding \"@\"
3018 or \"!\" to the TODO keyword definition), or set `org-log-done' to
3019 record a closing note, there will be no record of the task moving
3020 through DONE. This variable forces taking a note anyway.
3022 nil Don't force a record
3023 time Record a time stamp
3024 note Prompt for a note and add it with template `org-log-note-headings'
3026 This option can also be set with on a per-file-basis with
3028 #+STARTUP: nologrepeat
3029 #+STARTUP: logrepeat
3030 #+STARTUP: lognoterepeat
3032 You can have local logging settings for a subtree by setting the LOGGING
3033 property to one or more of these keywords."
3035 :group
'org-progress
3037 (const :tag
"Don't force a record" nil
)
3038 (const :tag
"Force recording the DONE state" time
)
3039 (const :tag
"Force recording a note with the DONE state" note
)))
3042 (defgroup org-priorities nil
3043 "Priorities in Org-mode."
3044 :tag
"Org Priorities"
3047 (defcustom org-enable-priority-commands t
3048 "Non-nil means priority commands are active.
3049 When nil, these commands will be disabled, so that you never accidentally
3051 :group
'org-priorities
3054 (defcustom org-highest-priority ?A
3055 "The highest priority of TODO items. A character like ?A, ?B etc.
3056 Must have a smaller ASCII number than `org-lowest-priority'."
3057 :group
'org-priorities
3060 (defcustom org-lowest-priority ?C
3061 "The lowest priority of TODO items. A character like ?A, ?B etc.
3062 Must have a larger ASCII number than `org-highest-priority'."
3063 :group
'org-priorities
3066 (defcustom org-default-priority ?B
3067 "The default priority of TODO items.
3068 This is the priority an item gets if no explicit priority is given.
3069 When starting to cycle on an empty priority the first step in the cycle
3070 depends on `org-priority-start-cycle-with-default'. The resulting first
3071 step priority must not exceed the range from `org-highest-priority' to
3072 `org-lowest-priority' which means that `org-default-priority' has to be
3073 in this range exclusive or inclusive the range boundaries. Else the
3074 first step refuses to set the default and the second will fall back
3075 to (depending on the command used) the highest or lowest priority."
3076 :group
'org-priorities
3079 (defcustom org-priority-start-cycle-with-default t
3080 "Non-nil means start with default priority when starting to cycle.
3081 When this is nil, the first step in the cycle will be (depending on the
3082 command used) one higher or lower than the default priority.
3083 See also `org-default-priority'."
3084 :group
'org-priorities
3087 (defcustom org-get-priority-function nil
3088 "Function to extract the priority from a string.
3089 The string is normally the headline. If this is nil Org computes the
3090 priority from the priority cookie like [#A] in the headline. It returns
3091 an integer, increasing by 1000 for each priority level.
3092 The user can set a different function here, which should take a string
3093 as an argument and return the numeric priority."
3094 :group
'org-priorities
3100 (defgroup org-time nil
3101 "Options concerning time stamps and deadlines in Org-mode."
3105 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3106 "Number of minutes to round time stamps to.
3107 These are two values, the first applies when first creating a time stamp.
3108 The second applies when changing it with the commands `S-up' and `S-down'.
3109 When changing the time stamp, this means that it will change in steps
3110 of N minutes, as given by the second value.
3112 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3113 numbers should be factors of 60, so for example 5, 10, 15.
3115 When this is larger than 1, you can still force an exact time stamp by using
3116 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3117 and by using a prefix arg to `S-up/down' to specify the exact number
3118 of minutes to shift."
3120 :get
(lambda (var) ; Make sure both elements are there
3121 (if (integerp (default-value var
))
3122 (list (default-value var
) 5)
3123 (default-value var
)))
3125 (integer :tag
"when inserting times")
3126 (integer :tag
"when modifying times")))
3128 ;; Normalize old customizations of this variable.
3129 (when (integerp org-time-stamp-rounding-minutes
)
3130 (setq org-time-stamp-rounding-minutes
3131 (list org-time-stamp-rounding-minutes
3132 org-time-stamp-rounding-minutes
)))
3134 (defcustom org-display-custom-times nil
3135 "Non-nil means overlay custom formats over all time stamps.
3136 The formats are defined through the variable `org-time-stamp-custom-formats'.
3137 To turn this on on a per-file basis, insert anywhere in the file:
3138 #+STARTUP: customtime"
3142 (make-variable-buffer-local 'org-display-custom-times
)
3144 (defcustom org-time-stamp-custom-formats
3145 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3146 "Custom formats for time stamps. See `format-time-string' for the syntax.
3147 These are overlaid over the default ISO format if the variable
3148 `org-display-custom-times' is set. Time like %H:%M should be at the
3149 end of the second format. The custom formats are also honored by export
3150 commands, if custom time display is turned on at the time of export."
3154 (defun org-time-stamp-format (&optional long inactive
)
3155 "Get the right format for a time string."
3156 (let ((f (if long
(cdr org-time-stamp-formats
)
3157 (car org-time-stamp-formats
))))
3159 (concat "[" (substring f
1 -
1) "]")
3162 (defcustom org-time-clocksum-format
3163 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3164 "The format string used when creating CLOCKSUM lines.
3165 This is also used when Org mode generates a time duration.
3167 The value can be a single format string containing two
3168 %-sequences, which will be filled with the number of hours and
3169 minutes in that order.
3171 Alternatively, the value can be a plist associating any of the
3172 keys :years, :months, :weeks, :days, :hours or :minutes with
3173 format strings. The time duration is formatted using only the
3174 time components that are needed and concatenating the results.
3175 If a time unit in absent, it falls back to the next smallest
3178 The keys :require-years, :require-months, :require-days,
3179 :require-weeks, :require-hours, :require-minutes are also
3180 meaningful. A non-nil value for these keys indicates that the
3181 corresponding time component should always be included, even if
3187 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3190 means durations longer than a day will be expressed in days,
3191 hours and minutes, and durations less than a day will always be
3192 expressed in hours and minutes (even for durations less than an
3197 \(:days \"%dd\" :minutes \"%dm\")
3199 means durations longer than a day will be expressed in days and
3200 minutes, and durations less than a day will be expressed entirely
3201 in minutes (even for durations longer than an hour)."
3205 :package-version
'(Org .
"8.0")
3206 :type
'(choice (string :tag
"Format string")
3208 (group :inline t
(const :tag
"Years" :years
)
3209 (string :tag
"Format string"))
3211 (const :tag
"Always show years" :require-years
)
3213 (group :inline t
(const :tag
"Months" :months
)
3214 (string :tag
"Format string"))
3216 (const :tag
"Always show months" :require-months
)
3218 (group :inline t
(const :tag
"Weeks" :weeks
)
3219 (string :tag
"Format string"))
3221 (const :tag
"Always show weeks" :require-weeks
)
3223 (group :inline t
(const :tag
"Days" :days
)
3224 (string :tag
"Format string"))
3226 (const :tag
"Always show days" :require-days
)
3228 (group :inline t
(const :tag
"Hours" :hours
)
3229 (string :tag
"Format string"))
3231 (const :tag
"Always show hours" :require-hours
)
3233 (group :inline t
(const :tag
"Minutes" :minutes
)
3234 (string :tag
"Format string"))
3236 (const :tag
"Always show minutes" :require-minutes
)
3239 (defcustom org-time-clocksum-use-fractional nil
3240 "When non-nil, \\[org-clock-display] uses fractional times.
3241 See `org-time-clocksum-format' for more on time clock formats."
3247 (defcustom org-time-clocksum-use-effort-durations nil
3248 "When non-nil, \\[org-clock-display] uses effort durations.
3249 E.g. by default, one day is considered to be a 8 hours effort,
3250 so a task that has been clocked for 16 hours will be displayed
3251 as during 2 days in the clock display or in the clocktable.
3253 See `org-effort-durations' on how to set effort durations
3254 and `org-time-clocksum-format' for more on time clock formats."
3258 :package-version
'(Org .
"8.0")
3261 (defcustom org-time-clocksum-fractional-format
"%.2f"
3262 "The format string used when creating CLOCKSUM lines,
3263 or when Org mode generates a time duration, if
3264 `org-time-clocksum-use-fractional' is enabled.
3266 The value can be a single format string containing one
3267 %-sequence, which will be filled with the number of hours as
3270 Alternatively, the value can be a plist associating any of the
3271 keys :years, :months, :weeks, :days, :hours or :minutes with
3272 a format string. The time duration is formatted using the
3273 largest time unit which gives a non-zero integer part. If all
3274 specified formats have zero integer part, the smallest time unit
3277 :type
'(choice (string :tag
"Format string")
3278 (set (group :inline t
(const :tag
"Years" :years
)
3279 (string :tag
"Format string"))
3280 (group :inline t
(const :tag
"Months" :months
)
3281 (string :tag
"Format string"))
3282 (group :inline t
(const :tag
"Weeks" :weeks
)
3283 (string :tag
"Format string"))
3284 (group :inline t
(const :tag
"Days" :days
)
3285 (string :tag
"Format string"))
3286 (group :inline t
(const :tag
"Hours" :hours
)
3287 (string :tag
"Format string"))
3288 (group :inline t
(const :tag
"Minutes" :minutes
)
3289 (string :tag
"Format string")))))
3291 (defcustom org-deadline-warning-days
14
3292 "Number of days before expiration during which a deadline becomes active.
3293 This variable governs the display in sparse trees and in the agenda.
3294 When 0 or negative, it means use this number (the absolute value of it)
3295 even if a deadline has a different individual lead time specified.
3297 Custom commands can set this variable in the options section."
3299 :group
'org-agenda-daily
/weekly
3302 (defcustom org-scheduled-delay-days
0
3303 "Number of days before a scheduled item becomes active.
3304 This variable governs the display in sparse trees and in the agenda.
3305 The default value (i.e. 0) means: don't delay scheduled item.
3306 When negative, it means use this number (the absolute value of it)
3307 even if a scheduled item has a different individual delay time
3310 Custom commands can set this variable in the options section."
3312 :group
'org-agenda-daily
/weekly
3314 :package-version
'(Org .
"8.0")
3317 (defcustom org-read-date-prefer-future t
3318 "Non-nil means assume future for incomplete date input from user.
3319 This affects the following situations:
3320 1. The user gives a month but not a year.
3321 For example, if it is April and you enter \"feb 2\", this will be read
3322 as Feb 2, *next* year. \"May 5\", however, will be this year.
3323 2. The user gives a day, but no month.
3324 For example, if today is the 15th, and you enter \"3\", Org-mode will
3325 read this as the third of *next* month. However, if you enter \"17\",
3326 it will be considered as *this* month.
3328 If you set this variable to the symbol `time', then also the following
3331 3. If the user gives a time.
3332 If the time is before now, it will be interpreted as tomorrow.
3334 Currently none of this works for ISO week specifications.
3336 When this option is nil, the current day, month and year will always be
3339 See also `org-agenda-jump-prefer-future'."
3342 (const :tag
"Never" nil
)
3343 (const :tag
"Check month and day" t
)
3344 (const :tag
"Check month, day, and time" time
)))
3346 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3347 "Should the agenda jump command prefer the future for incomplete dates?
3348 The default is to do the same as configured in `org-read-date-prefer-future'.
3349 But you can also set a deviating value here.
3350 This may t or nil, or the symbol `org-read-date-prefer-future'."
3355 (const :tag
"Use org-read-date-prefer-future"
3356 org-read-date-prefer-future
)
3357 (const :tag
"Never" nil
)
3358 (const :tag
"Always" t
)))
3360 (defcustom org-read-date-force-compatible-dates t
3361 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3363 Depending on the system Emacs is running on, certain dates cannot
3364 be represented with the type used internally to represent time.
3365 Dates between 1970-1-1 and 2038-1-1 can always be represented
3366 correctly. Some systems allow for earlier dates, some for later,
3367 some for both. One way to find out it to insert any date into an
3368 Org buffer, putting the cursor on the year and hitting S-up and
3369 S-down to test the range.
3371 When this variable is set to t, the date/time prompt will not let
3372 you specify dates outside the 1970-2037 range, so it is certain that
3373 these dates will work in whatever version of Emacs you are
3374 running, and also that you can move a file from one Emacs implementation
3375 to another. WHenever Org is forcing the year for you, it will display
3378 When this variable is nil, Org will check if the date is
3379 representable in the specific Emacs implementation you are using.
3380 If not, it will force a year, usually the current year, and beep
3381 to remind you. Currently this setting is not recommended because
3382 the likelihood that you will open your Org files in an Emacs that
3383 has limited date range is not negligible.
3385 A workaround for this problem is to use diary sexp dates for time
3386 stamps outside of this range."
3391 (defcustom org-read-date-display-live t
3392 "Non-nil means display current interpretation of date prompt live.
3393 This display will be in an overlay, in the minibuffer."
3397 (defcustom org-read-date-popup-calendar t
3398 "Non-nil means pop up a calendar when prompting for a date.
3399 In the calendar, the date can be selected with mouse-1. However, the
3400 minibuffer will also be active, and you can simply enter the date as well.
3401 When nil, only the minibuffer will be available."
3404 (org-defvaralias 'org-popup-calendar-for-date-prompt
3405 'org-read-date-popup-calendar
)
3407 (make-obsolete-variable
3408 'org-read-date-minibuffer-setup-hook
3409 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3410 (defcustom org-read-date-minibuffer-setup-hook nil
3411 "Hook to be used to set up keys for the date/time interface.
3412 Add key definitions to `minibuffer-local-map', which will be a
3415 WARNING: This option is obsolete, you should use
3416 `org-read-date-minibuffer-local-map' to set up keys."
3420 (defcustom org-extend-today-until
0
3421 "The hour when your day really ends. Must be an integer.
3422 This has influence for the following applications:
3423 - When switching the agenda to \"today\". It it is still earlier than
3424 the time given here, the day recognized as TODAY is actually yesterday.
3425 - When a date is read from the user and it is still before the time given
3426 here, the current date and time will be assumed to be yesterday, 23:59.
3427 Also, timestamps inserted in capture templates follow this rule.
3429 IMPORTANT: This is a feature whose implementation is and likely will
3430 remain incomplete. Really, it is only here because past midnight seems to
3431 be the favorite working time of John Wiegley :-)"
3435 (defcustom org-use-effective-time nil
3436 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3437 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3438 \"effective time\" of any timestamps between midnight and 8am will be
3439 23:59 of the previous day."
3444 (defcustom org-use-last-clock-out-time-as-effective-time nil
3445 "When non-nil, use the last clock out time for `org-todo'.
3446 Note that this option has precedence over the combined use of
3447 `org-use-effective-time' and `org-extend-today-until'."
3450 :package-version
'(Org .
"8.0")
3453 (defcustom org-edit-timestamp-down-means-later nil
3454 "Non-nil means S-down will increase the time in a time stamp.
3455 When nil, S-up will increase."
3459 (defcustom org-calendar-follow-timestamp-change t
3460 "Non-nil means make the calendar window follow timestamp changes.
3461 When a timestamp is modified and the calendar window is visible, it will be
3462 moved to the new date."
3466 (defgroup org-tags nil
3467 "Options concerning tags in Org-mode."
3471 (defcustom org-tag-alist nil
3472 "List of tags allowed in Org-mode files.
3473 When this list is nil, Org-mode will base TAG input on what is already in the
3475 The value of this variable is an alist, the car of each entry must be a
3476 keyword as a string, the cdr may be a character that is used to select
3477 that tag through the fast-tag-selection interface.
3478 See the manual for details."
3482 (cons (string :tag
"Tag name")
3483 (character :tag
"Access char"))
3484 (list :tag
"Start radio group"
3486 (option (string :tag
"Group description")))
3487 (list :tag
"Start tag group, non distinct"
3488 (const :startgrouptag
)
3489 (option (string :tag
"Group description")))
3490 (list :tag
"Group tags delimiter"
3492 (list :tag
"End radio group"
3494 (option (string :tag
"Group description")))
3495 (list :tag
"End tag group, non distinct"
3496 (const :endgrouptag
)
3497 (option (string :tag
"Group description")))
3498 (const :tag
"New line" (:newline
)))))
3500 (defcustom org-tag-persistent-alist nil
3501 "List of tags that will always appear in all Org-mode files.
3502 This is in addition to any in buffer settings or customizations
3504 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3505 The value of this variable is an alist, the car of each entry must be a
3506 keyword as a string, the cdr may be a character that is used to select
3507 that tag through the fast-tag-selection interface.
3508 See the manual for details.
3509 To disable these tags on a per-file basis, insert anywhere in the file:
3514 (cons (string :tag
"Tag name")
3515 (character :tag
"Access char"))
3516 (const :tag
"Start radio group" (:startgroup
))
3517 (const :tag
"Group tags delimiter" (:grouptags
))
3518 (const :tag
"End radio group" (:endgroup
))
3519 (const :tag
"New line" (:newline
)))))
3521 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3522 "If non-nil, always offer completion for all tags of all agenda files.
3523 Instead of customizing this variable directly, you might want to
3524 set it locally for capture buffers, because there no list of
3525 tags in that file can be created dynamically (there are none).
3527 (add-hook 'org-capture-mode-hook
3529 (set (make-local-variable
3530 'org-complete-tags-always-offer-all-agenda-tags)
3536 (defvar org-file-tags nil
3537 "List of tags that can be inherited by all entries in the file.
3538 The tags will be inherited if the variable `org-use-tag-inheritance'
3539 says they should be.
3540 This variable is populated from #+FILETAGS lines.")
3542 (defcustom org-use-fast-tag-selection
'auto
3543 "Non-nil means use fast tag selection scheme.
3544 This is a special interface to select and deselect tags with single keys.
3545 When nil, fast selection is never used.
3546 When the symbol `auto', fast selection is used if and only if selection
3547 characters for tags have been configured, either through the variable
3548 `org-tag-alist' or through a #+TAGS line in the buffer.
3549 When t, fast selection is always used and selection keys are assigned
3550 automatically if necessary."
3553 (const :tag
"Always" t
)
3554 (const :tag
"Never" nil
)
3555 (const :tag
"When selection characters are configured" auto
)))
3557 (defcustom org-fast-tag-selection-single-key nil
3558 "Non-nil means fast tag selection exits after first change.
3559 When nil, you have to press RET to exit it.
3560 During fast tag selection, you can toggle this flag with `C-c'.
3561 This variable can also have the value `expert'. In this case, the window
3562 displaying the tags menu is not even shown, until you press C-c again."
3565 (const :tag
"No" nil
)
3566 (const :tag
"Yes" t
)
3567 (const :tag
"Expert" expert
)))
3569 (defvar org-fast-tag-selection-include-todo nil
3570 "Non-nil means fast tags selection interface will also offer TODO states.
3571 This is an undocumented feature, you should not rely on it.")
3573 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3574 "The column to which tags should be indented in a headline.
3575 If this number is positive, it specifies the column. If it is negative,
3576 it means that the tags should be flushright to that column. For example,
3577 -80 works well for a normal 80 character screen.
3578 When 0, place tags directly after headline text, with only one space in
3583 (defcustom org-auto-align-tags t
3584 "Non-nil keeps tags aligned when modifying headlines.
3585 Some operations (i.e. demoting) change the length of a headline and
3586 therefore shift the tags around. With this option turned on, after
3587 each such operation the tags are again aligned to `org-tags-column'."
3591 (defcustom org-use-tag-inheritance t
3592 "Non-nil means tags in levels apply also for sublevels.
3593 When nil, only the tags directly given in a specific line apply there.
3594 This may also be a list of tags that should be inherited, or a regexp that
3595 matches tags that should be inherited. Additional control is possible
3596 with the variable `org-tags-exclude-from-inheritance' which gives an
3597 explicit list of tags to be excluded from inheritance, even if the value of
3598 `org-use-tag-inheritance' would select it for inheritance.
3600 If this option is t, a match early-on in a tree can lead to a large
3601 number of matches in the subtree when constructing the agenda or creating
3602 a sparse tree. If you only want to see the first match in a tree during
3603 a search, check out the variable `org-tags-match-list-sublevels'."
3606 (const :tag
"Not" nil
)
3607 (const :tag
"Always" t
)
3608 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3609 (regexp :tag
"Tags matched by regexp")))
3611 (defcustom org-tags-exclude-from-inheritance nil
3612 "List of tags that should never be inherited.
3613 This is a way to exclude a few tags from inheritance. For way to do
3614 the opposite, to actively allow inheritance for selected tags,
3615 see the variable `org-use-tag-inheritance'."
3617 :type
'(repeat (string :tag
"Tag")))
3619 (defun org-tag-inherit-p (tag)
3620 "Check if TAG is one that should be inherited."
3622 ((member tag org-tags-exclude-from-inheritance
) nil
)
3623 ((eq org-use-tag-inheritance t
) t
)
3624 ((not org-use-tag-inheritance
) nil
)
3625 ((stringp org-use-tag-inheritance
)
3626 (string-match org-use-tag-inheritance tag
))
3627 ((listp org-use-tag-inheritance
)
3628 (member tag org-use-tag-inheritance
))
3629 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3631 (defcustom org-tags-match-list-sublevels t
3632 "Non-nil means list also sublevels of headlines matching a search.
3633 This variable applies to tags/property searches, and also to stuck
3634 projects because this search is based on a tags match as well.
3636 When set to the symbol `indented', sublevels are indented with
3639 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3640 the sublevels of a headline matching a tag search often also match
3641 the same search. Listing all of them can create very long lists.
3642 Setting this variable to nil causes subtrees of a match to be skipped.
3644 This variable is semi-obsolete and probably should always be true. It
3645 is better to limit inheritance to certain tags using the variables
3646 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3649 (const :tag
"No, don't list them" nil
)
3650 (const :tag
"Yes, do list them" t
)
3651 (const :tag
"List them, indented with leading dots" indented
)))
3653 (defcustom org-tags-sort-function nil
3654 "When set, tags are sorted using this function as a comparator."
3657 (const :tag
"No sorting" nil
)
3658 (const :tag
"Alphabetical" string
<)
3659 (const :tag
"Reverse alphabetical" string
>)
3660 (function :tag
"Custom function" nil
)))
3662 (defvar org-tags-history nil
3663 "History of minibuffer reads for tags.")
3664 (defvar org-last-tags-completion-table nil
3665 "The last used completion table for tags.")
3666 (defvar org-after-tags-change-hook nil
3667 "Hook that is run after the tags in a line have changed.")
3669 (defgroup org-properties nil
3670 "Options concerning properties in Org-mode."
3671 :tag
"Org Properties"
3674 (defcustom org-property-format
"%-10s %s"
3675 "How property key/value pairs should be formatted by `indent-line'.
3676 When `indent-line' hits a property definition, it will format the line
3677 according to this format, mainly to make sure that the values are
3678 lined-up with respect to each other."
3679 :group
'org-properties
3682 (defcustom org-properties-postprocess-alist nil
3683 "Alist of properties and functions to adjust inserted values.
3684 Elements of this alist must be of the form
3686 ([string] [function])
3688 where [string] must be a property name and [function] must be a
3689 lambda expression: this lambda expression must take one argument,
3690 the value to adjust, and return the new value as a string.
3692 For example, this element will allow the property \"Remaining\"
3693 to be updated wrt the relation between the \"Effort\" property
3694 and the clock summary:
3696 ((\"Remaining\" (lambda(value)
3697 (let ((clocksum (org-clock-sum-current-item))
3698 (effort (org-duration-string-to-minutes
3699 (org-entry-get (point) \"Effort\"))))
3700 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3701 :group
'org-properties
3703 :type
'(alist :key-type
(string :tag
"Property")
3704 :value-type
(function :tag
"Function")))
3706 (defcustom org-use-property-inheritance nil
3707 "Non-nil means properties apply also for sublevels.
3709 This setting is chiefly used during property searches. Turning it on can
3710 cause significant overhead when doing a search, which is why it is not
3713 When nil, only the properties directly given in the current entry count.
3714 When t, every property is inherited. The value may also be a list of
3715 properties that should have inheritance, or a regular expression matching
3716 properties that should be inherited.
3718 However, note that some special properties use inheritance under special
3719 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3720 and the properties ending in \"_ALL\" when they are used as descriptor
3721 for valid values of a property.
3723 Note for programmers:
3724 When querying an entry with `org-entry-get', you can control if inheritance
3725 should be used. By default, `org-entry-get' looks only at the local
3726 properties. You can request inheritance by setting the inherit argument
3727 to t (to force inheritance) or to `selective' (to respect the setting
3729 :group
'org-properties
3731 (const :tag
"Not" nil
)
3732 (const :tag
"Always" t
)
3733 (repeat :tag
"Specific properties" (string :tag
"Property"))
3734 (regexp :tag
"Properties matched by regexp")))
3736 (defun org-property-inherit-p (property)
3737 "Check if PROPERTY is one that should be inherited."
3739 ((eq org-use-property-inheritance t
) t
)
3740 ((not org-use-property-inheritance
) nil
)
3741 ((stringp org-use-property-inheritance
)
3742 (string-match org-use-property-inheritance property
))
3743 ((listp org-use-property-inheritance
)
3744 (member property org-use-property-inheritance
))
3745 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3747 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3748 "The default column format, if no other format has been defined.
3749 This variable can be set on the per-file basis by inserting a line
3751 #+COLUMNS: %25ITEM ....."
3752 :group
'org-properties
3755 (defcustom org-columns-ellipses
".."
3756 "The ellipses to be used when a field in column view is truncated.
3757 When this is the empty string, as many characters as possible are shown,
3758 but then there will be no visual indication that the field has been truncated.
3759 When this is a string of length N, the last N characters of a truncated
3760 field are replaced by this string. If the column is narrower than the
3761 ellipses string, only part of the ellipses string will be shown."
3762 :group
'org-properties
3765 (defcustom org-columns-modify-value-for-display-function nil
3766 "Function that modifies values for display in column view.
3767 For example, it can be used to cut out a certain part from a time stamp.
3768 The function must take 2 arguments:
3770 column-title The title of the column (*not* the property name)
3771 value The value that should be modified.
3773 The function should return the value that should be displayed,
3774 or nil if the normal value should be used."
3775 :group
'org-properties
3776 :type
'(choice (const nil
) (function)))
3778 (defconst org-global-properties-fixed
3779 '(("VISIBILITY_ALL" .
"folded children content all")
3780 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3781 "List of property/value pairs that can be inherited by any entry.
3783 These are fixed values, for the preset properties. The user variable
3784 that can be used to add to this list is `org-global-properties'.
3786 The entries in this list are cons cells where the car is a property
3787 name and cdr is a string with the value. If the value represents
3788 multiple items like an \"_ALL\" property, separate the items by
3791 (defcustom org-global-properties nil
3792 "List of property/value pairs that can be inherited by any entry.
3794 This list will be combined with the constant `org-global-properties-fixed'.
3796 The entries in this list are cons cells where the car is a property
3797 name and cdr is a string with the value.
3799 You can set buffer-local values for the same purpose in the variable
3800 `org-file-properties' this by adding lines like
3802 #+PROPERTY: NAME VALUE"
3803 :group
'org-properties
3805 (cons (string :tag
"Property")
3806 (string :tag
"Value"))))
3808 (defvar org-file-properties nil
3809 "List of property/value pairs that can be inherited by any entry.
3810 Valid for the current buffer.
3811 This variable is populated from #+PROPERTY lines.")
3812 (make-variable-buffer-local 'org-file-properties
)
3814 (defgroup org-agenda nil
3815 "Options concerning agenda views in Org-mode."
3819 (defvar org-category nil
3820 "Variable used by org files to set a category for agenda display.
3821 Such files should use a file variable to set it, for example
3823 # -*- mode: org; org-category: \"ELisp\"
3825 or contain a special line
3829 If the file does not specify a category, then file's base name
3831 (make-variable-buffer-local 'org-category
)
3832 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3834 (defcustom org-agenda-files nil
3835 "The files to be used for agenda display.
3836 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3837 \\[org-remove-file]. You can also use customize to edit the list.
3839 If an entry is a directory, all files in that directory that are matched by
3840 `org-agenda-file-regexp' will be part of the file list.
3842 If the value of the variable is not a list but a single file name, then
3843 the list of agenda files is actually stored and maintained in that file, one
3844 agenda file per line. In this file paths can be given relative to
3845 `org-directory'. Tilde expansion and environment variable substitution
3849 (repeat :tag
"List of files and directories" file
)
3850 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3852 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3853 "Regular expression to match files for `org-agenda-files'.
3854 If any element in the list in that variable contains a directory instead
3855 of a normal file, all files in that directory that are matched by this
3856 regular expression will be included."
3860 (defcustom org-agenda-text-search-extra-files nil
3861 "List of extra files to be searched by text search commands.
3862 These files will be searched in addition to the agenda files by the
3863 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3864 Note that these files will only be searched for text search commands,
3865 not for the other agenda views like todo lists, tag searches or the weekly
3866 agenda. This variable is intended to list notes and possibly archive files
3867 that should also be searched by these two commands.
3868 In fact, if the first element in the list is the symbol `agenda-archives',
3869 then all archive files of all agenda files will be added to the search
3872 :type
'(set :greedy t
3873 (const :tag
"Agenda Archives" agenda-archives
)
3874 (repeat :inline t
(file))))
3876 (org-defvaralias 'org-agenda-multi-occur-extra-files
3877 'org-agenda-text-search-extra-files
)
3879 (defcustom org-agenda-skip-unavailable-files nil
3880 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3881 A nil value means to remove them, after a query, from the list."
3885 (defcustom org-calendar-to-agenda-key
[?c
]
3886 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3887 The command `org-calendar-goto-agenda' will be bound to this key. The
3888 default is the character `c' because then `c' can be used to switch back and
3889 forth between agenda and calendar."
3893 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3894 "The key to be installed in `calendar-mode-map' for adding diary entries.
3895 This option is irrelevant until `org-agenda-diary-file' has been configured
3896 to point to an Org-mode file. When that is the case, the command
3897 `org-agenda-diary-entry' will be bound to the key given here, by default
3898 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3899 if you want to continue doing this, you need to change this to a different
3904 (defcustom org-agenda-diary-file
'diary-file
3905 "File to which to add new entries with the `i' key in agenda and calendar.
3906 When this is the symbol `diary-file', the functionality in the Emacs
3907 calendar will be used to add entries to the `diary-file'. But when this
3908 points to a file, `org-agenda-diary-entry' will be used instead."
3911 (const :tag
"The standard Emacs diary file" diary-file
)
3912 (file :tag
"Special Org file diary entries")))
3914 (eval-after-load "calendar"
3916 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3917 'org-calendar-goto-agenda
)
3918 (add-hook 'calendar-mode-hook
3920 (unless (eq org-agenda-diary-file
'diary-file
)
3921 (define-key calendar-mode-map
3922 org-calendar-insert-diary-entry-key
3923 'org-agenda-diary-entry
))))))
3925 (defgroup org-latex nil
3926 "Options for embedding LaTeX code into Org-mode."
3930 (defcustom org-format-latex-options
3931 '(:foreground default
:background default
:scale
1.0
3932 :html-foreground
"Black" :html-background
"Transparent"
3933 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3934 "Options for creating images from LaTeX fragments.
3935 This is a property list with the following properties:
3936 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3937 `default' means use the foreground of the default face.
3938 `auto' means use the foreground from the text face.
3939 :background the background color, or \"Transparent\".
3940 `default' means use the background of the default face.
3941 `auto' means use the background from the text face.
3942 :scale a scaling factor for the size of the images, to get more pixels
3943 :html-foreground, :html-background, :html-scale
3944 the same numbers for HTML export.
3945 :matchers a list indicating which matchers should be used to
3946 find LaTeX fragments. Valid members of this list are:
3947 \"begin\" find environments
3948 \"$1\" find single characters surrounded by $.$
3949 \"$\" find math expressions surrounded by $...$
3950 \"$$\" find math expressions surrounded by $$....$$
3951 \"\\(\" find math expressions surrounded by \\(...\\)
3952 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3956 (defcustom org-format-latex-signal-error t
3957 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3958 When nil, just push out a message."
3963 (defcustom org-latex-to-mathml-jar-file nil
3964 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3965 Use this to specify additional executable file say a jar file.
3967 When using MathToWeb as the converter, specify the full-path to
3968 your mathtoweb.jar file."
3972 (const :tag
"None" nil
)
3973 (file :tag
"JAR file" :must-match t
)))
3975 (defcustom org-latex-to-mathml-convert-command nil
3976 "Command to convert LaTeX fragments to MathML.
3977 Replace format-specifiers in the command as noted below and use
3978 `shell-command' to convert LaTeX to MathML.
3979 %j: Executable file in fully expanded form as specified by
3980 `org-latex-to-mathml-jar-file'.
3981 %I: Input LaTeX file in fully expanded form.
3982 %i: The latex fragment to be converted.
3983 %o: Output MathML file.
3984 This command is used by `org-create-math-formula'.
3986 When using MathToWeb as the converter, set this to
3987 \"java -jar %j -unicode -force -df %o %I\".
3989 When using LaTeXML set this to
3990 \"latexmlmath \"%i\" --presentationmathml=%o\"."
3994 (const :tag
"None" nil
)
3995 (string :tag
"\nShell command")))
3997 (defcustom org-latex-create-formula-image-program
'dvipng
3998 "Program to convert LaTeX fragments with.
4000 dvipng Process the LaTeX fragments to dvi file, then convert
4001 dvi files to png files using dvipng.
4002 This will also include processing of non-math environments.
4003 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
4004 to convert pdf files to png files"
4008 (const :tag
"dvipng" dvipng
)
4009 (const :tag
"imagemagick" imagemagick
)))
4011 (defcustom org-latex-preview-ltxpng-directory
"ltxpng/"
4012 "Path to store latex preview images.
4013 A relative path here creates many directories relative to the
4014 processed org files paths. An absolute path puts all preview
4015 images at the same place."
4020 (defun org-format-latex-mathml-available-p ()
4021 "Return t if `org-latex-to-mathml-convert-command' is usable."
4023 (when (and (boundp 'org-latex-to-mathml-convert-command
)
4024 org-latex-to-mathml-convert-command
)
4025 (let ((executable (car (split-string
4026 org-latex-to-mathml-convert-command
))))
4027 (when (executable-find executable
)
4029 "%j" org-latex-to-mathml-convert-command
)
4030 (file-readable-p org-latex-to-mathml-jar-file
)
4033 (defcustom org-format-latex-header
"\\documentclass{article}
4034 \\usepackage[usenames]{color}
4037 \\pagestyle{empty} % do not remove
4038 % The settings below are copied from fullpage.sty
4039 \\setlength{\\textwidth}{\\paperwidth}
4040 \\addtolength{\\textwidth}{-3cm}
4041 \\setlength{\\oddsidemargin}{1.5cm}
4042 \\addtolength{\\oddsidemargin}{-2.54cm}
4043 \\setlength{\\evensidemargin}{\\oddsidemargin}
4044 \\setlength{\\textheight}{\\paperheight}
4045 \\addtolength{\\textheight}{-\\headheight}
4046 \\addtolength{\\textheight}{-\\headsep}
4047 \\addtolength{\\textheight}{-\\footskip}
4048 \\addtolength{\\textheight}{-3cm}
4049 \\setlength{\\topmargin}{1.5cm}
4050 \\addtolength{\\topmargin}{-2.54cm}"
4051 "The document header used for processing LaTeX fragments.
4052 It is imperative that this header make sure that no page number
4053 appears on the page. The package defined in the variables
4054 `org-latex-default-packages-alist' and `org-latex-packages-alist'
4055 will either replace the placeholder \"[PACKAGES]\" in this
4056 header, or they will be appended."
4060 (defun org-set-packages-alist (var val
)
4061 "Set the packages alist and make sure it has 3 elements per entry."
4062 (set var
(mapcar (lambda (x)
4063 (if (and (consp x
) (= (length x
) 2))
4064 (list (car x
) (nth 1 x
) t
)
4068 (defun org-get-packages-alist (var)
4069 "Get the packages alist and make sure it has 3 elements per entry."
4071 (if (and (consp x
) (= (length x
) 2))
4072 (list (car x
) (nth 1 x
) t
)
4074 (default-value var
)))
4076 (defcustom org-latex-default-packages-alist
4077 '(("AUTO" "inputenc" t
)
4081 ("" "longtable" nil
)
4085 ("normalem" "ulem" t
)
4094 "Alist of default packages to be inserted in the header.
4096 Change this only if one of the packages here causes an
4097 incompatibility with another package you are using.
4099 The packages in this list are needed by one part or another of
4100 Org mode to function properly:
4102 - inputenc, fontenc: for basic font and character selection
4103 - fixltx2e: Important patches of LaTeX itself
4104 - graphicx: for including images
4105 - longtable: For multipage tables
4106 - float, wrapfig: for figure placement
4107 - rotating: for sideways figures and tables
4108 - ulem: for underline and strike-through
4109 - amsmath: for subscript and superscript and math environments
4110 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4111 for interpreting the entities in `org-entities'. You can skip
4112 some of these packages if you don't use any of their symbols.
4113 - capt-of: for captions outside of floats
4114 - hyperref: for cross references
4116 Therefore you should not modify this variable unless you know
4117 what you are doing. The one reason to change it anyway is that
4118 you might be loading some other package that conflicts with one
4119 of the default packages. Each element is either a cell or
4122 A cell is of the format:
4124 \( \"options\" \"package\" SNIPPET-FLAG).
4126 If SNIPPET-FLAG is non-nil, the package also needs to be included
4127 when compiling LaTeX snippets into images for inclusion into
4130 A string will be inserted as-is in the header of the document."
4132 :group
'org-export-latex
4133 :set
'org-set-packages-alist
4134 :get
'org-get-packages-alist
4138 (list :tag
"options/package pair"
4139 (string :tag
"options")
4140 (string :tag
"package")
4141 (boolean :tag
"Snippet"))
4142 (string :tag
"A line of LaTeX"))))
4144 (defcustom org-latex-packages-alist nil
4145 "Alist of packages to be inserted in every LaTeX header.
4147 These will be inserted after `org-latex-default-packages-alist'.
4148 Each element is either a cell or a string.
4150 A cell is of the format:
4152 \(\"options\" \"package\" SNIPPET-FLAG)
4154 SNIPPET-FLAG, when non-nil, indicates that this package is also
4155 needed when turning LaTeX snippets into images for inclusion into
4158 A string will be inserted as-is in the header of the document.
4160 Make sure that you only list packages here which:
4162 - you want in every file;
4163 - do not conflict with the setup in `org-format-latex-header';
4164 - do not conflict with the default packages in
4165 `org-latex-default-packages-alist'."
4167 :group
'org-export-latex
4168 :set
'org-set-packages-alist
4169 :get
'org-get-packages-alist
4172 (list :tag
"options/package pair"
4173 (string :tag
"options")
4174 (string :tag
"package")
4175 (boolean :tag
"Snippet"))
4176 (string :tag
"A line of LaTeX"))))
4178 (defgroup org-appearance nil
4179 "Settings for Org-mode appearance."
4180 :tag
"Org Appearance"
4183 (defcustom org-level-color-stars-only nil
4184 "Non-nil means fontify only the stars in each headline.
4185 When nil, the entire headline is fontified.
4186 Changing it requires restart of `font-lock-mode' to become effective
4187 also in regions already fontified."
4188 :group
'org-appearance
4191 (defcustom org-hide-leading-stars nil
4192 "Non-nil means hide the first N-1 stars in a headline.
4193 This works by using the face `org-hide' for these stars. This
4194 face is white for a light background, and black for a dark
4195 background. You may have to customize the face `org-hide' to
4197 Changing it requires restart of `font-lock-mode' to become effective
4198 also in regions already fontified.
4199 You may also set this on a per-file basis by adding one of the following
4200 lines to the buffer:
4202 #+STARTUP: hidestars
4203 #+STARTUP: showstars"
4204 :group
'org-appearance
4207 (defcustom org-hidden-keywords nil
4208 "List of symbols corresponding to keywords to be hidden the org buffer.
4209 For example, a value '(title) for this list will make the document's title
4210 appear in the buffer without the initial #+TITLE: keyword."
4211 :group
'org-appearance
4213 :type
'(set (const :tag
"#+AUTHOR" author
)
4214 (const :tag
"#+DATE" date
)
4215 (const :tag
"#+EMAIL" email
)
4216 (const :tag
"#+TITLE" title
)))
4218 (defcustom org-custom-properties nil
4219 "List of properties (as strings) with a special meaning.
4220 The default use of these custom properties is to let the user
4221 hide them with `org-toggle-custom-properties-visibility'."
4222 :group
'org-properties
4223 :group
'org-appearance
4225 :type
'(repeat (string :tag
"Property Name")))
4227 (defcustom org-fontify-done-headline nil
4228 "Non-nil means change the face of a headline if it is marked DONE.
4229 Normally, only the TODO/DONE keyword indicates the state of a headline.
4230 When this is non-nil, the headline after the keyword is set to the
4231 `org-headline-done' as an additional indication."
4232 :group
'org-appearance
4235 (defcustom org-fontify-emphasized-text t
4236 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4237 Changing this variable requires a restart of Emacs to take effect."
4238 :group
'org-appearance
4241 (defcustom org-fontify-whole-heading-line nil
4242 "Non-nil means fontify the whole line for headings.
4243 This is useful when setting a background color for the
4245 :group
'org-appearance
4248 (defcustom org-highlight-latex-and-related nil
4249 "Non-nil means highlight LaTeX related syntax in the buffer.
4250 When non nil, the value should be a list containing any of the
4252 `latex' Highlight LaTeX snippets and environments.
4253 `script' Highlight subscript and superscript.
4254 `entities' Highlight entities."
4255 :group
'org-appearance
4257 :package-version
'(Org .
"8.0")
4259 (const :tag
"No highlighting" nil
)
4260 (set :greedy t
:tag
"Highlight"
4261 (const :tag
"LaTeX snippets and environments" latex
)
4262 (const :tag
"Subscript and superscript" script
)
4263 (const :tag
"Entities" entities
))))
4265 (defcustom org-hide-emphasis-markers nil
4266 "Non-nil mean font-lock should hide the emphasis marker characters."
4267 :group
'org-appearance
4270 (defcustom org-hide-macro-markers nil
4271 "Non-nil mean font-lock should hide the brackets marking macro calls."
4272 :group
'org-appearance
4275 (defcustom org-pretty-entities nil
4276 "Non-nil means show entities as UTF8 characters.
4277 When nil, the \\name form remains in the buffer."
4278 :group
'org-appearance
4282 (defcustom org-pretty-entities-include-sub-superscripts t
4283 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4284 :group
'org-appearance
4288 (defvar org-emph-re nil
4289 "Regular expression for matching emphasis.
4290 After a match, the match groups contain these elements:
4291 0 The match of the full regular expression, including the characters
4292 before and after the proper match
4293 1 The character before the proper match, or empty at beginning of line
4294 2 The proper match, including the leading and trailing markers
4295 3 The leading marker like * or /, indicating the type of highlighting
4296 4 The text between the emphasis markers, not including the markers
4297 5 The character after the match, empty at the end of a line")
4298 (defvar org-verbatim-re nil
4299 "Regular expression for matching verbatim text.")
4300 (defvar org-emphasis-regexp-components
) ; defined just below
4301 (defvar org-emphasis-alist
) ; defined just below
4302 (defun org-set-emph-re (var val
)
4303 "Set variable and compute the emphasis regular expression."
4305 (when (and (boundp 'org-emphasis-alist
)
4306 (boundp 'org-emphasis-regexp-components
)
4307 org-emphasis-alist org-emphasis-regexp-components
)
4308 (let* ((e org-emphasis-regexp-components
)
4314 (body1 (concat body
"*?"))
4315 (markers (mapconcat 'car org-emphasis-alist
""))
4316 (vmarkers (mapconcat
4317 (lambda (x) (if (eq (nth 2 x
) 'verbatim
) (car x
) ""))
4318 org-emphasis-alist
"")))
4319 ;; make sure special characters appear at the right position in the class
4320 (if (string-match "\\^" markers
)
4321 (setq markers
(concat (replace-match "" t t markers
) "^")))
4322 (if (string-match "-" markers
)
4323 (setq markers
(concat (replace-match "" t t markers
) "-")))
4324 (if (string-match "\\^" vmarkers
)
4325 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
4326 (if (string-match "-" vmarkers
)
4327 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
4329 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
4330 (int-to-string nl
) "\\}")))
4333 (concat "\\([" pre
"]\\|^\\)"
4335 "\\([" markers
"]\\)"
4343 "\\([" post
"]\\|$\\)"))
4344 (setq org-verbatim-re
4345 (concat "\\([" pre
"]\\|^\\)"
4347 "\\([" vmarkers
"]\\)"
4355 "\\([" post
"]\\|$\\)")))))
4357 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4358 ;; set this option proved cumbersome. See this message/thread:
4359 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4360 (defvar org-emphasis-regexp-components
4361 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4362 "Components used to build the regular expression for emphasis.
4363 This is a list with five entries. Terminology: In an emphasis string
4364 like \" *strong word* \", we call the initial space PREMATCH, the final
4365 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4366 and \"trong wor\" is the body. The different components in this variable
4367 specify what is allowed/forbidden in each part:
4369 pre Chars allowed as prematch. Beginning of line will be allowed too.
4370 post Chars allowed as postmatch. End of line will be allowed too.
4371 border The chars *forbidden* as border characters.
4372 body-regexp A regexp like \".\" to match a body character. Don't use
4373 non-shy groups here, and don't allow newline here.
4374 newline The maximum number of newlines allowed in an emphasis exp.
4376 You need to reload Org or to restart Emacs after customizing this.")
4378 (defcustom org-emphasis-alist
4382 ("=" org-verbatim verbatim
)
4383 ("~" org-code verbatim
)
4384 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))))
4385 "Alist of characters and faces to emphasize text.
4386 Text starting and ending with a special character will be emphasized,
4387 for example *bold*, _underlined_ and /italic/. This variable sets the
4388 marker characters and the face to be used by font-lock for highlighting
4389 in Org-mode Emacs buffers.
4391 You need to reload Org or to restart Emacs after customizing this."
4392 :group
'org-appearance
4393 :set
'org-set-emph-re
4395 :package-version
'(Org .
"8.0")
4398 (string :tag
"Marker character")
4400 (face :tag
"Font-lock-face")
4401 (plist :tag
"Face property list"))
4402 (option (const verbatim
)))))
4404 (defvar org-protecting-blocks
4405 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4406 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4407 This is needed for font-lock setup.")
4409 ;;; Miscellaneous options
4411 (defgroup org-completion nil
4412 "Completion in Org-mode."
4413 :tag
"Org Completion"
4416 (defcustom org-completion-use-ido nil
4417 "Non-nil means use ido completion wherever possible.
4418 Note that `ido-mode' must be active for this variable to be relevant.
4419 If you decide to turn this variable on, you might well want to turn off
4420 `org-outline-path-complete-in-steps'.
4421 See also `org-completion-use-iswitchb'."
4422 :group
'org-completion
4425 (defcustom org-completion-use-iswitchb nil
4426 "Non-nil means use iswitchb completion wherever possible.
4427 Note that `iswitchb-mode' must be active for this variable to be relevant.
4428 If you decide to turn this variable on, you might well want to turn off
4429 `org-outline-path-complete-in-steps'.
4430 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4431 :group
'org-completion
4434 (defcustom org-completion-fallback-command
'hippie-expand
4435 "The expansion command called by \\[pcomplete] in normal context.
4436 Normal means, no org-mode-specific context."
4437 :group
'org-completion
4440 ;;; Functions and variables from their packages
4441 ;; Declared here to avoid compiler warnings
4444 (defvar outline-mode-menu-heading
)
4445 (defvar outline-mode-menu-show
)
4446 (defvar outline-mode-menu-hide
)
4447 (defvar zmacs-regions
) ; XEmacs regions
4450 (defvar mark-active
)
4453 (declare-function calendar-iso-to-absolute
"cal-iso" (date))
4454 (declare-function calendar-forward-day
"cal-move" (arg))
4455 (declare-function calendar-goto-date
"cal-move" (date))
4456 (declare-function calendar-goto-today
"cal-move" ())
4457 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
4458 (defvar calc-embedded-close-formula
)
4459 (defvar calc-embedded-open-formula
)
4460 (declare-function cdlatex-tab
"ext:cdlatex" ())
4461 (declare-function cdlatex-compute-tables
"ext:cdlatex" ())
4462 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
4463 (defvar font-lock-unfontify-region-function
)
4464 (declare-function iswitchb-read-buffer
"iswitchb"
4465 (prompt &optional default require-match start matches-set
))
4466 (defvar iswitchb-temp-buflist
)
4467 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
4468 (defvar org-agenda-tags-todo-honor-ignore-options
)
4469 (declare-function org-agenda-skip
"org-agenda" ())
4471 org-agenda-format-item
"org-agenda"
4472 (extra txt
&optional level category tags dotime noprefix remove-re habitp
))
4473 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
4474 (declare-function org-agenda-change-all-lines
"org-agenda"
4475 (newhead hdmarker
&optional fixface just-this
))
4476 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
4477 (declare-function org-agenda-maybe-redo
"org-agenda" ())
4478 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
4480 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
4481 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4482 "org-agenda" (&optional end
))
4483 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
4484 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
4485 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
4486 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
4487 (declare-function org-indent-mode
"org-indent" (&optional arg
))
4488 (declare-function parse-time-string
"parse-time" (string))
4489 (declare-function org-attach-reveal
"org-attach" (&optional if-exists
))
4490 (declare-function orgtbl-send-table
"org-table" (&optional maybe
))
4491 (defvar remember-data-file
)
4492 (defvar texmathp-why
)
4493 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
4494 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
4495 (declare-function calc-eval
"calc" (str &optional separator
&rest args
))
4498 (defun turn-on-orgtbl ()
4499 "Unconditionally turn on `orgtbl-mode'."
4500 (require 'org-table
)
4503 (defun org-at-table-p (&optional table-type
)
4504 "Return t if the cursor is inside an org-type table.
4505 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4506 (if org-enable-table-editor
4508 (beginning-of-line 1)
4509 (looking-at (if table-type org-table-any-line-regexp
4510 org-table-line-regexp
)))
4512 (defsubst org-table-p
() (org-at-table-p))
4514 (defun org-at-table.el-p
()
4515 "Return t if and only if we are at a table.el table."
4516 (and (org-at-table-p 'any
)
4518 (goto-char (org-table-begin 'any
))
4519 (looking-at org-table1-hline-regexp
))))
4521 (defun org-table-recognize-table.el
()
4522 "If there is a table.el table nearby, recognize it and move into it."
4523 (if org-table-tab-recognizes-table.el
4524 (if (org-at-table.el-p
)
4526 (beginning-of-line 1)
4527 (if (looking-at org-table-dataline-regexp
)
4529 (if (looking-at org-table1-hline-regexp
)
4531 (beginning-of-line 2)
4532 (if (looking-at org-table-any-border-regexp
)
4533 (beginning-of-line -
1)))))
4534 (if (re-search-forward "|" (org-table-end t
) t
)
4537 (if (table--at-cell-p (point))
4539 (message "recognizing table.el table...")
4540 (table-recognize-table)
4541 (message "recognizing table.el table...done")))
4542 (error "This should not happen"))
4547 (defun org-at-table-hline-p ()
4548 "Return t if the cursor is inside a hline in a table."
4549 (if org-enable-table-editor
4551 (beginning-of-line 1)
4552 (looking-at org-table-hline-regexp
))
4555 (defun org-table-map-tables (function &optional quietly
)
4556 "Apply FUNCTION to the start of all tables in the buffer."
4560 (goto-char (point-min))
4561 (while (re-search-forward org-table-any-line-regexp nil t
)
4563 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4564 (beginning-of-line 1)
4565 (when (and (looking-at org-table-line-regexp
)
4566 ;; Exclude tables in src/example/verbatim/clocktable blocks
4567 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4568 (save-excursion (funcall function
))
4569 (or (looking-at org-table-line-regexp
)
4571 (re-search-forward org-table-any-border-regexp nil
1))))
4572 (unless quietly
(message "Mapping tables: done")))
4574 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock" (beg end
))
4575 (declare-function org-clock-update-mode-line
"org-clock" ())
4576 (declare-function org-resolve-clocks
"org-clock"
4577 (&optional also-non-dangling-p prompt last-valid
))
4579 (defun org-at-TBLFM-p (&optional pos
)
4580 "Return t when point (or POS) is in #+TBLFM line."
4583 (goto-char (or pos
(point)))
4584 (beginning-of-line 1)
4585 (looking-at org-TBLFM-regexp
)))
4587 (defvar org-clock-start-time
)
4588 (defvar org-clock-marker
(make-marker)
4589 "Marker recording the last clock-in.")
4590 (defvar org-clock-hd-marker
(make-marker)
4591 "Marker recording the last clock-in, but the headline position.")
4592 (defvar org-clock-heading
""
4593 "The heading of the current clock entry.")
4594 (defun org-clock-is-active ()
4595 "Return the buffer where the clock is currently running.
4596 Return nil if no clock is running."
4597 (marker-buffer org-clock-marker
))
4599 (defun org-check-running-clock ()
4600 "Check if the current buffer contains the running clock.
4601 If yes, offer to stop it and to save the buffer with the changes."
4602 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
4603 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4606 (when (y-or-n-p "Save changed buffer?")
4609 (defun org-clocktable-try-shift (dir n
)
4610 "Check if this line starts a clock table, if yes, shift the time block."
4611 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4612 (org-clocktable-shift dir n
)))
4615 (defun org-clock-persistence-insinuate ()
4616 "Set up hooks for clock persistence."
4617 (require 'org-clock
)
4618 (add-hook 'org-mode-hook
'org-clock-load
)
4619 (add-hook 'kill-emacs-hook
'org-clock-save
))
4621 (defgroup org-archive nil
4622 "Options concerning archiving in Org-mode."
4624 :group
'org-structure
)
4626 (defcustom org-archive-location
"%s_archive::"
4627 "The location where subtrees should be archived.
4629 The value of this variable is a string, consisting of two parts,
4630 separated by a double-colon. The first part is a filename and
4631 the second part is a headline.
4633 When the filename is omitted, archiving happens in the same file.
4634 %s in the filename will be replaced by the current file
4635 name (without the directory part). Archiving to a different file
4636 is useful to keep archived entries from contributing to the
4639 The archived entries will be filed as subtrees of the specified
4640 headline. When the headline is omitted, the subtrees are simply
4641 filed away at the end of the file, as top-level entries. Also in
4642 the heading you can use %s to represent the file name, this can be
4643 useful when using the same archive for a number of different files.
4645 Here are a few examples:
4647 If the current file is Projects.org, archive in file
4648 Projects.org_archive, as top-level trees. This is the default.
4650 \"::* Archived Tasks\"
4651 Archive in the current file, under the top-level headline
4652 \"* Archived Tasks\".
4654 \"~/org/archive.org::\"
4655 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4657 \"~/org/archive.org::* From %s\"
4658 Archive in file ~/org/archive.org (absolute path), under headlines
4659 \"From FILENAME\" where file name is the current file name.
4661 \"~/org/datetree.org::datetree/* Finished Tasks\"
4662 The \"datetree/\" string is special, signifying to archive
4663 items to the datetree. Items are placed in either the CLOSED
4664 date of the item, or the current date if there is no CLOSED date.
4665 The heading will be a subentry to the current date. There doesn't
4666 need to be a heading, but there always needs to be a slash after
4667 datetree. For example, to store archived items directly in the
4668 datetree, use \"~/org/datetree.org::datetree/\".
4670 \"basement::** Finished Tasks\"
4671 Archive in file ./basement (relative path), as level 3 trees
4672 below the level 2 heading \"** Finished Tasks\".
4674 You may set this option on a per-file basis by adding to the buffer a
4677 #+ARCHIVE: basement::** Finished Tasks
4679 You may also define it locally for a subtree by setting an ARCHIVE property
4680 in the entry. If such a property is found in an entry, or anywhere up
4681 the hierarchy, it will be used."
4685 (defcustom org-agenda-skip-archived-trees t
4686 "Non-nil means the agenda will skip any items located in archived trees.
4687 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4688 variable is no longer recommended, you should leave it at the value t.
4689 Instead, use the key `v' to cycle the archives-mode in the agenda."
4691 :group
'org-agenda-skip
4694 (defcustom org-columns-skip-archived-trees t
4695 "Non-nil means ignore archived trees when creating column view."
4697 :group
'org-properties
4700 (defcustom org-cycle-open-archived-trees nil
4701 "Non-nil means `org-cycle' will open archived trees.
4702 An archived tree is a tree marked with the tag ARCHIVE.
4703 When nil, archived trees will stay folded. You can still open them with
4704 normal outline commands like `show-all', but not with the cycling commands."
4709 (defcustom org-sparse-tree-open-archived-trees nil
4710 "Non-nil means sparse tree construction shows matches in archived trees.
4711 When nil, matches in these trees are highlighted, but the trees are kept in
4714 :group
'org-sparse-trees
4717 (defcustom org-sparse-tree-default-date-type nil
4718 "The default date type when building a sparse tree.
4719 When this is nil, a date is a scheduled or a deadline timestamp.
4720 Otherwise, these types are allowed:
4723 active: only active timestamps (<...>)
4724 inactive: only inactive timestamps ([...])
4725 scheduled: only scheduled timestamps
4726 deadline: only deadline timestamps"
4727 :type
'(choice (const :tag
"Scheduled or deadline" nil
)
4728 (const :tag
"All timestamps" all
)
4729 (const :tag
"Only active timestamps" active
)
4730 (const :tag
"Only inactive timestamps" inactive
)
4731 (const :tag
"Only scheduled timestamps" scheduled
)
4732 (const :tag
"Only deadline timestamps" deadline
)
4733 (const :tag
"Only closed timestamps" closed
))
4735 :package-version
'(Org .
"8.3")
4736 :group
'org-sparse-trees
)
4738 (defun org-cycle-hide-archived-subtrees (state)
4739 "Re-hide all archived subtrees after a visibility state change."
4740 (when (and (not org-cycle-open-archived-trees
)
4741 (not (memq state
'(overview folded
))))
4743 (let* ((globalp (memq state
'(contents all
)))
4744 (beg (if globalp
(point-min) (point)))
4745 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4746 (org-hide-archived-subtrees beg end
)
4748 (if (looking-at (concat ".*:" org-archive-tag
":"))
4749 (message "%s" (substitute-command-keys
4750 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4752 (defun org-force-cycle-archived ()
4753 "Cycle subtree even if it is archived."
4755 (setq this-command
'org-cycle
)
4756 (let ((org-cycle-open-archived-trees t
))
4757 (call-interactively 'org-cycle
)))
4759 (defun org-hide-archived-subtrees (beg end
)
4760 "Re-hide all archived subtrees after a visibility state change."
4761 (org-with-wide-buffer
4762 (let ((case-fold-search nil
)
4763 (re (concat org-outline-regexp-bol
".*:" org-archive-tag
":")))
4765 (while (and (< (point) end
) (re-search-forward re end t
))
4766 (when (member org-archive-tag
(org-get-tags))
4767 (org-flag-subtree t
)
4768 (org-end-of-subtree t
))))))
4770 (declare-function outline-end-of-heading
"outline" ())
4771 (declare-function outline-flag-region
"outline" (from to flag
))
4772 (defun org-flag-subtree (flag)
4774 (org-back-to-heading t
)
4775 (outline-end-of-heading)
4776 (outline-flag-region (point)
4777 (progn (org-end-of-subtree t
) (point))
4780 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4782 ;; Declare Column View Code
4784 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4785 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4786 (declare-function org-columns-compute
"org-colview" (property))
4790 (declare-function org-id-store-link
"org-id")
4791 (declare-function org-id-locations-load
"org-id")
4792 (declare-function org-id-locations-save
"org-id")
4793 (defvar org-id-track-globally
)
4795 ;;; Variables for pre-computed regular expressions, all buffer local
4797 (defvar org-todo-regexp nil
4798 "Matches any of the TODO state keywords.")
4799 (make-variable-buffer-local 'org-todo-regexp
)
4800 (defvar org-not-done-regexp nil
4801 "Matches any of the TODO state keywords except the last one.")
4802 (make-variable-buffer-local 'org-not-done-regexp
)
4803 (defvar org-not-done-heading-regexp nil
4804 "Matches a TODO headline that is not done.")
4805 (make-variable-buffer-local 'org-not-done-regexp
)
4806 (defvar org-todo-line-regexp nil
4807 "Matches a headline and puts TODO state into group 2 if present.")
4808 (make-variable-buffer-local 'org-todo-line-regexp
)
4809 (defvar org-complex-heading-regexp nil
4810 "Matches a headline and puts everything into groups:
4812 group 2: The todo keyword, maybe
4813 group 3: Priority cookie
4814 group 4: True headline
4816 (make-variable-buffer-local 'org-complex-heading-regexp
)
4817 (defvar org-complex-heading-regexp-format nil
4818 "Printf format to make regexp to match an exact headline.
4819 This regexp will match the headline of any node which has the
4820 exact headline text that is put into the format, but may have any
4821 TODO state, priority and tags.")
4822 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4823 (defvar org-todo-line-tags-regexp nil
4824 "Matches a headline and puts TODO state into group 2 if present.
4825 Also put tags into group 4 if tags are present.")
4826 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4828 (defconst org-plain-time-of-day-regexp
4831 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4834 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4836 "Regular expression to match a plain time or time range.
4837 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4838 groups carry important information:
4840 1 the first time, range or not
4841 8 the second time, if it is a range.")
4843 (defconst org-plain-time-extension-regexp
4846 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4847 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4848 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4849 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4850 groups carry important information:
4853 9 minutes of duration")
4855 (defconst org-stamp-time-of-day-regexp
4857 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4858 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4860 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4861 "Regular expression to match a timestamp time or time range.
4862 After a match, the following groups carry important information:
4864 1 date plus weekday, for back referencing to make sure both times are on the same day
4865 2 the first time, range or not
4866 4 the second time, if it is a range.")
4868 (defconst org-startup-options
4869 '(("fold" org-startup-folded t
)
4870 ("overview" org-startup-folded t
)
4871 ("nofold" org-startup-folded nil
)
4872 ("showall" org-startup-folded nil
)
4873 ("showeverything" org-startup-folded showeverything
)
4874 ("content" org-startup-folded content
)
4875 ("indent" org-startup-indented t
)
4876 ("noindent" org-startup-indented nil
)
4877 ("hidestars" org-hide-leading-stars t
)
4878 ("showstars" org-hide-leading-stars nil
)
4879 ("odd" org-odd-levels-only t
)
4880 ("oddeven" org-odd-levels-only nil
)
4881 ("align" org-startup-align-all-tables t
)
4882 ("noalign" org-startup-align-all-tables nil
)
4883 ("inlineimages" org-startup-with-inline-images t
)
4884 ("noinlineimages" org-startup-with-inline-images nil
)
4885 ("latexpreview" org-startup-with-latex-preview t
)
4886 ("nolatexpreview" org-startup-with-latex-preview nil
)
4887 ("customtime" org-display-custom-times t
)
4888 ("logdone" org-log-done time
)
4889 ("lognotedone" org-log-done note
)
4890 ("nologdone" org-log-done nil
)
4891 ("lognoteclock-out" org-log-note-clock-out t
)
4892 ("nolognoteclock-out" org-log-note-clock-out nil
)
4893 ("logrepeat" org-log-repeat state
)
4894 ("lognoterepeat" org-log-repeat note
)
4895 ("logdrawer" org-log-into-drawer t
)
4896 ("nologdrawer" org-log-into-drawer nil
)
4897 ("logstatesreversed" org-log-states-order-reversed t
)
4898 ("nologstatesreversed" org-log-states-order-reversed nil
)
4899 ("nologrepeat" org-log-repeat nil
)
4900 ("logreschedule" org-log-reschedule time
)
4901 ("lognotereschedule" org-log-reschedule note
)
4902 ("nologreschedule" org-log-reschedule nil
)
4903 ("logredeadline" org-log-redeadline time
)
4904 ("lognoteredeadline" org-log-redeadline note
)
4905 ("nologredeadline" org-log-redeadline nil
)
4906 ("logrefile" org-log-refile time
)
4907 ("lognoterefile" org-log-refile note
)
4908 ("nologrefile" org-log-refile nil
)
4909 ("fninline" org-footnote-define-inline t
)
4910 ("nofninline" org-footnote-define-inline nil
)
4911 ("fnlocal" org-footnote-section nil
)
4912 ("fnauto" org-footnote-auto-label t
)
4913 ("fnprompt" org-footnote-auto-label nil
)
4914 ("fnconfirm" org-footnote-auto-label confirm
)
4915 ("fnplain" org-footnote-auto-label plain
)
4916 ("fnadjust" org-footnote-auto-adjust t
)
4917 ("nofnadjust" org-footnote-auto-adjust nil
)
4918 ("constcgs" constants-unit-system cgs
)
4919 ("constSI" constants-unit-system SI
)
4920 ("noptag" org-tag-persistent-alist nil
)
4921 ("hideblocks" org-hide-block-startup t
)
4922 ("nohideblocks" org-hide-block-startup nil
)
4923 ("beamer" org-startup-with-beamer-mode t
)
4924 ("entitiespretty" org-pretty-entities t
)
4925 ("entitiesplain" org-pretty-entities nil
))
4926 "Variable associated with STARTUP options for org-mode.
4927 Each element is a list of three items: the startup options (as written
4928 in the #+STARTUP line), the corresponding variable, and the value to set
4929 this variable to if the option is found. An optional forth element PUSH
4930 means to push this value onto the list in the variable.")
4932 (defcustom org-group-tags t
4933 "When non-nil (the default), use group tags.
4934 This can be turned on/off through `org-toggle-tags-groups'."
4939 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4941 (defun org-toggle-tags-groups ()
4942 "Toggle support for group tags.
4943 Support for group tags is controlled by the option
4944 `org-group-tags', which is non-nil by default."
4946 (setq org-group-tags
(not org-group-tags
))
4947 (cond ((and (derived-mode-p 'org-agenda-mode
)
4950 ((derived-mode-p 'org-mode
)
4951 (let ((org-inhibit-startup t
)) (org-mode))))
4952 (message "Groups tags support has been turned %s"
4953 (if org-group-tags
"on" "off")))
4955 (defun org-set-regexps-and-options (&optional tags-only
)
4956 "Precompute regular expressions used in the current buffer.
4957 When optional argument TAGS-ONLY is non-nil, only compute tags
4958 related expressions."
4959 (when (derived-mode-p 'org-mode
)
4960 (let ((alist (org--setup-collect-keywords
4961 (org-make-options-regexp
4962 (append '("FILETAGS" "TAGS" "SETUPFILE")
4963 (and (not tags-only
)
4964 '("ARCHIVE" "CATEGORY" "COLUMNS" "CONSTANTS"
4965 "LINK" "OPTIONS" "PRIORITIES" "PROPERTY"
4966 "SEQ_TODO" "STARTUP" "TODO" "TYP_TODO")))))))
4967 (org--setup-process-tags
4968 (cdr (assq 'tags alist
)) (cdr (assq 'filetags alist
)))
4971 (org-set-local 'org-file-properties
(cdr (assq 'property alist
)))
4972 ;; Archive location.
4973 (let ((archive (cdr (assq 'archive alist
))))
4974 (when archive
(org-set-local 'org-archive-location archive
)))
4976 (let ((cat (org-string-nw-p (cdr (assq 'category alist
)))))
4978 (org-set-local 'org-category
(intern cat
))
4979 (org-set-local 'org-file-properties
4980 (org--update-property-plist
4981 "CATEGORY" cat org-file-properties
))))
4983 (let ((column (cdr (assq 'columns alist
))))
4984 (when column
(org-set-local 'org-columns-default-format column
)))
4986 (setq org-table-formula-constants-local
(cdr (assq 'constants alist
)))
4987 ;; Link abbreviations.
4988 (let ((links (cdr (assq 'link alist
))))
4989 (when links
(setq org-link-abbrev-alist-local
(nreverse links
))))
4991 (let ((priorities (cdr (assq 'priorities alist
))))
4993 (org-set-local 'org-highest-priority
(nth 0 priorities
))
4994 (org-set-local 'org-lowest-priority
(nth 1 priorities
))
4995 (org-set-local 'org-default-priority
(nth 2 priorities
))))
4997 (let ((scripts (assq 'scripts alist
)))
4999 (org-set-local 'org-use-sub-superscripts
(cdr scripts
))))
5001 (let ((startup (cdr (assq 'startup alist
))))
5002 (dolist (option startup
)
5003 (let ((entry (assoc-string option org-startup-options t
)))
5005 (let ((var (nth 1 entry
))
5006 (val (nth 2 entry
)))
5007 (if (not (nth 3 entry
)) (org-set-local var val
)
5008 (unless (listp (symbol-value var
))
5009 (org-set-local var nil
))
5010 (add-to-list var val
)))))))
5012 (org-set-local 'org-todo-kwd-alist nil
)
5013 (org-set-local 'org-todo-key-alist nil
)
5014 (org-set-local 'org-todo-key-trigger nil
)
5015 (org-set-local 'org-todo-keywords-1 nil
)
5016 (org-set-local 'org-done-keywords nil
)
5017 (org-set-local 'org-todo-heads nil
)
5018 (org-set-local 'org-todo-sets nil
)
5019 (org-set-local 'org-todo-log-states nil
)
5020 (let ((todo-sequences
5021 (or (nreverse (cdr (assq 'todo alist
)))
5022 (let ((d (default-value 'org-todo-keywords
)))
5023 (if (not (stringp (car d
))) d
5024 ;; XXX: Backward compatibility code.
5025 (list (cons org-todo-interpretation d
)))))))
5026 (dolist (sequence todo-sequences
)
5027 (let* ((sequence (or (run-hook-with-args-until-success
5028 'org-todo-setup-filter-hook sequence
)
5030 (sequence-type (car sequence
))
5031 (keywords (cdr sequence
))
5032 (sep (member "|" keywords
))
5034 (dolist (k (remove "|" keywords
))
5035 (unless (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$"
5037 (error "Invalid TODO keyword %s" k
))
5038 (let ((name (match-string 1 k
))
5039 (key (match-string 2 k
))
5040 (log (org-extract-log-state-settings k
)))
5042 (push (cons name
(and key
(string-to-char key
))) alist
)
5043 (when log
(push log org-todo-log-states
))))
5044 (let* ((names (nreverse names
))
5045 (done (if sep
(org-remove-keyword-keys (cdr sep
))
5048 (tail (list sequence-type head
(car done
) (org-last done
))))
5049 (add-to-list 'org-todo-heads head
'append
)
5050 (push names org-todo-sets
)
5051 (setq org-done-keywords
(append org-done-keywords done nil
))
5052 (setq org-todo-keywords-1
(append org-todo-keywords-1 names nil
))
5053 (setq org-todo-key-alist
5054 (append org-todo-key-alist
5056 (append '((:startgroup
))
5059 (dolist (k names
) (push (cons k tail
) org-todo-kwd-alist
))))))
5060 (setq org-todo-sets
(nreverse org-todo-sets
)
5061 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5062 org-todo-key-trigger
(delq nil
(mapcar #'cdr org-todo-key-alist
))
5063 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
))
5064 ;; Compute the regular expressions and other local variables.
5065 ;; Using `org-outline-regexp-bol' would complicate them much,
5066 ;; because of the fixed white space at the end of that string.
5067 (if (not org-done-keywords
)
5068 (setq org-done-keywords
5069 (and org-todo-keywords-1
(last org-todo-keywords-1
))))
5070 (setq org-not-done-keywords
5071 (org-delete-all org-done-keywords
5072 (copy-sequence org-todo-keywords-1
))
5073 org-todo-regexp
(regexp-opt org-todo-keywords-1 t
)
5074 org-not-done-regexp
(regexp-opt org-not-done-keywords t
)
5075 org-not-done-heading-regexp
5076 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5077 org-todo-line-regexp
5078 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5079 org-complex-heading-regexp
5080 (concat "^\\(\\*+\\)"
5081 "\\(?: +" org-todo-regexp
"\\)?"
5082 "\\(?: +\\(\\[#.\\]\\)\\)?"
5083 "\\(?: +\\(.*?\\)\\)??"
5084 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5086 org-complex-heading-regexp-format
5087 (concat "^\\(\\*+\\)"
5088 "\\(?: +" org-todo-regexp
"\\)?"
5089 "\\(?: +\\(\\[#.\\]\\)\\)?"
5091 ;; Stats cookies can be stuck to body.
5092 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5094 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5096 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5098 org-todo-line-tags-regexp
5099 (concat "^\\(\\*+\\)"
5100 "\\(?: +" org-todo-regexp
"\\)?"
5101 "\\(?: +\\(.*?\\)\\)??"
5102 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5104 (org-compute-latex-and-related-regexp)))))
5106 (defun org--setup-collect-keywords (regexp &optional files alist
)
5107 "Return setup keywords values as an alist.
5109 REGEXP matches a subset of setup keywords. FILES is a list of
5110 file names already visited. It is used to avoid circular setup
5111 files. ALIST, when non-nil, is the alist computed so far.
5113 Return value contains the following keys: `archive', `category',
5114 `columns', `constants', `filetags', `link', `priorities',
5115 `property', `scripts', `startup', `tags' and `todo'."
5116 (org-with-wide-buffer
5117 (goto-char (point-min))
5118 (let ((case-fold-search t
))
5119 (while (re-search-forward regexp nil t
)
5120 (let ((element (org-element-at-point)))
5121 (when (eq (org-element-type element
) 'keyword
)
5122 (let ((key (org-element-property :key element
))
5123 (value (org-element-property :value element
)))
5125 ((equal key
"ARCHIVE")
5126 (when (org-string-nw-p value
)
5127 (push (cons 'archive value
) alist
)))
5128 ((equal key
"CATEGORY") (push (cons 'category value
) alist
))
5129 ((equal key
"COLUMNS") (push (cons 'columns value
) alist
))
5130 ((equal key
"CONSTANTS")
5131 (let* ((constants (assq 'constants alist
))
5132 (store (cdr constants
)))
5133 (dolist (pair (org-split-string value
))
5134 (when (string-match "^\\([a-zA-Z0][_a-zA-Z0-9]*\\)=\\(.*\\)"
5136 (let* ((name (match-string 1 pair
))
5137 (value (match-string 2 pair
))
5138 (old (assoc name store
)))
5139 (if old
(setcdr old value
)
5140 (push (cons name value
) store
)))))
5141 (if constants
(setcdr constants store
)
5142 (push (cons 'constants store
) alist
))))
5143 ((equal key
"FILETAGS")
5144 (when (org-string-nw-p value
)
5145 (let ((old (assq 'filetags alist
))
5147 (mapcar (lambda (x) (org-split-string x
":"))
5148 (org-split-string value
)))))
5149 (if old
(setcdr old
(append new
(cdr old
)))
5150 (push (cons 'filetags new
) alist
)))))
5152 (when (string-match "\\`\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5153 (let ((links (assq 'link alist
))
5154 (pair (cons (org-match-string-no-properties 1 value
)
5155 (org-match-string-no-properties 2 value
))))
5156 (if links
(push pair
(cdr links
))
5157 (push (list 'link pair
) alist
)))))
5158 ((equal key
"OPTIONS")
5159 (when (and (org-string-nw-p value
)
5160 (string-match "\\^:\\(t\\|nil\\|{}\\)" value
))
5161 (push (cons 'scripts
(read (match-string 1 value
))) alist
)))
5162 ((equal key
"PRIORITIES")
5163 (push (cons 'priorities
5164 (let ((prio (org-split-string value
)))
5165 (if (< (length prio
) 3) '(?A ?C ?B
)
5166 (mapcar #'string-to-char prio
))))
5168 ((equal key
"PROPERTY")
5169 (when (string-match "\\(\\S-+\\)[ \t]+\\(.*\\)" value
)
5170 (let* ((property (assq 'property alist
))
5171 (value (org--update-property-plist
5172 (org-match-string-no-properties 1 value
)
5173 (org-match-string-no-properties 2 value
)
5175 (if property
(setcdr property value
)
5176 (push (cons 'property value
) alist
)))))
5177 ((equal key
"STARTUP")
5178 (let ((startup (assq 'startup alist
)))
5181 (append (cdr startup
) (org-split-string value
)))
5182 (push (cons 'startup
(org-split-string value
)) alist
))))
5184 (let ((tag-cell (assq 'tags alist
)))
5187 (append (cdr tag-cell
)
5189 (org-split-string value
)))
5190 (push (cons 'tags
(org-split-string value
)) alist
))))
5191 ((member key
'("TODO" "SEQ_TODO" "TYP_TODO"))
5192 (let ((todo (assq 'todo alist
))
5193 (value (cons (if (equal key
"TYP_TODO") 'type
'sequence
)
5194 (org-split-string value
))))
5195 (if todo
(push value
(cdr todo
))
5196 (push (list 'todo value
) alist
))))
5197 ((equal key
"SETUPFILE")
5198 (unless buffer-read-only
; Do not check in Gnus messages.
5199 (let ((f (and (org-string-nw-p value
)
5201 (org-remove-double-quotes value
)))))
5202 (when (and f
(file-readable-p f
) (not (member f files
)))
5204 (insert-file-contents f
)
5206 ;; Fake Org mode to benefit from cache
5207 ;; without recurring needlessly.
5208 (let ((major-mode 'org-mode
))
5209 (org--setup-collect-keywords
5210 regexp
(cons f files
) alist
)))))))))))))))
5213 (defun org--setup-process-tags (tags filetags
)
5214 "Precompute variables used for tags.
5215 TAGS is a list of tags and tag group symbols, as strings.
5216 FILETAGS is a list of tags, as strings."
5217 ;; Process the file tags.
5218 (org-set-local 'org-file-tags
5219 (mapcar #'org-add-prop-inherited filetags
))
5220 ;; Provide default tags if no local tags are found.
5221 (when (and (not tags
) org-tag-alist
)
5223 (mapcar (lambda (tag)
5227 (:startgrouptag
"[")
5231 (otherwise (concat (car tag
)
5232 (and (characterp (cdr tag
))
5233 (format "(%c)" (cdr tag
)))))))
5235 ;; Process the tags.
5236 (org-set-local 'org-tag-groups-alist nil
)
5237 (org-set-local 'org-tag-alist nil
)
5240 (let ((e (car tags
)))
5241 (setq tags
(cdr tags
))
5244 (push '(:startgroup
) org-tag-alist
)
5245 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5247 (push '(:endgroup
) org-tag-alist
)
5248 (setq group-flag nil
))
5250 (push '(:startgrouptag
) org-tag-alist
)
5251 (when (equal (nth 1 tags
) ":") (setq group-flag t
)))
5253 (push '(:endgrouptag
) org-tag-alist
)
5254 (setq group-flag nil
))
5256 (push '(:grouptags
) org-tag-alist
)
5257 (setq group-flag
'append
))
5258 ((equal e
"\\n") (push '(:newline
) org-tag-alist
))
5260 (org-re (concat "\\`\\([[:alnum:]_@#%]+"
5261 "\\|{.+?}\\)" ; regular expression
5262 "\\(?:(\\(.\\))\\)?\\'")) e
)
5263 (let ((tag (match-string 1 e
))
5264 (key (and (match-beginning 2)
5265 (string-to-char (match-string 2 e
)))))
5266 (cond ((eq group-flag
'append
)
5267 (setcar org-tag-groups-alist
5268 (append (car org-tag-groups-alist
) (list tag
))))
5269 (group-flag (push (list tag
) org-tag-groups-alist
)))
5270 ;; Push all tags in groups, no matter if they already exist.
5271 (unless (and (not group-flag
) (assoc tag org-tag-alist
))
5272 (push (cons tag key
) org-tag-alist
))))))))
5273 (setq org-tag-alist
(nreverse org-tag-alist
)))
5275 (defun org-file-contents (file &optional noerror
)
5276 "Return the contents of FILE, as a string."
5277 (if (and file
(file-readable-p file
))
5279 (insert-file-contents file
)
5281 (funcall (if noerror
'message
'error
)
5282 "Cannot read file \"%s\"%s"
5284 (let ((from (buffer-file-name (buffer-base-buffer))))
5285 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5287 (defun org-extract-log-state-settings (x)
5288 "Extract the log state setting from a TODO keyword string.
5289 This will extract info from a string like \"WAIT(w@/!)\"."
5290 (let (kw key log1 log2
)
5291 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5292 (setq kw
(match-string 1 x
)
5293 key
(and (match-end 2) (match-string 2 x
))
5294 log1
(and (match-end 3) (match-string 3 x
))
5295 log2
(and (match-end 4) (match-string 4 x
)))
5298 (and log1
(if (equal log1
"!") 'time
'note
))
5299 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5301 (defun org-remove-keyword-keys (list)
5302 "Remove a pair of parenthesis at the end of each string in LIST."
5304 (if (string-match "(.*)$" x
)
5305 (substring x
0 (match-beginning 0))
5309 (defun org-assign-fast-keys (alist)
5310 "Assign fast keys to a keyword-key alist.
5311 Respect keys that are already there."
5312 (let (new e
(alt ?
0))
5313 (while (setq e
(pop alist
))
5314 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5315 (cdr e
)) ;; Key already assigned.
5317 (let ((clist (string-to-list (downcase (car e
))))
5318 (used (append new alist
)))
5319 (when (= (car clist
) ?
@)
5321 (while (and clist
(rassoc (car clist
) used
))
5324 (while (rassoc alt used
)
5326 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5329 ;;; Some variables used in various places
5331 (defvar org-window-configuration nil
5332 "Used in various places to store a window configuration.")
5333 (defvar org-selected-window nil
5334 "Used in various places to store a window configuration.")
5335 (defvar org-finish-function nil
5336 "Function to be called when `C-c C-c' is used.
5337 This is for getting out of special buffers like capture.")
5340 ;; FIXME: Occasionally check by commenting these, to make sure
5341 ;; no other functions uses these, forgetting to let-bind them.
5342 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5343 (defvar org-last-state
)
5344 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5346 ;; Defined somewhere in this file, but used before definition.
5347 (defvar org-entities
) ;; defined in org-entities.el
5348 (defvar org-struct-menu
)
5349 (defvar org-org-menu
)
5350 (defvar org-tbl-menu
)
5352 ;;;; Define the Org-mode
5354 ;; We use a before-change function to check if a table might need
5356 (defvar org-table-may-need-update t
5357 "Indicates that a table might need an update.
5358 This variable is set by `org-before-change-function'.
5359 `org-table-align' sets it back to nil.")
5360 (defun org-before-change-function (beg end
)
5361 "Every change indicates that a table might need an update."
5362 (setq org-table-may-need-update t
))
5363 (defvar org-mode-map
)
5364 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5365 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5366 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5367 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5368 (defvar org-table-buffer-is-an nil
)
5370 (defvar bidi-paragraph-direction
)
5371 (defvar buffer-face-mode-face
)
5374 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5375 (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"))
5376 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5378 ;; Other stuff we need.
5379 (require 'time-date
)
5380 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5384 ;; (require 'org-macs) moved higher up in the file before it is first used
5385 (require 'org-entities
)
5386 ;; (require 'org-compat) moved higher up in the file before it is first used
5387 (require 'org-faces
)
5389 (require 'org-pcomplete
)
5391 (require 'org-footnote
)
5392 (require 'org-macro
)
5398 (define-derived-mode org-mode outline-mode
"Org"
5399 "Outline-based notes management and organizer, alias
5400 \"Carsten's outline-mode for keeping track of everything.\"
5402 Org-mode develops organizational tasks around a NOTES file which
5403 contains information about projects as plain text. Org-mode is
5404 implemented on top of outline-mode, which is ideal to keep the content
5405 of large files well structured. It supports ToDo items, deadlines and
5406 time stamps, which magically appear in the diary listing of the Emacs
5407 calendar. Tables are easily created with a built-in table editor.
5408 Plain text URL-like links connect to websites, emails (VM), Usenet
5409 messages (Gnus), BBDB entries, and any files related to the project.
5410 For printing and sharing of notes, an Org-mode file (or a part of it)
5411 can be exported as a structured ASCII or HTML file.
5413 The following commands are available:
5417 ;; Get rid of Outline menus, they are not needed
5418 ;; Need to do this here because define-derived-mode sets up
5419 ;; the keymap so late. Still, it is a waste to call this each time
5420 ;; we switch another buffer into org-mode.
5421 (if (featurep 'xemacs
)
5422 (when (boundp 'outline-mode-menu-heading
)
5423 ;; Assume this is Greg's port, it uses easymenu
5424 (easy-menu-remove outline-mode-menu-heading
)
5425 (easy-menu-remove outline-mode-menu-show
)
5426 (easy-menu-remove outline-mode-menu-hide
))
5427 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5428 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5429 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5431 (org-load-modules-maybe)
5432 (easy-menu-add org-org-menu
)
5433 (easy-menu-add org-tbl-menu
)
5434 (org-install-agenda-files-menu)
5435 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5436 (add-to-invisibility-spec '(org-cwidth))
5437 (add-to-invisibility-spec '(org-hide-block . t
))
5438 (when (featurep 'xemacs
)
5439 (org-set-local 'line-move-ignore-invisible t
))
5440 (org-set-local 'outline-regexp org-outline-regexp
)
5441 (org-set-local 'outline-level
'org-outline-level
)
5442 (setq bidi-paragraph-direction
'left-to-right
)
5443 (when (and org-ellipsis
5444 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5445 (fboundp 'make-glyph-code
))
5446 (unless org-display-table
5447 (setq org-display-table
(make-display-table)))
5448 (set-display-table-slot
5451 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5453 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5454 (setq buffer-display-table org-display-table
))
5455 (org-set-regexps-and-options)
5456 (org-set-font-lock-defaults)
5457 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5458 ;; tag faces set outside customize.... force initialization.
5459 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5461 (org-set-local 'calc-embedded-open-mode
"# ")
5462 ;; Modify a few syntax entries
5463 (modify-syntax-entry ?
@ "w")
5464 (modify-syntax-entry ?
\" "\"")
5465 (modify-syntax-entry ?
\\ "_")
5466 (modify-syntax-entry ?~
"_")
5467 (if org-startup-truncated
(setq truncate-lines t
))
5468 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5469 (org-set-local 'font-lock-unfontify-region-function
5470 'org-unfontify-region
)
5471 ;; Activate before-change-function
5472 (org-set-local 'org-table-may-need-update t
)
5473 (org-add-hook 'before-change-functions
'org-before-change-function nil
5475 ;; Check for running clock before killing a buffer
5476 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5477 ;; Initialize macros templates.
5478 (org-macro-initialize-templates)
5479 ;; Initialize radio targets.
5480 (org-update-radio-target-regexp)
5482 (org-set-local 'indent-line-function
'org-indent-line
)
5483 (org-set-local 'indent-region-function
'org-indent-region
)
5484 ;; Filling and auto-filling.
5487 (org-setup-comments-handling)
5488 ;; Initialize cache.
5489 (org-element-cache-reset)
5490 ;; Beginning/end of defun
5491 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5492 (org-set-local 'end-of-defun-function
5494 (if (not (org-at-heading-p))
5495 (org-forward-element)
5496 (org-forward-element)
5497 (forward-char -
1))))
5498 ;; Next error for sparse trees
5499 (org-set-local 'next-error-function
'org-occur-next-match
)
5500 ;; Make sure dependence stuff works reliably, even for users who set it
5502 (if org-enforce-todo-dependencies
5503 (add-hook 'org-blocker-hook
5504 'org-block-todo-from-children-or-siblings-or-parent
)
5505 (remove-hook 'org-blocker-hook
5506 'org-block-todo-from-children-or-siblings-or-parent
))
5507 (if org-enforce-todo-checkbox-dependencies
5508 (add-hook 'org-blocker-hook
5509 'org-block-todo-from-checkboxes
)
5510 (remove-hook 'org-blocker-hook
5511 'org-block-todo-from-checkboxes
))
5513 ;; Align options lines
5515 'align-mode-rules-list
5516 '((org-in-buffer-settings
5517 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5518 (modes .
'(org-mode)))))
5521 (org-set-local 'imenu-create-index-function
5522 'org-imenu-get-tree
)
5524 ;; Make isearch reveal context
5525 (if (or (featurep 'xemacs
)
5526 (not (boundp 'outline-isearch-open-invisible-function
)))
5527 ;; Emacs 21 and XEmacs make use of the hook
5528 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5529 ;; Emacs 22 deals with this through a special variable
5530 (org-set-local 'outline-isearch-open-invisible-function
5531 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5533 ;; Setup the pcomplete hooks
5534 (set (make-local-variable 'pcomplete-command-completion-function
)
5535 'org-pcomplete-initial
)
5536 (set (make-local-variable 'pcomplete-command-name-function
)
5537 'org-command-at-point
)
5538 (set (make-local-variable 'pcomplete-default-completion-function
)
5540 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5541 'org-parse-arguments
)
5542 (set (make-local-variable 'pcomplete-termination-string
) "")
5543 (when (>= emacs-major-version
23)
5544 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5546 ;; If empty file that did not turn on org-mode automatically, make it to.
5547 (if (and org-insert-mode-line-in-empty-file
5548 (org-called-interactively-p 'any
)
5549 (= (point-min) (point-max)))
5550 (insert "# -*- mode: org -*-\n\n"))
5551 (unless org-inhibit-startup
5553 (and org-startup-with-beamer-mode
(org-beamer-mode))
5554 (when org-startup-align-all-tables
5555 (org-table-map-tables 'org-table-align
'quietly
))
5556 (when org-startup-with-inline-images
5557 (org-display-inline-images))
5558 (when org-startup-with-latex-preview
5559 (org-toggle-latex-fragment))
5560 (unless org-inhibit-startup-visibility-stuff
5561 (org-set-startup-visibility))
5562 (org-refresh-effort-properties)))
5563 ;; Try to set org-hide correctly
5564 (let ((foreground (org-find-invisible-foreground)))
5566 (set-face-foreground 'org-hide foreground
))))
5568 ;; Update `customize-package-emacs-version-alist'
5569 (add-to-list 'customize-package-emacs-version-alist
5570 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5571 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5572 ("8.2.6" .
"24.4") ("8.3" .
"25.1")))
5574 (defvar org-mode-transpose-word-syntax-table
5575 (let ((st (make-syntax-table text-mode-syntax-table
)))
5576 (mapc (lambda(c) (modify-syntax-entry
5577 (string-to-char (car c
)) "w p" st
))
5581 (when (fboundp 'abbrev-table-put
)
5582 (abbrev-table-put org-mode-abbrev-table
5583 :parents
(list text-mode-abbrev-table
)))
5585 (defun org-find-invisible-foreground ()
5586 (let ((candidates (remove
5589 (list (face-background 'default
)
5590 (face-background 'org-default
))
5593 (when (boundp alist
)
5594 (cdr (assoc 'background-color
(symbol-value alist
)))))
5595 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5596 (list (face-foreground 'org-hide
))))))
5597 (car (remove nil candidates
))))
5599 (defun org-current-time (&optional rounding-minutes past
)
5600 "Current time, possibly rounded to ROUNDING-MINUTES.
5601 When ROUNDING-MINUTES is not an integer, fall back on the car of
5602 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5603 the rounding returns a past time."
5604 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5605 (car org-time-stamp-rounding-minutes
)))
5606 (time (decode-time)) res
)
5611 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5613 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5614 (seconds-to-time (- (org-float-time res
) (* r
60)))
5618 "Return today date, considering `org-extend-today-until'."
5620 (time-subtract (current-time)
5621 (list 0 (* 3600 org-extend-today-until
) 0))))
5623 ;;;; Font-Lock stuff, including the activators
5625 (defvar org-mouse-map
(make-sparse-keymap))
5626 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5627 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5628 (when org-mouse-1-follows-link
5629 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5630 (when org-tab-follows-link
5631 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5632 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5634 (require 'font-lock
)
5636 (defconst org-non-link-chars
"]\t\n\r<>")
5637 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5638 "file+sys" "news" "shell" "elisp" "doi" "message"
5640 (defvar org-link-types-re nil
5641 "Matches a link that has a url-like prefix like \"http:\"")
5642 (defvar org-link-re-with-space nil
5643 "Matches a link with spaces, optional angular brackets around it.")
5644 (defvar org-link-re-with-space2 nil
5645 "Matches a link with spaces, optional angular brackets around it.")
5646 (defvar org-link-re-with-space3 nil
5647 "Matches a link with spaces, only for internal part in bracket links.")
5648 (defvar org-angle-link-re nil
5649 "Matches link with angular brackets, spaces are allowed.")
5650 (defvar org-plain-link-re nil
5651 "Matches plain link, without spaces.")
5652 (defvar org-bracket-link-regexp nil
5653 "Matches a link in double brackets.")
5654 (defvar org-bracket-link-analytic-regexp nil
5655 "Regular expression used to analyze links.
5656 Here is what the match groups contain after a match:
5662 (defvar org-bracket-link-analytic-regexp
++ nil
5663 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5664 (defvar org-any-link-re nil
5665 "Regular expression matching any link.")
5667 (defconst org-match-sexp-depth
3
5668 "Number of stacked braces for sub/superscript matching.")
5670 (defun org-create-multibrace-regexp (left right n
)
5671 "Create a regular expression which will match a balanced sexp.
5672 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5673 as single character strings.
5674 The regexp returned will match the entire expression including the
5675 delimiters. It will also define a single group which contains the
5676 match except for the outermost delimiters. The maximum depth of
5677 stacked delimiters is N. Escaping delimiters is not possible."
5678 (let* ((nothing (concat "[^" left right
"]*?"))
5681 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5684 re
(concat re or next
)
5685 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5686 (concat left
"\\(" re
"\\)" right
)))
5688 (defconst org-match-substring-regexp
5690 "\\(\\S-\\)\\([_^]\\)\\("
5691 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5693 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5695 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5696 "The regular expression matching a sub- or superscript.")
5698 (defconst org-match-substring-with-braces-regexp
5700 "\\(\\S-\\)\\([_^]\\)"
5701 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5702 "The regular expression matching a sub- or superscript, forcing braces.")
5704 (defun org-make-link-regexps ()
5705 "Update the link regular expressions.
5706 This should be called after the variable `org-link-types' has changed."
5707 (let ((types-re (regexp-opt org-link-types t
)))
5708 (setq org-link-types-re
5709 (concat "\\`" types-re
":")
5710 org-link-re-with-space
5711 (concat "<?" types-re
":"
5712 "\\([^" org-non-link-chars
" ]"
5713 "[^" org-non-link-chars
"]*"
5714 "[^" org-non-link-chars
" ]\\)>?")
5715 org-link-re-with-space2
5716 (concat "<?" types-re
":"
5717 "\\([^" org-non-link-chars
" ]"
5719 "[^" org-non-link-chars
" ]\\)>?")
5720 org-link-re-with-space3
5721 (concat "<?" types-re
":"
5722 "\\([^" org-non-link-chars
" ]"
5725 (concat "<" types-re
":"
5726 "\\([^" org-non-link-chars
" ]"
5727 "[^" org-non-link-chars
"]*"
5732 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5733 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5734 org-bracket-link-regexp
5735 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5736 org-bracket-link-analytic-regexp
5739 "\\(" types-re
":\\)?"
5742 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5744 org-bracket-link-analytic-regexp
++
5747 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5750 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5753 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5754 org-angle-link-re
"\\)\\|\\("
5755 org-plain-link-re
"\\)"))))
5757 (org-make-link-regexps)
5759 (defvar org-emph-face nil
)
5761 (defun org-do-emphasis-faces (limit)
5762 "Run through the buffer and emphasize strings."
5764 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5765 (let* ((border (char-after (match-beginning 3)))
5766 (bre (regexp-quote (char-to-string border
))))
5767 (if (and (not (= border
(char-after (match-beginning 4))))
5768 (not (save-match-data
5769 (string-match (concat bre
".*" bre
)
5770 (replace-regexp-in-string
5772 (substring (match-string 2) 1 -
1))))))
5775 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5776 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5780 (org-remove-flyspell-overlays-in
5781 (match-beginning 0) (match-end 0)))
5782 (add-text-properties (match-beginning 2) (match-end 2)
5783 '(font-lock-multiline t org-emphasis t
))
5784 (when org-hide-emphasis-markers
5785 (add-text-properties (match-end 4) (match-beginning 5)
5786 '(invisible org-link
))
5787 (add-text-properties (match-beginning 3) (match-end 3)
5788 '(invisible org-link
))))))
5789 (goto-char (1+ (match-beginning 0))))
5792 (defun org-emphasize (&optional char
)
5793 "Insert or change an emphasis, i.e. a font like bold or italic.
5794 If there is an active region, change that region to a new emphasis.
5795 If there is no region, just insert the marker characters and position
5796 the cursor between them.
5797 CHAR should be the marker character. If it is a space, it means to
5798 remove the emphasis of the selected region.
5799 If CHAR is not given (for example in an interactive call) it will be
5802 (let ((erc org-emphasis-regexp-components
)
5804 (string "") beg end move c s
)
5805 (if (org-region-active-p)
5806 (setq beg
(region-beginning) end
(region-end)
5807 string
(buffer-substring beg end
))
5811 (message "Emphasis marker or tag: [%s]"
5812 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5813 (setq char
(read-char-exclusive)))
5814 (if (equal char ?\
)
5815 (setq s
"" move nil
)
5816 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5817 (user-error "No such emphasis marker: \"%c\"" char
))
5818 (setq s
(char-to-string char
)))
5819 (while (and (> (length string
) 1)
5820 (equal (substring string
0 1) (substring string -
1))
5821 (assoc (substring string
0 1) org-emphasis-alist
))
5822 (setq string
(substring string
1 -
1)))
5823 (setq string
(concat s string s
))
5824 (if beg
(delete-region beg end
))
5826 (string-match (concat "[" (nth 0 erc
) "\n]")
5827 (char-to-string (char-before (point)))))
5830 (string-match (concat "[" (nth 1 erc
) "\n]")
5831 (char-to-string (char-after (point)))))
5832 (insert " ") (backward-char 1))
5834 (and move
(backward-char 1))))
5836 (defconst org-nonsticky-props
5837 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5839 (defsubst org-rear-nonsticky-at
(pos)
5840 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5842 (defun org-activate-plain-links (limit)
5843 "Add link properties for plain links."
5845 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5846 (not (member 'org-tag
5847 (get-text-property (1- (match-beginning 0)) 'face
)))
5848 (not (org-in-src-block-p)))
5849 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5850 (setq f
(get-text-property (match-beginning 0) 'face
))
5851 (setq hl
(org-match-string-no-properties 0))
5852 (if (or (eq f
'org-tag
)
5853 (and (listp f
) (memq 'org-tag f
)))
5855 (add-text-properties (match-beginning 0) (match-end 0)
5856 (list 'mouse-face
'highlight
5858 'htmlize-link
`(:uri
,hl
)
5859 'keymap org-mouse-map
))
5860 (org-rear-nonsticky-at (match-end 0)))
5863 (defun org-activate-code (limit)
5864 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5866 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5867 (remove-text-properties (match-beginning 0) (match-end 0)
5868 '(display t invisible t intangible t
))
5871 (defcustom org-src-fontify-natively t
5872 "When non-nil, fontify code in code blocks."
5875 :package-version
'(Org .
"8.3")
5876 :group
'org-appearance
5879 (defcustom org-allow-promoting-top-level-subtree nil
5880 "When non-nil, allow promoting a top level subtree.
5881 The leading star of the top level headline will be replaced
5885 :group
'org-appearance
)
5887 (defun org-fontify-meta-lines-and-blocks (limit)
5889 (org-fontify-meta-lines-and-blocks-1 limit
)
5890 (error (message "org-mode fontification error"))))
5892 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5893 "Fontify #+ lines and blocks."
5894 (let ((case-fold-search t
))
5895 (if (re-search-forward
5896 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5898 (let ((beg (match-beginning 0))
5899 (block-start (match-end 0))
5901 (lang (match-string 7))
5902 (beg1 (line-beginning-position 2))
5903 (dc1 (downcase (match-string 2)))
5904 (dc3 (downcase (match-string 3)))
5905 end end1 quoting block-type ovl
)
5907 ((and (match-end 4) (equal dc3
"+begin"))
5909 (setq block-type
(downcase (match-string 5))
5910 quoting
(member block-type org-protecting-blocks
))
5911 (when (re-search-forward
5912 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5913 nil t
) ;; on purpose, we look further than LIMIT
5914 (setq end
(min (point-max) (match-end 0))
5915 end1
(min (point-max) (1- (match-beginning 0))))
5916 (setq block-end
(match-beginning 0))
5918 (org-remove-flyspell-overlays-in beg1 end1
)
5919 (remove-text-properties beg end
5920 '(display t invisible t intangible t
)))
5921 (add-text-properties
5922 beg end
'(font-lock-fontified t font-lock-multiline t
))
5923 (add-text-properties beg beg1
'(face org-meta-line
))
5924 (org-remove-flyspell-overlays-in beg beg1
)
5925 (add-text-properties ; For end_src
5926 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5927 (org-remove-flyspell-overlays-in end1 end
)
5929 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5930 (org-src-font-lock-fontify-block lang block-start block-end
)
5931 (add-text-properties beg1 block-end
'(src-block t
)))
5933 (add-text-properties beg1
(min (point-max) (1+ end1
))
5934 '(face org-block
))) ; end of source block
5935 ((not org-fontify-quote-and-verse-blocks
))
5936 ((string= block-type
"quote")
5937 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5938 ((string= block-type
"verse")
5939 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5940 (add-text-properties beg beg1
'(face org-block-begin-line
))
5941 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5942 '(face org-block-end-line
))
5944 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5945 (org-remove-flyspell-overlays-in
5947 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5948 (add-text-properties
5950 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5951 '(font-lock-fontified t invisible t
)
5952 '(font-lock-fontified t face org-document-info-keyword
)))
5953 (add-text-properties
5954 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5955 (if (string-equal dc1
"+title:")
5956 '(font-lock-fontified t face org-document-title
)
5957 '(font-lock-fontified t face org-document-info
))))
5958 ((equal dc1
"+caption:")
5959 (org-remove-flyspell-overlays-in (match-end 2) (match-end 0))
5960 (remove-text-properties (match-beginning 0) (match-end 0)
5961 '(display t invisible t intangible t
))
5962 (add-text-properties (match-beginning 1) (match-end 3)
5963 '(font-lock-fontified t face org-meta-line
))
5964 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5965 '(font-lock-fontified t face org-block
))
5967 ((member dc3
'(" " ""))
5968 (org-remove-flyspell-overlays-in beg
(match-end 0))
5969 (add-text-properties
5971 '(font-lock-fontified t face font-lock-comment-face
)))
5972 (t ;; just any other in-buffer setting, but not indented
5973 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5974 (remove-text-properties (match-beginning 0) (match-end 0)
5975 '(display t invisible t intangible t
))
5976 (add-text-properties beg
(match-end 0)
5977 '(font-lock-fontified t face org-meta-line
))
5980 (defun org-fontify-drawers (limit)
5982 (when (re-search-forward org-drawer-regexp limit t
)
5983 (add-text-properties
5984 (match-beginning 0) (match-end 0)
5985 '(font-lock-fontified t face org-special-keyword
))
5986 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5989 (defun org-fontify-macros (limit)
5991 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
5992 (add-text-properties
5993 (match-beginning 0) (match-end 0)
5994 '(font-lock-fontified t face org-macro
))
5995 (when org-hide-macro-markers
5996 (add-text-properties (match-end 2) (match-beginning 2)
5998 (add-text-properties (match-beginning 1) (match-end 1)
6000 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6003 (defun org-activate-angle-links (limit)
6004 "Add text properties for angle links."
6005 (if (and (re-search-forward org-angle-link-re limit t
)
6006 (not (org-in-src-block-p)))
6008 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6009 (add-text-properties (match-beginning 0) (match-end 0)
6010 (list 'mouse-face
'highlight
6011 'keymap org-mouse-map
))
6012 (org-rear-nonsticky-at (match-end 0))
6015 (defun org-activate-footnote-links (limit)
6016 "Add text properties for footnotes."
6017 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6019 (let* ((beg (nth 1 fn
))
6022 (referencep (/= (line-beginning-position) beg
)))
6023 (when (and referencep
(nth 3 fn
))
6026 (search-forward (or label
"fn:"))
6027 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6028 (add-text-properties beg end
6029 (list 'mouse-face
'highlight
6030 'keymap org-mouse-map
6032 (if referencep
"Footnote reference"
6033 "Footnote definition")
6034 'font-lock-fontified t
6035 'font-lock-multiline t
6036 'face
'org-footnote
))))))
6038 (defun org-activate-bracket-links (limit)
6039 "Add text properties for bracketed links."
6040 (if (and (re-search-forward org-bracket-link-regexp limit t
)
6041 (not (org-in-src-block-p)))
6042 (let* ((hl (org-match-string-no-properties 1))
6043 (help (concat "LINK: " (save-match-data (org-link-unescape hl
))))
6044 (ip (org-maybe-intangible
6045 (list 'invisible
'org-link
6046 'keymap org-mouse-map
'mouse-face
'highlight
6047 'font-lock-multiline t
'help-echo help
6048 'htmlize-link
`(:uri
,hl
))))
6049 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
6050 'font-lock-multiline t
'help-echo help
6051 'htmlize-link
`(:uri
,hl
))))
6052 ;; We need to remove the invisible property here. Table narrowing
6053 ;; may have made some of this invisible.
6054 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6055 (remove-text-properties (match-beginning 0) (match-end 0)
6059 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6060 (org-rear-nonsticky-at (match-beginning 3))
6061 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6062 (org-rear-nonsticky-at (match-end 3))
6063 (add-text-properties (match-end 3) (match-end 0) ip
)
6064 (org-rear-nonsticky-at (match-end 0)))
6065 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6066 (org-rear-nonsticky-at (match-beginning 1))
6067 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6068 (org-rear-nonsticky-at (match-end 1))
6069 (add-text-properties (match-end 1) (match-end 0) ip
)
6070 (org-rear-nonsticky-at (match-end 0)))
6073 (defun org-activate-dates (limit)
6074 "Add text properties for dates."
6075 (if (and (re-search-forward org-tsr-regexp-both limit t
)
6076 (not (equal (char-before (match-beginning 0)) 91)))
6078 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6079 (add-text-properties (match-beginning 0) (match-end 0)
6080 (list 'mouse-face
'highlight
6081 'keymap org-mouse-map
))
6082 (org-rear-nonsticky-at (match-end 0))
6083 (when org-display-custom-times
6085 (org-display-custom-time (match-beginning 3) (match-end 3)))
6086 (org-display-custom-time (match-beginning 1) (match-end 1)))
6089 (defvar org-target-link-regexp nil
6090 "Regular expression matching radio targets in plain text.")
6091 (make-variable-buffer-local 'org-target-link-regexp
)
6093 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6094 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6095 border border border
))
6096 "Regular expression matching a link target.")
6098 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6099 "Regular expression matching a radio target.")
6101 (defconst org-any-target-regexp
6102 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6103 "Regular expression matching any target.")
6105 (defun org-activate-target-links (limit)
6106 "Add text properties for target matches."
6107 (when org-target-link-regexp
6108 (let ((case-fold-search t
))
6109 (if (re-search-forward org-target-link-regexp limit t
)
6111 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6112 (add-text-properties (match-beginning 1) (match-end 1)
6113 (list 'mouse-face
'highlight
6114 'keymap org-mouse-map
6115 'help-echo
"Radio target link"
6116 'org-linked-text t
))
6117 (org-rear-nonsticky-at (match-end 1))
6120 (defun org-update-radio-target-regexp ()
6121 "Find all radio targets in this file and update the regular expression.
6122 Also refresh fontification if needed."
6124 (let ((old-regexp org-target-link-regexp
)
6125 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6126 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6128 (org-with-wide-buffer
6129 (goto-char (point-min))
6131 (while (re-search-forward org-radio-target-regexp nil t
)
6132 ;; Make sure point is really within the object.
6134 (let ((obj (org-element-context)))
6135 (when (eq (org-element-type obj
) 'radio-target
)
6136 (add-to-list 'rtn
(org-element-property :value obj
)))))
6138 (setq org-target-link-regexp
6143 (replace-regexp-in-string
6144 " +" "\\s-+" (regexp-quote x
) t t
))
6148 (unless (equal old-regexp org-target-link-regexp
)
6150 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6151 ((not org-target-link-regexp
) old-regexp
)
6156 (substring re
(length before-re
)
6157 (- (length after-re
))))
6158 (list old-regexp org-target-link-regexp
)
6161 (org-with-wide-buffer
6162 (goto-char (point-min))
6163 (while (re-search-forward regexp nil t
)
6164 (org-element-cache-refresh (match-beginning 1)))))
6165 ;; Re fontify buffer.
6166 (when (memq 'radio org-highlight-links
)
6167 (org-restart-font-lock)))))
6169 (defun org-hide-wide-columns (limit)
6171 (setq s
(text-property-any (point) (or limit
(point-max))
6174 (setq e
(next-single-property-change s
'org-cwidth
))
6175 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
6179 (defvar org-latex-and-related-regexp nil
6180 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6182 (defun org-compute-latex-and-related-regexp ()
6183 "Compute regular expression for LaTeX, entities and sub/superscript.
6184 Result depends on variable `org-highlight-latex-and-related'."
6186 'org-latex-and-related-regexp
6188 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6189 ((eq org-use-sub-superscripts
'{})
6190 (list org-match-substring-with-braces-regexp
))
6191 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6193 (when (memq 'latex org-highlight-latex-and-related
)
6194 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6197 (and (member (car x
) matchers
) (nth 1 x
)))
6198 org-latex-regexps
)))))
6200 (when (memq 'entities org-highlight-latex-and-related
)
6201 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6202 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6204 (defun org-do-latex-and-related (limit)
6205 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6206 LIMIT bounds the search for syntax to highlight. Stop at first
6207 highlighted object, if any. Return t if some highlighting was
6208 done, nil otherwise."
6209 (when (org-string-nw-p org-latex-and-related-regexp
)
6211 (while (re-search-forward org-latex-and-related-regexp limit t
)
6212 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6214 '(org-code org-verbatim underline
))
6215 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6219 (font-lock-prepend-text-property
6220 (+ offset
(match-beginning 0)) (match-end 0)
6221 'face
'org-latex-and-related
)
6222 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6223 '(font-lock-multiline t
)))
6227 (defun org-restart-font-lock ()
6228 "Restart `font-lock-mode', to force refontification."
6229 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6231 (font-lock-mode 1)))
6233 (defun org-activate-tags (limit)
6234 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
6236 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6237 (add-text-properties (match-beginning 1) (match-end 1)
6238 (list 'mouse-face
'highlight
6239 'keymap org-mouse-map
))
6240 (org-rear-nonsticky-at (match-end 1))
6243 (defun org-outline-level ()
6244 "Compute the outline level of the heading at point.
6246 If this is called at a normal headline, the level is the number
6247 of stars. Use `org-reduced-level' to remove the effect of
6248 `org-odd-levels'. Unlike to `org-current-level', this function
6249 takes into consideration inlinetasks."
6250 (org-with-wide-buffer
6252 (if (re-search-backward org-outline-regexp-bol nil t
)
6253 (1- (- (match-end 0) (match-beginning 0)))
6256 (defvar org-font-lock-keywords nil
)
6258 (defsubst org-re-property
(property &optional literal allow-null value
)
6259 "Return a regexp matching a PROPERTY line.
6261 When optional argument LITERAL is non-nil, do not quote PROPERTY.
6262 This is useful when PROPERTY is a regexp. When ALLOW-NULL is
6263 non-nil, match properties even without a value.
6265 Match group 3 is set to the value when it exists. If there is no
6266 value and ALLOW-NULL is non-nil, it is set to the empty string.
6268 With optional argument VALUE, match only property lines with
6269 that value; in this case, ALLOW-NULL is ignored. VALUE is quoted
6270 unless LITERAL is non-nil."
6273 (format "\\(?1::\\(?2:%s\\):\\)"
6274 (if literal property
(regexp-quote property
)))
6276 (format "[ \t]+\\(?3:%s\\)\\(?5:[ \t]*\\)$"
6277 (if literal value
(regexp-quote value
))))
6279 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$")
6281 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$"))))
6283 (defconst org-property-re
6284 (org-re-property "\\S-+" 'literal t
)
6285 "Regular expression matching a property line.
6286 There are four matching groups:
6287 1: :PROPKEY: including the leading and trailing colon,
6288 2: PROPKEY without the leading and trailing colon,
6289 3: PROPVAL without leading or trailing spaces,
6290 4: the indentation of the current line,
6291 5: trailing whitespace.")
6293 (defvar org-font-lock-hook nil
6294 "Functions to be called for special font lock stuff.")
6296 (defvar org-font-lock-set-keywords-hook nil
6297 "Functions that can manipulate `org-font-lock-extra-keywords'.
6298 This is called after `org-font-lock-extra-keywords' is defined, but before
6299 it is installed to be used by font lock. This can be useful if something
6300 needs to be inserted at a specific position in the font-lock sequence.")
6302 (defun org-font-lock-hook (limit)
6303 "Run `org-font-lock-hook' within LIMIT."
6304 (run-hook-with-args 'org-font-lock-hook limit
))
6306 (defun org-set-font-lock-defaults ()
6307 "Set font lock defaults for the current buffer."
6308 (let* ((em org-fontify-emphasized-text
)
6309 (lk org-highlight-links
)
6310 (org-font-lock-extra-keywords
6313 '(org-font-lock-hook)
6315 `(,(if org-fontify-whole-heading-line
6316 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6317 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6318 (1 (org-get-level-face 1))
6319 (2 (org-get-level-face 2))
6320 (3 (org-get-level-face 3)))
6322 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6325 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6326 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6327 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6328 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6330 '(org-fontify-drawers)
6332 (list org-property-re
6333 '(1 'org-special-keyword t
)
6334 '(3 'org-property-value t
))
6336 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6337 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6338 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6339 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6340 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6341 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6342 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6344 (list org-any-target-regexp
'(0 'org-target t
))
6346 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6348 '(org-fontify-macros)
6349 '(org-hide-wide-columns (0 nil append
))
6351 (list (format org-heading-keyword-regexp-format
6353 '(2 (org-get-todo-face 2) t
))
6355 (if org-fontify-done-headline
6356 (list (format org-heading-keyword-regexp-format
6359 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6361 '(2 'org-headline-done t
))
6364 '(org-font-lock-add-priority-faces)
6366 '(org-font-lock-add-tag-faces)
6368 (if (and org-group-tags org-tag-groups-alist
)
6369 (list (concat org-outline-regexp-bol
".+\\(:"
6370 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6372 '(1 'org-tag-group prepend
)))
6374 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6375 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6376 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6377 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6378 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6381 (if (featurep 'xemacs
)
6382 '(org-do-emphasis-faces (0 nil append
))
6383 '(org-do-emphasis-faces)))
6385 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6386 1 'org-checkbox prepend
)
6387 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6388 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6389 (0 (org-get-checkbox-statistics-face) t
)))
6390 ;; Description list items
6391 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6392 1 'org-list-dt prepend
)
6393 ;; ARCHIVEd headings
6395 org-outline-regexp-bol
6396 "\\(.*:" org-archive-tag
":.*\\)")
6397 '(1 'org-archived prepend
))
6399 '(org-do-latex-and-related)
6400 '(org-fontify-entities)
6401 '(org-raise-scripts)
6403 '(org-activate-code (1 'org-code t
))
6406 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6409 '(9 'org-special-keyword t
))
6410 ;; Blocks and meta lines
6411 '(org-fontify-meta-lines-and-blocks))))
6412 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6413 (run-hooks 'org-font-lock-set-keywords-hook
)
6414 ;; Now set the full font-lock-keywords
6415 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6416 (org-set-local 'font-lock-defaults
6417 '(org-font-lock-keywords t nil nil backward-paragraph
))
6418 (kill-local-variable 'font-lock-keywords
) nil
))
6420 (defun org-toggle-pretty-entities ()
6421 "Toggle the composition display of entities as UTF8 characters."
6423 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6424 (org-restart-font-lock)
6425 (if org-pretty-entities
6426 (message "Entities are now displayed as UTF8 characters")
6429 (org-decompose-region (point-min) (point-max))
6430 (message "Entities are now displayed as plain text"))))
6432 (defvar org-custom-properties-overlays nil
6433 "List of overlays used for custom properties.")
6434 (make-variable-buffer-local 'org-custom-properties-overlays
)
6436 (defun org-toggle-custom-properties-visibility ()
6437 "Display or hide properties in `org-custom-properties'."
6439 (if org-custom-properties-overlays
6440 (progn (mapc #'delete-overlay org-custom-properties-overlays
)
6441 (setq org-custom-properties-overlays nil
))
6442 (when org-custom-properties
6443 (org-with-wide-buffer
6444 (goto-char (point-min))
6445 (let ((regexp (org-re-property (regexp-opt org-custom-properties
) t t
)))
6446 (while (re-search-forward regexp nil t
)
6447 (let ((end (cdr (save-match-data (org-get-property-block)))))
6448 (when (and end
(< (point) end
))
6449 ;; Hide first custom property in current drawer.
6450 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6451 (overlay-put o
'invisible t
)
6452 (overlay-put o
'org-custom-property t
)
6453 (push o org-custom-properties-overlays
))
6454 ;; Hide additional custom properties in the same drawer.
6455 (while (re-search-forward regexp end t
)
6456 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6457 (overlay-put o
'invisible t
)
6458 (overlay-put o
'org-custom-property t
)
6459 (push o org-custom-properties-overlays
)))))
6460 ;; Each entry is limited to a single property drawer.
6461 (outline-next-heading)))))))
6463 (defun org-fontify-entities (limit)
6464 "Find an entity to fontify."
6466 (when org-pretty-entities
6468 ;; "\_ "-family is left out on purpose. Only the first one,
6469 ;; i.e., "\_ ", could be fontified anyway, and it would be
6470 ;; confusing when adding a second white space character.
6471 (while (re-search-forward
6472 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6474 (if (and (not (org-at-comment-p))
6475 (setq ee
(org-entity-get (match-string 1)))
6476 (= (length (nth 6 ee
)) 1))
6478 ((end (if (equal (match-string 2) "{}")
6481 (add-text-properties
6482 (match-beginning 0) end
6483 (list 'font-lock-fontified t
))
6484 (compose-region (match-beginning 0) end
6490 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6491 "Fontify string S like in Org-mode."
6494 (let ((org-odd-levels-only odd-levels
))
6502 (defun org-get-level-face (n)
6503 "Get the right face for match N in font-lock matching of headlines."
6504 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6505 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6506 (if org-cycle-level-faces
6507 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6508 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6510 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6512 (t (if org-level-color-stars-only nil org-f
))))
6515 (defun org-get-todo-face (kwd)
6516 "Get the right face for a TODO keyword KWD.
6517 If KWD is a number, get the corresponding match group."
6518 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6519 (or (org-face-from-face-or-color
6520 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6521 (and (member kwd org-done-keywords
) 'org-done
)
6524 (defun org-face-from-face-or-color (context inherit face-or-color
)
6525 "Create a face list that inherits INHERIT, but sets the foreground color.
6526 When FACE-OR-COLOR is not a string, just return it."
6527 (if (stringp face-or-color
)
6528 (list :inherit inherit
6529 (cdr (assoc context org-faces-easy-properties
))
6533 (defun org-font-lock-add-tag-faces (limit)
6534 "Add the special tag faces."
6535 (when (and org-tag-faces org-tags-special-faces-re
)
6536 (while (re-search-forward org-tags-special-faces-re limit t
)
6537 (add-text-properties (match-beginning 1) (match-end 1)
6538 (list 'face
(org-get-tag-face 1)
6539 'font-lock-fontified t
))
6540 (backward-char 1))))
6542 (defun org-font-lock-add-priority-faces (limit)
6543 "Add the special priority faces."
6544 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
6545 (when (save-match-data (org-at-heading-p))
6546 (add-text-properties
6547 (match-beginning 0) (match-end 0)
6548 (list 'face
(or (org-face-from-face-or-color
6549 'priority
'org-priority
6550 (cdr (assoc (char-after (match-beginning 1))
6551 org-priority-faces
)))
6553 'font-lock-fontified t
)))))
6555 (defun org-get-tag-face (kwd)
6556 "Get the right face for a TODO keyword KWD.
6557 If KWD is a number, get the corresponding match group."
6558 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6559 (or (org-face-from-face-or-color
6560 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
6563 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
6564 "Remove fontification and activation overlays from links."
6565 (font-lock-default-unfontify-region beg end
)
6566 (let* ((buffer-undo-list t
)
6567 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6568 (inhibit-modification-hooks t
)
6569 deactivate-mark buffer-file-name buffer-file-truename
)
6570 (org-decompose-region beg end
)
6571 (remove-text-properties beg end
6572 '(mouse-face t keymap t org-linked-text t
6573 invisible t intangible t
6575 (org-remove-font-lock-display-properties beg end
)))
6577 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6578 ((raise 0.3) (height 0.7))
6581 "Display properties for showing superscripts and subscripts.")
6583 (defun org-remove-font-lock-display-properties (beg end
)
6584 "Remove specific display properties that have been added by font lock.
6585 The will remove the raise properties that are used to show superscripts
6589 (setq next
(next-single-property-change beg
'display nil end
)
6590 prop
(get-text-property beg
'display
))
6591 (if (member prop org-script-display
)
6592 (put-text-property beg next
'display nil
))
6595 (defun org-raise-scripts (limit)
6596 "Add raise properties to sub/superscripts."
6597 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
6598 (if (re-search-forward
6599 (if (eq org-use-sub-superscripts t
)
6600 org-match-substring-regexp
6601 org-match-substring-with-braces-regexp
)
6603 (let* ((pos (point)) table-p comment-p
6604 (mpos (match-beginning 3))
6605 (emph-p (get-text-property mpos
'org-emphasis
))
6606 (link-p (get-text-property mpos
'mouse-face
))
6607 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6608 (goto-char (point-at-bol))
6609 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
6610 comment-p
(org-looking-at-p "^[ \t]*#[ +]"))
6613 (if (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6614 (if (or comment-p emph-p link-p keyw-p
)
6616 (put-text-property (match-beginning 3) (match-end 0)
6618 (if (equal (char-after (match-beginning 2)) ?^
)
6619 (nth (if table-p
3 1) org-script-display
)
6620 (nth (if table-p
2 0) org-script-display
)))
6621 (add-text-properties (match-beginning 2) (match-end 2)
6623 'org-dwidth t
'org-dwidth-n
1))
6624 (if (and (eq (char-after (match-beginning 3)) ?
{)
6625 (eq (char-before (match-end 3)) ?
}))
6627 (add-text-properties
6628 (match-beginning 3) (1+ (match-beginning 3))
6629 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6630 (add-text-properties
6631 (1- (match-end 3)) (match-end 3)
6632 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
6635 ;;;; Visibility cycling, including org-goto and indirect buffer
6639 (defvar org-cycle-global-status nil
)
6640 (make-variable-buffer-local 'org-cycle-global-status
)
6641 (put 'org-cycle-global-status
'org-state t
)
6642 (defvar org-cycle-subtree-status nil
)
6643 (make-variable-buffer-local 'org-cycle-subtree-status
)
6644 (put 'org-cycle-subtree-status
'org-state t
)
6646 (defvar org-inlinetask-min-level
)
6648 (defun org-unlogged-message (&rest args
)
6649 "Display a message, but avoid logging it in the *Messages* buffer."
6650 (let ((message-log-max nil
))
6651 (apply 'message args
)))
6654 (defun org-cycle (&optional arg
)
6655 "TAB-action and visibility cycling for Org-mode.
6657 This is the command invoked in Org-mode by the TAB key. Its main purpose
6658 is outline visibility cycling, but it also invokes other actions
6659 in special contexts.
6661 - When this function is called with a prefix argument, rotate the entire
6662 buffer through 3 states (global cycling)
6663 1. OVERVIEW: Show only top-level headlines.
6664 2. CONTENTS: Show all headlines of all levels, but no body text.
6665 3. SHOW ALL: Show everything.
6666 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6667 determined by the variable `org-startup-folded', and by any VISIBILITY
6668 properties in the buffer.
6669 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6670 including any drawers.
6672 - When inside a table, re-align the table and move to the next field.
6674 - When point is at the beginning of a headline, rotate the subtree started
6675 by this line through 3 different states (local cycling)
6676 1. FOLDED: Only the main headline is shown.
6677 2. CHILDREN: The main headline and the direct children are shown.
6678 From this state, you can move to one of the children
6679 and zoom in further.
6680 3. SUBTREE: Show the entire subtree, including body text.
6681 If there is no subtree, switch directly from CHILDREN to FOLDED.
6683 - When point is at the beginning of an empty headline and the variable
6684 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6685 of the headline by demoting and promoting it to likely levels. This
6686 speeds up creation document structure by pressing TAB once or several
6687 times right after creating a new headline.
6689 - When there is a numeric prefix, go up to a heading with level ARG, do
6690 a `show-subtree' and return to the previous cursor position. If ARG
6691 is negative, go up that many levels.
6693 - When point is not at the beginning of a headline, execute the global
6694 binding for TAB, which is re-indenting the line. See the option
6695 `org-cycle-emulate-tab' for details.
6697 - Special case: if point is at the beginning of the buffer and there is
6698 no headline in line 1, this function will act as if called with prefix arg
6699 (C-u TAB, same as S-TAB) also when called without prefix arg.
6700 But only if also the variable `org-cycle-global-at-bob' is t."
6702 (org-load-modules-maybe)
6703 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6704 (and org-cycle-level-after-item
/entry-creation
6705 (or (org-cycle-level)
6706 (org-cycle-item-indentation))))
6708 (or org-cycle-max-level
6709 (and (boundp 'org-inlinetask-min-level
)
6710 org-inlinetask-min-level
6711 (1- org-inlinetask-min-level
))))
6712 (nstars (and limit-level
6713 (if org-odd-levels-only
6714 (and limit-level
(1- (* limit-level
2)))
6717 (if (not (derived-mode-p 'org-mode
))
6719 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6720 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6721 (not (looking-at org-outline-regexp
))))
6724 (delq 'org-optimize-window-after-visibility-change
6725 (copy-sequence org-cycle-hook
))
6729 (if (or bob-special
(equal arg
'(4)))
6730 ;; special case: use global cycling
6736 (setq last-command
'dummy
)
6737 (org-set-startup-visibility)
6738 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6742 (org-unlogged-message "Entire buffer visible, including drawers"))
6744 ;; Try cdlatex TAB completion
6745 ((org-try-cdlatex-tab))
6747 ;; Table: enter it or move to the next field.
6748 ((org-at-table-p 'any
)
6749 (if (org-at-table.el-p
)
6750 (message "Use C-c ' to edit table.el tables")
6751 (if arg
(org-table-edit-field t
)
6752 (org-table-justify-field-maybe)
6753 (call-interactively 'org-table-next-field
))))
6755 ((run-hook-with-args-until-success
6756 'org-tab-after-check-for-table-hook
))
6758 ;; Global cycling: delegate to `org-cycle-internal-global'.
6759 ((eq arg t
) (org-cycle-internal-global))
6761 ;; Drawers: delegate to `org-flag-drawer'.
6763 (beginning-of-line 1)
6764 (looking-at org-drawer-regexp
))
6765 (org-flag-drawer ; toggle block visibility
6766 (not (get-char-property (match-end 0) 'invisible
))))
6768 ;; Show-subtree, ARG levels up from here.
6771 (org-back-to-heading)
6772 (outline-up-heading (if (< arg
0) (- arg
)
6773 (- (funcall outline-level
) arg
)))
6774 (org-show-subtree)))
6776 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6777 ((and (featurep 'org-inlinetask
)
6778 (org-inlinetask-at-task-p)
6779 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6780 (org-inlinetask-toggle-visibility))
6782 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6783 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
6784 (save-excursion (move-beginning-of-line 1)
6785 (looking-at org-outline-regexp
)))
6786 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6787 (org-cycle-internal-local))
6789 ;; From there: TAB emulation and template completion.
6790 (buffer-read-only (org-back-to-heading))
6792 ((run-hook-with-args-until-success
6793 'org-tab-after-check-for-cycling-hook
))
6795 ((org-try-structure-completion))
6797 ((run-hook-with-args-until-success
6798 'org-tab-before-tab-emulation-hook
))
6800 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6802 (not (looking-at org-outline-regexp
))))
6803 (call-interactively (global-key-binding "\t")))
6805 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6806 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6807 (or (and (eq org-cycle-emulate-tab
'white
)
6808 (= (match-end 0) (point-at-eol)))
6809 (and (eq org-cycle-emulate-tab
'whitestart
)
6810 (>= (match-end 0) pos
))))
6812 (eq org-cycle-emulate-tab t
))
6813 (call-interactively (global-key-binding "\t")))
6816 (org-back-to-heading)
6819 (defun org-cycle-internal-global ()
6820 "Do the global cycling action."
6821 ;; Hack to avoid display of messages for .org attachments in Gnus
6822 (let ((ga (string-match "\\*fontification" (buffer-name))))
6824 ((and (eq last-command this-command
)
6825 (eq org-cycle-global-status
'overview
))
6826 ;; We just created the overview - now do table of contents
6827 ;; This can be slow in very large buffers, so indicate action
6828 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6829 (unless ga
(org-unlogged-message "CONTENTS..."))
6831 (unless ga
(org-unlogged-message "CONTENTS...done"))
6832 (setq org-cycle-global-status
'contents
)
6833 (run-hook-with-args 'org-cycle-hook
'contents
))
6835 ((and (eq last-command this-command
)
6836 (eq org-cycle-global-status
'contents
))
6837 ;; We just showed the table of contents - now show everything
6838 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6840 (unless ga
(org-unlogged-message "SHOW ALL"))
6841 (setq org-cycle-global-status
'all
)
6842 (run-hook-with-args 'org-cycle-hook
'all
))
6845 ;; Default action: go to overview
6846 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6848 (unless ga
(org-unlogged-message "OVERVIEW"))
6849 (setq org-cycle-global-status
'overview
)
6850 (run-hook-with-args 'org-cycle-hook
'overview
)))))
6852 (defvar org-called-with-limited-levels nil
6853 "Non-nil when `org-with-limited-levels' is currently active.")
6855 (defun org-cycle-internal-local ()
6856 "Do the local cycling action."
6857 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6858 ;; First, determine end of headline (EOH), end of subtree or item
6859 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6864 (setq struct
(org-list-struct))
6865 (setq eoh
(point-at-eol))
6866 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6867 (setq has-children
(org-list-has-child-p (point) struct
)))
6868 (org-back-to-heading)
6869 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6870 (setq eos
(save-excursion (org-end-of-subtree t t
)
6871 (when (bolp) (backward-char)) (point)))
6874 (let ((level (funcall outline-level
)))
6875 (outline-next-heading)
6876 (and (org-at-heading-p t
)
6877 (> (funcall outline-level
) level
))))
6879 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6880 ;; Determine end invisible part of buffer (EOL)
6881 (beginning-of-line 2)
6882 ;; XEmacs doesn't have `next-single-char-property-change'
6883 (if (featurep 'xemacs
)
6884 (while (and (not (eobp)) ;; this is like `next-line'
6885 (get-char-property (1- (point)) 'invisible
))
6886 (beginning-of-line 2))
6887 (while (and (not (eobp)) ;; this is like `next-line'
6888 (get-char-property (1- (point)) 'invisible
))
6889 (goto-char (next-single-char-property-change (point) 'invisible
))
6890 (and (eolp) (beginning-of-line 2))))
6892 ;; Find out what to do next and set `this-command'
6895 ;; Nothing is hidden behind this heading
6896 (unless (org-before-first-heading-p)
6897 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
6898 (org-unlogged-message "EMPTY ENTRY")
6899 (setq org-cycle-subtree-status nil
)
6902 (outline-next-heading)
6903 (if (outline-invisible-p) (org-flag-heading nil
))))
6904 ((and (or (>= eol eos
)
6905 (not (string-match "\\S-" (buffer-substring eol eos
))))
6907 (not (setq children-skipped
6908 org-cycle-skip-children-state-if-no-children
))))
6909 ;; Entire subtree is hidden in one line: children view
6910 (unless (org-before-first-heading-p)
6911 (run-hook-with-args 'org-pre-cycle-hook
'children
))
6913 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6915 (org-with-limited-levels (show-children))
6916 ;; FIXME: This slows down the func way too much.
6917 ;; How keep drawers hidden in subtree anyway?
6918 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6919 ;; (org-cycle-hide-drawers 'subtree))
6921 ;; Fold every list in subtree to top-level items.
6922 (when (eq org-cycle-include-plain-lists
'integrate
)
6924 (org-back-to-heading)
6925 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6926 (beginning-of-line 1)
6927 (let* ((struct (org-list-struct))
6928 (prevs (org-list-prevs-alist struct
))
6929 (end (org-list-get-bottom-point struct
)))
6930 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6931 (org-list-get-all-items (point) struct prevs
))
6932 (goto-char (if (< end eos
) end eos
)))))))
6933 (org-unlogged-message "CHILDREN")
6936 (outline-next-heading)
6937 (if (outline-invisible-p) (org-flag-heading nil
)))
6938 (setq org-cycle-subtree-status
'children
)
6939 (unless (org-before-first-heading-p)
6940 (run-hook-with-args 'org-cycle-hook
'children
)))
6941 ((or children-skipped
6942 (and (eq last-command this-command
)
6943 (eq org-cycle-subtree-status
'children
)))
6944 ;; We just showed the children, or no children are there,
6945 ;; now show everything.
6946 (unless (org-before-first-heading-p)
6947 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
6948 (outline-flag-region eoh eos nil
)
6949 (org-unlogged-message
6950 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6951 (setq org-cycle-subtree-status
'subtree
)
6952 (unless (org-before-first-heading-p)
6953 (run-hook-with-args 'org-cycle-hook
'subtree
)))
6955 ;; Default action: hide the subtree.
6956 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6957 (outline-flag-region eoh eos t
)
6958 (org-unlogged-message "FOLDED")
6959 (setq org-cycle-subtree-status
'folded
)
6960 (unless (org-before-first-heading-p)
6961 (run-hook-with-args 'org-cycle-hook
'folded
))))))
6964 (defun org-global-cycle (&optional arg
)
6965 "Cycle the global visibility. For details see `org-cycle'.
6966 With \\[universal-argument] prefix arg, switch to startup visibility.
6967 With a numeric prefix, show all headlines up to that level."
6969 (let ((org-cycle-include-plain-lists
6970 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
6974 (hide-sublevels arg
)
6975 (setq org-cycle-global-status
'contents
))
6977 (org-set-startup-visibility)
6978 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6980 (org-cycle '(4))))))
6982 (defun org-set-startup-visibility ()
6983 "Set the visibility required by startup options and properties."
6985 ((eq org-startup-folded t
)
6987 ((eq org-startup-folded
'content
)
6989 ((or (eq org-startup-folded
'showeverything
)
6990 (eq org-startup-folded nil
))
6992 (unless (eq org-startup-folded
'showeverything
)
6993 (if org-hide-block-startup
(org-hide-block-all))
6994 (org-set-visibility-according-to-property 'no-cleanup
)
6995 (org-cycle-hide-archived-subtrees 'all
)
6996 (org-cycle-hide-drawers 'all
)
6997 (org-cycle-show-empty-lines t
)))
6999 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
7000 "Switch subtree visibilities according to :VISIBILITY: property."
7002 (let (org-show-entry-below)
7003 (org-with-wide-buffer
7004 (goto-char (point-min))
7005 (while (re-search-forward "^[ \t]*:VISIBILITY:" nil t
)
7006 (if (not (org-at-property-p)) (outline-next-heading)
7007 (let ((state (match-string 3)))
7009 (org-back-to-heading t
)
7013 ((equal state
"folded")
7015 ((equal state
"children")
7016 (org-show-hidden-entry)
7018 ((equal state
"content")
7021 (org-narrow-to-subtree)
7023 ((member state
'("all" "showall"))
7024 (show-subtree)))))))
7026 (org-cycle-hide-archived-subtrees 'all
)
7027 (org-cycle-hide-drawers 'all
)
7028 (org-cycle-show-empty-lines 'all
)))))
7030 ;; This function uses outline-regexp instead of the more fundamental
7031 ;; org-outline-regexp so that org-cycle-global works outside of Org
7032 ;; buffers, where outline-regexp is needed.
7033 (defun org-overview ()
7034 "Switch to overview mode, showing only top-level headlines.
7035 This shows all headlines with a level equal or greater than the level
7036 of the first headline in the buffer. This is important, because if the
7037 first headline is not level one, then (hide-sublevels 1) gives confusing
7043 (goto-char (point-min))
7044 (if (re-search-forward (concat "^" outline-regexp
) nil t
)
7046 (goto-char (match-beginning 0))
7047 (funcall outline-level
))))))
7048 (and level
(hide-sublevels level
)))))
7050 (defun org-content (&optional arg
)
7051 "Show all headlines in the buffer, like a table of contents.
7052 With numerical argument N, show content up to level N."
7056 ;; Visit all headings and show their offspring
7057 (and (integerp arg
) (org-overview))
7058 (goto-char (point-max))
7060 (while (and (progn (condition-case nil
7061 (outline-previous-visible-heading 1)
7062 (error (goto-char (point-min))))
7064 (looking-at org-outline-regexp
))
7066 (show-children (1- arg
))
7068 (if (bobp) (throw 'exit nil
))))))
7070 (defun org-optimize-window-after-visibility-change (state)
7071 "Adjust the window after a change in outline visibility.
7072 This function is the default value of the hook `org-cycle-hook'."
7073 (when (get-buffer-window (current-buffer))
7075 ((eq state
'content
) nil
)
7076 ((eq state
'all
) nil
)
7077 ((eq state
'folded
) nil
)
7078 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7079 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7081 (defun org-remove-empty-overlays-at (pos)
7082 "Remove outline overlays that do not contain non-white stuff."
7085 (and (eq 'outline
(overlay-get o
'invisible
))
7086 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7088 (delete-overlay o
)))
7091 (defun org-clean-visibility-after-subtree-move ()
7092 "Fix visibility issues after moving a subtree."
7093 ;; First, find a reasonable region to look at:
7094 ;; Start two siblings above, end three below
7095 (let* ((beg (save-excursion
7096 (and (org-get-last-sibling)
7097 (org-get-last-sibling))
7099 (end (save-excursion
7100 (and (org-get-next-sibling)
7101 (org-get-next-sibling)
7102 (org-get-next-sibling))
7103 (if (org-at-heading-p)
7106 (level (looking-at "\\*+"))
7107 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
7110 (narrow-to-region beg end
)
7112 ;; Properly fold already folded siblings
7113 (goto-char (point-min))
7114 (while (re-search-forward re nil t
)
7115 (if (and (not (outline-invisible-p))
7117 (goto-char (point-at-eol)) (outline-invisible-p)))
7119 (org-cycle-show-empty-lines 'overview
)
7120 (org-cycle-hide-drawers 'overview
)))))
7122 (defun org-cycle-show-empty-lines (state)
7123 "Show empty lines above all visible headlines.
7124 The region to be covered depends on STATE when called through
7125 `org-cycle-hook'. Lisp program can use t for STATE to get the
7126 entire buffer covered. Note that an empty line is only shown if there
7127 are at least `org-cycle-separator-lines' empty lines before the headline."
7128 (when (not (= org-cycle-separator-lines
0))
7130 (let* ((n (abs org-cycle-separator-lines
))
7132 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7133 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7134 (t (let ((ns (number-to-string (- n
2))))
7135 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7136 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7139 ((memq state
'(overview contents t
))
7140 (setq beg
(point-min) end
(point-max)))
7141 ((memq state
'(children folded
))
7142 (setq beg
(point) end
(progn (org-end-of-subtree t t
)
7143 (beginning-of-line 2)
7147 (while (re-search-forward re end t
)
7148 (unless (get-char-property (match-end 1) 'invisible
)
7149 (setq e
(match-end 1))
7150 (if (< org-cycle-separator-lines
0)
7151 (setq b
(save-excursion
7152 (goto-char (match-beginning 0))
7153 (org-back-over-empty-lines)
7155 (goto-char (max (point-min) (1- (point))))
7159 (setq b
(match-beginning 1)))
7160 (outline-flag-region b e nil
)))))))
7161 ;; Never hide empty lines at the end of the file.
7163 (goto-char (point-max))
7164 (outline-previous-heading)
7165 (outline-end-of-heading)
7166 (if (and (looking-at "[ \t\n]+")
7167 (= (match-end 0) (point-max)))
7168 (outline-flag-region (point) (match-end 0) nil
))))
7170 (defun org-show-empty-lines-in-parent ()
7171 "Move to the parent and re-show empty lines before visible headlines."
7173 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
7174 (org-cycle-show-empty-lines context
))))
7176 (defun org-files-list ()
7177 "Return `org-agenda-files' list, plus all open org-mode files.
7178 This is useful for operations that need to scan all of a user's
7179 open and agenda-wise Org files."
7180 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
7181 (dolist (buf (buffer-list))
7182 (with-current-buffer buf
7183 (if (and (derived-mode-p 'org-mode
) (buffer-file-name))
7184 (let ((file (expand-file-name (buffer-file-name))))
7185 (unless (member file files
)
7186 (push file files
))))))
7189 (defsubst org-entry-beginning-position
()
7190 "Return the beginning position of the current entry."
7191 (save-excursion (outline-back-to-heading t
) (point)))
7193 (defsubst org-entry-end-position
()
7194 "Return the end position of the current entry."
7195 (save-excursion (outline-next-heading) (point)))
7197 (defun org-cycle-hide-drawers (state &optional exceptions
)
7198 "Re-hide all drawers after a visibility state change.
7199 When non-nil, optional argument EXCEPTIONS is a list of strings
7200 specifying which drawers should not be hidden."
7201 (when (and (derived-mode-p 'org-mode
)
7202 (not (memq state
'(overview folded contents
))))
7204 (let* ((globalp (memq state
'(contents all
)))
7205 (beg (if globalp
(point-min) (point)))
7206 (end (if globalp
(point-max)
7207 (if (eq state
'children
)
7208 (save-excursion (outline-next-heading) (point))
7209 (org-end-of-subtree t
)))))
7211 (while (re-search-forward org-drawer-regexp
(max end
(point)) t
)
7212 (unless (member-ignore-case (match-string 1) exceptions
)
7213 (let ((drawer (org-element-at-point)))
7214 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7215 (org-flag-drawer t drawer
)
7216 ;; Make sure to skip drawer entirely or we might flag
7217 ;; it another time when matching its ending line with
7218 ;; `org-drawer-regexp'.
7219 (goto-char (org-element-property :end drawer
))))))))))
7221 (defun org-flag-drawer (flag &optional element
)
7222 "When FLAG is non-nil, hide the drawer we are at.
7223 Otherwise make it visible. When optional argument ELEMENT is
7224 a parsed drawer, as returned by `org-element-at-point', hide or
7225 show that drawer instead."
7226 (when (save-excursion
7228 (org-looking-at-p org-drawer-regexp
))
7229 (let ((drawer (or element
(org-element-at-point))))
7230 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7231 (let ((post (org-element-property :post-affiliated drawer
)))
7233 (outline-flag-region
7234 (progn (goto-char post
) (line-end-position))
7235 (progn (goto-char (org-element-property :end drawer
))
7236 (skip-chars-backward " \r\t\n")
7237 (line-end-position))
7239 ;; When the drawer is hidden away, make sure point lies in
7240 ;; a visible part of the buffer.
7241 (when (and flag
(> (line-beginning-position) post
))
7242 (goto-char post
)))))))
7244 (defun org-subtree-end-visible-p ()
7245 "Is the end of the current subtree visible?"
7246 (pos-visible-in-window-p
7247 (save-excursion (org-end-of-subtree t
) (point))))
7249 (defun org-first-headline-recenter ()
7250 "Move cursor to the first headline and recenter the headline."
7251 (goto-char (point-min))
7252 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7253 (set-window-start (selected-window) (point-at-bol))))
7255 ;;; Saving and restoring visibility
7257 (defun org-outline-overlay-data (&optional use-markers
)
7258 "Return a list of the locations of all outline overlays.
7259 These are overlays with the `invisible' property value `outline'.
7260 The return value is a list of cons cells, with start and stop
7261 positions for each overlay.
7262 If USE-MARKERS is set, return the positions as markers."
7269 (when (eq (overlay-get o
'invisible
) 'outline
)
7270 (setq beg
(overlay-start o
)
7271 end
(overlay-end o
))
7272 (and beg end
(> end beg
)
7274 (cons (copy-marker beg
)
7275 (copy-marker end t
))
7277 (overlays-in (point-min) (point-max))))))))
7279 (defun org-set-outline-overlay-data (data)
7280 "Create visibility overlays for all positions in DATA.
7281 DATA should have been made by `org-outline-overlay-data'."
7288 (outline-flag-region (car c
) (cdr c
) t
))
7291 ;;; Folding of blocks
7293 (defvar org-hide-block-overlays nil
7294 "Overlays hiding blocks.")
7295 (make-variable-buffer-local 'org-hide-block-overlays
)
7297 (defun org-block-map (function &optional start end
)
7298 "Call FUNCTION at the head of all source blocks in the current buffer.
7299 Optional arguments START and END can be used to limit the range."
7300 (let ((start (or start
(point-min)))
7301 (end (or end
(point-max))))
7304 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7307 (goto-char (match-beginning 0))
7308 (funcall function
)))))))
7310 (defun org-hide-block-toggle-all ()
7311 "Toggle the visibility of all blocks in the current buffer."
7312 (org-block-map 'org-hide-block-toggle
))
7314 (defun org-hide-block-all ()
7315 "Fold all blocks in the current buffer."
7317 (org-show-block-all)
7318 (org-block-map 'org-hide-block-toggle-maybe
))
7320 (defun org-show-block-all ()
7321 "Unfold all blocks in the current buffer."
7323 (mapc 'delete-overlay org-hide-block-overlays
)
7324 (setq org-hide-block-overlays nil
))
7326 (defun org-hide-block-toggle-maybe ()
7327 "Toggle visibility of block at point.
7328 Unlike to `org-hide-block-toggle', this function does not throw
7329 an error. Return a non-nil value when toggling is successful."
7331 (ignore-errors (org-hide-block-toggle)))
7333 (defun org-hide-block-toggle (&optional force
)
7334 "Toggle the visibility of the current block.
7335 When optional argument FORCE is `off', make block visible. If it
7336 is non-nil, hide it unconditionally. Throw an error when not at
7337 a block. Return a non-nil value when toggling is successful."
7339 (let ((element (org-element-at-point)))
7340 (unless (memq (org-element-type element
)
7341 '(center-block comment-block dynamic-block example-block
7342 export-block quote-block special-block
7343 src-block verse-block
))
7344 (user-error "Not at a block"))
7345 (let* ((start (save-excursion
7346 (goto-char (org-element-property :post-affiliated element
))
7347 (line-end-position)))
7348 (end (save-excursion
7349 (goto-char (org-element-property :end element
))
7350 (skip-chars-backward " \r\t\n")
7351 (line-end-position)))
7352 (overlays (overlays-at start
)))
7354 ;; Do nothing when not before or at the block opening line or
7355 ;; at the block closing line.
7356 ((let ((eol (line-end-position))) (and (> eol start
) (/= eol end
))) nil
)
7357 ((and (not (eq force
'off
))
7358 (not (memq t
(mapcar
7360 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7362 (let ((ov (make-overlay start end
)))
7363 (overlay-put ov
'invisible
'org-hide-block
)
7364 ;; Make the block accessible to `isearch'.
7366 ov
'isearch-open-invisible
7368 (when (memq ov org-hide-block-overlays
)
7369 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7370 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7371 (delete-overlay ov
))))
7372 (push ov org-hide-block-overlays
)
7373 ;; When the block is hidden away, make sure point is left in
7374 ;; a visible part of the buffer.
7375 (when (> (line-beginning-position) start
)
7377 (beginning-of-line))
7378 ;; Signal successful toggling.
7380 ((or (not force
) (eq force
'off
))
7381 (dolist (ov overlays t
)
7382 (when (memq ov org-hide-block-overlays
)
7383 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7384 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7385 (delete-overlay ov
))))))))
7387 ;; org-tab-after-check-for-cycling-hook
7388 (add-hook 'org-tab-first-hook
'org-hide-block-toggle-maybe
)
7389 ;; Remove overlays when changing major mode
7390 (add-hook 'org-mode-hook
7391 (lambda () (org-add-hook 'change-major-mode-hook
7392 'org-show-block-all
'append
'local
)))
7396 (defvar org-goto-window-configuration nil
)
7397 (defvar org-goto-marker nil
)
7398 (defvar org-goto-map
)
7399 (defun org-goto-map ()
7400 "Set the keymap `org-goto'."
7402 (let ((map (make-sparse-keymap)))
7403 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7404 mouse-drag-region universal-argument org-occur
))
7406 (while (setq cmd
(pop cmds
))
7407 (substitute-key-definition cmd cmd map global-map
)))
7408 (suppress-keymap map
)
7409 (org-defkey map
"\C-m" 'org-goto-ret
)
7410 (org-defkey map
[(return)] 'org-goto-ret
)
7411 (org-defkey map
[(left)] 'org-goto-left
)
7412 (org-defkey map
[(right)] 'org-goto-right
)
7413 (org-defkey map
[(control ?g
)] 'org-goto-quit
)
7414 (org-defkey map
"\C-i" 'org-cycle
)
7415 (org-defkey map
[(tab)] 'org-cycle
)
7416 (org-defkey map
[(down)] 'outline-next-visible-heading
)
7417 (org-defkey map
[(up)] 'outline-previous-visible-heading
)
7418 (if org-goto-auto-isearch
7419 (if (fboundp 'define-key-after
)
7420 (define-key-after map
[t] 'org-goto-local-auto-isearch)
7422 (org-defkey map "q" 'org-goto-quit)
7423 (org-defkey map "n" 'outline-next-visible-heading)
7424 (org-defkey map "p" 'outline-previous-visible-heading)
7425 (org-defkey map "f" 'outline-forward-same-level)
7426 (org-defkey map "b" 'outline-backward-same-level)
7427 (org-defkey map "u" 'outline-up-heading))
7428 (org-defkey map "/" 'org-occur)
7429 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7430 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7431 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7432 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7433 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7436 (defconst org-goto-help
7437 "Browse buffer copy, to find location or copy text.%s
7438 RET=jump to location C-g=quit and return to previous location
7439 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7441 (defvar org-goto-start-pos) ; dynamically scoped parameter
7443 (defun org-goto (&optional alternative-interface)
7444 "Look up a different location in the current file, keeping current visibility.
7446 When you want look-up or go to a different location in a
7447 document, the fastest way is often to fold the entire buffer and
7448 then dive into the tree. This method has the disadvantage, that
7449 the previous location will be folded, which may not be what you
7452 This command works around this by showing a copy of the current
7453 buffer in an indirect buffer, in overview mode. You can dive
7454 into the tree in that copy, use org-occur and incremental search
7455 to find a location. When pressing RET or `Q', the command
7456 returns to the original buffer in which the visibility is still
7457 unchanged. After RET it will also jump to the location selected
7458 in the indirect buffer and expose the headline hierarchy above.
7460 With a prefix argument, use the alternative interface: e.g. if
7461 `org-goto-interface' is 'outline use 'outline-path-completion."
7464 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7465 (org-refile-use-outline-path t)
7466 (org-refile-target-verify-function nil)
7468 (if (not alternative-interface)
7470 (if (eq org-goto-interface 'outline)
7471 'outline-path-completion
7473 (org-goto-start-pos (point))
7475 (if (eq interface 'outline)
7476 (car (org-get-location (current-buffer) org-goto-help))
7477 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7478 (org-refile-check-position pa)
7482 (org-mark-ring-push org-goto-start-pos)
7483 (goto-char selected-point)
7484 (if (or (outline-invisible-p) (org-invisible-p2))
7485 (org-show-context 'org-goto)))
7488 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7489 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7490 (defvar org-goto-local-auto-isearch-map) ; defined below
7492 (defun org-get-location (buf help)
7493 "Let the user select a location in the Org-mode buffer BUF.
7494 This function uses a recursive edit. It returns the selected position
7497 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7498 (isearch-hide-immediately nil)
7499 (isearch-search-fun-function
7500 (lambda () 'org-goto-local-search-headings))
7501 (org-goto-selected-point org-goto-exit-command))
7503 (save-window-excursion
7504 (delete-other-windows)
7505 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7506 (org-pop-to-buffer-same-window
7508 (make-indirect-buffer (current-buffer) "*org-goto*")
7509 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7510 (with-output-to-temp-buffer "*Org Help*"
7511 (princ (format help (if org-goto-auto-isearch
7512 " Just type for auto-isearch."
7513 " n/p/f/b/u to navigate, q to quit."))))
7514 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7515 (setq buffer-read-only nil)
7516 (let ((org-startup-truncated t)
7517 (org-startup-folded nil)
7518 (org-startup-align-all-tables nil))
7521 (setq buffer-read-only t)
7522 (if (and (boundp 'org-goto-start-pos)
7523 (integer-or-marker-p org-goto-start-pos))
7524 (progn (goto-char org-goto-start-pos)
7525 (when (outline-invisible-p)
7526 (org-show-set-visibility 'lineage)))
7527 (goto-char (point-min)))
7528 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7529 (message "Select location and press RET")
7530 (use-local-map org-goto-map)
7532 (kill-buffer "*org-goto*")
7533 (cons org-goto-selected-point org-goto-exit-command))))
7535 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7536 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7537 ;; `isearch-other-control-char' was removed in Emacs 24.4.
7538 (if (fboundp 'isearch-other-control-char)
7540 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7541 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char))
7542 (define-key org-goto-local-auto-isearch-map "\C-i" nil)
7543 (define-key org-goto-local-auto-isearch-map "\C-m" nil)
7544 (define-key org-goto-local-auto-isearch-map [return] nil))
7546 (defun org-goto-local-search-headings (string bound noerror)
7547 "Search and make sure that any matches are in headlines."
7549 (while (if isearch-forward
7550 (search-forward string bound noerror)
7551 (search-backward string bound noerror))
7552 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7553 (and (member :headline context)
7554 (not (member :tags context))))
7555 (throw 'return (point))))))
7557 (defun org-goto-local-auto-isearch ()
7560 (goto-char (point-min))
7561 (let ((keys (this-command-keys)))
7562 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7564 (isearch-process-search-char (string-to-char keys)))))
7566 (defun org-goto-ret (&optional arg)
7567 "Finish `org-goto' by going to the new location."
7569 (setq org-goto-selected-point (point)
7570 org-goto-exit-command 'return)
7573 (defun org-goto-left ()
7574 "Finish `org-goto' by going to the new location."
7576 (if (org-at-heading-p)
7578 (beginning-of-line 1)
7579 (setq org-goto-selected-point (point)
7580 org-goto-exit-command 'left)
7582 (user-error "Not on a heading")))
7584 (defun org-goto-right ()
7585 "Finish `org-goto' by going to the new location."
7587 (if (org-at-heading-p)
7589 (setq org-goto-selected-point (point)
7590 org-goto-exit-command 'right)
7592 (user-error "Not on a heading")))
7594 (defun org-goto-quit ()
7595 "Finish `org-goto' without cursor motion."
7597 (setq org-goto-selected-point nil)
7598 (setq org-goto-exit-command 'quit)
7601 ;;; Indirect buffer display of subtrees
7603 (defvar org-indirect-dedicated-frame nil
7604 "This is the frame being used for indirect tree display.")
7605 (defvar org-last-indirect-buffer nil)
7607 (defun org-tree-to-indirect-buffer (&optional arg)
7608 "Create indirect buffer and narrow it to current subtree.
7609 With a numerical prefix ARG, go up to this level and then take that tree.
7610 If ARG is negative, go up that many levels.
7612 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7613 indirect buffer previously made with this command, to avoid proliferation of
7614 indirect buffers. However, when you call the command with a \
7615 \\[universal-argument] prefix, or
7616 when `org-indirect-buffer-display' is `new-frame', the last buffer
7617 is kept so that you can work with several indirect buffers at the same time.
7618 If `org-indirect-buffer-display' is `dedicated-frame', the \
7619 \\[universal-argument] prefix also
7620 requests that a new frame be made for the new buffer, so that the dedicated
7621 frame is not changed."
7623 (let ((cbuf (current-buffer))
7624 (cwin (selected-window))
7626 beg end level heading ibuf)
7628 (org-back-to-heading t)
7630 (setq level (org-outline-level))
7631 (if (< arg 0) (setq arg (+ level arg)))
7632 (while (> (setq level (org-outline-level)) arg)
7633 (org-up-heading-safe)))
7635 heading (org-get-heading))
7636 (org-end-of-subtree t t)
7637 (if (org-at-heading-p) (backward-char 1))
7639 (if (and (buffer-live-p org-last-indirect-buffer)
7640 (not (eq org-indirect-buffer-display 'new-frame))
7642 (kill-buffer org-last-indirect-buffer))
7643 (setq ibuf (org-get-indirect-buffer cbuf heading)
7644 org-last-indirect-buffer ibuf)
7646 ((or (eq org-indirect-buffer-display 'new-frame)
7647 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7648 (select-frame (make-frame))
7649 (delete-other-windows)
7650 (org-pop-to-buffer-same-window ibuf)
7651 (org-set-frame-title heading))
7652 ((eq org-indirect-buffer-display 'dedicated-frame)
7654 (select-frame (or (and org-indirect-dedicated-frame
7655 (frame-live-p org-indirect-dedicated-frame)
7656 org-indirect-dedicated-frame)
7657 (setq org-indirect-dedicated-frame (make-frame)))))
7658 (delete-other-windows)
7659 (org-pop-to-buffer-same-window ibuf)
7660 (org-set-frame-title (concat "Indirect: " heading)))
7661 ((eq org-indirect-buffer-display 'current-window)
7662 (org-pop-to-buffer-same-window ibuf))
7663 ((eq org-indirect-buffer-display 'other-window)
7664 (pop-to-buffer ibuf))
7665 (t (error "Invalid value")))
7666 (if (featurep 'xemacs)
7667 (save-excursion (org-mode) (turn-on-font-lock)))
7668 (narrow-to-region beg end)
7671 (run-hook-with-args 'org-cycle-hook 'all)
7672 (and (window-live-p cwin) (select-window cwin))))
7674 (defun org-get-indirect-buffer (&optional buffer heading)
7675 (setq buffer (or buffer (current-buffer)))
7676 (let ((n 1) (base (buffer-name buffer)) bname)
7677 (while (buffer-live-p
7681 (if heading (concat heading "-" (number-to-string n))
7682 (number-to-string n))))))
7685 (make-indirect-buffer buffer bname 'clone)
7686 (error (make-indirect-buffer buffer bname)))))
7688 (defun org-set-frame-title (title)
7689 "Set the title of the current frame to the string TITLE."
7690 ;; FIXME: how to name a single frame in XEmacs???
7691 (unless (featurep 'xemacs)
7692 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7694 ;;;; Structure editing
7696 ;;; Inserting headlines
7698 (defun org-previous-line-empty-p (&optional next)
7699 "Is the previous line a blank line?
7700 When NEXT is non-nil, check the next line instead."
7703 (or (beginning-of-line (if next 2 0)) t)
7705 (looking-at "[ \t]*$")))))
7707 (defun org-insert-heading (&optional arg invisible-ok top-level)
7708 "Insert a new heading or an item with the same depth at point.
7710 If point is at the beginning of a heading or a list item, insert
7711 a new heading or a new item above the current one. If point is
7712 at the beginning of a normal line, turn the line into a heading.
7714 If point is in the middle of a headline or a list item, split the
7715 headline or the item and create a new headline/item with the text
7716 in the current line after point \(see `org-M-RET-may-split-line'
7717 on how to modify this behavior).
7719 With one universal prefix argument, set the user option
7720 `org-insert-heading-respect-content' to t for the duration of
7721 the command. This modifies the behavior described above in this
7722 ways: on list items and at the beginning of normal lines, force
7723 the insertion of a heading after the current subtree.
7725 With two universal prefix arguments, insert the heading at the
7726 end of the grandparent subtree. For example, if point is within
7727 a 2nd-level heading, then it will insert a 2nd-level heading at
7728 the end of the 1st-level parent heading.
7730 If point is at the beginning of a headline, insert a sibling
7731 before the current headline. If point is not at the beginning,
7732 split the line and create a new headline with the text in the
7733 current line after point \(see `org-M-RET-may-split-line' on how
7734 to modify this behavior).
7736 If point is at the beginning of a normal line, turn this line
7739 When INVISIBLE-OK is set, stop at invisible headlines when going
7740 back. This is important for non-interactive uses of the
7743 When optional argument TOP-LEVEL is non-nil, insert a level 1
7744 heading, unconditionally."
7746 (if (org-called-interactively-p 'any) (org-reveal))
7747 (let ((itemp (and (not top-level) (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 ""))
7755 ((or (= (buffer-size) 0)
7756 (and (not (save-excursion
7757 (and (ignore-errors (org-back-to-heading invisible-ok))
7758 (org-at-heading-p))))
7759 (or arg (not itemp))))
7760 ;; At beginning of buffer or so high up that only a heading
7762 (cond ((and (bolp) (not respect-content)) (insert "* "))
7763 ((not respect-content)
7764 (unless may-split (end-of-line))
7766 ((re-search-forward org-outline-regexp-bol nil t)
7770 (t (goto-char (point-max))
7772 (run-hooks 'org-insert-heading-hook))
7774 ((and itemp (not (member arg '((4) (16)))) (org-insert-item)))
7777 ;; Maybe move at the end of the subtree
7778 (when (equal arg '(16))
7779 (org-up-heading-safe)
7780 (org-end-of-subtree t))
7785 (on-heading (org-at-heading-p))
7786 (empty-line-p (if on-heading
7787 (org-previous-line-empty-p)
7788 ;; We will decide later
7790 ;; Get a level string to fall back on.
7792 (if (org-before-first-heading-p) "*"
7794 (org-back-to-heading t)
7795 (if (org-previous-line-empty-p) (setq empty-line-p t))
7796 (looking-at org-outline-regexp)
7797 (make-string (1- (length (match-string 0))) ?*))))
7802 (org-back-to-heading invisible-ok)
7803 (when (and (not on-heading)
7804 (featurep 'org-inlinetask)
7805 (integerp org-inlinetask-min-level)
7806 (>= (length (match-string 0))
7807 org-inlinetask-min-level))
7808 ;; Find a heading level before the inline
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
7831 (when (and respect-content
7832 (not (org-looking-at-p org-outline-regexp-bol)))
7833 (if (not (org-before-first-heading-p))
7834 (org-end-of-subtree nil t)
7835 (re-search-forward org-outline-regexp-bol)
7836 (beginning-of-line 0))
7837 (skip-chars-backward " \r\t\n")
7838 (and (not (looking-back "^\\*+"))
7839 (looking-at "[ \t]+") (replace-match ""))
7840 (unless (eobp) (forward-char 1))
7841 (when (looking-at "^\\*")
7842 (unless (bobp) (backward-char 1))
7845 ;; If we are splitting, grab the text that should be moved
7846 ;; to the new headline.
7848 (if (org-on-heading-p)
7849 ;; This is a heading: split intelligently (keeping
7851 (let ((pos (point)))
7853 (unless (looking-at org-complex-heading-regexp)
7854 (error "This should not happen"))
7855 (when (and (match-beginning 4)
7856 (> pos (match-beginning 4))
7857 (< pos (match-end 4)))
7858 (setq initial-content (buffer-substring pos (match-end 4)))
7860 (delete-region (point) (match-end 4))
7861 (if (looking-at "[ \t]*$")
7863 (insert (make-string (length initial-content) ?\s)))
7864 (setq initial-content (org-trim initial-content)))
7867 (setq initial-content
7869 (delete-and-extract-region (point) (line-end-position))))))
7871 ;; If we are at the beginning of the line, insert before it.
7872 ;; Otherwise, after it.
7874 ((and (bolp) (looking-at "[ \t]*$")))
7875 ((bolp) (save-excursion (insert "\n")))
7879 ;; Insert the new heading
7882 (insert initial-content)
7883 (unless (and blank (org-previous-line-empty-p))
7884 (org-N-empty-lines-before-current (if blank 1 0)))
7885 ;; Adjust visibility, which may be messed up if we removed
7886 ;; blank lines while previous entry was hidden.
7887 (let ((bol (line-beginning-position)))
7888 (dolist (o (overlays-at (1- bol)))
7889 (when (and (eq (overlay-get o 'invisible) 'outline)
7890 (eq (overlay-end o) bol))
7891 (move-overlay o (overlay-start o) (1- bol)))))
7892 (run-hooks 'org-insert-heading-hook)))))))
7894 (defun org-N-empty-lines-before-current (N)
7895 "Make the number of empty lines before current exactly N.
7896 So this will delete or add empty lines."
7900 (skip-chars-backward " \r\t\n")
7901 (unless (bolp) (forward-line))
7902 (delete-region (point) p))
7903 (when (> N 0) (insert (make-string N ?\n)))))
7905 (defun org-get-heading (&optional no-tags no-todo)
7906 "Return the heading of the current entry, without the stars.
7907 When NO-TAGS is non-nil, don't include tags.
7908 When NO-TODO is non-nil, don't include TODO keywords."
7910 (org-back-to-heading t)
7912 ((and no-tags no-todo)
7913 (looking-at org-complex-heading-regexp)
7916 (looking-at (concat org-outline-regexp
7918 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7921 (looking-at org-todo-line-regexp)
7923 (t (looking-at org-heading-regexp)
7924 (match-string 2)))))
7926 (defvar orgstruct-mode) ; defined below
7928 (defun org-heading-components ()
7929 "Return the components of the current heading.
7930 This is a list with the following elements:
7931 - the level as an integer
7932 - the reduced level, different if `org-odd-levels-only' is set.
7933 - the TODO keyword, or nil
7934 - the priority character, like ?A, or nil if no priority is given
7935 - the headline text itself, or the tags string if no headline text
7936 - the tags string, or nil."
7938 (org-back-to-heading t)
7939 (if (let (case-fold-search)
7943 org-complex-heading-regexp)))
7945 (list (length (match-string 1))
7946 (org-reduced-level (length (match-string 1)))
7951 (list (length (match-string 1))
7952 (org-reduced-level (length (match-string 1)))
7953 (org-match-string-no-properties 2)
7954 (and (match-end 3) (aref (match-string 3) 2))
7955 (org-match-string-no-properties 4)
7956 (org-match-string-no-properties 5))))))
7958 (defun org-get-entry ()
7959 "Get the entry text, after heading, entire subtree."
7961 (org-back-to-heading t)
7962 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7964 (defun org-insert-heading-after-current ()
7965 "Insert a new heading with same level as current, after current subtree."
7967 (org-back-to-heading)
7968 (org-insert-heading)
7969 (org-move-subtree-down)
7972 (defun org-insert-heading-respect-content (&optional invisible-ok)
7973 "Insert heading with `org-insert-heading-respect-content' set to t."
7975 (org-insert-heading '(4) invisible-ok))
7977 (defun org-insert-todo-heading-respect-content (&optional force-state)
7978 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7980 (org-insert-todo-heading force-state '(4)))
7982 (defun org-insert-todo-heading (arg &optional force-heading)
7983 "Insert a new heading with the same level and TODO state as current heading.
7984 If the heading has no TODO state, or if the state is DONE, use the first
7985 state (TODO by default). Also with one prefix arg, force first state. With
7986 two prefix args, force inserting at the end of the parent subtree."
7988 (when (or force-heading (not (org-insert-item 'checkbox)))
7989 (org-insert-heading (or (and (equal arg '(16)) '(16))
7992 (org-back-to-heading)
7993 (outline-previous-heading)
7994 (looking-at org-todo-line-regexp))
7997 (if (or (equal arg '(4))
7998 (not (match-beginning 2))
7999 (member (match-string 2) org-done-keywords))
8000 (car org-todo-keywords-1)
8004 (run-hook-with-args-until-success
8005 'org-todo-get-default-hook new-mark-x nil)
8007 (beginning-of-line 1)
8008 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
8009 (if org-treat-insert-todo-heading-as-state-change
8011 (insert new-mark " "))))
8012 (when org-provide-todo-statistics
8013 (org-update-parent-todo-statistics))))
8015 (defun org-insert-subheading (arg)
8016 "Insert a new subheading and demote it.
8017 Works for outline headings and for plain lists alike."
8019 (org-insert-heading arg)
8021 ((org-at-heading-p) (org-do-demote))
8022 ((org-at-item-p) (org-indent-item))))
8024 (defun org-insert-todo-subheading (arg)
8025 "Insert a new subheading with TODO keyword or checkbox and demote it.
8026 Works for outline headings and for plain lists alike."
8028 (org-insert-todo-heading arg)
8030 ((org-at-heading-p) (org-do-demote))
8031 ((org-at-item-p) (org-indent-item))))
8033 ;;; Promotion and Demotion
8035 (defvar org-after-demote-entry-hook nil
8036 "Hook run after an entry has been demoted.
8037 The cursor will be at the beginning of the entry.
8038 When a subtree is being demoted, the hook will be called for each node.")
8040 (defvar org-after-promote-entry-hook nil
8041 "Hook run after an entry has been promoted.
8042 The cursor will be at the beginning of the entry.
8043 When a subtree is being promoted, the hook will be called for each node.")
8045 (defun org-promote-subtree ()
8046 "Promote the entire subtree.
8047 See also `org-promote'."
8050 (org-with-limited-levels (org-map-tree 'org-promote)))
8051 (org-fix-position-after-promote))
8053 (defun org-demote-subtree ()
8054 "Demote the entire subtree. See `org-demote'.
8055 See also `org-promote'."
8058 (org-with-limited-levels (org-map-tree 'org-demote)))
8059 (org-fix-position-after-promote))
8062 (defun org-do-promote ()
8063 "Promote the current heading higher up the tree.
8064 If the region is active in `transient-mark-mode', promote all headings
8068 (if (org-region-active-p)
8069 (org-map-region 'org-promote (region-beginning) (region-end))
8071 (org-fix-position-after-promote))
8073 (defun org-do-demote ()
8074 "Demote the current heading lower down the tree.
8075 If the region is active in `transient-mark-mode', demote all headings
8079 (if (org-region-active-p)
8080 (org-map-region 'org-demote (region-beginning) (region-end))
8082 (org-fix-position-after-promote))
8084 (defun org-fix-position-after-promote ()
8085 "Make sure that after pro/demotion cursor position is right."
8086 (let ((pos (point)))
8087 (when (save-excursion
8088 (beginning-of-line 1)
8089 (looking-at org-todo-line-regexp)
8090 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8091 (cond ((eobp) (insert " "))
8092 ((eolp) (insert " "))
8093 ((equal (char-after) ?\ ) (forward-char 1))))))
8095 (defun org-current-level ()
8096 "Return the level of the current entry, or nil if before the first headline.
8097 The level is the number of stars at the beginning of the
8098 headline. Use `org-reduced-level' to remove the effect of
8099 `org-odd-levels'. Unlike to `org-outline-level', this function
8100 ignores inlinetasks."
8101 (let ((level (org-with-limited-levels (org-outline-level))))
8102 (and (> level 0) level)))
8104 (defun org-get-previous-line-level ()
8105 "Return the outline depth of the last headline before the current line.
8106 Returns 0 for the first headline in the buffer, and nil if before the
8108 (and (org-current-level)
8109 (or (and (/= (line-beginning-position) (point-min))
8110 (save-excursion (beginning-of-line 0) (org-current-level)))
8113 (defun org-reduced-level (l)
8114 "Compute the effective level of a heading.
8115 This takes into account the setting of `org-odd-levels-only'."
8118 (org-odd-levels-only (1+ (floor (/ l 2))))
8121 (defun org-level-increment ()
8122 "Return the number of stars that will be added or removed at a
8123 time to headlines when structure editing, based on the value of
8124 `org-odd-levels-only'."
8125 (if org-odd-levels-only 2 1))
8127 (defun org-get-valid-level (level &optional change)
8128 "Rectify a level change under the influence of `org-odd-levels-only'
8129 LEVEL is a current level, CHANGE is by how much the level should be
8130 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8131 even level numbers will become the next higher odd number."
8132 (if org-odd-levels-only
8133 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8134 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8135 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8136 (max 1 (+ level (or change 0)))))
8138 (if (boundp 'define-obsolete-function-alias)
8139 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8140 (define-obsolete-function-alias 'org-get-legal-level
8141 'org-get-valid-level)
8142 (define-obsolete-function-alias 'org-get-legal-level
8143 'org-get-valid-level "23.1")))
8145 (defun org-promote ()
8146 "Promote the current heading higher up the tree."
8147 (org-with-wide-buffer
8148 (org-back-to-heading t)
8149 (let* ((after-change-functions (remq 'flyspell-after-change-function
8150 after-change-functions))
8151 (level (save-match-data (funcall outline-level)))
8152 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8153 (diff (abs (- level (length up-head) -1))))
8155 ((and (= level 1) org-allow-promoting-top-level-subtree)
8156 (replace-match "# " nil t))
8158 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8159 (t (replace-match up-head nil t)))
8161 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8162 (when org-adapt-indentation (org-fixup-indentation (- diff))))
8163 (run-hooks 'org-after-promote-entry-hook))))
8165 (defun org-demote ()
8166 "Demote the current heading lower down the tree."
8167 (org-with-wide-buffer
8168 (org-back-to-heading t)
8169 (let* ((after-change-functions (remq 'flyspell-after-change-function
8170 after-change-functions))
8171 (level (save-match-data (funcall outline-level)))
8172 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8173 (diff (abs (- level (length down-head) -1))))
8174 (replace-match down-head nil t)
8175 (when org-auto-align-tags (org-set-tags nil 'ignore-column))
8176 (when org-adapt-indentation (org-fixup-indentation diff))
8177 (run-hooks 'org-after-demote-entry-hook))))
8179 (defun org-cycle-level ()
8180 "Cycle the level of an empty headline through possible states.
8181 This goes first to child, then to parent, level, then up the hierarchy.
8182 After top level, it switches back to sibling level."
8184 (let ((org-adapt-indentation nil))
8185 (when (org-point-at-end-of-empty-headline)
8186 (setq this-command 'org-cycle-level) ; Only needed for caching
8187 (let ((cur-level (org-current-level))
8188 (prev-level (org-get-previous-line-level)))
8190 ;; If first headline in file, promote to top-level.
8192 (loop repeat (/ (- cur-level 1) (org-level-increment))
8193 do (org-do-promote)))
8194 ;; If same level as prev, demote one.
8195 ((= prev-level cur-level)
8197 ;; If parent is top-level, promote to top level if not already.
8199 (loop repeat (/ (- cur-level 1) (org-level-increment))
8200 do (org-do-promote)))
8201 ;; If top-level, return to prev-level.
8203 (loop repeat (/ (- prev-level 1) (org-level-increment))
8204 do (org-do-demote)))
8205 ;; If less than prev-level, promote one.
8206 ((< cur-level prev-level)
8208 ;; If deeper than prev-level, promote until higher than
8210 ((> cur-level prev-level)
8211 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8212 do (org-do-promote))))
8215 (defun org-map-tree (fun)
8216 "Call FUN for every heading underneath the current one."
8217 (org-back-to-heading)
8218 (let ((level (funcall outline-level)))
8222 (outline-next-heading)
8223 (> (funcall outline-level) level))
8227 (defun org-map-region (fun beg end)
8228 "Call FUN for every heading between BEG and END."
8229 (let ((org-ignore-region t))
8231 (setq end (copy-marker end))
8233 (if (and (re-search-forward org-outline-regexp-bol nil t)
8237 (outline-next-heading)
8242 (defun org-fixup-indentation (diff)
8243 "Change the indentation in the current entry by DIFF.
8245 DIFF is an integer. Indentation is done according to the
8248 - Planning information and property drawers are always indented
8249 according to the new level of the headline;
8251 - Footnote definitions and their contents are ignored;
8253 - Inlinetasks' boundaries are not shifted;
8255 - Empty lines are ignored;
8257 - Other lines' indentation are shifted by DIFF columns, unless
8258 it would introduce a structural change in the document, in
8259 which case no shifting is done at all.
8261 Assume point is at a heading or an inlinetask beginning."
8262 (org-with-wide-buffer
8263 (narrow-to-region (line-beginning-position)
8265 (if (org-with-limited-levels (org-at-heading-p))
8266 (org-with-limited-levels (outline-next-heading))
8267 (org-inlinetask-goto-end))
8270 ;; Indent properly planning info and property drawer.
8271 (when (org-looking-at-p org-planning-line-re)
8274 (when (looking-at org-property-drawer-re)
8275 (goto-char (match-end 0))
8277 (save-excursion (org-indent-region (match-beginning 0) (match-end 0))))
8279 (when (zerop diff) (throw 'no-shift nil))
8280 ;; If DIFF is negative, first check if a shift is possible at all
8281 ;; (e.g., it doesn't break structure). This can only happen if
8282 ;; some contents are not properly indented.
8283 (let ((case-fold-search t))
8285 (let ((diff (- diff))
8286 (forbidden-re (concat org-outline-regexp
8288 (substring org-footnote-definition-re 1))))
8292 ((org-looking-at-p "[ \t]*$") (forward-line))
8293 ((and (org-looking-at-p org-footnote-definition-re)
8294 (let ((e (org-element-at-point)))
8295 (and (eq (org-element-type e) 'footnote-definition)
8296 (goto-char (org-element-property :end e))))))
8297 ((org-looking-at-p org-outline-regexp) (forward-line))
8298 ;; Give up if shifting would move before column 0 or
8299 ;; if it would introduce a headline or a footnote
8302 (skip-chars-forward " \t")
8303 (let ((ind (current-column)))
8304 (when (or (< ind diff)
8305 (and (= ind diff) (org-looking-at-p forbidden-re)))
8306 (throw 'no-shift nil)))
8307 ;; Ignore contents of example blocks and source
8308 ;; blocks if their indentation is meant to be
8309 ;; preserved. Jump to block's closing line.
8311 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8312 (let ((e (org-element-at-point)))
8313 (and (memq (org-element-type e)
8314 '(example-block src-block))
8315 (or org-src-preserve-indentation
8316 (org-element-property :preserve-indent e))
8317 (goto-char (org-element-property :end e))
8318 (progn (skip-chars-backward " \r\t\n")
8321 (forward-line))))))))
8322 ;; Shift lines but footnote definitions, inlinetasks boundaries
8323 ;; by DIFF. Also skip contents of source or example blocks
8324 ;; when indentation is meant to be preserved.
8327 ((and (org-looking-at-p org-footnote-definition-re)
8328 (let ((e (org-element-at-point)))
8329 (and (eq (org-element-type e) 'footnote-definition)
8330 (goto-char (org-element-property :end e))))))
8331 ((org-looking-at-p org-outline-regexp) (forward-line))
8332 ((org-looking-at-p "[ \t]*$") (forward-line))
8334 (org-indent-line-to (+ (org-get-indentation) diff))
8336 (or (and (org-looking-at-p "[ \t]*#\\+BEGIN_\\(EXAMPLE\\|SRC\\)")
8337 (let ((e (org-element-at-point)))
8338 (and (memq (org-element-type e)
8339 '(example-block src-block))
8340 (or org-src-preserve-indentation
8341 (org-element-property :preserve-indent e))
8342 (goto-char (org-element-property :end e))
8343 (progn (skip-chars-backward " \r\t\n")
8346 (forward-line)))))))))
8348 (defun org-convert-to-odd-levels ()
8349 "Convert an org-mode file with all levels allowed to one with odd levels.
8350 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8353 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8354 (let ((outline-level 'org-outline-level)
8355 (org-odd-levels-only nil) n)
8357 (goto-char (point-min))
8358 (while (re-search-forward "^\\*\\*+ " nil t)
8359 (setq n (- (length (match-string 0)) 2))
8360 (while (>= (setq n (1- n)) 0)
8362 (end-of-line 1))))))
8364 (defun org-convert-to-oddeven-levels ()
8365 "Convert an org-mode file with only odd levels to one with odd/even levels.
8366 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8367 file contains a section with an even level, conversion would
8368 destroy the structure of the file. An error is signaled in this
8371 (goto-char (point-min))
8372 ;; First check if there are no even levels
8373 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8374 (org-show-set-visibility 'canonical)
8375 (error "Not all levels are odd in this file. Conversion not possible"))
8376 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8377 (let ((outline-regexp org-outline-regexp)
8378 (outline-level 'org-outline-level)
8379 (org-odd-levels-only nil) n)
8381 (goto-char (point-min))
8382 (while (re-search-forward "^\\*\\*+ " nil t)
8383 (setq n (/ (1- (length (match-string 0))) 2))
8384 (while (>= (setq n (1- n)) 0)
8386 (end-of-line 1))))))
8388 (defun org-tr-level (n)
8389 "Make N odd if required."
8390 (if org-odd-levels-only (1+ (/ n 2)) n))
8392 ;;; Vertical tree motion, cutting and pasting of subtrees
8394 (defun org-move-subtree-up (&optional arg)
8395 "Move the current subtree up past ARG headlines of the same level."
8397 (org-move-subtree-down (- (prefix-numeric-value arg))))
8399 (defun org-move-subtree-down (&optional arg)
8400 "Move the current subtree down past ARG headlines of the same level."
8402 (setq arg (prefix-numeric-value arg))
8403 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8404 'org-get-last-sibling))
8405 (ins-point (make-marker))
8407 (col (current-column))
8408 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8410 (org-back-to-heading)
8413 (setq ne-beg (org-back-over-empty-lines))
8416 (save-excursion (outline-end-of-heading)
8417 (setq folded (outline-invisible-p)))
8418 (progn (org-end-of-subtree nil t)
8419 (unless (eobp) (backward-char))))
8420 (outline-next-heading)
8421 (setq ne-end (org-back-over-empty-lines))
8424 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8425 ;; include less whitespace
8428 (forward-line (- ne-beg ne-end))
8429 (setq beg (point))))
8430 ;; Find insertion point, with error handling
8432 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8433 (progn (goto-char beg0)
8434 (user-error "Cannot move past superior level or buffer limit")))
8435 (setq cnt (1- cnt)))
8437 ;; Moving forward - still need to move over subtree
8438 (progn (org-end-of-subtree t t)
8440 (org-back-over-empty-lines)
8441 (or (bolp) (newline)))))
8442 (setq ne-ins (org-back-over-empty-lines))
8443 (move-marker ins-point (point))
8444 (setq txt (buffer-substring beg end))
8445 (org-save-markers-in-region beg end)
8446 (delete-region beg end)
8447 (org-remove-empty-overlays-at beg)
8448 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8449 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8450 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8451 (let ((bbb (point)))
8452 (insert-before-markers txt)
8453 (org-reinstall-markers-in-region bbb)
8454 (move-marker ins-point bbb))
8455 (or (bolp) (insert "\n"))
8456 (setq ins-end (point))
8457 (goto-char ins-point)
8458 (org-skip-whitespace)
8459 (when (and (< arg 0)
8460 (org-first-sibling-p)
8462 ;; Move whitespace back to beginning
8465 (let ((kill-whole-line t))
8466 (kill-line (- ne-ins ne-beg)) (point)))
8467 (insert (make-string (- ne-ins ne-beg) ?\n)))
8468 (move-marker ins-point nil)
8473 (org-cycle-hide-drawers 'children))
8474 (org-clean-visibility-after-subtree-move)
8475 ;; move back to the initial column we were at
8476 (move-to-column col)))
8478 (defvar org-subtree-clip ""
8479 "Clipboard for cut and paste of subtrees.
8480 This is actually only a copy of the kill, because we use the normal kill
8481 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8483 (defvar org-subtree-clip-folded nil
8484 "Was the last copied subtree folded?
8485 This is used to fold the tree back after pasting.")
8487 (defun org-cut-subtree (&optional n)
8488 "Cut the current subtree into the clipboard.
8489 With prefix arg N, cut this many sequential subtrees.
8490 This is a short-hand for marking the subtree and then cutting it."
8492 (org-copy-subtree n 'cut))
8494 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8495 "Copy the current subtree it in the clipboard.
8496 With prefix arg N, copy this many sequential subtrees.
8497 This is a short-hand for marking the subtree and then copying it.
8498 If CUT is non-nil, actually cut the subtree.
8499 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8500 of some markers in the region, even if CUT is non-nil. This is
8501 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8503 (let (beg end folded (beg0 (point)))
8504 (if (org-called-interactively-p 'any)
8505 (org-back-to-heading nil) ; take what looks like a subtree
8506 (org-back-to-heading t)) ; take what is really there
8508 (skip-chars-forward " \t\r\n")
8511 (outline-next-heading)
8512 (save-excursion (outline-end-of-heading)
8513 (setq folded (outline-invisible-p)))
8514 (ignore-errors (org-forward-heading-same-level (1- n) t))
8515 (org-end-of-subtree t t)))
8516 ;; Include the end of an inlinetask
8517 (when (and (featurep 'org-inlinetask)
8518 (looking-at-p (concat (org-inlinetask-outline-regexp)
8524 (setq org-subtree-clip-folded folded)
8525 (when (or cut force-store-markers)
8526 (org-save-markers-in-region beg end))
8527 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8528 (setq org-subtree-clip (current-kill 0))
8529 (message "%s: Subtree(s) with %d characters"
8530 (if cut "Cut" "Copied")
8531 (length org-subtree-clip)))))
8533 (defun org-paste-subtree (&optional level tree for-yank remove)
8534 "Paste the clipboard as a subtree, with modification of headline level.
8535 The entire subtree is promoted or demoted in order to match a new headline
8538 If the cursor is at the beginning of a headline, the same level as
8539 that headline is used to paste the tree.
8541 If not, the new level is derived from the *visible* headings
8542 before and after the insertion point, and taken to be the inferior headline
8543 level of the two. So if the previous visible heading is level 3 and the
8544 next is level 4 (or vice versa), level 4 will be used for insertion.
8545 This makes sure that the subtree remains an independent subtree and does
8546 not swallow low level entries.
8548 You can also force a different level, either by using a numeric prefix
8549 argument, or by inserting the heading marker by hand. For example, if the
8550 cursor is after \"*****\", then the tree will be shifted to level 5.
8552 If optional TREE is given, use this text instead of the kill ring.
8554 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8555 move back over whitespace before inserting, and move point to the end of
8556 the inserted text when done.
8558 When REMOVE is non-nil, remove the subtree from the clipboard."
8560 (setq tree (or tree (and kill-ring (current-kill 0))))
8561 (unless (org-kill-is-subtree-p tree)
8563 (substitute-command-keys
8564 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8565 (org-with-limited-levels
8566 (let* ((visp (not (outline-invisible-p)))
8568 (^re_ "\\(\\*+\\)[ \t]*")
8569 (old-level (if (string-match org-outline-regexp-bol txt)
8570 (- (match-end 0) (match-beginning 0) 1)
8572 (force-level (cond (level (prefix-numeric-value level))
8573 ((and (looking-at "[ \t]*$")
8575 "^\\*+$" (buffer-substring
8576 (point-at-bol) (point))))
8577 (- (match-end 0) (match-beginning 0)))
8579 (looking-at org-outline-regexp))
8580 (- (match-end 0) (point) 1))))
8581 (previous-level (save-excursion
8584 (outline-previous-visible-heading 1)
8585 (if (looking-at ^re_)
8586 (- (match-end 0) (match-beginning 0) 1)
8589 (next-level (save-excursion
8592 (or (looking-at org-outline-regexp)
8593 (outline-next-visible-heading 1))
8594 (if (looking-at ^re_)
8595 (- (match-end 0) (match-beginning 0) 1)
8598 (new-level (or force-level (max previous-level next-level)))
8599 (shift (if (or (= old-level -1)
8601 (= old-level new-level))
8603 (- new-level old-level)))
8604 (delta (if (> shift 0) -1 1))
8605 (func (if (> shift 0) 'org-demote 'org-promote))
8606 (org-odd-levels-only nil)
8608 ;; Remove the forced level indicator
8610 (delete-region (point-at-bol) (point)))
8612 (beginning-of-line (if (bolp) 1 2))
8614 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8615 (insert-before-markers txt)
8616 (unless (string-match "\n\\'" txt) (insert "\n"))
8617 (setq newend (point))
8618 (org-reinstall-markers-in-region beg)
8621 (skip-chars-forward " \t\n\r")
8623 (if (and (outline-invisible-p) visp)
8624 (save-excursion (outline-show-heading)))
8625 ;; Shift if necessary
8628 (narrow-to-region beg end)
8629 (while (not (= shift 0))
8630 (org-map-region func (point-min) (point-max))
8631 (setq shift (+ delta shift)))
8632 (goto-char (point-min))
8633 (setq newend (point-max))))
8634 (when (or (org-called-interactively-p 'interactive) for-yank)
8635 (message "Clipboard pasted as level %d subtree" new-level))
8636 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8638 (eq org-subtree-clip (current-kill 0))
8639 org-subtree-clip-folded)
8640 ;; The tree was folded before it was killed/copied
8642 (and for-yank (goto-char newend))
8643 (and remove (setq kill-ring (cdr kill-ring))))))
8645 (defun org-kill-is-subtree-p (&optional txt)
8646 "Check if the current kill is an outline subtree, or a set of trees.
8647 Returns nil if kill does not start with a headline, or if the first
8648 headline level is not the largest headline level in the tree.
8649 So this will actually accept several entries of equal levels as well,
8650 which is OK for `org-paste-subtree'.
8651 If optional TXT is given, check this string instead of the current kill."
8652 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8653 (re (org-get-limited-outline-regexp))
8654 (^re (concat "^" re))
8655 (start-level (and kill
8657 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8659 (- (match-end 2) (match-beginning 2) 1)))
8660 (start (1+ (or (match-beginning 2) -1))))
8661 (if (not start-level)
8663 nil) ;; does not even start with a heading
8665 (while (setq start (string-match ^re kill (1+ start)))
8666 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8670 (defvar org-markers-to-move nil
8671 "Markers that should be moved with a cut-and-paste operation.
8672 Those markers are stored together with their positions relative to
8673 the start of the region.")
8675 (defun org-save-markers-in-region (beg end)
8676 "Check markers in region.
8677 If these markers are between BEG and END, record their position relative
8678 to BEG, so that after moving the block of text, we can put the markers back
8680 This function gets called just before an entry or tree gets cut from the
8681 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8682 called immediately, to move the markers with the entries."
8683 (setq org-markers-to-move nil)
8684 (when (featurep 'org-clock)
8685 (org-clock-save-markers-for-cut-and-paste beg end))
8686 (when (featurep 'org-agenda)
8687 (org-agenda-save-markers-for-cut-and-paste beg end)))
8689 (defun org-check-and-save-marker (marker beg end)
8690 "Check if MARKER is between BEG and END.
8691 If yes, remember the marker and the distance to BEG."
8692 (when (and (marker-buffer marker)
8693 (equal (marker-buffer marker) (current-buffer)))
8694 (if (and (>= marker beg) (< marker end))
8695 (push (cons marker (- marker beg)) org-markers-to-move))))
8697 (defun org-reinstall-markers-in-region (beg)
8698 "Move all remembered markers to their position relative to BEG."
8700 (move-marker (car x) (+ beg (cdr x))))
8701 org-markers-to-move)
8702 (setq org-markers-to-move nil))
8704 (defun org-narrow-to-subtree ()
8705 "Narrow buffer to the current subtree."
8709 (org-with-limited-levels
8711 (progn (org-back-to-heading t) (point))
8712 (progn (org-end-of-subtree t t)
8713 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8716 (defun org-narrow-to-block ()
8717 "Narrow buffer to the current block."
8719 (let* ((case-fold-search t)
8720 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8721 "^[ \t]*#\\+end_.*")))
8723 (narrow-to-region (car blockp) (cdr blockp))
8724 (user-error "Not in a block"))))
8726 (defun org-clone-subtree-with-time-shift (n &optional shift)
8727 "Clone the task (subtree) at point N times.
8728 The clones will be inserted as siblings.
8730 In interactive use, the user will be prompted for the number of
8731 clones to be produced. If the entry has a timestamp, the user
8732 will also be prompted for a time shift, which may be a repeater
8733 as used in time stamps, for example `+3d'. To disable this,
8734 you can call the function with a universal prefix argument.
8736 When a valid repeater is given and the entry contains any time
8737 stamps, the clones will become a sequence in time, with time
8738 stamps in the subtree shifted for each clone produced. If SHIFT
8739 is nil or the empty string, time stamps will be left alone. The
8740 ID property of the original subtree is removed.
8742 If the original subtree did contain time stamps with a repeater,
8743 the following will happen:
8744 - the repeater will be removed in each clone
8745 - an additional clone will be produced, with the current, unshifted
8746 date(s) in the entry.
8747 - the original entry will be placed *after* all the clones, with
8749 - the start days in the repeater in the original entry will be shifted
8750 to past the last clone.
8751 In this way you can spell out a number of instances of a repeating task,
8752 and still retain the repeater to cover future instances of the task."
8753 (interactive "nNumber of clones to produce: ")
8756 (if (and (not (equal current-prefix-arg '(4)))
8758 (re-search-forward org-ts-regexp-both
8760 (org-end-of-subtree t)
8762 (read-from-minibuffer
8763 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8764 ""))) ;; No time shift
8766 (drawer-re org-drawer-regexp)
8767 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8768 beg end template task idprop
8769 shift-n shift-what doshift nmin nmax)
8770 (if (not (and (integerp n) (> n 0)))
8771 (user-error "Invalid number of replications %s" n))
8772 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8773 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8775 (user-error "Invalid shift specification %s" shift))
8777 (setq shift-n (string-to-number (match-string 1 shift))
8778 shift-what (cdr (assoc (match-string 2 shift)
8779 '(("d" . day) ("w" . week)
8780 ("m" . month) ("y" . year))))))
8781 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8782 (setq nmin 1 nmax n)
8783 (org-back-to-heading t)
8785 (setq idprop (org-entry-get nil "ID"))
8786 (org-end-of-subtree t t)
8787 (or (bolp) (insert "\n"))
8789 (setq template (buffer-substring beg end))
8791 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8792 (delete-region beg end)
8794 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8796 (loop for n from nmin to nmax do
8801 (goto-char (point-min))
8803 (and idprop (if org-clone-delete-id
8804 (org-entry-delete nil "ID")
8805 (org-id-get-create t)))
8807 (while (re-search-forward org-clock-re nil t)
8809 (goto-char (point-min))
8810 (while (re-search-forward drawer-re nil t)
8811 (org-remove-empty-drawer-at (point))))
8812 (goto-char (point-min))
8814 (while (re-search-forward org-ts-regexp-both nil t)
8815 (org-timestamp-change (* n shift-n) shift-what))
8816 (unless (= n n-no-remove)
8817 (goto-char (point-min))
8818 (while (re-search-forward org-ts-regexp nil t)
8820 (goto-char (match-beginning 0))
8821 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8822 (delete-region (match-beginning 1) (match-end 1)))))))
8823 (setq task (buffer-string)))
8829 (defun org-sort (with-case)
8830 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8831 Optional argument WITH-CASE means sort case-sensitively."
8834 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8835 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8837 (org-call-with-arg 'org-sort-entries with-case))))
8839 (defun org-sort-remove-invisible (s)
8840 "Remove invisible links from string S."
8841 (remove-text-properties 0 (length s) org-rm-props s)
8842 (while (string-match org-bracket-link-regexp s)
8843 (setq s (replace-match (if (match-end 2)
8845 (match-string 1 s)) t t s)))
8846 (let ((st (format " %s " s)))
8847 (while (string-match org-emph-re st)
8848 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8849 (setq s (substring st 1 -1)))
8852 (defvar org-priority-regexp) ; defined later in the file
8854 (defvar org-after-sorting-entries-or-items-hook nil
8855 "Hook that is run after a bunch of entries or items have been sorted.
8856 When children are sorted, the cursor is in the parent line when this
8857 hook gets called. When a region or a plain list is sorted, the cursor
8858 will be in the first entry of the sorted region/list.")
8860 (defun org-sort-entries
8861 (&optional with-case sorting-type getkey-func compare-func property)
8862 "Sort entries on a certain level of an outline tree.
8863 If there is an active region, the entries in the region are sorted.
8864 Else, if the cursor is before the first entry, sort the top-level items.
8865 Else, the children of the entry at point are sorted.
8867 Sorting can be alphabetically, numerically, by date/time as given by
8868 a time stamp, by a property, by priority order, or by a custom function.
8870 The command prompts for the sorting type unless it has been given to the
8871 function through the SORTING-TYPE argument, which needs to be a character,
8872 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8873 the precise meaning of each character:
8875 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8876 c By creation time, which is assumed to be the first inactive time stamp
8877 at the beginning of a line.
8878 d By deadline date/time.
8880 n Numerically, by converting the beginning of the entry/item to a number.
8881 o By order of TODO keywords.
8882 p By priority according to the cookie.
8883 r By the value of a property.
8884 s By scheduled date/time.
8885 t By date/time, either the first active time stamp in the entry, or, if
8886 none exist, by the first inactive one.
8888 Capital letters will reverse the sort order.
8890 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8891 called with point at the beginning of the record. It must return either
8892 a string or a number that should serve as the sorting key for that record.
8894 Comparing entries ignores case by default. However, with an optional argument
8895 WITH-CASE, the sorting considers case as well.
8897 Sorting is done against the visible part of the headlines, it ignores hidden
8900 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8902 (let ((case-func (if with-case 'identity 'downcase))
8904 ;; The clock marker is lost when using `sort-subr', let's
8905 ;; store the clocking string.
8906 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8908 (goto-char org-clock-marker)
8909 (looking-back "^.*") (match-string-no-properties 0))))
8910 start beg end stars re re2
8912 ;; Find beginning and end of region to sort
8914 ((org-region-active-p)
8915 ;; we will sort the region
8916 (setq end (region-end)
8918 (goto-char (region-beginning))
8919 (if (not (org-at-heading-p)) (outline-next-heading))
8920 (setq start (point)))
8921 ((or (org-at-heading-p)
8922 (ignore-errors (progn (org-back-to-heading) t)))
8923 ;; we will sort the children of the current headline
8924 (org-back-to-heading)
8926 end (progn (org-end-of-subtree t t)
8927 (or (bolp) (insert "\n"))
8928 (when (>= (org-back-over-empty-lines) 1)
8934 (outline-next-heading))
8936 ;; we will sort the top-level entries in this file
8937 (goto-char (point-min))
8938 (or (org-at-heading-p) (outline-next-heading))
8939 (setq start (point))
8940 (goto-char (point-max))
8941 (beginning-of-line 1)
8942 (when (looking-at ".*?\\S-")
8943 ;; File ends in a non-white line
8946 (setq end (point-max))
8947 (setq what "top-level")
8952 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8954 (looking-at "\\(\\*+\\)")
8955 (setq stars (match-string 1)
8956 re (concat "^" (regexp-quote stars) " +")
8957 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8958 txt (buffer-substring beg end))
8959 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8960 (if (and (not (equal stars "*")) (string-match re2 txt))
8961 (user-error "Region to sort contains a level above the first entry"))
8963 (unless sorting-type
8965 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8966 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8967 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8969 (setq sorting-type (read-char-exclusive))
8972 (and (= (downcase sorting-type) ?f)
8974 (org-icompleting-read "Sort using function: "
8975 obarray 'fboundp t nil nil))
8976 (setq getkey-func (intern getkey-func))))
8978 (and (= (downcase sorting-type) ?r)
8981 (org-icompleting-read "Property: "
8982 (mapcar 'list (org-buffer-property-keys t))
8985 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8986 (message "Sorting entries...")
8989 (narrow-to-region start end)
8990 (let ((dcst (downcase sorting-type))
8991 (case-fold-search nil)
8992 (now (current-time)))
8994 (/= dcst sorting-type)
8995 ;; This function moves to the beginning character of the "record" to
8998 (if (re-search-forward re nil t)
8999 (goto-char (match-beginning 0))
9000 (goto-char (point-max))))
9001 ;; This function moves to the last character of the "record" being
9006 (outline-forward-same-level 1)
9008 (goto-char (point-max))))))
9009 ;; This function returns the value that gets sorted against.
9013 (if (looking-at org-complex-heading-regexp)
9014 (string-to-number (org-sort-remove-invisible (match-string 4)))
9017 (if (looking-at org-complex-heading-regexp)
9018 (funcall case-func (org-sort-remove-invisible (match-string 4)))
9021 (or (get-text-property (point) :org-clock-minutes) 0))
9023 (let ((end (save-excursion (outline-next-heading) (point))))
9024 (if (or (re-search-forward org-ts-regexp end t)
9025 (re-search-forward org-ts-regexp-both end t))
9026 (org-time-string-to-seconds (match-string 0))
9027 (org-float-time now))))
9029 (let ((end (save-excursion (outline-next-heading) (point))))
9030 (if (re-search-forward
9031 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
9033 (org-time-string-to-seconds (match-string 0))
9034 (org-float-time now))))
9036 (let ((end (save-excursion (outline-next-heading) (point))))
9037 (if (re-search-forward org-scheduled-time-regexp end t)
9038 (org-time-string-to-seconds (match-string 1))
9039 (org-float-time now))))
9041 (let ((end (save-excursion (outline-next-heading) (point))))
9042 (if (re-search-forward org-deadline-time-regexp end t)
9043 (org-time-string-to-seconds (match-string 1))
9044 (org-float-time now))))
9046 (if (re-search-forward org-priority-regexp (point-at-eol) t)
9047 (string-to-char (match-string 2))
9048 org-default-priority))
9050 (or (org-entry-get nil property) ""))
9052 (if (looking-at org-complex-heading-regexp)
9053 (let* ((m (match-string 2))
9054 (s (if (member m org-done-keywords) '- '+)))
9055 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
9059 (setq tmp (funcall getkey-func))
9060 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
9062 (error "Invalid key function `%s'" getkey-func)))
9063 (t (error "Invalid sorting type `%c'" sorting-type))))
9066 ((= dcst ?a) 'string<)
9067 ((= dcst ?f) compare-func)
9068 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
9069 (run-hooks 'org-after-sorting-entries-or-items-hook)
9070 ;; Reset the clock marker if needed
9074 (search-forward cmstr nil t)
9075 (move-marker org-clock-marker (point))))
9076 (message "Sorting entries...done")))
9078 ;;; The orgstruct minor mode
9080 ;; Define a minor mode which can be used in other modes in order to
9081 ;; integrate the org-mode structure editing commands.
9083 ;; This is really a hack, because the org-mode structure commands use
9084 ;; keys which normally belong to the major mode. Here is how it
9085 ;; works: The minor mode defines all the keys necessary to operate the
9086 ;; structure commands, but wraps the commands into a function which
9087 ;; tests if the cursor is currently at a headline or a plain list
9088 ;; item. If that is the case, the structure command is used,
9089 ;; temporarily setting many Org-mode variables like regular
9090 ;; expressions for filling etc. However, when any of those keys is
9091 ;; used at a different location, function uses `key-binding' to look
9092 ;; up if the key has an associated command in another currently active
9093 ;; keymap (minor modes, major mode, global), and executes that
9094 ;; command. There might be problems if any of the keys is otherwise
9095 ;; used as a prefix key.
9097 (defcustom orgstruct-heading-prefix-regexp ""
9098 "Regexp that matches the custom prefix of Org headlines in
9099 orgstruct(++)-mode."
9102 :package-version '(Org . "8.3")
9104 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9106 (defcustom orgstruct-setup-hook nil
9107 "Hook run after orgstruct-mode-map is filled."
9110 :package-version '(Org . "8.0")
9113 (defvar orgstruct-initialized nil)
9115 (defvar org-local-vars nil
9116 "List of local variables, for use by `orgstruct-mode'.")
9119 (define-minor-mode orgstruct-mode
9120 "Toggle the minor mode `orgstruct-mode'.
9121 This mode is for using Org-mode structure commands in other
9122 modes. The following keys behave as if Org-mode were active, if
9123 the cursor is on a headline, or on a plain list item (both as
9124 defined by Org-mode)."
9125 nil " OrgStruct" (make-sparse-keymap)
9126 (funcall (if orgstruct-mode
9127 'add-to-invisibility-spec
9128 'remove-from-invisibility-spec)
9130 (when orgstruct-mode
9131 (org-load-modules-maybe)
9132 (unless orgstruct-initialized
9134 (setq orgstruct-initialized t))))
9137 (defun turn-on-orgstruct ()
9138 "Unconditionally turn on `orgstruct-mode'."
9141 (defvar org-fb-vars nil)
9142 (make-variable-buffer-local 'org-fb-vars)
9143 (defun orgstruct++-mode (&optional arg)
9144 "Toggle `orgstruct-mode', the enhanced version of it.
9145 In addition to setting orgstruct-mode, this also exports all
9146 indentation and autofilling variables from org-mode into the
9147 buffer. It will also recognize item context in multiline items."
9149 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9151 (progn (orgstruct-mode -1)
9153 (org-set-local (car v)
9154 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9157 (setq org-fb-vars nil)
9158 (unless org-local-vars
9159 (setq org-local-vars (org-get-local-variables)))
9164 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9165 (symbol-name (car x)))
9166 (setq var (car x) val (nth 1 x))
9167 (push (list var `(quote ,(eval var))) org-fb-vars)
9168 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9170 (org-set-local 'orgstruct-is-++ t))))
9172 (defvar orgstruct-is-++ nil
9173 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9174 (make-variable-buffer-local 'orgstruct-is-++)
9177 (defun turn-on-orgstruct++ ()
9178 "Unconditionally turn on `orgstruct++-mode'."
9179 (orgstruct++-mode 1))
9181 (defun orgstruct-error ()
9182 "Error when there is no default binding for a structure key."
9184 (funcall (if (fboundp 'user-error)
9187 "This key has no function outside structure elements"))
9189 (defun orgstruct-setup ()
9190 "Setup orgstruct keymap."
9191 (dolist (cell '((org-demote . t)
9195 (org-shiftmetaleft . t)
9196 (org-shiftmetaright . t)
9197 org-backward-element
9198 org-backward-heading-same-level
9203 org-forward-heading-same-level
9205 org-insert-heading-respect-content
9206 org-kill-note-or-show-branches
9211 org-narrow-to-subtree
9226 outline-next-visible-heading
9227 outline-previous-visible-heading
9231 (let ((f (or (car-safe cell) cell))
9232 (disable-when-heading-prefix (cdr-safe cell)))
9234 (let ((new-bindings))
9235 (dolist (binding (nconc (where-is-internal f org-mode-map)
9236 (where-is-internal f outline-mode-map)))
9237 (push binding new-bindings)
9238 ;; TODO use local-function-key-map
9239 (dolist (rep '(("<tab>" . "TAB")
9240 ("<return>" . "RET")
9241 ("<escape>" . "ESC")
9242 ("<delete>" . "DEL")))
9243 (setq binding (read-kbd-macro
9244 (let ((case-fold-search))
9245 (replace-regexp-in-string
9246 (regexp-quote (cdr rep))
9248 (key-description binding)))))
9249 (pushnew binding new-bindings :test 'equal)))
9250 (dolist (binding new-bindings)
9251 (let ((key (lookup-key orgstruct-mode-map binding)))
9252 (when (or (not key) (numberp key))
9254 (org-defkey orgstruct-mode-map
9256 (orgstruct-make-binding
9257 f binding disable-when-heading-prefix))))))))))
9258 (run-hooks 'orgstruct-setup-hook))
9260 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9261 "Create a function for binding in the structure minor mode.
9262 FUN is the command to call inside a table. KEY is the key that
9263 should be checked in for a command to execute outside of tables.
9264 Non-nil `disable-when-heading-prefix' means to disable the command
9265 if `orgstruct-heading-prefix-regexp' is not empty."
9266 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9269 (while (fboundp (intern nname))
9270 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9271 (setq name (intern nname)))
9273 (let ((bindings '((org-heading-regexp
9275 orgstruct-heading-prefix-regexp
9276 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9278 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9279 (org-outline-regexp-bol
9280 (concat "^" org-outline-regexp))
9281 (outline-regexp org-outline-regexp)
9282 (outline-heading-end-regexp "\n")
9283 (outline-level 'org-outline-level)
9284 (outline-heading-alist))))
9286 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9287 "Outside of structure, run the binding of `"
9288 (key-description key) "'."
9289 (when disable-when-heading-prefix
9291 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9292 "back to the default binding due to limitations of Org's implementation of\n"
9293 "`" (symbol-name fun) "'.")))
9296 ,(and disable-when-heading-prefix
9297 '(not (string= orgstruct-heading-prefix-regexp ""))))
9302 (org-context-p 'headline 'item
9304 '(org-insert-heading
9305 org-insert-heading-respect-content
9307 '(when orgstruct-is-++
9310 (let* ((orgstruct-mode)
9317 ("<\\([^>]*\\)tab>" . "\\1TAB")
9318 ("<\\([^>]*\\)return>" . "\\1RET")
9319 ("<\\([^>]*\\)escape>" . "\\1ESC")
9320 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9323 (setq key (read-kbd-macro
9324 (let ((case-fold-search))
9325 (replace-regexp-in-string
9328 (key-description key))))))
9329 (when (key-binding key)
9330 (throw 'exit (key-binding key))))))))
9331 (if (keymapp binding)
9332 (org-set-transient-map binding)
9333 (let ((func (or binding
9335 'orgstruct-error))))
9337 (call-interactively func)))))
9338 (org-run-like-in-org-mode
9342 (call-interactively ',fun)))))))))
9345 (defun org-contextualize-keys (alist contexts)
9346 "Return valid elements in ALIST depending on CONTEXTS.
9348 `org-agenda-custom-commands' or `org-capture-templates' are the
9349 values used for ALIST, and `org-agenda-custom-commands-contexts'
9350 or `org-capture-templates-contexts' are the associated contexts
9353 ;; normalize contexts
9355 (lambda(c) (cond ((listp (cadr c))
9356 (list (car c) (car c) (cadr c)))
9357 ((string= "" (cadr c))
9358 (list (car c) (car c) (caddr c)))
9361 ;; loop over all commands or templates
9362 (while (setq c (pop a))
9365 ((not (assoc (car c) contexts))
9367 ((and (assoc (car c) contexts)
9368 (setq vrules (org-contextualize-validate-key
9371 (when (not (equal (car vr) (cadr vr)))
9372 (setq repl vr))) vrules)
9373 (if (not repl) (push c r)
9374 (push (cadr repl) s)
9377 (cdr (or (assoc (cadr repl) alist)
9378 (error "Undefined key `%s' as contextual replacement for `%s'"
9379 (cadr repl) (car c)))))
9381 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9386 (let ((tpl (car x)))
9390 (equal y tpl)) s))) x)))
9393 (defun org-contextualize-validate-key (key contexts)
9394 "Check CONTEXTS for agenda or capture KEY."
9396 (while (setq r (pop contexts))
9400 (and (equal key (car r))
9401 (if (functionp rr) (funcall rr)
9402 (or (and (eq (car rr) 'in-file)
9404 (string-match (cdr rr) (buffer-file-name)))
9405 (and (eq (car rr) 'in-mode)
9406 (string-match (cdr rr) (symbol-name major-mode)))
9407 (and (eq (car rr) 'in-buffer)
9408 (string-match (cdr rr) (buffer-name)))
9409 (when (and (eq (car rr) 'not-in-file)
9411 (not (string-match (cdr rr) (buffer-file-name))))
9412 (when (eq (car rr) 'not-in-mode)
9413 (not (string-match (cdr rr) (symbol-name major-mode))))
9414 (when (eq (car rr) 'not-in-buffer)
9415 (not (string-match (cdr rr) (buffer-name)))))))
9418 (delete-dups (delq nil res))))
9420 (defun org-context-p (&rest contexts)
9421 "Check if local context is any of CONTEXTS.
9422 Possible values in the list of contexts are `table', `headline', and `item'."
9423 (let ((pos (point)))
9424 (goto-char (point-at-bol))
9425 (prog1 (or (and (memq 'table contexts)
9426 (looking-at "[ \t]*|"))
9427 (and (memq 'headline contexts)
9428 (looking-at org-outline-regexp))
9429 (and (memq 'item contexts)
9430 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9431 (and (memq 'item-body contexts)
9435 (defun org-get-local-variables ()
9436 "Return a list of all local variables in an Org mode buffer."
9438 (with-current-buffer (get-buffer-create "*Org tmp*")
9441 (setq varlist (buffer-local-variables)))
9442 (kill-buffer "*Org tmp*")
9449 (list (car x) (cdr x))))
9450 (if (and (not (get (car x) 'org-state))
9452 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9453 (symbol-name (car x))))
9457 (defun org-clone-local-variables (from-buffer &optional regexp)
9458 "Clone local variables from FROM-BUFFER.
9459 Optional argument REGEXP selects variables to clone."
9462 (and (symbolp (car pair))
9464 (string-match regexp (symbol-name (car pair))))
9465 (set (make-local-variable (car pair))
9467 (buffer-local-variables from-buffer)))
9470 (defun org-run-like-in-org-mode (cmd)
9471 "Run a command, pretending that the current buffer is in Org-mode.
9472 This will temporarily bind local variables that are typically bound in
9473 Org-mode to the values they have in Org-mode, and then interactively
9475 (org-load-modules-maybe)
9476 (unless org-local-vars
9477 (setq org-local-vars (org-get-local-variables)))
9479 (dolist (var org-local-vars)
9480 (when (or (not (boundp (car var)))
9481 (eq (symbol-value (car var))
9482 (default-value (car var))))
9483 (push (list (car var) `(quote ,(cadr var))) binds)))
9485 (call-interactively (quote ,cmd))))))
9487 (defun org-get-category (&optional pos force-refresh)
9488 "Get the category applying to position POS."
9490 (if force-refresh (org-refresh-category-properties))
9491 (let ((pos (or pos (point))))
9492 (or (get-text-property pos 'org-category)
9493 (progn (org-refresh-category-properties)
9494 (get-text-property pos 'org-category))))))
9496 ;;; Refresh properties
9498 (defun org-refresh-properties (dprop tprop)
9499 "Refresh buffer text properties.
9500 DPROP is the drawer property and TPROP is either the
9501 corresponding text property to set, or an alist with each element
9502 being a text property (as a symbol) and a function to apply to
9503 the value of the drawer property."
9504 (let ((case-fold-search t)
9505 (inhibit-read-only t))
9506 (org-with-silent-modifications
9510 (goto-char (point-min))
9511 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9512 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9514 (defun org-refresh-property (tprop p)
9515 "Refresh the buffer text property TPROP from the drawer property P.
9516 The refresh happens only for the current tree (not subtree)."
9517 (unless (org-before-first-heading-p)
9519 (org-back-to-heading t)
9521 ;; TPROP is a text property symbol
9523 (point) (or (outline-next-heading) (point-max)) tprop p)
9524 ;; TPROP is an alist with (properties . function) elements
9528 (line-beginning-position) (or (outline-next-heading) (point-max))
9530 (funcall (cdr al) p))))))))
9532 (defun org-refresh-category-properties ()
9533 "Refresh category text properties in the buffer."
9534 (let ((case-fold-search t)
9535 (inhibit-read-only t)
9537 (cond ((null org-category)
9538 (if buffer-file-name
9539 (file-name-sans-extension
9540 (file-name-nondirectory buffer-file-name))
9542 ((symbolp org-category) (symbol-name org-category))
9544 (org-with-silent-modifications
9545 (org-with-wide-buffer
9546 ;; Set buffer-wide category. Search last #+CATEGORY keyword.
9547 ;; This is the default category for the buffer. If none is
9548 ;; found, fall-back to `org-category' or buffer file name.
9550 (point-min) (point-max)
9552 (catch 'buffer-category
9553 (goto-char (point-max))
9554 (while (re-search-backward "^[ \t]*#\\+CATEGORY:" (point-min) t)
9555 (let ((element (org-element-at-point)))
9556 (when (eq (org-element-type element) 'keyword)
9557 (throw 'buffer-category
9558 (org-element-property :value element)))))
9560 ;; Set sub-tree specific categories.
9561 (goto-char (point-min))
9562 (let ((regexp (org-re-property "CATEGORY")))
9563 (while (re-search-forward regexp nil t)
9564 (let ((value (org-match-string-no-properties 3)))
9565 (when (org-at-property-p)
9567 (save-excursion (org-back-to-heading t) (point))
9568 (org-end-of-subtree t t)
9572 (defun org-refresh-stats-properties ()
9573 "Refresh stats text properties in the buffer."
9575 (org-with-silent-modifications
9579 (goto-char (point-min))
9580 (while (re-search-forward
9581 (concat org-outline-regexp-bol ".*"
9582 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9584 (setq stats (cond ((equal (match-string 3) "0") 0)
9586 (/ (* (string-to-number (match-string 2)) 100)
9587 (string-to-number (match-string 3))))
9588 (t (string-to-number (match-string 1)))))
9589 (org-back-to-heading t)
9590 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9591 'org-stats stats)))))))
9593 (defun org-refresh-effort-properties ()
9594 "Refresh effort properties"
9595 (org-refresh-properties
9597 '((effort . identity)
9598 (effort-minutes . org-duration-string-to-minutes))))
9602 ;;; Link abbreviations
9604 (defun org-link-expand-abbrev (link)
9605 "Apply replacements as defined in `org-link-abbrev-alist'."
9606 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9607 (let* ((key (match-string 1 link))
9608 (as (or (assoc key org-link-abbrev-alist-local)
9609 (assoc key org-link-abbrev-alist)))
9610 (tag (and (match-end 2) (match-string 3 link)))
9616 ((symbolp rpl) (funcall rpl tag))
9617 ((string-match "%(\\([^)]+\\))" rpl)
9620 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9621 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9622 ((string-match "%h" rpl)
9623 (replace-match (url-hexify-string (or tag "")) t t rpl))
9624 (t (concat rpl tag)))))
9627 ;;; Storing and inserting links
9629 (defvar org-insert-link-history nil
9630 "Minibuffer history for links inserted with `org-insert-link'.")
9632 (defvar org-stored-links nil
9633 "Contains the links stored with `org-store-link'.")
9635 (defvar org-store-link-plist nil
9636 "Plist with info about the most recently link created with `org-store-link'.")
9638 (defvar org-link-protocols nil
9639 "Link protocols added to Org-mode using `org-add-link-type'.")
9641 (defvar org-store-link-functions nil
9642 "List of functions that are called to create and store a link.
9643 Each function will be called in turn until one returns a non-nil
9644 value. Each function should check if it is responsible for creating
9645 this link (for example by looking at the major mode).
9646 If not, it must exit and return nil.
9647 If yes, it should return a non-nil value after a calling
9648 `org-store-link-props' with a list of properties and values.
9649 Special properties are:
9651 :type The link prefix, like \"http\". This must be given.
9652 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9653 This is obligatory as well.
9654 :description Optional default description for the second pair
9655 of brackets in an Org-mode link. The user can still change
9656 this when inserting this link into an Org-mode buffer.
9658 In addition to these, any additional properties can be specified
9659 and then used in capture templates.")
9661 (defun org-add-link-type (type &optional follow export)
9662 "Add TYPE to the list of `org-link-types'.
9663 Re-compute all regular expressions depending on `org-link-types'
9665 FOLLOW and EXPORT are two functions.
9667 FOLLOW should take the link path as the single argument and do whatever
9668 is necessary to follow the link, for example find a file or display
9671 EXPORT should format the link path for export to one of the export formats.
9672 It should be a function accepting three arguments:
9674 path the path of the link, the text after the prefix (like \"http:\")
9675 desc the description of the link, if any
9676 format the export format, a symbol like `html' or `latex' or `ascii'.
9678 The function may use the FORMAT information to return different values
9679 depending on the format. The return value will be put literally into
9680 the exported file. If the return value is nil, this means Org should
9681 do what it normally does with links which do not have EXPORT defined.
9683 Org mode has a built-in default for exporting links. If you are happy with
9684 this default, there is no need to define an export function for the link
9685 type. For a simple example of an export function, see `org-bbdb.el'."
9686 (add-to-list 'org-link-types type t)
9687 (org-make-link-regexps)
9688 (org-element-update-syntax)
9689 (if (assoc type org-link-protocols)
9690 (setcdr (assoc type org-link-protocols) (list follow export))
9691 (push (list type follow export) org-link-protocols)))
9693 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9694 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9697 (defun org-store-link (arg)
9698 "\\<org-mode-map>Store an org-link to the current location.
9699 This link is added to `org-stored-links' and can later be inserted
9700 into an org-buffer with \\[org-insert-link].
9702 For some link types, a prefix arg is interpreted.
9703 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9704 For file links, arg negates `org-context-in-file-links'.
9706 A double prefix arg force skipping storing functions that are not
9709 A triple prefix arg force storing a link for each line in the
9712 (org-load-modules-maybe)
9713 (if (and (equal arg '(64)) (org-region-active-p))
9715 (let ((end (region-end)))
9716 (goto-char (region-beginning))
9718 (while (< (point-at-eol) end)
9719 (move-end-of-line 1) (activate-mark)
9720 (let (current-prefix-arg)
9721 (call-interactively 'org-store-link))
9722 (move-beginning-of-line 2)
9723 (set-mark (point)))))
9724 (org-with-limited-levels
9725 (setq org-store-link-plist nil)
9726 (let (link cpltxt desc description search
9727 txt custom-id agenda-link sfuns sfunsn)
9730 ;; Store a link using an external link type
9731 ((and (not (equal arg '(16)))
9734 nil (mapcar (lambda (f)
9735 (let (fs) (if (funcall f) (push f fs))))
9736 org-store-link-functions))
9737 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9738 (or (and (cdr sfuns)
9741 "Which function for creating the link? "
9742 sfunsn nil t (car sfunsn)))))
9743 (funcall (caar sfuns)))
9744 (setq link (plist-get org-store-link-plist :link)
9745 desc (or (plist-get org-store-link-plist
9746 :description) link))))
9748 ;; Store a link from a source code buffer
9749 ((org-src-edit-buffer-p)
9751 (while (or (not label)
9755 (goto-char (point-min))
9757 (regexp-quote (format org-coderef-label-format label))
9759 (when label (message "Label exists already") (sit-for 2))
9760 (setq label (read-string "Code line label: " label)))
9762 (setq link (format org-coderef-label-format label))
9763 (setq gc (- 79 (length link)))
9764 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9766 (setq link (concat "(" label ")") desc nil)))
9768 ;; We are in the agenda, link to referenced location
9769 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9770 (let ((m (or (get-text-property (point) 'org-hd-marker)
9771 (get-text-property (point) 'org-marker))))
9773 (org-with-point-at m
9775 (if (org-called-interactively-p 'any)
9776 (call-interactively 'org-store-link)
9777 (org-store-link nil)))))))
9779 ((eq major-mode 'calendar-mode)
9780 (let ((cd (calendar-cursor-to-date)))
9783 (car org-time-stamp-formats)
9785 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9787 (org-store-link-props :type "calendar" :date cd)))
9789 ((eq major-mode 'help-mode)
9790 (setq link (concat "help:" (save-excursion
9791 (goto-char (point-min))
9792 (looking-at "^[^ ]+")
9794 (org-store-link-props :type "help"))
9796 ((eq major-mode 'w3-mode)
9797 (setq cpltxt (if (and (buffer-name)
9798 (not (string-match "Untitled" (buffer-name))))
9801 link (url-view-url t))
9802 (org-store-link-props :type "w3" :url (url-view-url t)))
9804 ((eq major-mode 'image-mode)
9805 (setq cpltxt (concat "file:"
9806 (abbreviate-file-name buffer-file-name))
9808 (org-store-link-props :type "image" :file buffer-file-name))
9810 ;; In dired, store a link to the file of the current line
9811 ((derived-mode-p 'dired-mode)
9812 (let ((file (dired-get-filename nil t)))
9814 (abbreviate-file-name
9815 (expand-file-name (dired-get-filename nil t)))
9816 ;; otherwise, no file so use current directory.
9818 (setq cpltxt (concat "file:" file)
9821 ((setq search (run-hook-with-args-until-success
9822 'org-create-file-search-functions))
9823 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9825 (setq cpltxt (or description link)))
9827 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9828 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9830 ;; Store a link using the target at point
9831 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9834 (abbreviate-file-name
9835 (buffer-file-name (buffer-base-buffer)))
9836 "::" (match-string 1))
9838 ((and (featurep 'org-id)
9839 (or (eq org-id-link-to-org-use-id t)
9840 (and (org-called-interactively-p 'any)
9841 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9842 (and (eq org-id-link-to-org-use-id
9843 'create-if-interactive-and-no-custom-id)
9845 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9846 ;; Store a link using the ID at point
9847 (setq link (condition-case nil
9848 (prog1 (org-id-store-link)
9849 (setq desc (or (plist-get org-store-link-plist
9853 ;; Probably before first headline, link only to file
9855 (abbreviate-file-name
9856 (buffer-file-name (buffer-base-buffer))))))))
9858 ;; Just link to current headline
9859 (setq cpltxt (concat "file:"
9860 (abbreviate-file-name
9861 (buffer-file-name (buffer-base-buffer)))))
9862 ;; Add a context search string
9863 (when (org-xor org-context-in-file-links arg)
9864 (let* ((ee (org-element-at-point))
9865 (et (org-element-type ee))
9866 (ev (plist-get (cadr ee) :value))
9867 (ek (plist-get (cadr ee) :key))
9868 (eok (and (stringp ek) (string-match "name" ek))))
9870 ((org-at-heading-p) nil)
9871 ((and (eq et 'keyword) eok) ev)
9872 ((org-region-active-p)
9873 (buffer-substring (region-beginning) (region-end)))))
9874 (when (or (null txt) (string-match "\\S-" txt))
9878 (org-make-org-heading-search-string txt)
9880 desc (or (and (eq et 'keyword) eok ev)
9881 (nth 4 (ignore-errors (org-heading-components)))
9883 (if (string-match "::\\'" cpltxt)
9884 (setq cpltxt (substring cpltxt 0 -2)))
9885 (setq link cpltxt))))
9887 ((buffer-file-name (buffer-base-buffer))
9888 ;; Just link to this file here.
9889 (setq cpltxt (concat "file:"
9890 (abbreviate-file-name
9891 (buffer-file-name (buffer-base-buffer)))))
9892 ;; Add a context string.
9893 (when (org-xor org-context-in-file-links arg)
9894 (setq txt (if (org-region-active-p)
9895 (buffer-substring (region-beginning) (region-end))
9896 (buffer-substring (point-at-bol) (point-at-eol))))
9897 ;; Only use search option if there is some text.
9898 (when (string-match "\\S-" txt)
9900 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9904 ((org-called-interactively-p 'interactive)
9905 (user-error "No method for storing a link from this buffer"))
9907 (t (setq link nil)))
9909 ;; We're done setting link and desc, clean up
9910 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9911 (setq link (or link cpltxt)
9912 desc (or desc cpltxt))
9913 (cond ((equal desc "NONE") (setq desc nil))
9914 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9915 (let ((d0 (match-string 3 desc))
9916 (p0 (match-string 5 desc)))
9918 (replace-regexp-in-string
9919 org-bracket-link-regexp
9921 (if (equal (length (match-string 0 desc))
9922 (length desc)) "*" "")) desc)))))
9925 (if (not (and (or (org-called-interactively-p 'any)
9926 executing-kbd-macro) link))
9927 (or agenda-link (and link (org-make-link-string link desc)))
9928 (push (list link desc) org-stored-links)
9929 (message "Stored: %s" (or desc link))
9931 (setq link (concat "file:" (abbreviate-file-name
9932 (buffer-file-name)) "::#" custom-id))
9933 (push (list link desc) org-stored-links))
9934 (car org-stored-links))))))
9936 (defun org-store-link-props (&rest plist)
9937 "Store link properties, extract names and addresses."
9939 (when (setq x (plist-get plist :from))
9940 (setq adr (mail-extract-address-components x))
9941 (setq plist (plist-put plist :fromname (car adr)))
9942 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9943 (when (setq x (plist-get plist :to))
9944 (setq adr (mail-extract-address-components x))
9945 (setq plist (plist-put plist :toname (car adr)))
9946 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9947 (let ((from (plist-get plist :from))
9948 (to (plist-get plist :to)))
9949 (when (and from to org-from-is-user-regexp)
9951 (plist-put plist :fromto
9952 (if (string-match org-from-is-user-regexp from)
9954 (concat "from %f"))))))
9955 (setq org-store-link-plist plist))
9957 (defun org-add-link-props (&rest plist)
9958 "Add these properties to the link property list."
9961 (setq key (pop plist) value (pop plist))
9962 (setq org-store-link-plist
9963 (plist-put org-store-link-plist key value)))))
9965 (defun org-email-link-description (&optional fmt)
9966 "Return the description part of an email link.
9967 This takes information from `org-store-link-plist' and formats it
9968 according to FMT (default from `org-email-link-description-format')."
9969 (setq fmt (or fmt org-email-link-description-format))
9970 (let* ((p org-store-link-plist)
9971 (to (plist-get p :toaddress))
9972 (from (plist-get p :fromaddress))
9975 (cons "%c" (plist-get p :fromto))
9976 (cons "%F" (plist-get p :from))
9977 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9978 (cons "%T" (plist-get p :to))
9979 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9980 (cons "%s" (plist-get p :subject))
9981 (cons "%d" (plist-get p :date))
9982 (cons "%m" (plist-get p :message-id)))))
9983 (when (string-match "%c" fmt)
9984 ;; Check if the user wrote this message
9985 (if (and org-from-is-user-regexp from to
9986 (save-match-data (string-match org-from-is-user-regexp from)))
9987 (setq fmt (replace-match "to %t" t t fmt))
9988 (setq fmt (replace-match "from %f" t t fmt))))
9989 (org-replace-escapes fmt table)))
9991 (defun org-make-org-heading-search-string (&optional string)
9992 "Make search string for the current headline or STRING."
9994 (and (derived-mode-p 'org-mode)
9996 (org-back-to-heading t)
9997 (org-element-property :raw-value (org-element-at-point))))))
9998 (lines org-context-in-file-links))
9999 (or string (setq s (concat "*" s))) ; Add * for headlines
10000 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
10001 (when (and string (integerp lines) (> lines 0))
10002 (let ((slines (org-split-string s "\n")))
10003 (when (< lines (length slines))
10006 (reverse (nthcdr (- (length slines) lines)
10007 (reverse slines))) "\n")))))
10008 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
10010 (defun org-make-link-string (link &optional description)
10011 "Make a link with brackets, consisting of LINK and DESCRIPTION."
10012 (unless (string-match "\\S-" link)
10013 (error "Empty link"))
10014 (when (and description
10015 (stringp description)
10016 (not (string-match "\\S-" description)))
10017 (setq description nil))
10018 (when (stringp description)
10019 ;; Remove brackets from the description, they are fatal.
10020 (while (string-match "\\[" description)
10021 (setq description (replace-match "{" t t description)))
10022 (while (string-match "\\]" description)
10023 (setq description (replace-match "}" t t description))))
10024 (when (equal link description)
10025 ;; No description needed, it is identical
10026 (setq description nil))
10027 (when (and (not description)
10028 (not (string-match (org-image-file-name-regexp) link))
10029 (not (equal link (org-link-escape link))))
10030 (setq description (org-extract-attributes link)))
10032 (cond ((string-match (org-image-file-name-regexp) link) link)
10033 ((string-match org-link-types-re link)
10034 (concat (match-string 1 link)
10035 (org-link-escape (substring link (match-end 1)))))
10036 (t (org-link-escape link))))
10037 (concat "[[" link "]"
10038 (if description (concat "[" description "]") "")
10041 (defconst org-link-escape-chars
10044 "List of characters that should be escaped in a link when stored to Org.
10045 This is the list that is used for internal purposes.")
10047 (defconst org-link-escape-chars-browser
10050 "List of characters to be escaped before handing over to the browser.
10051 If you consider using this constant then you probably want to use
10052 the function `org-link-escape-browser' instead. See there why
10053 this constant is a candidate to be removed once Org drops support
10054 for Emacs 24.1 and 24.2.")
10056 (defun org-link-escape (text &optional table merge)
10057 "Return percent escaped representation of TEXT.
10058 TEXT is a string with the text to escape.
10059 Optional argument TABLE is a list with characters that should be
10060 escaped. When nil, `org-link-escape-chars' is used.
10061 If optional argument MERGE is set, merge TABLE into
10062 `org-link-escape-chars'."
10063 ;; Don't escape chars in internal links
10064 (if (string-match "^\\*[[:alnum:]]+" text)
10068 (mapc (lambda (defchr)
10069 (unless (member defchr table)
10070 (setq table (cons defchr table))))
10071 org-link-escape-chars))
10073 (setq table org-link-escape-chars)))
10076 (if (or (member char table)
10077 (and (or (< char 32) (= char ?\%) (> char 126))
10079 (mapconcat (lambda (sequence-element)
10080 (format "%%%.2X" sequence-element))
10081 (or (encode-coding-char char 'utf-8)
10082 (error "Unable to percent escape character: %s"
10083 (char-to-string char))) "")
10084 (char-to-string char))) text "")))
10086 (defun org-link-escape-browser (text)
10087 "Escape some characters before handing over to the browser.
10088 This function is a candidate to be removed together with the
10089 constant `org-link-escape-chars-browser' once Org drops support
10090 for Emacs 24.1 and 24.2. All calls to this function will have to
10091 be replaced with `url-encode-url' which is available since Emacs
10093 ;; Example with the Org link
10094 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10095 ;; to open the browser with +subject:"Release 8.2" filled into the
10096 ;; query field: In this case the variable TEXT contains the
10097 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10098 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10099 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10100 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10101 (if (fboundp 'url-encode-url)
10102 (url-encode-url text)
10103 (if (org-string-match-p
10104 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10106 (org-link-escape text org-link-escape-chars-browser)
10109 (defun org-link-unescape (str)
10110 "Unhex hexified Unicode strings as returned from the JavaScript function
10111 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10112 (unless (and (null str) (string= "" str))
10113 (let ((pos 0) (case-fold-search t) unhexed)
10114 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10115 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10116 (setq str (replace-match unhexed t t str))
10117 (setq pos (+ pos (length unhexed))))))
10120 (defun org-link-unescape-compound (hex)
10121 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10122 Note: this function also decodes single byte encodings like
10123 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10125 (let* ((bytes (cdr (split-string hex "%")))
10130 (let* ((val (string-to-number (pop bytes) 16))
10134 ((>= val 252) (cons 6 252))
10135 ((>= val 248) (cons 5 248))
10136 ((>= val 240) (cons 4 240))
10137 ((>= val 224) (cons 3 224))
10138 ((>= val 192) (cons 2 192))
10141 (if (>= val 192) (setq eat (car shift-xor)))
10142 (setq val (logxor val (cdr shift-xor)))
10143 (setq sum (+ (lsh sum (car shift-xor)) val))
10144 (if (> eat 0) (setq eat (- eat 1)))
10146 ((= 0 eat) ;multi byte
10147 (setq ret (concat ret (org-char-to-string sum)))
10149 ((not bytes) ; single byte(s)
10150 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10153 (defun org-link-unescape-single-byte-sequence (hex)
10154 "Unhexify hex-encoded single byte character sequences."
10155 (mapconcat (lambda (byte)
10156 (char-to-string (string-to-number byte 16)))
10157 (cdr (split-string hex "%")) ""))
10159 (defun org-xor (a b)
10163 (defun org-fixup-message-id-for-http (s)
10164 "Replace special characters in a message id, so it can be used in an http query."
10165 (when (string-match "%" s)
10166 (setq s (mapconcat (lambda (c)
10169 (char-to-string c)))
10171 (while (string-match "<" s)
10172 (setq s (replace-match "%3C" t t s)))
10173 (while (string-match ">" s)
10174 (setq s (replace-match "%3E" t t s)))
10175 (while (string-match "@" s)
10176 (setq s (replace-match "%40" t t s)))
10179 (defun org-link-prettify (link)
10180 "Return a human-readable representation of LINK.
10181 The car of LINK must be a raw link.
10182 The cdr of LINK must be either a link description or nil."
10183 (let ((desc (or (cadr link) "<no description>")))
10184 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10185 "<" (car link) ">")))
10188 (defun org-insert-link-global ()
10189 "Insert a link like Org-mode does.
10190 This command can be called in any mode to insert a link in Org-mode syntax."
10192 (org-load-modules-maybe)
10193 (org-run-like-in-org-mode 'org-insert-link))
10195 (defun org-insert-all-links (arg &optional pre post)
10196 "Insert all links in `org-stored-links'.
10197 When a universal prefix, do not delete the links from `org-stored-links'.
10198 When `ARG' is a number, insert the last N link(s).
10199 `PRE' and `POST' are optional arguments to define a string to
10200 prepend or to append."
10202 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10203 (links (copy-seq org-stored-links))
10205 (po (or post "\n"))
10207 (if (null org-stored-links)
10208 (message "No link to insert")
10209 (while (and (or (listp arg) (>= arg cnt))
10210 (setq l (if (listp arg)
10212 (pop org-stored-links))))
10213 (setq cnt (1+ cnt))
10215 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10218 (defun org-insert-last-stored-link (arg)
10219 "Insert the last link stored in `org-stored-links'."
10221 (org-insert-all-links arg "" "\n"))
10223 (defun org-link-fontify-links-to-this-file ()
10224 "Fontify links to the current file in `org-stored-links'."
10225 (let ((f (buffer-file-name)) a b)
10226 (setq a (mapcar (lambda(l)
10227 (let ((ll (car l)))
10228 (when (and (string-match "^file:\\(.+\\)::" ll)
10229 (equal f (expand-file-name (match-string 1 ll))))
10232 (when (featurep 'org-id)
10233 (setq b (mapcar (lambda(l)
10234 (let ((ll (car l)))
10235 (when (and (string-match "^id:\\(.+\\)$" ll)
10236 (equal f (expand-file-name
10237 (or (org-id-find-id-file
10238 (match-string 1 ll)) ""))))
10240 org-stored-links)))
10242 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10243 (delq nil (append a b)))))
10245 (defvar org-link-links-in-this-file nil)
10246 (defun org-insert-link (&optional complete-file link-location default-description)
10247 "Insert a link. At the prompt, enter the link.
10249 Completion can be used to insert any of the link protocol prefixes like
10250 http or ftp in use.
10252 The history can be used to select a link previously stored with
10253 `org-store-link'. When the empty string is entered (i.e. if you just
10254 press RET at the prompt), the link defaults to the most recently
10255 stored link. As SPC triggers completion in the minibuffer, you need to
10256 use M-SPC or C-q SPC to force the insertion of a space character.
10258 You will also be prompted for a description, and if one is given, it will
10259 be displayed in the buffer instead of the link.
10261 If there is already a link at point, this command will allow you to edit link
10262 and description parts.
10264 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10265 be selected using completion. The path to the file will be relative to the
10266 current directory if the file is in the current directory or a subdirectory.
10267 Otherwise, the link will be the absolute path as completed in the minibuffer
10268 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10269 option `org-link-file-path-type'.
10271 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10272 the current directory or below.
10274 With three \\[universal-argument] prefixes, negate the meaning of
10275 `org-keep-stored-link-after-insertion'.
10277 If `org-make-link-description-function' is non-nil, this function will be
10278 called with the link target, and the result will be the default
10281 If the LINK-LOCATION parameter is non-nil, this value will be
10282 used as the link location instead of reading one interactively.
10284 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10285 be used as the default description."
10287 (let* ((wcf (current-window-configuration))
10288 (origbuf (current-buffer))
10289 (region (if (org-region-active-p)
10290 (buffer-substring (region-beginning) (region-end))))
10291 (remove (and region (list (region-beginning) (region-end))))
10293 tmphist ; byte-compile incorrectly complains about this
10294 (link link-location)
10295 (abbrevs org-link-abbrev-alist-local)
10296 entry file all-prefixes auto-desc)
10298 (link-location) ; specified by arg, just use it.
10299 ((org-in-regexp org-bracket-link-regexp 1)
10300 ;; We do have a link at point, and we are going to edit it.
10301 (setq remove (list (match-beginning 0) (match-end 0)))
10302 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10303 (setq link (read-string "Link: "
10305 (org-match-string-no-properties 1)))))
10306 ((or (org-in-regexp org-angle-link-re)
10307 (org-in-regexp org-plain-link-re))
10308 ;; Convert to bracket link
10309 (setq remove (list (match-beginning 0) (match-end 0))
10310 link (read-string "Link: "
10311 (org-remove-angle-brackets (match-string 0)))))
10312 ((member complete-file '((4) (16)))
10313 ;; Completing read for file names.
10314 (setq link (org-file-complete-link complete-file)))
10316 ;; Read link, with completion for stored links.
10317 (org-link-fontify-links-to-this-file)
10318 (org-switch-to-buffer-other-window "*Org Links*")
10319 (with-current-buffer "*Org Links*"
10321 (insert "Insert a link.
10322 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10323 (when org-stored-links
10324 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10325 (insert (mapconcat 'org-link-prettify
10326 (reverse org-stored-links) "\n")))
10327 (goto-char (point-min)))
10328 (let ((cw (selected-window)))
10329 (select-window (get-buffer-window "*Org Links*" 'visible))
10330 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10331 (unless (pos-visible-in-window-p (point-max))
10332 (org-fit-window-to-buffer))
10333 (and (window-live-p cw) (select-window cw)))
10334 ;; Fake a link history, containing the stored links.
10335 (setq tmphist (append (mapcar 'car org-stored-links)
10336 org-insert-link-history))
10337 (setq all-prefixes (append (mapcar 'car abbrevs)
10338 (mapcar 'car org-link-abbrev-alist)
10343 (org-completing-read
10346 (mapcar (lambda (x) (concat x ":"))
10348 (mapcar 'car org-stored-links))
10351 (caar org-stored-links)))
10352 (if (not (string-match "\\S-" link))
10353 (user-error "No link selected"))
10355 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10357 (if (or (member link all-prefixes)
10358 (and (equal ":" (substring link -1))
10359 (member (substring link 0 -1) all-prefixes)
10360 (setq link (substring link 0 -1))))
10361 (setq link (with-current-buffer origbuf
10362 (org-link-try-special-completion link)))))
10363 (set-window-configuration wcf)
10364 (kill-buffer "*Org Links*"))
10365 (setq entry (assoc link org-stored-links))
10366 (or entry (push link org-insert-link-history))
10367 (setq desc (or desc (nth 1 entry)))))
10369 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10370 (not org-keep-stored-link-after-insertion))
10371 (setq org-stored-links (delq (assoc link org-stored-links)
10372 org-stored-links)))
10374 (if (and (string-match org-plain-link-re link)
10375 (not (string-match org-ts-regexp link)))
10376 ;; URL-like link, normalize the use of angular brackets.
10377 (setq link (org-remove-angle-brackets link)))
10379 ;; Check if we are linking to the current file with a search
10380 ;; option If yes, simplify the link by using only the search
10382 (when (and buffer-file-name
10383 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10384 (let* ((path (match-string 1 link))
10385 (case-fold-search nil)
10386 (search (match-string 2 link)))
10388 (if (equal (file-truename buffer-file-name) (file-truename path))
10389 ;; We are linking to this same file, with a search option
10390 (setq link search)))))
10392 ;; Check if we can/should use a relative path. If yes, simplify the link
10393 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10394 (let* ((type (match-string 1 link))
10395 (path (match-string 2 link))
10397 (case-fold-search nil))
10399 ((or (eq org-link-file-path-type 'absolute)
10400 (equal complete-file '(16)))
10401 (setq path (abbreviate-file-name (expand-file-name path))))
10402 ((eq org-link-file-path-type 'noabbrev)
10403 (setq path (expand-file-name path)))
10404 ((eq org-link-file-path-type 'relative)
10405 (setq path (file-relative-name path)))
10408 (if (string-match (concat "^" (regexp-quote
10410 (file-name-as-directory
10411 default-directory))))
10412 (expand-file-name path))
10413 ;; We are linking a file with relative path name.
10414 (setq path (substring (expand-file-name path)
10416 (setq path (abbreviate-file-name (expand-file-name path)))))))
10417 (setq link (concat type path))
10418 (if (equal desc origpath)
10419 (setq desc path))))
10421 (if org-make-link-description-function
10423 (or (condition-case nil
10424 (funcall org-make-link-description-function link desc)
10425 (error (progn (message "Can't get link description from `%s'"
10426 (symbol-name org-make-link-description-function))
10428 (read-string "Description: " default-description)))
10429 (if default-description (setq desc default-description)
10430 (setq desc (or (and auto-desc desc)
10431 (read-string "Description: " desc)))))
10433 (unless (string-match "\\S-" desc) (setq desc nil))
10434 (if remove (apply 'delete-region remove))
10435 (insert (org-make-link-string link desc))))
10437 (defun org-link-try-special-completion (type)
10438 "If there is completion support for link type TYPE, offer it."
10439 (let ((fun (intern (concat "org-" type "-complete-link"))))
10440 (if (functionp fun)
10442 (read-string "Link (no completion support): " (concat type ":")))))
10444 (defun org-file-complete-link (&optional arg)
10445 "Create a file link using completion."
10446 (let ((file (org-iread-file-name "File: "))
10447 (pwd (file-name-as-directory (expand-file-name ".")))
10448 (pwd1 (file-name-as-directory (abbreviate-file-name
10449 (expand-file-name ".")))))
10450 (cond ((equal arg '(16))
10452 (abbreviate-file-name (expand-file-name file))))
10454 (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10455 (concat "file:" (match-string 1 file)))
10457 (concat "^" (regexp-quote pwd) "\\(.+\\)")
10458 (expand-file-name file))
10460 (match-string 1 (expand-file-name file))))
10461 (t (concat "file:" file)))))
10463 (defun org-iread-file-name (&rest args)
10464 "Read-file-name using `ido-mode' speedup if available.
10465 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10466 See `read-file-name' for a description of parameters."
10467 (org-without-partial-completion
10468 (if (and org-completion-use-ido
10469 (fboundp 'ido-read-file-name)
10470 (org-bound-and-true-p ido-mode)
10471 (listp (nth 1 args)))
10472 (let ((ido-enter-matching-directory nil))
10473 (apply #'ido-read-file-name args))
10474 (apply #'read-file-name args))))
10476 (defun org-completing-read (&rest args)
10477 "Completing-read with SPACE being a normal character."
10478 (let ((enable-recursive-minibuffers t)
10479 (minibuffer-local-completion-map
10480 (copy-keymap minibuffer-local-completion-map)))
10481 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10482 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10483 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10484 (apply 'org-icompleting-read args)))
10486 (defun org-completing-read-no-i (&rest args)
10487 (let (org-completion-use-ido org-completion-use-iswitchb)
10488 (apply 'org-completing-read args)))
10490 (defun org-iswitchb-completing-read (prompt choices &rest args)
10491 "Use iswitch as a completing-read replacement to choose from choices.
10492 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10494 (let* ((iswitchb-use-virtual-buffers nil)
10495 (iswitchb-make-buflist-hook
10497 (setq iswitchb-temp-buflist choices))))
10498 (iswitchb-read-buffer prompt)))
10500 (defun org-icompleting-read (&rest args)
10501 "Completing-read using `ido-mode' or `iswitchb' speedups if available.
10502 Should be called like `completing-read'."
10503 (org-without-partial-completion
10504 (if (not (listp (nth 1 args)))
10505 ;; Ido only supports lists as the COLLECTION argument. Use
10506 ;; default completion function when second argument is not
10508 (apply #'completing-read args)
10509 (let ((ido-enter-matching-directory nil))
10510 (apply (cond ((and org-completion-use-ido
10511 (fboundp 'ido-completing-read)
10512 (org-bound-and-true-p ido-mode))
10513 #'ido-completing-read)
10514 ((and org-completion-use-iswitchb
10515 (org-bound-and-true-p iswitchb-mode))
10516 #'org-iswitchb-completing-read)
10517 (t #'completing-read))
10519 (if (org-some #'consp (car args))
10520 (mapcar #'car (pop args))
10524 (defun org-extract-attributes (s)
10525 "Extract the attributes cookie from a string and set as text property."
10526 (let (a attr (start 0) key value)
10528 (when (string-match "{{\\([^}]+\\)}}$" s)
10529 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10530 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10531 (setq key (match-string 1 a) value (match-string 2 a)
10532 start (match-end 0)
10533 attr (plist-put attr (intern key) value))))
10534 (org-add-props s nil 'org-attr attr))
10537 ;;; Opening/following a link
10539 (defvar org-link-search-failed nil)
10541 (defvar org-open-link-functions nil
10542 "Hook for functions finding a plain text link.
10543 These functions must take a single argument, the link content.
10544 They will be called for links that look like [[link text][description]]
10545 when LINK TEXT does not have a protocol like \"http:\" and does not look
10546 like a filename (e.g. \"./blue.png\").
10548 These functions will be called *before* Org attempts to resolve the
10549 link by doing text searches in the current buffer - so if you want a
10550 link \"[[target]]\" to still find \"<<target>>\", your function should
10551 handle this as a special case.
10553 When the function does handle the link, it must return a non-nil value.
10554 If it decides that it is not responsible for this link, it must return
10555 nil to indicate that that Org-mode can continue with other options
10556 like exact and fuzzy text search.")
10558 (defun org-next-link (&optional search-backward)
10559 "Move forward to the next link.
10560 If the link is in hidden text, expose it."
10562 (when (and org-link-search-failed (eq this-command last-command))
10563 (goto-char (point-min))
10564 (message "Link search wrapped back to beginning of buffer"))
10565 (setq org-link-search-failed nil)
10566 (let* ((pos (point))
10568 (a (assoc :link ct))
10569 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10570 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10571 ((looking-at org-any-link-re)
10572 ;; Don't stay stuck at link without an org-link face
10573 (forward-char (if search-backward -1 1))))
10574 (if (funcall srch-fun org-any-link-re nil t)
10576 (goto-char (match-beginning 0))
10577 (if (outline-invisible-p) (org-show-context)))
10579 (setq org-link-search-failed t)
10580 (message "No further link found"))))
10582 (defun org-previous-link ()
10583 "Move backward to the previous link.
10584 If the link is in hidden text, expose it."
10586 (funcall 'org-next-link t))
10588 (defun org-translate-link (s)
10589 "Translate a link string if a translation function has been defined."
10590 (if (and org-link-translation-function
10591 (fboundp org-link-translation-function)
10592 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10594 (setq s (funcall org-link-translation-function
10595 (match-string 1 s) (match-string 2 s)))
10596 (concat (car s) ":" (cdr s)))
10599 (defun org-translate-link-from-planner (type path)
10600 "Translate a link from Emacs Planner syntax so that Org can follow it.
10601 This is still an experimental function, your mileage may vary."
10603 ((member type '("http" "https" "news" "ftp"))
10604 ;; standard Internet links are the same.
10606 ((and (equal type "irc") (string-match "^//" path))
10607 ;; Planner has two / at the beginning of an irc link, we have 1.
10608 ;; We should have zero, actually....
10609 (setq path (substring path 1)))
10610 ((and (equal type "lisp") (string-match "^/" path))
10611 ;; Planner has a slash, we do not.
10612 (setq type "elisp" path (substring path 1)))
10613 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10614 ;; A typical message link. Planner has the id after the final slash,
10615 ;; we separate it with a hash mark
10616 (setq path (concat (match-string 1 path) "#"
10617 (org-remove-angle-brackets (match-string 2 path))))))
10620 (defun org-find-file-at-mouse (ev)
10621 "Open file link or URL at mouse."
10623 (mouse-set-point ev)
10624 (org-open-at-point 'in-emacs))
10626 (defun org-open-at-mouse (ev)
10627 "Open file link or URL at mouse.
10628 See the docstring of `org-open-file' for details."
10630 (mouse-set-point ev)
10631 (if (eq major-mode 'org-agenda-mode)
10632 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10633 (org-open-at-point))
10635 (defvar org-window-config-before-follow-link nil
10636 "The window configuration before following a link.
10637 This is saved in case the need arises to restore it.")
10639 (defvar org-open-link-marker (make-marker)
10640 "Marker pointing to the location where `org-open-at-point' was called.")
10643 (defun org-open-at-point-global ()
10644 "Follow a link like Org-mode does.
10645 This command can be called in any mode to follow a link that has
10648 (org-run-like-in-org-mode 'org-open-at-point))
10651 (defun org-open-link-from-string (s &optional arg reference-buffer)
10652 "Open a link in the string S, as if it was in Org-mode."
10653 (interactive "sLink: \nP")
10654 (let ((reference-buffer (or reference-buffer (current-buffer))))
10656 (let ((org-inhibit-startup (not reference-buffer)))
10659 (goto-char (point-min))
10660 (when reference-buffer
10661 (setq org-link-abbrev-alist-local
10662 (with-current-buffer reference-buffer
10663 org-link-abbrev-alist-local)))
10664 (org-open-at-point arg reference-buffer)))))
10666 (defvar org-open-at-point-functions nil
10667 "Hook that is run when following a link at point.
10669 Functions in this hook must return t if they identify and follow
10670 a link at point. If they don't find anything interesting at point,
10671 they must return nil.")
10673 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10674 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10675 (defun org-open-at-point (&optional arg reference-buffer)
10676 "Open link, timestamp, footnote or tags at point.
10678 When point is on a link, follow it. Normally, files will be
10679 opened by an appropriate application. If the optional prefix
10680 argument ARG is non-nil, Emacs will visit the file. With
10681 a double prefix argument, try to open outside of Emacs, in the
10682 application the system uses for this file type.
10684 When point is on a timestamp, open the agenda at the day
10687 When point is a footnote definition, move to the first reference
10688 found. If it is on a reference, move to the associated
10691 When point is on a headline, display a list of every link in the
10692 entry, so it is possible to pick one, or all, of them. If point
10693 is on a tag, call `org-tags-view' instead.
10695 When optional argument REFERENCE-BUFFER is non-nil, it should
10696 specify a buffer from where the link search should happen. This
10697 is used internally by `org-open-link-from-string'.
10699 On top of syntactically correct links, this function will open
10700 the link at point in comments or comment blocks and the first
10701 link in a property drawer line."
10703 ;; On a code block, open block's results.
10704 (unless (call-interactively 'org-babel-open-src-block-result)
10705 (org-load-modules-maybe)
10706 (move-marker org-open-link-marker (point))
10707 (setq org-window-config-before-follow-link (current-window-configuration))
10708 (org-remove-occur-highlights nil nil t)
10709 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10711 ;; Only consider supported types, even if they are not
10712 ;; the closest one.
10713 (org-element-lineage
10714 (org-element-context)
10715 '(comment comment-block footnote-definition footnote-reference
10716 headline inlinetask keyword link node-property
10719 (type (org-element-type context))
10720 (value (org-element-property :value context)))
10722 ((not context) (user-error "No link found"))
10723 ;; Exception: open timestamps and links in properties
10724 ;; drawers, keywords and comments.
10725 ((memq type '(comment comment-block keyword node-property))
10726 (cond ((org-in-regexp org-any-link-re)
10727 (org-open-link-from-string (match-string-no-properties 0)))
10728 ((or (org-at-timestamp-p t) (org-at-date-range-p t))
10729 (org-follow-timestamp-link))
10730 (t (user-error "No link found"))))
10731 ;; On a headline or an inlinetask, but not on a timestamp,
10732 ;; a link, a footnote reference or on tags.
10733 ((and (memq type '(headline inlinetask))
10735 (progn (save-excursion (beginning-of-line)
10736 (looking-at org-complex-heading-regexp))
10737 (or (not (match-beginning 5))
10738 (< (point) (match-beginning 5)))))
10739 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10741 (links-end (cdr data)))
10743 (dolist (link (if (stringp links) (list links) links))
10744 (search-forward link nil links-end)
10745 (goto-char (match-beginning 0))
10746 (org-open-at-point))
10747 (require 'org-attach)
10748 (org-attach-reveal 'if-exists))))
10749 ;; Do nothing on white spaces after an object, unless point
10750 ;; is right after it.
10753 (goto-char (org-element-property :end context))
10754 (skip-chars-backward " \t")
10756 (user-error "No link found"))
10757 ((eq type 'timestamp) (org-follow-timestamp-link))
10758 ;; On tags within a headline or an inlinetask.
10759 ((and (memq type '(headline inlinetask))
10760 (progn (save-excursion (beginning-of-line)
10761 (looking-at org-complex-heading-regexp))
10762 (and (match-beginning 5)
10763 (>= (point) (match-beginning 5)))))
10764 (org-tags-view arg (substring (match-string 5) 0 -1)))
10766 ;; When link is located within the description of another
10767 ;; link (e.g., an inline image), always open the parent
10769 (let*((link (let ((up (org-element-property :parent context)))
10770 (if (eq (org-element-type up) 'link) up context)))
10771 (type (org-element-property :type link))
10772 (path (org-link-unescape (org-element-property :path link))))
10773 ;; Switch back to REFERENCE-BUFFER needed when called in
10774 ;; a temporary buffer through `org-open-link-from-string'.
10775 (with-current-buffer (or reference-buffer (current-buffer))
10777 ((equal type "file")
10778 (if (string-match "[*?{]" (file-name-nondirectory path))
10780 ;; Look into `org-link-protocols' in order to find
10781 ;; a DEDICATED-FUNCTION to open file. The function
10782 ;; will be applied on raw link instead of parsed
10783 ;; link due to the limitation in `org-add-link-type'
10784 ;; ("open" function called with a single argument).
10785 ;; If no such function is found, fallback to
10786 ;; `org-open-file'.
10788 ;; Note : "file+emacs" and "file+sys" types are
10789 ;; hard-coded in order to escape the previous
10791 (let* ((option (org-element-property :search-option link))
10792 (app (org-element-property :application link))
10793 (dedicated-function
10794 (nth 1 (assoc app org-link-protocols))))
10795 (if dedicated-function
10796 (funcall dedicated-function
10798 (and option (concat "::" option))))
10799 (apply 'org-open-file
10802 ((equal app "emacs") 'emacs)
10803 ((equal app "sys") 'system))
10804 (cond ((not option) nil)
10805 ((org-string-match-p "\\`[0-9]+\\'" option)
10806 (list (string-to-number option)))
10808 (org-link-unescape option)))))))))
10809 ((assoc type org-link-protocols)
10810 (funcall (nth 1 (assoc type org-link-protocols)) path))
10811 ((equal type "help")
10812 (let ((f-or-v (intern path)))
10813 (cond ((fboundp f-or-v) (describe-function f-or-v))
10814 ((boundp f-or-v) (describe-variable f-or-v))
10815 (t (error "Not a known function or variable")))))
10816 ((member type '("http" "https" "ftp" "mailto" "news"))
10817 (browse-url (org-link-escape-browser (concat type ":" path))))
10818 ((equal type "doi")
10820 (org-link-escape-browser (concat org-doi-server-url path))))
10821 ((equal type "message") (browse-url (concat type ":" path)))
10822 ((equal type "shell")
10823 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10825 (if (or (and (org-string-nw-p
10826 org-confirm-shell-link-not-regexp)
10828 org-confirm-shell-link-not-regexp cmd))
10829 (not org-confirm-shell-link-function)
10830 (funcall org-confirm-shell-link-function
10831 (format "Execute \"%s\" in shell? "
10832 (org-add-props cmd nil
10833 'face 'org-warning))))
10835 (message "Executing %s" cmd)
10836 (shell-command cmd buf)
10837 (when (featurep 'midnight)
10838 (setq clean-buffer-list-kill-buffer-names
10840 clean-buffer-list-kill-buffer-names))))
10841 (user-error "Abort"))))
10842 ((equal type "elisp")
10844 (if (or (and (org-string-nw-p
10845 org-confirm-elisp-link-not-regexp)
10846 (org-string-match-p
10847 org-confirm-elisp-link-not-regexp cmd))
10848 (not org-confirm-elisp-link-function)
10849 (funcall org-confirm-elisp-link-function
10850 (format "Execute \"%s\" as elisp? "
10851 (org-add-props cmd nil
10852 'face 'org-warning))))
10853 (message "%s => %s" cmd
10854 (if (eq (string-to-char cmd) ?\()
10856 (call-interactively (read cmd))))
10857 (user-error "Abort"))))
10860 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10861 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10862 (unless (run-hook-with-args-until-success
10863 'org-open-link-functions path)
10864 (if (not arg) (org-mark-ring-push)
10865 (switch-to-buffer-other-window
10866 (org-get-buffer-for-internal-link (current-buffer))))
10867 (let ((cmd `(org-link-search
10868 ,(if (member type '("custom-id" "coderef"))
10869 (org-element-property :raw-link link)
10871 ,(cond ((equal arg '(4)) 'occur)
10872 ((equal arg '(16)) 'org-occur))
10873 ,(org-element-property :begin link))))
10874 (condition-case nil
10875 (let ((org-link-search-inhibit-query t))
10877 (error (progn (widen) (eval cmd)))))))
10878 (t (browse-url-at-point))))))
10879 ;; On a footnote reference or at a footnote definition's label.
10880 ((or (eq type 'footnote-reference)
10881 (and (eq type 'footnote-definition)
10883 ;; Do not validate action when point is on the
10884 ;; spaces right after the footnote label, in
10885 ;; order to be on par with behaviour on links.
10886 (skip-chars-forward " \t")
10888 (org-element-property :contents-begin context)))
10889 (if begin (< (point) begin)
10890 (= (org-element-property :post-affiliated context)
10891 (line-beginning-position)))))))
10892 (org-footnote-action))
10893 (t (user-error "No link found")))))
10894 (move-marker org-open-link-marker nil)
10895 (run-hook-with-args 'org-follow-link-hook)))
10897 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10898 "Offer links in the current entry and return the selected link.
10899 If there is only one link, return it.
10900 If NTH is an integer, return the NTH link found.
10901 If ZERO is a string, check also this string for a link, and if
10902 there is one, return it."
10903 (with-current-buffer buffer
10909 (in-emacs (if (integerp nth) nil nth))
10910 have-zero end links link c)
10911 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10912 (push (match-string 0 zero) links)
10913 (setq cnt (1- cnt) have-zero t))
10915 (org-back-to-heading t)
10916 (setq end (save-excursion (outline-next-heading) (point)))
10917 (while (re-search-forward org-any-link-re end t)
10918 (push (match-string 0) links))
10919 (setq links (org-uniquify (reverse links))))
10922 (message "No links"))
10923 ((equal (length links) 1)
10924 (setq link (car links)))
10925 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10926 (setq link (nth (if have-zero nth (1- nth)) links)))
10927 (t ; we have to select a link
10929 (save-window-excursion
10930 (delete-other-windows)
10931 (with-output-to-temp-buffer "*Select Link*"
10933 (if (not (string-match org-bracket-link-regexp l))
10934 (princ (format "[%c] %s\n" (incf cnt)
10935 (org-remove-angle-brackets l)))
10937 (princ (format "[%c] %s (%s)\n" (incf cnt)
10938 (match-string 3 l) (match-string 1 l)))
10939 (princ (format "[%c] %s\n" (incf cnt)
10940 (match-string 1 l))))))
10942 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10943 (message "Select link to open, RET to open all:")
10944 (setq c (read-char-exclusive))
10945 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10946 (when (equal c ?q) (user-error "Abort"))
10947 (if (equal c ?\C-m)
10949 (setq nth (- c ?0))
10950 (if have-zero (setq nth (1+ nth)))
10951 (unless (and (integerp nth) (>= (length links) nth))
10952 (user-error "Invalid link selection"))
10953 (setq link (nth (1- nth) links)))))
10954 (cons link end))))))
10956 ;; TODO: These functions are deprecated since `org-open-at-point'
10957 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10958 (defun org-open-file-with-system (path)
10959 "Open file at PATH using the system way of opening it."
10960 (org-open-file path 'system))
10961 (defun org-open-file-with-emacs (path)
10962 "Open file at PATH in Emacs."
10963 (org-open-file path 'emacs))
10968 (defvar org-create-file-search-functions nil
10969 "List of functions to construct the right search string for a file link.
10970 These functions are called in turn with point at the location to
10971 which the link should point.
10973 A function in the hook should first test if it would like to
10974 handle this file type, for example by checking the `major-mode'
10975 or the file extension. If it decides not to handle this file, it
10976 should just return nil to give other functions a chance. If it
10977 does handle the file, it must return the search string to be used
10978 when following the link. The search string will be part of the
10979 file link, given after a double colon, and `org-open-at-point'
10980 will automatically search for it. If special measures must be
10981 taken to make the search successful, another function should be
10982 added to the companion hook `org-execute-file-search-functions',
10985 A function in this hook may also use `setq' to set the variable
10986 `description' to provide a suggestion for the descriptive text to
10987 be used for this link when it gets inserted into an Org-mode
10988 buffer with \\[org-insert-link].")
10990 (defvar org-execute-file-search-functions nil
10991 "List of functions to execute a file search triggered by a link.
10993 Functions added to this hook must accept a single argument, the
10994 search string that was part of the file link, the part after the
10995 double colon. The function must first check if it would like to
10996 handle this search, for example by checking the `major-mode' or
10997 the file extension. If it decides not to handle this search, it
10998 should just return nil to give other functions a chance. If it
10999 does handle the search, it must return a non-nil value to keep
11000 other functions from trying.
11002 Each function can access the current prefix argument through the
11003 variable `current-prefix-arg'. Note that a single prefix is used
11004 to force opening a link in Emacs, so it may be good to only use a
11005 numeric or double prefix to guide the search function.
11007 In case this is needed, a function in this hook can also restore
11008 the window configuration before `org-open-at-point' was called using:
11010 (set-window-configuration org-window-config-before-follow-link)")
11012 (defun org-link-search (s &optional type avoid-pos stealth)
11013 "Search for a link search option.
11014 If S is surrounded by forward slashes, it is interpreted as a
11015 regular expression. In org-mode files, this will create an `org-occur'
11016 sparse tree. In ordinary files, `occur' will be used to list matches.
11017 If the current buffer is in `dired-mode', grep will be used to search
11018 in all files. If AVOID-POS is given, ignore matches near that position.
11020 When optional argument STEALTH is non-nil, do not modify
11021 visibility around point, thus ignoring `org-show-context-detail'
11023 (let ((case-fold-search t)
11024 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
11025 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
11026 (append '(("") (" ") ("\t") ("\n"))
11027 org-emphasis-alist)
11030 words re0 re2 re4_ re4 re5 re2a re2a_ reall)
11032 ;; First check if there are any special search functions
11033 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
11034 ;; Now try the builtin stuff
11035 ((and (eq (aref s0 0) ?#)
11037 (let ((match (org-find-property "CUSTOM_ID" (substring s0 1))))
11038 (and match (goto-char match) (setf type 'dedicated)))))
11040 (goto-char (point-min))
11043 (concat "<<" (regexp-quote s0) ">>") nil t)
11044 (setq type 'dedicated
11045 pos (match-beginning 0))))
11046 ;; There is an exact target for this
11049 (goto-char (point-min))
11052 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11053 (setq type 'dedicated pos (match-beginning 0))))
11054 ;; Found an element with a matching #+name affiliated keyword.
11056 ((and (string-match "^(\\(.*\\))$" s0)
11058 (goto-char (point-min))
11061 (concat "[^[]" (regexp-quote
11062 (format org-coderef-label-format
11063 (match-string 1 s0))))
11065 (setq type 'dedicated
11066 pos (1+ (match-beginning 0))))))
11067 ;; There is a coderef target for this
11069 ((string-match "^/\\(.*\\)/$" s)
11070 ;; A regular expression
11072 ((derived-mode-p 'org-mode)
11073 (org-occur (match-string 1 s)))
11074 (t (org-do-occur (match-string 1 s)))))
11075 ((and (derived-mode-p 'org-mode)
11076 (or (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11077 org-link-search-must-match-exact-headline))
11078 ;; Headline search.
11079 (goto-char (point-min))
11081 ((let (case-fold-search)
11083 (let* ((wspace "[ \t]")
11084 (wspaceopt (concat wspace "*"))
11085 (cookie (concat "\\(?:"
11087 "\\[[0-9]*\\(?:%\\|/[0-9]*\\)\\]"
11090 (sep (concat "\\(?:" wspace "+\\|" cookie "+\\)")))
11092 org-outline-regexp-bol
11093 "\\(?:" org-todo-regexp "[ \t]+\\)?"
11094 "\\(?:\\[#.\\][ \t]+\\)?"
11095 "\\(?:" org-comment-string "[ \t]+\\)?"
11097 (mapconcat #'identity
11098 (org-split-string (regexp-quote s))
11101 (org-re "\\(?:[ \t]+:[[:alnum:]_@#%%:]+:\\)?")
11104 ;; OK, found a match
11105 (setq type 'dedicated)
11106 (goto-char (match-beginning 0)))
11107 ((and (not org-link-search-inhibit-query)
11108 (eq org-link-search-must-match-exact-headline 'query-to-create)
11109 (y-or-n-p "No match - create this as a new heading? "))
11110 (goto-char (point-max))
11111 (unless (bolp) (newline))
11112 (org-insert-heading nil t t)
11114 (beginning-of-line 0))
11117 (error "No match"))))
11119 ;; A normal search string
11120 (remove-text-properties
11122 '(face nil mouse-face nil keymap nil fontified nil) s)
11123 ;; Make a series of regular expressions to find a match
11124 (setq words (org-split-string s "[ \n\r\t]+")
11126 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11127 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11129 re2a_ (concat "\\(" (mapconcat 'downcase words
11130 "[ \t\r\n]+") "\\)[ \t\r\n]")
11131 re2a (concat "[ \t\r\n]" re2a_)
11132 re4_ (concat "\\(" (mapconcat 'downcase words
11133 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11134 re4 (concat "[^a-zA-Z_]" re4_)
11136 re5 (concat ".*" re4)
11137 reall (concat "\\(" re0 "\\)\\|\\(" re2 "\\)\\|\\(" re4
11138 "\\)\\|\\(" re5 "\\)"))
11140 ((eq type 'org-occur) (org-occur reall))
11141 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11142 (t (goto-char (point-min))
11144 (if (or (and (org-search-not-self 1 re0 nil t)
11145 (setq type 'dedicated))
11146 (org-search-not-self 1 re2 nil t)
11147 (org-search-not-self 1 re2a nil t)
11148 (org-search-not-self 1 re4 nil t)
11149 (org-search-not-self 1 re5 nil t))
11150 (goto-char (match-beginning 1))
11152 (error "No match"))))))
11153 (and (derived-mode-p 'org-mode)
11155 (org-show-context 'link-search))
11158 (defun org-search-not-self (group &rest args)
11159 "Execute `re-search-forward', but only accept matches that do not
11160 enclose the position of `org-open-link-marker'."
11161 (let ((m org-open-link-marker))
11163 (while (apply 're-search-forward args)
11164 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11165 (goto-char (match-end group))
11166 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11167 (> (match-beginning 0) (marker-position m))
11168 (< (match-end 0) (marker-position m)))
11170 (or (not (org-in-regexp
11171 org-bracket-link-analytic-regexp 1))
11172 (not (match-end 4)) ; no description
11173 (and (<= (match-beginning 4) (point))
11174 (>= (match-end 4) (point))))))
11175 (throw 'exit (point))))))))
11177 (defun org-get-buffer-for-internal-link (buffer)
11178 "Return a buffer to be used for displaying the link target of internal links."
11180 ((not org-display-internal-link-with-indirect-buffer)
11182 ((string-match "(Clone)$" (buffer-name buffer))
11183 (message "Buffer is already a clone, not making another one")
11184 ;; we also do not modify visibility in this case
11186 (t ; make a new indirect buffer for displaying the link
11187 (let* ((bn (buffer-name buffer))
11188 (ibn (concat bn "(Clone)"))
11189 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11190 (with-current-buffer ib (org-overview))
11193 (defun org-do-occur (regexp &optional cleanup)
11194 "Call the Emacs command `occur'.
11195 If CLEANUP is non-nil, remove the printout of the regular expression
11196 in the *Occur* buffer. This is useful if the regex is long and not useful
11200 (let ((cwin (selected-window)) win beg end)
11201 (when (setq win (get-buffer-window "*Occur*"))
11202 (select-window win))
11203 (goto-char (point-min))
11204 (when (re-search-forward "match[a-z]+" nil t)
11205 (setq beg (match-end 0))
11206 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11207 (setq end (1- (match-beginning 0)))))
11208 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11209 (goto-char (point-min))
11210 (select-window cwin))))
11212 ;;; The mark ring for links jumps
11214 (defvar org-mark-ring nil
11215 "Mark ring for positions before jumps in Org-mode.")
11216 (defvar org-mark-ring-last-goto nil
11217 "Last position in the mark ring used to go back.")
11218 ;; Fill and close the ring
11219 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11220 (loop for i from 1 to org-mark-ring-length do
11221 (push (make-marker) org-mark-ring))
11222 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11225 (defun org-mark-ring-push (&optional pos buffer)
11226 "Put the current position or POS into the mark ring and rotate it."
11228 (setq pos (or pos (point)))
11229 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11230 (move-marker (car org-mark-ring)
11232 (or buffer (current-buffer)))
11234 (substitute-command-keys
11235 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11237 (defun org-mark-ring-goto (&optional n)
11238 "Jump to the previous position in the mark ring.
11239 With prefix arg N, jump back that many stored positions. When
11240 called several times in succession, walk through the entire ring.
11241 Org-mode commands jumping to a different position in the current file,
11242 or to another Org-mode file, automatically push the old position
11246 (if (eq last-command this-command)
11247 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11248 (setq p org-mark-ring))
11249 (setq org-mark-ring-last-goto p)
11251 (org-pop-to-buffer-same-window (marker-buffer m))
11253 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11255 (defun org-remove-angle-brackets (s)
11256 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11257 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11259 (defun org-add-angle-brackets (s)
11260 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11261 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11263 (defun org-remove-double-quotes (s)
11264 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11265 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11268 ;;; Following specific links
11270 (defun org-follow-timestamp-link ()
11271 "Open an agenda view for the time-stamp date/range at point."
11273 ((org-at-date-range-p t)
11274 (let ((org-agenda-start-on-weekday)
11275 (t1 (match-string 1))
11276 (t2 (match-string 2)) tt1 tt2)
11277 (setq tt1 (time-to-days (org-time-string-to-time t1))
11278 tt2 (time-to-days (org-time-string-to-time t2)))
11279 (let ((org-agenda-buffer-tmp-name
11280 (format "*Org Agenda(a:%s)"
11281 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11282 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11283 ((org-at-timestamp-p t)
11284 (let ((org-agenda-buffer-tmp-name
11285 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11286 (org-agenda-list nil (time-to-days (org-time-string-to-time
11287 (substring (match-string 1) 0 10)))
11289 (t (error "This should not happen"))))
11292 ;;; Following file links
11293 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11294 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11295 (declare-function mailcap-mime-info
11296 "mailcap" (string &optional request no-decode))
11297 (defvar org-wait nil)
11298 (defun org-open-file (path &optional in-emacs line search)
11299 "Open the file at PATH.
11300 First, this expands any special file name abbreviations. Then the
11301 configuration variable `org-file-apps' is checked if it contains an
11302 entry for this file type, and if yes, the corresponding command is launched.
11304 If no application is found, Emacs simply visits the file.
11306 With optional prefix argument IN-EMACS, Emacs will visit the file.
11307 With a double \\[universal-argument] \\[universal-argument] \
11308 prefix arg, Org tries to avoid opening in Emacs
11309 and to use an external application to visit the file.
11311 Optional LINE specifies a line to go to, optional SEARCH a string
11312 to search for. If LINE or SEARCH is given, the file will be
11313 opened in Emacs, unless an entry from org-file-apps that makes
11314 use of groups in a regexp matches.
11316 If you want to change the way frames are used when following a
11317 link, please customize `org-link-frame-setup'.
11319 If the file does not exist, an error is thrown."
11320 (let* ((file (if (equal path "")
11322 (substitute-in-file-name (expand-file-name path))))
11323 (file-apps (append org-file-apps (org-default-apps)))
11324 (apps (org-remove-if
11325 'org-file-apps-entry-match-against-dlink-p file-apps))
11326 (apps-dlink (org-remove-if-not
11327 'org-file-apps-entry-match-against-dlink-p file-apps))
11328 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11329 (dirp (if remp nil (file-directory-p file)))
11330 (file (if (and dirp org-open-directory-means-index-dot-org)
11331 (concat (file-name-as-directory file) "index.org")
11333 (a-m-a-p (assq 'auto-mode apps))
11334 (dfile (downcase file))
11335 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11336 (link (cond ((and (eq line nil)
11340 (concat file "::" (number-to-string line)))
11342 (concat file "::" search))))
11343 (dlink (downcase link))
11344 (old-buffer (current-buffer))
11346 (old-mode major-mode)
11347 ext cmd link-match-data)
11348 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11349 (setq ext (match-string 1 dfile))
11350 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11351 (setq ext (match-string 1 dfile))))
11353 ((member in-emacs '((16) system))
11354 (setq cmd (cdr (assoc 'system apps))))
11355 (in-emacs (setq cmd 'emacs))
11357 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11358 (and dirp (cdr (assoc 'directory apps)))
11359 ; first, try matching against apps-dlink
11360 ; if we get a match here, store the match data for later
11361 (let ((match (assoc-default dlink apps-dlink
11364 (progn (setq link-match-data (match-data))
11366 (progn (setq in-emacs (or in-emacs line search))
11367 nil))) ; if we have no match in apps-dlink,
11368 ; always open the file in emacs if line or search
11369 ; is given (for backwards compatibility)
11370 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11372 (cdr (assoc ext apps))
11373 (cdr (assoc t apps))))))
11374 (when (eq cmd 'system)
11375 (setq cmd (cdr (assoc 'system apps))))
11376 (when (eq cmd 'default)
11377 (setq cmd (cdr (assoc t apps))))
11378 (when (eq cmd 'mailcap)
11380 (mailcap-parse-mailcaps)
11381 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11382 (command (mailcap-mime-info mime-type)))
11383 (if (stringp command)
11385 (setq cmd 'emacs))))
11386 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11387 (not (file-exists-p file))
11388 (not org-open-non-existing-files))
11389 (user-error "No such file: %s" file))
11391 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11392 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11393 (while (string-match "['\"]%s['\"]" cmd)
11394 (setq cmd (replace-match "%s" t t cmd)))
11395 (while (string-match "%s" cmd)
11396 (setq cmd (replace-match
11398 (shell-quote-argument
11399 (convert-standard-filename file)))
11402 ;; Replace "%1", "%2" etc. in command with group matches from regex
11404 (let ((match-index 1)
11405 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11406 (set-match-data link-match-data)
11407 (while (<= match-index number-of-groups)
11408 (let ((regex (concat "%" (number-to-string match-index)))
11409 (replace-with (match-string match-index dlink)))
11410 (while (string-match regex cmd)
11411 (setq cmd (replace-match replace-with t t cmd))))
11412 (setq match-index (+ match-index 1)))))
11414 (save-window-excursion
11415 (message "Running %s...done" cmd)
11416 (start-process-shell-command cmd nil cmd)
11417 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11420 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11422 (if line (progn (org-goto-line line)
11423 (if (derived-mode-p 'org-mode)
11425 (if search (org-link-search search))))
11427 (let ((file (convert-standard-filename file)))
11429 (set-match-data link-match-data)
11431 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11432 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11433 (or (not (equal old-buffer (current-buffer)))
11434 (not (equal old-pos (point))))
11435 (org-mark-ring-push old-pos old-buffer))))
11437 (defun org-file-apps-entry-match-against-dlink-p (entry)
11438 "This function returns non-nil if `entry' uses a regular
11439 expression which should be matched against the whole link by
11442 It assumes that is the case when the entry uses a regular
11443 expression which has at least one grouping construct and the
11444 action is either a lisp form or a command string containing
11445 '%1', i.e. using at least one subexpression match as a
11447 (let ((selector (car entry))
11448 (action (cdr entry)))
11449 (if (stringp selector)
11450 (and (> (regexp-opt-depth selector) 0)
11451 (or (and (stringp action)
11452 (string-match "%[0-9]" action))
11456 (defun org-default-apps ()
11457 "Return the default applications for this operating system."
11459 ((eq system-type 'darwin)
11460 org-file-apps-defaults-macosx)
11461 ((eq system-type 'windows-nt)
11462 org-file-apps-defaults-windowsnt)
11463 (t org-file-apps-defaults-gnu)))
11465 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11466 "Convert extensions to regular expressions in the cars of LIST.
11467 Also, weed out any non-string entries, because the return value is used
11468 only for regexp matching.
11469 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11470 point to the symbol `emacs', indicating that the file should
11471 be opened in Emacs."
11474 (mapcar (lambda (x)
11475 (if (not (stringp (car x)))
11477 (if (string-match "\\W" (car x))
11479 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11482 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11484 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11485 (defun org-file-remote-p (file)
11486 "Test whether FILE specifies a location on a remote system.
11487 Return non-nil if the location is indeed remote.
11489 For example, the filename \"/user@host:/foo\" specifies a location
11490 on the system \"/user@host:\"."
11491 (cond ((fboundp 'file-remote-p)
11492 (file-remote-p file))
11493 ((fboundp 'tramp-handle-file-remote-p)
11494 (tramp-handle-file-remote-p file))
11495 ((and (boundp 'ange-ftp-name-format)
11496 (string-match (car ange-ftp-name-format) file))
11502 (defun org-get-org-file ()
11503 "Read a filename, with default directory `org-directory'."
11504 (let ((default (or org-default-notes-file remember-data-file)))
11505 (read-file-name (format "File name [%s]: " default)
11506 (file-name-as-directory org-directory)
11509 (defun org-notes-order-reversed-p ()
11510 "Check if the current file should receive notes in reversed order."
11512 ((not org-reverse-note-order) nil)
11513 ((eq t org-reverse-note-order) t)
11514 ((not (listp org-reverse-note-order)) nil)
11516 (let ((all org-reverse-note-order)
11518 (while (setq entry (pop all))
11519 (if (string-match (car entry) buffer-file-name)
11520 (throw 'exit (cdr entry))))
11523 (defvar org-refile-target-table nil
11524 "The list of refile targets, created by `org-refile'.")
11526 (defvar org-agenda-new-buffers nil
11527 "Buffers created to visit agenda files.")
11529 (defvar org-refile-cache nil
11530 "Cache for refile targets.")
11532 (defvar org-refile-markers nil
11533 "All the markers used for caching refile locations.")
11535 (defun org-refile-marker (pos)
11536 "Get a new refile marker, but only if caching is in use."
11537 (if (not org-refile-use-cache)
11539 (let ((m (make-marker)))
11540 (move-marker m pos)
11541 (push m org-refile-markers)
11544 (defun org-refile-cache-clear ()
11545 "Clear the refile cache and disable all the markers."
11546 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11547 (setq org-refile-markers nil)
11548 (setq org-refile-cache nil)
11549 (message "Refile cache has been cleared"))
11551 (defun org-refile-cache-check-set (set)
11552 "Check if all the markers in the cache still have live buffers."
11555 (while (and set (setq marker (nth 3 (pop set))))
11556 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11557 (when (and marker (null (marker-buffer marker)))
11558 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11560 (throw 'exit nil)))
11563 (defun org-refile-cache-put (set &rest identifiers)
11564 "Push the refile targets SET into the cache, under IDENTIFIERS."
11565 (let* ((key (sha1 (prin1-to-string identifiers)))
11566 (entry (assoc key org-refile-cache)))
11569 (push (cons key set) org-refile-cache))))
11571 (defun org-refile-cache-get (&rest identifiers)
11572 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11574 ((not org-refile-cache) nil)
11575 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11577 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11578 org-refile-cache))))
11579 (and set (org-refile-cache-check-set set) set)))))
11581 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11582 "Produce a table with refile targets."
11583 (let ((case-fold-search nil)
11584 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11585 (entries (or org-refile-targets '((nil . (:level . 1)))))
11586 targets tgs txt re files f desc descre fast-path-p level pos0)
11587 (message "Getting targets...")
11588 (with-current-buffer (or default-buffer (current-buffer))
11589 (while (setq entry (pop entries))
11590 (setq files (car entry) desc (cdr entry))
11591 (setq fast-path-p nil)
11593 ((null files) (setq files (list (current-buffer))))
11594 ((eq files 'org-agenda-files)
11595 (setq files (org-agenda-files 'unrestricted)))
11596 ((and (symbolp files) (fboundp files))
11597 (setq files (funcall files)))
11598 ((and (symbolp files) (boundp files))
11599 (setq files (symbol-value files))))
11600 (if (stringp files) (setq files (list files)))
11602 ((eq (car desc) :tag)
11603 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11604 ((eq (car desc) :todo)
11605 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11606 ((eq (car desc) :regexp)
11607 (setq descre (cdr desc)))
11608 ((eq (car desc) :level)
11609 (setq descre (concat "^\\*\\{" (number-to-string
11610 (if org-odd-levels-only
11611 (1- (* 2 (cdr desc)))
11614 ((eq (car desc) :maxlevel)
11615 (setq fast-path-p t)
11616 (setq descre (concat "^\\*\\{1," (number-to-string
11617 (if org-odd-levels-only
11618 (1- (* 2 (cdr desc)))
11621 (t (error "Bad refiling target description %s" desc)))
11622 (while (setq f (pop files))
11623 (with-current-buffer
11624 (if (bufferp f) f (org-get-agenda-file-buffer f))
11626 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11628 (if (bufferp f) (setq f (buffer-file-name
11629 (buffer-base-buffer f))))
11630 (setq f (and f (expand-file-name f)))
11631 (if (eq org-refile-use-outline-path 'file)
11632 (push (list (file-name-nondirectory f) f nil nil) tgs))
11636 (goto-char (point-min))
11637 (while (re-search-forward descre nil t)
11638 (goto-char (setq pos0 (point-at-bol)))
11640 (when org-refile-target-verify-function
11642 (or (funcall org-refile-target-verify-function)
11644 (when (and (looking-at org-complex-heading-regexp)
11645 (not (member (match-string 4) excluded-entries))
11647 (setq level (org-reduced-level
11648 (- (match-end 1) (match-beginning 1)))
11649 txt (org-link-display-format (match-string 4))
11650 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11651 re (format org-complex-heading-regexp-format
11652 (regexp-quote (match-string 4))))
11653 (when org-refile-use-outline-path
11654 (setq txt (mapconcat
11657 (if (eq org-refile-use-outline-path
11659 (list (file-name-nondirectory
11661 (buffer-base-buffer))))
11662 (if (eq org-refile-use-outline-path
11664 (list (buffer-file-name
11665 (buffer-base-buffer)))))
11666 (org-get-outline-path fast-path-p
11670 (push (list txt f re (org-refile-marker (point)))
11672 (when (= (point) pos0)
11673 ;; verification function has not moved point
11674 (goto-char (point-at-eol))))))))
11675 (when org-refile-use-cache
11676 (org-refile-cache-put tgs (buffer-file-name) descre))
11677 (setq targets (append tgs targets))))))
11678 (message "Getting targets...done")
11679 (nreverse targets)))
11681 (defun org-protect-slash (s)
11682 (while (string-match "/" s)
11683 (setq s (replace-match "\\" t t s)))
11686 (defvar org-olpa (make-vector 20 nil))
11688 (defun org-get-outline-path (&optional fastp level heading)
11689 "Return the outline path to the current entry, as a list.
11691 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11692 routine which makes outline path derivations for an entire file,
11693 avoiding backtracing. Refile target collection makes use of that."
11697 (error "Outline path failure, more than 19 levels"))
11698 (loop for i from level upto 19 do
11699 (aset org-olpa i nil))
11701 (delq nil (append org-olpa nil))
11702 (aset org-olpa level heading)))
11703 (let (rtn case-fold-search)
11707 (while (org-up-heading-safe)
11708 (when (looking-at org-complex-heading-regexp)
11710 (replace-regexp-in-string
11711 ;; Remove statistical/checkboxes cookies
11712 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11713 (org-match-string-no-properties 4)))
11717 (defun org-format-outline-path (path &optional width prefix separator)
11718 "Format the outline path PATH for display.
11719 WIDTH is the maximum number of characters that is available.
11720 PREFIX is a prefix to be included in the returned string,
11721 such as the file name.
11722 SEPARATOR is inserted between the different parts of the path,
11723 the default is \"/\"."
11724 (setq width (or width 79))
11725 (if prefix (setq width (- width (length prefix))))
11728 (let* ((nsteps (length path))
11729 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11730 (maxwidth (if (<= total-width width)
11731 10000 ;; everything fits
11732 ;; we need to shorten the level headings
11733 (/ (- width nsteps) nsteps)))
11734 (org-odd-levels-only nil)
11736 (total (1+ (length prefix))))
11737 (setq maxwidth (max maxwidth 10))
11739 (if prefix (or separator "/"))
11743 (if (and (= n nsteps) (< maxwidth 10000))
11744 (setq maxwidth (- total-width total)))
11745 (if (< (length h) maxwidth)
11746 (progn (setq total (+ total (length h) 1)) h)
11747 (setq h (substring h 0 (- maxwidth 2))
11748 total (+ total maxwidth 1))
11749 (if (string-match "[ \t]+\\'" h)
11750 (setq h (substring h 0 (match-beginning 0))))
11751 (setq h (concat h "..")))
11752 (org-add-props h nil 'face
11753 (nth (% (1- n) org-n-level-faces)
11756 path (or separator "/"))))))
11758 (defun org-display-outline-path (&optional file current separator just-return-string)
11759 "Display the current outline path in the echo area.
11761 If FILE is non-nil, prepend the output with the file name.
11762 If CURRENT is non-nil, append the current heading to the output.
11763 SEPARATOR is passed through to `org-format-outline-path'. It separates
11764 the different parts of the path and defaults to \"/\".
11765 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11767 (let* (case-fold-search
11768 (bfn (buffer-file-name (buffer-base-buffer)))
11769 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11771 (if current (setq path (append path
11773 (org-back-to-heading t)
11774 (if (looking-at org-complex-heading-regexp)
11775 (list (match-string 4)))))))
11777 (org-format-outline-path
11780 (and file bfn (concat (file-name-nondirectory bfn) separator))
11782 (if just-return-string
11783 (org-no-properties res)
11784 (org-unlogged-message "%s" res))))
11786 (defvar org-refile-history nil
11787 "History for refiling operations.")
11789 (defvar org-after-refile-insert-hook nil
11790 "Hook run after `org-refile' has inserted its stuff at the new location.
11791 Note that this is still *before* the stuff will be removed from
11792 the *old* location.")
11794 (defvar org-capture-last-stored-marker)
11795 (defvar org-refile-keep nil
11796 "Non-nil means `org-refile' will copy instead of refile.")
11799 "Like `org-refile', but copy."
11801 (let ((org-refile-keep t))
11802 (funcall 'org-refile nil nil nil "Copy")))
11804 (defun org-refile (&optional arg default-buffer rfloc msg)
11805 "Move the entry or entries at point to another heading.
11806 The list of target headings is compiled using the information in
11807 `org-refile-targets', which see.
11809 At the target location, the entry is filed as a subitem of the
11810 target heading. Depending on `org-reverse-note-order', the new
11811 subitem will either be the first or the last subitem.
11813 If there is an active region, all entries in that region will be
11814 refiled. However, the region must fulfill the requirement that
11815 the first heading sets the top-level of the moved text.
11817 With prefix arg ARG, the command will only visit the target
11818 location and not actually move anything.
11820 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11821 refiling operation has put the subtree.
11823 With a numeric prefix argument of `2', refile to the running clock.
11825 With a numeric prefix argument of `3', emulate `org-refile-keep'
11826 being set to `t' and copy to the target location, don't move it.
11827 Beware that keeping refiled entries may result in duplicated ID
11830 RFLOC can be a refile location obtained in a different way.
11832 MSG is a string to replace \"Refile\" in the default prompt with
11833 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11835 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11837 If you are using target caching (see `org-refile-use-cache'), you
11838 have to clear the target cache in order to find new targets.
11839 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11840 prefix argument (`C-u C-u C-u C-c C-w')."
11842 (if (member arg '(0 (64)))
11843 (org-refile-cache-clear)
11844 (let* ((actionmsg (cond (msg msg)
11845 ((equal arg 3) "Refile (and keep)")
11847 (cbuf (current-buffer))
11848 (regionp (org-region-active-p))
11849 (region-start (and regionp (region-beginning)))
11850 (region-end (and regionp (region-end)))
11851 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11852 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11853 pos it nbuf file re level reversed)
11854 (setq last-command nil)
11856 (goto-char region-start)
11857 (or (bolp) (goto-char (point-at-bol)))
11858 (setq region-start (point))
11859 (unless (or (org-kill-is-subtree-p
11860 (buffer-substring region-start region-end))
11861 (prog1 org-refile-active-region-within-subtree
11862 (let ((s (point-at-eol)))
11863 (org-toggle-heading)
11864 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11865 (user-error "The region is not a (sequence of) subtree(s)")))
11866 (if (equal arg '(16))
11867 (org-refile-goto-last-stored)
11870 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11872 (setq it (list (or org-clock-heading "running clock")
11874 (marker-buffer org-clock-hd-marker))
11876 (marker-position org-clock-hd-marker)))
11879 (let (heading-text)
11881 (unless (and arg (listp arg))
11882 (org-back-to-heading t)
11884 (replace-regexp-in-string
11885 org-bracket-link-regexp
11887 (nth 4 (org-heading-components)))))
11888 (org-refile-get-location
11889 (cond ((and arg (listp arg)) "Goto")
11890 (regionp (concat actionmsg " region to"))
11891 (t (concat actionmsg " subtree \""
11892 heading-text "\" to")))
11894 (and (not (equal '(4) arg))
11895 org-refile-allow-creating-parent-nodes)
11897 (setq file (nth 1 it)
11902 (equal (buffer-file-name) file)
11904 (and (>= pos region-start)
11905 (<= pos region-end))
11906 (and (>= pos (point))
11907 (< pos (save-excursion
11908 (org-end-of-subtree t t))))))
11909 (error "Cannot refile to position inside the tree or region"))
11910 (setq nbuf (or (find-buffer-visiting file)
11911 (find-file-noselect file)))
11912 (if (and arg (not (equal arg 3)))
11914 (org-pop-to-buffer-same-window nbuf)
11916 (org-show-context 'org-goto))
11919 (org-kill-new (buffer-substring region-start region-end))
11920 (org-save-markers-in-region region-start region-end))
11921 (org-copy-subtree 1 nil t))
11922 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11923 (find-file-noselect file)))
11924 (setq reversed (org-notes-order-reversed-p))
11931 (looking-at org-outline-regexp)
11932 (setq level (org-get-valid-level (funcall outline-level) 1))
11935 (or (outline-next-heading) (point-max))
11936 (or (save-excursion (org-get-next-sibling))
11937 (org-end-of-subtree t t)
11941 (goto-char (point-max))
11942 (goto-char (point-min))
11943 (or (outline-next-heading) (goto-char (point-max)))))
11944 (if (not (bolp)) (newline))
11945 (org-paste-subtree level nil nil t)
11946 (when org-log-refile
11947 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11948 (unless (eq org-log-refile 'note)
11949 (save-excursion (org-add-log-note))))
11950 (and org-auto-align-tags
11951 (let ((org-loop-over-headlines-in-active-region nil))
11952 (org-set-tags nil t)))
11953 (let ((bookmark-name (plist-get org-bookmark-names-plist
11955 (when bookmark-name
11956 (with-demoted-errors
11957 (bookmark-set bookmark-name))))
11958 ;; If we are refiling for capture, make sure that the
11959 ;; last-capture pointers point here
11960 (when (org-bound-and-true-p org-refile-for-capture)
11961 (let ((bookmark-name (plist-get org-bookmark-names-plist
11962 :last-capture-marker)))
11963 (when bookmark-name
11964 (with-demoted-errors
11965 (bookmark-set bookmark-name))))
11966 (move-marker org-capture-last-stored-marker (point)))
11967 (if (fboundp 'deactivate-mark) (deactivate-mark))
11968 (run-hooks 'org-after-refile-insert-hook))))
11969 (unless org-refile-keep
11971 (delete-region (point) (+ (point) (- region-end region-start)))
11973 (and (org-back-to-heading t) (point))
11974 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11975 (when (featurep 'org-inlinetask)
11976 (org-inlinetask-remove-END-maybe))
11977 (setq org-markers-to-move nil)
11978 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11980 (defun org-refile-goto-last-stored ()
11981 "Go to the location where the last refile was stored."
11983 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11984 (message "This is the location of the last refile"))
11986 (defun org-refile--get-location (refloc tbl)
11987 "When user refile to REFLOC, find the associated target in TBL.
11988 Also check `org-refile-target-table'."
11992 (lambda (r) (or (assoc r tbl)
11993 (assoc r org-refile-target-table)))
11994 (list (replace-regexp-in-string "/$" "" refloc)
11995 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11997 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11999 "Prompt the user for a refile location, using PROMPT.
12000 PROMPT should not be suffixed with a colon and a space, because
12001 this function appends the default value from
12002 `org-refile-history' automatically, if that is not empty.
12003 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
12004 this is used for the GOTO interface."
12005 (let ((org-refile-targets org-refile-targets)
12006 (org-refile-use-outline-path org-refile-use-outline-path)
12008 (when (and (derived-mode-p 'org-mode)
12009 (not org-refile-use-cache)
12013 (setq excluded-entries
12014 (append excluded-entries (list (org-get-heading t t)))))))
12015 (setq org-refile-target-table
12016 (org-refile-get-targets default-buffer excluded-entries)))
12017 (unless org-refile-target-table
12018 (user-error "No refile targets"))
12019 (let* ((cbuf (current-buffer))
12020 (partial-completion-mode nil)
12021 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
12022 (cfunc (if (and org-refile-use-outline-path
12023 org-outline-path-complete-in-steps)
12024 'org-olpath-completing-read
12025 'org-icompleting-read))
12026 (extra (if org-refile-use-outline-path "/" ""))
12027 (cbnex (concat (buffer-name) extra))
12028 (filename (and cfn (expand-file-name cfn)))
12031 (if (and (not (member org-refile-use-outline-path
12032 '(file full-file-path)))
12033 (not (equal filename (nth 1 x))))
12034 (cons (concat (car x) extra " ("
12035 (file-name-nondirectory (nth 1 x)) ")")
12037 (cons (concat (car x) extra) (cdr x))))
12038 org-refile-target-table))
12039 (completion-ignore-case t)
12041 (prompt (concat prompt
12042 (or (and (car org-refile-history)
12043 (concat " (default " (car org-refile-history) ")"))
12044 (and (assoc cbnex tbl) (setq cdef cbnex)
12045 (concat " (default " cbnex ")"))) ": "))
12046 pa answ parent-target child parent old-hist)
12047 (setq old-hist org-refile-history)
12048 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12049 nil 'org-refile-history (or cdef (car org-refile-history))))
12050 (if (setq pa (org-refile--get-location answ tbl))
12052 (org-refile-check-position pa)
12053 (when (or (not org-refile-history)
12054 (not (eq old-hist org-refile-history))
12055 (not (equal (car pa) (car org-refile-history))))
12056 (setq org-refile-history
12057 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12059 (cdr org-refile-history))))
12060 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12061 (pop org-refile-history)))
12063 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12065 (setq parent (match-string 1 answ)
12066 child (match-string 2 answ))
12067 (setq parent-target (org-refile--get-location parent tbl))
12068 (when (and parent-target
12069 (or (eq new-nodes t)
12070 (and (eq new-nodes 'confirm)
12071 (y-or-n-p (format "Create new node \"%s\"? "
12073 (org-refile-new-child parent-target child)))
12074 (user-error "Invalid target location")))))
12076 (declare-function org-string-nw-p "org-macs" (s))
12077 (defun org-refile-check-position (refile-pointer)
12078 "Check if the refile pointer matches the headline to which it points."
12079 (let* ((file (nth 1 refile-pointer))
12080 (re (nth 2 refile-pointer))
12081 (pos (nth 3 refile-pointer))
12083 (if (and (not (markerp pos)) (not file))
12084 (user-error "Please indicate a target file in the refile path")
12085 (when (org-string-nw-p re)
12086 (setq buffer (if (markerp pos)
12087 (marker-buffer pos)
12088 (or (find-buffer-visiting file)
12089 (find-file-noselect file))))
12090 (with-current-buffer buffer
12095 (beginning-of-line 1)
12096 (unless (org-looking-at-p re)
12097 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12099 (defun org-refile-new-child (parent-target child)
12100 "Use refile target PARENT-TARGET to add new CHILD below it."
12101 (unless parent-target
12102 (error "Cannot find parent for new node"))
12103 (let ((file (nth 1 parent-target))
12104 (pos (nth 3 parent-target))
12106 (with-current-buffer (or (find-buffer-visiting file)
12107 (find-file-noselect file))
12113 (goto-char (point-max))
12114 (if (not (bolp)) (newline)))
12115 (when (looking-at org-outline-regexp)
12116 (setq level (funcall outline-level))
12117 (org-end-of-subtree t t))
12118 (org-back-over-empty-lines)
12119 (insert "\n" (make-string
12120 (if pos (org-get-valid-level level 1) 1) ?*)
12122 (beginning-of-line 0)
12123 (list (concat (car parent-target) "/" child) file "" (point)))))))
12125 (defun org-olpath-completing-read (prompt collection &rest args)
12126 "Read an outline path like a file name."
12127 (let ((thetable collection)
12128 (org-completion-use-ido nil) ; does not work with ido.
12129 (org-completion-use-iswitchb nil)) ; or iswitchb
12131 'org-icompleting-read prompt
12132 (lambda (string predicate &optional flag)
12133 (let (rtn r f (l (length string)))
12137 (try-completion string thetable))
12140 (setq rtn (all-completions string thetable predicate))
12143 (setq r (substring x l))
12144 (if (string-match " ([^)]*)$" x)
12145 (setq f (match-string 0 x))
12147 (if (string-match "/" r)
12148 (concat string (substring r 0 (match-end 0)) f)
12153 (assoc string thetable)))))
12156 ;;;; Dynamic blocks
12158 (defun org-find-dblock (name)
12159 "Find the first dynamic block with name NAME in the buffer.
12160 If not found, stay at current position and return nil."
12161 (let ((case-fold-search t) pos)
12163 (goto-char (point-min))
12164 (setq pos (and (re-search-forward
12165 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12166 (match-beginning 0))))
12167 (if pos (goto-char pos))
12170 (defun org-create-dblock (plist)
12171 "Create a dynamic block section, with parameters taken from PLIST.
12172 PLIST must contain a :name entry which is used as the name of the block."
12173 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12176 (let ((col (current-column))
12177 (name (plist-get plist :name)))
12178 (insert "#+BEGIN: " name)
12180 (if (eq (car plist) :name)
12181 (setq plist (cddr plist))
12182 (insert " " (prin1-to-string (pop plist)))))
12183 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12184 (beginning-of-line -2)))
12186 (defun org-prepare-dblock ()
12187 "Prepare dynamic block for refresh.
12188 This empties the block, puts the cursor at the insert position and returns
12189 the property list including an extra property :name with the block name."
12190 (unless (looking-at org-dblock-start-re)
12191 (user-error "Not at a dynamic block"))
12192 (let* ((begdel (1+ (match-end 0)))
12193 (name (org-no-properties (match-string 1)))
12194 (params (append (list :name name)
12195 (read (concat "(" (match-string 3) ")")))))
12197 (beginning-of-line 1)
12198 (skip-chars-forward " \t")
12199 (setq params (plist-put params :indentation-column (current-column))))
12200 (unless (re-search-forward org-dblock-end-re nil t)
12201 (error "Dynamic block not terminated"))
12204 (list :content (buffer-substring
12205 begdel (match-beginning 0)))))
12206 (delete-region begdel (match-beginning 0))
12211 (defun org-map-dblocks (&optional command)
12212 "Apply COMMAND to all dynamic blocks in the current buffer.
12213 If COMMAND is not given, use `org-update-dblock'."
12214 (let ((cmd (or command 'org-update-dblock)))
12216 (goto-char (point-min))
12217 (while (re-search-forward org-dblock-start-re nil t)
12218 (goto-char (match-beginning 0))
12220 (condition-case nil
12222 (error (message "Error during update of dynamic block"))))
12223 (unless (re-search-forward org-dblock-end-re nil t)
12224 (error "Dynamic block not terminated"))))))
12226 (defun org-dblock-update (&optional arg)
12227 "User command for updating dynamic blocks.
12228 Update the dynamic block at point. With prefix ARG, update all dynamic
12229 blocks in the buffer."
12232 (org-update-all-dblocks)
12233 (or (looking-at org-dblock-start-re)
12234 (org-beginning-of-dblock))
12235 (org-update-dblock)))
12237 (defun org-update-dblock ()
12238 "Update the dynamic block at point.
12239 This means to empty the block, parse for parameters and then call
12240 the correct writing function."
12243 (let* ((win (selected-window))
12245 (line (org-current-line))
12246 (params (org-prepare-dblock))
12247 (name (plist-get params :name))
12248 (indent (plist-get params :indentation-column))
12249 (cmd (intern (concat "org-dblock-write:" name))))
12250 (message "Updating dynamic block `%s' at line %d..." name line)
12251 (funcall cmd params)
12252 (message "Updating dynamic block `%s' at line %d...done" name line)
12254 (when (and indent (> indent 0))
12255 (setq indent (make-string indent ?\ ))
12257 (select-window win)
12258 (org-beginning-of-dblock)
12260 (while (not (looking-at org-dblock-end-re))
12262 (beginning-of-line 2))
12263 (when (looking-at org-dblock-end-re)
12264 (and (looking-at "[ \t]+")
12265 (replace-match ""))
12266 (insert indent)))))))
12268 (defun org-beginning-of-dblock ()
12269 "Find the beginning of the dynamic block at point.
12270 Error if there is no such block at point."
12271 (let ((pos (point))
12274 (if (and (re-search-backward org-dblock-start-re nil t)
12275 (setq beg (match-beginning 0))
12276 (re-search-forward org-dblock-end-re nil t)
12277 (> (match-end 0) pos))
12280 (error "Not in a dynamic block"))))
12282 (defun org-update-all-dblocks ()
12283 "Update all dynamic blocks in the buffer.
12284 This function can be used in a hook."
12286 (when (derived-mode-p 'org-mode)
12287 (org-map-dblocks 'org-update-dblock)))
12292 (declare-function org-export-backend-name "org-export" (cl-x))
12293 (declare-function org-export-backend-options "org-export" (cl-x))
12294 (defun org-get-export-keywords ()
12295 "Return a list of all currently understood export keywords.
12296 Export keywords include options, block names, attributes and
12297 keywords relative to each registered export back-end."
12300 (org-bound-and-true-p org-export-registered-backends)
12301 (delq nil keywords))
12302 ;; Back-end name (for keywords, like #+LATEX:)
12303 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12304 (dolist (option-entry (org-export-backend-options backend))
12305 ;; Back-end options.
12306 (push (nth 1 option-entry) keywords)))))
12308 (defconst org-options-keywords
12309 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12310 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12311 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12312 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12313 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12315 (defcustom org-structure-template-alist
12316 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12317 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12318 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12319 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12320 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12321 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12322 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12324 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12326 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12329 ("I" "#+INCLUDE: %file ?"))
12330 "Structure completion elements.
12331 This is a list of abbreviation keys and values. The value gets inserted
12332 if you type `<' followed by the key and then press the completion key,
12333 usually `TAB'. %file will be replaced by a file name after prompting
12334 for the file using completion. The cursor will be placed at the position
12335 of the `?` in the template.
12336 There are two templates for each key, the first uses the original Org syntax,
12337 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12338 the default when the /org-mtags.el/ module has been loaded. See also the
12339 variable `org-mtags-prefer-muse-templates'."
12340 :group 'org-completion
12343 (string :tag "Key")
12344 (string :tag "Template")))
12346 :package-version '(Org . "8.3"))
12348 (defun org-try-structure-completion ()
12349 "Try to complete a structure template before point.
12350 This looks for strings like \"<e\" on an otherwise empty line and
12352 (let ((l (buffer-substring (point-at-bol) (point)))
12354 (when (and (looking-at "[ \t]*$")
12355 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12356 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12357 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12358 (match-beginning 1)) a)
12361 (defun org-complete-expand-structure-template (start cell)
12362 "Expand a structure template."
12363 (let ((rpl (nth 1 cell))
12365 (delete-region start (point))
12366 (when (string-match "\\`[ \t]*#\\+" rpl)
12369 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12370 (setq ind (buffer-substring (point-at-bol) (point))))
12372 (setq start (point))
12373 (if (string-match "%file" rpl)
12374 (setq rpl (replace-match
12378 (abbreviate-file-name (read-file-name "Include file: ")))
12381 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12382 (concat "\n" ind)))
12384 (if (re-search-backward "\\?" start t) (delete-char 1))))
12386 ;;;; TODO, DEADLINE, Comments
12388 (defun org-toggle-comment ()
12389 "Change the COMMENT state of an entry."
12392 (org-back-to-heading)
12393 (looking-at org-complex-heading-regexp)
12394 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12395 (skip-chars-forward " \t")
12396 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12397 (if (org-in-commented-heading-p t)
12398 (delete-region (point)
12399 (progn (search-forward " " (line-end-position) 'move)
12400 (skip-chars-forward " \t")
12402 (insert org-comment-string)
12403 (unless (eolp) (insert " ")))))
12405 (defvar org-last-todo-state-is-todo nil
12406 "This is non-nil when the last TODO state change led to a TODO state.
12407 If the last change removed the TODO tag or switched to DONE, then
12410 (defvar org-setting-tags nil) ; dynamically skipped
12412 (defvar org-todo-setup-filter-hook nil
12413 "Hook for functions that pre-filter todo specs.
12414 Each function takes a todo spec and returns either nil or the spec
12415 transformed into canonical form." )
12417 (defvar org-todo-get-default-hook nil
12418 "Hook for functions that get a default item for todo.
12419 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12420 nil or a string to be used for the todo mark." )
12422 (defvar org-agenda-headline-snapshot-before-repeat)
12424 (defun org-current-effective-time ()
12425 "Return current time adjusted for `org-extend-today-until' variable."
12426 (let* ((ct (org-current-time))
12427 (dct (decode-time ct))
12430 (org-use-last-clock-out-time-as-effective-time
12431 (or (org-clock-get-last-clock-out-time) ct))
12432 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12433 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12437 (defun org-todo-yesterday (&optional arg)
12438 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12440 (if (eq major-mode 'org-agenda-mode)
12441 (apply 'org-agenda-todo-yesterday arg)
12442 (let* ((org-use-effective-time t)
12443 (hour (third (decode-time
12444 (org-current-time))))
12445 (org-extend-today-until (1+ hour)))
12448 (defvar org-block-entry-blocking ""
12449 "First entry preventing the TODO state change.")
12451 (defun org-cancel-repeater ()
12452 "Cancel a repeater by setting its numeric value to zero."
12455 (org-back-to-heading t)
12456 (let ((bound1 (point))
12457 (bound0 (save-excursion (outline-next-heading) (point))))
12458 (when (re-search-forward
12459 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12460 org-deadline-time-regexp "\\)\\|\\("
12461 org-ts-regexp "\\)")
12463 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12464 (replace-match "0" t nil nil 1))))))
12466 (defun org-todo (&optional arg)
12467 "Change the TODO state of an item.
12468 The state of an item is given by a keyword at the start of the heading,
12470 *** TODO Write paper
12473 The different keywords are specified in the variable `org-todo-keywords'.
12474 By default the available states are \"TODO\" and \"DONE\".
12475 So for this example: when the item starts with TODO, it is changed to DONE.
12476 When it starts with DONE, the DONE is removed. And when neither TODO nor
12477 DONE are present, add TODO at the beginning of the heading.
12479 With \\[universal-argument] prefix arg, use completion to determine the new \
12481 With numeric prefix arg, switch to that state.
12482 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12483 keywords (nextset).
12484 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12485 With a numeric prefix arg of 0, inhibit note taking for the change.
12486 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12488 When called through ELisp, arg is also interpreted in the following way:
12489 'none -> empty state
12490 \"\"(empty string) -> switch to empty state
12491 'done -> switch to DONE
12492 'nextset -> switch to the next set of keywords
12493 'previousset -> switch to the previous set of keywords
12494 \"WAITING\" -> switch to the specified keyword, but only if it
12495 really is a member of `org-todo-keywords'."
12497 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12498 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12499 'region-start-level 'region))
12500 org-loop-over-headlines-in-active-region)
12503 org-loop-over-headlines-in-active-region
12504 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12505 (if (equal arg '(16)) (setq arg 'nextset))
12506 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12507 (let ((org-blocker-hook org-blocker-hook)
12510 (when (equal arg '(64))
12511 (setq arg nil org-blocker-hook nil))
12512 (when (and org-blocker-hook
12513 (or org-inhibit-blocking
12514 (org-entry-get nil "NOBLOCKING")))
12515 (setq org-blocker-hook nil))
12518 (org-back-to-heading t)
12519 (when (org-in-commented-heading-p t)
12520 (org-toggle-comment)
12522 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12523 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12524 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12525 (let* ((match-data (match-data))
12526 (startpos (point-at-bol))
12527 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12528 (org-log-done org-log-done)
12529 (org-log-repeat org-log-repeat)
12530 (org-todo-log-states org-todo-log-states)
12531 (org-inhibit-logging
12533 (progn (setq arg nil) 'note) org-inhibit-logging))
12534 (this (match-string 1))
12535 (hl-pos (match-beginning 0))
12536 (head (org-get-todo-sequence-head this))
12537 (ass (assoc head org-todo-kwd-alist))
12538 (interpret (nth 1 ass))
12539 (done-word (nth 3 ass))
12540 (final-done-word (nth 4 ass))
12541 (org-last-state (or this ""))
12542 (completion-ignore-case t)
12543 (member (member this org-todo-keywords-1))
12544 (tail (cdr member))
12546 ((and org-todo-key-trigger
12547 (or (and (equal arg '(4))
12548 (eq org-use-fast-todo-selection 'prefix))
12549 (and (not arg) org-use-fast-todo-selection
12550 (not (eq org-use-fast-todo-selection
12552 ;; Use fast selection
12553 (org-fast-todo-selection))
12554 ((and (equal arg '(4))
12555 (or (not org-use-fast-todo-selection)
12556 (not org-todo-key-trigger)))
12557 ;; Read a state with completion
12558 (org-icompleting-read
12559 "State: " (mapcar 'list org-todo-keywords-1)
12563 (if tail (car tail) nil)
12564 (car org-todo-keywords-1)))
12566 (if (equal member org-todo-keywords-1)
12569 (nth (- (length org-todo-keywords-1)
12571 org-todo-keywords-1)
12572 (org-last org-todo-keywords-1))))
12573 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12574 (setq arg nil))) ; hack to fall back to cycling
12576 ;; user or caller requests a specific state
12578 ((equal arg "") nil)
12579 ((eq arg 'none) nil)
12580 ((eq arg 'done) (or done-word (car org-done-keywords)))
12582 (or (car (cdr (member head org-todo-heads)))
12583 (car org-todo-heads)))
12584 ((eq arg 'previousset)
12585 (let ((org-todo-heads (reverse org-todo-heads)))
12586 (or (car (cdr (member head org-todo-heads)))
12587 (car org-todo-heads))))
12588 ((car (member arg org-todo-keywords-1)))
12590 (user-error "State `%s' not valid in this file" arg))
12591 ((nth (1- (prefix-numeric-value arg))
12592 org-todo-keywords-1))))
12593 ((null member) (or head (car org-todo-keywords-1)))
12594 ((equal this final-done-word) nil) ;; -> make empty
12595 ((null tail) nil) ;; -> first entry
12596 ((memq interpret '(type priority))
12597 (if (eq this-command last-command)
12599 (if (> (length tail) 0)
12600 (or done-word (car org-done-keywords))
12605 (run-hook-with-args-until-success
12606 'org-todo-get-default-hook org-state org-last-state)
12608 (next (if org-state (concat " " org-state " ") " "))
12609 (change-plist (list :type 'todo-state-change :from this :to org-state
12610 :position startpos))
12612 (when org-blocker-hook
12613 (setq org-last-todo-state-is-todo
12614 (not (member this org-done-keywords)))
12615 (unless (save-excursion
12617 (org-with-wide-buffer
12618 (run-hook-with-args-until-failure
12619 'org-blocker-hook change-plist))))
12620 (if (org-called-interactively-p 'interactive)
12621 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12622 this org-state org-block-entry-blocking)
12624 (message "TODO state change from %s to %s blocked (by \"%s\")"
12625 this org-state org-block-entry-blocking)
12626 (throw 'exit nil))))
12627 (store-match-data match-data)
12628 (replace-match next t t)
12629 (cond ((equal this org-state)
12630 (message "TODO state was already %s" (org-trim next)))
12631 ((pos-visible-in-window-p hl-pos)
12632 (message "TODO state changed to %s" (org-trim next))))
12634 (setq head (org-get-todo-sequence-head org-state)
12635 ass (assoc head org-todo-kwd-alist)
12636 interpret (nth 1 ass)
12637 done-word (nth 3 ass)
12638 final-done-word (nth 4 ass)))
12639 (when (memq arg '(nextset previousset))
12640 (message "Keyword-Set %d/%d: %s"
12641 (- (length org-todo-sets) -1
12642 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12643 (length org-todo-sets)
12644 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12645 (setq org-last-todo-state-is-todo
12646 (not (member org-state org-done-keywords)))
12647 (setq now-done-p (and (member org-state org-done-keywords)
12648 (not (member this org-done-keywords))))
12649 (and logging (org-local-logging logging))
12650 (when (and (or org-todo-log-states org-log-done)
12651 (not (eq org-inhibit-logging t))
12652 (not (memq arg '(nextset previousset))))
12653 ;; we need to look at recording a time and note
12654 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12655 (nth 2 (assoc this org-todo-log-states))))
12656 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12657 (setq dolog 'time))
12658 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12660 (member org-state org-not-done-keywords)
12661 (not (member this org-not-done-keywords))))
12662 ;; This is now a todo state and was not one before
12663 ;; If there was a CLOSED time stamp, get rid of it.
12664 (org-add-planning-info nil nil 'closed))
12665 (when (and now-done-p org-log-done)
12666 ;; It is now done, and it was not done before
12667 (org-add-planning-info 'closed (org-current-effective-time))
12668 (if (and (not dolog) (eq 'note org-log-done))
12669 (org-add-log-setup 'done org-state this 'findpos 'note)))
12670 (when (and org-state dolog)
12671 ;; This is a non-nil state, and we need to log it
12672 (org-add-log-setup 'state org-state this 'findpos dolog)))
12673 ;; Fixup tag positioning
12674 (org-todo-trigger-tag-changes org-state)
12675 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12676 (when org-provide-todo-statistics
12677 (org-update-parent-todo-statistics))
12678 (run-hooks 'org-after-todo-state-change-hook)
12679 (if (and arg (not (member org-state org-done-keywords)))
12680 (setq head (org-get-todo-sequence-head org-state)))
12681 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12682 ;; Do we need to trigger a repeat?
12684 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12685 ;; This is for the agenda, take a snapshot of the headline.
12687 (setq org-agenda-headline-snapshot-before-repeat
12688 (org-get-heading))))
12689 (org-auto-repeat-maybe org-state))
12690 ;; Fixup cursor location if close to the keyword
12691 (if (and (outline-on-heading-p)
12693 (save-excursion (beginning-of-line 1)
12694 (looking-at org-todo-line-regexp))
12695 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12697 (goto-char (or (match-end 2) (match-end 1)))
12698 (and (looking-at " ") (just-one-space))))
12699 (when org-trigger-hook
12701 (run-hook-with-args 'org-trigger-hook change-plist)))
12702 (when commentp (org-toggle-comment))))))))
12704 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12705 "Block turning an entry into a TODO, using the hierarchy.
12706 This checks whether the current task should be blocked from state
12707 changes. Such blocking occurs when:
12709 1. The task has children which are not all in a completed state.
12711 2. A task has a parent with the property :ORDERED:, and there
12712 are siblings prior to the current task with incomplete
12715 3. The parent of the task is blocked because it has siblings that should
12716 be done first, or is child of a block grandparent TODO entry."
12718 (if (not org-enforce-todo-dependencies)
12719 t ; if locally turned off don't block
12721 ;; If this is not a todo state change, or if this entry is already DONE,
12723 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12724 (member (plist-get change-plist :from)
12725 (cons 'done org-done-keywords))
12726 (member (plist-get change-plist :to)
12727 (cons 'todo org-not-done-keywords))
12728 (not (plist-get change-plist :to)))
12729 (throw 'dont-block t))
12730 ;; If this task has children, and any are undone, it's blocked
12732 (org-back-to-heading t)
12733 (let ((this-level (funcall outline-level)))
12734 (outline-next-heading)
12735 (let ((child-level (funcall outline-level)))
12736 (while (and (not (eobp))
12737 (> child-level this-level))
12738 ;; this todo has children, check whether they are all
12740 (if (and (not (org-entry-is-done-p))
12741 (org-entry-is-todo-p))
12742 (progn (setq org-block-entry-blocking (org-get-heading))
12743 (throw 'dont-block nil)))
12744 (outline-next-heading)
12745 (setq child-level (funcall outline-level))))))
12746 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12747 ;; any previous siblings are undone, it's blocked
12749 (org-back-to-heading t)
12750 (let* ((pos (point))
12751 (parent-pos (and (org-up-heading-safe) (point))))
12752 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12753 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12755 (re-search-forward org-not-done-heading-regexp pos t))
12756 (setq org-block-entry-blocking (match-string 0))
12757 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12758 ;; Search further up the hierarchy, to see if an ancestor is blocked
12760 (goto-char parent-pos)
12761 (if (not (looking-at org-not-done-heading-regexp))
12762 (throw 'dont-block t)) ; do not block, parent is not a TODO
12764 (setq parent-pos (and (org-up-heading-safe) (point)))
12765 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12766 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12768 (re-search-forward org-not-done-heading-regexp pos t)
12769 (setq org-block-entry-blocking (org-get-heading)))
12770 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12772 (defcustom org-track-ordered-property-with-tag nil
12773 "Should the ORDERED property also be shown as a tag?
12774 The ORDERED property decides if an entry should require subtasks to be
12775 completed in sequence. Since a property is not very visible, setting
12776 this option means that toggling the ORDERED property with the command
12777 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12778 not relevant for the behavior, but it makes things more visible.
12780 Note that toggling the tag with tags commands will not change the property
12781 and therefore not influence behavior!
12783 This can be t, meaning the tag ORDERED should be used, It can also be a
12784 string to select a different tag for this task."
12787 (const :tag "No tracking" nil)
12788 (const :tag "Track with ORDERED tag" t)
12789 (string :tag "Use other tag")))
12791 (defun org-toggle-ordered-property ()
12792 "Toggle the ORDERED property of the current entry.
12793 For better visibility, you can track the value of this property with a tag.
12794 See variable `org-track-ordered-property-with-tag'."
12796 (let* ((t1 org-track-ordered-property-with-tag)
12797 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12799 (org-back-to-heading)
12800 (if (org-entry-get nil "ORDERED")
12802 (org-delete-property "ORDERED")
12803 (and tag (org-toggle-tag tag 'off))
12804 (message "Subtasks can be completed in arbitrary order"))
12805 (org-entry-put nil "ORDERED" "t")
12806 (and tag (org-toggle-tag tag 'on))
12807 (message "Subtasks must be completed in sequence")))))
12809 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12810 (defun org-block-todo-from-checkboxes (change-plist)
12811 "Block turning an entry into a TODO, using checkboxes.
12812 This checks whether the current task should be blocked from state
12813 changes because there are unchecked boxes in this entry."
12814 (if (not org-enforce-todo-checkbox-dependencies)
12815 t ; if locally turned off don't block
12817 ;; If this is not a todo state change, or if this entry is already DONE,
12819 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12820 (member (plist-get change-plist :from)
12821 (cons 'done org-done-keywords))
12822 (member (plist-get change-plist :to)
12823 (cons 'todo org-not-done-keywords))
12824 (not (plist-get change-plist :to)))
12825 (throw 'dont-block t))
12826 ;; If this task has checkboxes that are not checked, it's blocked
12828 (org-back-to-heading t)
12829 (let ((beg (point)) end)
12830 (outline-next-heading)
12833 (if (org-list-search-forward
12834 (concat (org-item-beginning-re)
12835 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12839 (if (boundp 'org-blocked-by-checkboxes)
12840 (setq org-blocked-by-checkboxes t))
12841 (throw 'dont-block nil)))))
12842 t))) ; do not block
12844 (defun org-entry-blocked-p ()
12845 "Is the current entry blocked?"
12846 (org-with-silent-modifications
12847 (if (org-entry-get nil "NOBLOCKING")
12848 nil ;; Never block this entry
12849 (not (run-hook-with-args-until-failure
12851 (list :type 'todo-state-change
12856 (defun org-update-statistics-cookies (all)
12857 "Update the statistics cookie, either from TODO or from checkboxes.
12858 This should be called with the cursor in a line with a statistics cookie."
12862 (org-update-checkbox-count 'all)
12863 (org-map-entries 'org-update-parent-todo-statistics))
12864 (if (not (org-at-heading-p))
12865 (org-update-checkbox-count)
12866 (let ((pos (point-marker))
12868 (ignore-errors (org-back-to-heading t))
12869 (if (not (org-at-heading-p))
12870 (org-update-checkbox-count)
12871 (setq l1 (org-outline-level))
12872 (setq end (save-excursion
12873 (outline-next-heading)
12874 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12876 (if (and (save-excursion
12878 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12879 (not (save-excursion (re-search-forward
12880 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12881 (org-update-checkbox-count)
12882 (if (and l2 (> l2 l1))
12885 (org-update-parent-todo-statistics))
12887 (beginning-of-line 1)
12888 (while (re-search-forward
12889 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12891 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12893 (move-marker pos nil)))))
12895 (defvar org-entry-property-inherited-from) ;; defined below
12896 (defun org-update-parent-todo-statistics ()
12897 "Update any statistics cookie in the parent of the current headline.
12898 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12899 the entire subtree and this will travel up the hierarchy and update
12900 statistics everywhere."
12901 (let* ((prop (save-excursion (org-up-heading-safe)
12902 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12903 (recursive (or (not org-hierarchical-todo-statistics)
12904 (and prop (string-match "\\<recursive\\>" prop))))
12905 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12908 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12909 level ltoggle l1 new ndel
12910 (cnt-all 0) (cnt-done 0) is-percent kwd
12911 checkbox-beg ov ovs ove cookie-present)
12914 (beginning-of-line 1)
12915 (setq ltoggle (funcall outline-level))
12916 ;; Three situations are to consider:
12918 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12919 ;; to the top-level ancestor on the headline;
12921 ;; 2. If parent has "recursive" property, repeat up to the
12922 ;; headline setting that property, taking inheritance into
12925 ;; 3. Else, move up to direct parent and proceed only once.
12926 (while (and (setq level (org-up-heading-safe))
12927 (or recursive first)
12929 (setq first nil cookie-present nil)
12933 (downcase (or (org-entry-get nil "COOKIE_DATA")
12936 (while (re-search-forward box-re (point-at-eol) t)
12937 (setq cnt-all 0 cnt-done 0 cookie-present t)
12938 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12940 (unless (outline-next-heading) (throw 'exit nil))
12941 (while (and (looking-at org-complex-heading-regexp)
12942 (> (setq l1 (length (match-string 1))) level))
12943 (setq kwd (and (or recursive (= l1 ltoggle))
12945 (if (or (eq org-provide-todo-statistics 'all-headlines)
12946 (and (eq org-provide-todo-statistics t)
12947 (or (member kwd org-done-keywords)))
12948 (and (listp org-provide-todo-statistics)
12949 (stringp (car org-provide-todo-statistics))
12950 (or (member kwd org-provide-todo-statistics)
12951 (member kwd org-done-keywords)))
12952 (and (listp org-provide-todo-statistics)
12953 (listp (car org-provide-todo-statistics))
12954 (or (member kwd (car org-provide-todo-statistics))
12955 (and (member kwd org-done-keywords)
12956 (member kwd (cadr org-provide-todo-statistics))))))
12957 (setq cnt-all (1+ cnt-all))
12958 (if (eq org-provide-todo-statistics t)
12959 (and kwd (setq cnt-all (1+ cnt-all)))))
12960 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12961 (member kwd org-done-keywords))
12962 (and (listp org-provide-todo-statistics)
12963 (listp (car org-provide-todo-statistics))
12964 (member kwd org-done-keywords)
12965 (member kwd (cadr org-provide-todo-statistics)))
12966 (and (listp org-provide-todo-statistics)
12967 (stringp (car org-provide-todo-statistics))
12968 (member kwd org-done-keywords)))
12969 (setq cnt-done (1+ cnt-done)))
12970 (outline-next-heading)))
12973 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12974 (format "[%d/%d]" cnt-done cnt-all))
12975 ndel (- (match-end 0) checkbox-beg))
12976 ;; handle overlays when updating cookie from column view
12977 (when (setq ov (car (overlays-at checkbox-beg)))
12978 (setq ovs (overlay-start ov) ove (overlay-end ov))
12979 (delete-overlay ov))
12980 (goto-char checkbox-beg)
12982 (delete-region (point) (+ (point) ndel))
12983 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12984 (when ov (move-overlay ov ovs ove)))
12985 (when cookie-present
12986 (run-hook-with-args 'org-after-todo-statistics-hook
12987 cnt-done (- cnt-all cnt-done))))))
12988 (run-hooks 'org-todo-statistics-hook)))
12990 (defvar org-after-todo-statistics-hook nil
12991 "Hook that is called after a TODO statistics cookie has been updated.
12992 Each function is called with two arguments: the number of not-done entries
12993 and the number of done entries.
12995 For example, the following function, when added to this hook, will switch
12996 an entry to DONE when all children are done, and back to TODO when new
12997 entries are set to a TODO status. Note that this hook is only called
12998 when there is a statistics cookie in the headline!
13000 (defun org-summary-todo (n-done n-not-done)
13001 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
13002 (let (org-log-done org-log-states) ; turn off logging
13003 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
13006 (defvar org-todo-statistics-hook nil
13007 "Hook that is run whenever Org thinks TODO statistics should be updated.
13008 This hook runs even if there is no statistics cookie present, in which case
13009 `org-after-todo-statistics-hook' would not run.")
13011 (defun org-todo-trigger-tag-changes (state)
13012 "Apply the changes defined in `org-todo-state-tags-triggers'."
13013 (let ((l org-todo-state-tags-triggers)
13015 (when (or (not state) (equal state ""))
13016 (setq changes (append changes (cdr (assoc "" l)))))
13017 (when (and (stringp state) (> (length state) 0))
13018 (setq changes (append changes (cdr (assoc state l)))))
13019 (when (member state org-not-done-keywords)
13020 (setq changes (append changes (cdr (assoc 'todo l)))))
13021 (when (member state org-done-keywords)
13022 (setq changes (append changes (cdr (assoc 'done l)))))
13023 (dolist (c changes)
13024 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
13026 (defun org-local-logging (value)
13027 "Get logging settings from a property VALUE."
13029 ;; directly set the variables, they are already local.
13030 (setq org-log-done nil
13032 org-todo-log-states nil)
13033 (setq words (org-split-string value))
13034 (while (setq w (pop words))
13036 ((setq a (assoc w org-startup-options))
13037 (and (member (nth 1 a) '(org-log-done org-log-repeat))
13038 (set (nth 1 a) (nth 2 a))))
13039 ((setq a (org-extract-log-state-settings w))
13040 (and (member (car a) org-todo-keywords-1)
13041 (push a org-todo-log-states)))))))
13043 (defun org-get-todo-sequence-head (kwd)
13044 "Return the head of the TODO sequence to which KWD belongs.
13045 If KWD is not set, check if there is a text property remembering the
13050 (or (get-text-property (point-at-bol) 'org-todo-head)
13052 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13053 nil (point-at-eol)))
13054 (get-text-property p 'org-todo-head))))
13055 ((not (member kwd org-todo-keywords-1))
13056 (car org-todo-keywords-1))
13057 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13059 (defun org-fast-todo-selection ()
13060 "Fast TODO keyword selection with single keys.
13061 Returns the new TODO keyword, or nil if no state change should occur."
13062 (let* ((fulltable org-todo-key-alist)
13063 (done-keywords org-done-keywords) ;; needed for the faces.
13064 (maxlen (apply 'max (mapcar
13066 (if (stringp (car x)) (string-width (car x)) 0))
13069 (fwidth (+ maxlen 3 1 3))
13070 (ncol (/ (- (window-width) 4) fwidth))
13074 (save-window-excursion
13076 (set-buffer (get-buffer-create " *Org todo*"))
13077 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13079 (org-set-local 'org-done-keywords done-keywords)
13080 (setq tbl fulltable cnt 0)
13081 (while (setq e (pop tbl))
13083 ((equal e '(:startgroup))
13084 (push '() groups) (setq ingroup t)
13085 (when (not (= cnt 0))
13089 ((equal e '(:endgroup))
13090 (setq ingroup nil cnt 0)
13092 ((equal e '(:newline))
13093 (when (not (= cnt 0))
13097 (while (equal (car tbl) '(:newline))
13099 (setq tbl (cdr tbl)))))
13101 (setq tg (car e) c (cdr e))
13102 (if ingroup (push tg (car groups)))
13103 (setq tg (org-add-props tg nil 'face
13104 (org-get-todo-face tg)))
13105 (if (and (= cnt 0) (not ingroup)) (insert " "))
13106 (insert "[" c "] " tg (make-string
13107 (- fwidth 4 (length tg)) ?\ ))
13108 (when (= (setq cnt (1+ cnt)) ncol)
13110 (if ingroup (insert " "))
13113 (goto-char (point-min))
13114 (if (not expert) (org-fit-window-to-buffer))
13115 (message "[a-z..]:Set [SPC]:clear")
13116 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13119 (and (= c ?q) (not (rassoc c fulltable))))
13120 (setq quit-flag t))
13122 ((setq e (rassoc c fulltable) tg (car e))
13124 (t (setq quit-flag t)))))))
13126 (defun org-entry-is-todo-p ()
13127 (member (org-get-todo-state) org-not-done-keywords))
13129 (defun org-entry-is-done-p ()
13130 (member (org-get-todo-state) org-done-keywords))
13132 (defun org-get-todo-state ()
13133 "Return the TODO keyword of the current subtree."
13135 (org-back-to-heading t)
13136 (and (looking-at org-todo-line-regexp)
13138 (match-string 2))))
13140 (defun org-at-date-range-p (&optional inactive-ok)
13141 "Is the cursor inside a date range?"
13145 (let ((pos (point)))
13146 (skip-chars-backward "^[<\r\n")
13147 (skip-chars-backward "<[")
13148 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13149 (>= (match-end 0) pos)
13151 (skip-chars-backward "^<[\r\n")
13152 (skip-chars-backward "<[")
13153 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13154 (>= (match-end 0) pos)
13158 (defun org-get-repeat (&optional tagline)
13159 "Check if there is a deadline/schedule with repeater in this entry."
13162 (org-back-to-heading t)
13163 (and (re-search-forward (if tagline
13164 (concat tagline "\\s-*" org-repeat-re)
13166 (org-entry-end-position) t)
13167 (match-string-no-properties 1)))))
13169 (defvar org-last-changed-timestamp)
13170 (defvar org-last-inserted-timestamp)
13171 (defvar org-log-post-message)
13172 (defvar org-log-note-purpose)
13173 (defvar org-log-note-how nil)
13174 (defvar org-log-note-extra)
13175 (defun org-auto-repeat-maybe (done-word)
13176 "Check if the current headline contains a repeated deadline/schedule.
13177 If yes, set TODO state back to what it was and change the base date
13178 of repeating deadline/scheduled time stamps to new date.
13179 This function is run automatically after each state change to a DONE state."
13180 ;; last-state is dynamically scoped into this function
13181 (let* ((repeat (org-get-repeat))
13182 (aa (assoc org-last-state org-todo-kwd-alist))
13183 (interpret (nth 1 aa))
13185 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13186 (msg "Entry repeats: ")
13188 (org-todo-log-states nil)
13189 re type n what ts time to-state)
13190 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13191 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13192 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13193 org-todo-repeat-to-state))
13194 (unless (and to-state (member to-state org-todo-keywords-1))
13195 (setq to-state (if (eq interpret 'type) org-last-state head)))
13196 (org-todo to-state)
13197 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13198 (org-entry-put nil "LAST_REPEAT" (format-time-string
13199 (org-time-stamp-format t t))))
13200 (when org-log-repeat
13201 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13202 (memq 'org-add-log-note post-command-hook))
13203 ;; OK, we are already setup for some record
13204 (if (eq org-log-repeat 'note)
13205 ;; make sure we take a note, not only a time stamp
13206 (setq org-log-note-how 'note))
13207 ;; Set up for taking a record
13208 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13210 'findpos org-log-repeat)))
13211 (org-back-to-heading t)
13212 (org-add-planning-info nil nil 'closed)
13213 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13214 org-deadline-time-regexp "\\)\\|\\("
13215 org-ts-regexp "\\)"))
13216 (while (re-search-forward
13217 re (save-excursion (outline-next-heading) (point)) t)
13218 (setq type (if (match-end 1) org-scheduled-string
13219 (if (match-end 3) org-deadline-string "Plain:"))
13220 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13221 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13222 (setq n (string-to-number (match-string 2 ts))
13223 what (match-string 3 ts))
13224 (if (equal what "w") (setq n (* n 7) what "d"))
13225 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13226 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13227 ;; Preparation, see if we need to modify the start date for the change
13228 (when (match-end 1)
13229 (setq time (save-match-data (org-time-string-to-time ts)))
13231 ((equal (match-string 1 ts) ".")
13232 ;; Shift starting date to today
13233 (org-timestamp-change
13234 (- (org-today) (time-to-days time))
13236 ((equal (match-string 1 ts) "+")
13237 (let ((nshiftmax 10) (nshift 0))
13238 (while (or (= nshift 0)
13239 (<= (time-to-days time)
13240 (time-to-days (current-time))))
13241 (when (= (incf nshift) nshiftmax)
13242 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13243 (user-error "Abort")))
13244 (org-timestamp-change n (cdr (assoc what whata)))
13245 (org-at-timestamp-p t)
13246 (setq ts (match-string 1))
13247 (setq time (save-match-data (org-time-string-to-time ts)))))
13248 (org-timestamp-change (- n) (cdr (assoc what whata)))
13249 ;; rematch, so that we have everything in place for the real shift
13250 (org-at-timestamp-p t)
13251 (setq ts (match-string 1))
13252 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13253 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13254 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13255 (setq org-log-post-message msg)
13256 (message "%s" msg))))
13258 (defun org-show-todo-tree (arg)
13259 "Make a compact tree which shows all headlines marked with TODO.
13260 The tree will show the lines where the regexp matches, and all higher
13261 headlines above the match.
13262 With a \\[universal-argument] prefix, prompt for a regexp to match.
13263 With a numeric prefix N, construct a sparse tree for the Nth element
13264 of `org-todo-keywords-1'."
13266 (let ((case-fold-search nil)
13268 (cond ((null arg) org-not-done-regexp)
13270 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13271 (mapcar 'list org-todo-keywords-1))))
13273 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13275 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13276 (regexp-quote (nth (1- (prefix-numeric-value arg))
13277 org-todo-keywords-1)))
13278 (t (user-error "Invalid prefix argument: %s" arg)))))
13279 (message "%d TODO entries found"
13280 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13282 (defun org-deadline (arg &optional time)
13283 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13284 With one universal prefix argument, remove any deadline from the item.
13285 With two universal prefix arguments, prompt for a warning delay.
13286 With argument TIME, set the deadline at the corresponding date. TIME
13287 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13289 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13290 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13291 'region-start-level 'region))
13292 org-loop-over-headlines-in-active-region)
13294 `(org-deadline ',arg ,time)
13295 org-loop-over-headlines-in-active-region
13296 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13297 (let* ((old-date (org-entry-get nil "DEADLINE"))
13298 (old-date-time (if old-date (org-time-string-to-time old-date)))
13299 (repeater (and old-date
13301 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13303 (match-string 1 old-date))))
13306 (when (and old-date org-log-redeadline)
13307 (org-add-log-setup 'deldeadline nil old-date 'findpos
13308 org-log-redeadline))
13309 (org-remove-timestamp-with-keyword org-deadline-string)
13310 (message "Item no longer has a deadline."))
13313 (org-back-to-heading t)
13314 (if (re-search-forward
13315 org-deadline-time-regexp
13316 (save-excursion (outline-next-heading) (point)) t)
13317 (let* ((rpl0 (match-string 1))
13318 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13320 (concat org-deadline-string
13326 (org-read-date nil t nil "Warn starting from" old-date-time)))
13327 (time-to-days old-date-time))))
13329 (user-error "No deadline information to update"))))
13331 (org-add-planning-info 'deadline time 'closed)
13332 (when (and old-date org-log-redeadline
13333 (not (equal old-date
13334 (substring org-last-inserted-timestamp 1 -1))))
13335 (org-add-log-setup 'redeadline nil old-date 'findpos
13336 org-log-redeadline))
13339 (org-back-to-heading t)
13340 (when (re-search-forward (concat org-deadline-string " "
13341 org-last-inserted-timestamp)
13343 (outline-next-heading) (point)) t)
13344 (goto-char (1- (match-end 0)))
13345 (insert " " repeater)
13346 (setq org-last-inserted-timestamp
13347 (concat (substring org-last-inserted-timestamp 0 -1)
13349 (substring org-last-inserted-timestamp -1))))))
13350 (message "Deadline on %s" org-last-inserted-timestamp))))))
13352 (defun org-schedule (arg &optional time)
13353 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13354 With one universal prefix argument, remove any scheduling date from the item.
13355 With two universal prefix arguments, prompt for a delay cookie.
13356 With argument TIME, scheduled at the corresponding date. TIME can
13357 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13359 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13360 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13361 'region-start-level 'region))
13362 org-loop-over-headlines-in-active-region)
13364 `(org-schedule ',arg ,time)
13365 org-loop-over-headlines-in-active-region
13366 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13367 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13368 (old-date-time (if old-date (org-time-string-to-time old-date)))
13369 (repeater (and old-date
13371 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13373 (match-string 1 old-date))))
13377 (when (and old-date org-log-reschedule)
13378 (org-add-log-setup 'delschedule nil old-date 'findpos
13379 org-log-reschedule))
13380 (org-remove-timestamp-with-keyword org-scheduled-string)
13381 (message "Item is no longer scheduled.")))
13384 (org-back-to-heading t)
13385 (if (re-search-forward
13386 org-scheduled-time-regexp
13387 (save-excursion (outline-next-heading) (point)) t)
13388 (let* ((rpl0 (match-string 1))
13389 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13391 (concat org-scheduled-string
13397 (org-read-date nil t nil "Delay until" old-date-time)))
13398 (time-to-days old-date-time))))
13400 (user-error "No scheduled information to update"))))
13402 (org-add-planning-info 'scheduled time 'closed)
13403 (when (and old-date org-log-reschedule
13404 (not (equal old-date
13405 (substring org-last-inserted-timestamp 1 -1))))
13406 (org-add-log-setup 'reschedule nil old-date 'findpos
13407 org-log-reschedule))
13410 (org-back-to-heading t)
13411 (when (re-search-forward (concat org-scheduled-string " "
13412 org-last-inserted-timestamp)
13414 (outline-next-heading) (point)) t)
13415 (goto-char (1- (match-end 0)))
13416 (insert " " repeater)
13417 (setq org-last-inserted-timestamp
13418 (concat (substring org-last-inserted-timestamp 0 -1)
13420 (substring org-last-inserted-timestamp -1))))))
13421 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13423 (defun org-get-scheduled-time (pom &optional inherit)
13424 "Get the scheduled time as a time tuple, of a format suitable
13425 for calling org-schedule with, or if there is no scheduling,
13427 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13429 (apply 'encode-time (org-parse-time-string time)))))
13431 (defun org-get-deadline-time (pom &optional inherit)
13432 "Get the deadline as a time tuple, of a format suitable for
13433 calling org-deadline with, or if there is no scheduling, returns
13435 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13437 (apply 'encode-time (org-parse-time-string time)))))
13439 (defun org-remove-timestamp-with-keyword (keyword)
13440 "Remove all time stamps with KEYWORD in the current entry."
13441 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13444 (org-back-to-heading t)
13446 (outline-next-heading)
13447 (while (re-search-backward re beg t)
13449 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13450 (equal (char-before) ?\ ))
13451 (backward-delete-char 1)
13452 (if (string-match "^[ \t]*$" (buffer-substring
13453 (point-at-bol) (point-at-eol)))
13454 (delete-region (point-at-bol)
13455 (min (point-max) (1+ (point-at-eol))))))))))
13457 (defvar org-time-was-given) ; dynamically scoped parameter
13458 (defvar org-end-time-was-given) ; dynamically scoped parameter
13460 (defun org-at-planning-p ()
13461 "Non-nil when point is on a planning info line."
13462 ;; This is as accurate and faster than `org-element-at-point' since
13463 ;; planning info location is fixed in the section.
13464 (org-with-wide-buffer
13465 (beginning-of-line)
13466 (and (org-looking-at-p org-planning-line-re)
13469 (if (and (featurep 'org-inlinetask) (org-inlinetask-in-task-p))
13470 (org-back-to-heading t)
13471 (org-with-limited-levels (org-back-to-heading t)))
13472 (line-beginning-position 2))))))
13474 (defun org-add-planning-info (what &optional time &rest remove)
13475 "Insert new timestamp with keyword in the planning line.
13476 WHAT indicates what kind of time stamp to add. It is a symbol
13477 among `closed', `deadline', `scheduled' and nil. TIME indicates
13478 the time to use. If none is given, the user is prompted for
13479 a date. REMOVE indicates what kind of entries to remove. An old
13480 WHAT entry will also be removed."
13481 (let (org-time-was-given org-end-time-was-given default-time default-input)
13483 (when (and (memq what '(scheduled deadline))
13485 (and (stringp time)
13486 (string-match "^[-+]+[0-9]" time))))
13487 ;; Try to get a default date/time from existing timestamp
13489 (org-back-to-heading t)
13490 (let ((end (save-excursion (outline-next-heading) (point))) ts)
13491 (when (re-search-forward (if (eq what 'scheduled)
13492 org-scheduled-time-regexp
13493 org-deadline-time-regexp)
13495 (setq ts (match-string 1)
13496 default-time (apply 'encode-time (org-parse-time-string ts))
13497 default-input (and ts (org-get-compact-tod ts)))))))
13501 ;; This is a string (relative or absolute), set
13503 (apply #'encode-time
13504 (org-read-date-analyze
13505 time default-time (decode-time default-time)))
13506 ;; If necessary, get the time from the user
13507 (or time (org-read-date nil 'to-time nil nil
13508 default-time default-input)))))
13510 (org-with-wide-buffer
13511 (org-back-to-heading t)
13513 (unless (bolp) (insert "\n"))
13514 (cond ((org-looking-at-p org-planning-line-re)
13515 ;; Move to current indentation.
13516 (skip-chars-forward " \t")
13517 ;; Check if we have to remove something.
13518 (dolist (type (if what (cons what remove) remove))
13519 (when (save-excursion
13522 (closed org-closed-time-regexp)
13523 (deadline org-deadline-time-regexp)
13524 (scheduled org-scheduled-time-regexp)
13525 (otherwise (error "Invalid planning type: %s" type)))
13526 (line-end-position) t))
13528 (when (looking-at "--+<[^>]+>") (replace-match ""))
13529 (when (and (not what) (eq type 'closed))
13531 (beginning-of-line)
13532 (if (looking-at "[ \t]*$")
13533 (delete-region (point) (1+ (point-at-eol)))))))
13534 ;; Remove leading white spaces.
13535 (when (and (not (bolp)) (looking-at "[ \t]+")) (replace-match ""))))
13536 ((not what) (throw 'exit nil)) ; Nothing to do.
13537 (t (insert-before-markers "\n")
13539 (when org-adapt-indentation
13540 (org-indent-to-column (1+ (org-outline-level))))))
13542 ;; Insert planning keyword.
13544 (closed org-closed-string)
13545 (deadline org-deadline-string)
13546 (scheduled org-scheduled-string)
13547 (otherwise (error "Invalid planning type: %s" what)))
13549 ;; Insert associated timestamp.
13550 (let ((ts (org-insert-time-stamp
13552 (or org-time-was-given
13553 (and (eq what 'closed) org-log-done-with-time))
13555 nil nil (list org-end-time-was-given))))
13556 (unless (eolp) (insert " "))
13559 (defvar org-log-note-marker (make-marker))
13560 (defvar org-log-note-purpose nil)
13561 (defvar org-log-note-state nil)
13562 (defvar org-log-note-previous-state nil)
13563 (defvar org-log-note-extra nil)
13564 (defvar org-log-note-window-configuration nil)
13565 (defvar org-log-note-return-to (make-marker))
13566 (defvar org-log-note-effective-time nil
13567 "Remembered current time so that dynamically scoped
13568 `org-extend-today-until' affects tha timestamps in state change
13571 (defvar org-log-post-message nil
13572 "Message to be displayed after a log note has been stored.
13573 The auto-repeater uses this.")
13575 (defun org-add-note ()
13576 "Add a note to the current entry.
13577 This is done in the same way as adding a state change note."
13579 (org-add-log-setup 'note nil nil 'findpos nil))
13581 (defun org-log-beginning (&optional create)
13582 "Return expected start of log notes in current entry.
13583 When optional argument CREATE is non-nil, the function creates
13584 a drawer to store notes, if necessary. Returned position ignores
13586 (org-with-wide-buffer
13587 (org-end-of-meta-data)
13588 (let ((end (if (org-at-heading-p) (point)
13589 (save-excursion (outline-next-heading) (point))))
13590 (drawer (org-log-into-drawer)))
13593 (let ((regexp (concat "^[ \t]*:" (regexp-quote drawer) ":[ \t]*$"))
13594 (case-fold-search t))
13596 ;; Try to find existing drawer.
13597 (while (re-search-forward regexp end t)
13598 (let ((element (org-element-at-point)))
13599 (when (eq (org-element-type element) 'drawer)
13600 (let ((cend (org-element-property :contents-end element)))
13601 (when (and (not org-log-states-order-reversed) cend)
13603 (throw 'exit nil))))
13604 ;; No drawer found. Create one, if permitted.
13606 (unless (bolp) (insert "\n"))
13607 (let ((beg (point)))
13608 (insert ":" drawer ":\n:END:\n")
13609 (org-indent-region beg (point)))
13610 (end-of-line -1)))))
13611 (org-log-state-notes-insert-after-drawers
13612 (while (and (looking-at org-drawer-regexp)
13613 (progn (goto-char (match-end 0))
13614 (re-search-forward org-property-end-re end t)))
13616 (if (bolp) (point) (line-beginning-position 2))))
13618 (defun org-add-log-setup (&optional purpose state prev-state findpos how extra)
13619 "Set up the post command hook to take a note.
13620 If this is about to TODO state change, the new state is expected in STATE.
13621 When FINDPOS is non-nil, find the correct position for the note in
13622 the current entry. If not, assume that it can be inserted at point.
13623 HOW is an indicator what kind of note should be created.
13624 EXTRA is additional text that will be inserted into the notes buffer."
13625 (org-with-wide-buffer
13627 (goto-char (org-log-beginning t))
13628 (unless org-log-states-order-reversed
13629 (org-skip-over-state-notes)
13630 (skip-chars-backward " \t\n\r")
13632 (move-marker org-log-note-marker (point))
13633 ;; Preserve position even if a property drawer is inserted in the
13635 (set-marker-insertion-type org-log-note-marker t)
13636 (setq org-log-note-purpose purpose
13637 org-log-note-state state
13638 org-log-note-previous-state prev-state
13639 org-log-note-how how
13640 org-log-note-extra extra
13641 org-log-note-effective-time (org-current-effective-time))
13642 (add-hook 'post-command-hook 'org-add-log-note 'append)))
13644 (defun org-skip-over-state-notes ()
13645 "Skip past the list of State notes in an entry."
13646 (when (ignore-errors (goto-char (org-in-item-p)))
13647 (let* ((struct (org-list-struct))
13648 (prevs (org-list-prevs-alist struct))
13650 (concat "[ \t]*- +"
13651 (replace-regexp-in-string
13653 (org-replace-escapes
13654 (regexp-quote (cdr (assq 'state org-log-note-headings)))
13655 `(("%d" . ,org-ts-regexp-inactive)
13656 ("%D" . ,org-ts-regexp)
13657 ("%s" . "\"\\S-+\"")
13658 ("%S" . "\"\\S-+\"")
13659 ("%t" . ,org-ts-regexp-inactive)
13660 ("%T" . ,org-ts-regexp)
13662 ("%U" . ".*?")))))))
13663 (while (org-looking-at-p regexp)
13664 (goto-char (or (org-list-get-next-item (point) struct prevs)
13665 (org-list-get-item-end (point) struct)))))))
13667 (defun org-add-log-note (&optional purpose)
13668 "Pop up a window for taking a note, and add this note later at point."
13669 (remove-hook 'post-command-hook 'org-add-log-note)
13670 (setq org-log-note-window-configuration (current-window-configuration))
13671 (delete-other-windows)
13672 (move-marker org-log-note-return-to (point))
13673 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13674 (goto-char org-log-note-marker)
13675 (org-switch-to-buffer-other-window "*Org Note*")
13677 (if (memq org-log-note-how '(time state))
13678 (let (current-prefix-arg) (org-store-log-note))
13679 (let ((org-inhibit-startup t)) (org-mode))
13680 (insert (format "# Insert note for %s.
13681 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13683 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13684 ((eq org-log-note-purpose 'done) "closed todo item")
13685 ((eq org-log-note-purpose 'state)
13686 (format "state change from \"%s\" to \"%s\""
13687 (or org-log-note-previous-state "")
13688 (or org-log-note-state "")))
13689 ((eq org-log-note-purpose 'reschedule)
13691 ((eq org-log-note-purpose 'delschedule)
13692 "no longer scheduled")
13693 ((eq org-log-note-purpose 'redeadline)
13694 "changing deadline")
13695 ((eq org-log-note-purpose 'deldeadline)
13696 "removing deadline")
13697 ((eq org-log-note-purpose 'refile)
13699 ((eq org-log-note-purpose 'note)
13701 (t (error "This should not happen")))))
13702 (if org-log-note-extra (insert org-log-note-extra))
13703 (org-set-local 'org-finish-function 'org-store-log-note)
13704 (run-hooks 'org-log-buffer-setup-hook)))
13706 (defvar org-note-abort nil) ; dynamically scoped
13707 (defun org-store-log-note ()
13708 "Finish taking a log note, and insert it to where it belongs."
13709 (let ((txt (buffer-string)))
13710 (kill-buffer (current-buffer))
13711 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings))) lines)
13712 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13713 (setq txt (replace-match "" t t txt)))
13714 (if (string-match "\\s-+\\'" txt)
13715 (setq txt (replace-match "" t t txt)))
13716 (setq lines (org-split-string txt "\n"))
13717 (when (and note (string-match "\\S-" note))
13719 (org-replace-escapes
13721 (list (cons "%u" (user-login-name))
13722 (cons "%U" user-full-name)
13723 (cons "%t" (format-time-string
13724 (org-time-stamp-format 'long 'inactive)
13725 org-log-note-effective-time))
13726 (cons "%T" (format-time-string
13727 (org-time-stamp-format 'long nil)
13728 org-log-note-effective-time))
13729 (cons "%d" (format-time-string
13730 (org-time-stamp-format nil 'inactive)
13731 org-log-note-effective-time))
13732 (cons "%D" (format-time-string
13733 (org-time-stamp-format nil nil)
13734 org-log-note-effective-time))
13735 (cons "%s" (if org-log-note-state
13736 (concat "\"" org-log-note-state "\"")
13738 (cons "%S" (if org-log-note-previous-state
13739 (concat "\"" org-log-note-previous-state "\"")
13741 (when lines (setq note (concat note " \\\\")))
13743 (when (or current-prefix-arg org-note-abort)
13744 (when (org-log-into-drawer)
13745 (org-remove-empty-drawer-at org-log-note-marker))
13748 (with-current-buffer (marker-buffer org-log-note-marker)
13750 (goto-char org-log-note-marker)
13751 (move-marker org-log-note-marker nil)
13752 ;; Make sure point is at the beginning of an empty line.
13753 (cond ((not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13754 ((looking-at "[ \t]*\\S-") (save-excursion (insert "\n"))))
13755 ;; In an existing list, add a new item at the top level.
13756 ;; Otherwise, indent line like a regular one.
13757 (let ((itemp (org-in-item-p)))
13759 (org-indent-line-to
13760 (let ((struct (save-excursion
13761 (goto-char itemp) (org-list-struct))))
13762 (org-list-get-ind (org-list-get-top-point struct) struct)))
13763 (org-indent-line)))
13764 (insert (org-list-bullet-string "-") (pop lines))
13765 (let ((ind (org-list-item-body-column (line-beginning-position))))
13766 (dolist (line lines)
13768 (org-indent-line-to ind)
13770 (message "Note stored")
13771 (org-back-to-heading t)
13772 (org-cycle-hide-drawers 'children))
13773 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13774 ;; from within `org-add-log-note' because `buffer-undo-list'
13775 ;; is then modified outside of `org-with-remote-undo'.
13776 (when (eq this-command 'org-agenda-todo)
13777 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13778 ;; Don't add undo information when called from `org-agenda-todo'
13779 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13780 (set-window-configuration org-log-note-window-configuration)
13781 (with-current-buffer (marker-buffer org-log-note-return-to)
13782 (goto-char org-log-note-return-to))
13783 (move-marker org-log-note-return-to nil)
13784 (and org-log-post-message (message "%s" org-log-post-message))))
13786 (defun org-remove-empty-drawer-at (pos)
13787 "Remove an empty drawer at position POS.
13788 POS may also be a marker."
13789 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13790 (org-with-wide-buffer
13792 (let ((drawer (org-element-at-point)))
13793 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13794 (not (org-element-property :contents-begin drawer)))
13795 (delete-region (org-element-property :begin drawer)
13796 (progn (goto-char (org-element-property :end drawer))
13797 (skip-chars-backward " \r\t\n")
13801 (defvar org-ts-type nil)
13802 (defun org-sparse-tree (&optional arg type)
13803 "Create a sparse tree, prompt for the details.
13804 This command can create sparse trees. You first need to select the type
13805 of match used to create the tree:
13807 t Show all TODO entries.
13808 T Show entries with a specific TODO keyword.
13809 m Show entries selected by a tags/property match.
13810 p Enter a property name and its value (both with completion on existing
13811 names/values) and show entries with that property.
13812 r Show entries matching a regular expression (`/' can be used as well).
13813 b Show deadlines and scheduled items before a date.
13814 a Show deadlines and scheduled items after a date.
13815 d Show deadlines due within `org-deadline-warning-days'.
13816 D Show deadlines and scheduled items between a date range."
13818 (setq type (or type org-sparse-tree-default-date-type))
13819 (setq org-ts-type type)
13820 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13821 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13822 [c]ycle through date types: %s"
13824 (all "all timestamps")
13825 (scheduled "only scheduled")
13826 (deadline "only deadline")
13827 (active "only active timestamps")
13828 (inactive "only inactive timestamps")
13829 (closed "with a closed time-stamp")
13830 (otherwise "scheduled/deadline")))
13831 (let ((answer (read-char-exclusive)))
13837 (memq type '(nil all scheduled deadline active inactive closed)))))
13838 (?d (call-interactively 'org-check-deadlines))
13839 (?b (call-interactively 'org-check-before-date))
13840 (?a (call-interactively 'org-check-after-date))
13841 (?D (call-interactively 'org-check-dates-range))
13842 (?t (call-interactively 'org-show-todo-tree))
13843 (?T (org-show-todo-tree '(4)))
13844 (?m (call-interactively 'org-match-sparse-tree))
13846 (let* ((kwd (org-icompleting-read
13847 "Property: " (mapcar 'list (org-buffer-property-keys))))
13848 (value (org-icompleting-read
13849 "Value: " (mapcar 'list (org-property-values kwd)))))
13850 (unless (string-match "\\`{.*}\\'" value)
13851 (setq value (concat "\"" value "\"")))
13852 (org-match-sparse-tree arg (concat kwd "=" value))))
13853 ((?r ?R ?/) (call-interactively 'org-occur))
13854 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13856 (defvar org-occur-highlights nil
13857 "List of overlays used for occur matches.")
13858 (make-variable-buffer-local 'org-occur-highlights)
13859 (defvar org-occur-parameters nil
13860 "Parameters of the active org-occur calls.
13861 This is a list, each call to org-occur pushes as cons cell,
13862 containing the regular expression and the callback, onto the list.
13863 The list can contain several entries if `org-occur' has been called
13864 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13865 will only contain one set of parameters. When the highlights are
13866 removed (for example with `C-c C-c', or with the next edit (depending
13867 on `org-remove-highlights-with-change'), this variable is emptied
13869 (make-variable-buffer-local 'org-occur-parameters)
13871 (defun org-occur (regexp &optional keep-previous callback)
13872 "Make a compact tree which shows all matches of REGEXP.
13873 The tree will show the lines where the regexp matches, and all higher
13874 headlines above the match. It will also show the heading after the match,
13875 to make sure editing the matching entry is easy.
13876 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13877 call to `org-occur' will be kept, to allow stacking of calls to this
13879 If CALLBACK is non-nil, it is a function which is called to confirm
13880 that the match should indeed be shown."
13881 (interactive "sRegexp: \nP")
13882 (when (equal regexp "")
13883 (user-error "Regexp cannot be empty"))
13884 (unless keep-previous
13885 (org-remove-occur-highlights nil nil t))
13886 (push (cons regexp callback) org-occur-parameters)
13889 (goto-char (point-min))
13890 (if (or (not keep-previous) ; do not want to keep
13891 (not org-occur-highlights)) ; no previous matches
13894 (while (re-search-forward regexp nil t)
13895 (when (or (not callback)
13896 (save-match-data (funcall callback)))
13897 (setq cnt (1+ cnt))
13898 (when org-highlight-sparse-tree-matches
13899 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13900 (org-show-context 'occur-tree))))
13901 (when org-remove-highlights-with-change
13902 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13904 (unless org-sparse-tree-open-archived-trees
13905 (org-hide-archived-subtrees (point-min) (point-max)))
13906 (run-hooks 'org-occur-hook)
13907 (if (org-called-interactively-p 'interactive)
13908 (message "%d match(es) for regexp %s" cnt regexp))
13911 (defun org-occur-next-match (&optional n reset)
13912 "Function for `next-error-function' to find sparse tree matches.
13913 N is the number of matches to move, when negative move backwards.
13914 RESET is entirely ignored - this function always goes back to the
13915 starting point when no match is found."
13916 (let* ((limit (if (< n 0) (point-min) (point-max)))
13917 (search-func (if (< n 0)
13918 'previous-single-char-property-change
13919 'next-single-char-property-change))
13924 (while (setq p1 (funcall search-func (point) 'org-type))
13925 (when (equal p1 limit)
13927 (user-error "No more matches"))
13928 (when (equal (get-char-property p1 'org-type) 'org-occur)
13932 (throw 'exit (point))))
13935 (user-error "No more matches"))))
13937 (defun org-show-context (&optional key)
13938 "Make sure point and context are visible.
13939 Optional argument KEY, when non-nil, is a symbol. See
13940 `org-show-context-detail' for allowed values and how much is to
13942 (org-show-set-visibility
13943 (cond ((symbolp org-show-context-detail) org-show-context-detail)
13944 ((cdr (assq key org-show-context-detail)))
13945 (t (cdr (assq 'default org-show-context-detail))))))
13947 (defun org-show-set-visibility (detail)
13948 "Set visibility around point according to DETAIL.
13949 DETAIL is either nil, `minimal', `local', `ancestors', `lineage',
13950 `tree', `canonical' or t. See `org-show-context-detail' for more
13952 (unless (org-before-first-heading-p)
13953 ;; Show current heading and possibly its entry, following headline
13954 ;; or all children.
13955 (if (and (org-at-heading-p) (not (eq detail 'local)))
13956 (org-flag-heading nil)
13958 (org-with-limited-levels
13960 ((tree canonical t) (show-children))
13961 ((nil minimal ancestors))
13963 (outline-next-heading)
13964 (org-flag-heading nil))))))
13965 ;; Show all siblings.
13966 (when (eq detail 'lineage) (org-show-siblings))
13967 ;; Show ancestors, possibly with their children.
13968 (when (memq detail '(ancestors lineage tree canonical t))
13970 (while (org-up-heading-safe)
13971 (org-flag-heading nil)
13972 (when (memq detail '(canonical t)) (org-show-entry))
13973 (when (memq detail '(tree canonical t)) (show-children)))))))
13975 (defvar org-reveal-start-hook nil
13976 "Hook run before revealing a location.")
13978 (defun org-reveal (&optional siblings)
13979 "Show current entry, hierarchy above it, and the following headline.
13981 This can be used to show a consistent set of context around
13982 locations exposed with `org-show-context'.
13984 With optional argument SIBLINGS, on each level of the hierarchy all
13985 siblings are shown. This repairs the tree structure to what it would
13986 look like when opened with hierarchical calls to `org-cycle'.
13988 With double optional argument \\[universal-argument] \\[universal-argument], \
13989 go to the parent and show the
13992 (run-hooks 'org-reveal-start-hook)
13993 (cond ((equal siblings '(4)) (org-show-set-visibility 'canonical))
13994 ((equal siblings '(16))
13996 (when (org-up-heading-safe)
13998 (run-hook-with-args 'org-cycle-hook 'subtree))))
13999 (t (org-show-set-visibility 'lineage))))
14001 (defun org-highlight-new-match (beg end)
14002 "Highlight from BEG to END and mark the highlight is an occur headline."
14003 (let ((ov (make-overlay beg end)))
14004 (overlay-put ov 'face 'secondary-selection)
14005 (overlay-put ov 'org-type 'org-occur)
14006 (push ov org-occur-highlights)))
14008 (defun org-remove-occur-highlights (&optional beg end noremove)
14009 "Remove the occur highlights from the buffer.
14010 BEG and END are ignored. If NOREMOVE is nil, remove this function
14011 from the `before-change-functions' in the current buffer."
14013 (unless org-inhibit-highlight-removal
14014 (mapc 'delete-overlay org-occur-highlights)
14015 (setq org-occur-highlights nil)
14016 (setq org-occur-parameters nil)
14018 (remove-hook 'before-change-functions
14019 'org-remove-occur-highlights 'local))))
14023 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
14024 "Regular expression matching the priority indicator.")
14026 (defvar org-remove-priority-next-time nil)
14028 (defun org-priority-up ()
14029 "Increase the priority of the current item."
14031 (org-priority 'up))
14033 (defun org-priority-down ()
14034 "Decrease the priority of the current item."
14036 (org-priority 'down))
14038 (defun org-priority (&optional action show)
14039 "Change the priority of an item.
14040 ACTION can be `set', `up', `down', or a character."
14042 (if (equal action '(4))
14043 (org-show-priority)
14044 (unless org-enable-priority-commands
14045 (user-error "Priority commands are disabled"))
14046 (setq action (or action 'set))
14047 (let (current new news have remove)
14049 (org-back-to-heading t)
14050 (if (looking-at org-priority-regexp)
14051 (setq current (string-to-char (match-string 2))
14054 ((eq action 'remove)
14055 (setq remove t new ?\ ))
14056 ((or (eq action 'set)
14057 (if (featurep 'xemacs) (characterp action) (integerp action)))
14058 (if (not (eq action 'set))
14060 (message "Priority %c-%c, SPC to remove: "
14061 org-highest-priority org-lowest-priority)
14063 (setq new (read-char-exclusive))))
14064 (if (and (= (upcase org-highest-priority) org-highest-priority)
14065 (= (upcase org-lowest-priority) org-lowest-priority))
14066 (setq new (upcase new)))
14067 (cond ((equal new ?\ ) (setq remove t))
14068 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14069 (user-error "Priority must be between `%c' and `%c'"
14070 org-highest-priority org-lowest-priority))))
14073 (1- current) ; normal cycling
14074 ;; last priority was empty
14075 (if (eq last-command this-command)
14076 org-lowest-priority ; wrap around empty to lowest
14078 (if org-priority-start-cycle-with-default
14079 org-default-priority
14080 (1- org-default-priority))))))
14083 (1+ current) ; normal cycling
14084 ;; last priority was empty
14085 (if (eq last-command this-command)
14086 org-highest-priority ; wrap around empty to highest
14088 (if org-priority-start-cycle-with-default
14089 org-default-priority
14090 (1+ org-default-priority))))))
14091 (t (user-error "Invalid action")))
14092 (if (or (< (upcase new) org-highest-priority)
14093 (> (upcase new) org-lowest-priority))
14094 (if (and (memq action '(up down))
14095 (not have) (not (eq last-command this-command)))
14096 ;; `new' is from default priority
14098 "The default can not be set, see `org-default-priority' why")
14099 ;; normal cycling: `new' is beyond highest/lowest priority
14100 ;; and is wrapped around to the empty priority
14102 (setq news (format "%c" new))
14105 (replace-match "" t t nil 1)
14106 (replace-match news t t nil 2))
14108 (user-error "No priority cookie found in line")
14109 (let ((case-fold-search nil))
14110 (looking-at org-todo-line-regexp))
14113 (goto-char (match-end 2))
14114 (insert " [#" news "]"))
14115 (goto-char (match-beginning 3))
14116 (insert "[#" news "] "))))
14117 (org-set-tags nil 'align))
14119 (message "Priority removed")
14120 (message "Priority of current item set to %s" news)))))
14122 (defun org-show-priority ()
14123 "Show the priority of the current item.
14124 This priority is composed of the main priority given with the [#A] cookies,
14125 and by additional input from the age of a schedules or deadline entry."
14127 (let ((pri (if (eq major-mode 'org-agenda-mode)
14128 (org-get-at-bol 'priority)
14131 (beginning-of-line)
14132 (and (looking-at org-heading-regexp)
14133 (org-get-priority (match-string 0))))))))
14134 (message "Priority is %d" (if pri pri -1000))))
14136 (defun org-get-priority (s)
14137 "Find priority cookie and return priority."
14139 (if (functionp org-get-priority-function)
14140 (funcall org-get-priority-function)
14141 (if (not (string-match org-priority-regexp s))
14142 (* 1000 (- org-lowest-priority org-default-priority))
14143 (* 1000 (- org-lowest-priority
14144 (string-to-char (match-string 2 s))))))))
14148 (defvar org-agenda-archives-mode)
14149 (defvar org-map-continue-from nil
14150 "Position from where mapping should continue.
14151 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14153 (defvar org-scanner-tags nil
14154 "The current tag list while the tags scanner is running.")
14155 (defvar org-trust-scanner-tags nil
14156 "Should `org-get-tags-at' use the tags for the scanner.
14157 This is for internal dynamical scoping only.
14158 When this is non-nil, the function `org-get-tags-at' will return the value
14159 of `org-scanner-tags' instead of building the list by itself. This
14160 can lead to large speed-ups when the tags scanner is used in a file with
14161 many entries, and when the list of tags is retrieved, for example to
14162 obtain a list of properties. Building the tags list for each entry in such
14163 a file becomes an N^2 operation - but with this variable set, it scales
14166 (defun org-scan-tags (action matcher todo-only &optional start-level)
14167 "Scan headline tags with inheritance and produce output ACTION.
14169 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14170 or `agenda' to produce an entry list for an agenda view. It can also be
14171 a Lisp form or a function that should be called at each matched headline, in
14172 this case the return value is a list of all return values from these calls.
14174 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14175 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14176 only lines with a not-done TODO keyword are included in the output.
14177 This should be the same variable that was scoped into
14178 and set by `org-make-tags-matcher' when it constructed MATCHER.
14180 START-LEVEL can be a string with asterisks, reducing the scope to
14181 headlines matching this string."
14182 (require 'org-agenda)
14183 (let* ((re (concat "^"
14185 ;; Get the correct level to match
14186 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14187 org-outline-regexp)
14189 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14190 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14191 (props (list 'face 'default
14192 'done-face 'org-agenda-done
14193 'undone-face 'default
14194 'mouse-face 'highlight
14195 'org-not-done-regexp org-not-done-regexp
14196 'org-todo-regexp org-todo-regexp
14197 'org-complex-heading-regexp org-complex-heading-regexp
14199 (format "mouse-2 or RET jump to org file %s"
14200 (abbreviate-file-name
14201 (or (buffer-file-name (buffer-base-buffer))
14202 (buffer-name (buffer-base-buffer)))))))
14203 (org-map-continue-from nil)
14204 lspos tags tags-list
14205 (tags-alist (list (cons 0 org-file-tags)))
14206 (llast 0) rtn rtn1 level category i txt
14207 todo marker entry priority
14208 ts-date ts-date-type ts-date-pair)
14209 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14210 (setq action (list 'lambda nil action)))
14212 (goto-char (point-min))
14213 (when (eq action 'sparse-tree)
14215 (org-remove-occur-highlights))
14216 (while (let (case-fold-search)
14217 (re-search-forward re nil t))
14218 (setq org-map-continue-from nil)
14220 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14221 tags (if (match-end 4) (org-match-string-no-properties 4)))
14222 (goto-char (setq lspos (match-beginning 0)))
14223 (setq level (org-reduced-level (org-outline-level))
14224 category (org-get-category))
14225 (when (eq action 'agenda)
14226 (setq ts-date-pair (org-agenda-entry-get-agenda-timestamp (point))
14227 ts-date (car ts-date-pair)
14228 ts-date-type (cdr ts-date-pair)))
14229 (setq i llast llast level)
14230 ;; remove tag lists from same and sublevels
14231 (while (>= i level)
14232 (when (setq entry (assoc i tags-alist))
14233 (setq tags-alist (delete entry tags-alist)))
14235 ;; add the next tags
14237 (setq tags (org-split-string tags ":")
14239 (cons (cons level tags) tags-alist)))
14240 ;; compile tags for current headline
14242 (if org-use-tag-inheritance
14243 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14245 org-scanner-tags tags-list)
14246 (when org-use-tag-inheritance
14247 (setcdr (car tags-alist)
14248 (mapcar (lambda (x)
14249 (setq x (copy-sequence x))
14250 (org-add-prop-inherited x))
14251 (cdar tags-alist))))
14252 (when (and tags org-use-tag-inheritance
14253 (or (not (eq t org-use-tag-inheritance))
14254 org-tags-exclude-from-inheritance))
14255 ;; selective inheritance, remove uninherited ones
14256 (setcdr (car tags-alist)
14257 (org-remove-uninherited-tags (cdar tags-alist))))
14260 ;; eval matcher only when the todo condition is OK
14261 (and (or (not todo-only) (member todo org-not-done-keywords))
14262 (let ((case-fold-search t) (org-trust-scanner-tags t))
14265 ;; Call the skipper, but return t if it does not skip,
14266 ;; so that the `and' form continues evaluating
14268 (unless (eq action 'sparse-tree) (org-agenda-skip))
14271 ;; Check if timestamps are deselecting this entry
14272 (or (not todo-only)
14273 (and (member todo org-not-done-keywords)
14274 (or (not org-agenda-tags-todo-honor-ignore-options)
14275 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14277 ;; select this headline
14279 ((eq action 'sparse-tree)
14280 (and org-highlight-sparse-tree-matches
14281 (org-get-heading) (match-end 0)
14282 (org-highlight-new-match
14283 (match-beginning 1) (match-end 1)))
14284 (org-show-context 'tags-tree))
14285 ((eq action 'agenda)
14286 (setq txt (org-agenda-format-item
14289 (if (eq org-tags-match-list-sublevels 'indented)
14290 (make-string (1- level) ?.) "")
14292 (make-string level ?\s)
14295 priority (org-get-priority txt))
14297 (setq marker (org-agenda-new-marker))
14298 (org-add-props txt props
14299 'org-marker marker 'org-hd-marker marker 'org-category category
14303 'type (concat "tagsmatch" ts-date-type))
14305 ((functionp action)
14306 (setq org-map-continue-from nil)
14308 (setq rtn1 (funcall action))
14310 (t (user-error "Invalid action")))
14312 ;; if we are to skip sublevels, jump to end of subtree
14313 (unless org-tags-match-list-sublevels
14314 (org-end-of-subtree t)
14315 (backward-char 1))))
14316 ;; Get the correct position from where to continue
14317 (if org-map-continue-from
14318 (goto-char org-map-continue-from)
14319 (and (= (point) lspos) (end-of-line 1)))))
14320 (when (and (eq action 'sparse-tree)
14321 (not org-sparse-tree-open-archived-trees))
14322 (org-hide-archived-subtrees (point-min) (point-max)))
14325 (defun org-remove-uninherited-tags (tags)
14326 "Remove all tags that are not inherited from the list TAGS."
14328 ((eq org-use-tag-inheritance t)
14329 (if org-tags-exclude-from-inheritance
14330 (org-delete-all org-tags-exclude-from-inheritance tags)
14332 ((not org-use-tag-inheritance) nil)
14333 ((stringp org-use-tag-inheritance)
14336 (if (and (string-match org-use-tag-inheritance x)
14337 (not (member x org-tags-exclude-from-inheritance)))
14340 ((listp org-use-tag-inheritance)
14343 (if (member x org-use-tag-inheritance) x nil))
14346 (defun org-match-sparse-tree (&optional todo-only match)
14347 "Create a sparse tree according to tags string MATCH.
14348 MATCH can contain positive and negative selection of tags, like
14349 \"+WORK+URGENT-WITHBOSS\".
14350 If optional argument TODO-ONLY is non-nil, only select lines that are
14353 (org-agenda-prepare-buffers (list (current-buffer)))
14354 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14356 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14358 (defvar org-cached-props nil)
14359 (defun org-cached-entry-get (pom property)
14360 (if (or (eq t org-use-property-inheritance)
14361 (and (stringp org-use-property-inheritance)
14362 (let ((case-fold-search t))
14363 (org-string-match-p org-use-property-inheritance property)))
14364 (and (listp org-use-property-inheritance)
14365 (member-ignore-case property org-use-property-inheritance)))
14366 ;; Caching is not possible, check it directly.
14367 (org-entry-get pom property 'inherit)
14368 ;; Get all properties, so we can do complicated checks easily.
14369 (cdr (assoc-string property
14370 (or org-cached-props
14371 (setq org-cached-props (org-entry-properties pom)))
14374 (defun org-global-tags-completion-table (&optional files)
14375 "Return the list of all tags in all agenda buffer/files.
14376 Optional FILES argument is a list of files which can be used
14377 instead of the agenda files."
14384 (set-buffer (find-file-noselect file))
14385 (append (org-get-buffer-tags)
14386 (mapcar (lambda (x) (if (stringp (car-safe x))
14387 (list (car-safe x)) nil))
14389 (if (and files (car files))
14391 (org-agenda-files))))))))
14393 (defun org-make-tags-matcher (match)
14394 "Create the TAGS/TODO matcher form for the selection string MATCH.
14396 The variable `todo-only' is scoped dynamically into this function.
14397 It will be set to t if the matcher restricts matching to TODO entries,
14398 otherwise will not be touched.
14400 Returns a cons of the selection string MATCH and the constructed
14401 lisp form implementing the matcher. The matcher is to be evaluated
14402 at an Org entry, with point on the headline, and returns t if the
14403 entry matches the selection string MATCH. The returned lisp form
14404 references two variables with information about the entry, which
14405 must be bound around the form's evaluation: todo, the TODO keyword
14406 at the entry (or nil of none); and tags-list, the list of all tags
14407 at the entry including inherited ones. Additionally, the category
14408 of the entry (if any) must be specified as the text property
14409 'org-category on the headline.
14411 See also `org-scan-tags'.
14413 (declare (special todo-only))
14414 (unless (boundp 'todo-only)
14415 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14417 ;; Get a new match request, with completion against the global
14418 ;; tags table and the local tags in current buffer
14419 (let ((org-last-tags-completion-table
14421 (delq nil (append (org-get-buffer-tags)
14422 (org-global-tags-completion-table))))))
14423 (setq match (org-completing-read-no-i
14424 "Match: " 'org-tags-completion-function nil nil nil
14425 'org-tags-history))))
14427 ;; Parse the string and create a lisp form
14428 (let ((match0 match)
14429 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14431 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14432 orterms term orlist re-p str-p level-p level-op time-p
14433 prop-p pn pv po gv rest (start 0) (ss 0))
14434 ;; Expand group tags
14435 (setq match (org-tags-expand match))
14437 ;; Check if there is a TODO part of this match, which would be the
14438 ;; part after a "/". TO make sure that this slash is not part of
14439 ;; a property value to be matched against, we also check that there
14440 ;; is no " after that slash.
14441 ;; First, find the last slash
14442 (while (string-match "/+" match ss)
14443 (setq start (match-beginning 0) ss (match-end 0)))
14444 (if (and (string-match "/+" match start)
14445 (not (save-match-data (string-match "\"" match start))))
14446 ;; match contains also a todo-matching request
14448 (setq tagsmatch (substring match 0 (match-beginning 0))
14449 todomatch (substring match (match-end 0)))
14450 (if (string-match "^!" todomatch)
14451 (setq todo-only t todomatch (substring todomatch 1)))
14452 (if (string-match "^\\s-*$" todomatch)
14453 (setq todomatch nil)))
14454 ;; only matching tags
14455 (setq tagsmatch match todomatch nil))
14457 ;; Make the tags matcher
14458 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14459 (setq tagsmatcher t)
14460 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14461 (while (setq term (pop orterms))
14462 (while (and (equal (substring term -1) "\\") orterms)
14463 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14464 (while (string-match re term)
14465 (setq rest (substring term (match-end 0))
14466 minus (and (match-end 1)
14467 (equal (match-string 1 term) "-"))
14468 tag (save-match-data (replace-regexp-in-string
14470 (match-string 2 term)))
14471 re-p (equal (string-to-char tag) ?{)
14472 level-p (match-end 4)
14473 prop-p (match-end 5)
14475 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14477 (setq level-op (org-op-to-function (match-string 3 term)))
14478 `(,level-op level ,(string-to-number
14479 (match-string 4 term))))
14481 (setq pn (match-string 5 term)
14482 po (match-string 6 term)
14483 pv (match-string 7 term)
14484 re-p (equal (string-to-char pv) ?{)
14485 str-p (equal (string-to-char pv) ?\")
14486 time-p (save-match-data
14487 (string-match "^\"[[<].*[]>]\"$" pv))
14488 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14489 (if time-p (setq pv (org-matcher-time pv)))
14490 (setq po (org-op-to-function po (if time-p 'time str-p)))
14492 ((equal pn "CATEGORY")
14493 (setq gv '(get-text-property (point) 'org-category)))
14497 (setq gv `(org-cached-entry-get nil ,pn))))
14500 `(not (string-match ,pv (or ,gv "")))
14501 `(string-match ,pv (or ,gv "")))
14503 `(,po (or ,gv "") ,pv)
14504 `(,po (string-to-number (or ,gv ""))
14505 ,(string-to-number pv) ))))
14506 (t `(member ,tag tags-list)))
14507 mm (if minus (list 'not mm) mm)
14509 (push mm tagsmatcher))
14510 (push (if (> (length tagsmatcher) 1)
14511 (cons 'and tagsmatcher)
14514 (setq tagsmatcher nil))
14515 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14517 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14518 ;; Make the todo matcher
14519 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14520 (setq todomatcher t)
14521 (setq orterms (org-split-string todomatch "|") orlist nil)
14522 (while (setq term (pop orterms))
14523 (while (string-match re term)
14524 (setq minus (and (match-end 1)
14525 (equal (match-string 1 term) "-"))
14526 kwd (match-string 2 term)
14527 re-p (equal (string-to-char kwd) ?{)
14528 term (substring term (match-end 0))
14530 `(string-match ,(substring kwd 1 -1) todo)
14531 (list 'equal 'todo kwd))
14532 mm (if minus (list 'not mm) mm))
14533 (push mm todomatcher))
14534 (push (if (> (length todomatcher) 1)
14535 (cons 'and todomatcher)
14538 (setq todomatcher nil))
14539 (setq todomatcher (if (> (length orlist) 1)
14540 (cons 'or orlist) (car orlist))))
14542 ;; Return the string and lisp forms of the matcher
14543 (setq matcher (if todomatcher
14544 (list 'and tagsmatcher todomatcher)
14547 (setq matcher (list 'and '(member todo org-not-done-keywords)
14549 (cons match0 matcher)))
14551 (defun org-tags-expand (match &optional single-as-list downcased tags-already-expanded)
14552 "Expand group tags in MATCH.
14554 This replaces every group tag in MATCH with a regexp tag search.
14555 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14556 will be replaced like this:
14558 Work => {\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14559 +Work => +{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14560 -Work => -{\\<\\(?:Work\\|Lab\\|Conf\\)\\>}
14562 Replacing by a regexp preserves the structure of the match.
14563 E.g., this expansion
14565 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14567 will match anything tagged with \"Lab\" and \"Home\", or tagged
14568 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14570 A group tag in MATCH can contain regular expressions of its own.
14571 For example, a group tag \"Proj\" defined as { Proj : {P@.+} }
14572 will be replaced like this:
14574 Proj => {\\<\\(?:Proj\\)\\>\\|P@.+}
14576 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14577 assumed to be a single group tag, and the function will return
14578 the list of tags in this group.
14580 When DOWNCASE is non-nil, expand downcased TAGS."
14582 (let* ((case-fold-search t)
14583 (stable org-mode-syntax-table)
14584 (taggroups (or org-tag-groups-alist-for-agenda org-tag-groups-alist))
14585 (taggroups (if downcased
14586 (mapcar (lambda (tg) (mapcar #'downcase tg))
14589 (taggroups-keys (mapcar #'car taggroups))
14590 (return-match (if downcased (downcase match) match))
14592 (work-already-expanded tags-already-expanded)
14593 regexps-in-match tags-in-group regexp-in-group regexp-in-group-escaped)
14594 ;; @ and _ are allowed as word-components in tags.
14595 (modify-syntax-entry ?@ "w" stable)
14596 (modify-syntax-entry ?_ "w" stable)
14597 ;; Temporarily replace regexp-expressions in the match-expression.
14598 (while (string-match "{.+?}" return-match)
14600 (push (match-string 0 return-match) regexps-in-match)
14601 (setq return-match (replace-match (format "<%d>" count) t nil return-match)))
14602 (while (and taggroups-keys
14603 (with-syntax-table stable
14605 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14606 (regexp-opt taggroups-keys) "\\>\\)") return-match)))
14607 (let* ((dir (match-string 1 return-match))
14608 (tag (match-string 2 return-match))
14609 (tag (if downcased (downcase tag) tag)))
14610 (unless (or (get-text-property 0 'grouptag (match-string 2 return-match))
14611 (member tag work-already-expanded))
14612 (setq tags-in-group (assoc tag taggroups))
14613 (push tag work-already-expanded)
14614 ;; Recursively expand each tag in the group, if the tag hasn't
14615 ;; already been expanded. Restore the match-data after all recursive calls.
14617 (let (tags-expanded)
14618 (dolist (x (cdr tags-in-group))
14619 (if (and (member x taggroups-keys)
14620 (not (member x work-already-expanded)))
14621 (setq tags-expanded
14624 (org-tags-expand x t downcased
14625 work-already-expanded)
14627 (setq tags-expanded
14628 (append (list x) tags-expanded)))
14629 (setq work-already-expanded
14631 (append tags-expanded
14632 work-already-expanded))))
14633 (setq tags-in-group
14634 (delete-dups (cons (car tags-in-group)
14636 ;; Filter tag-regexps from tags.
14637 (setq regexp-in-group-escaped
14638 (delq nil (mapcar (lambda (x)
14640 (and (equal "{" (substring x 0 1))
14641 (equal "}" (substring x -1))
14646 (mapcar (lambda (x)
14647 (substring x 1 -1))
14648 regexp-in-group-escaped)
14650 (delq nil (mapcar (lambda (x)
14652 (and (not (equal "{" (substring x 0 1)))
14653 (not (equal "}" (substring x -1)))
14657 ;; If single-as-list, do no more in the while-loop.
14658 (if (not single-as-list)
14660 (when regexp-in-group
14661 (setq regexp-in-group
14663 (mapconcat 'identity regexp-in-group
14665 (setq tags-in-group
14668 (regexp-opt tags-in-group)
14672 (when (stringp tags-in-group)
14673 (org-add-props tags-in-group '(grouptag t)))
14675 (replace-match tags-in-group t t return-match)))
14676 (setq tags-in-group
14677 (append regexp-in-group-escaped tags-in-group))))
14678 (setq taggroups-keys (delete tag taggroups-keys))))
14679 ;; Add the regular expressions back into the match-expression again.
14680 (while regexps-in-match
14681 (setq return-match (replace-regexp-in-string (format "<%d>" count)
14682 (pop regexps-in-match)
14686 (if tags-in-group tags-in-group (list return-match))
14689 (list (if downcased (downcase match) match))
14692 (defun org-op-to-function (op &optional stringp)
14693 "Turn an operator into the appropriate function."
14696 ((equal op "<" ) '(< string< org-time<))
14697 ((equal op ">" ) '(> org-string> org-time>))
14698 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14699 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14700 ((member op '("=" "==")) '(= string= org-time=))
14701 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14702 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14704 (defun org<> (a b) (not (= a b)))
14705 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14706 (defun org-string>= (a b) (not (string< a b)))
14707 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14708 (defun org-string<> (a b) (not (string= a b)))
14709 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14710 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14711 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14712 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14713 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14714 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14716 "Convert S to a floating point time.
14717 If S is already a number, just return it. If it is a string, parse
14718 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14722 (condition-case nil
14723 (float-time (apply 'encode-time (org-parse-time-string s)))
14727 (defun org-time-today ()
14728 "Time in seconds today at 0:00.
14729 Returns the float number of seconds since the beginning of the
14730 epoch to the beginning of today (00:00)."
14731 (float-time (apply 'encode-time
14732 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14734 (defun org-matcher-time (s)
14735 "Interpret a time comparison value."
14738 ((string= s "<now>") (float-time))
14739 ((string= s "<today>") (org-time-today))
14740 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14741 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14742 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14743 (+ (org-time-today)
14744 (* (string-to-number (match-string 1 s))
14745 (cdr (assoc (match-string 2 s)
14746 '(("d" . 86400.0) ("w" . 604800.0)
14747 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14750 (defun org-match-any-p (re list)
14751 "Does re match any element of list?"
14752 (setq list (mapcar (lambda (x) (string-match re x)) list))
14755 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14756 (defvar org-tags-overlay (make-overlay 1 1))
14757 (org-detach-overlay org-tags-overlay)
14759 (defun org-get-local-tags-at (&optional pos)
14760 "Get a list of tags defined in the current headline."
14761 (org-get-tags-at pos 'local))
14763 (defun org-get-local-tags ()
14764 "Get a list of tags defined in the current headline."
14765 (org-get-tags-at nil 'local))
14767 (defun org-get-tags-at (&optional pos local)
14768 "Get a list of all headline tags applicable at POS.
14769 POS defaults to point. If tags are inherited, the list contains
14770 the targets in the same sequence as the headlines appear, i.e.
14771 the tags of the current headline come last.
14772 When LOCAL is non-nil, only return tags from the current headline,
14773 ignore inherited ones."
14775 (if (and org-trust-scanner-tags
14776 (or (not pos) (equal pos (point)))
14779 (let (tags ltags lastpos parent)
14783 (goto-char (or pos (point)))
14786 (condition-case nil
14788 (org-back-to-heading t)
14789 (while (not (equal lastpos (point)))
14790 (setq lastpos (point))
14792 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14793 (setq ltags (org-split-string
14794 (org-match-string-no-properties 1) ":"))
14796 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14799 (org-remove-uninherited-tags ltags)
14802 (or org-use-tag-inheritance (throw 'done t))
14803 (if local (throw 'done t))
14804 (or (org-up-heading-safe) (error nil))
14809 (reverse (delete-dups
14811 (org-remove-uninherited-tags
14812 org-file-tags) tags)))))))))
14814 (defun org-add-prop-inherited (s)
14815 (add-text-properties 0 (length s) '(inherited t) s)
14818 (defun org-toggle-tag (tag &optional onoff)
14819 "Toggle the tag TAG for the current line.
14820 If ONOFF is `on' or `off', don't toggle but set to this state."
14823 (org-back-to-heading t)
14824 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14827 (setq current (match-string 1))
14828 (replace-match ""))
14830 (setq current (nreverse (org-split-string current ":")))
14834 (or (member tag current) (push tag current)))
14836 (or (not (member tag current)) (setq current (delete tag current))))
14837 (t (if (member tag current)
14838 (setq current (delete tag current))
14840 (push tag current))))
14844 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14845 (org-set-tags nil t))
14846 (delete-horizontal-space))
14847 (run-hooks 'org-after-tags-change-hook))
14850 (defun org-align-tags-here (to-col)
14851 ;; Assumes that this is a headline
14852 "Align tags on the current headline to TO-COL."
14853 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14854 (beginning-of-line 1)
14855 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14856 (< pos (match-beginning 2)))
14858 (setq tags-l (- (match-end 2) (match-beginning 2)))
14859 (goto-char (match-beginning 1))
14861 (delete-region (point) (1+ (match-beginning 2)))
14862 (setq ncol (max (current-column)
14866 (- (abs to-col) tags-l))))
14868 (insert (make-string (- ncol (current-column)) ?\ ))
14869 (setq ncol (current-column))
14870 (when indent-tabs-mode (tabify p (point-at-eol)))
14871 (org-move-to-column (min ncol col)))
14874 (defun org-set-tags-command (&optional arg just-align)
14875 "Call the set-tags command for the current entry."
14877 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14878 (org-set-tags arg just-align)
14880 (unless (and (org-region-active-p)
14881 org-loop-over-headlines-in-active-region)
14882 (org-back-to-heading t))
14883 (org-set-tags arg just-align))))
14885 (defun org-set-tags-to (data)
14886 "Set the tags of the current entry to DATA, replacing the current tags.
14887 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14888 If DATA is nil or the empty string, any tags will be removed."
14889 (interactive "sTags: ")
14893 ((equal data "") "")
14895 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14898 (concat ":" (mapconcat 'identity data ":") ":"))))
14901 (org-back-to-heading t)
14902 (when (looking-at org-complex-heading-regexp)
14905 (goto-char (match-beginning 5))
14907 (delete-region (point) (point-at-eol))
14908 (org-set-tags nil 'align))
14909 (goto-char (point-at-eol))
14911 (org-set-tags nil 'align)))
14912 (beginning-of-line 1)
14913 (if (looking-at ".*?\\([ \t]+\\)$")
14914 (delete-region (match-beginning 1) (match-end 1))))))
14916 (defun org-align-all-tags ()
14917 "Align the tags i all headings."
14920 (or (ignore-errors (org-back-to-heading t))
14921 (outline-next-heading))
14922 (if (org-at-heading-p)
14924 (message "No headings"))))
14926 (defvar org-indent-indentation-per-level)
14927 (defun org-set-tags (&optional arg just-align)
14928 "Set the tags for the current headline.
14929 With prefix ARG, realign all tags in headings in the current buffer.
14930 When JUST-ALIGN is non-nil, only align tags."
14932 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14933 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14934 'region-start-level 'region))
14935 org-loop-over-headlines-in-active-region)
14937 ;; We don't use ARG and JUST-ALIGN here because these args
14938 ;; are not useful when looping over headlines.
14940 org-loop-over-headlines-in-active-region
14941 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14942 (let* ((re org-outline-regexp-bol)
14943 (current (unless arg (org-get-tags-string)))
14944 (col (current-column))
14945 (org-setting-tags t)
14946 table current-tags inherited-tags ; computed below when needed
14947 tags p0 c0 c1 rpl di tc level)
14950 (goto-char (point-min))
14951 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14952 (while (re-search-forward re nil t)
14953 (org-set-tags nil t)
14955 (message "All tags realigned to column %d" org-tags-column))
14957 (setq tags current)
14958 ;; Get a new set of tags from the user
14960 (setq table (append org-tag-persistent-alist
14961 (or org-tag-alist (org-get-buffer-tags))
14963 org-complete-tags-always-offer-all-agenda-tags
14964 (org-global-tags-completion-table
14965 (org-agenda-files))))
14966 org-last-tags-completion-table table
14967 current-tags (org-split-string current ":")
14968 inherited-tags (nreverse
14969 (nthcdr (length current-tags)
14970 (nreverse (org-get-tags-at))))
14972 (if (or (eq t org-use-fast-tag-selection)
14973 (and org-use-fast-tag-selection
14974 (delq nil (mapcar 'cdr table))))
14975 (org-fast-tag-selection
14976 current-tags inherited-tags table
14977 (if org-fast-tag-selection-include-todo
14978 org-todo-key-alist))
14979 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14981 (org-icompleting-read "Tags: "
14982 'org-tags-completion-function
14983 nil nil current 'org-tags-history))))))
14984 (while (string-match "[-+&]+" tags)
14985 ;; No boolean logic, just a list
14986 (setq tags (replace-match ":" t t tags))))
14988 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14990 (if org-tags-sort-function
14991 (setq tags (mapconcat 'identity
14992 (sort (org-split-string
14993 tags (org-re "[^[:alnum:]_@#%]+"))
14994 org-tags-sort-function) ":")))
14996 (if (string-match "\\`[\t ]*\\'" tags)
14998 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14999 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
15001 ;; Insert new tags at the correct column
15002 (beginning-of-line 1)
15003 (setq level (or (and (looking-at org-outline-regexp)
15004 (- (match-end 0) (point) 1))
15007 ((and (equal current "") (equal tags "")))
15008 ((re-search-forward
15009 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
15011 (if (equal tags "")
15013 (goto-char (match-beginning 0))
15014 (setq c0 (current-column)
15015 ;; compute offset for the case of org-indent-mode active
15016 di (if (org-bound-and-true-p org-indent-mode)
15017 (* (1- org-indent-indentation-per-level) (1- level))
15019 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
15020 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
15021 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
15022 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
15023 (replace-match rpl t t)
15024 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
15026 (t (error "Tags alignment failed")))
15027 (org-move-to-column col)
15029 (run-hooks 'org-after-tags-change-hook))))))
15031 (defun org-change-tag-in-region (beg end tag off)
15032 "Add or remove TAG for each entry in the region.
15033 This works in the agenda, and also in an org-mode buffer."
15035 (list (region-beginning) (region-end)
15036 (let ((org-last-tags-completion-table
15037 (if (derived-mode-p 'org-mode)
15039 (delq nil (append (org-get-buffer-tags)
15040 (org-global-tags-completion-table))))
15041 (org-global-tags-completion-table))))
15042 (org-icompleting-read
15043 "Tag: " 'org-tags-completion-function nil nil nil
15044 'org-tags-history))
15046 (message "[s]et or
[r]emove? ")
15047 (equal (read-char-exclusive) ?r))))
15048 (if (fboundp 'deactivate-mark) (deactivate-mark))
15049 (let ((agendap (equal major-mode 'org-agenda-mode))
15050 l1 l2 m buf pos newhead (cnt 0))
15052 (setq l2 (1- (org-current-line)))
15054 (setq l1 (org-current-line))
15055 (loop for l from l1 to l2 do
15057 (setq m (get-text-property (point) 'org-hd-marker))
15058 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
15060 (setq buf (if agendap (marker-buffer m) (current-buffer))
15061 pos (if agendap m (point)))
15062 (with-current-buffer buf
15066 (setq cnt (1+ cnt))
15067 (org-toggle-tag tag (if off 'off 'on))
15068 (setq newhead (org-get-heading)))))
15069 (and agendap (org-agenda-change-all-lines newhead m))))
15070 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
15072 (defun org-tags-completion-function (string predicate &optional flag)
15073 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
15074 (confirm (lambda (x) (stringp (car x)))))
15075 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
15076 (setq s1 (match-string 1 string)
15077 s2 (match-string 2 string))
15078 (setq s1 "" s2 string))
15082 (setq rtn (try-completion s2 ctable confirm))
15085 (concat s1 s2 (substring rtn (length s2))
15086 (if (and org-add-colon-after-tag-completion
15087 (assoc rtn ctable))
15092 (all-completions s2 ctable confirm))
15095 (assoc s2 ctable)))))
15097 (defun org-fast-tag-insert (kwd tags face &optional end)
15098 "Insert KDW, and the TAGS, the latter with face FACE.
15100 (insert (format "%-12s" (concat kwd ":"))
15101 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
15104 (defun org-fast-tag-show-exit (flag)
15107 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
15108 (replace-match ""))
15111 (org-move-to-column (- (window-width) 19) t)
15112 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
15114 (defun org-set-current-tags-overlay (current prefix)
15115 "Add an overlay to CURRENT tag with PREFIX."
15116 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
15117 (if (featurep 'xemacs)
15118 (org-overlay-display org-tags-overlay (concat prefix s)
15119 'secondary-selection)
15120 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
15121 (org-overlay-display org-tags-overlay (concat prefix s)))))
15123 (defvar org-last-tag-selection-key nil)
15124 (defun org-fast-tag-selection (current inherited table &optional todo-table)
15125 "Fast tag selection with single keys.
15126 CURRENT is the current list of tags in the headline, INHERITED is the
15127 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
15128 possibly with grouping information. TODO-TABLE is a similar table with
15129 TODO keywords, should these have keys assigned to them.
15130 If the keys are nil, a-z are automatically assigned.
15131 Returns the new tags string, or nil to not change the current settings."
15132 (let* ((fulltable (append table todo-table))
15133 (maxlen (apply 'max (mapcar
15135 (if (stringp (car x)) (string-width (car x)) 0))
15137 (buf (current-buffer))
15138 (expert (eq org-fast-tag-selection-single-key 'expert))
15140 (fwidth (+ maxlen 3 1 3))
15141 (ncol (/ (- (window-width) 4) fwidth))
15144 tg cnt e c char c1 c2 ntable tbl rtn
15145 ov-start ov-end ov-prefix
15146 (exit-after-next org-fast-tag-selection-single-key)
15147 (done-keywords org-done-keywords)
15148 groups ingroup intaggroup)
15150 (beginning-of-line 1)
15152 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15153 (setq ov-start (match-beginning 1)
15154 ov-end (match-end 1)
15156 (setq ov-start (1- (point-at-eol))
15157 ov-end (1+ ov-start))
15158 (skip-chars-forward "^\n\r")
15161 (buffer-substring (1- (point)) (point))
15162 (if (> (current-column) org-tags-column)
15164 (make-string (- org-tags-column (current-column)) ?\ ))))))
15165 (move-overlay org-tags-overlay ov-start ov-end)
15166 (save-window-excursion
15168 (set-buffer (get-buffer-create " *Org tags*"))
15169 (delete-other-windows)
15170 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15171 (org-switch-to-buffer-other-window " *Org tags*"))
15173 (org-set-local 'org-done-keywords done-keywords)
15174 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15175 (org-fast-tag-insert "Current" current c-face "\n\n")
15176 (org-fast-tag-show-exit exit-after-next)
15177 (org-set-current-tags-overlay current ov-prefix)
15178 (setq tbl fulltable char ?a cnt 0)
15179 (while (setq e (pop tbl))
15181 ((eq (car e) :startgroup)
15182 (push '() groups) (setq ingroup t)
15183 (unless (zerop cnt)
15186 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15187 ((eq (car e) :endgroup)
15188 (setq ingroup nil cnt 0)
15189 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15190 ((eq (car e) :startgrouptag)
15191 (setq intaggroup t)
15192 (unless (zerop cnt)
15196 ((eq (car e) :endgrouptag)
15197 (setq intaggroup nil cnt 0)
15199 ((equal e '(:newline))
15200 (unless (zerop cnt)
15204 (while (equal (car tbl) '(:newline))
15206 (setq tbl (cdr tbl)))))
15207 ((equal e '(:grouptags)) (insert " : "))
15209 (setq tg (copy-sequence (car e)) c2 nil)
15212 ;; automatically assign a character.
15213 (setq c1 (string-to-char
15214 (downcase (substring
15215 tg (if (= (string-to-char tg) ?@) 1 0)))))
15216 (if (or (rassoc c1 ntable) (rassoc c1 table))
15217 (while (or (rassoc char ntable) (rassoc char table))
15218 (setq char (1+ char)))
15220 (setq c (or c2 char)))
15221 (when ingroup (push tg (car groups)))
15222 (setq tg (org-add-props tg nil 'face
15224 ((not (assoc tg table))
15225 (org-get-todo-face tg))
15226 ((member tg current) c-face)
15227 ((member tg inherited) i-face))))
15228 (when (equal (caar tbl) :grouptags)
15229 (org-add-props tg nil 'face 'org-tag-group))
15230 (when (and (zerop cnt) (not ingroup) (not intaggroup)) (insert " "))
15231 (insert "[" c "] " tg (make-string
15232 (- fwidth 4 (length tg)) ?\ ))
15233 (push (cons tg c) ntable)
15234 (when (= (incf cnt) ncol)
15236 (when (or ingroup intaggroup) (insert " "))
15238 (setq ntable (nreverse ntable))
15240 (goto-char (point-min))
15241 (unless expert (org-fit-window-to-buffer))
15245 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15246 (if (not groups) "no " "")
15247 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15248 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15249 (setq org-last-tag-selection-key c)
15251 ((= c ?\r) (throw 'exit t))
15253 (setq groups (not groups))
15254 (goto-char (point-min))
15255 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15258 (org-fast-tag-show-exit
15259 (setq exit-after-next (not exit-after-next)))
15261 (delete-other-windows)
15262 (set-window-buffer (split-window-vertically) " *Org tags*")
15263 (org-switch-to-buffer-other-window " *Org tags*")
15264 (org-fit-window-to-buffer)))
15266 (and (= c ?q) (not (rassoc c ntable))))
15267 (org-detach-overlay org-tags-overlay)
15268 (setq quit-flag t))
15271 (when exit-after-next (setq exit-after-next 'now)))
15273 (condition-case nil
15274 (setq tg (org-icompleting-read
15277 (with-current-buffer buf
15278 (org-get-buffer-tags)))))
15279 (quit (setq tg "")))
15280 (when (string-match "\\S-" tg)
15281 (add-to-list 'buffer-tags (list tg))
15282 (if (member tg current)
15283 (setq current (delete tg current))
15284 (push tg current)))
15285 (when exit-after-next (setq exit-after-next 'now)))
15286 ((setq e (rassoc c todo-table) tg (car e))
15287 (with-current-buffer buf
15288 (save-excursion (org-todo tg)))
15289 (when exit-after-next (setq exit-after-next 'now)))
15290 ((setq e (rassoc c ntable) tg (car e))
15291 (if (member tg current)
15292 (setq current (delete tg current))
15293 (loop for g in groups do
15294 (when (member tg g)
15295 (dolist (x g) (setq current (delete x current)))))
15297 (when exit-after-next (setq exit-after-next 'now))))
15299 ;; Create a sorted list
15303 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15304 (when (eq exit-after-next 'now) (throw 'exit t))
15305 (goto-char (point-min))
15306 (beginning-of-line 2)
15307 (delete-region (point) (point-at-eol))
15308 (org-fast-tag-insert "Current" current c-face)
15309 (org-set-current-tags-overlay current ov-prefix)
15310 (while (re-search-forward
15311 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15312 (setq tg (match-string 1))
15313 (add-text-properties
15314 (match-beginning 1) (match-end 1)
15317 ((member tg current) c-face)
15318 ((member tg inherited) i-face)
15319 (t (get-text-property (match-beginning 1) 'face))))))
15320 (goto-char (point-min)))))
15321 (org-detach-overlay org-tags-overlay)
15323 (mapconcat 'identity current ":")
15326 (defun org-get-tags-string ()
15327 "Get the TAGS string in the current headline."
15328 (unless (org-at-heading-p t)
15329 (user-error "Not on a heading"))
15331 (beginning-of-line 1)
15332 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15333 (org-match-string-no-properties 1)
15336 (defun org-get-tags ()
15337 "Get the list of tags specified in the current headline."
15338 (org-split-string (org-get-tags-string) ":"))
15340 (defun org-get-buffer-tags ()
15341 "Get a table of all tags used in the buffer, for completion."
15342 (org-with-wide-buffer
15343 (goto-char (point-min))
15344 (let ((tag-re (concat org-outline-regexp-bol
15345 "\\(?:.*?[ \t]\\)?"
15346 (org-re ":\\([[:alnum:]_@#%:]+\\):[ \t]*$")))
15348 (while (re-search-forward tag-re nil t)
15349 (dolist (tag (org-split-string (org-match-string-no-properties 1) ":"))
15351 (mapcar #'list (append org-file-tags (org-uniquify tags))))))
15353 ;;;; The mapping API
15355 (defun org-map-entries (func &optional match scope &rest skip)
15356 "Call FUNC at each headline selected by MATCH in SCOPE.
15358 FUNC is a function or a lisp form. The function will be called without
15359 arguments, with the cursor positioned at the beginning of the headline.
15360 The return values of all calls to the function will be collected and
15361 returned as a list.
15363 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15364 does not need to preserve point. After evaluation, the cursor will be
15365 moved to the end of the line (presumably of the headline of the
15366 processed entry) and search continues from there. Under some
15367 circumstances, this may not produce the wanted results. For example,
15368 if you have removed (e.g. archived) the current (sub)tree it could
15369 mean that the next entry will be skipped entirely. In such cases, you
15370 can specify the position from where search should continue by making
15371 FUNC set the variable `org-map-continue-from' to the desired buffer
15374 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15375 Only headlines that are matched by this query will be considered during
15376 the iteration. When MATCH is nil or t, all headlines will be
15377 visited by the iteration.
15379 SCOPE determines the scope of this command. It can be any of:
15381 nil The current buffer, respecting the restriction if any
15382 tree The subtree started with the entry at point
15383 region The entries within the active region, if any
15385 The entries within the active region, but only those at
15386 the same level than the first one.
15387 file The current buffer, without restriction
15389 The current buffer, and any archives associated with it
15390 agenda All agenda files
15391 agenda-with-archives
15392 All agenda files with any archive files associated with them
15394 If this is a list, all files in the list will be scanned
15396 The remaining args are treated as settings for the skipping facilities of
15397 the scanner. The following items can be given here:
15399 archive skip trees with the archive tag
15400 comment skip trees with the COMMENT keyword
15401 function or Emacs Lisp form:
15402 will be used as value for `org-agenda-skip-function', so
15403 whenever the function returns a position, FUNC will not be
15404 called for that entry and search will continue from the
15407 If your function needs to retrieve the tags including inherited tags
15408 at the *current* entry, you can use the value of the variable
15409 `org-scanner-tags' which will be much faster than getting the value
15410 with `org-get-tags-at'. If your function gets properties with
15411 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15412 to t around the call to `org-entry-properties' to get the same speedup.
15413 Note that if your function moves around to retrieve tags and properties at
15414 a *different* entry, you cannot use these techniques."
15415 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15416 (not (org-region-active-p)))
15417 (let* ((org-agenda-archives-mode nil) ; just to make sure
15418 (org-agenda-skip-archived-trees (memq 'archive skip))
15419 (org-agenda-skip-comment-trees (memq 'comment skip))
15420 (org-agenda-skip-function
15421 (car (org-delete-all '(comment archive) skip)))
15422 (org-tags-match-list-sublevels t)
15423 (start-level (eq scope 'region-start-level))
15425 org-todo-keywords-for-agenda
15426 org-done-keywords-for-agenda
15427 org-todo-keyword-alist-for-agenda
15428 org-tag-alist-for-agenda
15432 ((eq match t) (setq matcher t))
15433 ((eq match nil) (setq matcher t))
15434 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15438 (cond ((eq scope 'tree)
15439 (org-back-to-heading t)
15440 (org-narrow-to-subtree)
15442 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15443 (org-region-active-p))
15444 ;; If needed, set start-level to a string like "2"
15447 (goto-char (region-beginning))
15448 (unless (org-at-heading-p) (outline-next-heading))
15449 (setq start-level (org-current-level))))
15450 (narrow-to-region (region-beginning)
15452 (goto-char (region-end))
15453 (unless (and (bolp) (org-at-heading-p))
15454 (outline-next-heading))
15460 (org-agenda-prepare-buffers
15461 (list (buffer-file-name (current-buffer))))
15462 (setq res (org-scan-tags func matcher todo-only start-level)))
15463 ;; Get the right scope
15465 ((and scope (listp scope) (symbolp (car scope)))
15466 (setq scope (eval scope)))
15467 ((eq scope 'agenda)
15468 (setq scope (org-agenda-files t)))
15469 ((eq scope 'agenda-with-archives)
15470 (setq scope (org-agenda-files t))
15471 (setq scope (org-add-archive-files scope)))
15473 (setq scope (list (buffer-file-name))))
15474 ((eq scope 'file-with-archives)
15475 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15476 (org-agenda-prepare-buffers scope)
15477 (while (setq file (pop scope))
15478 (with-current-buffer (org-find-base-buffer-visiting file)
15482 (goto-char (point-min))
15483 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15488 (defconst org-special-properties
15489 '("ALLTAGS" "BLOCKED" "CLOCKSUM" "CLOCKSUM_T" "CLOSED" "DEADLINE" "FILE"
15490 "ITEM" "PRIORITY" "SCHEDULED" "TAGS" "TIMESTAMP" "TIMESTAMP_IA" "TODO")
15491 "The special properties valid in Org mode.
15492 These are properties that are not defined in the property drawer,
15493 but in some other way.")
15495 (defconst org-default-properties
15496 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15497 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15498 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15499 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15500 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE" "UNNUMBERED"
15501 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15502 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15503 "Some properties that are used by Org mode for various purposes.
15504 Being in this list makes sure that they are offered for completion.")
15506 (defun org--update-property-plist (key val props)
15507 "Associate KEY to VAL in alist PROPS.
15508 Modifications are made by side-effect. Return new alist."
15509 (let* ((appending (string= (substring key -1) "+"))
15510 (key (if appending (substring key 0 -1) key))
15511 (old (assoc-string key props t)))
15512 (if (not old) (cons (cons key val) props)
15513 (setcdr old (if appending (concat (cdr old) " " val) val))
15516 (defun org-get-property-block (&optional beg force)
15517 "Return the (beg . end) range of the body of the property drawer.
15518 BEG is the beginning of the current subtree, or of the part
15519 before the first headline. If it is not given, it will be found.
15520 If the drawer does not exist, create it if FORCE is non-nil, or
15522 (org-with-wide-buffer
15523 (when beg (goto-char beg))
15524 (unless (org-before-first-heading-p)
15525 (let ((beg (cond (beg)
15526 ((or (not (featurep 'org-inlinetask))
15527 (org-inlinetask-in-task-p))
15528 (org-back-to-heading t))
15529 (t (org-with-limited-levels (org-back-to-heading t))))))
15531 (when (org-looking-at-p org-planning-line-re) (forward-line))
15532 (cond ((looking-at org-property-drawer-re)
15534 (cons (point) (progn (goto-char (match-end 0))
15535 (line-beginning-position))))
15538 (org-insert-property-drawer)
15539 (let ((pos (save-excursion (search-forward ":END:")
15540 (line-beginning-position))))
15541 (cons pos pos))))))))
15543 (defun org-at-property-p ()
15544 "Non-nil when point is inside a property drawer.
15545 See `org-property-re' for match data, if applicable."
15547 (beginning-of-line)
15548 (and (looking-at org-property-re)
15549 (let ((property-drawer (save-match-data (org-get-property-block))))
15550 (and property-drawer
15551 (>= (point) (car property-drawer))
15552 (< (point) (cdr property-drawer)))))))
15554 (defun org-property-action ()
15555 "Do an action on properties."
15557 (unless (org-at-property-p) (user-error "Not at a property"))
15558 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15559 (let ((c (read-char-exclusive)))
15561 (?s (call-interactively #'org-set-property))
15562 (?d (call-interactively #'org-delete-property))
15563 (?D (call-interactively #'org-delete-property-globally))
15564 (?c (call-interactively #'org-compute-property-at-point))
15565 (otherwise (user-error "No such property action %c" c)))))
15567 (defun org-inc-effort ()
15568 "Increment the value of the effort property in the current entry."
15570 (org-set-effort nil t))
15572 (defvar org-clock-effort) ; Defined in org-clock.el.
15573 (defvar org-clock-current-task) ; Defined in org-clock.el.
15574 (defun org-set-effort (&optional value increment)
15575 "Set the effort property of the current entry.
15576 With numerical prefix arg, use the nth allowed value, 0 stands for the
15577 10th allowed value.
15579 When INCREMENT is non-nil, set the property to the next allowed value."
15581 (if (equal value 0) (setq value 10))
15582 (let* ((completion-ignore-case t)
15583 (prop org-effort-property)
15584 (cur (org-entry-get nil prop))
15585 (allowed (org-property-get-allowed-values nil prop 'table))
15586 (existing (mapcar 'list (org-property-values prop)))
15587 (heading (nth 4 (org-heading-components)))
15590 ((stringp value) value)
15591 ((and allowed (integerp value))
15592 (or (car (nth (1- value) allowed))
15593 (car (org-last allowed))))
15594 ((and allowed increment)
15595 (or (caadr (member (list cur) allowed))
15596 (user-error "Allowed effort values are not set")))
15598 (message "Select 1-9,0, [RET%s]: %s"
15599 (if cur (concat "=" cur) "")
15600 (mapconcat 'car allowed " "))
15601 (setq rpl (read-char-exclusive))
15602 (if (equal rpl ?\r)
15604 (setq rpl (- rpl ?0))
15605 (if (equal rpl 0) (setq rpl 10))
15606 (if (and (> rpl 0) (<= rpl (length allowed)))
15607 (car (nth (1- rpl) allowed))
15608 (org-completing-read "Effort: " allowed nil))))
15610 (let (org-completion-use-ido org-completion-use-iswitchb)
15611 (org-completing-read
15612 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15613 (concat "[" cur "]") "")
15615 existing nil nil "" nil cur))))))
15616 (unless (equal (org-entry-get nil prop) val)
15617 (org-entry-put nil prop val))
15618 (org-refresh-property
15619 '((effort . identity)
15620 (effort-minutes . org-duration-string-to-minutes))
15622 (when (string= heading org-clock-current-task)
15623 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15624 (org-clock-update-mode-line))
15625 (message "%s is now %s" prop val)))
15627 (defun org-entry-properties (&optional pom which)
15628 "Get all properties of the current entry.
15630 When POM is a buffer position, get all properties from the entry
15633 This includes the TODO keyword, the tags, time strings for
15634 deadline, scheduled, and clocking, and any additional properties
15635 defined in the entry.
15637 If WHICH is nil or `all', get all properties. If WHICH is
15638 `special' or `standard', only get that subclass. If WHICH is
15639 a string, only get that property.
15641 Return value is an alist. Keys are properties, as upcased
15643 (org-with-point-at pom
15644 (when (and (derived-mode-p 'org-mode)
15645 (ignore-errors (org-back-to-heading t)))
15647 (let* ((beg (point))
15648 (specific (and (stringp which) (upcase which)))
15649 (which (cond ((not specific) which)
15650 ((member specific org-special-properties) 'special)
15653 ;; Get the special properties, like TODO and TAGS.
15654 (when (memq which '(nil all special))
15655 (when (or (not specific) (string= specific "CLOCKSUM"))
15656 (let ((clocksum (get-text-property (point) :org-clock-minutes)))
15658 (push (cons "CLOCKSUM"
15659 (org-columns-number-to-string
15660 (/ (float clocksum) 60.) 'add_times))
15662 (when specific (throw 'exit props)))
15663 (when (or (not specific) (string= specific "CLOCKSUM_T"))
15664 (let ((clocksumt (get-text-property (point)
15665 :org-clock-minutes-today)))
15667 (push (cons "CLOCKSUM_T"
15668 (org-columns-number-to-string
15669 (/ (float clocksumt) 60.) 'add_times))
15671 (when specific (throw 'exit props)))
15672 (when (or (not specific) (string= specific "ITEM"))
15673 (when (looking-at org-complex-heading-regexp)
15676 (org-match-string-no-properties 1)
15677 (let ((title (org-match-string-no-properties 4)))
15678 (when (org-string-nw-p title)
15679 (concat " " (org-remove-tabs title))))))
15681 (when specific (throw 'exit props)))
15682 (when (or (not specific) (string= specific "TODO"))
15683 (when (and (looking-at org-todo-line-regexp) (match-end 2))
15684 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15685 (when specific (throw 'exit props)))
15686 (when (or (not specific) (string= specific "PRIORITY"))
15687 (when (looking-at org-priority-regexp)
15688 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15689 (when specific (throw 'exit props)))
15690 (when (or (not specific) (string= specific "FILE"))
15691 (push (cons "FILE" (buffer-file-name (buffer-base-buffer)))
15693 (when specific (throw 'exit props)))
15694 (when (or (not specific) (string= specific "TAGS"))
15695 (let ((value (org-string-nw-p (org-get-tags-string))))
15696 (when value (push (cons "TAGS" value) props)))
15697 (when specific (throw 'exit props)))
15698 (when (or (not specific) (string= specific "ALLTAGS"))
15699 (let ((value (org-get-tags-at)))
15701 (push (cons "ALLTAGS"
15702 (format ":%s:" (mapconcat #'identity value ":")))
15704 (when specific (throw 'exit props)))
15705 (when (or (not specific) (string= specific "BLOCKED"))
15706 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props)
15707 (when specific (throw 'exit props)))
15708 (when (or (not specific)
15709 (member specific '("CLOSED" "DEADLINE" "SCHEDULED")))
15711 (when (org-looking-at-p org-planning-line-re)
15713 (let ((bol (line-beginning-position))
15714 ;; Backward compatibility: time keywords used to
15715 ;; be configurable (before 8.3). Make sure we
15716 ;; get the correct keyword.
15717 (key-assoc `(("CLOSED" . ,org-closed-string)
15718 ("DEADLINE" . ,org-deadline-string)
15719 ("SCHEDULED" . ,org-scheduled-string))))
15720 (dolist (pair (if specific (list (assoc specific key-assoc))
15723 (when (search-backward (cdr pair) bol t)
15724 (goto-char (match-end 0))
15725 (skip-chars-forward " \t")
15726 (and (looking-at org-ts-regexp-both)
15727 (push (cons (car pair)
15728 (org-match-string-no-properties 0))
15730 (when specific (throw 'exit props)))
15731 (when (or (not specific)
15732 (member specific '("TIMESTAMP" "TIMESTAMP_IA")))
15735 (let ((regexp (if (or (string= specific "TIMESTAMP")
15736 (assoc "TIMESTAMP_IA" ts))
15738 org-ts-regexp-both)))
15740 (while (re-search-forward regexp end t)
15742 (let ((object (org-element-context)))
15743 ;; Accept to match timestamps in node
15744 ;; properties, too.
15745 (when (memq (org-element-type object)
15746 '(node-property timestamp))
15748 (org-element-property :type object)))
15750 ((and (memq type '(active active-range))
15751 (not (equal specific "TIMESTAMP_IA")))
15752 (unless (assoc "TIMESTAMP" ts)
15753 (push (cons "TIMESTAMP"
15754 (org-element-property
15755 :raw-value object))
15757 (when specific (throw 'exit ts))))
15758 ((and (memq type '(inactive inactive-range))
15759 (not (string= specific "TIMESTAMP")))
15760 (unless (assoc "TIMESTAMP_IA" ts)
15761 (push (cons "TIMESTAMP_IA"
15762 (org-element-property
15763 :raw-value object))
15765 (when specific (throw 'exit ts))))))
15766 ;; Both timestamp types are found,
15767 ;; move to next part.
15768 (when (= (length ts) 2) (throw 'next ts)))))
15771 ;; First look for timestamps within headline.
15772 (let ((ts (funcall find-ts (line-end-position) nil)))
15773 (if (= (length ts) 2) (setq props (nconc ts props))
15775 ;; Then find timestamps in the section, skipping
15777 (when (org-looking-at-p org-planning-line-re)
15779 (let ((end (save-excursion (outline-next-heading))))
15780 (setq props (nconc (funcall find-ts end ts) props))))))))
15781 ;; Get the standard properties, like :PROP:.
15782 (when (memq which '(nil all standard))
15783 ;; If we are looking after a specific property, delegate
15784 ;; to `org-entry-get', which is faster. However, make an
15785 ;; exception for "CATEGORY", since it can be also set
15786 ;; through keywords (i.e. #+CATEGORY).
15787 (if (and specific (not (equal specific "CATEGORY")))
15788 (let ((value (org-entry-get beg specific nil t)))
15789 (throw 'exit (and value (list (cons specific value)))))
15790 (let ((range (org-get-property-block beg)))
15792 (let ((end (cdr range)) seen-base)
15793 (goto-char (car range))
15794 ;; Unlike to `org--update-property-plist', we
15795 ;; handle the case where base values is found
15796 ;; after its extension. We also forbid standard
15797 ;; properties to be named as special properties.
15798 (while (re-search-forward org-property-re end t)
15799 (let* ((key (upcase (org-match-string-no-properties 2)))
15800 (extendp (org-string-match-p "\\+\\'" key))
15801 (key-base (if extendp (substring key 0 -1) key))
15802 (value (org-match-string-no-properties 3)))
15804 ((member-ignore-case key-base org-special-properties))
15807 (org--update-property-plist key value props)))
15808 ((member key seen-base))
15809 (t (push key seen-base)
15810 (let ((p (assoc-string key props t)))
15811 (if p (setcdr p (concat value " " (cdr p)))
15812 (push (cons key value) props))))))))))))
15813 (unless (assoc "CATEGORY" props)
15814 (push (cons "CATEGORY" (org-get-category beg)) props)
15815 (when (string= specific "CATEGORY") (throw 'exit props)))
15817 (append (get-text-property beg 'org-summaries) props))))))
15819 (defun org-entry-get (pom property &optional inherit literal-nil)
15820 "Get value of PROPERTY for entry or content at point-or-marker POM.
15822 If INHERIT is non-nil and the entry does not have the property,
15823 then also check higher levels of the hierarchy. If INHERIT is
15824 the symbol `selective', use inheritance only if the setting in
15825 `org-use-property-inheritance' selects PROPERTY for inheritance.
15827 If the property is present but empty, the return value is the
15828 empty string. If the property is not present at all, nil is
15829 returned. In any other case, return the value as a string.
15830 Search is case-insensitive.
15832 If LITERAL-NIL is set, return the string value \"nil\" as
15833 a string, do not interpret it as the list atom nil. This is used
15834 for inheritance when a \"nil\" value can supersede a non-nil
15835 value higher up the hierarchy."
15836 (org-with-point-at pom
15839 (or (not (eq inherit 'selective)) (org-property-inherit-p property)))
15840 (org-entry-get-with-inheritance property literal-nil))
15841 ((member-ignore-case property (cons "CATEGORY" org-special-properties))
15842 ;; We need a special property. Use `org-entry-properties' to
15843 ;; retrieve it, but specify the wanted property.
15844 (cdr (assoc-string property (org-entry-properties nil property))))
15846 (let ((range (org-get-property-block)))
15848 (let* ((case-fold-search t)
15852 (or (assoc-string property org-file-properties t)
15853 (assoc-string property org-global-properties t)
15855 property org-global-properties-fixed t))))
15856 ;; Make sure to not re-use GLOBAL as
15857 ;; `org--update-property-plist' would alter it by
15859 (and global (list (cons property (cdr global))))))
15862 (when (re-search-forward (org-re-property key nil t) end t)
15864 (org--update-property-plist
15865 key (org-match-string-no-properties 3) props))))))
15866 (goto-char (car range))
15867 ;; Find base value.
15868 (save-excursion (funcall find-value property))
15869 ;; Find additional values.
15870 (let ((property+ (concat property "+")))
15871 (while (funcall find-value property+)))
15872 ;; Return final value.
15873 (let ((val (cdr (assoc-string property props t))))
15874 (if literal-nil val (org-not-nil val))))))))))
15876 (defun org-property-or-variable-value (var &optional inherit)
15877 "Check if there is a property fixing the value of VAR.
15878 If yes, return this value. If not, return the current value of the variable."
15879 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15880 (if (and prop (stringp prop) (string-match "\\S-" prop))
15882 (symbol-value var))))
15884 (defun org-entry-delete (pom property)
15885 "Delete PROPERTY from entry at point-or-marker POM.
15886 Accumulated properties, i.e. PROPERTY+, are also removed. Return
15887 non-nil when a property was removed."
15888 (unless (member property org-special-properties)
15889 (org-with-point-at pom
15890 (let ((range (org-get-property-block)))
15892 (let* ((begin (car range))
15893 (origin (cdr range))
15894 (end (copy-marker origin))
15895 (re (org-re-property
15896 (concat (regexp-quote property) "\\+?") t t)))
15898 (while (re-search-forward re end t)
15899 (delete-region (match-beginning 0) (line-beginning-position 2)))
15900 ;; If drawer is empty, remove it altogether.
15901 (when (= begin end)
15902 (delete-region (line-beginning-position 0)
15903 (line-beginning-position 2)))
15904 ;; Return non-nil if some property was removed.
15905 (prog1 (/= end origin) (set-marker end nil))))))))
15907 ;; Multi-values properties are properties that contain multiple values
15908 ;; These values are assumed to be single words, separated by whitespace.
15909 (defun org-entry-add-to-multivalued-property (pom property value)
15910 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15911 (let* ((old (org-entry-get pom property))
15912 (values (and old (org-split-string old "[ \t]"))))
15913 (setq value (org-entry-protect-space value))
15914 (unless (member value values)
15915 (setq values (append values (list value)))
15916 (org-entry-put pom property
15917 (mapconcat 'identity values " ")))))
15919 (defun org-entry-remove-from-multivalued-property (pom property value)
15920 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15921 (let* ((old (org-entry-get pom property))
15922 (values (and old (org-split-string old "[ \t]"))))
15923 (setq value (org-entry-protect-space value))
15924 (when (member value values)
15925 (setq values (delete value values))
15926 (org-entry-put pom property
15927 (mapconcat 'identity values " ")))))
15929 (defun org-entry-member-in-multivalued-property (pom property value)
15930 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15931 (let* ((old (org-entry-get pom property))
15932 (values (and old (org-split-string old "[ \t]"))))
15933 (setq value (org-entry-protect-space value))
15934 (member value values)))
15936 (defun org-entry-get-multivalued-property (pom property)
15937 "Return a list of values in a multivalued property."
15938 (let* ((value (org-entry-get pom property))
15939 (values (and value (org-split-string value "[ \t]"))))
15940 (mapcar 'org-entry-restore-space values)))
15942 (defun org-entry-put-multivalued-property (pom property &rest values)
15943 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15944 VALUES should be a list of strings. Spaces will be protected."
15945 (org-entry-put pom property
15946 (mapconcat 'org-entry-protect-space values " "))
15947 (let* ((value (org-entry-get pom property))
15948 (values (and value (org-split-string value "[ \t]"))))
15949 (mapcar 'org-entry-restore-space values)))
15951 (defun org-entry-protect-space (s)
15952 "Protect spaces and newline in string S."
15953 (while (string-match " " s)
15954 (setq s (replace-match "%20" t t s)))
15955 (while (string-match "\n" s)
15956 (setq s (replace-match "%0A" t t s)))
15959 (defun org-entry-restore-space (s)
15960 "Restore spaces and newline in string S."
15961 (while (string-match "%20" s)
15962 (setq s (replace-match " " t t s)))
15963 (while (string-match "%0A" s)
15964 (setq s (replace-match "\n" t t s)))
15967 (defvar org-entry-property-inherited-from (make-marker)
15968 "Marker pointing to the entry from where a property was inherited.
15969 Each call to `org-entry-get-with-inheritance' will set this marker to the
15970 location of the entry where the inheritance search matched. If there was
15971 no match, the marker will point nowhere.
15972 Note that also `org-entry-get' calls this function, if the INHERIT flag
15975 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15976 "Get PROPERTY of entry or content at point, search higher levels if needed.
15977 The search will stop at the first ancestor which has the property defined.
15978 If the value found is \"nil\", return nil to show that the property
15979 should be considered as undefined (this is the meaning of nil here).
15980 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15981 (move-marker org-entry-property-inherited-from nil)
15983 (org-with-wide-buffer
15986 (when (setq value (org-entry-get nil property nil literal-nil))
15987 (org-back-to-heading t)
15988 (move-marker org-entry-property-inherited-from (point))
15990 (or (org-up-heading-safe) (throw 'exit nil)))))
15993 (cdr (or (assoc-string property org-file-properties t)
15994 (assoc-string property org-global-properties t)
15995 (assoc-string property org-global-properties-fixed t)))))
15996 (if literal-nil value (org-not-nil value))))
15998 (defvar org-property-changed-functions nil
15999 "Hook called when the value of a property has changed.
16000 Each hook function should accept two arguments, the name of the property
16001 and the new value.")
16003 (defun org-entry-put (pom property value)
16004 "Set PROPERTY to VALUE for entry at point-or-marker POM.
16006 If the value is `nil', it is converted to the empty string. If
16007 it is not a string, an error is raised.
16009 PROPERTY can be any regular property (see
16010 `org-special-properties'). It can also be \"TODO\",
16011 \"PRIORITY\", \"SCHEDULED\" and \"DEADLINE\".
16013 For the last two properties, VALUE may have any of the special
16014 values \"earlier\" and \"later\". The function then increases or
16015 decreases scheduled or deadline date by one day."
16016 (cond ((null value) (setq value ""))
16017 ((not (stringp value)) (error "Properties values should be strings")))
16018 (org-with-point-at pom
16019 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16020 (org-back-to-heading t)
16021 (org-with-limited-levels (org-back-to-heading t)))
16022 (let ((beg (point)))
16024 ((equal property "TODO")
16025 (cond ((not (org-string-nw-p value)) (setq value 'none))
16026 ((not (member value org-todo-keywords-1))
16027 (user-error "\"%s\" is not a valid TODO state" value)))
16029 (org-set-tags nil 'align))
16030 ((equal property "PRIORITY")
16031 (org-priority (if (org-string-nw-p value) (string-to-char value) ?\s))
16032 (org-set-tags nil 'align))
16033 ((equal property "SCHEDULED")
16035 (if (and (org-looking-at-p org-planning-line-re)
16037 org-scheduled-time-regexp (line-end-position) t))
16038 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16039 ((string= value "later") (org-timestamp-change 1 'day))
16040 ((string= value "") (org-schedule '(4)))
16041 (t (org-schedule nil value)))
16042 (if (member value '("earlier" "later" ""))
16043 (call-interactively #'org-schedule)
16044 (org-schedule nil value))))
16045 ((equal property "DEADLINE")
16047 (if (and (org-looking-at-p org-planning-line-re)
16049 org-deadline-time-regexp (line-end-position) t))
16050 (cond ((string= value "earlier") (org-timestamp-change -1 'day))
16051 ((string= value "later") (org-timestamp-change 1 'day))
16052 ((string= value "") (org-deadline '(4)))
16053 (t (org-deadline nil value)))
16054 (if (member value '("earlier" "later" ""))
16055 (call-interactively #'org-deadline)
16056 (org-deadline nil value))))
16057 ((member property org-special-properties)
16058 (error "The %s property cannot be set with `org-entry-put'" property))
16060 (let* ((range (org-get-property-block beg 'force))
16062 (case-fold-search t))
16063 (goto-char (car range))
16064 (if (re-search-forward (org-re-property property nil t) end t)
16065 (progn (delete-region (match-beginning 0) (match-end 0))
16066 (goto-char (match-beginning 0)))
16070 (insert ":" property ":")
16071 (when value (insert " " value))
16072 (org-indent-line)))))
16073 (run-hook-with-args 'org-property-changed-functions property value)))
16075 (defun org-buffer-property-keys (&optional specials defaults columns)
16076 "Get all property keys in the current buffer.
16078 When SPECIALS is non-nil, also list the special properties that
16079 reflect things like tags and TODO state.
16081 When DEFAULTS is non-nil, also include properties that has
16082 special meaning internally: ARCHIVE, CATEGORY, SUMMARY,
16083 DESCRIPTION, LOCATION, and LOGGING and others.
16085 When COLUMNS in non-nil, also include property names given in
16086 COLUMN formats in the current buffer."
16087 (let ((case-fold-search t)
16089 (and specials org-special-properties)
16090 (and defaults (cons org-effort-property org-default-properties))
16092 (org-with-wide-buffer
16093 (goto-char (point-min))
16094 (while (re-search-forward org-property-start-re nil t)
16095 (let ((range (org-get-property-block)))
16098 (when (and (not (org-before-first-heading-p))
16099 (y-or-n-p (format "Malformed drawer at %d, repair?"
16100 (line-beginning-position))))
16101 (org-get-property-block nil t))
16103 (goto-char (car range))
16104 (let ((begin (car range))
16106 ;; Make sure that found property block is not located
16107 ;; before current point, as it would generate an infloop.
16108 ;; It can happen, for example, in the following
16115 ;; *************** Inlinetask
16120 (if (< begin (point)) (throw 'skip nil) (goto-char begin))
16121 (while (< (point) end)
16122 (let ((p (progn (looking-at org-property-re)
16123 (org-match-string-no-properties 2))))
16124 ;; Only add true property name, not extension symbol.
16125 (add-to-list 'props
16126 (if (not (org-string-match-p "\\+\\'" p)) p
16127 (substring p 0 -1))))
16129 (outline-next-heading)))
16131 (goto-char (point-min))
16132 (while (re-search-forward "^[ \t]*\\(?:#\\+\\|:\\)COLUMNS:" nil t)
16133 (let ((element (org-element-at-point)))
16134 (when (memq (org-element-type element) '(keyword node-property))
16135 (let ((value (org-element-property :value element))
16137 (while (string-match "%[0-9]*\\(\\S-+\\)" value start)
16138 (setq start (match-end 0))
16139 (let ((p (org-match-string-no-properties 1 value)))
16140 (unless (member-ignore-case p org-special-properties)
16141 (add-to-list 'props p))))))))))
16142 (sort props (lambda (a b) (string< (upcase a) (upcase b))))))
16144 (defun org-property-values (key)
16145 "List all non-nil values of property KEY in current buffer."
16146 (org-with-wide-buffer
16147 (goto-char (point-min))
16148 (let ((case-fold-search t)
16149 (re (org-re-property key))
16151 (while (re-search-forward re nil t)
16152 (add-to-list 'values (org-entry-get (point) key)))
16155 (defun org-insert-property-drawer ()
16156 "Insert a property drawer into the current entry."
16157 (org-with-wide-buffer
16158 (if (or (not (featurep 'org-inlinetask)) (org-inlinetask-in-task-p))
16159 (org-back-to-heading t)
16160 (org-with-limited-levels (org-back-to-heading t)))
16162 (when (org-looking-at-p org-planning-line-re) (forward-line))
16163 (unless (org-looking-at-p org-property-drawer-re)
16164 (let ((inhibit-read-only t))
16165 (unless (bolp) (insert "\n"))
16166 (let ((begin (point)))
16167 (insert ":PROPERTIES:\n:END:\n")
16168 (org-indent-region begin (point)))))))
16170 (defun org-insert-drawer (&optional arg drawer)
16171 "Insert a drawer at point.
16173 When optional argument ARG is non-nil, insert a property drawer.
16175 Optional argument DRAWER, when non-nil, is a string representing
16176 drawer's name. Otherwise, the user is prompted for a name.
16178 If a region is active, insert the drawer around that region
16181 Point is left between drawer's boundaries."
16183 (let* ((drawer (if arg "PROPERTIES"
16184 (or drawer (read-from-minibuffer "Drawer: ")))))
16186 ;; With C-u, fall back on `org-insert-property-drawer'
16187 (arg (org-insert-property-drawer))
16188 ;; Check validity of suggested drawer's name.
16189 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
16190 (user-error "Invalid drawer name"))
16191 ;; With an active region, insert a drawer at point.
16192 ((not (org-region-active-p))
16194 (unless (bolp) (insert "\n"))
16195 (insert (format ":%s:\n\n:END:\n" drawer))
16196 (forward-line -2)))
16197 ;; Otherwise, insert the drawer at point
16199 (let ((rbeg (region-beginning))
16200 (rend (copy-marker (region-end))))
16204 (beginning-of-line)
16205 (when (save-excursion
16206 (re-search-forward org-outline-regexp-bol rend t))
16207 (user-error "Drawers cannot contain headlines"))
16208 ;; Position point at the beginning of the first
16209 ;; non-blank line in region. Insert drawer's opening
16210 ;; there, then indent it.
16211 (org-skip-whitespace)
16212 (beginning-of-line)
16213 (insert ":" drawer ":\n")
16215 (indent-for-tab-command)
16216 ;; Move point to the beginning of the first blank line
16217 ;; after the last non-blank line in region. Insert
16218 ;; drawer's closing, then indent it.
16220 (skip-chars-backward " \r\t\n")
16222 (deactivate-mark t)
16223 (indent-for-tab-command)
16224 (unless (eolp) (insert "\n")))
16225 ;; Clear marker, whatever the outcome of insertion is.
16226 (set-marker rend nil)))))))
16228 (defvar org-property-set-functions-alist nil
16229 "Property set function alist.
16230 Each entry should have the following format:
16232 (PROPERTY . READ-FUNCTION)
16234 The read function will be called with the same argument as
16235 `org-completing-read'.")
16237 (defun org-set-property-function (property)
16238 "Get the function that should be used to set PROPERTY.
16239 This is computed according to `org-property-set-functions-alist'."
16240 (or (cdr (assoc property org-property-set-functions-alist))
16241 'org-completing-read))
16243 (defun org-read-property-value (property)
16244 "Read PROPERTY value from user."
16245 (let* ((completion-ignore-case t)
16246 (allowed (org-property-get-allowed-values nil property 'table))
16247 (cur (org-entry-get nil property))
16248 (prompt (concat property " value"
16249 (if (and cur (string-match "\\S-" cur))
16250 (concat " [" cur "]") "") ": "))
16251 (set-function (org-set-property-function property))
16253 (funcall set-function prompt allowed nil
16254 (not (get-text-property 0 'org-unrestricted
16256 (let (org-completion-use-ido org-completion-use-iswitchb)
16257 (funcall set-function prompt
16258 (mapcar 'list (org-property-values property))
16259 nil nil "" nil cur)))))
16262 (defvar org-last-set-property nil)
16263 (defvar org-last-set-property-value nil)
16264 (defun org-read-property-name ()
16265 "Read a property name."
16266 (let ((completion-ignore-case t)
16267 (default-prop (or (and (org-at-property-p)
16268 (org-match-string-no-properties 2))
16269 org-last-set-property)))
16270 (org-completing-read
16272 (if default-prop (concat " [" default-prop "]") "")
16274 (mapcar #'list (org-buffer-property-keys nil t t))
16275 nil nil nil nil default-prop)))
16277 (defun org-set-property-and-value (use-last)
16278 "Allow to set [PROPERTY]: [value] direction from prompt.
16279 When use-default, don't even ask, just use the last
16280 \"[PROPERTY]: [value]\" string from the history."
16282 (let* ((completion-ignore-case t)
16283 (pv (or (and use-last org-last-set-property-value)
16284 (org-completing-read
16285 "Enter a \"[Property]: [value]\" pair: "
16286 nil nil nil nil nil
16287 org-last-set-property-value)))
16289 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16290 (setq prop (match-string 1 pv)
16291 val (match-string 2 pv))
16292 (org-set-property prop val))))
16294 (defun org-set-property (property value)
16295 "In the current entry, set PROPERTY to VALUE.
16296 When called interactively, this will prompt for a property name, offering
16297 completion on existing and default properties. And then it will prompt
16298 for a value, offering completion either on allowed values (via an inherited
16299 xxx_ALL property) or on existing values in other instances of this property
16300 in the current file."
16301 (interactive (list nil nil))
16302 (let* ((property (or property (org-read-property-name)))
16303 (value (or value (org-read-property-value property)))
16304 (fn (cdr (assoc property org-properties-postprocess-alist))))
16305 (setq org-last-set-property property)
16306 (setq org-last-set-property-value (concat property ": " value))
16307 ;; Possibly postprocess the inserted value:
16308 (when fn (setq value (funcall fn value)))
16309 (unless (equal (org-entry-get nil property) value)
16310 (org-entry-put nil property value))))
16312 (defun org-find-property (property &optional value)
16313 "Find first entry in buffer that sets PROPERTY.
16315 When optional argument VALUE is non-nil, only consider an entry
16316 if it contains PROPERTY set to this value. If PROPERTY should be
16317 explicitly set to nil, use string \"nil\" for VALUE.
16319 Return position where the entry begins, or nil if there is no
16320 such entry. If narrowing is in effect, only search the visible
16321 part of the buffer."
16323 (goto-char (point-min))
16324 (let ((case-fold-search t)
16325 (re (org-re-property property nil (not value) value)))
16327 (while (re-search-forward re nil t)
16328 (when (if value (org-at-property-p)
16329 (org-entry-get (point) property nil t))
16330 (throw 'exit (progn (org-back-to-heading t) (point)))))))))
16332 (defun org-delete-property (property)
16333 "In the current entry, delete PROPERTY."
16335 (let* ((completion-ignore-case t)
16336 (cat (org-entry-get (point) "CATEGORY"))
16337 (props0 (org-entry-properties nil 'standard))
16338 (props (if cat props0
16339 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16340 (prop (if (< 1 (length props))
16341 (org-icompleting-read "Property: " props nil t)
16345 (message "No property to delete in this entry")
16346 (org-entry-delete nil property)
16347 (message "Property \"%s\" deleted" property)))
16349 (defun org-delete-property-globally (property)
16350 "Remove PROPERTY globally, from all entries.
16351 This function ignores narrowing, if any."
16353 (let* ((completion-ignore-case t)
16354 (prop (org-icompleting-read
16355 "Globally remove property: "
16356 (mapcar #'list (org-buffer-property-keys)))))
16358 (org-with-wide-buffer
16359 (goto-char (point-min))
16361 (re (org-re-property (concat (regexp-quote property) "\\+?") t t)))
16362 (while (re-search-forward re nil t)
16363 (when (org-entry-delete (point) property) (incf count)))
16364 (message "Property \"%s\" removed from %d entries" property count))))
16366 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16368 (defun org-compute-property-at-point ()
16369 "Compute the property at point.
16370 This looks for an enclosing column format, extracts the operator and
16371 then applies it to the property in the column format's scope."
16373 (unless (org-at-property-p)
16374 (user-error "Not at a property"))
16375 (let ((prop (org-match-string-no-properties 2)))
16376 (org-columns-get-format-and-top-level)
16377 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16378 (user-error "No operator defined for property %s" prop))
16379 (org-columns-compute prop)))
16381 (defvar org-property-allowed-value-functions nil
16382 "Hook for functions supplying allowed values for a specific property.
16383 The functions must take a single argument, the name of the property, and
16384 return a flat list of allowed values. If \":ETC\" is one of
16385 the values, this means that these values are intended as defaults for
16386 completion, but that other values should be allowed too.
16387 The functions must return nil if they are not responsible for this
16390 (defun org-property-get-allowed-values (pom property &optional table)
16391 "Get allowed values for the property PROPERTY.
16392 When TABLE is non-nil, return an alist that can directly be used for
16396 ((equal property "TODO")
16397 (setq vals (org-with-point-at pom
16398 (append org-todo-keywords-1 '("")))))
16399 ((equal property "PRIORITY")
16400 (let ((n org-lowest-priority))
16401 (while (>= n org-highest-priority)
16402 (push (char-to-string n) vals)
16404 ((equal property "CATEGORY"))
16405 ((member property org-special-properties))
16406 ((setq vals (run-hook-with-args-until-success
16407 'org-property-allowed-value-functions property)))
16409 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16410 (when (and vals (string-match "\\S-" vals))
16411 (setq vals (car (read-from-string (concat "(" vals ")"))))
16412 (setq vals (mapcar (lambda (x)
16413 (cond ((stringp x) x)
16414 ((numberp x) (number-to-string x))
16415 ((symbolp x) (symbol-name x))
16418 (when (member ":ETC" vals)
16419 (setq vals (remove ":ETC" vals))
16420 (org-add-props (car vals) '(org-unrestricted t)))
16421 (if table (mapcar 'list vals) vals)))
16423 (defun org-property-previous-allowed-value (&optional previous)
16424 "Switch to the next allowed value for this property."
16426 (org-property-next-allowed-value t))
16428 (defun org-property-next-allowed-value (&optional previous)
16429 "Switch to the next allowed value for this property."
16431 (unless (org-at-property-p)
16432 (user-error "Not at a property"))
16433 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16434 (key (match-string 2))
16435 (value (match-string 3))
16436 (allowed (or (org-property-get-allowed-values (point) key)
16437 (and (member value '("[ ]" "[-]" "[X]"))
16439 (heading (save-match-data (nth 4 (org-heading-components))))
16442 (user-error "Allowed values for this property have not been defined"))
16443 (if previous (setq allowed (reverse allowed)))
16444 (if (member value allowed)
16445 (setq nval (car (cdr (member value allowed)))))
16446 (setq nval (or nval (car allowed)))
16447 (if (equal nval value)
16448 (user-error "Only one allowed value for this property"))
16449 (org-at-property-p)
16450 (replace-match (concat " :" key ": " nval) t t)
16452 (beginning-of-line 1)
16453 (skip-chars-forward " \t")
16454 (when (equal prop org-effort-property)
16455 (org-refresh-property
16456 '((effort . identity)
16457 (effort-minutes . org-duration-string-to-minutes))
16459 (when (string= org-clock-current-task heading)
16460 (setq org-clock-effort nval)
16461 (org-clock-update-mode-line)))
16462 (run-hook-with-args 'org-property-changed-functions key nval)))
16464 (defun org-find-olp (path &optional this-buffer)
16465 "Return a marker pointing to the entry at outline path OLP.
16466 If anything goes wrong, throw an error.
16467 You can wrap this call to catch the error like this:
16469 (condition-case msg
16470 (org-mobile-locate-entry (match-string 4))
16471 (error (nth 1 msg)))
16473 The return value will then be either a string with the error message,
16474 or a marker if everything is OK.
16476 If THIS-BUFFER is set, the outline path does not contain a file,
16478 (let* ((file (if this-buffer buffer-file-name (pop path)))
16479 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16483 limit re end found pos heading cnt flevel)
16484 (unless buffer (error "File not found :%s" file))
16485 (with-current-buffer buffer
16489 (setq limit (point-max))
16490 (goto-char (point-min))
16491 (while (setq heading (pop path))
16492 (setq re (format org-complex-heading-regexp-format
16493 (regexp-quote heading)))
16494 (setq cnt 0 pos (point))
16495 (while (re-search-forward re end t)
16496 (setq level (- (match-end 1) (match-beginning 1)))
16497 (if (and (>= level lmin) (<= level lmax))
16498 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16499 (when (= cnt 0) (error "Heading not found on level %d: %s"
16501 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16504 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16505 (setq end (save-excursion (org-end-of-subtree t t))))
16506 (when (org-at-heading-p)
16507 (point-marker)))))))
16509 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16510 "Find node HEADING in BUFFER.
16511 Return a marker to the heading if it was found, or nil if not.
16512 If POS-ONLY is set, return just the position instead of a marker.
16514 The heading text must match exact, but it may have a TODO keyword,
16515 a priority cookie and tags in the standard locations."
16516 (with-current-buffer (or buffer (current-buffer))
16520 (goto-char (point-min))
16521 (let (case-fold-search)
16522 (if (re-search-forward
16523 (format org-complex-heading-regexp-format
16524 (regexp-quote heading)) nil t)
16526 (match-beginning 0)
16527 (move-marker (make-marker) (match-beginning 0)))))))))
16529 (defun org-find-exact-heading-in-directory (heading &optional dir)
16530 "Find Org node headline HEADING in all .org files in directory DIR.
16531 When the target headline is found, return a marker to this location."
16532 (let ((files (directory-files (or dir default-directory)
16533 t "\\`[^.#].*\\.org\\'"))
16534 file visiting m buffer)
16536 (while (setq file (pop files))
16537 (message "trying %s" file)
16538 (setq visiting (org-find-base-buffer-visiting file))
16539 (setq buffer (or visiting (find-file-noselect file)))
16540 (setq m (org-find-exact-headline-in-buffer
16542 (when (and (not m) (not visiting)) (kill-buffer buffer))
16543 (and m (throw 'found m))))))
16545 (defun org-find-entry-with-id (ident)
16546 "Locate the entry that contains the ID property with exact value IDENT.
16547 IDENT can be a string, a symbol or a number, this function will search for
16548 the string representation of it.
16549 Return the position where this entry starts, or nil if there is no such entry."
16550 (interactive "sID: ")
16552 ((stringp ident) ident)
16553 ((symbolp ident) (symbol-name ident))
16554 ((numberp ident) (number-to-string ident))
16555 (t (error "IDENT %s must be a string, symbol or number" ident)))))
16556 (org-with-wide-buffer (org-find-property "ID" id))))
16560 (defvar org-last-changed-timestamp nil)
16561 (defvar org-last-inserted-timestamp nil
16562 "The last time stamp inserted with `org-insert-time-stamp'.")
16563 (defvar org-ts-what) ; dynamically scoped parameter
16565 (defun org-time-stamp (arg &optional inactive)
16566 "Prompt for a date/time and insert a time stamp.
16568 If the user specifies a time like HH:MM or if this command is
16569 called with at least one prefix argument, the time stamp contains
16570 the date and the time. Otherwise, only the date is included.
16572 All parts of a date not specified by the user are filled in from
16573 the timestamp at point, if any, or the current date/time
16576 If there is already a timestamp at the cursor, it is replaced.
16578 With two universal prefix arguments, insert an active timestamp
16579 with the current time without prompting the user.
16581 When called from lisp, the timestamp is inactive if INACTIVE is
16585 (cond ((org-at-date-range-p t)
16587 (goto-char (match-beginning 0))
16588 (looking-at (if inactive org-ts-regexp-both org-ts-regexp)))
16590 ((org-at-timestamp-p t) (match-string 0))))
16591 ;; Default time is either the timestamp at point or today.
16592 ;; When entering a range, only the range start is considered.
16593 (default-time (if (not ts) (current-time)
16594 (apply #'encode-time (org-parse-time-string ts))))
16595 (default-input (and ts (org-get-compact-tod ts)))
16597 (string-match "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ts)
16598 (match-string 0 ts)))
16600 org-end-time-was-given
16602 (and (if (equal arg '(16)) (current-time)
16603 ;; Preserve `this-command' and `last-command'.
16604 (let ((this-command this-command)
16605 (last-command last-command))
16607 arg 'totime nil nil default-time default-input
16611 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16612 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16614 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16616 ;; Make sure we're on a timestamp. When in the middle of a date
16617 ;; range, move arbitrarily to range end.
16618 (unless (org-at-timestamp-p t)
16619 (skip-chars-forward "-")
16620 (org-at-timestamp-p t))
16622 (setq org-last-changed-timestamp
16623 (org-insert-time-stamp
16624 time (or org-time-was-given arg)
16625 inactive nil nil (list org-end-time-was-given)))
16628 (insert " " repeater)
16629 (setq org-last-changed-timestamp
16630 (concat (substring org-last-inserted-timestamp 0 -1)
16631 " " repeater ">")))
16632 (message "Timestamp updated"))
16633 ((equal arg '(16)) (org-insert-time-stamp time t inactive))
16634 (t (org-insert-time-stamp
16635 time (or org-time-was-given arg) inactive nil nil
16636 (list org-end-time-was-given))))))
16638 ;; FIXME: can we use this for something else, like computing time differences?
16639 (defun org-get-compact-tod (s)
16640 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16641 (let* ((t1 (match-string 1 s))
16642 (h1 (string-to-number (match-string 2 s)))
16643 (m1 (string-to-number (match-string 3 s)))
16644 (t2 (and (match-end 4) (match-string 5 s)))
16645 (h2 (and t2 (string-to-number (match-string 6 s))))
16646 (m2 (and t2 (string-to-number (match-string 7 s))))
16650 (setq dh (- h2 h1) dm (- m2 m1))
16651 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16652 (concat t1 "+" (number-to-string dh)
16653 (and (/= 0 dm) (format ":%02d" dm)))))))
16655 (defun org-time-stamp-inactive (&optional arg)
16656 "Insert an inactive time stamp.
16657 An inactive time stamp is enclosed in square brackets instead of angle
16658 brackets. It is inactive in the sense that it does not trigger agenda entries,
16659 does not link to the calendar and cannot be changed with the S-cursor keys.
16660 So these are more for recording a certain time/date."
16662 (org-time-stamp arg 'inactive))
16664 (defvar org-date-ovl (make-overlay 1 1))
16665 (overlay-put org-date-ovl 'face 'org-date-selected)
16666 (org-detach-overlay org-date-ovl)
16668 (defvar org-ans1) ; dynamically scoped parameter
16669 (defvar org-ans2) ; dynamically scoped parameter
16671 (defvar org-plain-time-of-day-regexp) ; defined below
16673 (defvar org-overriding-default-time nil) ; dynamically scoped
16674 (defvar org-read-date-overlay nil)
16675 (defvar org-dcst nil) ; dynamically scoped
16676 (defvar org-read-date-history nil)
16677 (defvar org-read-date-final-answer nil)
16678 (defvar org-read-date-analyze-futurep nil)
16679 (defvar org-read-date-analyze-forced-year nil)
16680 (defvar org-read-date-inactive)
16682 (defvar org-read-date-minibuffer-local-map
16683 (let* ((map (make-sparse-keymap)))
16684 (set-keymap-parent map minibuffer-local-map)
16685 (org-defkey map (kbd ".")
16686 (lambda () (interactive)
16687 ;; Are we at the beginning of the prompt?
16688 (if (looking-back "^[^:]+: ")
16689 (org-eval-in-calendar '(calendar-goto-today))
16691 (org-defkey map (kbd "C-.")
16692 (lambda () (interactive)
16693 (org-eval-in-calendar '(calendar-goto-today))))
16694 (org-defkey map [(meta shift left)]
16695 (lambda () (interactive)
16696 (org-eval-in-calendar '(calendar-backward-month 1))))
16697 (org-defkey map [(meta shift right)]
16698 (lambda () (interactive)
16699 (org-eval-in-calendar '(calendar-forward-month 1))))
16700 (org-defkey map [(meta shift up)]
16701 (lambda () (interactive)
16702 (org-eval-in-calendar '(calendar-backward-year 1))))
16703 (org-defkey map [(meta shift down)]
16704 (lambda () (interactive)
16705 (org-eval-in-calendar '(calendar-forward-year 1))))
16706 (org-defkey map [?\e (shift left)]
16707 (lambda () (interactive)
16708 (org-eval-in-calendar '(calendar-backward-month 1))))
16709 (org-defkey map [?\e (shift right)]
16710 (lambda () (interactive)
16711 (org-eval-in-calendar '(calendar-forward-month 1))))
16712 (org-defkey map [?\e (shift up)]
16713 (lambda () (interactive)
16714 (org-eval-in-calendar '(calendar-backward-year 1))))
16715 (org-defkey map [?\e (shift down)]
16716 (lambda () (interactive)
16717 (org-eval-in-calendar '(calendar-forward-year 1))))
16718 (org-defkey map [(shift up)]
16719 (lambda () (interactive)
16720 (org-eval-in-calendar '(calendar-backward-week 1))))
16721 (org-defkey map [(shift down)]
16722 (lambda () (interactive)
16723 (org-eval-in-calendar '(calendar-forward-week 1))))
16724 (org-defkey map [(shift left)]
16725 (lambda () (interactive)
16726 (org-eval-in-calendar '(calendar-backward-day 1))))
16727 (org-defkey map [(shift right)]
16728 (lambda () (interactive)
16729 (org-eval-in-calendar '(calendar-forward-day 1))))
16730 (org-defkey map "!"
16731 (lambda () (interactive)
16732 (org-eval-in-calendar '(diary-view-entries))
16734 (org-defkey map ">"
16735 (lambda () (interactive)
16736 (org-eval-in-calendar '(calendar-scroll-left 1))))
16737 (org-defkey map "<"
16738 (lambda () (interactive)
16739 (org-eval-in-calendar '(calendar-scroll-right 1))))
16740 (org-defkey map "\C-v"
16741 (lambda () (interactive)
16742 (org-eval-in-calendar
16743 '(calendar-scroll-left-three-months 1))))
16744 (org-defkey map "\M-v"
16745 (lambda () (interactive)
16746 (org-eval-in-calendar
16747 '(calendar-scroll-right-three-months 1))))
16749 "Keymap for minibuffer commands when using `org-read-date'.")
16752 (defvar org-defdecode)
16753 (defvar org-with-time)
16755 (defun org-read-date (&optional org-with-time to-time from-string prompt
16756 default-time default-input inactive)
16757 "Read a date, possibly a time, and make things smooth for the user.
16758 The prompt will suggest to enter an ISO date, but you can also enter anything
16759 which will at least partially be understood by `parse-time-string'.
16760 Unrecognized parts of the date will default to the current day, month, year,
16761 hour and minute. If this command is called to replace a timestamp at point,
16762 or to enter the second timestamp of a range, the default time is taken
16763 from the existing stamp. Furthermore, the command prefers the future,
16764 so if you are giving a date where the year is not given, and the day-month
16765 combination is already past in the current year, it will assume you
16766 mean next year. For details, see the manual. A few examples:
16768 3-2-5 --> 2003-02-05
16769 feb 15 --> currentyear-02-15
16770 2/15 --> currentyear-02-15
16771 sep 12 9 --> 2009-09-12
16772 12:45 --> today 12:45
16773 22 sept 0:34 --> currentyear-09-22 0:34
16774 12 --> currentyear-currentmonth-12
16775 Fri --> nearest Friday after today
16776 -Tue --> last Tuesday
16779 Furthermore you can specify a relative date by giving, as the *first* thing
16780 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16781 change in days weeks, months, years.
16782 With a single plus or minus, the date is relative to today. With a double
16783 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16784 +4d --> four days from today
16785 +4 --> same as above
16786 +2w --> two weeks from today
16787 ++5 --> five days from default date
16789 The function understands only English month and weekday abbreviations.
16791 While prompting, a calendar is popped up - you can also select the
16792 date with the mouse (button 1). The calendar shows a period of three
16793 months. To scroll it to other months, use the keys `>' and `<'.
16794 If you don't like the calendar, turn it off with
16795 \(setq org-read-date-popup-calendar nil)
16797 With optional argument TO-TIME, the date will immediately be converted
16798 to an internal time.
16799 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16800 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16801 still enter a time, and this function will inform the calling routine
16802 about this change. The calling routine may then choose to change the
16803 format used to insert the time stamp into the buffer to include the time.
16804 With optional argument FROM-STRING, read from this string instead from
16805 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16806 the time/date that is used for everything that is not specified by the
16808 (require 'parse-time)
16809 (let* ((org-time-stamp-rounding-minutes
16810 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16811 (org-dcst org-display-custom-times)
16812 (ct (org-current-time))
16813 (org-def (or org-overriding-default-time default-time ct))
16814 (org-defdecode (decode-time org-def))
16816 (when (< (nth 2 org-defdecode) org-extend-today-until)
16817 (setcar (nthcdr 2 org-defdecode) -1)
16818 (setcar (nthcdr 1 org-defdecode) 59)
16819 (setq org-def (apply 'encode-time org-defdecode)
16820 org-defdecode (decode-time org-def)))))
16821 (cur-frame (selected-frame))
16822 (mouse-autoselect-window nil) ; Don't let the mouse jump
16823 (calendar-frame-setup nil)
16824 (calendar-setup (when (eq calendar-setup 'calendar-only) 'calendar-only))
16825 (calendar-move-hook nil)
16826 (calendar-view-diary-initially-flag nil)
16827 (calendar-view-holidays-initially-flag nil)
16828 (timestr (format-time-string
16829 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16830 (prompt (concat (if prompt (concat prompt " ") "")
16831 (format "Date+time [%s]: " timestr)))
16832 ans (org-ans0 "") org-ans1 org-ans2 final cal-frame)
16835 (from-string (setq ans from-string))
16836 (org-read-date-popup-calendar
16838 (save-window-excursion
16840 (when (eq calendar-setup 'calendar-only)
16842 (window-frame (get-buffer-window "*Calendar*" 'visible)))
16843 (select-frame cal-frame))
16844 (org-eval-in-calendar '(setq cursor-type nil) t)
16847 (calendar-forward-day (- (time-to-days org-def)
16848 (calendar-absolute-from-gregorian
16849 (calendar-current-date))))
16850 (org-eval-in-calendar nil t)
16851 (let* ((old-map (current-local-map))
16852 (map (copy-keymap calendar-mode-map))
16853 (minibuffer-local-map
16854 (copy-keymap org-read-date-minibuffer-local-map)))
16855 (org-defkey map (kbd "RET") 'org-calendar-select)
16856 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16857 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16860 (use-local-map map)
16861 (setq org-read-date-inactive inactive)
16862 (add-hook 'post-command-hook 'org-read-date-display)
16863 (setq org-ans0 (read-string prompt default-input
16864 'org-read-date-history nil))
16865 ;; org-ans0: from prompt
16866 ;; org-ans1: from mouse click
16867 ;; org-ans2: from calendar motion
16868 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16869 (remove-hook 'post-command-hook 'org-read-date-display)
16870 (use-local-map old-map)
16871 (when org-read-date-overlay
16872 (delete-overlay org-read-date-overlay)
16873 (setq org-read-date-overlay nil)))))
16874 (bury-buffer "*Calendar*")
16876 (delete-frame cal-frame)
16877 (select-frame-set-input-focus cur-frame))))))
16879 (t ; Naked prompt only
16881 (setq ans (read-string prompt default-input
16882 'org-read-date-history timestr))
16883 (when org-read-date-overlay
16884 (delete-overlay org-read-date-overlay)
16885 (setq org-read-date-overlay nil)))))
16887 (setq final (org-read-date-analyze ans org-def org-defdecode))
16889 (when org-read-date-analyze-forced-year
16890 (message "Year was forced into %s"
16891 (if org-read-date-force-compatible-dates
16892 "compatible range (1970-2037)"
16893 "range representable on this machine"))
16896 ;; One round trip to get rid of 34th of August and stuff like that....
16897 (setq final (decode-time (apply 'encode-time final)))
16899 (setq org-read-date-final-answer ans)
16902 (apply 'encode-time final)
16903 (if (and (boundp 'org-time-was-given) org-time-was-given)
16904 (format "%04d-%02d-%02d %02d:%02d"
16905 (nth 5 final) (nth 4 final) (nth 3 final)
16906 (nth 2 final) (nth 1 final))
16907 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16909 (defun org-read-date-display ()
16910 "Display the current date prompt interpretation in the minibuffer."
16911 (when org-read-date-display-live
16912 (when org-read-date-overlay
16913 (delete-overlay org-read-date-overlay))
16914 (when (minibufferp (current-buffer))
16917 (while (not (equal (buffer-substring
16918 (max (point-min) (- (point) 4)) (point))
16921 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16922 " " (or org-ans1 org-ans2)))
16923 (org-end-time-was-given nil)
16924 (f (org-read-date-analyze ans org-def org-defdecode))
16926 org-time-stamp-custom-formats
16927 org-time-stamp-formats))
16928 (fmt (if (or org-with-time
16929 (and (boundp 'org-time-was-given) org-time-was-given))
16932 (txt (format-time-string fmt (apply 'encode-time f)))
16933 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16934 (txt (concat "=> " txt)))
16935 (when (and org-end-time-was-given
16936 (string-match org-plain-time-of-day-regexp txt))
16937 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16938 org-end-time-was-given
16939 (substring txt (match-end 0)))))
16940 (when org-read-date-analyze-futurep
16941 (setq txt (concat txt " (=>F)")))
16942 (setq org-read-date-overlay
16943 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16944 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16946 (defun org-read-date-analyze (ans org-def org-defdecode)
16947 "Analyze the combined answer of the date prompt."
16948 ;; FIXME: cleanup and comment
16949 (let ((nowdecode (decode-time (current-time)))
16950 delta deltan deltaw deltadef year month day
16951 hour minute second wday pm h2 m2 tl wday1
16952 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16953 (setq org-read-date-analyze-futurep nil
16954 org-read-date-analyze-forced-year nil)
16955 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16958 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16959 (setq ans (replace-match "" t t ans)
16961 deltaw (nth 1 delta)
16962 deltadef (nth 2 delta)))
16964 ;; Check if there is an iso week date in there. If yes, store the
16965 ;; info and postpone interpreting it until the rest of the parsing
16967 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16968 (setq iso-year (if (match-end 1)
16969 (org-small-year-to-year
16970 (string-to-number (match-string 1 ans))))
16971 iso-weekday (if (match-end 3)
16972 (string-to-number (match-string 3 ans)))
16973 iso-week (string-to-number (match-string 2 ans)))
16974 (setq ans (replace-match "" t t ans)))
16976 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16977 (when (string-match
16978 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16979 (setq year (if (match-end 2)
16980 (string-to-number (match-string 2 ans))
16981 (progn (setq kill-year t)
16982 (string-to-number (format-time-string "%Y"))))
16983 month (string-to-number (match-string 3 ans))
16984 day (string-to-number (match-string 4 ans)))
16985 (if (< year 100) (setq year (+ 2000 year)))
16986 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16989 ;; Help matching dotted european dates
16990 (when (string-match
16991 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16992 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16994 (string-to-number (format-time-string "%Y")))
16995 day (string-to-number (match-string 1 ans))
16996 month (string-to-number (match-string 2 ans))
16997 ans (replace-match (format "%04d-%02d-%02d" year month day)
17000 ;; Help matching american dates, like 5/30 or 5/30/7
17001 (when (string-match
17002 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
17003 (setq year (if (match-end 4)
17004 (string-to-number (match-string 4 ans))
17005 (progn (setq kill-year t)
17006 (string-to-number (format-time-string "%Y"))))
17007 month (string-to-number (match-string 1 ans))
17008 day (string-to-number (match-string 2 ans)))
17009 (if (< year 100) (setq year (+ 2000 year)))
17010 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
17012 ;; Help matching am/pm times, because `parse-time-string' does not do that.
17013 ;; If there is a time with am/pm, and *no* time without it, we convert
17014 ;; so that matching will be successful.
17015 (loop for i from 1 to 2 do ; twice, for end time as well
17016 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
17017 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
17018 (setq hour (string-to-number (match-string 1 ans))
17019 minute (if (match-end 3)
17020 (string-to-number (match-string 3 ans))
17023 (string-to-char (downcase (match-string 4 ans)))))
17024 (if (and (= hour 12) (not pm))
17026 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
17027 (setq ans (replace-match (format "%02d:%02d" hour minute)
17030 ;; Check if a time range is given as a duration
17031 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
17032 (setq hour (string-to-number (match-string 1 ans))
17033 h2 (+ hour (string-to-number (match-string 3 ans)))
17034 minute (string-to-number (match-string 2 ans))
17035 m2 (+ minute (if (match-end 5) (string-to-number
17036 (match-string 5 ans))0)))
17037 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
17038 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
17041 ;; Check if there is a time range
17042 (when (boundp 'org-end-time-was-given)
17043 (setq org-time-was-given nil)
17044 (when (and (string-match org-plain-time-of-day-regexp ans)
17046 (setq org-end-time-was-given (match-string 8 ans))
17047 (setq ans (concat (substring ans 0 (match-beginning 7))
17048 (substring ans (match-end 7))))))
17050 (setq tl (parse-time-string ans)
17051 day (or (nth 3 tl) (nth 3 org-defdecode))
17054 ((not org-read-date-prefer-future) (nth 4 org-defdecode))
17055 ;; Day was specified. Make sure DAY+MONTH
17056 ;; combination happens in the future.
17059 (if (< day (nth 3 nowdecode)) (1+ (nth 4 nowdecode))
17060 (nth 4 nowdecode)))
17061 (t (nth 4 org-defdecode)))
17063 (cond ((and (not kill-year) (nth 5 tl)))
17064 ((not org-read-date-prefer-future) (nth 5 org-defdecode))
17065 ;; Month was guessed in the future and is at least
17066 ;; equal to NOWDECODE's. Fix year accordingly.
17068 (if (or (> month (nth 4 nowdecode))
17069 (>= day (nth 3 nowdecode)))
17071 (1+ (nth 5 nowdecode))))
17072 ;; Month was specified. Make sure MONTH+YEAR
17073 ;; combination happens in the future.
17076 (cond ((> month (nth 4 nowdecode)) (nth 5 nowdecode))
17077 ((< month (nth 4 nowdecode)) (1+ (nth 5 nowdecode)))
17078 ((< day (nth 3 nowdecode)) (1+ (nth 5 nowdecode)))
17079 (t (nth 5 nowdecode))))
17080 (t (nth 5 org-defdecode)))
17081 hour (or (nth 2 tl) (nth 2 org-defdecode))
17082 minute (or (nth 1 tl) (nth 1 org-defdecode))
17083 second (or (nth 0 tl) 0)
17086 (when (and (eq org-read-date-prefer-future 'time)
17087 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
17088 (equal day (nth 3 nowdecode))
17089 (equal month (nth 4 nowdecode))
17090 (equal year (nth 5 nowdecode))
17092 (or (< (nth 2 tl) (nth 2 nowdecode))
17093 (and (= (nth 2 tl) (nth 2 nowdecode))
17095 (< (nth 1 tl) (nth 1 nowdecode)))))
17099 ;; Special date definitions below
17102 ;; There was an iso week
17105 (setq year (or iso-year year)
17106 day (or iso-weekday wday 1)
17107 wday nil ; to make sure that the trigger below does not match
17108 iso-date (calendar-gregorian-from-absolute
17109 (calendar-iso-to-absolute
17110 (list iso-week day year))))
17111 ; FIXME: Should we also push ISO weeks into the future?
17112 ; (when (and org-read-date-prefer-future
17114 ; (< (calendar-absolute-from-gregorian iso-date)
17115 ; (time-to-days (current-time))))
17116 ; (setq year (1+ year)
17117 ; iso-date (calendar-gregorian-from-absolute
17118 ; (calendar-iso-to-absolute
17119 ; (list iso-week day year)))))
17120 (setq month (car iso-date)
17121 year (nth 2 iso-date)
17122 day (nth 1 iso-date)))
17126 (let ((now (decode-time (current-time))))
17127 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
17128 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
17129 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
17130 ((equal deltaw "m") (setq month (+ month deltan)))
17131 ((equal deltaw "y") (setq year (+ year deltan)))))
17132 ((and wday (not (nth 3 tl)))
17133 ;; Weekday was given, but no day, so pick that day in the week
17134 ;; on or after the derived date.
17135 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
17136 (unless (equal wday wday1)
17137 (setq day (+ day (% (- wday wday1 -7) 7))))))
17138 (if (and (boundp 'org-time-was-given)
17140 (setq org-time-was-given t))
17141 (if (< year 100) (setq year (+ 2000 year)))
17142 ;; Check of the date is representable
17143 (if org-read-date-force-compatible-dates
17146 (setq year 1970 org-read-date-analyze-forced-year t))
17148 (setq year 2037 org-read-date-analyze-forced-year t)))
17149 (condition-case nil
17150 (ignore (encode-time second minute hour day month year))
17152 (setq year (nth 5 org-defdecode))
17153 (setq org-read-date-analyze-forced-year t))))
17154 (setq org-read-date-analyze-futurep futurep)
17155 (list second minute hour day month year)))
17157 (defvar parse-time-weekdays)
17158 (defun org-read-date-get-relative (s today default)
17159 "Check string S for special relative date string.
17160 TODAY and DEFAULT are internal times, for today and for a default.
17161 Return shift list (N what def-flag)
17162 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
17163 N is the number of WHATs to shift.
17164 DEF-FLAG is t when a double ++ or -- indicates shift relative to
17165 the DEFAULT date rather than TODAY."
17166 (require 'parse-time)
17170 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
17172 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
17173 "\\([ \t]\\|$\\)") s)
17174 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
17175 (let* ((dir (if (> (match-end 1) (match-beginning 1))
17176 (string-to-char (substring (match-string 1 s) -1))
17178 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
17179 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
17180 (what (if (match-end 3) (match-string 3 s) "d"))
17181 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
17182 (date (if rel default today))
17183 (wday (nth 6 (decode-time date)))
17187 (setq delta (mod (+ 7 (- wday1 wday)) 7))
17188 (if (= delta 0) (setq delta 7))
17191 (setq delta (- delta 7))
17192 (if (= delta 0) (setq delta -7))))
17193 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
17194 (list delta "d" rel))
17195 (list (* n (if (= dir ?-) -1 1)) what rel)))))
17197 (defun org-order-calendar-date-args (arg1 arg2 arg3)
17198 "Turn a user-specified date into the internal representation.
17199 The internal representation needed by the calendar is (month day year).
17200 This is a wrapper to handle the brain-dead convention in calendar that
17201 user function argument order change dependent on argument order."
17202 (if (boundp 'calendar-date-style)
17204 ((eq calendar-date-style 'american)
17205 (list arg1 arg2 arg3))
17206 ((eq calendar-date-style 'european)
17207 (list arg2 arg1 arg3))
17208 ((eq calendar-date-style 'iso)
17209 (list arg2 arg3 arg1)))
17210 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
17211 (if (org-bound-and-true-p european-calendar-style)
17212 (list arg2 arg1 arg3)
17213 (list arg1 arg2 arg3)))))
17215 (defun org-eval-in-calendar (form &optional keepdate)
17216 "Eval FORM in the calendar window and return to current window.
17217 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
17218 otherwise stick to the current value of `org-ans2'."
17219 (let ((sf (selected-frame))
17220 (sw (selected-window)))
17221 (select-window (get-buffer-window "*Calendar*" t))
17223 (when (and (not keepdate) (calendar-cursor-to-date))
17224 (let* ((date (calendar-cursor-to-date))
17225 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17226 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
17227 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
17229 (org-select-frame-set-input-focus sf)))
17231 (defun org-calendar-select ()
17232 "Return to `org-read-date' with the date currently selected.
17233 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17235 (when (calendar-cursor-to-date)
17236 (let* ((date (calendar-cursor-to-date))
17237 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17238 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17239 (if (active-minibuffer-window) (exit-minibuffer))))
17241 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
17242 "Insert a date stamp for the date given by the internal TIME.
17243 See `format-time-string' for the format of TIME.
17244 WITH-HM means use the stamp format that includes the time of the day.
17245 INACTIVE means use square brackets instead of angular ones, so that the
17246 stamp will not contribute to the agenda.
17247 PRE and POST are optional strings to be inserted before and after the
17249 The command returns the inserted time stamp."
17250 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
17252 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
17253 (insert-before-markers (or pre ""))
17254 (when (listp extra)
17255 (setq extra (car extra))
17256 (if (and (stringp extra)
17257 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
17258 (setq extra (format "-%02d:%02d"
17259 (string-to-number (match-string 1 extra))
17260 (string-to-number (match-string 2 extra))))
17263 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17264 (insert-before-markers (setq stamp (format-time-string fmt time)))
17265 (insert-before-markers (or post ""))
17266 (setq org-last-inserted-timestamp stamp)))
17268 (defun org-toggle-time-stamp-overlays ()
17269 "Toggle the use of custom time stamp formats."
17271 (setq org-display-custom-times (not org-display-custom-times))
17272 (unless org-display-custom-times
17273 (let ((p (point-min)) (bmp (buffer-modified-p)))
17274 (while (setq p (next-single-property-change p 'display))
17275 (if (and (get-text-property p 'display)
17276 (eq (get-text-property p 'face) 'org-date))
17277 (remove-text-properties
17278 p (setq p (next-single-property-change p 'display))
17280 (set-buffer-modified-p bmp)))
17281 (if (featurep 'xemacs)
17282 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17283 (org-restart-font-lock)
17284 (setq org-table-may-need-update t)
17285 (if org-display-custom-times
17286 (message "Time stamps are overlaid with custom format")
17287 (message "Time stamp overlays removed")))
17289 (defun org-display-custom-time (beg end)
17290 "Overlay modified time stamp format over timestamp between BEG and END."
17291 (let* ((ts (buffer-substring beg end))
17292 t1 w1 with-hm tf time str w2 (off 0))
17294 (setq t1 (org-parse-time-string ts t))
17295 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17296 (setq off (- (match-end 0) (match-beginning 0)))))
17297 (setq end (- end off))
17298 (setq w1 (- end beg)
17299 with-hm (and (nth 1 t1) (nth 2 t1))
17300 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17301 time (org-fix-decoded-time t1)
17303 (format-time-string
17304 (substring tf 1 -1) (apply 'encode-time time))
17305 nil 'mouse-face 'highlight)
17307 (if (not (= w2 w1))
17308 (add-text-properties (1+ beg) (+ 2 beg)
17309 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17310 (if (featurep 'xemacs)
17312 (put-text-property beg end 'invisible t)
17313 (put-text-property beg end 'end-glyph (make-glyph str)))
17314 (put-text-property beg end 'display str))))
17316 (defun org-fix-decoded-time (time)
17317 "Set 0 instead of nil for the first 6 elements of time.
17318 Don't touch the rest."
17320 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17322 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17324 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17325 "Difference between TIMESTAMP-STRING and now in days.
17326 If SECONDS is non-nil, return the difference in seconds."
17327 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17328 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17329 (funcall fdiff (current-time)))))
17331 (defun org-deadline-close (timestamp-string &optional ndays)
17332 "Is the time in TIMESTAMP-STRING close to the current date?"
17333 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17334 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17335 (not (org-entry-is-done-p))))
17337 (defun org-get-wdays (ts &optional delay zero-delay)
17338 "Get the deadline lead time appropriate for timestring TS.
17339 When DELAY is non-nil, get the delay time for scheduled items
17340 instead of the deadline lead time. When ZERO-DELAY is non-nil
17341 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17342 don't try to find the delay cookie in the scheduled timestamp."
17343 (let ((tv (if delay org-scheduled-delay-days
17344 org-deadline-warning-days)))
17346 ((or (and delay (< tv 0))
17347 (and delay zero-delay (<= tv 0))
17348 (and (not delay) (<= tv 0)))
17349 ;; Enforce this value no matter what
17351 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17352 ;; lead time is specified.
17353 (floor (* (string-to-number (match-string 1 ts))
17354 (cdr (assoc (match-string 2 ts)
17355 '(("d" . 1) ("w" . 7)
17356 ("m" . 30.4) ("y" . 365.25)
17357 ("h" . 0.041667)))))))
17358 ;; go for the default.
17361 (defun org-calendar-select-mouse (ev)
17362 "Return to `org-read-date' with the date currently selected.
17363 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17365 (mouse-set-point ev)
17366 (when (calendar-cursor-to-date)
17367 (let* ((date (calendar-cursor-to-date))
17368 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17369 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17370 (if (active-minibuffer-window) (exit-minibuffer))))
17372 (defun org-check-deadlines (ndays)
17373 "Check if there are any deadlines due or past due.
17374 A deadline is considered due if it happens within `org-deadline-warning-days'
17375 days from today's date. If the deadline appears in an entry marked DONE,
17376 it is not shown. The prefix arg NDAYS can be used to test that many
17377 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17379 (let* ((org-warn-days
17381 ((equal ndays '(4)) 100000)
17382 (ndays (prefix-numeric-value ndays))
17383 (t (abs org-deadline-warning-days))))
17384 (case-fold-search nil)
17385 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17387 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17389 (message "%d deadlines past-due or due within %d days"
17390 (org-occur regexp nil callback)
17393 (defsubst org-re-timestamp (type)
17394 "Return a regexp for timestamp TYPE.
17395 Allowed values for TYPE are:
17397 all: all timestamps
17398 active: only active timestamps (<...>)
17399 inactive: only inactive timestamps ([...])
17400 scheduled: only scheduled timestamps
17401 deadline: only deadline timestamps
17402 closed: only closed time-stamps
17404 When TYPE is nil, fall back on returning a regexp that matches
17405 both scheduled and deadline timestamps."
17407 (all org-ts-regexp-both)
17408 (active org-ts-regexp)
17409 (inactive org-ts-regexp-inactive)
17410 (scheduled org-scheduled-time-regexp)
17411 (deadline org-deadline-time-regexp)
17412 (closed org-closed-time-regexp)
17415 (regexp-opt (list org-deadline-string org-scheduled-string))
17416 " *<\\([^>]+\\)>"))))
17418 (defun org-check-before-date (date)
17419 "Check if there are deadlines or scheduled entries before DATE."
17420 (interactive (list (org-read-date)))
17421 (let ((case-fold-search nil)
17422 (regexp (org-re-timestamp org-ts-type))
17425 (and ,(if (memq org-ts-type '(active inactive all))
17426 '(eq (org-element-type (org-element-context) 'timestamp))
17427 '(org-at-planning-p))
17429 (org-time-string-to-time (match-string 1))
17430 (org-time-string-to-time date))))))
17431 (message "%d entries before %s"
17432 (org-occur regexp nil callback) date)))
17434 (defun org-check-after-date (date)
17435 "Check if there are deadlines or scheduled entries after DATE."
17436 (interactive (list (org-read-date)))
17437 (let ((case-fold-search nil)
17438 (regexp (org-re-timestamp org-ts-type))
17441 (and ,(if (memq org-ts-type '(active inactive all))
17442 '(eq (org-element-type (org-element-context) 'timestamp))
17443 '(org-at-planning-p))
17445 (org-time-string-to-time (match-string 1))
17446 (org-time-string-to-time date)))))))
17447 (message "%d entries after %s"
17448 (org-occur regexp nil callback) date)))
17450 (defun org-check-dates-range (start-date end-date)
17451 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17452 (interactive (list (org-read-date nil nil nil "Range starts")
17453 (org-read-date nil nil nil "Range end")))
17454 (let ((case-fold-search nil)
17455 (regexp (org-re-timestamp org-ts-type))
17458 (let ((match (match-string 1)))
17460 ,(if (memq org-ts-type '(active inactive all))
17461 '(eq (org-element-type (org-element-context) 'timestamp))
17462 '(org-at-planning-p))
17464 (org-time-string-to-time match)
17465 (org-time-string-to-time start-date)))
17467 (org-time-string-to-time match)
17468 (org-time-string-to-time end-date)))))))
17469 (message "%d entries between %s and %s"
17470 (org-occur regexp nil callback) start-date end-date)))
17472 (defun org-evaluate-time-range (&optional to-buffer)
17473 "Evaluate a time range by computing the difference between start and end.
17474 Normally the result is just printed in the echo area, but with prefix arg
17475 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17476 If the time range is actually in a table, the result is inserted into the
17478 For time difference computation, a year is assumed to be exactly 365
17479 days in order to avoid rounding problems."
17482 (org-clock-update-time-maybe)
17484 (unless (org-at-date-range-p t)
17485 (goto-char (point-at-bol))
17486 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17487 (if (not (org-at-date-range-p t))
17488 (user-error "Not at a time-stamp range, and none found in current line")))
17489 (let* ((ts1 (match-string 1))
17490 (ts2 (match-string 2))
17491 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17492 (match-end (match-end 0))
17493 (time1 (org-time-string-to-time ts1))
17494 (time2 (org-time-string-to-time ts2))
17495 (t1 (org-float-time time1))
17496 (t2 (org-float-time time2))
17497 (diff (abs (- t2 t1)))
17498 (negative (< (- t2 t1) 0))
17499 ;; (ys (floor (* 365 24 60 60)))
17502 (fy "%dy %dd %02d:%02d")
17504 (fd "%dd %02d:%02d")
17509 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17511 d (floor (/ diff ds)) diff (mod diff ds)
17512 h (floor (/ diff hs)) diff (mod diff hs)
17513 m (floor (/ diff 60)))
17514 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17516 d (floor (+ (/ diff ds) 0.5))
17518 (if (not to-buffer)
17519 (message "%s" (org-make-tdiff-string y d h m))
17520 (if (org-at-table-p)
17522 (goto-char match-end)
17524 (and (looking-at " *|") (goto-char (match-end 0))))
17525 (goto-char match-end))
17527 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17528 (replace-match ""))
17529 (if negative (insert " -"))
17530 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17531 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17532 (insert " " (format fh h m))))
17533 (if align (org-table-align))
17534 (message "Time difference inserted")))))
17536 (defun org-make-tdiff-string (y d h m)
17539 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17541 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17543 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17545 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17547 (apply 'format fmt (nreverse l))))
17549 (defun org-time-string-to-time (s &optional buffer pos)
17550 "Convert a timestamp string into internal time."
17551 (condition-case errdata
17552 (apply 'encode-time (org-parse-time-string s))
17553 (error (error "Bad timestamp `%s'%s\nError was: %s"
17554 s (if (not (and buffer pos))
17556 (format " at %d in buffer `%s'" pos buffer))
17559 (defun org-time-string-to-seconds (s)
17560 "Convert a timestamp string to a number of seconds."
17561 (org-float-time (org-time-string-to-time s)))
17563 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17564 "Convert a time stamp to an absolute day number.
17565 If there is a specifier for a cyclic time stamp, get the closest
17567 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17568 The variable `date' is bound by the calendar when this is called."
17570 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17571 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17574 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17575 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17576 (time-to-days (current-time))) (match-string 0 s)
17579 (condition-case errdata
17580 (apply 'encode-time (org-parse-time-string s))
17581 (error (error "Bad timestamp `%s'%s\nError was: %s"
17582 s (if (not (and buffer pos))
17584 (format " at %d in buffer `%s'" pos buffer))
17585 (cdr errdata))))))))
17587 (defun org-days-to-iso-week (days)
17588 "Return the iso week number."
17590 (car (calendar-iso-from-absolute days)))
17592 (defun org-small-year-to-year (year)
17593 "Convert 2-digit years into 4-digit years.
17594 YEAR is expanded into one of the 30 next years, if possible, or
17595 into a past one. Any year larger than 99 is returned unchanged."
17596 (if (>= year 100) year
17597 (let* ((current (string-to-number (format-time-string "%Y" (current-time))))
17598 (century (/ current 100))
17599 (offset (- year (% current 100))))
17600 (cond ((> offset 30) (+ (* (1- century) 100) year))
17601 ((> offset -70) (+ (* century 100) year))
17602 (t (+ (* (1+ century) 100) year))))))
17604 (defun org-time-from-absolute (d)
17605 "Return the time corresponding to date D.
17606 D may be an absolute day number, or a calendar-type list (month day year)."
17607 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17608 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17610 (defun org-calendar-holiday ()
17611 "List of holidays, for Diary display in Org-mode."
17612 (require 'holidays)
17614 (if (fboundp 'calendar-check-holidays)
17615 'calendar-check-holidays 'check-calendar-holidays) date)))
17616 (if hl (mapconcat 'identity hl "; "))))
17618 (defun org-diary-sexp-entry (sexp entry date)
17619 "Process a SEXP diary ENTRY for DATE."
17620 (require 'diary-lib)
17621 (let ((result (if calendar-debug-sexp
17622 (let ((stack-trace-on-error t))
17623 (eval (car (read-from-string sexp))))
17624 (condition-case nil
17625 (eval (car (read-from-string sexp)))
17628 (message "Bad sexp at line %d in %s: %s"
17630 (buffer-file-name) sexp)
17632 (cond ((stringp result) (split-string result "; "))
17633 ((and (consp result)
17634 (not (consp (cdr result)))
17635 (stringp (cdr result))) (cdr result))
17636 ((and (consp result)
17637 (stringp (car result))) result)
17640 (defun org-diary-to-ical-string (frombuf)
17641 "Get iCalendar entries from diary entries in buffer FROMBUF.
17642 This uses the icalendar.el library."
17643 (let* ((tmpdir (if (featurep 'xemacs)
17645 temporary-file-directory))
17646 (tmpfile (make-temp-name
17647 (expand-file-name "orgics" tmpdir)))
17649 (with-current-buffer frombuf
17650 (icalendar-export-region (point-min) (point-max) tmpfile)
17651 (setq buf (find-buffer-visiting tmpfile))
17653 (goto-char (point-min))
17654 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17655 (setq b (match-beginning 0)))
17656 (goto-char (point-max))
17657 (if (re-search-backward "^END:VEVENT" nil t)
17658 (setq e (match-end 0)))
17659 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17661 (delete-file tmpfile)
17664 (defun org-closest-date (start current change prefer show-all)
17665 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17666 When PREFER is `past', return a date that is either CURRENT or past.
17667 When PREFER is `future', return a date that is either CURRENT or future.
17668 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17669 ;; Make the proper lists from the dates
17671 (let ((a1 '(("h" . hour)
17676 (shour (nth 2 (org-parse-time-string start)))
17677 dn dw sday cday n1 n2 n0
17678 d m y y1 y2 date1 date2 nmonths nm ny m2)
17680 (setq start (org-date-to-gregorian start)
17681 current (org-date-to-gregorian
17684 (time-to-days (current-time))))
17685 sday (calendar-absolute-from-gregorian start)
17686 cday (calendar-absolute-from-gregorian current))
17688 (if (<= cday sday) (throw 'exit sday))
17690 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17691 (setq dn (string-to-number (match-string 1 change))
17692 dw (cdr (assoc (match-string 2 change) a1)))
17693 (user-error "Invalid change specifier: %s" change))
17694 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17697 (let ((missing-hours
17698 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17700 (setq n1 (if (zerop missing-hours) cday
17701 (- cday (1+ (floor (/ missing-hours 24)))))
17702 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17704 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17707 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17708 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17709 (setq date1 (list m d y1)
17710 n1 (calendar-absolute-from-gregorian date1)
17711 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17712 n2 (calendar-absolute-from-gregorian date2)))
17714 ;; approx number of month between the two dates
17715 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17716 ;; How often does dn fit in there?
17717 (setq d (nth 1 start) m (car start) y (nth 2 start)
17718 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17720 ny (floor (/ m 12))
17723 (while (> m 12) (setq m (- m 12) y (1+ y)))
17724 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17725 (setq m2 (+ m dn) y2 y)
17726 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17727 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17728 (while (<= n2 cday)
17729 (setq n1 n2 m m2 y y2)
17730 (setq m2 (+ m dn) y2 y)
17731 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17732 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17733 ;; Make sure n1 is the earlier date
17734 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17737 ((eq prefer 'past) (if (= cday n2) n2 n1))
17738 ((eq prefer 'future) (if (= cday n1) n1 n2))
17739 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17741 ((eq prefer 'past) (if (= cday n2) n2 n1))
17742 ((eq prefer 'future) (if (= cday n1) n1 n2))
17743 (t (if (= cday n1) n1 n2)))))))
17745 (defun org-date-to-gregorian (date)
17746 "Turn any specification of DATE into a Gregorian date for the calendar."
17747 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17748 ((and (listp date) (= (length date) 3)) date)
17750 (setq date (org-parse-time-string date))
17751 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17753 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17755 (defun org-parse-time-string (s &optional nodefault)
17756 "Parse the standard Org-mode time string.
17757 This should be a lot faster than the normal `parse-time-string'.
17758 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17759 hour and minute fields will be nil if not given."
17760 (cond ((string-match org-ts-regexp0 s)
17762 (if (or (match-beginning 8) (not nodefault))
17763 (string-to-number (or (match-string 8 s) "0")))
17764 (if (or (match-beginning 7) (not nodefault))
17765 (string-to-number (or (match-string 7 s) "0")))
17766 (string-to-number (match-string 4 s))
17767 (string-to-number (match-string 3 s))
17768 (string-to-number (match-string 2 s))
17770 ((string-match "^<[^>]+>$" s)
17771 (decode-time (seconds-to-time (org-matcher-time s))))
17772 (t (error "Not a standard Org-mode time string: %s" s))))
17774 (defun org-timestamp-up (&optional arg)
17775 "Increase the date item at the cursor by one.
17776 If the cursor is on the year, change the year. If it is on the month,
17777 the day or the time, change that.
17778 With prefix ARG, change by that many units."
17780 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17782 (defun org-timestamp-down (&optional arg)
17783 "Decrease the date item at the cursor by one.
17784 If the cursor is on the year, change the year. If it is on the month,
17785 the day or the time, change that.
17786 With prefix ARG, change by that many units."
17788 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17790 (defun org-timestamp-up-day (&optional arg)
17791 "Increase the date in the time stamp by one day.
17792 With prefix ARG, change that many days."
17794 (if (and (not (org-at-timestamp-p t))
17795 (org-at-heading-p))
17797 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17799 (defun org-timestamp-down-day (&optional arg)
17800 "Decrease the date in the time stamp by one day.
17801 With prefix ARG, change that many days."
17803 (if (and (not (org-at-timestamp-p t))
17804 (org-at-heading-p))
17806 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17808 (defun org-at-timestamp-p (&optional inactive-ok)
17809 "Determine if the cursor is in or at a timestamp."
17811 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17813 (ans (or (looking-at tsr)
17815 (skip-chars-backward "^[<\n\r\t")
17816 (if (> (point) (point-min)) (backward-char 1))
17817 (and (looking-at tsr)
17818 (> (- (match-end 0) pos) -1))))))
17820 (boundp 'org-ts-what)
17823 ((= pos (match-beginning 0)) 'bracket)
17824 ;; Point is considered to be "on the bracket" whether
17825 ;; it's really on it or right after it.
17826 ((= pos (1- (match-end 0))) 'bracket)
17827 ((= pos (match-end 0)) 'after)
17828 ((org-pos-in-match-range pos 2) 'year)
17829 ((org-pos-in-match-range pos 3) 'month)
17830 ((org-pos-in-match-range pos 7) 'hour)
17831 ((org-pos-in-match-range pos 8) 'minute)
17832 ((or (org-pos-in-match-range pos 4)
17833 (org-pos-in-match-range pos 5)) 'day)
17834 ((and (> pos (or (match-end 8) (match-end 5)))
17835 (< pos (match-end 0)))
17836 (- pos (or (match-end 8) (match-end 5))))
17840 (defun org-toggle-timestamp-type ()
17841 "Toggle the type (<active> or [inactive]) of a time stamp."
17843 (when (org-at-timestamp-p t)
17844 (let ((beg (match-beginning 0)) (end (match-end 0))
17845 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17848 (while (re-search-forward "[][<>]" end t)
17849 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17851 (message "Timestamp is now %sactive"
17852 (if (equal (char-after beg) ?<) "" "in")))))
17854 (defun org-at-clock-log-p nil
17855 "Is the cursor on the clock log line?"
17857 (move-beginning-of-line 1)
17858 (looking-at org-clock-line-re)))
17860 (defvar org-clock-history) ; defined in org-clock.el
17861 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17862 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17863 "Change the date in the time stamp at point.
17864 The date will be changed by N times WHAT. WHAT can be `day', `month',
17865 `year', `minute', `second'. If WHAT is not given, the cursor position
17866 in the timestamp determines what will be changed.
17867 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17868 (let ((origin (point)) origin-cat
17870 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17873 ts time time0 fixnext clrgx)
17874 (if (not (org-at-timestamp-p t))
17875 (user-error "Not at a timestamp"))
17876 (if (and (not what) (eq org-ts-what 'bracket))
17877 (org-toggle-timestamp-type)
17878 ;; Point isn't on brackets. Remember the part of the time-stamp
17879 ;; the point was in. Indeed, size of time-stamps may change,
17880 ;; but point must be kept in the same category nonetheless.
17881 (setq origin-cat org-ts-what)
17882 (if (and (not what) (not (eq org-ts-what 'day))
17883 org-display-custom-times
17884 (get-text-property (point) 'display)
17885 (not (get-text-property (1- (point)) 'display)))
17886 (setq org-ts-what 'day))
17887 (setq org-ts-what (or what org-ts-what)
17888 inactive (= (char-after (match-beginning 0)) ?\[)
17889 ts (match-string 0))
17891 (when (string-match
17892 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17894 (setq extra (match-string 1 ts))
17895 (if suppress-tmp-delay
17896 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17897 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17899 (setq time0 (org-parse-time-string ts))
17901 (eq org-ts-what 'minute)
17902 (not current-prefix-arg))
17903 ;; This looks like s-up and s-down. Change by one rounding step.
17904 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17905 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17906 (setcar (cdr time0) (+ (nth 1 time0)
17907 (if (> n 0) (- rem) (- dm rem))))))
17909 (encode-time (or (car time0) 0)
17910 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17911 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17912 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17913 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17914 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17916 (when (and (member org-ts-what '(hour minute))
17918 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17919 (setq extra (org-modify-ts-extra
17921 (if (eq org-ts-what 'hour) 2 5)
17923 (when (integerp org-ts-what)
17924 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17925 (if (eq what 'calendar)
17926 (let ((cal-date (org-get-date-from-calendar)))
17927 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17928 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17929 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17930 (setcar time0 (or (car time0) 0))
17931 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17932 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17933 (setq time (apply 'encode-time time0))))
17934 ;; Insert the new time-stamp, and ensure point stays in the same
17935 ;; category as before (i.e. not after the last position in that
17937 (let ((pos (point)))
17938 ;; Stay before inserted string. `save-excursion' is of no use.
17939 (setq org-last-changed-timestamp
17940 (org-insert-time-stamp time with-hm inactive nil nil extra))
17943 (looking-at org-ts-regexp3)
17945 ;; `day' category ends before `hour' if any, or at
17946 ;; the end of the day name.
17947 ((eq origin-cat 'day)
17948 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17949 ((eq origin-cat 'hour) (min (match-end 7) origin))
17950 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17951 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17952 ;; `year' and `month' have both fixed size: point
17953 ;; couldn't have moved into another part.
17955 ;; Update clock if on a CLOCK line.
17956 (org-clock-update-time-maybe)
17957 ;; Maybe adjust the closest clock in `org-clock-history'
17958 (when org-clock-adjust-closest
17959 (if (not (and (org-at-clock-log-p)
17960 (< 1 (length (delq nil (mapcar 'marker-position
17961 org-clock-history))))))
17962 (message "No clock to adjust")
17963 (cond ((save-excursion ; fix previous clock?
17964 (re-search-backward org-ts-regexp0 nil t)
17965 (org-looking-back (concat org-clock-string " \\[")))
17966 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17967 ((save-excursion ; fix next clock?
17968 (re-search-backward org-ts-regexp0 nil t)
17969 (looking-at (concat org-ts-regexp0 "\\] =>")))
17970 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17971 (save-window-excursion
17972 ;; Find closest clock to point, adjust the previous/next one in history
17973 (let* ((p (save-excursion (org-back-to-heading t)))
17974 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17976 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17977 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17979 (message "No clock to adjust")
17981 (org-goto-marker-or-bmk clfixpos)
17983 (when (re-search-forward clrgx nil t)
17984 (goto-char (match-beginning 1))
17985 (let (org-clock-adjust-closest)
17986 (org-timestamp-change n org-ts-what updown))
17987 (message "Clock adjusted in %s for heading: %s"
17988 (file-name-nondirectory (buffer-file-name))
17989 (org-get-heading t t)))))))))
17990 ;; Try to recenter the calendar window, if any.
17991 (if (and org-calendar-follow-timestamp-change
17992 (get-buffer-window "*Calendar*" t)
17993 (memq org-ts-what '(day month year)))
17994 (org-recenter-calendar (time-to-days time))))))
17996 (defun org-modify-ts-extra (s pos n dm)
17997 "Change the different parts of the lead-time and repeat fields in timestamp."
17998 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
18000 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
18002 ((or (org-pos-in-match-range pos 2)
18003 (org-pos-in-match-range pos 3))
18004 (setq m (string-to-number (match-string 3 s))
18005 h (string-to-number (match-string 2 s)))
18006 (if (org-pos-in-match-range pos 2)
18008 (setq n (* dm (org-no-warnings (signum n))))
18009 (when (not (= 0 (setq rem (% m dm))))
18010 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
18012 (if (< m 0) (setq m (+ m 60) h (1- h)))
18013 (if (> m 59) (setq m (- m 60) h (1+ h)))
18014 (setq h (min 24 (max 0 h)))
18015 (setq ng 1 new (format "-%02d:%02d" h m)))
18016 ((org-pos-in-match-range pos 6)
18017 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
18018 ((org-pos-in-match-range pos 5)
18019 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
18021 ((org-pos-in-match-range pos 9)
18022 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
18023 ((org-pos-in-match-range pos 8)
18024 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
18028 (substring s 0 (match-beginning ng))
18030 (substring s (match-end ng))))))
18033 (defun org-recenter-calendar (date)
18034 "If the calendar is visible, recenter it to DATE."
18035 (let ((cwin (get-buffer-window "*Calendar*" t)))
18037 (let ((calendar-move-hook nil))
18038 (with-selected-window cwin
18039 (calendar-goto-date (if (listp date) date
18040 (calendar-gregorian-from-absolute date))))))))
18042 (defun org-goto-calendar (&optional arg)
18043 "Go to the Emacs calendar at the current date.
18044 If there is a time stamp in the current line, go to that date.
18045 A prefix ARG can be used to force the current date."
18047 (let ((tsr org-ts-regexp) diff
18048 (calendar-move-hook nil)
18049 (calendar-view-holidays-initially-flag nil)
18050 (calendar-view-diary-initially-flag nil))
18051 (if (or (org-at-timestamp-p)
18053 (beginning-of-line 1)
18054 (looking-at (concat ".*" tsr))))
18055 (let ((d1 (time-to-days (current-time)))
18057 (org-time-string-to-time (match-string 1)))))
18058 (setq diff (- d2 d1))))
18060 (calendar-goto-today)
18061 (if (and diff (not arg)) (calendar-forward-day diff))))
18063 (defun org-get-date-from-calendar ()
18064 "Return a list (month day year) of date at point in calendar."
18065 (with-current-buffer "*Calendar*"
18067 (calendar-cursor-to-date))))
18069 (defun org-date-from-calendar ()
18070 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
18071 If there is already a time stamp at the cursor position, update it."
18073 (if (org-at-timestamp-p t)
18074 (org-timestamp-change 0 'calendar)
18075 (let ((cal-date (org-get-date-from-calendar)))
18076 (org-insert-time-stamp
18077 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
18079 (defcustom org-effort-durations
18083 ("w" . ,(* 60 8 5))
18084 ("m" . ,(* 60 8 5 4))
18085 ("y" . ,(* 60 8 5 40)))
18086 "Conversion factor to minutes for an effort modifier.
18088 Each entry has the form (MODIFIER . MINUTES).
18090 In an effort string, a number followed by MODIFIER is multiplied
18091 by the specified number of MINUTES to obtain an effort in
18094 For example, if the value of this variable is ((\"hours\" . 60)), then an
18095 effort string \"2hours\" is equivalent to 120 minutes."
18098 :package-version '(Org . "8.3")
18099 :type '(alist :key-type (string :tag "Modifier")
18100 :value-type (number :tag "Minutes")))
18102 (defun org-minutes-to-clocksum-string (m)
18103 "Format number of minutes as a clocksum string.
18104 The format is determined by `org-time-clocksum-format',
18105 `org-time-clocksum-use-fractional' and
18106 `org-time-clocksum-fractional-format' and
18107 `org-time-clocksum-use-effort-durations'."
18108 (let ((clocksum "")
18109 (m (round m)) ; Don't allow fractions of minutes
18111 (setq h (if org-time-clocksum-use-effort-durations
18112 (cdr (assoc "h" org-effort-durations)) 60)
18113 d (if org-time-clocksum-use-effort-durations
18114 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
18115 w (if org-time-clocksum-use-effort-durations
18116 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
18117 mo (if org-time-clocksum-use-effort-durations
18118 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
18119 y (if org-time-clocksum-use-effort-durations
18120 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
18121 ;; fractional format
18122 (if org-time-clocksum-use-fractional
18124 ;; single format string
18125 ((stringp org-time-clocksum-fractional-format)
18126 (format org-time-clocksum-fractional-format (/ m (float h))))
18127 ;; choice of fractional formats for different time units
18128 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
18129 (> (/ (truncate m) (* y d h)) 0))
18130 (format fmt (/ m (* y d (float h)))))
18131 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
18132 (> (/ (truncate m) (* mo d h)) 0))
18133 (format fmt (/ m (* mo d (float h)))))
18134 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18135 (> (/ (truncate m) (* w d h)) 0))
18136 (format fmt (/ m (* w d (float h)))))
18137 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
18138 (> (/ (truncate m) (* d h)) 0))
18139 (format fmt (/ m (* d (float h)))))
18140 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18141 (> (/ (truncate m) h) 0))
18142 (format fmt (/ m (float h))))
18143 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
18145 ;; fall back to smallest time unit with a format
18146 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
18147 (format fmt (/ m (float h))))
18148 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
18149 (format fmt (/ m (* d (float h)))))
18150 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
18151 (format fmt (/ m (* w d (float h)))))
18152 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
18153 (format fmt (/ m (* mo d (float h)))))
18154 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
18155 (format fmt (/ m (* y d (float h))))))
18156 ;; standard (non-fractional) format, with single format string
18157 (if (stringp org-time-clocksum-format)
18158 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
18159 ;; separate formats components
18160 (and (setq fmt (plist-get org-time-clocksum-format :years))
18161 (or (> (setq n (/ (truncate m) (* y d h))) 0)
18162 (plist-get org-time-clocksum-format :require-years))
18163 (setq clocksum (concat clocksum (format fmt n))
18164 m (- m (* n y d h))))
18165 (and (setq fmt (plist-get org-time-clocksum-format :months))
18166 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
18167 (plist-get org-time-clocksum-format :require-months))
18168 (setq clocksum (concat clocksum (format fmt n))
18169 m (- m (* n mo d h))))
18170 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
18171 (or (> (setq n (/ (truncate m) (* w d h))) 0)
18172 (plist-get org-time-clocksum-format :require-weeks))
18173 (setq clocksum (concat clocksum (format fmt n))
18174 m (- m (* n w d h))))
18175 (and (setq fmt (plist-get org-time-clocksum-format :days))
18176 (or (> (setq n (/ (truncate m) (* d h))) 0)
18177 (plist-get org-time-clocksum-format :require-days))
18178 (setq clocksum (concat clocksum (format fmt n))
18179 m (- m (* n d h))))
18180 (and (setq fmt (plist-get org-time-clocksum-format :hours))
18181 (or (> (setq n (/ (truncate m) h)) 0)
18182 (plist-get org-time-clocksum-format :require-hours))
18183 (setq clocksum (concat clocksum (format fmt n))
18185 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
18186 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
18187 (setq clocksum (concat clocksum (format fmt m))))
18188 ;; return formatted time duration
18191 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
18192 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
18193 "Org mode version 8.0")
18195 (defun org-hours-to-clocksum-string (n)
18196 (org-minutes-to-clocksum-string (* n 60)))
18198 (defun org-hh:mm-string-to-minutes (s)
18199 "Convert a string H:MM to a number of minutes.
18200 If the string is just a number, interpret it as minutes.
18201 In fact, the first hh:mm or number in the string will be taken,
18202 there can be extra stuff in the string.
18203 If no number is found, the return value is 0."
18206 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
18207 (+ (* (string-to-number (match-string 1 s)) 60)
18208 (string-to-number (match-string 2 s))))
18209 ((string-match "\\([0-9]+\\)" s)
18210 (string-to-number (match-string 1 s)))
18213 (defcustom org-image-actual-width t
18214 "Should we use the actual width of images when inlining them?
18216 When set to `t', always use the image width.
18218 When set to a number, use imagemagick (when available) to set
18219 the image's width to this value.
18221 When set to a number in a list, try to get the width from any
18222 #+ATTR.* keyword if it matches a width specification like
18224 #+ATTR_HTML: :width 300px
18226 and fall back on that number if none is found.
18228 When set to nil, try to get the width from an #+ATTR.* keyword
18229 and fall back on the original width if none is found.
18231 This requires Emacs >= 24.1, build with imagemagick support."
18232 :group 'org-appearance
18234 :package-version '(Org . "8.0")
18236 (const :tag "Use the image width" t)
18237 (integer :tag "Use a number of pixels")
18238 (list :tag "Use #+ATTR* or a number of pixels" (integer))
18239 (const :tag "Use #+ATTR* or don't resize" nil)))
18241 (defcustom org-agenda-inhibit-startup nil
18242 "Inhibit startup when preparing agenda buffers.
18243 When this variable is `t', the initialization of the Org agenda
18244 buffers is inhibited: e.g. the visibility state is not set, the
18245 tables are not re-aligned, etc."
18248 :group 'org-agenda)
18250 (define-obsolete-variable-alias
18251 'org-agenda-ignore-drawer-properties
18252 'org-agenda-ignore-properties "25.1")
18254 (defcustom org-agenda-ignore-properties nil
18255 "Avoid updating text properties when building the agenda.
18256 Properties are used to prepare buffers for effort estimates,
18257 appointments, statistics and subtree-local categories.
18258 If you don't use these in the agenda, you can add them to this
18259 list and agenda building will be a bit faster.
18260 The value is a list, with zero or more of the symbols `effort', `appt',
18261 `stats' or `category'."
18262 :type '(set :greedy t
18268 :package-version '(Org . "8.3")
18269 :group 'org-agenda)
18271 (defun org-duration-string-to-minutes (s &optional output-to-string)
18272 "Convert a duration string S to minutes.
18274 A bare number is interpreted as minutes, modifiers can be set by
18275 customizing `org-effort-durations' (which see).
18277 Entries containing a colon are interpreted as H:MM by
18278 `org-hh:mm-string-to-minutes'."
18280 (re (concat "\\([0-9.]+\\) *\\("
18281 (regexp-opt (mapcar 'car org-effort-durations))
18283 (while (string-match re s)
18284 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18285 (string-to-number (match-string 1 s))))
18286 (setq s (replace-match "" nil t s)))
18287 (setq result (floor result))
18288 (incf result (org-hh:mm-string-to-minutes s))
18289 (if output-to-string (number-to-string result) result)))
18293 (defun org-save-all-org-buffers ()
18294 "Save all Org-mode buffers without user confirmation."
18296 (message "Saving all Org-mode buffers...")
18297 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18298 (when (featurep 'org-id) (org-id-locations-save))
18299 (message "Saving all Org-mode buffers... done"))
18301 (defun org-revert-all-org-buffers ()
18302 "Revert all Org-mode buffers.
18303 Prompt for confirmation when there are unsaved changes.
18304 Be sure you know what you are doing before letting this function
18305 overwrite your changes.
18307 This function is useful in a setup where one tracks org files
18308 with a version control system, to revert on one machine after pulling
18309 changes from another. I believe the procedure must be like this:
18311 1. M-x org-save-all-org-buffers
18312 2. Pull changes from the other machine, resolve conflicts
18313 3. M-x org-revert-all-org-buffers"
18315 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18316 (user-error "Abort"))
18318 (save-window-excursion
18321 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18322 (with-current-buffer b buffer-file-name))
18323 (org-pop-to-buffer-same-window b)
18324 (revert-buffer t 'no-confirm)))
18326 (when (and (featurep 'org-id) org-id-track-globally)
18327 (org-id-locations-load)))))
18332 (defun org-switchb (&optional arg)
18333 "Switch between Org buffers.
18334 With one prefix argument, restrict available buffers to files.
18335 With two prefix arguments, restrict available buffers to agenda files.
18337 Defaults to `iswitchb' for buffer name completion.
18338 Set `org-completion-use-ido' to make it use ido instead."
18340 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18341 ((equal arg '(16)) (org-buffer-list 'agenda))
18342 (t (org-buffer-list))))
18343 (org-completion-use-iswitchb org-completion-use-iswitchb)
18344 (org-completion-use-ido org-completion-use-ido))
18345 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18346 (setq org-completion-use-iswitchb t))
18347 (org-pop-to-buffer-same-window
18348 (org-icompleting-read "Org buffer: "
18349 (mapcar 'list (mapcar 'buffer-name blist))
18352 ;;; Define some older names previously used for this functionality
18354 (defalias 'org-ido-switchb 'org-switchb)
18356 (defalias 'org-iswitchb 'org-switchb)
18358 (defun org-buffer-list (&optional predicate exclude-tmp)
18359 "Return a list of Org buffers.
18360 PREDICATE can be `export', `files' or `agenda'.
18362 export restrict the list to Export buffers.
18363 files restrict the list to buffers visiting Org files.
18364 agenda restrict the list to buffers visiting agenda files.
18366 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18368 (agenda-files (and (eq predicate 'agenda)
18369 (mapcar 'file-truename (org-agenda-files t))))
18372 ((eq predicate 'files)
18373 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18374 ((eq predicate 'export)
18375 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18376 ((eq predicate 'agenda)
18378 (with-current-buffer b
18379 (and (derived-mode-p 'org-mode)
18380 (setq bfn (buffer-file-name b))
18381 (member (file-truename bfn) agenda-files)))))
18382 (t (lambda (b) (with-current-buffer b
18383 (or (derived-mode-p 'org-mode)
18384 (string-match "\*Org .*Export"
18385 (buffer-name b)))))))))
18389 (if (and (funcall filter b)
18390 (or (not exclude-tmp)
18391 (not (string-match "tmp" (buffer-name b)))))
18396 (defun org-agenda-files (&optional unrestricted archives)
18397 "Get the list of agenda files.
18398 Optional UNRESTRICTED means return the full list even if a restriction
18399 is currently in place.
18400 When ARCHIVES is t, include all archive files that are really being
18401 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18402 `org-agenda-archives-mode' is t."
18405 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18406 ((stringp org-agenda-files) (org-read-agenda-file-list))
18407 ((listp org-agenda-files) org-agenda-files)
18408 (t (error "Invalid value of `org-agenda-files'")))))
18409 (setq files (apply 'append
18410 (mapcar (lambda (f)
18411 (if (file-directory-p f)
18413 f t org-agenda-file-regexp)
18416 (when org-agenda-skip-unavailable-files
18417 (setq files (delq nil
18420 (and (file-readable-p file) file)))
18422 (when (or (eq archives t)
18423 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18424 (setq files (org-add-archive-files files)))
18427 (defun org-agenda-file-p (&optional file)
18428 "Return non-nil, if FILE is an agenda file.
18429 If FILE is omitted, use the file associated with the current
18431 (let ((fname (or file (buffer-file-name))))
18433 (member (file-truename fname)
18434 (mapcar #'file-truename (org-agenda-files t))))))
18436 (defun org-edit-agenda-file-list ()
18437 "Edit the list of agenda files.
18438 Depending on setup, this either uses customize to edit the variable
18439 `org-agenda-files', or it visits the file that is holding the list. In the
18440 latter case, the buffer is set up in a way that saving it automatically kills
18441 the buffer and restores the previous window configuration."
18443 (if (stringp org-agenda-files)
18444 (let ((cw (current-window-configuration)))
18445 (find-file org-agenda-files)
18446 (org-set-local 'org-window-configuration cw)
18447 (org-add-hook 'after-save-hook
18449 (set-window-configuration
18450 (prog1 org-window-configuration
18451 (kill-buffer (current-buffer))))
18452 (org-install-agenda-files-menu)
18453 (message "New agenda file list installed"))
18455 (message "%s" (substitute-command-keys
18456 "Edit list and finish with \\[save-buffer]")))
18457 (customize-variable 'org-agenda-files)))
18459 (defun org-store-new-agenda-file-list (list)
18460 "Set new value for the agenda file list and save it correctly."
18461 (if (stringp org-agenda-files)
18462 (let ((fe (org-read-agenda-file-list t)) b u)
18463 (while (setq b (find-buffer-visiting org-agenda-files))
18465 (with-temp-file org-agenda-files
18468 (lambda (f) ;; Keep un-expanded entries.
18469 (if (setq u (assoc f fe))
18474 (let ((org-mode-hook nil) (org-inhibit-startup t)
18475 (org-insert-mode-line-in-empty-file nil))
18476 (setq org-agenda-files list)
18477 (customize-save-variable 'org-agenda-files org-agenda-files))))
18479 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18480 "Read the list of agenda files from a file.
18481 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18482 filenames, used by `org-store-new-agenda-file-list' to write back
18483 un-expanded file names."
18484 (when (file-directory-p org-agenda-files)
18485 (error "`org-agenda-files' cannot be a single directory"))
18486 (when (stringp org-agenda-files)
18488 (insert-file-contents org-agenda-files)
18491 (let ((e (expand-file-name (substitute-in-file-name f)
18493 (if pair-with-expansion
18496 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18499 (defun org-cycle-agenda-files ()
18500 "Cycle through the files in `org-agenda-files'.
18501 If the current buffer visits an agenda file, find the next one in the list.
18502 If the current buffer does not, find the first agenda file."
18504 (let* ((fs (org-agenda-files t))
18505 (files (append fs (list (car fs))))
18506 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18508 (unless files (user-error "No agenda files"))
18510 (while (setq file (pop files))
18511 (if (equal (file-truename file) tcf)
18513 (find-file (car files))
18515 (find-file (car fs)))
18516 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18518 (defun org-agenda-file-to-front (&optional to-end)
18519 "Move/add the current file to the top of the agenda file list.
18520 If the file is not present in the list, it is added to the front. If it is
18521 present, it is moved there. With optional argument TO-END, add/move to the
18524 (let ((org-agenda-skip-unavailable-files nil)
18525 (file-alist (mapcar (lambda (x)
18526 (cons (file-truename x) x))
18527 (org-agenda-files t)))
18528 (ctf (file-truename
18529 (or buffer-file-name
18530 (user-error "Please save the current buffer to a file"))))
18532 (setq x (assoc ctf file-alist) had x)
18534 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18536 (setq file-alist (append (delq x file-alist) (list x)))
18537 (setq file-alist (cons x (delq x file-alist))))
18538 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18539 (org-install-agenda-files-menu)
18540 (message "File %s to %s of agenda file list"
18541 (if had "moved" "added") (if to-end "end" "front"))))
18543 (defun org-remove-file (&optional file)
18544 "Remove current file from the list of files in variable `org-agenda-files'.
18545 These are the files which are being checked for agenda entries.
18546 Optional argument FILE means use this file instead of the current."
18548 (let* ((org-agenda-skip-unavailable-files nil)
18549 (file (or file buffer-file-name
18550 (user-error "Current buffer does not visit a file")))
18551 (true-file (file-truename file))
18552 (afile (abbreviate-file-name file))
18553 (files (delq nil (mapcar
18555 (if (equal true-file
18558 (org-agenda-files t)))))
18559 (if (not (= (length files) (length (org-agenda-files t))))
18561 (org-store-new-agenda-file-list files)
18562 (org-install-agenda-files-menu)
18563 (message "Removed from Org Agenda list: %s" afile))
18564 (message "File was not in list: %s (not removed)" afile))))
18566 (defun org-file-menu-entry (file)
18567 (vector file (list 'find-file file) t))
18569 (defun org-check-agenda-file (file)
18570 "Make sure FILE exists. If not, ask user what to do."
18571 (when (not (file-exists-p file))
18572 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18573 (abbreviate-file-name file))
18574 (let ((r (downcase (read-char-exclusive))))
18577 (org-remove-file file)
18578 (throw 'nextfile t))
18579 (t (user-error "Abort"))))))
18581 (defun org-get-agenda-file-buffer (file)
18582 "Get an agenda buffer visiting FILE.
18583 If the buffer needs to be created, add it to the list of buffers
18584 which might be released later."
18585 (let ((buf (org-find-base-buffer-visiting file)))
18587 buf ; just return it
18588 ;; Make a new buffer and remember it
18589 (setq buf (find-file-noselect file))
18590 (if buf (push buf org-agenda-new-buffers))
18593 (defun org-release-buffers (blist)
18594 "Release all buffers in list, asking the user for confirmation when needed.
18595 When a buffer is unmodified, it is just killed. When modified, it is saved
18596 \(if the user agrees) and then killed."
18598 (while (setq buf (pop blist))
18599 (setq file (buffer-file-name buf))
18600 (when (and (buffer-modified-p buf)
18602 (y-or-n-p (format "Save file %s? " file)))
18603 (with-current-buffer buf (save-buffer)))
18604 (kill-buffer buf))))
18606 (defun org-agenda-prepare-buffers (files)
18607 "Create buffers for all agenda files, protect archived trees and comments."
18609 (let ((pa '(:org-archived t))
18610 (pc '(:org-comment t))
18611 (pall '(:org-archived t :org-comment t))
18612 (inhibit-read-only t)
18613 (org-inhibit-startup org-agenda-inhibit-startup)
18614 (rea (concat ":" org-archive-tag ":"))
18616 (setq org-tag-alist-for-agenda nil
18617 org-tag-groups-alist-for-agenda nil)
18620 (while (setq file (pop files))
18624 (org-check-agenda-file file)
18625 (set-buffer (org-get-agenda-file-buffer file)))
18627 (org-set-regexps-and-options 'tags-only)
18629 (or (memq 'category org-agenda-ignore-properties)
18630 (org-refresh-category-properties))
18631 (or (memq 'stats org-agenda-ignore-properties)
18632 (org-refresh-stats-properties))
18633 (or (memq 'effort org-agenda-ignore-properties)
18634 (org-refresh-effort-properties))
18635 (or (memq 'appt org-agenda-ignore-properties)
18636 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18637 (setq org-todo-keywords-for-agenda
18638 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18639 (setq org-done-keywords-for-agenda
18640 (append org-done-keywords-for-agenda org-done-keywords))
18641 (setq org-todo-keyword-alist-for-agenda
18642 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18643 (setq org-tag-alist-for-agenda
18645 (append org-tag-alist-for-agenda
18647 org-tag-persistent-alist)))
18649 (setq org-tag-groups-alist-for-agenda
18650 (org-uniquify-alist
18651 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18652 (org-with-silent-modifications
18654 (remove-text-properties (point-min) (point-max) pall)
18655 (when org-agenda-skip-archived-trees
18656 (goto-char (point-min))
18657 (while (re-search-forward rea nil t)
18658 (if (org-at-heading-p t)
18659 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18660 (goto-char (point-min))
18661 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18662 (while (re-search-forward re nil t)
18663 (when (save-match-data (org-in-commented-heading-p t))
18664 (add-text-properties
18665 (match-beginning 0) (org-end-of-subtree t) pc)))))
18666 (goto-char pos)))))
18667 (setq org-todo-keywords-for-agenda
18668 (org-uniquify org-todo-keywords-for-agenda))
18669 (setq org-todo-keyword-alist-for-agenda
18670 (org-uniquify org-todo-keyword-alist-for-agenda))))
18673 ;;;; CDLaTeX minor mode
18675 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18676 "Keymap for the minor `org-cdlatex-mode'.")
18678 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18679 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18680 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18681 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18682 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18684 (defvar org-cdlatex-texmathp-advice-is-done nil
18685 "Flag remembering if we have applied the advice to texmathp already.")
18687 (define-minor-mode org-cdlatex-mode
18688 "Toggle the minor `org-cdlatex-mode'.
18689 This mode supports entering LaTeX environment and math in LaTeX fragments
18691 \\{org-cdlatex-mode-map}"
18693 (when org-cdlatex-mode
18695 (run-hooks 'cdlatex-mode-hook)
18696 (cdlatex-compute-tables))
18697 (unless org-cdlatex-texmathp-advice-is-done
18698 (setq org-cdlatex-texmathp-advice-is-done t)
18699 (defadvice texmathp (around org-math-always-on activate)
18700 "Always return t in org-mode buffers.
18701 This is because we want to insert math symbols without dollars even outside
18702 the LaTeX math segments. If Orgmode thinks that point is actually inside
18703 an embedded LaTeX fragment, let texmathp do its job.
18704 \\[org-cdlatex-mode-map]"
18708 ((not (derived-mode-p 'org-mode)) ad-do-it)
18709 ((eq this-command 'cdlatex-math-symbol)
18710 (setq ad-return-value t
18711 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18713 (let ((p (org-inside-LaTeX-fragment-p)))
18714 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18715 (setq ad-return-value t
18716 texmathp-why '("Org-mode embedded math" . 0))
18717 (if p ad-do-it)))))))))
18719 (defun turn-on-org-cdlatex ()
18720 "Unconditionally turn on `org-cdlatex-mode'."
18721 (org-cdlatex-mode 1))
18723 (defun org-try-cdlatex-tab ()
18724 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18725 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18726 - inside a LaTeX fragment, or
18727 - after the first word in a line, where an abbreviation expansion could
18728 insert a LaTeX environment."
18729 (when org-cdlatex-mode
18731 ;; Before any word on the line: No expansion possible.
18732 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18733 ;; Just after first word on the line: Expand it. Make sure it
18734 ;; cannot happen on headlines, though.
18736 (skip-chars-backward "a-zA-Z0-9*")
18737 (skip-chars-backward " \t")
18738 (and (bolp) (not (org-at-heading-p))))
18740 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18742 (defun org-cdlatex-underscore-caret (&optional arg)
18743 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18744 Revert to the normal definition outside of these fragments."
18746 (if (org-inside-LaTeX-fragment-p)
18747 (call-interactively 'cdlatex-sub-superscript)
18748 (let (org-cdlatex-mode)
18749 (call-interactively (key-binding (vector last-input-event))))))
18751 (defun org-cdlatex-math-modify (&optional arg)
18752 "Execute `cdlatex-math-modify' in LaTeX fragments.
18753 Revert to the normal definition outside of these fragments."
18755 (if (org-inside-LaTeX-fragment-p)
18756 (call-interactively 'cdlatex-math-modify)
18757 (let (org-cdlatex-mode)
18758 (call-interactively (key-binding (vector last-input-event))))))
18760 (defun org-cdlatex-environment-indent (&optional environment item)
18761 "Execute `cdlatex-environment' and indent the inserted environment.
18763 ENVIRONMENT and ITEM are passed to `cdlatex-environment'.
18765 The inserted environment is indented to current indentation
18766 unless point is at the beginning of the line, in which the
18767 environment remains unintended."
18769 ;; cdlatex-environment always return nil. Therefore, capture output
18770 ;; first and determine if an environment was selected.
18771 (let* ((beg (point-marker))
18772 (end (copy-marker (point) t))
18774 (ignore-errors (cdlatex-environment environment item))
18776 ;; Figure out how many lines to move forward after the
18777 ;; environment has been inserted.
18778 (lines (when inserted
18780 (- (loop while (< beg (point))
18782 do (forward-line -1)
18785 (if (progn (goto-char beg)
18786 (and (progn (skip-chars-forward " \t") (eolp))
18787 (progn (skip-chars-backward " \t") (bolp))))
18789 (env (org-trim (delete-and-extract-region beg end))))
18791 ;; Get indentation of next line unless at column 0.
18792 (let ((ind (if (bolp) 0
18794 (org-return-indent)
18795 (prog1 (org-get-indentation)
18796 (when (progn (skip-chars-forward " \t") (eolp))
18797 (delete-region beg (point)))))))
18798 (bol (progn (skip-chars-backward " \t") (bolp))))
18799 ;; Insert a newline before environment unless at column zero
18800 ;; to "escape" the current line. Insert a newline if
18801 ;; something is one the same line as \end{ENVIRONMENT}.
18803 (concat (unless bol "\n") env
18804 (when (and (skip-chars-forward " \t") (not (eolp))) "\n")))
18805 (unless (zerop ind)
18808 (while (< (point) end)
18809 (unless (eolp) (org-indent-line-to ind))
18812 (forward-line lines)
18813 (org-indent-line-to ind)))
18814 (set-marker beg nil)
18815 (set-marker end nil)))
18818 ;;;; LaTeX fragments
18820 (defun org-inside-LaTeX-fragment-p ()
18821 "Test if point is inside a LaTeX fragment.
18822 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18823 sequence appearing also before point.
18824 Even though the matchers for math are configurable, this function assumes
18825 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18826 delimiters are skipped when they have been removed by customization.
18827 The return value is nil, or a cons cell with the delimiter and the
18828 position of this delimiter.
18830 This function does a reasonably good job, but can locally be fooled by
18831 for example currency specifications. For example it will assume being in
18832 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18833 fragments that are properly closed, but during editing, we have to live
18834 with the uncertainty caused by missing closing delimiters. This function
18835 looks only before point, not after."
18837 (let ((pos (point))
18838 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18840 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18842 dd-on str (start 0) m re)
18845 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18846 re (nth 1 (assoc "$" org-latex-regexps)))
18847 (while (string-match re str start)
18849 ((= (match-end 0) (length str))
18850 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18851 ((= (match-end 0) (- (length str) 5))
18853 (t (setq start (match-end 0))))))
18854 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18856 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18857 (and (match-beginning 2) (throw 'exit nil))
18859 (while (re-search-backward "\\$\\$" lim t)
18860 (setq dd-on (not dd-on)))
18862 (if dd-on (cons "$$" m))))))
18864 (defun org-inside-latex-macro-p ()
18865 "Is point inside a LaTeX macro or its arguments?"
18868 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18870 (defvar org-latex-fragment-image-overlays nil
18871 "List of overlays carrying the images of latex fragments.")
18872 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18874 (defun org-remove-latex-fragment-image-overlays (&optional beg end)
18875 "Remove all overlays with LaTeX fragment images in current buffer.
18876 When optional arguments BEG and END are non-nil, remove all
18877 overlays between them instead. Return t when some overlays were
18878 removed, nil otherwise."
18880 (setq org-latex-fragment-image-overlays
18881 (let ((beg (or beg (point-min)))
18882 (end (or end (point-max))))
18885 (and (>= (overlay-start o) beg)
18886 (<= (overlay-end o) end)
18887 (progn (delete-overlay o)
18888 (or removedp (setq removedp t)))))
18889 org-latex-fragment-image-overlays)))
18892 (define-obsolete-function-alias
18893 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18894 (defun org-toggle-latex-fragment (&optional arg)
18895 "Preview the LaTeX fragment at point, or all locally or globally.
18897 If the cursor is on a LaTeX fragment, create the image and overlay
18898 it over the source code, if there is none. Remove it otherwise.
18899 If there is no fragment at point, display all fragments in the
18902 With prefix ARG, preview or clear image for all fragments in the
18903 current subtree or in the whole buffer when used before the first
18904 headline. With a double prefix ARG \\[universal-argument] \
18905 \\[universal-argument] preview or clear images
18906 for all fragments in the buffer."
18908 (unless (buffer-file-name (buffer-base-buffer))
18909 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18910 (when (display-graphic-p)
18913 (let ((window-start (window-start)) msg)
18916 ((or (equal arg '(16))
18917 (and (equal arg '(4))
18918 (org-with-limited-levels (org-before-first-heading-p))))
18919 (if (org-remove-latex-fragment-image-overlays)
18920 (progn (message "LaTeX fragments images removed from buffer")
18922 (setq msg "Creating images for buffer...")))
18924 (org-with-limited-levels (org-back-to-heading t))
18925 (let ((beg (point))
18926 (end (progn (org-end-of-subtree t) (point))))
18927 (if (org-remove-latex-fragment-image-overlays beg end)
18929 (message "LaTeX fragment images removed from subtree")
18931 (setq msg "Creating images for subtree...")
18932 (narrow-to-region beg end))))
18933 ((let ((datum (org-element-context)))
18934 (when (memq (org-element-type datum)
18935 '(latex-environment latex-fragment))
18936 (let* ((beg (org-element-property :begin datum))
18937 (end (org-element-property :end datum)))
18938 (if (org-remove-latex-fragment-image-overlays beg end)
18939 (progn (message "LaTeX fragment image removed")
18941 (narrow-to-region beg end)
18942 (setq msg "Creating image..."))))))
18944 (org-with-limited-levels
18945 (let ((beg (if (org-at-heading-p) (line-beginning-position)
18946 (outline-previous-heading)
18948 (end (progn (outline-next-heading) (point))))
18949 (if (org-remove-latex-fragment-image-overlays beg end)
18951 (message "LaTeX fragment images removed from section")
18953 (setq msg "Creating images for section...")
18954 (narrow-to-region beg end))))))
18955 (let ((file (buffer-file-name (buffer-base-buffer))))
18957 (concat org-latex-preview-ltxpng-directory
18958 (file-name-sans-extension (file-name-nondirectory file)))
18959 ;; Emacs cannot overlay images from remote hosts.
18960 ;; Create it in `temporary-file-directory' instead.
18961 (if (file-remote-p file) temporary-file-directory
18963 'overlays msg 'forbuffer
18964 org-latex-create-formula-image-program)))
18965 ;; Work around a bug that doesn't restore window's start
18966 ;; when widening back the buffer.
18967 (set-window-start nil window-start)
18968 (message (concat msg "done")))))))
18970 (defun org-format-latex
18971 (prefix &optional dir overlays msg forbuffer processing-type)
18972 "Replace LaTeX fragments with links to an image, and produce images.
18974 When optional argument OVERLAYS is non-nil, display the image on
18975 top of the fragment instead of replacing it.
18977 PROCESSING-TYPE is the conversion method to use, as a symbol.
18979 Some of the options can be changed using the variable
18980 `org-format-latex-options', which see."
18981 (when (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18982 (unless (eq processing-type 'verbatim)
18983 (let* ((math-regexp "\\$\\|\\\\[([]\\|^[ \t]*\\\\begin{[A-Za-z0-9*]+}")
18986 (goto-char (point-min))
18987 ;; Optimize overlay creation: (info "(elisp) Managing Overlays").
18988 (when (and overlays (memq processing-type '(dvipng imagemagick)))
18989 (overlay-recenter (point-max)))
18990 (while (re-search-forward math-regexp nil t)
18991 (unless (and overlays
18992 (eq (get-char-property (point) 'org-overlay-type)
18993 'org-latex-overlay))
18994 (let* ((context (org-element-context))
18995 (type (org-element-type context)))
18996 (when (memq type '(latex-environment latex-fragment))
18997 (let ((block-type (eq type 'latex-environment))
18998 (value (org-element-property :value context))
18999 (beg (org-element-property :begin context))
19000 (end (save-excursion
19001 (goto-char (org-element-property :end context))
19002 (skip-chars-backward " \r\t\n")
19004 (case processing-type
19006 ;; Prepare for MathJax processing.
19007 (if (eq (char-after beg) ?$)
19009 (delete-region beg end)
19010 (insert "\\(" (substring value 1 -1) "\\)"))
19012 ((dvipng imagemagick)
19013 ;; Process to an image.
19016 (let* ((face (face-at-point))
19017 ;; Get the colors from the face at point.
19019 (let ((color (plist-get org-format-latex-options
19021 (if (and forbuffer (eq color 'auto))
19022 (face-attribute face :foreground nil 'default)
19025 (let ((color (plist-get org-format-latex-options
19027 (if (and forbuffer (eq color 'auto))
19028 (face-attribute face :background nil 'default)
19030 (hash (sha1 (prin1-to-string
19031 (list org-format-latex-header
19032 org-latex-default-packages-alist
19033 org-latex-packages-alist
19034 org-format-latex-options
19035 forbuffer value fg bg))))
19036 (absprefix (expand-file-name prefix dir))
19037 (linkfile (format "%s_%s.png" prefix hash))
19038 (movefile (format "%s_%s.png" absprefix hash))
19039 (sep (and block-type "\n\n"))
19040 (link (concat sep "[[file:" linkfile "]]" sep))
19042 (org-combine-plists
19043 org-format-latex-options
19044 `(:foreground ,fg :background ,bg))))
19045 (when msg (message msg cnt))
19046 (unless checkdir-flag ; Ensure the directory exists.
19047 (setq checkdir-flag t)
19048 (let ((todir (file-name-directory absprefix)))
19049 (unless (file-directory-p todir)
19050 (make-directory todir t))))
19051 (unless (file-exists-p movefile)
19052 (org-create-formula-image
19053 value movefile options forbuffer processing-type))
19056 (dolist (o (overlays-in beg end))
19057 (when (eq (overlay-get o 'org-overlay-type)
19058 'org-latex-overlay)
19059 (delete-overlay o)))
19060 (let ((ov (make-overlay beg end)))
19063 'org-latex-overlay)
19064 (overlay-put ov 'evaporate t)
19065 (if (featurep 'xemacs)
19067 (overlay-put ov 'invisible t)
19071 (vector 'png :file movefile))))
19078 (push ov org-latex-fragment-image-overlays))
19080 (delete-region beg end)
19082 (org-add-props link
19083 (list 'org-latex-src
19084 (replace-regexp-in-string "\"" "" value)
19085 'org-latex-src-embed-type
19086 (if block-type 'paragraph 'character)))))))
19088 ;; Process to MathML.
19089 (unless (org-format-latex-mathml-available-p)
19090 (user-error "LaTeX to MathML converter not configured"))
19092 (when msg (message msg cnt))
19094 (delete-region beg end)
19095 (insert (org-format-latex-as-mathml
19096 value block-type prefix dir)))
19098 (error "Unknown conversion type %s for LaTeX fragments"
19099 processing-type)))))))))))
19101 (defun org-create-math-formula (latex-frag &optional mathml-file)
19102 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
19103 Use `org-latex-to-mathml-convert-command'. If the conversion is
19104 sucessful, return the portion between \"<math...> </math>\"
19105 elements otherwise return nil. When MATHML-FILE is specified,
19106 write the results in to that file. When invoked as an
19107 interactive command, prompt for LATEX-FRAG, with initial value
19108 set to the current active region and echo the results for user
19110 (interactive (list (let ((frag (when (org-region-active-p)
19111 (buffer-substring-no-properties
19112 (region-beginning) (region-end)))))
19113 (read-string "LaTeX Fragment: " frag nil frag))))
19114 (unless latex-frag (user-error "Invalid LaTeX fragment"))
19115 (let* ((tmp-in-file (file-relative-name
19116 (make-temp-name (expand-file-name "ltxmathml-in"))))
19117 (ignore (write-region latex-frag nil tmp-in-file))
19118 (tmp-out-file (file-relative-name
19119 (make-temp-name (expand-file-name "ltxmathml-out"))))
19121 org-latex-to-mathml-convert-command
19122 `((?j . ,(and org-latex-to-mathml-jar-file
19123 (shell-quote-argument
19125 org-latex-to-mathml-jar-file))))
19126 (?I . ,(shell-quote-argument tmp-in-file))
19128 (?o . ,(shell-quote-argument tmp-out-file)))))
19129 mathml shell-command-output)
19130 (when (org-called-interactively-p 'any)
19131 (unless (org-format-latex-mathml-available-p)
19132 (user-error "LaTeX to MathML converter not configured")))
19133 (message "Running %s" cmd)
19134 (setq shell-command-output (shell-command-to-string cmd))
19136 (when (file-readable-p tmp-out-file)
19137 (with-current-buffer (find-file-noselect tmp-out-file t)
19138 (goto-char (point-min))
19139 (when (re-search-forward
19142 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\"")
19147 (prog1 (match-string 0) (kill-buffer))))))
19151 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
19153 (write-region mathml nil mathml-file))
19154 (when (org-called-interactively-p 'any)
19156 ((message "LaTeX to MathML conversion failed")
19157 (message shell-command-output)))
19158 (delete-file tmp-in-file)
19159 (when (file-exists-p tmp-out-file)
19160 (delete-file tmp-out-file))
19163 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
19164 prefix &optional dir)
19165 "Use `org-create-math-formula' but check local cache first."
19166 (let* ((absprefix (expand-file-name prefix dir))
19167 (print-length nil) (print-level nil)
19168 (formula-id (concat
19173 org-latex-to-mathml-convert-command)))))
19174 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
19175 (formula-cache-dir (file-name-directory formula-cache)))
19177 (unless (file-directory-p formula-cache-dir)
19178 (make-directory formula-cache-dir t))
19180 (unless (file-exists-p formula-cache)
19181 (org-create-math-formula latex-frag formula-cache))
19183 (if (file-exists-p formula-cache)
19184 ;; Successful conversion. Return the link to MathML file.
19186 (format "[[file:%s]]" (file-relative-name formula-cache dir))
19187 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
19188 'org-latex-src-embed-type (if latex-frag-type
19189 'paragraph 'character)))
19190 ;; Failed conversion. Return the LaTeX fragment verbatim
19193 (defun org-create-formula-image (string tofile options buffer &optional type)
19194 "Create an image from LaTeX source using dvipng or convert.
19195 This function calls either `org-create-formula-image-with-dvipng'
19196 or `org-create-formula-image-with-imagemagick' depending on the
19197 value of `org-latex-create-formula-image-program' or on the value
19198 of the optional TYPE variable.
19200 Note: ultimately these two function should be combined as they
19201 share a good deal of logic."
19202 (org-check-external-command
19203 "latex" "needed to convert LaTeX fragments to images")
19205 (case (or type org-latex-create-formula-image-program)
19207 (org-check-external-command
19208 "dvipng" "needed to convert LaTeX fragments to images")
19209 'org-create-formula-image-with-dvipng)
19211 (org-check-external-command
19212 "convert" "you need to install imagemagick")
19213 'org-create-formula-image-with-imagemagick)
19215 "Invalid value of `org-latex-create-formula-image-program'")))
19216 string tofile options buffer))
19218 (declare-function org-export-get-backend "ox" (name))
19219 (declare-function org-export--get-global-options "ox" (&optional backend))
19220 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
19221 (declare-function org-latex-guess-inputenc "ox-latex" (header))
19222 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
19223 (defun org-create-formula--latex-header ()
19224 "Return LaTeX header appropriate for previewing a LaTeX snippet."
19225 (let ((info (org-combine-plists (org-export--get-global-options
19226 (org-export-get-backend 'latex))
19227 (org-export--get-inbuffer-options
19228 (org-export-get-backend 'latex)))))
19229 (org-latex-guess-babel-language
19230 (org-latex-guess-inputenc
19231 (org-splice-latex-header
19232 org-format-latex-header
19233 org-latex-default-packages-alist
19234 org-latex-packages-alist t
19235 (plist-get info :latex-header)))
19238 (defun org--get-display-dpi ()
19239 "Get the DPI of the display.
19241 Assumes that the display has the same pixel width in the
19242 horizontal and vertical directions."
19243 (if (display-graphic-p)
19244 (round (/ (display-pixel-height)
19245 (/ (display-mm-height) 25.4)))
19246 (error "Attempt to calculate the dpi of a non-graphic display")))
19248 ;; This function borrows from Ganesh Swami's latex2png.el
19249 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
19250 "This calls dvipng."
19251 (require 'ox-latex)
19252 (let* ((tmpdir (if (featurep 'xemacs)
19254 temporary-file-directory))
19255 (texfilebase (make-temp-name
19256 (expand-file-name "orgtex" tmpdir)))
19257 (texfile (concat texfilebase ".tex"))
19258 (dvifile (concat texfilebase ".dvi"))
19259 (pngfile (concat texfilebase ".png"))
19260 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19261 ;; This assumes that the display has the same pixel width in
19262 ;; the horizontal and vertical directions
19263 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19264 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19266 (bg (or (plist-get options (if buffer :background :html-background))
19268 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
19269 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
19270 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
19271 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
19272 (let ((latex-header (org-create-formula--latex-header)))
19273 (with-temp-file texfile
19274 (insert latex-header)
19275 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
19276 (let ((dir default-directory))
19279 (call-process "latex" nil nil nil texfile))
19281 (if (not (file-exists-p dvifile))
19282 (progn (message "Failed to create dvi file from %s" texfile) nil)
19284 (if (featurep 'xemacs)
19285 (call-process "dvipng" nil nil nil
19290 (call-process "dvipng" nil nil nil
19293 ;;"-x" scale "-y" scale
19297 (if (not (file-exists-p pngfile))
19298 (if org-format-latex-signal-error
19299 (error "Failed to create png file from %s" texfile)
19300 (message "Failed to create png file from %s" texfile)
19302 ;; Use the requested file name and clean up
19303 (copy-file pngfile tofile 'replace)
19304 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
19305 (if (file-exists-p (concat texfilebase e))
19306 (delete-file (concat texfilebase e))))
19309 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
19310 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
19311 "This calls convert, which is included into imagemagick."
19312 (require 'ox-latex)
19313 (let* ((tmpdir (if (featurep 'xemacs)
19315 temporary-file-directory))
19316 (texfilebase (make-temp-name
19317 (expand-file-name "orgtex" tmpdir)))
19318 (texfile (concat texfilebase ".tex"))
19319 (pdffile (concat texfilebase ".pdf"))
19320 (pngfile (concat texfilebase ".png"))
19321 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
19322 (dpi (number-to-string (* scale (if buffer (org--get-display-dpi) 120))))
19323 (fg (or (plist-get options (if buffer :foreground :html-foreground))
19325 (bg (or (plist-get options (if buffer :background :html-background))
19327 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
19328 (setq fg (org-latex-color-format fg)))
19329 (if (eq bg 'default) (setq bg (org-latex-color :background))
19330 (setq bg (org-latex-color-format
19331 (if (string= bg "Transparent") "white" bg))))
19332 (let ((latex-header (org-create-formula--latex-header)))
19333 (with-temp-file texfile
19334 (insert latex-header)
19335 (insert "\n\\begin{document}\n"
19336 "\\definecolor{fg}{rgb}{" fg "}\n"
19337 "\\definecolor{bg}{rgb}{" bg "}\n"
19338 "\n\\pagecolor{bg}\n"
19342 "\n\\end{document}\n")))
19343 (org-latex-compile texfile t)
19344 (if (not (file-exists-p pdffile))
19345 (progn (message "Failed to create pdf file from %s" texfile) nil)
19347 (if (featurep 'xemacs)
19348 (call-process "convert" nil nil nil
19354 ;; "-sharpen" "0x1.0"
19356 (call-process "convert" nil nil nil
19362 ;; "-sharpen" "0x1.0"
19364 (if (not (file-exists-p pngfile))
19365 (if org-format-latex-signal-error
19366 (error "Failed to create png file from %s" texfile)
19367 (message "Failed to create png file from %s" texfile)
19369 ;; Use the requested file name and clean up
19370 (copy-file pngfile tofile 'replace)
19371 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19372 (if (file-exists-p (concat texfilebase e))
19373 (delete-file (concat texfilebase e))))
19376 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19377 "Fill a LaTeX header template TPL.
19378 In the template, the following place holders will be recognized:
19380 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19381 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19382 [PACKAGES] \\usepackage statements for PKG
19383 [NO-PACKAGES] do not include PKG
19384 [EXTRA] the string EXTRA
19385 [NO-EXTRA] do not include EXTRA
19387 For backward compatibility, if both the positive and the negative place
19388 holder is missing, the positive one (without the \"NO-\") will be
19389 assumed to be present at the end of the template.
19390 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19392 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19393 (let (rpl (end ""))
19394 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19395 (setq rpl (if (or (match-end 1) (not def-pkg))
19396 "" (org-latex-packages-to-string def-pkg snippets-p t))
19397 tpl (replace-match rpl t t tpl))
19398 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19400 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19401 (setq rpl (if (or (match-end 1) (not pkg))
19402 "" (org-latex-packages-to-string pkg snippets-p t))
19403 tpl (replace-match rpl t t tpl))
19406 (org-latex-packages-to-string pkg snippets-p)))))
19408 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19409 (setq rpl (if (or (match-end 1) (not extra))
19410 "" (concat extra "\n"))
19411 tpl (replace-match rpl t t tpl))
19412 (if (and extra (string-match "\\S-" extra))
19413 (setq end (concat end "\n" extra))))
19415 (if (string-match "\\S-" end)
19416 (concat tpl "\n" end)
19419 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19420 "Turn an alist of packages into a string with the \\usepackage macros."
19421 (setq pkg (mapconcat (lambda(p)
19424 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19425 (format "%% Package %s omitted" (cadr p)))
19426 ((equal "" (car p))
19427 (format "\\usepackage{%s}" (cadr p)))
19429 (format "\\usepackage[%s]{%s}"
19430 (car p) (cadr p)))))
19433 (if newline (concat pkg "\n") pkg))
19435 (defun org-dvipng-color (attr)
19436 "Return a RGB color specification for dvipng."
19437 (apply 'format "rgb %s %s %s"
19438 (mapcar 'org-normalize-color
19439 (if (featurep 'xemacs)
19440 (color-rgb-components
19441 (face-property 'default
19442 (cond ((eq attr :foreground) 'foreground)
19443 ((eq attr :background) 'background))))
19444 (color-values (face-attribute 'default attr nil))))))
19446 (defun org-dvipng-color-format (color-name)
19447 "Convert COLOR-NAME to a RGB color value for dvipng."
19448 (apply 'format "rgb %s %s %s"
19449 (mapcar 'org-normalize-color
19450 (color-values color-name))))
19452 (defun org-latex-color (attr)
19453 "Return a RGB color for the LaTeX color package."
19454 (apply 'format "%s,%s,%s"
19455 (mapcar 'org-normalize-color
19456 (if (featurep 'xemacs)
19457 (color-rgb-components
19458 (face-property 'default
19459 (cond ((eq attr :foreground) 'foreground)
19460 ((eq attr :background) 'background))))
19461 (color-values (face-attribute 'default attr nil))))))
19463 (defun org-latex-color-format (color-name)
19464 "Convert COLOR-NAME to a RGB color value."
19465 (apply 'format "%s,%s,%s"
19466 (mapcar 'org-normalize-color
19467 (color-values color-name))))
19469 (defun org-normalize-color (value)
19470 "Return string to be used as color value for an RGB component."
19471 (format "%g" (/ value 65535.0)))
19477 (defvar org-inline-image-overlays nil)
19478 (make-variable-buffer-local 'org-inline-image-overlays)
19480 (defun org-toggle-inline-images (&optional include-linked)
19481 "Toggle the display of inline images.
19482 INCLUDE-LINKED is passed to `org-display-inline-images'."
19484 (if org-inline-image-overlays
19486 (org-remove-inline-images)
19487 (when (org-called-interactively-p 'interactive)
19488 (message "Inline image display turned off")))
19489 (org-display-inline-images include-linked)
19490 (when (org-called-interactively-p 'interactive)
19491 (message (if org-inline-image-overlays
19492 (format "%d images displayed inline"
19493 (length org-inline-image-overlays))
19494 "No images to display inline")))))
19496 (defun org-redisplay-inline-images ()
19497 "Refresh the display of inline images."
19499 (if (not org-inline-image-overlays)
19500 (org-toggle-inline-images)
19501 (org-toggle-inline-images)
19502 (org-toggle-inline-images)))
19504 (defun org-display-inline-images (&optional include-linked refresh beg end)
19505 "Display inline images.
19507 An inline image is a link which follows either of these
19510 1. Its path is a file with an extension matching return value
19511 from `image-file-name-regexp' and it has no contents.
19513 2. Its description consists in a single link of the previous
19516 When optional argument INCLUDE-LINKED is non-nil, also links with
19517 a text description part will be inlined. This can be nice for
19518 a quick look at those images, but it does not reflect what
19519 exported files will look like.
19521 When optional argument REFRESH is non-nil, refresh existing
19522 images between BEG and END. This will create new image displays
19523 only if necessary. BEG and END default to the buffer
19526 (when (display-graphic-p)
19528 (org-remove-inline-images)
19529 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19530 (org-with-wide-buffer
19531 (goto-char (or beg (point-min)))
19532 (let ((case-fold-search t)
19533 (file-extension-re (org-image-file-name-regexp)))
19534 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19535 (let ((link (save-match-data (org-element-context))))
19536 ;; Check if we're at an inline image.
19537 (when (and (equal (org-element-property :type link) "file")
19539 (not (org-element-property :contents-begin link)))
19540 (let ((parent (org-element-property :parent link)))
19541 (or (not (eq (org-element-type parent) 'link))
19542 (not (cdr (org-element-contents parent)))))
19543 (org-string-match-p file-extension-re
19544 (org-element-property :path link)))
19545 (let ((file (expand-file-name (org-element-property :path link))))
19546 (when (file-exists-p file)
19548 ;; Apply `org-image-actual-width' specifications.
19550 ((not (image-type-available-p 'imagemagick)) nil)
19551 ((eq org-image-actual-width t) nil)
19552 ((listp org-image-actual-width)
19554 ;; First try to find a width among
19555 ;; attributes associated to the paragraph
19556 ;; containing link.
19559 (while (and (setq e (org-element-property
19561 (not (eq (org-element-type e)
19566 (goto-char (org-element-property :begin paragraph))
19569 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19570 (org-element-property
19571 :post-affiliated paragraph)
19573 (string-to-number (match-string 1))))))
19574 ;; Otherwise, fall-back to provided number.
19575 (car org-image-actual-width)))
19576 ((numberp org-image-actual-width)
19577 org-image-actual-width)))
19578 (old (get-char-property-and-overlay
19579 (org-element-property :begin link)
19580 'org-image-overlay)))
19581 (if (and (car-safe old) refresh)
19582 (image-refresh (overlay-get (cdr old) 'display))
19583 (let ((image (create-image file
19584 (and width 'imagemagick)
19589 ;; If inline image is the description
19590 ;; of another link, be sure to
19591 ;; consider the latter as the one to
19592 ;; apply the overlay on.
19594 (org-element-property :parent link)))
19595 (if (eq (org-element-type parent) 'link)
19599 (org-element-property :begin link)
19602 (org-element-property :end link))
19603 (skip-chars-backward " \t")
19605 (overlay-put ov 'display image)
19606 (overlay-put ov 'face 'default)
19607 (overlay-put ov 'org-image-overlay t)
19609 ov 'modification-hooks
19610 (list 'org-display-inline-remove-overlay))
19611 (push ov org-inline-image-overlays)))))))))))))))
19613 (define-obsolete-function-alias
19614 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19616 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19617 "Remove inline-display overlay if a corresponding region is modified."
19618 (let ((inhibit-modification-hooks t))
19619 (when (and ov after)
19620 (delete ov org-inline-image-overlays)
19621 (delete-overlay ov))))
19623 (defun org-remove-inline-images ()
19624 "Remove inline display of images."
19626 (mapc 'delete-overlay org-inline-image-overlays)
19627 (setq org-inline-image-overlays nil))
19631 ;; Outline functions from `outline-mode-prefix-map'
19632 ;; that can be remapped in Org:
19633 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19634 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19635 (define-key org-mode-map [remap outline-forward-same-level]
19636 'org-forward-heading-same-level)
19637 (define-key org-mode-map [remap outline-backward-same-level]
19638 'org-backward-heading-same-level)
19639 (define-key org-mode-map [remap show-branches]
19640 'org-kill-note-or-show-branches)
19641 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19642 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19643 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19644 (define-key org-mode-map [remap outline-next-visible-heading]
19645 'org-next-visible-heading)
19646 (define-key org-mode-map [remap outline-previous-visible-heading]
19647 'org-previous-visible-heading)
19649 ;; Outline functions from `outline-mode-prefix-map' that can not
19650 ;; be remapped in Org:
19652 ;; - the column "key binding" shows whether the Outline function is still
19653 ;; available in Org mode on the same key that it has been bound to in
19655 ;; - "overridden": key used for a different functionality in Org mode
19656 ;; - else: key still bound to the same Outline function in Org mode
19658 ;; | Outline function | key binding | Org replacement |
19659 ;; |------------------------------------+-------------+--------------------------|
19660 ;; | `outline-next-visible-heading' | `C-c C-n' | better: skip inlinetasks |
19661 ;; | `outline-previous-visible-heading' | `C-c C-p' | better: skip inlinetasks |
19662 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19663 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19664 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19665 ;; | `show-entry' | overridden | no replacement |
19666 ;; | `show-children' | `C-c C-i' | visibility cycling |
19667 ;; | `show-branches' | `C-c C-k' | still same function |
19668 ;; | `show-subtree' | overridden | visibility cycling |
19669 ;; | `show-all' | overridden | no replacement |
19670 ;; | `hide-subtree' | overridden | visibility cycling |
19671 ;; | `hide-body' | overridden | no replacement |
19672 ;; | `hide-entry' | overridden | visibility cycling |
19673 ;; | `hide-leaves' | overridden | no replacement |
19674 ;; | `hide-sublevels' | overridden | no replacement |
19675 ;; | `hide-other' | overridden | no replacement |
19677 ;; Make `C-c C-x' a prefix key
19678 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19680 ;; TAB key with modifiers
19681 (org-defkey org-mode-map "\C-i" 'org-cycle)
19682 (org-defkey org-mode-map [(tab)] 'org-cycle)
19683 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19684 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19685 ;; The following line is necessary under Suse GNU/Linux
19686 (unless (featurep 'xemacs)
19687 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19688 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19689 (define-key org-mode-map [backtab] 'org-shifttab)
19691 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19692 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19693 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19695 ;; Cursor keys with modifiers
19696 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19697 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19698 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19699 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19701 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19702 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19703 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19704 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19705 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19706 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19708 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19709 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19710 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19711 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19713 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19714 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19715 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19716 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19719 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19720 (mapc (lambda (pair)
19721 (define-key org-babel-map (car pair) (cdr pair)))
19722 org-babel-key-bindings)
19724 ;;; Extra keys for tty access.
19725 ;; We only set them when really needed because otherwise the
19726 ;; menus don't show the simple keys
19728 (when (or org-use-extra-keys
19729 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19730 (not window-system))
19731 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19732 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19733 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19734 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19735 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19736 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19737 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19738 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19739 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19740 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19741 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19742 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19743 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19744 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19745 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19746 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19747 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19748 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19749 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19750 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19751 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19752 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19753 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19754 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19755 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19756 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19757 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19758 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19760 ;; All the other keys
19762 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19763 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19764 (if (boundp 'narrow-map)
19765 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19766 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19767 (if (boundp 'narrow-map)
19768 (org-defkey narrow-map "b" 'org-narrow-to-block)
19769 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19770 (if (boundp 'narrow-map)
19771 (org-defkey narrow-map "e" 'org-narrow-to-element)
19772 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19773 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19774 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19775 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19776 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19777 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19778 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19779 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19780 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19781 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19782 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19783 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19784 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19785 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19786 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19787 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19788 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19789 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19790 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19791 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19792 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19793 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19794 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19795 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19796 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19797 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19798 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19799 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19800 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19801 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19802 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19803 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19804 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19805 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19806 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19807 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19808 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19809 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19810 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19811 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19812 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19813 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19814 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19815 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19816 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19817 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19818 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19819 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19820 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19821 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19822 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19823 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19824 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19825 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19826 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19827 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19828 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19829 (org-defkey org-mode-map "\C-c^" 'org-sort)
19830 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19831 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19832 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19833 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19834 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19835 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19836 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19837 (org-defkey org-mode-map "\C-m" 'org-return)
19838 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19839 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19840 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19841 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19842 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19843 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19844 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19845 (org-defkey org-mode-map "\C-c\"a" 'orgtbl-ascii-plot)
19846 (org-defkey org-mode-map "\C-c\"g" 'org-plot/gnuplot)
19847 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19848 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19849 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19850 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19851 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19852 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19853 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19854 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19855 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19856 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19857 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19858 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19859 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19860 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19861 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19862 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19864 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19865 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19866 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19868 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19869 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19870 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19871 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19872 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19873 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19874 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19875 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19876 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19877 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19878 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19879 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19880 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19881 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19882 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19883 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19884 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19885 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19886 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19887 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19888 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19889 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19891 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19892 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19893 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19894 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19895 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19897 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19899 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19901 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19902 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19904 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19907 (when (featurep 'xemacs)
19908 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19911 (defconst org-speed-commands-default
19913 ("Outline Navigation")
19914 ("n" . (org-speed-move-safe 'org-next-visible-heading))
19915 ("p" . (org-speed-move-safe 'org-previous-visible-heading))
19916 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19917 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19918 ("F" . org-next-block)
19919 ("B" . org-previous-block)
19920 ("u" . (org-speed-move-safe 'outline-up-heading))
19922 ("g" . (org-refile t))
19923 ("Outline Visibility")
19925 ("C" . org-shifttab)
19926 (" " . org-display-outline-path)
19927 ("s" . org-narrow-to-subtree)
19928 ("=" . org-columns)
19929 ("Outline Structure Editing")
19931 ("D" . org-metadown)
19932 ("r" . org-metaright)
19933 ("l" . org-metaleft)
19934 ("R" . org-shiftmetaright)
19935 ("L" . org-shiftmetaleft)
19936 ("i" . (progn (forward-char 1) (call-interactively
19937 'org-insert-heading-respect-content)))
19940 ("a" . org-archive-subtree-default-with-confirmation)
19941 ("@" . org-mark-subtree)
19942 ("#" . org-toggle-comment)
19944 ("I" . org-clock-in)
19945 ("O" . org-clock-out)
19946 ("Meta Data Editing")
19948 ("," . (org-priority))
19949 ("0" . (org-priority ?\ ))
19950 ("1" . (org-priority ?A))
19951 ("2" . (org-priority ?B))
19952 ("3" . (org-priority ?C))
19953 (":" . org-set-tags-command)
19954 ("e" . org-set-effort)
19955 ("E" . org-inc-effort)
19956 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19957 (org-entry-put (point) "APPT_WARNTIME" m)))
19958 ("Agenda Views etc")
19960 ("/" . org-sparse-tree)
19962 ("o" . org-open-at-point)
19963 ("?" . org-speed-command-help)
19964 ("<" . (org-agenda-set-restriction-lock 'subtree))
19965 (">" . (org-agenda-remove-restriction-lock))
19967 "The default speed commands.")
19969 (defun org-print-speed-command (e)
19970 (if (> (length (car e)) 1)
19975 (princ (make-string (length (car e)) ?-))
19979 (if (symbolp (cdr e))
19980 (princ (symbol-name (cdr e)))
19984 (defun org-speed-command-help ()
19985 "Show the available speed commands."
19987 (if (not org-use-speed-commands)
19988 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19989 (with-output-to-temp-buffer "*Help*"
19990 (princ "User-defined Speed commands\n===========================\n")
19991 (mapc 'org-print-speed-command org-speed-commands-user)
19993 (princ "Built-in Speed commands\n=======================\n")
19994 (mapc 'org-print-speed-command org-speed-commands-default))
19995 (with-current-buffer "*Help*"
19996 (setq truncate-lines t))))
19998 (defun org-speed-move-safe (cmd)
19999 "Execute CMD, but make sure that the cursor always ends up in a headline.
20000 If not, return to the original position and throw an error."
20002 (let ((pos (point)))
20003 (call-interactively cmd)
20004 (unless (and (bolp) (org-at-heading-p))
20006 (error "Boundary reached while executing %s" cmd))))
20008 (defvar org-self-insert-command-undo-counter 0)
20010 (defvar org-table-auto-blank-field) ; defined in org-table.el
20011 (defvar org-speed-command nil)
20013 (define-obsolete-function-alias
20014 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
20016 (defun org-speed-command-activate (keys)
20017 "Hook for activating single-letter speed commands.
20018 `org-speed-commands-default' specifies a minimal command set.
20019 Use `org-speed-commands-user' for further customization."
20020 (when (or (and (bolp) (looking-at org-outline-regexp))
20021 (and (functionp org-use-speed-commands)
20022 (funcall org-use-speed-commands)))
20023 (cdr (assoc keys (append org-speed-commands-user
20024 org-speed-commands-default)))))
20026 (define-obsolete-function-alias
20027 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
20029 (defun org-babel-speed-command-activate (keys)
20030 "Hook for activating single-letter code block commands."
20031 (when (and (bolp) (looking-at org-babel-src-block-regexp))
20032 (cdr (assoc keys org-babel-key-bindings))))
20034 (defcustom org-speed-command-hook
20035 '(org-speed-command-default-hook org-babel-speed-command-hook)
20036 "Hook for activating speed commands at strategic locations.
20037 Hook functions are called in sequence until a valid handler is
20040 Each hook takes a single argument, a user-pressed command key
20041 which is also a `self-insert-command' from the global map.
20043 Within the hook, examine the cursor position and the command key
20044 and return nil or a valid handler as appropriate. Handler could
20045 be one of an interactive command, a function, or a form.
20047 Set `org-use-speed-commands' to non-nil value to enable this
20048 hook. The default setting is `org-speed-command-activate'."
20049 :group 'org-structure
20053 (defun org-self-insert-command (N)
20054 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
20055 If the cursor is in a table looking at whitespace, the whitespace is
20056 overwritten, and the table is not marked as requiring realignment."
20058 (org-check-before-invisible-edit 'insert)
20060 ((and org-use-speed-commands
20061 (let ((kv (this-command-keys-vector)))
20062 (setq org-speed-command
20063 (run-hook-with-args-until-success
20064 'org-speed-command-hook
20065 (make-string 1 (aref kv (1- (length kv))))))))
20067 ((commandp org-speed-command)
20068 (setq this-command org-speed-command)
20069 (call-interactively org-speed-command))
20070 ((functionp org-speed-command)
20071 (funcall org-speed-command))
20072 ((and org-speed-command (listp org-speed-command))
20073 (eval org-speed-command))
20074 (t (let (org-use-speed-commands)
20075 (call-interactively 'org-self-insert-command)))))
20079 ;; check if we blank the field, and if that triggers align
20080 (and (featurep 'org-table) org-table-auto-blank-field
20082 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c))
20083 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
20084 ;; got extra space, this field does not determine column width
20085 (let (org-table-may-need-update) (org-table-blank-field))
20086 ;; no extra space, this field may determine column width
20087 (org-table-blank-field)))
20090 (looking-at "[^|\n]* |"))
20091 (let (org-table-may-need-update)
20092 (goto-char (1- (match-end 0)))
20093 (backward-delete-char 1)
20094 (goto-char (match-beginning 0))
20095 (self-insert-command N)))
20097 (setq org-table-may-need-update t)
20098 (self-insert-command N)
20099 (org-fix-tags-on-the-fly)
20100 (if org-self-insert-cluster-for-undo
20101 (if (not (eq last-command 'org-self-insert-command))
20102 (setq org-self-insert-command-undo-counter 1)
20103 (if (>= org-self-insert-command-undo-counter 20)
20104 (setq org-self-insert-command-undo-counter 1)
20105 (and (> org-self-insert-command-undo-counter 0)
20106 buffer-undo-list (listp buffer-undo-list)
20107 (not (cadr buffer-undo-list)) ; remove nil entry
20108 (setcdr buffer-undo-list (cddr buffer-undo-list)))
20109 (setq org-self-insert-command-undo-counter
20110 (1+ org-self-insert-command-undo-counter))))))))
20112 (defun org-check-before-invisible-edit (kind)
20113 "Check is editing if kind KIND would be dangerous with invisible text around.
20114 The detailed reaction depends on the user option `org-catch-invisible-edits'."
20115 ;; First, try to get out of here as quickly as possible, to reduce overhead
20116 (if (and org-catch-invisible-edits
20117 (or (not (boundp 'visible-mode)) (not visible-mode))
20118 (or (get-char-property (point) 'invisible)
20119 (get-char-property (max (point-min) (1- (point))) 'invisible)))
20120 ;; OK, we need to take a closer look
20121 (let* ((invisible-at-point (get-char-property (point) 'invisible))
20122 (invisible-before-point (if (bobp) nil (get-char-property
20123 (1- (point)) 'invisible)))
20124 (border-and-ok-direction
20126 ;; Check if we are acting predictably before invisible text
20127 (and invisible-at-point (not invisible-before-point)
20128 (memq kind '(insert delete-backward)))
20129 ;; Check if we are acting predictably after invisible text
20130 ;; This works not well, and I have turned it off. It seems
20131 ;; better to always show and stop after invisible text.
20132 ;; (and (not invisible-at-point) invisible-before-point
20133 ;; (memq kind '(insert delete)))
20135 (when (or (memq invisible-at-point '(outline org-hide-block t))
20136 (memq invisible-before-point '(outline org-hide-block t)))
20137 (if (eq org-catch-invisible-edits 'error)
20138 (user-error "Editing in invisible areas is prohibited, make them visible first"))
20139 (if (and org-custom-properties-overlays
20140 (y-or-n-p "Display invisible properties in this buffer? "))
20141 (org-toggle-custom-properties-visibility)
20142 ;; Make the area visible
20144 (if invisible-before-point
20145 (goto-char (previous-single-char-property-change
20146 (point) 'invisible)))
20149 ((eq org-catch-invisible-edits 'show)
20150 ;; That's it, we do the edit after showing
20152 "Unfolding invisible region around point before editing")
20154 ((and (eq org-catch-invisible-edits 'smart)
20155 border-and-ok-direction)
20156 (message "Unfolding invisible region around point before editing"))
20158 ;; Don't do the edit, make the user repeat it in full visibility
20159 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
20161 (defun org-fix-tags-on-the-fly ()
20162 (when (and (equal (char-after (point-at-bol)) ?*)
20163 (org-at-heading-p))
20164 (org-align-tags-here org-tags-column)))
20166 (defun org-delete-backward-char (N)
20167 "Like `delete-backward-char', insert whitespace at field end in tables.
20168 When deleting backwards, in tables this function will insert whitespace in
20169 front of the next \"|\" separator, to keep the table aligned. The table will
20170 still be marked for re-alignment if the field did fill the entire column,
20171 because, in this case the deletion might narrow the column."
20174 (org-check-before-invisible-edit 'delete-backward)
20175 (if (and (org-table-p)
20177 (string-match "|" (buffer-substring (point-at-bol) (point)))
20178 (looking-at ".*?|"))
20179 (let ((pos (point))
20180 (noalign (looking-at "[^|\n\r]* |"))
20181 (c org-table-may-need-update))
20182 (backward-delete-char N)
20183 (if (not overwrite-mode)
20185 (skip-chars-forward "^|")
20187 (goto-char (1- pos))))
20188 ;; noalign: if there were two spaces at the end, this field
20189 ;; does not determine the width of the column.
20190 (if noalign (setq org-table-may-need-update c)))
20191 (backward-delete-char N)
20192 (org-fix-tags-on-the-fly))))
20194 (defun org-delete-char (N)
20195 "Like `delete-char', but insert whitespace at field end in tables.
20196 When deleting characters, in tables this function will insert whitespace in
20197 front of the next \"|\" separator, to keep the table aligned. The table will
20198 still be marked for re-alignment if the field did fill the entire column,
20199 because, in this case the deletion might narrow the column."
20202 (org-check-before-invisible-edit 'delete)
20203 (if (and (org-table-p)
20205 (not (= (char-after) ?|))
20207 (if (looking-at ".*?|")
20208 (let ((pos (point))
20209 (noalign (looking-at "[^|\n\r]* |"))
20210 (c org-table-may-need-update))
20212 (concat (substring (match-string 0) 1 -1) " |") nil t)
20214 ;; noalign: if there were two spaces at the end, this field
20215 ;; does not determine the width of the column.
20216 (if noalign (setq org-table-may-need-update c)))
20219 (org-fix-tags-on-the-fly))))
20221 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
20222 (put 'org-self-insert-command 'delete-selection
20224 (not (run-hook-with-args-until-success
20225 'self-insert-uses-region-functions))))
20226 (put 'orgtbl-self-insert-command 'delete-selection
20228 (not (run-hook-with-args-until-success
20229 'self-insert-uses-region-functions))))
20230 (put 'org-delete-char 'delete-selection 'supersede)
20231 (put 'org-delete-backward-char 'delete-selection 'supersede)
20232 (put 'org-yank 'delete-selection 'yank)
20234 ;; Make `flyspell-mode' delay after some commands
20235 (put 'org-self-insert-command 'flyspell-delayed t)
20236 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
20237 (put 'org-delete-char 'flyspell-delayed t)
20238 (put 'org-delete-backward-char 'flyspell-delayed t)
20240 ;; Make pabbrev-mode expand after org-mode commands
20241 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
20242 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
20244 (defun org-remap (map &rest commands)
20245 "In MAP, remap the functions given in COMMANDS.
20246 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
20249 (setq old (pop commands) new (pop commands))
20250 (if (fboundp 'command-remapping)
20251 (org-defkey map (vector 'remap old) new)
20252 (substitute-key-definition old new map global-map)))))
20254 (defun org-transpose-words ()
20255 "Transpose words for Org.
20256 This uses the `org-mode-transpose-word-syntax-table' syntax
20257 table, which interprets characters in `org-emphasis-alist' as
20258 word constituents."
20260 (with-syntax-table org-mode-transpose-word-syntax-table
20261 (call-interactively 'transpose-words)))
20262 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
20264 (when (eq org-enable-table-editor 'optimized)
20265 ;; If the user wants maximum table support, we need to hijack
20266 ;; some standard editing functions
20267 (org-remap org-mode-map
20268 'self-insert-command 'org-self-insert-command
20269 'delete-char 'org-delete-char
20270 'delete-backward-char 'org-delete-backward-char)
20271 (org-defkey org-mode-map "|" 'org-force-self-insert))
20273 (defvar org-ctrl-c-ctrl-c-hook nil
20274 "Hook for functions attaching themselves to `C-c C-c'.
20276 This can be used to add additional functionality to the C-c C-c
20277 key which executes context-dependent commands. This hook is run
20278 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
20279 run after the last test.
20281 Each function will be called with no arguments. The function
20282 must check if the context is appropriate for it to act. If yes,
20283 it should do its thing and then return a non-nil value. If the
20284 context is wrong, just do nothing and return nil.")
20286 (defvar org-ctrl-c-ctrl-c-final-hook nil
20287 "Hook for functions attaching themselves to `C-c C-c'.
20289 This can be used to add additional functionality to the C-c C-c
20290 key which executes context-dependent commands. This hook is run
20291 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
20292 before the first test.
20294 Each function will be called with no arguments. The function
20295 must check if the context is appropriate for it to act. If yes,
20296 it should do its thing and then return a non-nil value. If the
20297 context is wrong, just do nothing and return nil.")
20299 (defvar org-tab-first-hook nil
20300 "Hook for functions to attach themselves to TAB.
20301 See `org-ctrl-c-ctrl-c-hook' for more information.
20302 This hook runs as the first action when TAB is pressed, even before
20303 `org-cycle' messes around with the `outline-regexp' to cater for
20304 inline tasks and plain list item folding.
20305 If any function in this hook returns t, any other actions that
20306 would have been caused by TAB (such as table field motion or visibility
20307 cycling) will not occur.")
20309 (defvar org-tab-after-check-for-table-hook nil
20310 "Hook for functions to attach themselves to TAB.
20311 See `org-ctrl-c-ctrl-c-hook' for more information.
20312 This hook runs after it has been established that the cursor is not in a
20313 table, but before checking if the cursor is in a headline or if global cycling
20315 If any function in this hook returns t, not other actions like visibility
20316 cycling will be done.")
20318 (defvar org-tab-after-check-for-cycling-hook nil
20319 "Hook for functions to attach themselves to TAB.
20320 See `org-ctrl-c-ctrl-c-hook' for more information.
20321 This hook runs after it has been established that not table field motion and
20322 not visibility should be done because of current context. This is probably
20323 the place where a package like yasnippets can hook in.")
20325 (defvar org-tab-before-tab-emulation-hook nil
20326 "Hook for functions to attach themselves to TAB.
20327 See `org-ctrl-c-ctrl-c-hook' for more information.
20328 This hook runs after every other options for TAB have been exhausted, but
20329 before indentation and \t insertion takes place.")
20331 (defvar org-metaleft-hook nil
20332 "Hook for functions attaching themselves to `M-left'.
20333 See `org-ctrl-c-ctrl-c-hook' for more information.")
20334 (defvar org-metaright-hook nil
20335 "Hook for functions attaching themselves to `M-right'.
20336 See `org-ctrl-c-ctrl-c-hook' for more information.")
20337 (defvar org-metaup-hook nil
20338 "Hook for functions attaching themselves to `M-up'.
20339 See `org-ctrl-c-ctrl-c-hook' for more information.")
20340 (defvar org-metadown-hook nil
20341 "Hook for functions attaching themselves to `M-down'.
20342 See `org-ctrl-c-ctrl-c-hook' for more information.")
20343 (defvar org-shiftmetaleft-hook nil
20344 "Hook for functions attaching themselves to `M-S-left'.
20345 See `org-ctrl-c-ctrl-c-hook' for more information.")
20346 (defvar org-shiftmetaright-hook nil
20347 "Hook for functions attaching themselves to `M-S-right'.
20348 See `org-ctrl-c-ctrl-c-hook' for more information.")
20349 (defvar org-shiftmetaup-hook nil
20350 "Hook for functions attaching themselves to `M-S-up'.
20351 See `org-ctrl-c-ctrl-c-hook' for more information.")
20352 (defvar org-shiftmetadown-hook nil
20353 "Hook for functions attaching themselves to `M-S-down'.
20354 See `org-ctrl-c-ctrl-c-hook' for more information.")
20355 (defvar org-metareturn-hook nil
20356 "Hook for functions attaching themselves to `M-RET'.
20357 See `org-ctrl-c-ctrl-c-hook' for more information.")
20358 (defvar org-shiftup-hook nil
20359 "Hook for functions attaching themselves to `S-up'.
20360 See `org-ctrl-c-ctrl-c-hook' for more information.")
20361 (defvar org-shiftup-final-hook nil
20362 "Hook for functions attaching themselves to `S-up'.
20363 This one runs after all other options except shift-select have been excluded.
20364 See `org-ctrl-c-ctrl-c-hook' for more information.")
20365 (defvar org-shiftdown-hook nil
20366 "Hook for functions attaching themselves to `S-down'.
20367 See `org-ctrl-c-ctrl-c-hook' for more information.")
20368 (defvar org-shiftdown-final-hook nil
20369 "Hook for functions attaching themselves to `S-down'.
20370 This one runs after all other options except shift-select have been excluded.
20371 See `org-ctrl-c-ctrl-c-hook' for more information.")
20372 (defvar org-shiftleft-hook nil
20373 "Hook for functions attaching themselves to `S-left'.
20374 See `org-ctrl-c-ctrl-c-hook' for more information.")
20375 (defvar org-shiftleft-final-hook nil
20376 "Hook for functions attaching themselves to `S-left'.
20377 This one runs after all other options except shift-select have been excluded.
20378 See `org-ctrl-c-ctrl-c-hook' for more information.")
20379 (defvar org-shiftright-hook nil
20380 "Hook for functions attaching themselves to `S-right'.
20381 See `org-ctrl-c-ctrl-c-hook' for more information.")
20382 (defvar org-shiftright-final-hook nil
20383 "Hook for functions attaching themselves to `S-right'.
20384 This one runs after all other options except shift-select have been excluded.
20385 See `org-ctrl-c-ctrl-c-hook' for more information.")
20387 (defun org-modifier-cursor-error ()
20388 "Throw an error, a modified cursor command was applied in wrong context."
20389 (user-error "This command is active in special context like tables, headlines or items"))
20391 (defun org-shiftselect-error ()
20392 "Throw an error because Shift-Cursor command was applied in wrong context."
20393 (if (and (boundp 'shift-select-mode) shift-select-mode)
20394 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20395 (user-error "This command works only in special context like headlines or timestamps")))
20397 (defun org-call-for-shift-select (cmd)
20398 (let ((this-command-keys-shift-translated t))
20399 (call-interactively cmd)))
20401 (defun org-shifttab (&optional arg)
20402 "Global visibility cycling or move to previous table field.
20403 Call `org-table-previous-field' within a table.
20404 When ARG is nil, cycle globally through visibility states.
20405 When ARG is a numeric prefix, show contents of this level."
20408 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20410 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20411 (message "Content view to level: %d" arg)
20412 (org-content (prefix-numeric-value arg2))
20413 (org-cycle-show-empty-lines t)
20414 (setq org-cycle-global-status 'overview)))
20415 (t (call-interactively 'org-global-cycle))))
20417 (defun org-shiftmetaleft ()
20418 "Promote subtree or delete table column.
20419 Calls `org-promote-subtree', `org-outdent-item-tree', or
20420 `org-table-delete-column', depending on context. See the
20421 individual commands for more information."
20424 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20425 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20426 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20427 ((if (not (org-region-active-p)) (org-at-item-p)
20428 (save-excursion (goto-char (region-beginning))
20430 (call-interactively 'org-outdent-item-tree))
20431 (t (org-modifier-cursor-error))))
20433 (defun org-shiftmetaright ()
20434 "Demote subtree or insert table column.
20435 Calls `org-demote-subtree', `org-indent-item-tree', or
20436 `org-table-insert-column', depending on context. See the
20437 individual commands for more information."
20440 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20441 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20442 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20443 ((if (not (org-region-active-p)) (org-at-item-p)
20444 (save-excursion (goto-char (region-beginning))
20446 (call-interactively 'org-indent-item-tree))
20447 (t (org-modifier-cursor-error))))
20449 (defun org-shiftmetaup (&optional arg)
20450 "Drag the line at point up.
20451 In a table, kill the current row.
20452 On a clock timestamp, update the value of the timestamp like `S-<up>'
20453 but also adjust the previous clocked item in the clock history.
20454 Everywhere else, drag the line at point up."
20457 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20458 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20459 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20460 (call-interactively 'org-timestamp-up)))
20461 (t (call-interactively 'org-drag-line-backward))))
20463 (defun org-shiftmetadown (&optional arg)
20464 "Drag the line at point down.
20465 In a table, insert an empty row at the current line.
20466 On a clock timestamp, update the value of the timestamp like `S-<down>'
20467 but also adjust the previous clocked item in the clock history.
20468 Everywhere else, drag the line at point down."
20471 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20472 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20473 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20474 (call-interactively 'org-timestamp-down)))
20475 (t (call-interactively 'org-drag-line-forward))))
20477 (defsubst org-hidden-tree-error ()
20479 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20481 (defun org-metaleft (&optional arg)
20482 "Promote heading or move table column to left.
20483 Calls `org-do-promote' or `org-table-move-column', depending on context.
20484 With no specific context, calls the Emacs default `backward-word'.
20485 See the individual commands for more information."
20488 ((run-hook-with-args-until-success 'org-metaleft-hook))
20489 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20490 ((org-with-limited-levels
20491 (or (org-at-heading-p)
20492 (and (org-region-active-p)
20494 (goto-char (region-beginning))
20495 (org-at-heading-p)))))
20496 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20497 (call-interactively 'org-do-promote))
20498 ;; At an inline task.
20499 ((org-at-heading-p)
20500 (call-interactively 'org-inlinetask-promote))
20501 ((or (org-at-item-p)
20502 (and (org-region-active-p)
20504 (goto-char (region-beginning))
20506 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20507 (call-interactively 'org-outdent-item))
20508 (t (call-interactively 'backward-word))))
20510 (defun org-metaright (&optional arg)
20511 "Demote a subtree, a list item or move table column to right.
20512 In front of a drawer or a block keyword, indent it correctly.
20513 With no specific context, calls the Emacs default `forward-word'.
20514 See the individual commands for more information."
20517 ((run-hook-with-args-until-success 'org-metaright-hook))
20518 ((org-at-table-p) (call-interactively 'org-table-move-column))
20519 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20520 ((org-at-block-p) (call-interactively 'org-indent-block))
20521 ((org-with-limited-levels
20522 (or (org-at-heading-p)
20523 (and (org-region-active-p)
20525 (goto-char (region-beginning))
20526 (org-at-heading-p)))))
20527 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20528 (call-interactively 'org-do-demote))
20529 ;; At an inline task.
20530 ((org-at-heading-p)
20531 (call-interactively 'org-inlinetask-demote))
20532 ((or (org-at-item-p)
20533 (and (org-region-active-p)
20535 (goto-char (region-beginning))
20537 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20538 (call-interactively 'org-indent-item))
20539 (t (call-interactively 'forward-word))))
20541 (defun org-check-for-hidden (what)
20542 "Check if there are hidden headlines/items in the current visual line.
20543 WHAT can be either `headlines' or `items'. If the current line is
20544 an outline or item heading and it has a folded subtree below it,
20545 this function returns t, nil otherwise."
20547 ((eq what 'headlines) org-outline-regexp-bol)
20548 ((eq what 'items) (org-item-beginning-re))
20549 (t (error "This should not happen"))))
20553 (unless (org-region-active-p)
20554 (setq beg (point-at-bol))
20555 (beginning-of-line 2)
20556 (while (and (not (eobp)) ;; this is like `next-line'
20557 (get-char-property (1- (point)) 'invisible))
20558 (beginning-of-line 2))
20561 (goto-char (point-at-eol))
20562 (setq end (max end (point)))
20563 (while (re-search-forward re end t)
20564 (if (get-char-property (match-beginning 0) 'invisible)
20568 (defun org-metaup (&optional arg)
20569 "Move subtree up or move table row up.
20570 Calls `org-move-subtree-up' or `org-table-move-row' or
20571 `org-move-item-up', depending on context. See the individual commands
20572 for more information."
20575 ((run-hook-with-args-until-success 'org-metaup-hook))
20576 ((org-region-active-p)
20577 (let* ((a (min (region-beginning) (region-end)))
20578 (b (1- (max (region-beginning) (region-end))))
20579 (c (save-excursion (goto-char a)
20580 (move-beginning-of-line 0)))
20581 (d (save-excursion (goto-char a)
20582 (move-end-of-line 0) (point))))
20583 (transpose-regions a b c d)
20585 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20586 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20587 ((org-at-item-p) (call-interactively 'org-move-item-up))
20588 (t (org-drag-element-backward))))
20590 (defun org-metadown (&optional arg)
20591 "Move subtree down or move table row down.
20592 Calls `org-move-subtree-down' or `org-table-move-row' or
20593 `org-move-item-down', depending on context. See the individual
20594 commands for more information."
20597 ((run-hook-with-args-until-success 'org-metadown-hook))
20598 ((org-region-active-p)
20599 (let* ((a (min (region-beginning) (region-end)))
20600 (b (max (region-beginning) (region-end)))
20601 (c (save-excursion (goto-char b)
20602 (move-beginning-of-line 1)))
20603 (d (save-excursion (goto-char b)
20604 (move-end-of-line 1) (1+ (point)))))
20605 (transpose-regions a b c d)
20607 ((org-at-table-p) (call-interactively 'org-table-move-row))
20608 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20609 ((org-at-item-p) (call-interactively 'org-move-item-down))
20610 (t (org-drag-element-forward))))
20612 (defun org-shiftup (&optional arg)
20613 "Increase item in timestamp or increase priority of current headline.
20614 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20615 depending on context. See the individual commands for more information."
20618 ((run-hook-with-args-until-success 'org-shiftup-hook))
20619 ((and org-support-shift-select (org-region-active-p))
20620 (org-call-for-shift-select 'previous-line))
20621 ((org-at-timestamp-p t)
20622 (call-interactively (if org-edit-timestamp-down-means-later
20623 'org-timestamp-down 'org-timestamp-up)))
20624 ((and (not (eq org-support-shift-select 'always))
20625 org-enable-priority-commands
20626 (org-at-heading-p))
20627 (call-interactively 'org-priority-up))
20628 ((and (not org-support-shift-select) (org-at-item-p))
20629 (call-interactively 'org-previous-item))
20630 ((org-clocktable-try-shift 'up arg))
20631 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20632 (org-support-shift-select
20633 (org-call-for-shift-select 'previous-line))
20634 (t (org-shiftselect-error))))
20636 (defun org-shiftdown (&optional arg)
20637 "Decrease item in timestamp or decrease priority of current headline.
20638 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20639 depending on context. See the individual commands for more information."
20642 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20643 ((and org-support-shift-select (org-region-active-p))
20644 (org-call-for-shift-select 'next-line))
20645 ((org-at-timestamp-p t)
20646 (call-interactively (if org-edit-timestamp-down-means-later
20647 'org-timestamp-up 'org-timestamp-down)))
20648 ((and (not (eq org-support-shift-select 'always))
20649 org-enable-priority-commands
20650 (org-at-heading-p))
20651 (call-interactively 'org-priority-down))
20652 ((and (not org-support-shift-select) (org-at-item-p))
20653 (call-interactively 'org-next-item))
20654 ((org-clocktable-try-shift 'down arg))
20655 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20656 (org-support-shift-select
20657 (org-call-for-shift-select 'next-line))
20658 (t (org-shiftselect-error))))
20660 (defun org-shiftright (&optional arg)
20661 "Cycle the thing at point or in the current line, depending on context.
20662 Depending on context, this does one of the following:
20664 - switch a timestamp at point one day into the future
20665 - on a headline, switch to the next TODO keyword.
20666 - on an item, switch entire list to the next bullet type
20667 - on a property line, switch to the next allowed value
20668 - on a clocktable definition line, move time block into the future"
20671 ((run-hook-with-args-until-success 'org-shiftright-hook))
20672 ((and org-support-shift-select (org-region-active-p))
20673 (org-call-for-shift-select 'forward-char))
20674 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20675 ((and (not (eq org-support-shift-select 'always))
20676 (org-at-heading-p))
20677 (let ((org-inhibit-logging
20678 (not org-treat-S-cursor-todo-selection-as-state-change))
20679 (org-inhibit-blocking
20680 (not org-treat-S-cursor-todo-selection-as-state-change)))
20681 (org-call-with-arg 'org-todo 'right)))
20682 ((or (and org-support-shift-select
20683 (not (eq org-support-shift-select 'always))
20684 (org-at-item-bullet-p))
20685 (and (not org-support-shift-select) (org-at-item-p)))
20686 (org-call-with-arg 'org-cycle-list-bullet nil))
20687 ((and (not (eq org-support-shift-select 'always))
20688 (org-at-property-p))
20689 (call-interactively 'org-property-next-allowed-value))
20690 ((org-clocktable-try-shift 'right arg))
20691 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20692 (org-support-shift-select
20693 (org-call-for-shift-select 'forward-char))
20694 (t (org-shiftselect-error))))
20696 (defun org-shiftleft (&optional arg)
20697 "Cycle the thing at point or in the current line, depending on context.
20698 Depending on context, this does one of the following:
20700 - switch a timestamp at point one day into the past
20701 - on a headline, switch to the previous TODO keyword.
20702 - on an item, switch entire list to the previous bullet type
20703 - on a property line, switch to the previous allowed value
20704 - on a clocktable definition line, move time block into the past"
20707 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20708 ((and org-support-shift-select (org-region-active-p))
20709 (org-call-for-shift-select 'backward-char))
20710 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20711 ((and (not (eq org-support-shift-select 'always))
20712 (org-at-heading-p))
20713 (let ((org-inhibit-logging
20714 (not org-treat-S-cursor-todo-selection-as-state-change))
20715 (org-inhibit-blocking
20716 (not org-treat-S-cursor-todo-selection-as-state-change)))
20717 (org-call-with-arg 'org-todo 'left)))
20718 ((or (and org-support-shift-select
20719 (not (eq org-support-shift-select 'always))
20720 (org-at-item-bullet-p))
20721 (and (not org-support-shift-select) (org-at-item-p)))
20722 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20723 ((and (not (eq org-support-shift-select 'always))
20724 (org-at-property-p))
20725 (call-interactively 'org-property-previous-allowed-value))
20726 ((org-clocktable-try-shift 'left arg))
20727 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20728 (org-support-shift-select
20729 (org-call-for-shift-select 'backward-char))
20730 (t (org-shiftselect-error))))
20732 (defun org-shiftcontrolright ()
20733 "Switch to next TODO set."
20736 ((and org-support-shift-select (org-region-active-p))
20737 (org-call-for-shift-select 'forward-word))
20738 ((and (not (eq org-support-shift-select 'always))
20739 (org-at-heading-p))
20740 (org-call-with-arg 'org-todo 'nextset))
20741 (org-support-shift-select
20742 (org-call-for-shift-select 'forward-word))
20743 (t (org-shiftselect-error))))
20745 (defun org-shiftcontrolleft ()
20746 "Switch to previous TODO set."
20749 ((and org-support-shift-select (org-region-active-p))
20750 (org-call-for-shift-select 'backward-word))
20751 ((and (not (eq org-support-shift-select 'always))
20752 (org-at-heading-p))
20753 (org-call-with-arg 'org-todo 'previousset))
20754 (org-support-shift-select
20755 (org-call-for-shift-select 'backward-word))
20756 (t (org-shiftselect-error))))
20758 (defun org-shiftcontrolup (&optional n)
20759 "Change timestamps synchronously up in CLOCK log lines.
20760 Optional argument N tells to change by that many units."
20762 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20763 (let (org-support-shift-select)
20764 (org-clock-timestamps-up n))
20765 (user-error "Not at a clock log")))
20767 (defun org-shiftcontroldown (&optional n)
20768 "Change timestamps synchronously down in CLOCK log lines.
20769 Optional argument N tells to change by that many units."
20771 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20772 (let (org-support-shift-select)
20773 (org-clock-timestamps-down n))
20774 (user-error "Not at a clock log")))
20776 (defun org-increase-number-at-point (&optional inc)
20777 "Increment the number at point.
20778 With an optional prefix numeric argument INC, increment using
20779 this numeric value."
20781 (if (not (number-at-point))
20782 (user-error "Not on a number")
20783 (unless inc (setq inc 1))
20784 (let ((pos (point))
20785 (beg (skip-chars-backward "-+^/*0-9eE."))
20786 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20787 (setq nap (buffer-substring-no-properties
20788 (+ pos beg) (+ pos beg end)))
20789 (delete-region (+ pos beg) (+ pos beg end))
20790 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20791 (when (org-at-table-p)
20793 (org-table-end-of-field 1))))
20795 (defun org-decrease-number-at-point (&optional inc)
20796 "Decrement the number at point.
20797 With an optional prefix numeric argument INC, decrement using
20798 this numeric value."
20800 (org-increase-number-at-point (- inc)))
20802 (defun org-ctrl-c-ret ()
20803 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20806 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20807 (t (call-interactively 'org-insert-heading))))
20809 (defun org-find-visible ()
20811 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20812 (get-char-property s 'invisible)))
20814 (defun org-find-invisible ()
20816 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20817 (not (get-char-property s 'invisible))))
20820 (defun org-copy-visible (beg end)
20821 "Copy the visible parts of the region."
20826 (narrow-to-region beg end)
20827 (setq s (goto-char (point-min)))
20828 (while (not (= (point) (point-max)))
20829 (goto-char (org-find-invisible))
20830 (push (buffer-substring s (point)) snippets)
20831 (setq s (goto-char (org-find-visible))))))
20832 (kill-new (apply 'concat (nreverse snippets)))))
20834 (defun org-copy-special ()
20835 "Copy region in table or copy current subtree.
20836 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20837 See the individual commands for more information."
20839 (call-interactively
20840 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20842 (defun org-cut-special ()
20843 "Cut region in table or cut current subtree.
20844 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20845 See the individual commands for more information."
20847 (call-interactively
20848 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20850 (defun org-paste-special (arg)
20851 "Paste rectangular region into table, or past subtree relative to level.
20852 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20853 See the individual commands for more information."
20855 (if (org-at-table-p)
20856 (org-table-paste-rectangle)
20857 (org-paste-subtree arg)))
20859 (defsubst org-in-fixed-width-region-p ()
20860 "Is point in a fixed-width region?"
20862 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20864 (defun org-edit-special (&optional arg)
20865 "Call a special editor for the element at point.
20866 When at a table, call the formula editor with `org-table-edit-formulas'.
20867 When in a source code block, call `org-edit-src-code'.
20868 When in a fixed-width region, call `org-edit-fixed-width-region'.
20869 When in an export block, call `org-edit-export-block'.
20870 When at an #+INCLUDE keyword, visit the included file.
20871 When at a footnote reference, call `org-edit-footnote-reference'
20872 On a link, call `ffap' to visit the link at point.
20873 Otherwise, return a user error."
20875 (let ((element (org-element-at-point)))
20876 (assert (not buffer-read-only) nil
20877 "Buffer is read-only: %s" (buffer-name))
20878 (case (org-element-type element)
20880 (if (not arg) (org-edit-src-code)
20881 (let* ((info (org-babel-get-src-block-info))
20882 (lang (nth 0 info))
20883 (params (nth 2 info))
20884 (session (cdr (assq :session params))))
20885 (if (not session) (org-edit-src-code)
20886 ;; At a src-block with a session and function called with
20887 ;; an ARG: switch to the buffer related to the inferior
20890 (funcall (intern (concat "org-babel-prep-session:" lang))
20891 session params))))))
20893 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20894 (org-open-link-from-string
20897 (let ((value (org-element-property :value element)))
20898 (cond ((not (org-string-nw-p value))
20899 (user-error "No file to edit"))
20900 ((string-match "\\`\"\\(.*?\\)\"" value)
20901 (match-string 1 value))
20902 ((string-match "\\`[^ \t\"]\\S-*" value)
20903 (match-string 0 value))
20904 (t (user-error "No valid file specified")))))))
20905 (user-error "No special environment to edit here")))
20907 (if (eq (org-element-property :type element) 'table.el)
20908 (org-edit-table.el)
20909 (call-interactively 'org-table-edit-formulas)))
20910 ;; Only Org tables contain `table-row' type elements.
20911 (table-row (call-interactively 'org-table-edit-formulas))
20912 (example-block (org-edit-src-code))
20913 (export-block (org-edit-export-block))
20914 (fixed-width (org-edit-fixed-width-region))
20916 ;; No notable element at point. Though, we may be at a link or
20917 ;; a footnote reference, which are objects. Thus, scan deeper.
20918 (let ((context (org-element-context element)))
20919 (case (org-element-type context)
20920 (link (call-interactively #'ffap))
20921 (footnote-reference (org-edit-footnote-reference))
20922 (t (user-error "No special environment to edit here"))))))))
20924 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20925 (defun org-ctrl-c-ctrl-c (&optional arg)
20926 "Set tags in headline, or update according to changed information at point.
20928 This command does many different things, depending on context:
20930 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20931 this is what we do.
20933 - If the cursor is on a statistics cookie, update it.
20935 - If the cursor is in a headline, prompt for tags and insert them
20936 into the current line, aligned to `org-tags-column'. When called
20937 with prefix arg, realign all tags in the current buffer.
20939 - If the cursor is in one of the special #+KEYWORD lines, this
20940 triggers scanning the buffer for these lines and updating the
20943 - If the cursor is inside a table, realign the table. This command
20944 works even if the automatic table editor has been turned off.
20946 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20949 - If the cursor is at a footnote reference or definition, jump to
20950 the corresponding definition or references, respectively.
20952 - If the cursor is a the beginning of a dynamic block, update it.
20954 - If the current buffer is a capture buffer, close note and file it.
20956 - If the cursor is on a <<<target>>>, update radio targets and
20957 corresponding links in this buffer.
20959 - If the cursor is on a numbered item in a plain list, renumber the
20962 - If the cursor is on a checkbox, toggle it.
20964 - If the cursor is on a code block, evaluate it. The variable
20965 `org-confirm-babel-evaluate' can be used to control prompting
20966 before code block evaluation, by default every code block
20967 evaluation requires confirmation. Code block evaluation can be
20968 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20971 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20972 org-occur-highlights)
20973 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20974 (org-remove-occur-highlights)
20975 (message "Temporary highlights/overlays removed from current buffer"))
20976 ((and (local-variable-p 'org-finish-function (current-buffer))
20977 (fboundp org-finish-function))
20978 (funcall org-finish-function))
20979 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20981 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20982 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20983 (user-error "C-c C-c can do nothing useful at this location"))
20984 (let* ((context (org-element-context))
20985 (type (org-element-type context)))
20987 ;; When at a link, act according to the parent instead.
20988 (link (setq context (org-element-property :parent context))
20989 (setq type (org-element-type context)))
20990 ;; Unsupported object types: refer to the first supported
20991 ;; element or object containing it.
20992 ((bold code entity export-snippet inline-babel-call inline-src-block
20993 italic latex-fragment line-break macro strike-through subscript
20994 superscript underline verbatim)
20996 (org-element-lineage
20997 context '(radio-target paragraph verse-block table-cell)))))
20998 ;; For convenience: at the first line of a paragraph on the
20999 ;; same line as an item, apply function on that item instead.
21000 (when (eq type 'paragraph)
21001 (let ((parent (org-element-property :parent context)))
21002 (when (and (eq (org-element-type parent) 'item)
21003 (= (line-beginning-position)
21004 (org-element-property :begin parent)))
21005 (setq context parent type 'item))))
21006 ;; Act according to type of element or object at point.
21008 (clock (org-clock-update-time-maybe))
21011 (goto-char (org-element-property :post-affiliated context))
21012 (org-update-dblock)))
21013 (footnote-definition
21014 (goto-char (org-element-property :post-affiliated context))
21015 (call-interactively 'org-footnote-action))
21016 (footnote-reference (call-interactively 'org-footnote-action))
21017 ((headline inlinetask)
21018 (save-excursion (goto-char (org-element-property :begin context))
21019 (call-interactively 'org-set-tags)))
21021 ;; At an item: a double C-u set checkbox to "[-]"
21022 ;; unconditionally, whereas a single one will toggle its
21023 ;; presence. Without an universal argument, if the item
21024 ;; has a checkbox, toggle it. Otherwise repair the list.
21025 (let* ((box (org-element-property :checkbox context))
21026 (struct (org-element-property :structure context))
21027 (old-struct (copy-tree struct))
21028 (parents (org-list-parents-alist struct))
21029 (prevs (org-list-prevs-alist struct))
21030 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
21031 (org-list-set-checkbox
21032 (org-element-property :begin context) struct
21033 (cond ((equal arg '(16)) "[-]")
21034 ((and (not box) (equal arg '(4))) "[ ]")
21035 ((or (not box) (equal arg '(4))) nil)
21036 ((eq box 'on) "[ ]")
21038 ;; Mimic `org-list-write-struct' but with grabbing
21039 ;; a return value from `org-list-struct-fix-box'.
21040 (org-list-struct-fix-ind struct parents 2)
21041 (org-list-struct-fix-item-end struct)
21042 (org-list-struct-fix-bul struct prevs)
21043 (org-list-struct-fix-ind struct parents)
21045 (org-list-struct-fix-box struct parents prevs orderedp)))
21046 (if (and box (equal struct old-struct))
21047 (if (equal arg '(16))
21048 (message "Checkboxes already reset")
21049 (user-error "Cannot toggle this checkbox: %s"
21051 "all subitems checked"
21052 "unchecked subitems")))
21053 (org-list-struct-apply-struct struct old-struct)
21054 (org-update-checkbox-count-maybe))
21056 (message "Checkboxes were removed due to empty box at line %d"
21057 (org-current-line block-item))))))
21059 (let ((org-inhibit-startup-visibility-stuff t)
21060 (org-startup-align-all-tables nil))
21061 (when (boundp 'org-table-coordinate-overlays)
21062 (mapc 'delete-overlay org-table-coordinate-overlays)
21063 (setq org-table-coordinate-overlays nil))
21064 (org-save-outline-visibility 'use-markers (org-mode-restart)))
21065 (message "Local setup has been refreshed"))
21067 ;; At a plain list, with a double C-u argument, set
21068 ;; checkboxes of each item to "[-]", whereas a single one
21069 ;; will toggle their presence according to the state of the
21070 ;; first item in the list. Without an argument, repair the
21072 (let* ((begin (org-element-property :contents-begin context))
21073 (beginm (move-marker (make-marker) begin))
21074 (struct (org-element-property :structure context))
21075 (old-struct (copy-tree struct))
21076 (first-box (save-excursion
21078 (looking-at org-list-full-item-re)
21079 (match-string-no-properties 3)))
21080 (new-box (cond ((equal arg '(16)) "[-]")
21081 ((equal arg '(4)) (unless first-box "[ ]"))
21082 ((equal first-box "[X]") "[ ]")
21086 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
21087 (org-list-get-all-items
21088 begin struct (org-list-prevs-alist struct))))
21089 ((and first-box (eq (point) begin))
21090 ;; For convenience, when point is at bol on the first
21091 ;; item of the list and no argument is provided, simply
21092 ;; toggle checkbox of that item, if any.
21093 (org-list-set-checkbox begin struct new-box)))
21094 (org-list-write-struct
21095 struct (org-list-parents-alist struct) old-struct)
21096 (org-update-checkbox-count-maybe)
21097 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
21098 ((property-drawer node-property)
21099 (call-interactively 'org-property-action))
21100 ((radio-target target)
21101 (call-interactively 'org-update-radio-target-regexp))
21103 (call-interactively 'org-update-statistics-cookies))
21104 ((table table-cell table-row)
21105 ;; At a table, recalculate every field and align it. Also
21106 ;; send the table if necessary. If the table has
21107 ;; a `table.el' type, just give up. At a table row or
21108 ;; cell, maybe recalculate line but always align table.
21109 (if (eq (org-element-property :type context) 'table.el)
21110 (message "Use C-c ' to edit table.el tables")
21111 (let ((org-enable-table-editor t))
21112 (if (or (eq type 'table)
21113 ;; Check if point is at a TBLFM line.
21114 (and (eq type 'table-row)
21115 (= (point) (org-element-property :end context))))
21117 (if (org-at-TBLFM-p)
21118 (progn (require 'org-table)
21119 (org-table-calc-current-TBLFM))
21120 (goto-char (org-element-property :contents-begin context))
21121 (org-call-with-arg 'org-table-recalculate (or arg t))
21122 (orgtbl-send-table 'maybe)))
21123 (org-table-maybe-eval-formula)
21124 (cond (arg (call-interactively 'org-table-recalculate))
21125 ((org-table-maybe-recalculate-line))
21126 (t (org-table-align)))))))
21127 (timestamp (org-timestamp-change 0 'day))
21129 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
21131 "C-c C-c can do nothing useful at this location")))))))))
21133 (defun org-mode-restart ()
21135 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
21136 (funcall major-mode)
21137 (hack-local-variables)
21138 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
21139 (org-indent-mode -1)))
21140 (message "%s restarted" major-mode))
21142 (defun org-kill-note-or-show-branches ()
21143 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
21145 (if (not org-finish-function)
21148 (call-interactively 'show-branches))
21149 (let ((org-note-abort t))
21150 (funcall org-finish-function))))
21152 (defun org-open-line (n)
21153 "Insert a new row in tables, call `open-line' elsewhere.
21154 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
21157 ((not org-special-ctrl-o)
21160 (org-table-insert-row))
21164 (defun org-return (&optional indent)
21165 "Goto next table row or insert a newline.
21167 Calls `org-table-next-row' or `newline', depending on context.
21169 When optional INDENT argument is non-nil, call
21170 `newline-and-indent' instead of `newline'.
21172 When `org-return-follows-link' is non-nil and point is on
21173 a timestamp or a link, call `org-open-at-point'. However, it
21174 will not happen if point is in a table or on a \"dead\"
21175 object (e.g., within a comment). In these case, you need to use
21176 `org-open-at-point' directly."
21178 (if (and (save-excursion
21179 (beginning-of-line)
21180 (looking-at org-todo-line-regexp))
21181 (match-beginning 3)
21182 (>= (point) (match-beginning 3)))
21183 ;; Point is on headline tags. Do not break them: add a newline
21184 ;; after the headline instead.
21185 (progn (org-show-entry)
21187 (if indent (newline-and-indent) (newline)))
21188 (let* ((context (if org-return-follows-link (org-element-context)
21189 (org-element-at-point)))
21190 (type (org-element-type context)))
21192 ;; In a table, call `org-table-next-row'.
21193 ((or (and (eq type 'table)
21194 (>= (point) (org-element-property :contents-begin context))
21195 (< (point) (org-element-property :contents-end context)))
21196 (org-element-lineage context '(table-row table-cell) t))
21197 (org-table-justify-field-maybe)
21198 (call-interactively #'org-table-next-row))
21199 ;; On a link or a timestamp but not on white spaces after it,
21200 ;; call `org-open-line' if `org-return-follows-link' allows it.
21201 ((and org-return-follows-link
21202 (memq type '(link timestamp))
21204 (save-excursion (goto-char (org-element-property :end context))
21205 (skip-chars-backward " \t")
21207 (call-interactively #'org-open-at-point))
21208 ;; In a list, make sure indenting keeps trailing text within.
21211 (org-element-lineage context '(item)))
21212 (let ((trailing-data
21213 (delete-and-extract-region (point) (line-end-position))))
21214 (newline-and-indent)
21215 (save-excursion (insert trailing-data))))
21216 (t (if indent (newline-and-indent) (newline)))))))
21218 (defun org-return-indent ()
21219 "Goto next table row or insert a newline and indent.
21220 Calls `org-table-next-row' or `newline-and-indent', depending on
21221 context. See the individual commands for more information."
21225 (defun org-ctrl-c-star ()
21226 "Compute table, or change heading status of lines.
21227 Calls `org-table-recalculate' or `org-toggle-heading',
21228 depending on context."
21232 (call-interactively 'org-table-recalculate))
21234 ;; Convert all lines in region to list items
21235 (call-interactively 'org-toggle-heading))))
21237 (defun org-ctrl-c-minus ()
21238 "Insert separator line in table or modify bullet status of line.
21239 Also turns a plain line or a region of lines into list items.
21240 Calls `org-table-insert-hline', `org-toggle-item', or
21241 `org-cycle-list-bullet', depending on context."
21245 (call-interactively 'org-table-insert-hline))
21246 ((org-region-active-p)
21247 (call-interactively 'org-toggle-item))
21249 (call-interactively 'org-cycle-list-bullet))
21251 (call-interactively 'org-toggle-item))))
21253 (defun org-toggle-item (arg)
21254 "Convert headings or normal lines to items, items to normal lines.
21255 If there is no active region, only the current line is considered.
21257 If the first non blank line in the region is a headline, convert
21258 all headlines to items, shifting text accordingly.
21260 If it is an item, convert all items to normal lines.
21262 If it is normal text, change region into a list of items.
21263 With a prefix argument ARG, change the region in a single item."
21267 ;; Shift text in current section to IND, from point to END.
21268 ;; The function leaves point to END line.
21270 (let ((min-i 1000) (end (copy-marker end)))
21271 ;; First determine the minimum indentation (MIN-I) of
21275 (while (< (point) end)
21276 (let ((i (org-get-indentation)))
21278 ;; Skip blank lines and inline tasks.
21279 ((looking-at "^[ \t]*$"))
21280 ((looking-at org-outline-regexp-bol))
21281 ;; We can't find less than 0 indentation.
21282 ((zerop i) (throw 'exit (setq min-i 0)))
21283 ((< i min-i) (setq min-i i))))
21285 ;; Then indent each line so that a line indented to
21286 ;; MIN-I becomes indented to IND. Ignore blank lines
21287 ;; and inline tasks in the process.
21288 (let ((delta (- ind min-i)))
21289 (while (< (point) end)
21290 (unless (or (looking-at "^[ \t]*$")
21291 (looking-at org-outline-regexp-bol))
21292 (org-indent-line-to (+ (org-get-indentation) delta)))
21293 (forward-line)))))))
21296 ;; Return beginning of first non-blank line, starting from
21301 (skip-chars-forward " \r\t\n")
21304 ;; Determine boundaries of changes.
21305 (if (org-region-active-p)
21306 (setq beg (funcall skip-blanks (region-beginning))
21307 end (copy-marker (region-end)))
21308 (setq beg (funcall skip-blanks (point-at-bol))
21309 end (copy-marker (point-at-eol))))
21310 ;; Depending on the starting line, choose an action on the text
21311 ;; between BEG and END.
21312 (org-with-limited-levels
21316 ;; Case 1. Start at an item: de-itemize. Note that it only
21317 ;; happens when a region is active: `org-ctrl-c-minus'
21318 ;; would call `org-cycle-list-bullet' otherwise.
21320 (while (< (point) end)
21321 (when (org-at-item-p)
21322 (skip-chars-forward " \t")
21323 (delete-region (point) (match-end 0)))
21325 ;; Case 2. Start at an heading: convert to items.
21326 ((org-at-heading-p)
21327 (let* ((bul (org-list-bullet-string "-"))
21328 (bul-len (length bul))
21329 (done (org-entry-is-done-p))
21330 (todo (org-entry-is-todo-p))
21331 ;; Indentation of the first heading. It should be
21332 ;; relative to the indentation of its parent, if any.
21333 (start-ind (save-excursion
21335 ((not org-adapt-indentation) 0)
21336 ((not (outline-previous-heading)) 0)
21337 (t (length (match-string 0))))))
21338 ;; Level of first heading. Further headings will be
21339 ;; compared to it to determine hierarchy in the list.
21340 (ref-level (org-reduced-level (org-outline-level))))
21341 (when (or done todo) (org-todo ""))
21342 (while (< (point) end)
21343 (let* ((level (org-reduced-level (org-outline-level)))
21344 (delta (max 0 (- level ref-level))))
21345 ;; If current headline is less indented than the first
21346 ;; one, set it as reference, in order to preserve
21348 (when (< level ref-level) (setq ref-level level))
21349 (replace-match bul t t)
21350 (org-indent-line-to (+ start-ind (* delta bul-len)))
21351 (when (or done todo)
21352 (let* ((struct (org-list-struct))
21353 (old (copy-tree struct)))
21354 (org-list-set-checkbox (line-beginning-position)
21356 (if done "[X]" "[ ]"))
21357 (org-list-write-struct struct
21358 (org-list-parents-alist struct)
21360 ;; Ensure all text down to END (or SECTION-END) belongs
21361 ;; to the newly created item.
21362 (let ((section-end (save-excursion
21363 (or (outline-next-heading) (point)))))
21365 (funcall shift-text
21366 (+ start-ind (* (1+ delta) bul-len))
21367 (min end section-end)))))))
21368 ;; Case 3. Normal line with ARG: make the first line of region
21369 ;; an item, and shift indentation of others lines to
21370 ;; set them as item's body.
21371 (arg (let* ((bul (org-list-bullet-string "-"))
21372 (bul-len (length bul))
21373 (ref-ind (org-get-indentation)))
21374 (skip-chars-forward " \t")
21377 (while (< (point) end)
21378 ;; Ensure that lines less indented than first one
21379 ;; still get included in item body.
21380 (funcall shift-text
21381 (+ ref-ind bul-len)
21382 (min end (save-excursion (or (outline-next-heading)
21385 ;; Case 4. Normal line without ARG: turn each non-item line
21388 (while (< (point) end)
21389 (unless (or (org-at-heading-p) (org-at-item-p))
21390 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21392 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21393 (forward-line))))))))
21395 (defun org-toggle-heading (&optional nstars)
21396 "Convert headings to normal text, or items or text to headings.
21397 If there is no active region, only convert the current line.
21399 With a \\[universal-argument] prefix, convert the whole list at
21400 point into heading.
21404 - If the first non blank line is a headline, remove the stars
21405 from all headlines in the region.
21407 - If it is a normal line, turn each and every normal line (i.e.,
21408 not an heading or an item) in the region into headings. If you
21409 want to convert only the first line of this region, use one
21410 universal prefix argument.
21412 - If it is a plain list item, turn all plain list items into headings.
21414 When converting a line into a heading, the number of stars is chosen
21415 such that the lines become children of the current entry. However,
21416 when a numeric prefix argument is given, its value determines the
21417 number of stars to add."
21421 ;; Return beginning of first non-blank line, starting from
21426 (while (org-at-comment-p) (forward-line))
21427 (skip-chars-forward " \r\t\n")
21430 ;; Determine boundaries of changes. If a universal prefix has
21431 ;; been given, put the list in a region. If region ends at a bol,
21432 ;; do not consider the last line to be in the region.
21434 (when (and current-prefix-arg (org-at-item-p))
21435 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21436 (org-mark-element))
21438 (if (org-region-active-p)
21439 (setq beg (funcall skip-blanks (region-beginning))
21440 end (copy-marker (save-excursion
21441 (goto-char (region-end))
21442 (if (bolp) (point) (point-at-eol)))))
21443 (setq beg (funcall skip-blanks (point-at-bol))
21444 end (copy-marker (point-at-eol))))
21445 ;; Ensure inline tasks don't count as headings.
21446 (org-with-limited-levels
21450 ;; Case 1. Started at an heading: de-star headings.
21451 ((org-at-heading-p)
21452 (while (< (point) end)
21453 (when (org-at-heading-p t)
21454 (looking-at org-outline-regexp) (replace-match "")
21457 ;; Case 2. Started at an item: change items into headlines.
21458 ;; One star will be added by `org-list-to-subtree'.
21460 (while (< (point) end)
21461 (when (org-at-item-p)
21462 ;; Pay attention to cases when region ends before list.
21463 (let* ((struct (org-list-struct))
21464 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21466 (narrow-to-region (point) list-end)
21467 (insert (org-list-to-subtree (org-list-parse-list t)))))
21470 ;; Case 3. Started at normal text: make every line an heading,
21471 ;; skipping headlines and items.
21474 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21476 (cond (nstars "") ; stars from prefix only
21477 ((equal stars "") "*") ; before first heading
21478 (org-odd-levels-only "**") ; inside heading, odd
21479 (t "*"))) ; inside heading, oddeven
21480 (rpl (concat stars add-stars " "))
21481 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21482 (while (< (point) (if (equal nstars '(4)) lend end))
21483 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21484 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21485 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21486 (forward-line)))))))
21487 (unless toggled (message "Cannot toggle heading from here"))))
21489 (defun org-meta-return (&optional arg)
21490 "Insert a new heading or wrap a region in a table.
21491 Calls `org-insert-heading' or `org-table-wrap-region', depending
21492 on context. See the individual commands for more information."
21494 (org-check-before-invisible-edit 'insert)
21495 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21496 (let* ((element (org-element-at-point))
21497 (type (org-element-type element)))
21498 (when (eq type 'table-row)
21499 (setq element (org-element-property :parent element))
21500 (setq type 'table))
21501 (if (and (eq type 'table)
21502 (eq (org-element-property :type element) 'org)
21503 (>= (point) (org-element-property :contents-begin element))
21504 (< (point) (org-element-property :contents-end element)))
21505 (call-interactively 'org-table-wrap-region)
21506 (call-interactively 'org-insert-heading)))))
21510 (defsubst org-in-subtree-not-table-p ()
21511 "Are we in a subtree and not in a table?"
21512 (and (not (org-before-first-heading-p))
21513 (not (org-at-table-p))))
21515 ;; Define the Org-mode menus
21516 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21518 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21519 ["Next Field" org-cycle (org-at-table-p)]
21520 ["Previous Field" org-shifttab (org-at-table-p)]
21521 ["Next Row" org-return (org-at-table-p)]
21523 ["Blank Field" org-table-blank-field (org-at-table-p)]
21524 ["Edit Field" org-table-edit-field (org-at-table-p)]
21525 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21528 ["Move Column Left" org-metaleft (org-at-table-p)]
21529 ["Move Column Right" org-metaright (org-at-table-p)]
21530 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21531 ["Insert Column" org-shiftmetaright (org-at-table-p)])
21533 ["Move Row Up" org-metaup (org-at-table-p)]
21534 ["Move Row Down" org-metadown (org-at-table-p)]
21535 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21536 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21537 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21539 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21541 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21542 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21543 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21544 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21547 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21548 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21549 ["Edit Formulas" org-edit-special (org-at-table-p)]
21551 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21552 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21553 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21555 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21557 ["Sum Column/Rectangle" org-table-sum
21558 (or (org-at-table-p) (org-region-active-p))]
21559 ["Which Column?" org-table-current-column (org-at-table-p)])
21561 org-table-toggle-formula-debugger
21562 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21563 ["Show Col/Row Numbers"
21564 org-table-toggle-coordinate-overlays
21566 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21568 ["Create" org-table-create (and (not (org-at-table-p))
21569 org-enable-table-editor)]
21570 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21571 ["Import from File" org-table-import (not (org-at-table-p))]
21572 ["Export to File" org-table-export (org-at-table-p)]
21574 ["Create/Convert from/to table.el" org-table-create-with-table.el t]
21577 ["Ascii plot" orgtbl-ascii-plot :active (org-at-table-p) :keys "C-c \" a"]
21578 ["Gnuplot" org-plot/gnuplot :active (org-at-table-p) :keys "C-c \" g"])))
21580 (easy-menu-define org-org-menu org-mode-map "Org menu"
21583 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21584 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21585 ["Sparse Tree..." org-sparse-tree t]
21586 ["Reveal Context" org-reveal t]
21587 ["Show All" show-all t]
21589 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21591 ["New Heading" org-insert-heading t]
21592 ("Navigate Headings"
21593 ["Up" outline-up-heading t]
21594 ["Next" outline-next-visible-heading t]
21595 ["Previous" outline-previous-visible-heading t]
21596 ["Next Same Level" outline-forward-same-level t]
21597 ["Previous Same Level" outline-backward-same-level t]
21599 ["Jump" org-goto t])
21601 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21603 ["Move Subtree Up" org-metaup (org-at-heading-p)]
21604 ["Move Subtree Down" org-metadown (org-at-heading-p)]
21606 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21607 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21608 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21610 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21612 ["Copy visible text" org-copy-visible t]
21614 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21615 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21616 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21617 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21619 ["Sort Region/Children" org-sort t]
21621 ["Convert to odd levels" org-convert-to-odd-levels t]
21622 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21624 ["Emphasis..." org-emphasize t]
21625 ["Edit Source Example" org-edit-special t]
21627 ["Footnote new/jump" org-footnote-action t]
21628 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21630 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21632 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21633 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21634 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21638 ["Store Link (Global)" org-store-link t]
21639 ["Find existing link to here" org-occur-link-in-agenda-files t]
21640 ["Insert Link" org-insert-link t]
21641 ["Follow Link" org-open-at-point t]
21643 ["Next link" org-next-link t]
21644 ["Previous link" org-previous-link t]
21646 ["Descriptive Links"
21647 org-toggle-link-display
21649 :selected org-descriptive-links
21652 org-toggle-link-display
21654 :selected (not org-descriptive-links)])
21657 ["TODO/DONE/-" org-todo t]
21659 ["Next keyword" org-shiftright (org-at-heading-p)]
21660 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21661 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21662 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21663 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21664 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21665 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21667 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21668 :selected org-enforce-todo-dependencies :style toggle :active t]
21669 "Settings for tree at point"
21670 ["Do Children sequentially" org-toggle-ordered-property :style radio
21671 :selected (org-entry-get nil "ORDERED")
21672 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21673 ["Do Children parallel" org-toggle-ordered-property :style radio
21674 :selected (not (org-entry-get nil "ORDERED"))
21675 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21677 ["Set Priority" org-priority t]
21678 ["Priority Up" org-shiftup t]
21679 ["Priority Down" org-shiftdown t]
21681 ["Get news from all feeds" org-feed-update-all t]
21682 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21683 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21684 ("TAGS and Properties"
21685 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21686 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21688 ["Set property" org-set-property (not (org-before-first-heading-p))]
21689 ["Column view of properties" org-columns t]
21690 ["Insert Column View DBlock" org-insert-columns-dblock t])
21691 ("Dates and Scheduling"
21692 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21693 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21695 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21696 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21697 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21698 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21699 ["Compute Time Range" org-evaluate-time-range t]
21700 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21701 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21703 ["Custom time format" org-toggle-time-stamp-overlays
21704 :style radio :selected org-display-custom-times]
21706 ["Goto Calendar" org-goto-calendar t]
21707 ["Date from Calendar" org-date-from-calendar t]
21709 ["Start/Restart Timer" org-timer-start t]
21710 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21711 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21712 ["Insert Timer String" org-timer t]
21713 ["Insert Timer Item" org-timer-item t])
21715 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21716 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21717 ["Clock out" org-clock-out t]
21718 ["Clock cancel" org-clock-cancel t]
21720 ["Mark as default task" org-clock-mark-default-task t]
21721 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21722 ["Goto running clock" org-clock-goto t]
21724 ["Display times" org-clock-display t]
21725 ["Create clock table" org-clock-report t]
21727 ["Record DONE time"
21728 (progn (setq org-log-done (not org-log-done))
21729 (message "Switching to %s will %s record a timestamp"
21730 (car org-done-keywords)
21731 (if org-log-done "automatically" "not")))
21732 :style toggle :selected org-log-done])
21734 ["Agenda Command..." org-agenda t]
21735 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21736 ("File List for Agenda")
21737 ("Special views current file"
21738 ["TODO Tree" org-show-todo-tree t]
21739 ["Check Deadlines" org-check-deadlines t]
21740 ["Timeline" org-timeline t]
21741 ["Tags/Property tree" org-match-sparse-tree t])
21743 ["Export/Publish..." org-export-dispatch t]
21745 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21746 :selected org-cdlatex-mode]
21747 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21748 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21749 ["Modify math symbol" org-cdlatex-math-modify
21750 (org-inside-LaTeX-fragment-p)]
21751 ["Insert citation" org-reftex-citation t]
21753 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21756 ["Push Files and Views" org-mobile-push t]
21757 ["Get Captured and Flagged" org-mobile-pull t]
21758 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21760 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21763 ["Show Version" org-version t]
21764 ["Info Documentation" org-info t])
21766 ["Browse Org Group" org-customize t]
21768 ["Expand This Menu" org-create-customize-menu
21769 (fboundp 'customize-menu-create)])
21770 ["Send bug report" org-submit-bug-report t]
21773 ["Refresh setup current buffer" org-mode-restart t]
21774 ["Reload Org (after update)" org-reload t]
21775 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21778 (defun org-info (&optional node)
21779 "Read documentation for Org-mode in the info system.
21780 With optional NODE, go directly to that node."
21782 (info (format "(org)%s" (or node ""))))
21785 (defun org-submit-bug-report ()
21786 "Submit a bug report on Org-mode via mail.
21788 Don't hesitate to report any problems or inaccurate documentation.
21790 If you don't have setup sending mail from (X)Emacs, please copy the
21791 output buffer into your mail program, as it gives us important
21792 information about your Org-mode version and configuration."
21794 (require 'reporter)
21795 (org-load-modules-maybe)
21796 (org-require-autoloaded-modules)
21797 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21798 (reporter-submit-bug-report
21799 "emacs-orgmode@gnu.org"
21800 (org-version nil 'full)
21802 (save-window-excursion
21803 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21804 (delete-other-windows)
21806 (insert "You are about to submit a bug report to the Org-mode mailing list.
21808 We would like to add your full Org-mode and Outline configuration to the
21809 bug report. This greatly simplifies the work of the maintainer and
21810 other experts on the mailing list.
21812 HOWEVER, some variables you have customized may contain private
21813 information. The names of customers, colleagues, or friends, might
21814 appear in the form of file names, tags, todo states, or search strings.
21815 If you answer yes to the prompt, you might want to check and remove
21816 such private information before sending the email.")
21817 (add-text-properties (point-min) (point-max) '(face org-warning))
21818 (when (yes-or-no-p "Include your Org-mode configuration ")
21822 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21823 (or (and (symbol-value v)
21824 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21826 (get v 'custom-type) (get v 'standard-value)
21827 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21829 (kill-buffer (get-buffer "*Warn about privacy*"))
21832 "Remember to cover the basics, that is, what you expected to happen and
21833 what in fact did happen. You don't know how to make a good report? See
21835 http://orgmode.org/manual/Feedback.html#Feedback
21837 Your bug report will be posted to the Org-mode mailing list.
21838 ------------------------------------------------------------------------")
21840 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21841 (replace-match "\\1Bug: \\3 [\\2]")))))
21844 (defun org-install-agenda-files-menu ()
21845 (let ((bl (buffer-list)))
21848 (set-buffer (pop bl))
21849 (if (derived-mode-p 'org-mode) (setq bl nil)))
21850 (when (derived-mode-p 'org-mode)
21852 '("Org") "File List for Agenda"
21855 ["Edit File List" (org-edit-agenda-file-list) t]
21856 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21857 ["Remove Current File from List" org-remove-file t]
21858 ["Cycle through agenda files" org-cycle-agenda-files t]
21859 ["Occur in all agenda files" org-occur-in-agenda-files t]
21861 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21865 (defun org-require-autoloaded-modules ()
21868 '(org-agenda org-archive org-attach org-clock org-colview org-id
21869 org-table org-timer)))
21872 (defun org-reload (&optional uncompiled)
21873 "Reload all org lisp files.
21874 With prefix arg UNCOMPILED, load the uncompiled versions."
21876 (require 'loadhist)
21877 (let* ((org-dir (org-find-library-dir "org"))
21878 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21879 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21880 (remove-re (mapconcat 'identity
21881 (mapcar (lambda (f) (concat "^" f "$"))
21882 (list (if (featurep 'xemacs)
21884 "org-colview-xemacs")
21885 "org" "org-loaddefs" "org-version"))
21887 (feats (delete-dups
21888 (mapcar 'file-name-sans-extension
21889 (mapcar 'file-name-nondirectory
21891 (mapcar 'feature-file
21898 (if (and (string-match feature-re f)
21899 (not (string-match remove-re f)))
21903 (list "org-version" "org")))
21904 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21905 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21906 load-uncore load-misses)
21909 (mapcar (lambda (f)
21910 (or (org-load-noerror-mustsuffix (concat org-dir f))
21911 (and (string= org-dir contrib-dir)
21912 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21913 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21914 (add-to-list 'load-uncore f 'append)
21919 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21920 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21922 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21923 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21924 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21927 (defun org-customize ()
21928 "Call the customize function with org as argument."
21930 (org-load-modules-maybe)
21931 (org-require-autoloaded-modules)
21932 (customize-browse 'org))
21934 (defun org-create-customize-menu ()
21935 "Create a full customization menu for Org-mode, insert it into the menu."
21937 (org-load-modules-maybe)
21938 (org-require-autoloaded-modules)
21939 (if (fboundp 'customize-menu-create)
21942 '("Org") "Customize"
21943 `(["Browse Org group" org-customize t]
21945 ,(customize-menu-create 'org)
21946 ["Set" Custom-set t]
21947 ["Save" Custom-save t]
21948 ["Reset to Current" Custom-reset-current t]
21949 ["Reset to Saved" Custom-reset-saved t]
21950 ["Reset to Standard Settings" Custom-reset-standard t]))
21951 (message "\"Org\"-menu now contains full customization menu"))
21952 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21954 ;;;; Miscellaneous stuff
21956 ;;; Generally useful functions
21958 (defsubst org-get-at-eol (property n)
21959 "Get text property PROPERTY at the end of line less N characters."
21960 (get-text-property (- (point-at-eol) n) property))
21962 (defun org-find-text-property-in-string (prop s)
21963 "Return the first non-nil value of property PROP in string S."
21964 (or (get-text-property 0 prop s)
21965 (get-text-property (or (next-single-property-change 0 prop s) 0)
21968 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21969 "Display the given MESSAGE as a warning."
21970 (if (fboundp 'display-warning)
21971 (display-warning 'org message
21972 (if (featurep 'xemacs) 'warning :warning))
21973 (let ((buf (get-buffer-create "*Org warnings*")))
21974 (with-current-buffer buf
21975 (goto-char (point-max))
21976 (insert "Warning (Org): " message)
21979 (display-buffer buf)
21982 (defun org-eval (form)
21983 "Eval FORM and return result."
21984 (condition-case error
21986 (error (format "%%![Error: %s]" error))))
21988 (defun org-in-clocktable-p ()
21989 "Check if the cursor is in a clocktable."
21990 (let ((pos (point)) start)
21993 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21994 (setq start (match-beginning 0))
21995 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21996 (>= (match-end 0) pos)
21999 (defun org-in-verbatim-emphasis ()
22001 (and (org-in-regexp org-emph-re 2)
22002 (>= (point) (match-beginning 3))
22003 (<= (point) (match-end 4))
22004 (member (match-string 3) '("=" "~")))))
22006 (defun org-goto-marker-or-bmk (marker &optional bookmark)
22007 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
22008 (if (and marker (marker-buffer marker)
22009 (buffer-live-p (marker-buffer marker)))
22011 (org-pop-to-buffer-same-window (marker-buffer marker))
22012 (if (or (> marker (point-max)) (< marker (point-min)))
22015 (org-show-context 'org-goto))
22017 (bookmark-jump bookmark)
22018 (error "Cannot find location"))))
22020 (defun org-quote-csv-field (s)
22021 "Quote field for inclusion in CSV material."
22022 (if (string-match "[\",]" s)
22023 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
22026 (defun org-force-self-insert (N)
22027 "Needed to enforce self-insert under remapping."
22029 (self-insert-command N))
22031 (defun org-string-width (s)
22032 "Compute width of string, ignoring invisible characters.
22033 This ignores character with invisibility property `org-link', and also
22034 characters with property `org-cwidth', because these will become invisible
22035 upon the next fontification round."
22037 (when (or (eq t buffer-invisibility-spec)
22038 (assq 'org-link buffer-invisibility-spec))
22039 (while (setq b (text-property-any 0 (length s)
22040 'invisible 'org-link s))
22041 (setq s (concat (substring s 0 b)
22042 (substring s (or (next-single-property-change
22043 b 'invisible s) (length s)))))))
22044 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
22045 (setq s (concat (substring s 0 b)
22046 (substring s (or (next-single-property-change
22047 b 'org-cwidth s) (length s))))))
22048 (setq l (string-width s) b -1)
22049 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
22050 (setq l (- l (get-text-property b 'org-dwidth-n s))))
22053 (defun org-shorten-string (s maxlength)
22054 "Shorten string S so tht it is no longer than MAXLENGTH characters.
22055 If the string is shorter or has length MAXLENGTH, just return the
22056 original string. If it is longer, the functions finds a space in the
22057 string, breaks this string off at that locations and adds three dots
22058 as ellipsis. Including the ellipsis, the string will not be longer
22059 than MAXLENGTH. If finding a good breaking point in the string does
22060 not work, the string is just chopped off in the middle of a word
22062 (if (<= (length s) maxlength)
22064 (let* ((n (max (- maxlength 4) 1))
22065 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
22066 (if (string-match re s)
22067 (concat (match-string 1 s) "...")
22068 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
22070 (defun org-get-indentation (&optional line)
22071 "Get the indentation of the current line, interpreting tabs.
22072 When LINE is given, assume it represents a line and compute its indentation."
22074 (if (string-match "^ *" (org-remove-tabs line))
22077 (beginning-of-line 1)
22078 (skip-chars-forward " \t")
22079 (current-column))))
22081 (defun org-get-string-indentation (s)
22082 "What indentation has S due to SPACE and TAB at the beginning of the string?"
22083 (let ((n -1) (i 0) (w tab-width) c)
22085 (while (< (setq n (1+ n)) (length s))
22086 (setq c (aref s n))
22087 (cond ((= c ?\ ) (setq i (1+ i)))
22088 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
22089 (t (throw 'exit t)))))
22092 (defun org-remove-tabs (s &optional width)
22093 "Replace tabulators in S with spaces.
22094 Assumes that s is a single line, starting in column 0."
22095 (setq width (or width tab-width))
22096 (while (string-match "\t" s)
22097 (setq s (replace-match
22099 (- (* width (/ (+ (match-beginning 0) width) width))
22100 (match-beginning 0)) ?\ )
22104 (defun org-fix-indentation (line ind)
22105 "Fix indentation in LINE.
22106 IND is a cons cell with target and minimum indentation.
22107 If the current indentation in LINE is smaller than the minimum,
22108 leave it alone. If it is larger than ind, set it to the target."
22109 (let* ((l (org-remove-tabs line))
22110 (i (org-get-indentation l))
22111 (i1 (car ind)) (i2 (cdr ind)))
22112 (if (>= i i2) (setq l (substring line i2)))
22114 (concat (make-string i1 ?\ ) l)
22117 (defun org-remove-indentation (code &optional n)
22118 "Remove the maximum common indentation from the lines in CODE.
22119 N may optionally be the number of spaces to remove."
22122 (org-do-remove-indentation n)
22125 (defun org-do-remove-indentation (&optional n)
22126 "Remove the maximum common indentation from the buffer."
22127 (untabify (point-min) (point-max))
22128 (let ((min 10000) re)
22131 (goto-char (point-min))
22132 (while (re-search-forward "^ *[^ \n]" nil t)
22133 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
22134 (unless (or (= min 0) (= min 10000))
22135 (setq re (format "^ \\{%d\\}" min))
22136 (goto-char (point-min))
22137 (while (re-search-forward re nil t)
22142 (defun org-fill-template (template alist)
22143 "Find each %key of ALIST in TEMPLATE and replace it."
22144 (let ((case-fold-search nil)
22146 (setq alist (sort (copy-sequence alist)
22147 (lambda (a b) (< (length (car a)) (length (car b))))))
22148 (while (setq entry (pop alist))
22150 (replace-regexp-in-string
22151 (concat "%" (regexp-quote (car entry)))
22152 (or (cdr entry) "") template t t)))
22155 (defun org-base-buffer (buffer)
22156 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
22159 (or (buffer-base-buffer buffer)
22162 (defun org-wrap (string &optional width lines)
22163 "Wrap string to either a number of lines, or a width in characters.
22164 If WIDTH is non-nil, the string is wrapped to that width, however many lines
22165 that costs. If there is a word longer than WIDTH, the text is actually
22166 wrapped to the length of that word.
22167 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
22168 many lines, whatever width that takes.
22169 The return value is a list of lines, without newlines at the end."
22170 (let* ((words (org-split-string string "[ \t\n]+"))
22171 (maxword (apply 'max (mapcar 'org-string-width words)))
22174 (org-do-wrap words (max maxword width)))
22177 (setq ll (org-do-wrap words maxword))
22178 (if (<= (length ll) lines)
22181 (while (> (length ll) lines)
22183 (setq ll (org-do-wrap words w)))
22185 (t (error "Cannot wrap this")))))
22187 (defun org-do-wrap (words width)
22188 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
22191 (setq line (pop words))
22192 (while (and words (< (+ (length line) (length (car words))) width))
22193 (setq line (concat line " " (pop words))))
22194 (setq lines (push line lines)))
22197 (defun org-split-string (string &optional separators)
22198 "Splits STRING into substrings at SEPARATORS.
22199 No empty strings are returned if there are matches at the beginning
22200 and end of string."
22201 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
22205 (while (and (string-match rexp string
22207 (= start (match-beginning 0))
22208 (< start (length string)))
22210 (< (match-beginning 0) (length string)))
22212 (or (eq (match-beginning 0) 0)
22213 (and (eq (match-beginning 0) (match-end 0))
22214 (eq (match-beginning 0) start))
22216 (cons (substring string start (match-beginning 0))
22218 (setq start (match-end 0)))
22219 (or (eq start (length string))
22221 (cons (substring string start)
22225 (defun org-quote-vert (s)
22226 "Replace \"|\" with \"\\vert\"."
22227 (while (string-match "|" s)
22228 (setq s (replace-match "\\vert" t t s)))
22231 (defun org-uuidgen-p (s)
22232 "Is S an ID created by UUIDGEN?"
22233 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
22235 (defun org-in-src-block-p (&optional inside)
22236 "Whether point is in a code source block.
22237 When INSIDE is non-nil, don't consider we are within a src block
22238 when point is at #+BEGIN_SRC or #+END_SRC."
22239 (let ((case-fold-search t) ov)
22240 (or (and (eq (get-char-property (point) 'src-block) t))
22244 (beginning-of-line)
22245 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
22247 (defun org-context ()
22248 "Return a list of contexts of the current cursor position.
22249 If several contexts apply, all are returned.
22250 Each context entry is a list with a symbol naming the context, and
22251 two positions indicating start and end of the context. Possible
22254 :headline anywhere in a headline
22255 :headline-stars on the leading stars in a headline
22256 :todo-keyword on a TODO keyword (including DONE) in a headline
22257 :tags on the TAGS in a headline
22258 :priority on the priority cookie in a headline
22259 :item on the first line of a plain list item
22260 :item-bullet on the bullet/number of a plain list item
22261 :checkbox on the checkbox in a plain list item
22262 :table in an org-mode table
22263 :table-special on a special filed in a table
22264 :table-table in a table.el table
22265 :clocktable in a clocktable
22266 :src-block in a source block
22267 :link on a hyperlink
22268 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
22269 :target on a <<target>>
22270 :radio-target on a <<<radio-target>>>
22271 :latex-fragment on a LaTeX fragment
22272 :latex-preview on a LaTeX fragment with overlaid preview image
22274 This function expects the position to be visible because it uses font-lock
22275 faces as a help to recognize the following contexts: :table-special, :link,
22277 (let* ((f (get-text-property (point) 'face))
22278 (faces (if (listp f) f (list f)))
22279 (case-fold-search t)
22280 (p (point)) clist o)
22281 ;; First the large context
22283 ((org-at-heading-p t)
22284 (push (list :headline (point-at-bol) (point-at-eol)) clist)
22286 (beginning-of-line 1)
22287 (looking-at org-todo-line-tags-regexp))
22288 (push (org-point-in-group p 1 :headline-stars) clist)
22289 (push (org-point-in-group p 2 :todo-keyword) clist)
22290 (push (org-point-in-group p 4 :tags) clist))
22292 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
22293 (if (looking-at "\\[#[A-Z0-9]\\]")
22294 (push (org-point-in-group p 0 :priority) clist)))
22297 (push (org-point-in-group p 2 :item-bullet) clist)
22298 (push (list :item (point-at-bol)
22299 (save-excursion (org-end-of-item) (point)))
22301 (and (org-at-item-checkbox-p)
22302 (push (org-point-in-group p 0 :checkbox) clist)))
22305 (push (list :table (org-table-begin) (org-table-end)) clist)
22306 (if (memq 'org-formula faces)
22307 (push (list :table-special
22308 (previous-single-property-change p 'face)
22309 (next-single-property-change p 'face)) clist)))
22310 ((org-at-table-p 'any)
22311 (push (list :table-table) clist)))
22314 (let ((case-fold-search t))
22315 ;; New the "medium" contexts: clocktables, source blocks
22316 (cond ((org-in-clocktable-p)
22317 (push (list :clocktable
22318 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
22319 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
22320 (match-beginning 1))
22321 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
22322 (match-end 0))) clist))
22323 ((org-in-src-block-p)
22324 (push (list :src-block
22325 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
22326 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
22327 (match-beginning 1))
22328 (and (search-forward "#+END_SRC" nil t)
22329 (match-beginning 0))) clist))))
22332 ;; Now the small context
22334 ((org-at-timestamp-p)
22335 (push (org-point-in-group p 0 :timestamp) clist))
22336 ((memq 'org-link faces)
22338 (previous-single-property-change p 'face)
22339 (next-single-property-change p 'face)) clist))
22340 ((memq 'org-special-keyword faces)
22341 (push (list :keyword
22342 (previous-single-property-change p 'face)
22343 (next-single-property-change p 'face)) clist))
22345 (push (org-point-in-group p 0 :target) clist)
22346 (goto-char (1- (match-beginning 0)))
22347 (if (looking-at org-radio-target-regexp)
22348 (push (org-point-in-group p 0 :radio-target) clist))
22350 ((setq o (car (delq nil
22353 (if (memq x org-latex-fragment-image-overlays) x))
22354 (overlays-at (point))))))
22355 (push (list :latex-fragment
22356 (overlay-start o) (overlay-end o)) clist)
22357 (push (list :latex-preview
22358 (overlay-start o) (overlay-end o)) clist))
22359 ((org-inside-LaTeX-fragment-p)
22360 ;; FIXME: positions wrong.
22361 (push (list :latex-fragment (point) (point)) clist)))
22363 (setq clist (nreverse (delq nil clist)))
22366 (defun org-in-regexp (re &optional nlines visually)
22367 "Check if point is inside a match of RE.
22369 Normally only the current line is checked, but you can include
22370 NLINES extra lines after point into the search. If VISUALLY is
22371 set, require that the cursor is not after the match but really
22372 on, so that the block visually is on the match."
22374 (let ((pos (point))
22375 (eol (point-at-eol (+ 1 (or nlines 0))))
22376 (inc (if visually 1 0)))
22378 (beginning-of-line (- 1 (or nlines 0)))
22379 (while (re-search-forward re eol t)
22380 (if (and (<= (match-beginning 0) pos)
22381 (>= (+ inc (match-end 0)) pos))
22382 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22383 (define-obsolete-function-alias 'org-at-regexp-p 'org-in-regexp
22386 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22387 "Non-nil when point is between matches of START-RE and END-RE.
22389 Also return a non-nil value when point is on one of the matches.
22391 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22392 buffer positions. Default values are the positions of headlines
22393 surrounding the point.
22395 The functions returns a cons cell whose car (resp. cdr) is the
22396 position before START-RE (resp. after END-RE)."
22398 (let ((pos (point))
22399 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22400 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22403 ;; Point is on a block when on START-RE or if START-RE can be
22404 ;; found before it...
22405 (and (or (org-in-regexp start-re)
22406 (re-search-backward start-re limit-up t))
22407 (setq beg (match-beginning 0))
22408 ;; ... and END-RE after it...
22409 (goto-char (match-end 0))
22410 (re-search-forward end-re limit-down t)
22411 (> (setq end (match-end 0)) pos)
22412 ;; ... without another START-RE in-between.
22413 (goto-char (match-beginning 0))
22414 (not (re-search-backward start-re (1+ beg) t))
22416 (cons beg end))))))
22418 (defun org-in-block-p (names)
22419 "Non-nil when point belongs to a block whose name belongs to NAMES.
22421 NAMES is a list of strings containing names of blocks.
22423 Return first block name matched, or nil. Beware that in case of
22424 nested blocks, the returned name may not belong to the closest
22428 (let ((case-fold-search t)
22429 (lim-up (save-excursion (outline-previous-heading)))
22430 (lim-down (save-excursion (outline-next-heading))))
22431 (mapc (lambda (name)
22432 (let ((n (regexp-quote name)))
22433 (when (org-between-regexps-p
22434 (concat "^[ \t]*#\\+begin_" n)
22435 (concat "^[ \t]*#\\+end_" n)
22441 (defun org-occur-in-agenda-files (regexp &optional nlines)
22442 "Call `multi-occur' with buffers for all agenda files."
22443 (interactive "sOrg-files matching: \np")
22444 (let* ((files (org-agenda-files))
22445 (tnames (mapcar 'file-truename files))
22446 (extra org-agenda-text-search-extra-files)
22448 (when (eq (car extra) 'agenda-archives)
22449 (setq extra (cdr extra))
22450 (setq files (org-add-archive-files files)))
22451 (while (setq f (pop extra))
22452 (unless (member (file-truename f) tnames)
22453 (add-to-list 'files f 'append)
22454 (add-to-list 'tnames (file-truename f) 'append)))
22456 (mapcar (lambda (x)
22457 (with-current-buffer
22458 (or (get-file-buffer x) (find-file-noselect x))
22464 (if (boundp 'occur-mode-find-occurrence-hook)
22466 (add-hook 'occur-mode-find-occurrence-hook
22468 (when (derived-mode-p 'org-mode)
22471 (defadvice occur-mode-goto-occurrence
22472 (after org-occur-reveal activate)
22473 (and (derived-mode-p 'org-mode) (org-reveal)))
22474 (defadvice occur-mode-goto-occurrence-other-window
22475 (after org-occur-reveal activate)
22476 (and (derived-mode-p 'org-mode) (org-reveal)))
22477 (defadvice occur-mode-display-occurrence
22478 (after org-occur-reveal activate)
22479 (when (derived-mode-p 'org-mode)
22480 (let ((pos (occur-mode-find-occurrence)))
22481 (with-current-buffer (marker-buffer pos)
22486 (defun org-occur-link-in-agenda-files ()
22487 "Create a link and search for it in the agendas.
22488 The link is not stored in `org-stored-links', it is just created
22489 for the search purpose."
22491 (let ((link (condition-case nil
22492 (org-store-link nil)
22493 (error "Unable to create a link to here"))))
22494 (org-occur-in-agenda-files (regexp-quote link))))
22496 (defun org-reverse-string (string)
22497 "Return the reverse of STRING."
22498 (apply 'string (reverse (string-to-list string))))
22500 ;; defsubst org-uniquify must be defined before first use
22502 (defun org-uniquify-alist (alist)
22503 "Merge elements of ALIST with the same key.
22505 For example, in this alist:
22507 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22508 => '((a 1 3) (b 2))
22510 merge (a 1) and (a 3) into (a 1 3).
22512 The function returns the new ALIST."
22517 (if (not (assoc (car e) rtn))
22519 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22520 (setq rtn (assq-delete-all (car e) rtn))
22525 (defun org-delete-all (elts list)
22526 "Remove all elements in ELTS from LIST."
22528 (setq list (delete (pop elts) list)))
22531 (defun org-count (cl-item cl-seq)
22532 "Count the number of occurrences of ITEM in SEQ.
22533 Taken from `count' in cl-seq.el with all keyword arguments removed."
22534 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22535 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22536 (while (< cl-start cl-end)
22537 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22538 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22539 (setq cl-start (1+ cl-start)))
22542 (defun org-remove-if (predicate seq)
22543 "Remove everything from SEQ that fulfills PREDICATE."
22547 (if (not (funcall predicate e)) (push e res)))
22550 (defun org-remove-if-not (predicate seq)
22551 "Remove everything from SEQ that does not fulfill PREDICATE."
22555 (if (funcall predicate e) (push e res)))
22558 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22559 "Reduce two-argument FUNCTION across SEQ.
22560 Taken from `reduce' in cl-seq.el with all keyword arguments but
22561 \":initial-value\" removed."
22562 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22563 (cadr (memq :initial-value cl-keys)))
22564 (cl-seq (pop cl-seq))
22565 (t (funcall cl-func)))))
22567 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22570 (defun org-every (pred seq)
22571 "Return true if PREDICATE is true of every element of SEQ.
22572 Adapted from `every' in cl.el."
22574 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22577 (defun org-some (pred seq)
22578 "Return true if PREDICATE is true of any element of SEQ.
22579 Adapted from `some' in cl.el."
22581 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22584 (defun org-back-over-empty-lines ()
22585 "Move backwards over whitespace, to the beginning of the first empty line.
22586 Returns the number of empty lines passed."
22587 (let ((pos (point)))
22588 (if (cdr (assoc 'heading org-blank-before-new-entry))
22589 (skip-chars-backward " \t\n\r")
22591 (forward-line -1)))
22592 (beginning-of-line 2)
22593 (goto-char (min (point) pos))
22594 (count-lines (point) pos)))
22596 (defun org-skip-whitespace ()
22597 (skip-chars-forward " \t\n\r"))
22599 (defun org-point-in-group (point group &optional context)
22600 "Check if POINT is in match-group GROUP.
22601 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22602 match. If the match group does not exist or point is not inside it,
22604 (and (match-beginning group)
22605 (>= point (match-beginning group))
22606 (<= point (match-end group))
22608 (list context (match-beginning group) (match-end group))
22611 (defun org-switch-to-buffer-other-window (&rest args)
22612 "Switch to buffer in a second window on the current frame.
22613 In particular, do not allow pop-up frames.
22614 Returns the newly created buffer."
22616 (apply 'switch-to-buffer-other-window args)))
22618 (defun org-combine-plists (&rest plists)
22619 "Create a single property list from all plists in PLISTS.
22620 The process starts by copying the first list, and then setting properties
22621 from the other lists. Settings in the last list are the most significant
22622 ones and overrule settings in the other lists."
22623 (let ((rtn (copy-sequence (pop plists)))
22626 (setq ls (pop plists))
22628 (setq p (pop ls) v (pop ls))
22629 (setq rtn (plist-put rtn p v))))
22632 (defun org-replace-escapes (string table)
22633 "Replace %-escapes in STRING with values in TABLE.
22634 TABLE is an association list with keys like \"%a\" and string values.
22635 The sequences in STRING may contain normal field width and padding information,
22636 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22637 so values can contain further %-escapes if they are define later in TABLE."
22638 (let ((tbl (copy-alist table))
22639 (case-fold-search nil)
22642 (while (setq e (pop tbl))
22643 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22644 (when (and (cdr e) (string-match re (cdr e)))
22645 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22647 (add-text-properties 0 3 (list 'sref sref) safe)
22648 (setcdr e (replace-match safe t t (cdr e)))))
22649 (while (string-match re string)
22650 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22652 (setq string (replace-match rpl t t string))))
22653 (while (setq pchg (next-property-change pchg string))
22654 (let ((sref (get-text-property pchg 'sref string)))
22655 (when (and sref (string-match "SREF" string pchg))
22656 (setq string (replace-match sref t t string)))))
22659 (defun org-sublist (list start end)
22660 "Return a section of LIST, from START to END.
22661 Counting starts at 1."
22662 (let (rtn (c start))
22663 (setq list (nthcdr (1- start) list))
22664 (while (and list (<= c end))
22665 (push (pop list) rtn)
22669 (defun org-find-base-buffer-visiting (file)
22670 "Like `find-buffer-visiting' but always return the base buffer and
22671 not an indirect buffer."
22672 (let ((buf (or (get-file-buffer file)
22673 (find-buffer-visiting file))))
22675 (or (buffer-base-buffer buf) buf)
22678 (defun org-image-file-name-regexp (&optional extensions)
22679 "Return regexp matching the file names of images.
22680 If EXTENSIONS is given, only match these."
22681 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22682 (image-file-name-regexp)
22683 (let ((image-file-name-extensions
22685 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22686 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22688 (regexp-opt (nconc (mapcar 'upcase
22689 image-file-name-extensions)
22690 image-file-name-extensions)
22694 (defun org-file-image-p (file &optional extensions)
22695 "Return non-nil if FILE is an image."
22697 (string-match (org-image-file-name-regexp extensions) file)))
22699 (defun org-get-cursor-date (&optional with-time)
22700 "Return the date at cursor in as a time.
22701 This works in the calendar and in the agenda, anywhere else it just
22702 returns the current time.
22703 If WITH-TIME is non-nil, returns the time of the event at point (in
22704 the agenda) or the current time of the day."
22705 (let (date day defd tp tm hod mod)
22707 (setq tp (get-text-property (point) 'time))
22708 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22709 (setq hod (string-to-number (match-string 1 tp))
22710 mod (string-to-number (match-string 2 tp))))
22711 (or tp (setq hod (nth 2 (decode-time (current-time)))
22712 mod (nth 1 (decode-time (current-time))))))
22714 ((eq major-mode 'calendar-mode)
22715 (setq date (calendar-cursor-to-date)
22716 defd (encode-time 0 (or mod 0) (or hod 0)
22717 (nth 1 date) (nth 0 date) (nth 2 date))))
22718 ((eq major-mode 'org-agenda-mode)
22719 (setq day (get-text-property (point) 'day))
22721 (setq date (calendar-gregorian-from-absolute day)
22722 defd (encode-time 0 (or mod 0) (or hod 0)
22723 (nth 1 date) (nth 0 date) (nth 2 date))))))
22724 (or defd (current-time))))
22726 (defun org-mark-subtree (&optional up)
22727 "Mark the current subtree.
22728 This puts point at the start of the current subtree, and mark at
22729 the end. If a numeric prefix UP is given, move up into the
22730 hierarchy of headlines by UP levels before marking the subtree."
22732 (org-with-limited-levels
22733 (cond ((org-at-heading-p) (beginning-of-line))
22734 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22735 (t (outline-previous-visible-heading 1))))
22736 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22737 (if (org-called-interactively-p 'any)
22738 (call-interactively 'org-mark-element)
22739 (org-mark-element)))
22744 (defun org--get-expected-indentation (element contentsp)
22745 "Expected indentation column for current line, according to ELEMENT.
22746 ELEMENT is an element containing point. CONTENTSP is non-nil
22747 when indentation is to be computed according to contents of
22749 (let ((type (org-element-type element))
22750 (start (org-element-property :begin element)))
22751 (org-with-wide-buffer
22755 ((diary-sexp footnote-definition) 0)
22756 ((headline inlinetask nil)
22757 (if (not org-adapt-indentation) 0
22758 (let ((level (org-current-level)))
22759 (if level (1+ level) 0))))
22761 (org-list-item-body-column
22762 (org-element-property :post-affiliated element)))
22765 (goto-char (org-element-property :post-affiliated element))
22766 (org-get-indentation)))
22769 (org-get-indentation))))
22770 ((memq type '(headline inlinetask nil))
22771 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22772 (org--get-expected-indentation element t)
22774 ((memq type '(diary-sexp footnote-definition)) 0)
22775 ;; First paragraph of a footnote definition or an item.
22776 ;; Indent like parent.
22777 ((< (line-beginning-position) start)
22778 (org--get-expected-indentation
22779 (org-element-property :parent element) t))
22780 ;; At first line: indent according to previous sibling, if any,
22781 ;; ignoring footnote definitions and inline tasks, or parent's
22783 ((= (line-beginning-position) start)
22786 (if (= (point-min) start) (throw 'exit 0)
22787 (goto-char (1- start))
22788 (let* ((previous (org-element-at-point))
22790 (while (and parent (<= (org-element-property :end parent) start))
22791 (setq previous parent
22792 parent (org-element-property :parent parent)))
22794 ((not previous) (throw 'exit 0))
22795 ((> (org-element-property :end previous) start)
22796 (throw 'exit (org--get-expected-indentation previous t)))
22797 ((memq (org-element-type previous)
22798 '(footnote-definition inlinetask))
22799 (setq start (org-element-property :begin previous)))
22800 (t (goto-char (org-element-property :begin previous))
22802 (if (bolp) (org-get-indentation)
22803 ;; At first paragraph in an item or
22804 ;; a footnote definition.
22805 (org--get-expected-indentation
22806 (org-element-property :parent previous) t))))))))))
22807 ;; Otherwise, move to the first non-blank line above.
22809 (beginning-of-line)
22810 (let ((pos (point)))
22811 (skip-chars-backward " \r\t\n")
22813 ;; Two blank lines end a footnote definition or a plain
22814 ;; list. When we indent an empty line after them, the
22815 ;; containing list or footnote definition is over, so it
22816 ;; qualifies as a previous sibling. Therefore, we indent
22817 ;; like its first line.
22818 ((and (memq type '(footnote-definition plain-list))
22819 (> (count-lines (point) pos) 2))
22821 (org-get-indentation))
22822 ;; Line above is the first one of a paragraph at the
22823 ;; beginning of an item or a footnote definition. Indent
22825 ((< (line-beginning-position) start)
22826 (org--get-expected-indentation
22827 (org-element-property :parent element) t))
22828 ;; POS is after contents in a greater element. Indent like
22829 ;; the beginning of the element.
22831 ;; As a special case, if point is at the end of a footnote
22832 ;; definition or an item, indent like the very last element
22834 ((and (not (eq type 'paragraph))
22835 (let ((cend (org-element-property :contents-end element)))
22836 (and cend (<= cend pos))))
22837 (if (memq type '(footnote-definition item plain-list))
22838 (org--get-expected-indentation (org-element-at-point) nil)
22840 (org-get-indentation)))
22841 ;; In any other case, indent like the current line.
22842 (t (org-get-indentation)))))))))
22844 (defun org--align-node-property ()
22845 "Align node property at point.
22846 Alignment is done according to `org-property-format', which see."
22847 (when (save-excursion
22848 (beginning-of-line)
22849 (looking-at org-property-re))
22851 (concat (match-string 4)
22853 (format org-property-format (match-string 1) (match-string 3))))
22856 (defun org-indent-line ()
22857 "Indent line depending on context.
22859 Indentation is done according to the following rules:
22861 - Footnote definitions, diary sexps, headlines and inline tasks
22862 have to start at column 0.
22864 - On the very first line of an element, consider, in order, the
22865 next rules until one matches:
22867 1. If there's a sibling element before, ignoring footnote
22868 definitions and inline tasks, indent like its first line.
22870 2. If element has a parent, indent like its contents. More
22871 precisely, if parent is an item, indent after the
22872 description part, if any, or the bullet (see
22873 `org-list-description-max-indent'). Else, indent like
22874 parent's first line.
22876 3. Otherwise, indent relatively to current level, if
22877 `org-adapt-indentation' is non-nil, or to left margin.
22879 - On a blank line at the end of an element, indent according to
22880 the type of the element. More precisely
22882 1. If element is a plain list, an item, or a footnote
22883 definition, indent like the very last element within.
22885 2. If element is a paragraph, indent like its last non blank
22888 3. Otherwise, indent like its very first line.
22890 - In the code part of a source block, use language major mode
22891 to indent current line if `org-src-tab-acts-natively' is
22892 non-nil. If it is nil, do nothing.
22894 - Otherwise, indent like the first non-blank line above.
22896 The function doesn't indent an item as it could break the whole
22897 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22898 \\[org-shiftmetaright].
22900 Also align node properties according to `org-property-format'."
22904 (let ((indent-line-function
22905 (cadadr (assq 'indent-line-function org-fb-vars))))
22906 (indent-according-to-mode)))
22907 ((org-at-heading-p) 'noindent)
22909 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22910 (type (org-element-type element)))
22911 (cond ((and (memq type '(plain-list item))
22912 (= (line-beginning-position)
22913 (org-element-property :post-affiliated element)))
22915 ((and (eq type 'src-block)
22916 org-src-tab-acts-natively
22917 (> (line-beginning-position)
22918 (org-element-property :post-affiliated element))
22919 (< (line-beginning-position)
22920 (org-with-wide-buffer
22921 (goto-char (org-element-property :end element))
22922 (skip-chars-backward " \r\t\n")
22923 (line-beginning-position))))
22924 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB")))
22926 (let ((column (org--get-expected-indentation element nil)))
22927 ;; Preserve current column.
22928 (if (<= (current-column) (current-indentation))
22929 (org-indent-line-to column)
22930 (save-excursion (org-indent-line-to column))))
22931 ;; Align node property. Also preserve current column.
22932 (when (eq type 'node-property)
22933 (let ((column (current-column)))
22934 (org--align-node-property)
22935 (org-move-to-column column)))))))))
22937 (defun org-indent-region (start end)
22938 "Indent each non-blank line in the region.
22939 Called from a program, START and END specify the region to
22940 indent. The function will not indent contents of example blocks,
22941 verse blocks and export blocks as leading white spaces are
22942 assumed to be significant there."
22946 (skip-chars-forward " \r\t\n")
22947 (unless (eobp) (beginning-of-line))
22950 ;; Set IND as indentation for all lines between point and
22951 ;; POS or END, whichever comes first. Blank lines are
22952 ;; ignored. Leave point after POS once done.
22953 (let ((limit (copy-marker (min end pos))))
22954 (while (< (point) limit)
22955 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22957 (set-marker limit nil))))
22958 (end (copy-marker end)))
22959 (while (< (point) end)
22960 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22961 (let* ((element (org-element-at-point))
22962 (type (org-element-type element))
22963 (element-end (copy-marker (org-element-property :end element)))
22964 (ind (org--get-expected-indentation element nil)))
22966 ((or (memq type '(paragraph table table-row))
22967 (not (or (org-element-property :contents-begin element)
22969 '(example-block export-block src-block)))))
22970 ;; Elements here are indented as a single block. Also
22971 ;; align node properties.
22972 (when (eq type 'node-property)
22973 (org--align-node-property)
22974 (beginning-of-line))
22975 (funcall indent-to ind element-end))
22977 ;; Elements in this category consist of three parts:
22978 ;; before the contents, the contents, and after the
22979 ;; contents. The contents are treated specially,
22980 ;; according to the element type, or not indented at
22981 ;; all. Other parts are indented as a single block.
22982 (let* ((post (copy-marker
22983 (org-element-property :post-affiliated element)))
22987 ((not (org-element-property :contents-begin element))
22988 ;; Fake contents for source blocks.
22989 (org-with-wide-buffer
22993 ((memq type '(footnote-definition item plain-list))
22994 ;; Contents in these elements could start on
22995 ;; the same line as the beginning of the
22996 ;; element. Make sure we start indenting
22997 ;; from the second line.
22998 (org-with-wide-buffer
23001 (skip-chars-forward " \r\t\n")
23002 (if (eobp) (point) (line-beginning-position))))
23003 (t (org-element-property :contents-begin element)))))
23005 (or (org-element-property :contents-end element)
23006 ;; Fake contents for source blocks.
23007 (org-with-wide-buffer
23008 (goto-char element-end)
23009 (skip-chars-backward " \r\t\n")
23010 (line-beginning-position)))
23012 ;; Do not change items indentation individually as it
23013 ;; might break the list as a whole. On the other
23014 ;; hand, when at a plain list, indent it as a whole.
23015 (cond ((eq type 'plain-list)
23016 (let ((offset (- ind (org-get-indentation))))
23017 (unless (zerop offset)
23018 (indent-rigidly (org-element-property :begin element)
23019 (org-element-property :end element)
23022 ((eq type 'item) (goto-char cbeg))
23023 (t (funcall indent-to ind cbeg)))
23024 (when (< (point) end)
23026 ((example-block export-block verse-block))
23028 ;; In a source block, indent source code
23029 ;; according to language major mode, but only if
23030 ;; `org-src-tab-acts-natively' is non-nil.
23031 (when (and (< (point) end) org-src-tab-acts-natively)
23033 (org-babel-do-in-edit-buffer
23034 (indent-region (point-min) (point-max))))))
23035 (t (org-indent-region (point) (min cend end))))
23036 (goto-char (min cend end))
23037 (when (< (point) end) (funcall indent-to ind element-end)))
23038 (set-marker post nil)
23039 (set-marker cbeg nil)
23040 (set-marker cend nil))))
23041 (set-marker element-end nil))))
23042 (set-marker end nil))))
23044 (defun org-indent-drawer ()
23045 "Indent the drawer at point."
23047 (unless (save-excursion
23048 (beginning-of-line)
23049 (org-looking-at-p org-drawer-regexp))
23050 (user-error "Not at a drawer"))
23051 (let ((element (org-element-at-point)))
23052 (unless (memq (org-element-type element) '(drawer property-drawer))
23053 (user-error "Not at a drawer"))
23054 (org-with-wide-buffer
23055 (org-indent-region (org-element-property :begin element)
23056 (org-element-property :end element))))
23057 (message "Drawer at point indented"))
23059 (defun org-indent-block ()
23060 "Indent the block at point."
23062 (unless (save-excursion
23063 (beginning-of-line)
23064 (let ((case-fold-search t))
23065 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
23066 (user-error "Not at a block"))
23067 (let ((element (org-element-at-point)))
23068 (unless (memq (org-element-type element)
23069 '(comment-block center-block dynamic-block example-block
23070 export-block quote-block special-block
23071 src-block verse-block))
23072 (user-error "Not at a block"))
23073 (org-with-wide-buffer
23074 (org-indent-region (org-element-property :begin element)
23075 (org-element-property :end element))))
23076 (message "Block at point indented"))
23081 ;; We use our own fill-paragraph and auto-fill functions.
23083 ;; `org-fill-paragraph' relies on adaptive filling and context
23084 ;; checking. Appropriate `fill-prefix' is computed with
23085 ;; `org-adaptive-fill-function'.
23087 ;; `org-auto-fill-function' takes care of auto-filling. It calls
23088 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
23089 ;; `org-adaptive-fill-function' value. Internally,
23090 ;; `org-comment-line-break-function' breaks the line.
23092 ;; `org-setup-filling' installs filling and auto-filling related
23093 ;; variables during `org-mode' initialization.
23095 (defvar org-element-paragraph-separate) ; org-element.el
23096 (defun org-setup-filling ()
23097 (require 'org-element)
23098 ;; Prevent auto-fill from inserting unwanted new items.
23099 (when (boundp 'fill-nobreak-predicate)
23101 'fill-nobreak-predicate
23103 (append fill-nobreak-predicate
23104 '(org-fill-line-break-nobreak-p
23105 org-fill-paragraph-with-timestamp-nobreak-p)))))
23106 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
23107 (org-set-local 'paragraph-start paragraph-ending)
23108 (org-set-local 'paragraph-separate paragraph-ending))
23109 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
23110 (org-set-local 'auto-fill-inhibit-regexp nil)
23111 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
23112 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
23113 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
23115 (defun org-fill-line-break-nobreak-p ()
23116 "Non-nil when a new line at point would create an Org line break."
23118 (skip-chars-backward "[ \t]")
23119 (skip-chars-backward "\\\\")
23120 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
23122 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
23123 "Non-nil when a new line at point would split a timestamp."
23124 (and (org-at-timestamp-p t)
23125 (not (looking-at org-ts-regexp-both))))
23127 (declare-function message-in-body-p "message" ())
23128 (defvar orgtbl-line-start-regexp) ; From org-table.el
23129 (defun org-adaptive-fill-function ()
23130 "Compute a fill prefix for the current line.
23131 Return fill prefix, as a string, or nil if current line isn't
23132 meant to be filled. For convenience, if `adaptive-fill-regexp'
23133 matches in paragraphs or comments, use it."
23135 (when (derived-mode-p 'message-mode)
23137 (beginning-of-line)
23138 (cond ((not (message-in-body-p)) (throw 'exit nil))
23139 ((org-looking-at-p org-table-line-regexp) (throw 'exit nil))
23140 ((looking-at message-cite-prefix-regexp)
23141 (throw 'exit (match-string-no-properties 0)))
23142 ((looking-at org-outline-regexp)
23143 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
23144 (org-with-wide-buffer
23145 (unless (org-at-heading-p)
23146 (let* ((p (line-beginning-position))
23147 (element (save-excursion
23148 (beginning-of-line)
23149 (org-element-at-point)))
23150 (type (org-element-type element))
23151 (post-affiliated (org-element-property :post-affiliated element)))
23152 (unless (< p post-affiliated)
23156 (beginning-of-line)
23157 (looking-at "[ \t]*")
23158 (concat (match-string 0) "# ")))
23159 (footnote-definition "")
23161 (make-string (org-list-item-body-column post-affiliated) ?\s))
23163 ;; Fill prefix is usually the same as the current line,
23164 ;; unless the paragraph is at the beginning of an item.
23165 (let ((parent (org-element-property :parent element)))
23167 (beginning-of-line)
23168 (cond ((eq (org-element-type parent) 'item)
23169 (make-string (org-list-item-body-column
23170 (org-element-property :begin parent))
23172 ((and adaptive-fill-regexp
23174 ;; `adaptive-fill-function' to let
23175 ;; `fill-context-prefix' handle
23176 ;; `adaptive-fill-regexp' variable.
23177 (let (adaptive-fill-function)
23178 (fill-context-prefix
23180 (org-element-property :end element)))))
23181 ((looking-at "[ \t]+") (match-string 0))
23184 ;; Only fill contents if P is within block boundaries.
23185 (let* ((cbeg (save-excursion (goto-char post-affiliated)
23188 (cend (save-excursion
23189 (goto-char (org-element-property :end element))
23190 (skip-chars-backward " \r\t\n")
23191 (line-beginning-position))))
23192 (when (and (>= p cbeg) (< p cend))
23193 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
23197 (declare-function message-goto-body "message" ())
23198 (defvar message-cite-prefix-regexp) ; From message.el
23199 (defun org-fill-paragraph (&optional justify)
23200 "Fill element at point, when applicable.
23202 This function only applies to comment blocks, comments, example
23203 blocks and paragraphs. Also, as a special case, re-align table
23204 when point is at one.
23206 If JUSTIFY is non-nil (interactively, with prefix argument),
23207 justify as well. If `sentence-end-double-space' is non-nil, then
23208 period followed by one space does not end a sentence, so don't
23209 break a line there. The variable `fill-column' controls the
23212 For convenience, when point is at a plain list, an item or
23213 a footnote definition, try to fill the first paragraph within."
23215 (if (and (derived-mode-p 'message-mode)
23216 (or (not (message-in-body-p))
23217 (save-excursion (move-beginning-of-line 1)
23218 (looking-at message-cite-prefix-regexp))))
23219 ;; First ensure filling is correct in message-mode.
23220 (let ((fill-paragraph-function
23221 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
23222 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
23223 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
23224 (paragraph-separate
23225 (cadadr (assoc 'paragraph-separate org-fb-vars))))
23226 (fill-paragraph nil))
23227 (with-syntax-table org-mode-transpose-word-syntax-table
23228 ;; Move to end of line in order to get the first paragraph
23229 ;; within a plain list or a footnote definition.
23230 (let ((element (save-excursion
23232 (or (ignore-errors (org-element-at-point))
23233 (user-error "An element cannot be parsed line %d"
23234 (line-number-at-pos (point)))))))
23235 ;; First check if point is in a blank line at the beginning of
23236 ;; the buffer. In that case, ignore filling.
23237 (case (org-element-type element)
23238 ;; Use major mode filling function is src blocks.
23239 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
23240 ;; Align Org tables, leave table.el tables as-is.
23241 (table-row (org-table-align) t)
23243 (when (eq (org-element-property :type element) 'org)
23245 (goto-char (org-element-property :post-affiliated element))
23246 (org-table-align)))
23249 ;; Paragraphs may contain `line-break' type objects.
23250 (let ((beg (max (point-min)
23251 (org-element-property :contents-begin element)))
23252 (end (min (point-max)
23253 (org-element-property :contents-end element))))
23254 ;; Do nothing if point is at an affiliated keyword.
23255 (if (< (line-end-position) beg) t
23256 (when (derived-mode-p 'message-mode)
23257 ;; In `message-mode', do not fill following citation
23258 ;; in current paragraph nor text before message body.
23259 (let ((body-start (save-excursion (message-goto-body))))
23260 (when body-start (setq beg (max body-start beg))))
23261 (when (save-excursion
23263 (concat "^" message-cite-prefix-regexp) end t))
23264 (setq end (match-beginning 0))))
23265 ;; Fill paragraph, taking line breaks into account.
23268 (let ((cuts (list beg)))
23269 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
23270 (when (eq 'line-break
23272 (save-excursion (backward-char)
23273 (org-element-context))))
23274 (push (point) cuts)))
23275 (dolist (c (delq end cuts))
23276 (fill-region-as-paragraph c end justify)
23279 ;; Contents of `comment-block' type elements should be
23280 ;; filled as plain text, but only if point is within block
23283 (let* ((case-fold-search t)
23284 (beg (save-excursion
23285 (goto-char (org-element-property :begin element))
23286 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
23289 (end (save-excursion
23290 (goto-char (org-element-property :end element))
23291 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
23292 (line-beginning-position))))
23293 (if (or (< (point) beg) (> (point) end)) t
23294 (fill-region-as-paragraph
23295 (save-excursion (end-of-line)
23296 (re-search-backward "^[ \t]*$" beg 'move)
23297 (line-beginning-position))
23298 (save-excursion (beginning-of-line)
23299 (re-search-forward "^[ \t]*$" end 'move)
23300 (line-beginning-position))
23304 (let ((begin (org-element-property :post-affiliated element))
23305 (end (org-element-property :end element)))
23306 (when (and (>= (point) begin) (<= (point) end))
23307 (let ((begin (save-excursion
23309 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
23310 (progn (forward-line) (point))
23312 (end (save-excursion
23314 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
23315 (1- (line-beginning-position))
23316 (skip-chars-backward " \r\t\n")
23317 (line-end-position)))))
23318 ;; Do not fill comments when at a blank line.
23319 (when (> end begin)
23322 (beginning-of-line)
23323 (looking-at "[ \t]*#")
23324 (let ((comment-prefix (match-string 0)))
23325 (goto-char (match-end 0))
23326 (if (looking-at adaptive-fill-regexp)
23327 (concat comment-prefix (match-string 0))
23328 (concat comment-prefix " "))))))
23330 (fill-region-as-paragraph begin end justify))))))
23332 ;; Ignore every other element.
23335 (defun org-auto-fill-function ()
23336 "Auto-fill function."
23337 ;; Check if auto-filling is meaningful.
23338 (let ((fc (current-fill-column)))
23339 (when (and fc (> (current-column) fc))
23340 (let* ((fill-prefix (org-adaptive-fill-function))
23341 ;; Enforce empty fill prefix, if required. Otherwise, it
23342 ;; will be computed again.
23343 (adaptive-fill-mode (not (equal fill-prefix ""))))
23344 (when fill-prefix (do-auto-fill))))))
23346 (defun org-comment-line-break-function (&optional soft)
23347 "Break line at point and indent, continuing comment if within one.
23348 The inserted newline is marked hard if variable
23349 `use-hard-newlines' is true, unless optional argument SOFT is
23351 (if soft (insert-and-inherit ?\n) (newline 1))
23352 (save-excursion (forward-char -1) (delete-horizontal-space))
23353 (delete-horizontal-space)
23354 (indent-to-left-margin)
23355 (insert-before-markers-and-inherit fill-prefix))
23358 ;;; Fixed Width Areas
23360 (defun org-toggle-fixed-width ()
23361 "Toggle fixed-width markup.
23363 Add or remove fixed-width markup on current line, whenever it
23364 makes sense. Return an error otherwise.
23366 If a region is active and if it contains only fixed-width areas
23367 or blank lines, remove all fixed-width markup in it. If the
23368 region contains anything else, convert all non-fixed-width lines
23369 to fixed-width ones.
23371 Blank lines at the end of the region are ignored unless the
23372 region only contains such lines."
23374 (if (not (org-region-active-p))
23377 ;; Remove fixed width marker only in a fixed-with element.
23379 ;; Add fixed width maker in paragraphs, in blank lines after
23380 ;; elements or at the beginning of a headline or an inlinetask,
23381 ;; and before any one-line elements (e.g., a clock).
23383 (beginning-of-line)
23384 (let* ((element (org-element-at-point))
23385 (type (org-element-type element)))
23387 ((and (eq type 'fixed-width)
23388 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23390 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23391 ((and (memq type '(babel-call clock comment diary-sexp headline
23392 horizontal-rule keyword paragraph
23394 (<= (org-element-property :post-affiliated element) (point)))
23395 (skip-chars-forward " \t")
23397 ((and (org-looking-at-p "[ \t]*$")
23398 (or (eq type 'inlinetask)
23400 (skip-chars-forward " \r\t\n")
23401 (<= (org-element-property :end element) (point)))))
23402 (delete-region (point) (line-end-position))
23405 (t (user-error "Cannot insert a fixed-width line here")))))
23407 (let* ((begin (save-excursion
23408 (goto-char (region-beginning))
23409 (line-beginning-position)))
23412 (goto-char (region-end))
23413 (unless (eolp) (beginning-of-line))
23414 (if (save-excursion (re-search-backward "\\S-" begin t))
23415 (progn (skip-chars-backward " \r\t\n") (point))
23421 (skip-chars-forward " \r\t\n")
23422 (when (eobp) (throw 'not-all-p nil))
23423 (while (< (point) end)
23424 (let ((element (org-element-at-point)))
23425 (if (eq (org-element-type element) 'fixed-width)
23426 (goto-char (org-element-property :end element))
23427 (throw 'not-all-p nil))))
23429 (if all-fixed-width-p
23432 (while (< (point) end)
23433 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23436 (if (= (line-end-position) (match-end 0)) 0 1)))
23438 (let ((min-ind (point-max)))
23439 ;; Find minimum indentation across all lines.
23442 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23445 (while (< (point) end)
23446 (unless (org-looking-at-p "[ \t]*$")
23447 (let ((ind (org-get-indentation)))
23448 (setq min-ind (min min-ind ind))
23449 (when (zerop ind) (throw 'zerop t))))
23451 ;; Loop over all lines and add fixed-width markup everywhere
23452 ;; but in fixed-width lines.
23455 (while (< (point) end)
23457 ((org-at-heading-p)
23460 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23463 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23464 (let* ((element (org-element-at-point))
23465 (element-end (org-element-property :end element)))
23466 (if (eq (org-element-type element) 'fixed-width)
23467 (progn (goto-char element-end)
23468 (skip-chars-backward " \r\t\n")
23470 (let ((limit (min end element-end)))
23471 (while (< (point) limit)
23472 (org-move-to-column min-ind t)
23474 (forward-line))))))
23476 (org-move-to-column min-ind t)
23478 (forward-line)))))))
23479 (set-marker end nil))))
23484 ;; Org comments syntax is quite complex. It requires the entire line
23485 ;; to be just a comment. Also, even with the right syntax at the
23486 ;; beginning of line, some some elements (i.e. verse-block or
23487 ;; example-block) don't accept comments. Usual Emacs comment commands
23488 ;; cannot cope with those requirements. Therefore, Org replaces them.
23490 ;; Org still relies on `comment-dwim', but cannot trust
23491 ;; `comment-only-p'. So, `comment-region-function' and
23492 ;; `uncomment-region-function' both point
23493 ;; to`org-comment-or-uncomment-region'. Eventually,
23494 ;; `org-insert-comment' takes care of insertion of comments at the
23495 ;; beginning of line.
23497 ;; `org-setup-comments-handling' install comments related variables
23498 ;; during `org-mode' initialization.
23500 (defun org-setup-comments-handling ()
23502 (org-set-local 'comment-use-syntax nil)
23503 (org-set-local 'comment-start "# ")
23504 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23505 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23506 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23507 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23509 (defun org-insert-comment ()
23510 "Insert an empty comment above current line.
23511 If the line is empty, insert comment at its beginning. When
23512 point is within a source block, comment according to the related
23514 (if (let ((element (org-element-at-point)))
23515 (and (eq (org-element-type element) 'src-block)
23517 (goto-char (org-element-property :post-affiliated element))
23518 (line-end-position))
23521 (goto-char (org-element-property :end element))
23522 (skip-chars-backward " \r\t\n")
23523 (line-beginning-position))
23525 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23526 (beginning-of-line)
23527 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23532 (defvar comment-empty-lines) ; From newcomment.el.
23533 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23534 "Comment or uncomment each non-blank line in the region.
23535 Uncomment each non-blank line between BEG and END if it only
23536 contains commented lines. Otherwise, comment them. If region is
23537 strictly within a source block, use appropriate comment syntax."
23538 (if (let ((element (org-element-at-point)))
23539 (and (eq (org-element-type element) 'src-block)
23541 (goto-char (org-element-property :post-affiliated element))
23542 (line-end-position))
23544 (>= (save-excursion
23545 (goto-char (org-element-property :end element))
23546 (skip-chars-backward " \r\t\n")
23547 (line-beginning-position))
23549 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23552 (narrow-to-region (save-excursion (goto-char beg)
23553 (skip-chars-forward " \r\t\n" end)
23554 (line-beginning-position))
23555 (save-excursion (goto-char end)
23556 (skip-chars-backward " \r\t\n" beg)
23557 (line-end-position)))
23559 ;; UNCOMMENTP is non-nil when every non blank line between
23560 ;; BEG and END is a comment.
23562 (goto-char (point-min))
23563 (while (and (not (eobp))
23564 (let ((element (org-element-at-point)))
23565 (and (eq (org-element-type element) 'comment)
23566 (goto-char (min (point-max)
23567 (org-element-property
23568 :end element)))))))
23571 ;; Only blank lines and comments in region: uncomment it.
23573 (goto-char (point-min))
23574 (while (not (eobp))
23575 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23576 (replace-match "" nil nil nil 1))
23578 ;; Comment each line in region.
23579 (let ((min-indent (point-max)))
23580 ;; First find the minimum indentation across all lines.
23582 (goto-char (point-min))
23583 (while (and (not (eobp)) (not (zerop min-indent)))
23584 (unless (looking-at "[ \t]*$")
23585 (setq min-indent (min min-indent (current-indentation))))
23587 ;; Then loop over all lines.
23589 (goto-char (point-min))
23590 (while (not (eobp))
23591 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23592 ;; Don't get fooled by invisible text (e.g. link path)
23593 ;; when moving to column MIN-INDENT.
23594 (let ((buffer-invisibility-spec nil))
23595 (org-move-to-column min-indent t))
23596 (insert comment-start))
23597 (forward-line)))))))))
23599 (defun org-comment-dwim (arg)
23600 "Call `comment-dwim' within a source edit buffer if needed."
23602 (if (org-in-src-block-p)
23603 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23604 (call-interactively 'comment-dwim)))
23609 ;; This section contains tools to operate on timestamp objects, as
23610 ;; returned by, e.g. `org-element-context'.
23612 (defun org-timestamp--to-internal-time (timestamp &optional end)
23613 "Encode TIMESTAMP object into Emacs internal time.
23614 Use end of date range or time range when END is non-nil."
23615 (apply #'encode-time
23618 (lambda (prop) (or (org-element-property prop timestamp) 0))
23619 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23620 '(:minute-start :hour-start :day-start :month-start
23623 (defun org-timestamp-has-time-p (timestamp)
23624 "Non-nil when TIMESTAMP has a time specified."
23625 (org-element-property :hour-start timestamp))
23627 (defun org-timestamp-format (timestamp format &optional end utc)
23628 "Format a TIMESTAMP object into a string.
23630 FORMAT is a format specifier to be passed to
23631 `format-time-string'.
23633 When optional argument END is non-nil, use end of date-range or
23634 time-range, if possible.
23636 When optional argument UTC is non-nil, time will be expressed as
23638 (format-time-string
23639 format (org-timestamp--to-internal-time timestamp end) utc))
23641 (defun org-timestamp-split-range (timestamp &optional end)
23642 "Extract a TIMESTAMP object from a date or time range.
23644 END, when non-nil, means extract the end of the range.
23645 Otherwise, extract its start.
23647 Return a new timestamp object."
23648 (let ((type (org-element-property :type timestamp)))
23649 (if (memq type '(active inactive diary)) timestamp
23650 (let ((split-ts (org-element-copy timestamp)))
23652 (org-element-put-property
23653 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23654 ;; Copy start properties over end properties if END is
23655 ;; non-nil. Otherwise, copy end properties over `start' ones.
23656 (let ((p-alist '((:minute-start . :minute-end)
23657 (:hour-start . :hour-end)
23658 (:day-start . :day-end)
23659 (:month-start . :month-end)
23660 (:year-start . :year-end))))
23661 (dolist (p-cell p-alist)
23662 (org-element-put-property
23664 (funcall (if end #'car #'cdr) p-cell)
23665 (org-element-property
23666 (funcall (if end #'cdr #'car) p-cell) split-ts)))
23667 ;; Eventually refresh `:raw-value'.
23668 (org-element-put-property split-ts :raw-value nil)
23669 (org-element-put-property
23670 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23672 (defun org-timestamp-translate (timestamp &optional boundary)
23673 "Translate TIMESTAMP object to custom format.
23675 Format string is defined in `org-time-stamp-custom-formats',
23678 When optional argument BOUNDARY is non-nil, it is either the
23679 symbol `start' or `end'. In this case, only translate the
23680 starting or ending part of TIMESTAMP if it is a date or time
23681 range. Otherwise, translate both parts.
23683 Return timestamp as-is if `org-display-custom-times' is nil or if
23684 it has a `diary' type."
23685 (let ((type (org-element-property :type timestamp)))
23686 (if (or (not org-display-custom-times) (eq type 'diary))
23687 (org-element-interpret-data timestamp)
23688 (let ((fmt (funcall (if (org-timestamp-has-time-p timestamp) #'cdr #'car)
23689 org-time-stamp-custom-formats)))
23690 (if (and (not boundary) (memq type '(active-range inactive-range)))
23691 (concat (org-timestamp-format timestamp fmt)
23693 (org-timestamp-format timestamp fmt t))
23694 (org-timestamp-format timestamp fmt (eq boundary 'end)))))))
23700 (defun org-reftex-citation ()
23701 "Use reftex-citation to insert a citation into the buffer.
23702 This looks for a line like
23704 #+BIBLIOGRAPHY: foo plain option:-d
23706 and derives from it that foo.bib is the bibliography file relevant
23707 for this document. It then installs the necessary environment for RefTeX
23708 to work in this buffer and calls `reftex-citation' to insert a citation
23711 Export of such citations to both LaTeX and HTML is handled by the contributed
23712 package ox-bibtex by Taru Karttunen."
23714 (let ((reftex-docstruct-symbol 'rds)
23715 (reftex-cite-format "\\cite{%l}")
23720 (let ((case-fold-search t)
23721 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23722 (if (not (save-excursion
23723 (or (re-search-forward re nil t)
23724 (re-search-backward re nil t))))
23725 (user-error "No bibliography defined in file")
23726 (setq bib (concat (match-string 1) ".bib")
23727 rds (list (list 'bib bib)))))))
23728 (call-interactively 'reftex-citation)))
23730 ;;;; Functions extending outline functionality
23732 (defun org-beginning-of-line (&optional arg)
23733 "Go to the beginning of the current line. If that is invisible, continue
23734 to a visible line beginning. This makes the function of C-a more intuitive.
23735 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23736 first attempt, and only move to after the tags when the cursor is already
23737 beyond the end of the headline."
23739 (let ((pos (point))
23740 (special (if (consp org-special-ctrl-a/e)
23741 (car org-special-ctrl-a/e)
23742 org-special-ctrl-a/e))
23743 deactivate-mark refpos)
23744 (if (org-bound-and-true-p visual-line-mode)
23745 (beginning-of-visual-line 1)
23746 (beginning-of-line 1))
23747 (if (and arg (fboundp 'move-beginning-of-line))
23748 (call-interactively 'move-beginning-of-line)
23752 (if (org-truely-invisible-p)
23753 (while (and (not (bobp)) (org-truely-invisible-p))
23755 (beginning-of-line 1))
23756 (forward-char 1))))
23759 ((and (looking-at org-complex-heading-regexp)
23760 (= (char-after (match-end 1)) ?\ ))
23761 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23765 (cond ((> pos refpos) refpos)
23766 ((= pos (point)) refpos)
23768 (cond ((> pos (point)) (point))
23769 ((not (eq last-command this-command)) (point))
23772 ;; Being at an item and not looking at an the item means point
23773 ;; was previously moved to beginning of a visual line, which
23774 ;; doesn't contain the item. Therefore, do nothing special,
23776 (when (looking-at org-list-full-item-re)
23777 ;; Set special position at first white space character after
23778 ;; bullet, and check-box, if any.
23779 (let ((after-bullet
23780 (let ((box (match-end 3)))
23781 (if (not box) (match-end 1)
23782 (let ((after (char-after box)))
23783 (if (and after (= after ? )) (1+ box) box))))))
23784 ;; Special case: Move point to special position when
23785 ;; currently after it or at beginning of line.
23787 (when (or (> pos after-bullet) (= (point) pos))
23788 (goto-char after-bullet))
23789 ;; Reversed case: Move point to special position when
23790 ;; point was already at beginning of line and command is
23792 (when (and (= (point) pos) (eq last-command this-command))
23793 (goto-char after-bullet))))))))
23795 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23796 (setq disable-point-adjustment
23797 (or (not (invisible-p (point)))
23798 (not (invisible-p (max (point-min) (1- (point))))))))
23800 (defun org-end-of-line (&optional arg)
23801 "Go to the end of the line.
23802 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23803 tags on the first attempt, and only move to after the tags when
23804 the cursor is already beyond the end of the headline."
23806 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23807 org-special-ctrl-a/e))
23808 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23809 'end-of-visual-line)
23810 ((fboundp 'move-end-of-line) 'move-end-of-line)
23813 (if (or (not special) arg) (call-interactively move-fun)
23814 (let* ((element (save-excursion (beginning-of-line)
23815 (org-element-at-point)))
23816 (type (org-element-type element)))
23818 ((memq type '(headline inlinetask))
23819 (let ((pos (point)))
23820 (beginning-of-line 1)
23821 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23823 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23824 (goto-char (match-beginning 1))
23825 (goto-char (match-end 0)))
23826 (if (or (< pos (match-end 0))
23827 (not (eq this-command last-command)))
23828 (goto-char (match-end 0))
23829 (goto-char (match-beginning 1))))
23830 (call-interactively move-fun))))
23831 ((outline-invisible-p (line-end-position))
23832 ;; If element is hidden, `move-end-of-line' would put point
23833 ;; after it. Use `end-of-line' to stay on current line.
23834 (call-interactively 'end-of-line))
23835 (t (call-interactively move-fun)))))
23836 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23837 (setq disable-point-adjustment
23838 (or (not (invisible-p (point)))
23839 (not (invisible-p (max (point-min) (1- (point))))))))
23841 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23842 (define-key org-mode-map "\C-e" 'org-end-of-line)
23844 (defun org-backward-sentence (&optional arg)
23845 "Go to beginning of sentence, or beginning of table field.
23846 This will call `backward-sentence' or `org-table-beginning-of-field',
23847 depending on context."
23849 (let* ((element (org-element-at-point))
23850 (contents-begin (org-element-property :contents-begin element))
23851 (table (org-element-lineage element '(table) t)))
23853 (> (point) contents-begin)
23854 (<= (point) (org-element-property :contents-end table)))
23855 (call-interactively #'org-table-beginning-of-field)
23857 (when (and contents-begin
23858 (< (point-min) contents-begin)
23859 (> (point) contents-begin))
23860 (narrow-to-region contents-begin
23861 (org-element-property :contents-end element)))
23862 (call-interactively #'backward-sentence)))))
23864 (defun org-forward-sentence (&optional arg)
23865 "Go to end of sentence, or end of table field.
23866 This will call `forward-sentence' or `org-table-end-of-field',
23867 depending on context."
23869 (let* ((element (org-element-at-point))
23870 (contents-end (org-element-property :contents-end element))
23871 (table (org-element-lineage element '(table) t)))
23873 (>= (point) (org-element-property :contents-begin table))
23874 (< (point) contents-end))
23875 (call-interactively #'org-table-end-of-field)
23877 (when (and contents-end
23878 (> (point-max) contents-end)
23879 ;; Skip blank lines between elements.
23880 (< (org-element-property :end element)
23881 (save-excursion (goto-char contents-end)
23882 (skip-chars-forward " \r\t\n"))))
23883 (narrow-to-region (org-element-property :contents-begin element)
23885 (call-interactively #'forward-sentence)))))
23887 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23888 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23890 (defun org-kill-line (&optional arg)
23891 "Kill line, to tags or end of line."
23894 ((or (not org-special-ctrl-k)
23896 (not (org-at-heading-p)))
23897 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23898 org-ctrl-k-protect-subtree)
23899 (if (or (eq org-ctrl-k-protect-subtree 'error)
23900 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23901 (user-error "C-k aborted as it would kill a hidden subtree")))
23902 (call-interactively
23903 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23904 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23905 (kill-region (point) (match-beginning 1))
23906 (org-set-tags nil t))
23907 (t (kill-region (point) (point-at-eol)))))
23909 (define-key org-mode-map "\C-k" 'org-kill-line)
23911 (defun org-yank (&optional arg)
23912 "Yank. If the kill is a subtree, treat it specially.
23913 This command will look at the current kill and check if is a single
23914 subtree, or a series of subtrees[1]. If it passes the test, and if the
23915 cursor is at the beginning of a line or after the stars of a currently
23916 empty headline, then the yank is handled specially. How exactly depends
23917 on the value of the following variables, both set by default.
23919 `org-yank-folded-subtrees'
23920 When set, the subtree(s) will be folded after insertion, but only
23921 if doing so would now swallow text after the yanked text.
23923 `org-yank-adjusted-subtrees'
23924 When set, the subtree will be promoted or demoted in order to
23925 fit into the local outline tree structure, which means that the
23926 level will be adjusted so that it becomes the smaller one of the
23927 two *visible* surrounding headings.
23929 Any prefix to this command will cause `yank' to be called directly with
23930 no special treatment. In particular, a simple \\[universal-argument] prefix \
23932 plainly yank the text as it is.
23934 \[1] The test checks if the first non-white line is a heading
23935 and if there are no other headings with fewer stars."
23937 (org-yank-generic 'yank arg))
23939 (defun org-yank-generic (command arg)
23940 "Perform some yank-like command.
23942 This function implements the behavior described in the `org-yank'
23943 documentation. However, it has been generalized to work for any
23944 interactive command with similar behavior."
23946 ;; pretend to be command COMMAND
23947 (setq this-command command)
23950 (call-interactively command)
23952 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23953 (and (org-kill-is-subtree-p)
23955 (and (looking-at "[ \t]*$")
23958 (buffer-substring (point-at-bol) (point)))))))
23961 ((and subtreep org-yank-folded-subtrees)
23962 (let ((beg (point))
23964 (if (and subtreep org-yank-adjusted-subtrees)
23965 (org-paste-subtree nil nil 'for-yank)
23966 (call-interactively command))
23970 (when (and (bolp) subtreep
23971 (not (setq swallowp
23972 (org-yank-folding-would-swallow-text beg end))))
23973 (org-with-limited-levels
23974 (or (looking-at org-outline-regexp)
23975 (re-search-forward org-outline-regexp-bol end t))
23976 (while (and (< (point) end) (looking-at org-outline-regexp))
23978 (org-cycle-show-empty-lines 'folded)
23979 (condition-case nil
23980 (outline-forward-same-level 1)
23981 (error (goto-char end))))))
23984 "Inserted text not folded because that would swallow text"))
23987 (skip-chars-forward " \t\n\r")
23988 (beginning-of-line 1)
23989 (push-mark beg 'nomsg)))
23990 ((and subtreep org-yank-adjusted-subtrees)
23991 (let ((beg (point-at-bol)))
23992 (org-paste-subtree nil nil 'for-yank)
23993 (push-mark beg 'nomsg)))
23995 (call-interactively command))))))
23997 (defun org-yank-folding-would-swallow-text (beg end)
23998 "Would hide-subtree at BEG swallow any text after END?"
24000 (org-with-limited-levels
24003 (when (or (looking-at org-outline-regexp)
24004 (re-search-forward org-outline-regexp-bol end t))
24005 (setq level (org-outline-level)))
24007 (skip-chars-forward " \t\r\n\v\f")
24009 (and (bolp) (looking-at org-outline-regexp)
24010 (<= (org-outline-level) level)))
24011 nil ; Nothing would be swallowed
24012 t))))) ; something would swallow
24014 (define-key org-mode-map "\C-y" 'org-yank)
24016 (defun org-truely-invisible-p ()
24017 "Check if point is at a character currently not visible.
24018 This version does not only check the character property, but also
24020 ;; Early versions of noutline don't have `outline-invisible-p'.
24021 (if (org-bound-and-true-p visible-mode)
24023 (outline-invisible-p)))
24025 (defun org-invisible-p2 ()
24026 "Check if point is at a character currently not visible."
24028 (if (and (eolp) (not (bobp))) (backward-char 1))
24029 ;; Early versions of noutline don't have `outline-invisible-p'.
24030 (outline-invisible-p)))
24032 (defun org-back-to-heading (&optional invisible-ok)
24033 "Call `outline-back-to-heading', but provide a better error message."
24034 (condition-case nil
24035 (outline-back-to-heading invisible-ok)
24036 (error (error "Before first headline at position %d in buffer %s"
24037 (point) (current-buffer)))))
24039 (defun org-before-first-heading-p ()
24040 "Before first heading?"
24043 (null (re-search-backward org-outline-regexp-bol nil t))))
24045 (defun org-at-heading-p (&optional ignored)
24046 (outline-on-heading-p t))
24047 ;; Compatibility alias with Org versions < 7.8.03
24048 (defalias 'org-on-heading-p 'org-at-heading-p)
24050 (defun org-in-commented-heading-p (&optional no-inheritance)
24051 "Non-nil if point is under a commented heading.
24052 This function also checks ancestors of the current headline,
24053 unless optional argument NO-INHERITANCE is non-nil."
24055 ((org-before-first-heading-p) nil)
24056 ((let ((headline (nth 4 (org-heading-components))))
24058 (let ((case-fold-search nil))
24059 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
24061 (no-inheritance nil)
24063 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
24065 (defun org-at-comment-p nil
24066 "Is cursor in a commented line?"
24069 (beginning-of-line)
24070 (looking-at "^[ \t]*# "))))
24072 (defun org-at-drawer-p nil
24073 "Is cursor at a drawer keyword?"
24075 (move-beginning-of-line 1)
24076 (looking-at org-drawer-regexp)))
24078 (defun org-at-block-p nil
24079 "Is cursor at a block keyword?"
24081 (move-beginning-of-line 1)
24082 (looking-at org-block-regexp)))
24084 (defun org-point-at-end-of-empty-headline ()
24085 "If point is at the end of an empty headline, return t, else nil.
24086 If the heading only contains a TODO keyword, it is still still considered
24088 (and (looking-at "[ \t]*$")
24089 (when org-todo-line-regexp
24091 (beginning-of-line 1)
24092 (let ((case-fold-search nil))
24093 (looking-at org-todo-line-regexp)
24094 (string= (match-string 3) ""))))))
24096 (defun org-at-heading-or-item-p ()
24097 (or (org-at-heading-p) (org-at-item-p)))
24099 (defun org-at-target-p ()
24100 (or (org-in-regexp org-radio-target-regexp)
24101 (org-in-regexp org-target-regexp)))
24102 ;; Compatibility alias with Org versions < 7.8.03
24103 (defalias 'org-on-target-p 'org-at-target-p)
24105 (defun org-up-heading-all (arg)
24106 "Move to the heading line of which the present line is a subheading.
24107 This function considers both visible and invisible heading lines.
24108 With argument, move up ARG levels."
24109 (if (fboundp 'outline-up-heading-all)
24110 (outline-up-heading-all arg) ; emacs 21 version of outline.el
24111 (outline-up-heading arg t))) ; emacs 22 version of outline.el
24113 (defun org-up-heading-safe ()
24114 "Move to the heading line of which the present line is a subheading.
24115 This version will not throw an error. It will return the level of the
24116 headline found, or nil if no higher level is found.
24118 Also, this function will be a lot faster than `outline-up-heading',
24119 because it relies on stars being the outline starters. This can really
24120 make a significant difference in outlines with very many siblings."
24121 (when (ignore-errors (org-back-to-heading t))
24122 (let ((level-up (1- (funcall outline-level))))
24123 (and (> level-up 0)
24124 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
24125 (funcall outline-level)))))
24127 (defun org-first-sibling-p ()
24128 "Is this heading the first child of its parents?"
24130 (let ((re org-outline-regexp-bol)
24132 (unless (org-at-heading-p t)
24133 (user-error "Not at a heading"))
24134 (setq level (funcall outline-level))
24136 (if (not (re-search-backward re nil t))
24138 (setq l (funcall outline-level))
24141 (defun org-goto-sibling (&optional previous)
24142 "Goto the next sibling, even if it is invisible.
24143 When PREVIOUS is set, go to the previous sibling instead. Returns t
24144 when a sibling was found. When none is found, return nil and don't
24146 (let ((fun (if previous 're-search-backward 're-search-forward))
24148 (re org-outline-regexp-bol)
24150 (when (ignore-errors (org-back-to-heading t))
24151 (setq level (funcall outline-level))
24153 (or previous (forward-char 1))
24154 (while (funcall fun re nil t)
24155 (setq l (funcall outline-level))
24156 (when (< l level) (goto-char pos) (throw 'exit nil))
24157 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
24161 (defun org-show-siblings ()
24162 "Show all siblings of the current headline."
24164 (while (org-goto-sibling) (org-flag-heading nil)))
24166 (while (org-goto-sibling 'previous)
24167 (org-flag-heading nil))))
24169 (defun org-goto-first-child ()
24170 "Goto the first child, even if it is invisible.
24171 Return t when a child was found. Otherwise don't move point and
24173 (let (level (pos (point)) (re org-outline-regexp-bol))
24174 (when (ignore-errors (org-back-to-heading t))
24175 (setq level (outline-level))
24177 (if (and (re-search-forward re nil t) (> (outline-level) level))
24178 (progn (goto-char (match-beginning 0)) t)
24179 (goto-char pos) nil))))
24181 (defun org-show-hidden-entry ()
24182 "Show an entry where even the heading is hidden."
24186 (defun org-flag-heading (flag &optional entry)
24187 "Flag the current heading. FLAG non-nil means make invisible.
24188 When ENTRY is non-nil, show the entire entry."
24190 (org-back-to-heading t)
24191 ;; Check if we should show the entire entry
24196 (and (outline-next-heading)
24197 (org-flag-heading nil))))
24198 (outline-flag-region (max (point-min) (1- (point)))
24199 (save-excursion (outline-end-of-heading) (point))
24202 (defun org-get-next-sibling ()
24203 "Move to next heading of the same level, and return point.
24204 If there is no such heading, return nil.
24205 This is like outline-next-sibling, but invisible headings are ok."
24206 (let ((level (funcall outline-level)))
24207 (outline-next-heading)
24208 (while (and (not (eobp)) (> (funcall outline-level) level))
24209 (outline-next-heading))
24210 (if (or (eobp) (< (funcall outline-level) level))
24214 (defun org-get-last-sibling ()
24215 "Move to previous heading of the same level, and return point.
24216 If there is no such heading, return nil."
24217 (let ((opoint (point))
24218 (level (funcall outline-level)))
24219 (outline-previous-heading)
24220 (when (and (/= (point) opoint) (outline-on-heading-p t))
24221 (while (and (> (funcall outline-level) level)
24223 (outline-previous-heading))
24224 (if (< (funcall outline-level) level)
24228 (defun org-end-of-subtree (&optional invisible-ok to-heading)
24229 "Goto to the end of a subtree."
24230 ;; This contains an exact copy of the original function, but it uses
24231 ;; `org-back-to-heading', to make it work also in invisible
24232 ;; trees. And is uses an invisible-ok argument.
24233 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
24234 ;; Furthermore, when used inside Org, finding the end of a large subtree
24235 ;; with many children and grandchildren etc, this can be much faster
24236 ;; than the outline version.
24237 (org-back-to-heading invisible-ok)
24239 (level (funcall outline-level)))
24240 (if (and (derived-mode-p 'org-mode) (< level 1000))
24241 ;; A true heading (not a plain list item), in Org-mode
24242 ;; This means we can easily find the end by looking
24243 ;; only for the right number of stars. Using a regexp to do
24244 ;; this is so much faster than using a Lisp loop.
24245 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
24247 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
24248 ;; something else, do it the slow way
24249 (while (and (not (eobp))
24250 (or first (> (funcall outline-level) level)))
24252 (outline-next-heading)))
24254 (if (memq (preceding-char) '(?\n ?\^M))
24256 ;; Go to end of line before heading
24258 (if (memq (preceding-char) '(?\n ?\^M))
24259 ;; leave blank line before heading
24260 (forward-char -1))))))
24263 (defun org-end-of-meta-data (&optional full)
24264 "Skip planning line and properties drawer in current entry.
24265 When optional argument FULL is non-nil, also skip empty lines,
24266 clocking lines and regular drawers at the beginning of the
24268 (org-back-to-heading t)
24270 (when (org-looking-at-p org-planning-line-re) (forward-line))
24271 (when (looking-at org-property-drawer-re)
24272 (goto-char (match-end 0))
24274 (when (and full (not (org-at-heading-p)))
24276 (let ((end (save-excursion (outline-next-heading) (point)))
24277 (re (concat "[ \t]*$" "\\|" org-clock-line-re)))
24278 (while (not (eobp))
24279 (cond ((org-looking-at-p org-drawer-regexp)
24280 (if (re-search-forward "^[ \t]*:END:[ \t]*$" end t)
24283 ((org-looking-at-p re) (forward-line))
24284 (t (throw 'exit t))))))))
24286 (defun org-forward-heading-same-level (arg &optional invisible-ok)
24287 "Move forward to the ARG'th subheading at same level as this one.
24288 Stop at the first and last subheadings of a superior heading.
24289 Normally this only looks at visible headings, but when INVISIBLE-OK is
24290 non-nil it will also look at invisible ones."
24292 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
24293 (if (and arg (< arg 0))
24294 (goto-char (point-min))
24295 (outline-next-heading))
24297 (let ((level (- (match-end 0) (match-beginning 0) 1))
24298 (f (if (and arg (< arg 0))
24299 're-search-backward
24300 're-search-forward))
24301 (count (if arg (abs arg) 1))
24303 (while (and (prog1 (> count 0)
24304 (forward-char (if (and arg (< arg 0)) -1 1)))
24305 (funcall f org-outline-regexp-bol nil 'move))
24306 (let ((l (- (match-end 0) (match-beginning 0) 1)))
24307 (cond ((< l level) (setq count 0))
24311 (goto-char (line-beginning-position))
24312 (not (outline-invisible-p)))))
24313 (setq count (1- count))
24315 (setq result (point)))))))
24316 (goto-char result))
24317 (beginning-of-line 1)))
24319 (defun org-backward-heading-same-level (arg &optional invisible-ok)
24320 "Move backward to the ARG'th subheading at same level as this one.
24321 Stop at the first and last subheadings of a superior heading."
24323 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
24325 (defun org-next-visible-heading (arg)
24326 "Move to the next visible heading.
24328 This function wraps `outline-next-visible-heading' with
24329 `org-with-limited-levels' in order to skip over inline tasks and
24330 respect customization of `org-odd-levels-only'."
24332 (org-with-limited-levels
24333 (outline-next-visible-heading arg)))
24335 (defun org-previous-visible-heading (arg)
24336 "Move to the next visible heading.
24338 This function wraps `outline-previous-visible-heading' with
24339 `org-with-limited-levels' in order to skip over inline tasks and
24340 respect customization of `org-odd-levels-only'."
24342 (org-with-limited-levels
24343 (outline-previous-visible-heading arg)))
24345 (defun org-next-block (arg &optional backward block-regexp)
24346 "Jump to the next block.
24347 With a prefix argument ARG, jump forward ARG many source blocks.
24348 When BACKWARD is non-nil, jump to the previous block.
24349 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24351 (let ((re (or block-regexp org-block-regexp))
24352 (re-search-fn (or (and backward 're-search-backward)
24353 're-search-forward)))
24354 (if (looking-at re) (forward-char 1))
24355 (condition-case nil
24356 (funcall re-search-fn re nil nil arg)
24357 (error (user-error "No %s code blocks"
24358 (if backward "previous" "further" ))))
24359 (goto-char (match-beginning 0)) (org-show-context)))
24361 (defun org-previous-block (arg &optional block-regexp)
24362 "Jump to the previous block.
24363 With a prefix argument ARG, jump backward ARG many source blocks.
24364 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
24366 (org-next-block arg t block-regexp))
24368 (defun org-forward-paragraph ()
24369 "Move forward to beginning of next paragraph or equivalent.
24371 The function moves point to the beginning of the next visible
24372 structural element, which can be a paragraph, a table, a list
24373 item, etc. It also provides some special moves for convenience:
24375 - On an affiliated keyword, jump to the beginning of the
24377 - On an item or a footnote definition, move to the second
24378 element inside, if any.
24379 - On a table or a property drawer, jump after it.
24380 - On a verse or source block, stop after blank lines."
24382 (when (eobp) (user-error "Cannot move further down"))
24383 (let* ((deactivate-mark nil)
24384 (element (org-element-at-point))
24385 (type (org-element-type element))
24386 (post-affiliated (org-element-property :post-affiliated element))
24387 (contents-begin (org-element-property :contents-begin element))
24388 (contents-end (org-element-property :contents-end element))
24389 (end (let ((end (org-element-property :end element)) (parent element))
24390 (while (and (setq parent (org-element-property :parent parent))
24391 (= (org-element-property :contents-end parent) end))
24392 (setq end (org-element-property :end parent)))
24394 (cond ((not element)
24395 (skip-chars-forward " \r\t\n")
24396 (or (eobp) (beginning-of-line)))
24397 ;; On affiliated keywords, move to element's beginning.
24398 ((< (point) post-affiliated)
24399 (goto-char post-affiliated))
24400 ;; At a table row, move to the end of the table. Similarly,
24401 ;; at a node property, move to the end of the property
24403 ((memq type '(node-property table-row))
24404 (goto-char (org-element-property
24405 :end (org-element-property :parent element))))
24406 ((memq type '(property-drawer table)) (goto-char end))
24407 ;; Consider blank lines as separators in verse and source
24408 ;; blocks to ease editing.
24409 ((memq type '(src-block verse-block))
24410 (when (eq type 'src-block)
24412 (save-excursion (goto-char end)
24413 (skip-chars-backward " \r\t\n")
24414 (line-beginning-position))))
24415 (beginning-of-line)
24416 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
24417 (if (not (re-search-forward "^[ \t]*$" contents-end t))
24419 (skip-chars-forward " \r\t\n")
24420 (if (= (point) contents-end) (goto-char end)
24421 (beginning-of-line))))
24422 ;; With no contents, just skip element.
24423 ((not contents-begin) (goto-char end))
24424 ;; If contents are invisible, skip the element altogether.
24425 ((outline-invisible-p (line-end-position))
24428 (org-with-limited-levels (outline-next-visible-heading 1)))
24429 ;; At a plain list, make sure we move to the next item
24430 ;; instead of skipping the whole list.
24431 (plain-list (forward-char)
24432 (org-forward-paragraph))
24433 (otherwise (goto-char end))))
24434 ((>= (point) contents-end) (goto-char end))
24435 ((>= (point) contents-begin)
24436 ;; This can only happen on paragraphs and plain lists.
24438 (paragraph (goto-char end))
24439 ;; At a plain list, try to move to second element in
24440 ;; first item, if possible.
24441 (plain-list (end-of-line)
24442 (org-forward-paragraph))))
24443 ;; When contents start on the middle of a line (e.g. in
24444 ;; items and footnote definitions), try to reach first
24445 ;; element starting after current line.
24446 ((> (line-end-position) contents-begin)
24448 (org-forward-paragraph))
24449 (t (goto-char contents-begin)))))
24451 (defun org-backward-paragraph ()
24452 "Move backward to start of previous paragraph or equivalent.
24454 The function moves point to the beginning of the current
24455 structural element, which can be a paragraph, a table, a list
24456 item, etc., or to the beginning of the previous visible one if
24457 point is already there. It also provides some special moves for
24460 - On an affiliated keyword, jump to the first one.
24461 - On a table or a property drawer, move to its beginning.
24462 - On a verse or source block, stop before blank lines."
24464 (when (bobp) (user-error "Cannot move further up"))
24465 (let* ((deactivate-mark nil)
24466 (element (org-element-at-point))
24467 (type (org-element-type element))
24468 (contents-begin (org-element-property :contents-begin element))
24469 (contents-end (org-element-property :contents-end element))
24470 (post-affiliated (org-element-property :post-affiliated element))
24471 (begin (org-element-property :begin element)))
24473 ((not element) (goto-char (point-min)))
24476 (org-backward-paragraph))
24477 ((<= (point) post-affiliated) (goto-char begin))
24478 ((memq type '(node-property table-row))
24479 (goto-char (org-element-property
24480 :post-affiliated (org-element-property :parent element))))
24481 ((memq type '(property-drawer table)) (goto-char begin))
24482 ((memq type '(src-block verse-block))
24483 (when (eq type 'src-block)
24484 (setq contents-begin
24485 (save-excursion (goto-char begin) (forward-line) (point))))
24486 (if (= (point) contents-begin) (goto-char post-affiliated)
24487 ;; Inside a verse block, see blank lines as paragraph
24489 (let ((origin (point)))
24490 (skip-chars-backward " \r\t\n" contents-begin)
24491 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24492 (skip-chars-forward " \r\t\n" origin)
24493 (if (= (point) origin) (goto-char contents-begin)
24494 (beginning-of-line))))))
24495 ((not contents-begin) (goto-char (or post-affiliated begin)))
24496 ((eq type 'paragraph)
24497 (goto-char contents-begin)
24498 ;; When at first paragraph in an item or a footnote definition,
24499 ;; move directly to beginning of line.
24500 (let ((parent-contents
24501 (org-element-property
24502 :contents-begin (org-element-property :parent element))))
24503 (when (and parent-contents (= parent-contents contents-begin))
24504 (beginning-of-line))))
24505 ;; At the end of a greater element, move to the beginning of the
24506 ;; last element within.
24507 ((>= (point) contents-end)
24508 (goto-char (1- contents-end))
24509 (org-backward-paragraph))
24510 (t (goto-char (or post-affiliated begin))))
24511 ;; Ensure we never leave point invisible.
24512 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24514 (defun org-forward-element ()
24515 "Move forward by one element.
24516 Move to the next element at the same level, when possible."
24518 (cond ((eobp) (user-error "Cannot move further down"))
24519 ((org-with-limited-levels (org-at-heading-p))
24520 (let ((origin (point)))
24521 (goto-char (org-end-of-subtree nil t))
24522 (unless (org-with-limited-levels (org-at-heading-p))
24524 (user-error "Cannot move further down"))))
24526 (let* ((elem (org-element-at-point))
24527 (end (org-element-property :end elem))
24528 (parent (org-element-property :parent elem)))
24529 (cond ((and parent (= (org-element-property :contents-end parent) end))
24530 (goto-char (org-element-property :end parent)))
24531 ((integer-or-marker-p end) (goto-char end))
24532 (t (message "No element at point")))))))
24534 (defun org-backward-element ()
24535 "Move backward by one element.
24536 Move to the previous element at the same level, when possible."
24538 (cond ((bobp) (user-error "Cannot move further up"))
24539 ((org-with-limited-levels (org-at-heading-p))
24540 ;; At a headline, move to the previous one, if any, or stay
24542 (let ((origin (point)))
24543 (org-with-limited-levels (org-backward-heading-same-level 1))
24544 ;; When current headline has no sibling above, move to its
24546 (when (= (point) origin)
24547 (or (org-with-limited-levels (org-up-heading-safe))
24548 (progn (goto-char origin)
24549 (user-error "Cannot move further up"))))))
24551 (let* ((elem (org-element-at-point))
24552 (beg (org-element-property :begin elem)))
24554 ;; Move to beginning of current element if point isn't
24556 ((null beg) (message "No element at point"))
24557 ((/= (point) beg) (goto-char beg))
24559 (skip-chars-backward " \r\t\n")
24561 (let ((prev (org-element-at-point)))
24562 (goto-char (org-element-property :begin prev))
24563 (while (and (setq prev (org-element-property :parent prev))
24564 (<= (org-element-property :end prev) beg))
24565 (goto-char (org-element-property :begin prev)))))))))))
24567 (defun org-up-element ()
24568 "Move to upper element."
24570 (if (org-with-limited-levels (org-at-heading-p))
24571 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24572 (let* ((elem (org-element-at-point))
24573 (parent (org-element-property :parent elem)))
24574 (if parent (goto-char (org-element-property :begin parent))
24575 (if (org-with-limited-levels (org-before-first-heading-p))
24576 (user-error "No surrounding element")
24577 (org-with-limited-levels (org-back-to-heading)))))))
24579 (defvar org-element-greater-elements)
24580 (defun org-down-element ()
24581 "Move to inner element."
24583 (let ((element (org-element-at-point)))
24585 ((memq (org-element-type element) '(plain-list table))
24586 (goto-char (org-element-property :contents-begin element))
24588 ((memq (org-element-type element) org-element-greater-elements)
24589 ;; If contents are hidden, first disclose them.
24590 (when (outline-invisible-p (line-end-position)) (org-cycle))
24591 (goto-char (or (org-element-property :contents-begin element)
24592 (user-error "No content for this element"))))
24593 (t (user-error "No inner element")))))
24595 (defun org-drag-element-backward ()
24596 "Move backward element at point."
24598 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24599 (let* ((elem (org-element-at-point))
24602 (goto-char (org-element-property :begin elem))
24603 (skip-chars-backward " \r\t\n")
24605 (let* ((beg (org-element-property :begin elem))
24606 (prev (org-element-at-point))
24608 (while (and (setq up (org-element-property :parent up))
24609 (<= (org-element-property :end up) beg))
24612 ;; Error out if no previous element or previous element is
24613 ;; a parent of the current one.
24614 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24615 (user-error "Cannot drag element backward")
24616 (let ((pos (point)))
24617 (org-element-swap-A-B prev-elem elem)
24618 (goto-char (+ (org-element-property :begin prev-elem)
24619 (- pos (org-element-property :begin elem)))))))))
24621 (defun org-drag-element-forward ()
24622 "Move forward element at point."
24624 (let* ((pos (point))
24625 (elem (org-element-at-point)))
24626 (when (= (point-max) (org-element-property :end elem))
24627 (user-error "Cannot drag element forward"))
24628 (goto-char (org-element-property :end elem))
24629 (let ((next-elem (org-element-at-point)))
24630 (when (or (org-element-nested-p elem next-elem)
24631 (and (eq (org-element-type next-elem) 'headline)
24632 (not (eq (org-element-type elem) 'headline))))
24634 (user-error "Cannot drag element forward"))
24635 ;; Compute new position of point: it's shifted by NEXT-ELEM
24636 ;; body's length (without final blanks) and by the length of
24637 ;; blanks between ELEM and NEXT-ELEM.
24638 (let ((size-next (- (save-excursion
24639 (goto-char (org-element-property :end next-elem))
24640 (skip-chars-backward " \r\t\n")
24642 ;; Small correction if buffer doesn't end
24643 ;; with a newline character.
24644 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24645 (org-element-property :begin next-elem)))
24646 (size-blank (- (org-element-property :end elem)
24648 (goto-char (org-element-property :end elem))
24649 (skip-chars-backward " \r\t\n")
24652 (org-element-swap-A-B elem next-elem)
24653 (goto-char (+ pos size-next size-blank))))))
24655 (defun org-drag-line-forward (arg)
24656 "Drag the line at point ARG lines forward."
24658 (dotimes (n (abs arg))
24659 (let ((c (current-column)))
24662 (beginning-of-line 2)
24663 (transpose-lines 1)
24664 (beginning-of-line 0))
24665 (transpose-lines 1)
24666 (beginning-of-line -1))
24667 (org-move-to-column c))))
24669 (defun org-drag-line-backward (arg)
24670 "Drag the line at point ARG lines backward."
24672 (org-drag-line-forward (- arg)))
24674 (defun org-mark-element ()
24675 "Put point at beginning of this element, mark at end.
24677 Interactively, if this command is repeated or (in Transient Mark
24678 mode) if the mark is active, it marks the next element after the
24679 ones already marked."
24681 (let (deactivate-mark)
24682 (if (and (org-called-interactively-p 'any)
24683 (or (and (eq last-command this-command) (mark t))
24684 (and transient-mark-mode mark-active)))
24688 (goto-char (org-element-property :end (org-element-at-point)))))
24689 (let ((element (org-element-at-point)))
24691 (push-mark (org-element-property :end element) t t)
24692 (goto-char (org-element-property :begin element))))))
24694 (defun org-narrow-to-element ()
24695 "Narrow buffer to current element."
24697 (let ((elem (org-element-at-point)))
24699 ((eq (car elem) 'headline)
24701 (org-element-property :begin elem)
24702 (org-element-property :end elem)))
24703 ((memq (car elem) org-element-greater-elements)
24705 (org-element-property :contents-begin elem)
24706 (org-element-property :contents-end elem)))
24709 (org-element-property :begin elem)
24710 (org-element-property :end elem))))))
24712 (defun org-transpose-element ()
24713 "Transpose current and previous elements, keeping blank lines between.
24714 Point is moved after both elements."
24716 (org-skip-whitespace)
24717 (let ((end (org-element-property :end (org-element-at-point))))
24718 (org-drag-element-backward)
24721 (defun org-unindent-buffer ()
24722 "Un-indent the visible part of the buffer.
24723 Relative indentation (between items, inside blocks, etc.) isn't
24726 (unless (eq major-mode 'org-mode)
24727 (user-error "Cannot un-indent a buffer not in Org mode"))
24728 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24729 unindent-tree ; For byte-compiler.
24735 (if (memq (org-element-type element) '(headline section))
24736 (funcall unindent-tree (org-element-contents element))
24740 (org-element-property :begin element)
24741 (org-element-property :end element))
24742 (org-do-remove-indentation)))))
24743 (reverse contents))))))
24744 (funcall unindent-tree (org-element-contents parse-tree))))
24746 (defun org-show-subtree ()
24747 "Show everything after this heading at deeper levels."
24749 (outline-flag-region
24752 (org-end-of-subtree t t))
24755 (defun org-show-entry ()
24756 "Show the body directly following this heading.
24757 Show the heading too, if it is currently invisible."
24761 (org-back-to-heading t)
24762 (outline-flag-region
24763 (max (point-min) (1- (point)))
24765 (if (re-search-forward
24766 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24767 (match-beginning 1)
24770 (org-cycle-hide-drawers 'children))))
24772 (defun org-make-options-regexp (kwds &optional extra)
24773 "Make a regular expression for keyword lines.
24774 KWDS is a list of keywords, as strings. Optional argument EXTRA,
24775 when non-nil, is a regexp matching keywords names."
24776 (concat "^[ \t]*#\\+\\("
24778 (and extra (concat (and kwds "\\|") extra))
24779 "\\):[ \t]*\\(.*\\)"))
24781 ;; Make isearch reveal the necessary context
24782 (defun org-isearch-end ()
24783 "Reveal context after isearch exits."
24784 (when isearch-success ; only if search was successful
24785 (if (featurep 'xemacs)
24786 ;; Under XEmacs, the hook is run in the correct place,
24787 ;; we directly show the context.
24788 (org-show-context 'isearch)
24789 ;; In Emacs the hook runs *before* restoring the overlays.
24790 ;; So we have to use a one-time post-command-hook to do this.
24791 ;; (Emacs 22 has a special variable, see function `org-mode')
24792 (unless (and (boundp 'isearch-mode-end-hook-quit)
24793 isearch-mode-end-hook-quit)
24794 ;; Only when the isearch was not quitted.
24795 (org-add-hook 'post-command-hook 'org-isearch-post-command
24796 'append 'local)))))
24798 (defun org-isearch-post-command ()
24799 "Remove self from hook, and show context."
24800 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24801 (org-show-context 'isearch))
24804 ;;;; Integration with and fixes for other packages
24808 (defvar org-imenu-markers nil
24809 "All markers currently used by Imenu.")
24810 (make-variable-buffer-local 'org-imenu-markers)
24812 (defun org-imenu-new-marker (&optional pos)
24813 "Return a new marker for use by Imenu, and remember the marker."
24814 (let ((m (make-marker)))
24815 (move-marker m (or pos (point)))
24816 (push m org-imenu-markers)
24819 (defun org-imenu-get-tree ()
24820 "Produce the index for Imenu."
24821 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24822 (setq org-imenu-markers nil)
24823 (let* ((n org-imenu-depth)
24824 (re (concat "^" (org-get-limited-outline-regexp)))
24825 (subs (make-vector (1+ n) nil))
24827 m level head0 head)
24831 (goto-char (point-max))
24832 (while (re-search-backward re nil t)
24833 (setq level (org-reduced-level (funcall outline-level)))
24834 (when (and (<= level n)
24835 (looking-at org-complex-heading-regexp)
24836 (setq head0 (org-match-string-no-properties 4)))
24837 (setq head (org-link-display-format head0)
24838 m (org-imenu-new-marker))
24839 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24840 (if (>= level last-level)
24841 (push (cons head m) (aref subs level))
24842 (push (cons head (aref subs (1+ level))) (aref subs level))
24843 (loop for i from (1+ level) to n do (aset subs i nil)))
24844 (setq last-level level)))))
24847 (eval-after-load "imenu"
24849 (add-hook 'imenu-after-jump-hook
24851 (if (derived-mode-p 'org-mode)
24852 (org-show-context 'org-goto))))))
24854 (defun org-link-display-format (link)
24855 "Replace a link with its the description.
24856 If there is no description, use the link target."
24858 (if (string-match org-bracket-link-analytic-regexp link)
24859 (replace-match (if (match-end 5)
24860 (match-string 5 link)
24861 (concat (match-string 1 link)
24862 (match-string 3 link)))
24866 (defun org-toggle-link-display ()
24867 "Toggle the literal or descriptive display of links."
24869 (if org-descriptive-links
24870 (progn (org-remove-from-invisibility-spec '(org-link))
24871 (org-restart-font-lock)
24872 (setq org-descriptive-links nil))
24873 (progn (add-to-invisibility-spec '(org-link))
24874 (org-restart-font-lock)
24875 (setq org-descriptive-links t))))
24877 ;; Speedbar support
24879 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24880 "Overlay marking the agenda restriction line in speedbar.")
24881 (overlay-put org-speedbar-restriction-lock-overlay
24882 'face 'org-agenda-restriction-lock)
24883 (overlay-put org-speedbar-restriction-lock-overlay
24884 'help-echo "Agendas are currently limited to this item.")
24885 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24887 (defun org-speedbar-set-agenda-restriction ()
24888 "Restrict future agenda commands to the location at point in speedbar.
24889 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24891 (require 'org-agenda)
24892 (let (p m tp np dir txt)
24894 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24896 (setq m (get-text-property p 'org-imenu-marker))
24897 (with-current-buffer (marker-buffer m)
24899 (org-agenda-set-restriction-lock 'subtree)))
24900 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24901 'speedbar-function 'speedbar-find-file))
24902 (setq tp (previous-single-property-change
24903 (1+ p) 'speedbar-function)
24904 np (next-single-property-change
24905 tp 'speedbar-function)
24906 dir (speedbar-line-directory)
24907 txt (buffer-substring-no-properties (or tp (point-min))
24908 (or np (point-max))))
24909 (with-current-buffer (find-file-noselect
24910 (let ((default-directory dir))
24911 (expand-file-name txt)))
24912 (unless (derived-mode-p 'org-mode)
24913 (user-error "Cannot restrict to non-Org-mode file"))
24914 (org-agenda-set-restriction-lock 'file)))
24915 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24916 (move-overlay org-speedbar-restriction-lock-overlay
24917 (point-at-bol) (point-at-eol))
24918 (setq current-prefix-arg nil)
24919 (org-agenda-maybe-redo)))
24921 (defvar speedbar-file-key-map)
24922 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24923 (eval-after-load "speedbar"
24925 (speedbar-add-supported-extension ".org")
24926 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24927 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24928 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24929 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24930 (add-hook 'speedbar-visiting-tag-hook
24931 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24933 ;;; Fixes and Hacks for problems with other packages
24935 (defun org--flyspell-object-check-p (element)
24936 "Non-nil when Flyspell can check object at point.
24937 ELEMENT is the element at point."
24938 (let ((object (save-excursion
24939 (when (org-looking-at-p "\\>") (backward-char))
24940 (org-element-context element))))
24941 (case (org-element-type object)
24942 ;; Prevent checks in links due to keybinding conflict with
24944 ((code entity export-snippet inline-babel-call
24945 inline-src-block line-break latex-fragment link macro
24946 statistics-cookie target timestamp verbatim)
24948 (footnote-reference
24949 ;; Only in inline footnotes, within the definition.
24950 (and (eq (org-element-property :type object) 'inline)
24952 (goto-char (org-element-property :begin object))
24953 (search-forward ":" nil t 2))
24957 (defun org-mode-flyspell-verify ()
24958 "Function used for `flyspell-generic-check-word-predicate'."
24959 (if (org-at-heading-p)
24960 ;; At a headline or an inlinetask, check title only. This is
24961 ;; faster than relying on `org-element-at-point'.
24962 (and (save-excursion (beginning-of-line)
24963 (and (let ((case-fold-search t))
24964 (not (looking-at "\\*+ END[ \t]*$")))
24965 (looking-at org-complex-heading-regexp)))
24966 (match-beginning 4)
24967 (>= (point) (match-beginning 4))
24968 (or (not (match-beginning 5))
24969 (< (point) (match-beginning 5))))
24970 (let* ((element (org-element-at-point))
24971 (post-affiliated (org-element-property :post-affiliated element)))
24973 ;; Ignore checks in all affiliated keywords but captions.
24974 ((< (point) post-affiliated)
24975 (and (save-excursion
24976 (beginning-of-line)
24977 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24978 (> (point) (match-end 0))
24979 (org--flyspell-object-check-p element)))
24980 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24981 ((let ((log (org-log-into-drawer)))
24983 (let ((drawer (org-element-lineage element '(drawer))))
24985 (eq (compare-strings
24987 (org-element-property :drawer-name drawer) nil nil t)
24991 (case (org-element-type element)
24992 ((comment quote-section) t)
24994 ;; Allow checks between block markers, not on them.
24995 (and (> (line-beginning-position) post-affiliated)
24998 (skip-chars-forward " \r\t\n")
24999 (< (point) (org-element-property :end element)))))
25000 ;; Arbitrary list of keywords where checks are meaningful.
25001 ;; Make sure point is on the value part of the element.
25003 (and (member (org-element-property :key element)
25004 '("DESCRIPTION" "TITLE"))
25006 (search-backward ":" (line-beginning-position) t))))
25007 ;; Check is globally allowed in paragraphs verse blocks and
25008 ;; table rows (after affiliated keywords) but some objects
25009 ;; must not be affected.
25010 ((paragraph table-row verse-block)
25011 (let ((cbeg (org-element-property :contents-begin element))
25012 (cend (org-element-property :contents-end element)))
25013 (and cbeg (>= (point) cbeg) (< (point) cend)
25014 (org--flyspell-object-check-p element))))))))))
25015 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
25017 (defun org-remove-flyspell-overlays-in (beg end)
25018 "Remove flyspell overlays in region."
25019 (and (org-bound-and-true-p flyspell-mode)
25020 (fboundp 'flyspell-delete-region-overlays)
25021 (flyspell-delete-region-overlays beg end)))
25023 (defvar flyspell-delayed-commands)
25024 (eval-after-load "flyspell"
25025 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
25027 ;; Make `bookmark-jump' shows the jump location if it was hidden.
25028 (eval-after-load "bookmark"
25029 '(if (boundp 'bookmark-after-jump-hook)
25030 ;; We can use the hook
25031 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
25032 ;; Hook not available, use advice
25033 (defadvice bookmark-jump (after org-make-visible activate)
25034 "Make the position visible."
25035 (org-bookmark-jump-unhide))))
25037 ;; Make sure saveplace shows the location if it was hidden
25038 (eval-after-load "saveplace"
25039 '(defadvice save-place-find-file-hook (after org-make-visible activate)
25040 "Make the position visible."
25041 (org-bookmark-jump-unhide)))
25043 ;; Make sure ecb shows the location if it was hidden
25044 (eval-after-load "ecb"
25045 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
25046 "Make hierarchy visible when jumping into location from ECB tree buffer."
25047 (if (derived-mode-p 'org-mode)
25048 (org-show-context))))
25050 (defun org-bookmark-jump-unhide ()
25051 "Unhide the current position, to show the bookmark location."
25052 (and (derived-mode-p 'org-mode)
25053 (or (outline-invisible-p)
25054 (save-excursion (goto-char (max (point-min) (1- (point))))
25055 (outline-invisible-p)))
25056 (org-show-context 'bookmark-jump)))
25058 (defun org-mark-jump-unhide ()
25059 "Make the point visible with `org-show-context' after jumping to the mark."
25060 (when (and (derived-mode-p 'org-mode)
25061 (outline-invisible-p))
25062 (org-show-context 'mark-goto)))
25064 (eval-after-load "simple"
25065 '(defadvice pop-to-mark-command (after org-make-visible activate)
25066 "Make the point visible with `org-show-context'."
25067 (org-mark-jump-unhide)))
25069 (eval-after-load "simple"
25070 '(defadvice exchange-point-and-mark (after org-make-visible activate)
25071 "Make the point visible with `org-show-context'."
25072 (org-mark-jump-unhide)))
25074 (eval-after-load "simple"
25075 '(defadvice pop-global-mark (after org-make-visible activate)
25076 "Make the point visible with `org-show-context'."
25077 (org-mark-jump-unhide)))
25079 ;; Make session.el ignore our circular variable
25080 (defvar session-globals-exclude)
25081 (eval-after-load "session"
25082 '(add-to-list 'session-globals-exclude 'org-mark-ring))
25088 (run-hooks 'org-load-hook)
25090 ;;; org.el ends here