1 ;;; org.el --- Outline-based notes management and organizer
3 ;; Carstens outline-mode for keeping track of everything.
4 ;; Copyright (C) 2004-2014 Free Software Foundation, Inc.
6 ;; Author: Carsten Dominik <carsten at orgmode dot org>
7 ;; Maintainer: Carsten Dominik <carsten at orgmode dot org>
8 ;; Keywords: outlines, hypermedia, calendar, wp
9 ;; Homepage: http://orgmode.org
11 ;; This file is part of GNU Emacs.
13 ;; GNU Emacs is free software: you can redistribute it and/or modify
14 ;; it under the terms of the GNU General Public License as published by
15 ;; the Free Software Foundation, either version 3 of the License, or
16 ;; (at your option) any later version.
18 ;; GNU Emacs is distributed in the hope that it will be useful,
19 ;; but WITHOUT ANY WARRANTY; without even the implied warranty of
20 ;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
21 ;; GNU General Public License for more details.
23 ;; You should have received a copy of the GNU General Public License
24 ;; along with GNU Emacs. If not, see <http://www.gnu.org/licenses/>.
28 ;; Org-mode is a mode for keeping notes, maintaining ToDo lists, and doing
29 ;; project planning with a fast and effective plain-text system.
31 ;; Org-mode develops organizational tasks around NOTES files that contain
32 ;; information about projects as plain text. Org-mode is implemented on
33 ;; top of outline-mode, which makes it possible to keep the content of
34 ;; large files well structured. Visibility cycling and structure editing
35 ;; help to work with the tree. Tables are easily created with a built-in
36 ;; table editor. Org-mode supports ToDo items, deadlines, time stamps,
37 ;; and scheduling. It dynamically compiles entries into an agenda that
38 ;; utilizes and smoothly integrates much of the Emacs calendar and diary.
39 ;; Plain text URL-like links connect to websites, emails, Usenet
40 ;; messages, BBDB entries, and any files related to the projects. For
41 ;; printing and sharing of notes, an Org-mode file can be exported as a
42 ;; structured ASCII file, as HTML, or (todo and agenda items only) as an
43 ;; iCalendar file. It can also serve as a publishing tool for a set of
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
54 ;; The documentation of Org-mode can be found in the TeXInfo file. The
55 ;; distribution also contains a PDF version of it. At the homepage of
56 ;; Org-mode, you can read the same text online as HTML. There is also an
57 ;; excellent reference card made by Philip Rooke. This card can be found
58 ;; in the etc/ directory of Emacs 22.
60 ;; A list of recent changes can be found at
61 ;; http://orgmode.org/Changes.html
65 (defvar org-inhibit-highlight-removal nil
) ; dynamically scoped param
66 (defvar org-table-formula-constants-local nil
67 "Local version of `org-table-formula-constants'.")
68 (make-variable-buffer-local 'org-table-formula-constants-local
)
70 ;;;; Require other packages
78 (require 'format-spec
)
80 (or (equal this-command
'eval-buffer
)
82 (load (concat (file-name-directory load-file-name
)
86 (message "WARNING: No org-loaddefs.el file could be found from where org.el is loaded.")
88 (message "You need to run \"make\" or \"make autoloads\" from Org lisp directory")
94 (declare-function cdlatex-environment
"ext:cdlatex" (environment item
))
96 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
97 ;; some places -- e.g. see the macro `org-with-limited-levels'.
99 ;; In Org buffers, the value of `outline-regexp' is that of
100 ;; `org-outline-regexp'. The only function still directly relying on
101 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
102 ;; job when `orgstruct-mode' is active.
103 (defvar org-outline-regexp
"\\*+ "
104 "Regexp to match Org headlines.")
106 (defvar org-outline-regexp-bol
"^\\*+ "
107 "Regexp to match Org headlines.
108 This is similar to `org-outline-regexp' but additionally makes
109 sure that we are at the beginning of the line.")
111 (defvar org-heading-regexp
"^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
112 "Matches a headline, putting stars and text into groups.
113 Stars are put in group 1 and the trimmed body in group 2.")
115 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
116 (unless (boundp 'calendar-view-holidays-initially-flag
)
117 (org-defvaralias 'calendar-view-holidays-initially-flag
118 'view-calendar-holidays-initially
))
119 (unless (boundp 'calendar-view-diary-initially-flag
)
120 (org-defvaralias 'calendar-view-diary-initially-flag
121 'view-diary-entries-initially
))
122 (unless (boundp 'diary-fancy-buffer
)
123 (org-defvaralias 'diary-fancy-buffer
'fancy-diary-buffer
))
125 (declare-function org-add-archive-files
"org-archive" (files))
127 (declare-function org-inlinetask-at-task-p
"org-inlinetask" ())
128 (declare-function org-inlinetask-outline-regexp
"org-inlinetask" ())
129 (declare-function org-inlinetask-toggle-visibility
"org-inlinetask" ())
130 (declare-function org-pop-to-buffer-same-window
"org-compat" (&optional buffer-or-name norecord label
))
131 (declare-function org-clock-get-last-clock-out-time
"org-clock" ())
132 (declare-function org-clock-timestamps-up
"org-clock" (&optional n
))
133 (declare-function org-clock-timestamps-down
"org-clock" (&optional n
))
134 (declare-function org-clock-remove-overlays
"org-clock" (&optional beg end noremove
))
135 (declare-function org-clock-sum
"org-clock" (&optional tstart tend headline-filter propname
))
136 (declare-function org-clock-sum-current-item
"org-clock" (&optional tstart
))
137 (declare-function org-clock-update-time-maybe
"org-clock" ())
138 (declare-function org-clocktable-shift
"org-clock" (dir n
))
140 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
141 (declare-function org-babel-do-in-edit-buffer
"ob-core" (&rest body
))
142 (declare-function orgtbl-mode
"org-table" (&optional arg
))
143 (declare-function org-clock-out
"org-clock" (&optional switch-to-state fail-quietly at-time
))
144 (declare-function org-beamer-mode
"ox-beamer" ())
145 (declare-function org-table-blank-field
"org-table" ())
146 (declare-function org-table-edit-field
"org-table" (arg))
147 (declare-function org-table-insert-row
"org-table" (&optional arg
))
148 (declare-function org-table-justify-field-maybe
"org-table" (&optional new
))
149 (declare-function org-table-set-constants
"org-table" ())
150 (declare-function org-table-calc-current-TBLFM
"org-table" (&optional arg
))
151 (declare-function org-id-get-create
"org-id" (&optional force
))
152 (declare-function org-add-archive-files
"org-archive" (files))
153 (declare-function org-id-find-id-file
"org-id" (id))
154 (declare-function org-tags-view
"org-agenda" (&optional todo-only match
))
155 (declare-function org-agenda-list
"org-agenda" (&optional arg start-day span
))
156 (declare-function org-agenda-redo
"org-agenda" (&optional all
))
157 (declare-function org-table-align
"org-table" ())
158 (declare-function org-table-begin
"org-table" (&optional table-type
))
159 (declare-function org-table-blank-field
"org-table" ())
160 (declare-function org-table-end
"org-table" (&optional table-type
))
161 (declare-function org-table-end-of-field
"org-table" (&optional n
))
162 (declare-function org-table-insert-row
"org-table" (&optional arg
))
163 (declare-function org-table-paste-rectangle
"org-table" ())
164 (declare-function org-table-maybe-eval-formula
"org-table" ())
165 (declare-function org-table-maybe-recalculate-line
"org-table" ())
167 (declare-function org-element-at-point
"org-element" ())
168 (declare-function org-element-cache-reset
"org-element" (&optional all
))
169 (declare-function org-element-cache-refresh
"org-element" (pos))
170 (declare-function org-element-contents
"org-element" (element))
171 (declare-function org-element-context
"org-element" (&optional element
))
172 (declare-function org-element-interpret-data
"org-element"
173 (data &optional parent
))
174 (declare-function org-element-nested-p
"org-element" (elem-a elem-b
))
175 (declare-function org-element-parse-buffer
"org-element"
176 (&optional granularity visible-only
))
177 (declare-function org-element-property
"org-element" (property element
))
178 (declare-function org-element-put-property
"org-element"
179 (element property value
))
180 (declare-function org-element-swap-A-B
"org-element" (elem-a elem-b
))
181 (declare-function org-element-parse-buffer
"org-element"
182 (&optional granularity visible-only
))
183 (declare-function org-element-type
"org-element" (element))
185 (defsubst org-uniquify
(list)
186 "Non-destructively remove duplicate elements from LIST."
187 (let ((res (copy-sequence list
))) (delete-dups res
)))
189 (defsubst org-get-at-bol
(property)
190 "Get text property PROPERTY at the beginning of line."
191 (get-text-property (point-at-bol) property
))
193 (defsubst org-trim
(s)
194 "Remove whitespace at the beginning and the end of string S."
195 (replace-regexp-in-string
197 (replace-regexp-in-string "[ \t\n\r]+\\'" "" s
)))
199 ;; load languages based on value of `org-babel-load-languages'
200 (defvar org-babel-load-languages
)
203 (defun org-babel-do-load-languages (sym value
)
204 "Load the languages defined in `org-babel-load-languages'."
205 (set-default sym value
)
207 (let ((active (cdr pair
)) (lang (symbol-name (car pair
))))
210 (require (intern (concat "ob-" lang
))))
212 (funcall 'fmakunbound
213 (intern (concat "org-babel-execute:" lang
)))
214 (funcall 'fmakunbound
215 (intern (concat "org-babel-expand-body:" lang
)))))))
216 org-babel-load-languages
))
218 (declare-function org-babel-tangle-file
"ob-tangle" (file &optional target-file lang
))
220 (defun org-babel-load-file (file &optional compile
)
221 "Load Emacs Lisp source code blocks in the Org-mode FILE.
222 This function exports the source code using `org-babel-tangle'
223 and then loads the resulting file using `load-file'. With prefix
224 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
225 file to byte-code before it is loaded."
226 (interactive "fFile to load: \nP")
227 (let* ((age (lambda (file)
229 (time-subtract (current-time)
230 (nth 5 (or (file-attributes (file-truename file
))
231 (file-attributes file
)))))))
232 (base-name (file-name-sans-extension file
))
233 (exported-file (concat base-name
".el")))
234 ;; tangle if the org-mode file is newer than the elisp file
235 (unless (and (file-exists-p exported-file
)
236 (> (funcall age file
) (funcall age exported-file
)))
238 (car (org-babel-tangle-file file exported-file
"emacs-lisp"))))
241 (progn (byte-compile-file exported-file
'load
)
242 "Compiled and loaded")
243 (progn (load-file exported-file
) "Loaded"))
246 (defcustom org-babel-load-languages
'((emacs-lisp . t
))
247 "Languages which can be evaluated in Org-mode buffers.
248 This list can be used to load support for any of the languages
249 below, note that each language will depend on a different set of
250 system executables and/or Emacs modes. When a language is
251 \"loaded\", then code blocks in that language can be evaluated
252 with `org-babel-execute-src-block' bound by default to C-c
253 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
254 be set to remove code block evaluation from the C-c C-c
255 keybinding. By default only Emacs Lisp (which has no
256 requirements) is loaded."
258 :set
'org-babel-do-load-languages
260 :type
'(alist :tag
"Babel Languages"
263 (const :tag
"Awk" awk
)
266 (const :tag
"Asymptote" asymptote
)
267 (const :tag
"Calc" calc
)
268 (const :tag
"Clojure" clojure
)
269 (const :tag
"CSS" css
)
270 (const :tag
"Ditaa" ditaa
)
271 (const :tag
"Dot" dot
)
272 (const :tag
"Emacs Lisp" emacs-lisp
)
273 (const :tag
"Forth" forth
)
274 (const :tag
"Fortran" fortran
)
275 (const :tag
"Gnuplot" gnuplot
)
276 (const :tag
"Haskell" haskell
)
279 (const :tag
"Java" java
)
280 (const :tag
"Javascript" js
)
281 (const :tag
"LaTeX" latex
)
282 (const :tag
"Ledger" ledger
)
283 (const :tag
"Lilypond" lilypond
)
284 (const :tag
"Lisp" lisp
)
285 (const :tag
"Makefile" makefile
)
286 (const :tag
"Maxima" maxima
)
287 (const :tag
"Matlab" matlab
)
288 (const :tag
"Mscgen" mscgen
)
289 (const :tag
"Ocaml" ocaml
)
290 (const :tag
"Octave" octave
)
291 (const :tag
"Org" org
)
292 (const :tag
"Perl" perl
)
293 (const :tag
"Pico Lisp" picolisp
)
294 (const :tag
"PlantUML" plantuml
)
295 (const :tag
"Python" python
)
296 (const :tag
"Ruby" ruby
)
297 (const :tag
"Sass" sass
)
298 (const :tag
"Scala" scala
)
299 (const :tag
"Scheme" scheme
)
300 (const :tag
"Screen" screen
)
301 (const :tag
"Shell Script" shell
)
302 (const :tag
"Shen" shen
)
303 (const :tag
"Sql" sql
)
304 (const :tag
"Sqlite" sqlite
)
305 (const :tag
"ebnf2ps" ebnf2ps
))
306 :value-type
(boolean :tag
"Activate" :value t
)))
308 ;;;; Customization variables
309 (defcustom org-clone-delete-id nil
310 "Remove ID property of clones of a subtree.
311 When non-nil, clones of a subtree don't inherit the ID property.
312 Otherwise they inherit the ID property with a new unique
322 (defun org-version (&optional here full message
)
323 "Show the org-mode version.
324 Interactively, or when MESSAGE is non-nil, show it in echo area.
325 With prefix argument, or when HERE is non-nil, insert it at point.
326 In non-interactive uses, a reduced version string is output unless
328 (interactive (list current-prefix-arg t
(not current-prefix-arg
)))
329 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
330 (save-load-suffixes (when (boundp 'load-suffixes
) load-suffixes
))
331 (load-suffixes (list ".el"))
332 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
334 (and (fboundp 'org-release
) (fboundp 'org-git-version
))
335 (org-load-noerror-mustsuffix (concat org-dir
"org-version"))))
336 (load-suffixes save-load-suffixes
)
337 (org-version (org-release))
338 (git-version (org-git-version))
339 (version (format "Org-mode version %s (%s @ %s)"
343 (if (string= org-dir org-install-dir
)
345 (concat "mixed installation! " org-install-dir
" and " org-dir
))
346 "org-loaddefs.el can not be found!")))
347 (version1 (if full version org-version
)))
348 (when here
(insert version1
))
349 (when message
(message "%s" version1
))
352 (defconst org-version
(org-version))
359 (defconst org-block-regexp
360 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
361 "Regular expression for hiding blocks.")
363 (defconst org-dblock-start-re
364 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
365 "Matches the start line of a dynamic block, with parameters.")
367 (defconst org-dblock-end-re
"^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
368 "Matches the end of a dynamic block.")
370 ;;;; Clock and Planning
372 (defconst org-clock-string
"CLOCK:"
373 "String used as prefix for timestamps clocking work hours on an item.")
375 (defconst org-closed-string
"CLOSED:"
376 "String used as the prefix for timestamps logging closing a TODO entry.")
378 (defconst org-deadline-string
"DEADLINE:"
379 "String to mark deadline entries.
380 A deadline is this string, followed by a time stamp. Should be a word,
381 terminated by a colon. You can insert a schedule keyword and
382 a timestamp with \\[org-deadline].")
384 (defconst org-scheduled-string
"SCHEDULED:"
385 "String to mark scheduled TODO entries.
386 A schedule is this string, followed by a time stamp. Should be a word,
387 terminated by a colon. You can insert a schedule keyword and
388 a timestamp with \\[org-schedule].")
390 (defconst org-planning-line-re
393 (list org-closed-string org-deadline-string org-scheduled-string
)
395 "Matches a line with planning info.
396 Matched keyword is in group 1.")
398 (defconst org-clock-line-re
399 (concat "^[ \t]*" org-clock-string
)
400 "Matches a line with clock info.")
404 (defconst org-drawer-regexp
"^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
405 "Matches first or last line of a hidden block.
406 Group 1 contains drawer's name or \"END\".")
408 (defconst org-property-start-re
"^[ \t]*:PROPERTIES:[ \t]*$"
409 "Regular expression matching the first line of a property drawer.")
411 (defconst org-property-end-re
"^[ \t]*:END:[ \t]*$"
412 "Regular expression matching the last line of a property drawer.")
414 (defconst org-clock-drawer-start-re
"^[ \t]*:CLOCK:[ \t]*$"
415 "Regular expression matching the first line of a clock drawer.")
417 (defconst org-clock-drawer-end-re
"^[ \t]*:END:[ \t]*$"
418 "Regular expression matching the last line of a clock drawer.")
420 (defconst org-property-drawer-re
421 (concat "\\(" org-property-start-re
"\\)[^\000]*?\\("
422 org-property-end-re
"\\)\n?")
423 "Matches an entire property drawer.")
425 (defconst org-clock-drawer-re
426 (concat "\\(" org-clock-drawer-start-re
"\\)[^\000]*?\\("
427 org-clock-drawer-end-re
"\\)\n?")
428 "Matches an entire clock drawer.")
432 (defconst org-heading-keyword-regexp-format
433 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
434 "Printf format for a regexp matching a headline with some keyword.
435 This regexp will match the headline of any node which has the
436 exact keyword that is put into the format. The keyword isn't in
437 any group by default, but the stars and the body are.")
439 (defconst org-heading-keyword-maybe-regexp-format
440 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
441 "Printf format for a regexp matching a headline, possibly with some keyword.
442 This regexp can match any headline with the specified keyword, or
443 without a keyword. The keyword isn't in any group by default,
444 but the stars and the body are.")
446 (defconst org-archive-tag
"ARCHIVE"
447 "The tag that marks a subtree as archived.
448 An archived subtree does not open during visibility cycling, and does
449 not contribute to the agenda listings.")
451 (defconst org-comment-string
"COMMENT"
452 "Entries starting with this keyword will never be exported.
453 An entry can be toggled between COMMENT and normal with
454 \\[org-toggle-comment].")
457 ;;;; LaTeX Environments and Fragments
459 (defconst org-latex-regexps
460 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t
)
461 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
462 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
463 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
464 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil
)
465 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil
)
466 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil
)
467 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil
))
468 "Regular expressions for matching embedded LaTeX.")
472 (defconst org-effort-property
"Effort"
473 "The property that is being used to keep track of effort estimates.
474 Effort estimates given in this property need to have the format H:MM.")
478 (defconst org-table-any-line-regexp
"^[ \t]*\\(|\\|\\+-[-+]\\)"
479 "Detect an org-type or table-type table.")
481 (defconst org-table-line-regexp
"^[ \t]*|"
482 "Detect an org-type table line.")
484 (defconst org-table-dataline-regexp
"^[ \t]*|[^-]"
485 "Detect an org-type table line.")
487 (defconst org-table-hline-regexp
"^[ \t]*|-"
488 "Detect an org-type table hline.")
490 (defconst org-table1-hline-regexp
"^[ \t]*\\+-[-+]"
491 "Detect a table-type table hline.")
493 (defconst org-table-any-border-regexp
"^[ \t]*[^|+ \t]"
494 "Detect the first line outside a table when searching from within it.
495 This works for both table types.")
497 (defconst org-TBLFM-regexp
"^[ \t]*#\\+TBLFM: "
498 "Detect a #+TBLFM line.")
502 (defconst org-ts-regexp
"<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
503 "Regular expression for fast time stamp matching.")
505 (defconst org-ts-regexp-both
"[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
506 "Regular expression for fast time stamp matching.")
508 (defconst org-ts-regexp0
509 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
510 "Regular expression matching time strings for analysis.
511 This one does not require the space after the date, so it can be used
512 on a string that terminates immediately after the date.")
514 (defconst org-ts-regexp1
"\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
515 "Regular expression matching time strings for analysis.")
517 (defconst org-ts-regexp2
(concat "<" org-ts-regexp1
"[^>\n]\\{0,16\\}>")
518 "Regular expression matching time stamps, with groups.")
520 (defconst org-ts-regexp3
(concat "[[<]" org-ts-regexp1
"[^]>\n]\\{0,16\\}[]>]")
521 "Regular expression matching time stamps (also [..]), with groups.")
523 (defconst org-tr-regexp
(concat org-ts-regexp
"--?-?" org-ts-regexp
)
524 "Regular expression matching a time stamp range.")
526 (defconst org-tr-regexp-both
527 (concat org-ts-regexp-both
"--?-?" org-ts-regexp-both
)
528 "Regular expression matching a time stamp range.")
530 (defconst org-tsr-regexp
(concat org-ts-regexp
"\\(--?-?"
531 org-ts-regexp
"\\)?")
532 "Regular expression matching a time stamp or time stamp range.")
534 (defconst org-tsr-regexp-both
535 (concat org-ts-regexp-both
"\\(--?-?"
536 org-ts-regexp-both
"\\)?")
537 "Regular expression matching a time stamp or time stamp range.
538 The time stamps may be either active or inactive.")
540 (defconst org-repeat-re
541 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
542 "Regular expression for specifying repeated events.
543 After a match, group 1 contains the repeat expression.")
545 (defconst org-time-stamp-formats
'("<%Y-%m-%d %a>" .
"<%Y-%m-%d %a %H:%M>")
546 "Formats for `format-time-string' which are used for time stamps.")
549 ;;; The custom variables
552 "Outline-based notes management and organizer."
557 (defcustom org-mode-hook nil
558 "Mode hook for Org-mode, run after the mode was turned on."
562 (defcustom org-load-hook nil
563 "Hook that is run after org.el has been loaded."
567 (defcustom org-log-buffer-setup-hook nil
568 "Hook that is run after an Org log buffer is created."
573 (defvar org-modules
) ; defined below
574 (defvar org-modules-loaded nil
575 "Have the modules been loaded already?")
577 (defun org-load-modules-maybe (&optional force
)
578 "Load all extensions listed in `org-modules'."
579 (when (or force
(not org-modules-loaded
))
581 (condition-case nil
(require ext
)
582 (error (message "Problems while trying to load feature `%s'" ext
))))
584 (setq org-modules-loaded t
)))
586 (defun org-set-modules (var value
)
587 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
589 (when (featurep 'org
)
590 (org-load-modules-maybe 'force
)
591 (org-element-cache-reset 'all
)))
593 (defcustom org-modules
'(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail
)
594 "Modules that should always be loaded together with org.el.
596 If a description starts with <C>, the file is not part of Emacs
597 and loading it will require that you have downloaded and properly
598 installed the Org mode distribution.
600 You can also use this system to load external packages (i.e. neither Org
601 core modules, nor modules from the CONTRIB directory). Just add symbols
602 to the end of the list. If the package is called org-xyz.el, then you need
603 to add the symbol `xyz', and the package must have a call to:
607 For export specific modules, see also `org-export-backends'."
609 :set
'org-set-modules
611 :package-version
'(Org .
"8.0")
614 (const :tag
" bbdb: Links to BBDB entries" org-bbdb
)
615 (const :tag
" bibtex: Links to BibTeX entries" org-bibtex
)
616 (const :tag
" crypt: Encryption of subtrees" org-crypt
)
617 (const :tag
" ctags: Access to Emacs tags with links" org-ctags
)
618 (const :tag
" docview: Links to doc-view buffers" org-docview
)
619 (const :tag
" gnus: Links to GNUS folders/messages" org-gnus
)
620 (const :tag
" habit: Track your consistency with habits" org-habit
)
621 (const :tag
" id: Global IDs for identifying entries" org-id
)
622 (const :tag
" info: Links to Info nodes" org-info
)
623 (const :tag
" inlinetask: Tasks independent of outline hierarchy" org-inlinetask
)
624 (const :tag
" irc: Links to IRC/ERC chat sessions" org-irc
)
625 (const :tag
" mhe: Links to MHE folders/messages" org-mhe
)
626 (const :tag
" mouse: Additional mouse support" org-mouse
)
627 (const :tag
" protocol: Intercept calls from emacsclient" org-protocol
)
628 (const :tag
" rmail: Links to RMAIL folders/messages" org-rmail
)
629 (const :tag
" w3m: Special cut/paste from w3m to Org-mode." org-w3m
)
631 (const :tag
"C annotate-file: Annotate a file with org syntax" org-annotate-file
)
632 (const :tag
"C bookmark: Org-mode links to bookmarks" org-bookmark
)
633 (const :tag
"C bullets: Add overlays to headlines stars" org-bullets
)
634 (const :tag
"C checklist: Extra functions for checklists in repeated tasks" org-checklist
)
635 (const :tag
"C choose: Use TODO keywords to mark decisions states" org-choose
)
636 (const :tag
"C collector: Collect properties into tables" org-collector
)
637 (const :tag
"C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend
)
638 (const :tag
"C drill: Flashcards and spaced repetition for Org-mode" org-drill
)
639 (const :tag
"C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol
)
640 (const :tag
"C eshell Support for links to working directories in eshell" org-eshell
)
641 (const :tag
"C eval-light: Evaluate inbuffer-code on demand" org-eval-light
)
642 (const :tag
"C eval: Include command output as text" org-eval
)
643 (const :tag
"C expiry: Expiry mechanism for Org-mode entries" org-expiry
)
644 (const :tag
"C favtable: Lookup table of favorite references and links" org-favtable
)
645 (const :tag
"C git-link: Provide org links to specific file version" org-git-link
)
646 (const :tag
"C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query
)
647 (const :tag
"C invoice: Help manage client invoices in Org-mode" org-invoice
)
648 (const :tag
"C jira: Add a jira:ticket protocol to Org-mode" org-jira
)
649 (const :tag
"C learn: SuperMemo's incremental learning algorithm" org-learn
)
650 (const :tag
"C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal
)
651 (const :tag
"C mac-link: Grab links and url from various mac Applications" org-mac-link
)
652 (const :tag
"C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix
)
653 (const :tag
"C man: Support for links to manpages in Org-mode" org-man
)
654 (const :tag
"C mew: Links to Mew folders/messages" org-mew
)
655 (const :tag
"C mtags: Support for muse-like tags" org-mtags
)
656 (const :tag
"C notmuch: Provide org links to notmuch searches or messages" org-notmuch
)
657 (const :tag
"C panel: Simple routines for us with bad memory" org-panel
)
658 (const :tag
"C registry: A registry for Org-mode links" org-registry
)
659 (const :tag
"C screen: Visit screen sessions through Org-mode links" org-screen
)
660 (const :tag
"C secretary: Team management with org-mode" org-secretary
)
661 (const :tag
"C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert
)
662 (const :tag
"C toc: Table of contents for Org-mode buffer" org-toc
)
663 (const :tag
"C track: Keep up with Org-mode development" org-track
)
664 (const :tag
"C velocity Something like Notational Velocity for Org" org-velocity
)
665 (const :tag
"C vm: Links to VM folders/messages" org-vm
)
666 (const :tag
"C wikinodes: CamelCase wiki-like links" org-wikinodes
)
667 (const :tag
"C wl: Links to Wanderlust folders/messages" org-wl
)
668 (repeat :tag
"External packages" :inline t
(symbol :tag
"Package"))))
670 (defvar org-export--registered-backends
) ; From ox.el.
671 (declare-function org-export-derived-backend-p
"ox" (backend &rest backends
))
672 (declare-function org-export-backend-name
"ox" (backend))
673 (defcustom org-export-backends
'(ascii html icalendar latex
)
674 "List of export back-ends that should be always available.
676 If a description starts with <C>, the file is not part of Emacs
677 and loading it will require that you have downloaded and properly
678 installed the Org mode distribution.
680 Unlike to `org-modules', libraries in this list will not be
681 loaded along with Org, but only once the export framework is
684 This variable needs to be set before org.el is loaded. If you
685 need to make a change while Emacs is running, use the customize
686 interface or run the following code, where VAL stands for the new
687 value of the variable, after updating it:
690 \(setq org-export--registered-backends
693 \(let ((name (org-export-backend-name backend)))
697 \(and (org-export-derived-backend-p b name)
698 \(throw 'parentp t)))))))
699 org-export--registered-backends))
700 \(let ((new-list (mapcar 'org-export-backend-name
701 org-export--registered-backends)))
702 \(dolist (backend val)
704 \((not (load (format \"ox-%s\" backend) t t))
705 \(message \"Problems while trying to load export back-end `%s'\"
707 \((not (memq backend new-list)) (push backend new-list))))
708 \(set-default 'org-export-backends new-list)))
710 Adding a back-end to this list will also pull the back-end it
715 :package-version
'(Org .
"8.0")
716 :initialize
'custom-initialize-set
717 :set
(lambda (var val
)
718 (if (not (featurep 'ox
)) (set-default var val
)
719 ;; Any back-end not required anymore (not present in VAL and not
720 ;; a parent of any back-end in the new value) is removed from the
721 ;; list of registered back-ends.
722 (setq org-export--registered-backends
725 (let ((name (org-export-backend-name backend
)))
729 (and (org-export-derived-backend-p b name
)
730 (throw 'parentp t
)))))))
731 org-export--registered-backends
))
732 ;; Now build NEW-LIST of both new back-ends and required
734 (let ((new-list (mapcar 'org-export-backend-name
735 org-export--registered-backends
)))
736 (dolist (backend val
)
738 ((not (load (format "ox-%s" backend
) t t
))
739 (message "Problems while trying to load export back-end `%s'"
741 ((not (memq backend new-list
)) (push backend new-list
))))
742 ;; Set VAR to that list with fixed dependencies.
743 (set-default var new-list
))))
744 :type
'(set :greedy t
745 (const :tag
" ascii Export buffer to ASCII format" ascii
)
746 (const :tag
" beamer Export buffer to Beamer presentation" beamer
)
747 (const :tag
" html Export buffer to HTML format" html
)
748 (const :tag
" icalendar Export buffer to iCalendar format" icalendar
)
749 (const :tag
" latex Export buffer to LaTeX format" latex
)
750 (const :tag
" man Export buffer to MAN format" man
)
751 (const :tag
" md Export buffer to Markdown format" md
)
752 (const :tag
" odt Export buffer to ODT format" odt
)
753 (const :tag
" org Export buffer to Org format" org
)
754 (const :tag
" texinfo Export buffer to Texinfo format" texinfo
)
755 (const :tag
"C confluence Export buffer to Confluence Wiki format" confluence
)
756 (const :tag
"C deck Export buffer to deck.js presentations" deck
)
757 (const :tag
"C freemind Export buffer to Freemind mindmap format" freemind
)
758 (const :tag
"C groff Export buffer to Groff format" groff
)
759 (const :tag
"C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter
)
760 (const :tag
"C RSS 2.0 Export buffer to RSS 2.0 format" rss
)
761 (const :tag
"C s5 Export buffer to s5 presentations" s5
)
762 (const :tag
"C taskjuggler Export buffer to TaskJuggler format" taskjuggler
)))
767 (condition-case nil
(require (intern (format "ox-%s" backend
)))
768 (error (message "Problems while trying to load export back-end `%s'"
770 org-export-backends
))
772 (defcustom org-support-shift-select nil
773 "Non-nil means make shift-cursor commands select text when possible.
775 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
776 start selecting a region, or enlarge regions started in this way.
777 In Org-mode, in special contexts, these same keys are used for
778 other purposes, important enough to compete with shift selection.
779 Org tries to balance these needs by supporting `shift-select-mode'
780 outside these special contexts, under control of this variable.
782 The default of this variable is nil, to avoid confusing behavior. Shifted
783 cursor keys will then execute Org commands in the following contexts:
784 - on a headline, changing TODO state (left/right) and priority (up/down)
785 - on a time stamp, changing the time
786 - in a plain list item, changing the bullet type
787 - in a property definition line, switching between allowed values
788 - in the BEGIN line of a clock table (changing the time block).
789 Outside these contexts, the commands will throw an error.
791 When this variable is t and the cursor is not in a special
792 context, Org-mode will support shift-selection for making and
793 enlarging regions. To make this more effective, the bullet
794 cycling will no longer happen anywhere in an item line, but only
795 if the cursor is exactly on the bullet.
797 If you set this variable to the symbol `always', then the keys
798 will not be special in headlines, property lines, and item lines,
799 to make shift selection work there as well. If this is what you
800 want, you can use the following alternative commands: `C-c C-t'
801 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
802 can be used to switch TODO sets, `C-c -' to cycle item bullet
803 types, and properties can be edited by hand or in column view.
805 However, when the cursor is on a timestamp, shift-cursor commands
806 will still edit the time stamp - this is just too good to give up.
808 XEmacs user should have this variable set to nil, because
809 `shift-select-mode' is in Emacs 23 or later only."
812 (const :tag
"Never" nil
)
813 (const :tag
"When outside special context" t
)
814 (const :tag
"Everywhere except timestamps" always
)))
816 (defcustom org-loop-over-headlines-in-active-region nil
817 "Shall some commands act upon headlines in the active region?
819 When set to `t', some commands will be performed in all headlines
820 within the active region.
822 When set to `start-level', some commands will be performed in all
823 headlines within the active region, provided that these headlines
824 are of the same level than the first one.
826 When set to a string, those commands will be performed on the
827 matching headlines within the active region. Such string must be
828 a tags/property/todo match as it is used in the agenda tags view.
830 The list of commands is: `org-schedule', `org-deadline',
831 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
832 `org-archive-to-archive-sibling'. The archiving commands skip
833 already archived entries."
834 :type
'(choice (const :tag
"Don't loop" nil
)
835 (const :tag
"All headlines in active region" t
)
836 (const :tag
"In active region, headlines at the same level than the first one" start-level
)
837 (string :tag
"Tags/Property/Todo matcher"))
842 (defgroup org-startup nil
843 "Options concerning startup of Org-mode."
847 (defcustom org-startup-folded t
848 "Non-nil means entering Org-mode will switch to OVERVIEW.
849 This can also be configured on a per-file basis by adding one of
850 the following lines anywhere in the buffer:
852 #+STARTUP: fold (or `overview', this is equivalent)
853 #+STARTUP: nofold (or `showall', this is equivalent)
855 #+STARTUP: showeverything
857 By default, this option is ignored when Org opens agenda files
858 for the first time. If you want the agenda to honor the startup
859 option, set `org-agenda-inhibit-startup' to nil."
862 (const :tag
"nofold: show all" nil
)
863 (const :tag
"fold: overview" t
)
864 (const :tag
"content: all headlines" content
)
865 (const :tag
"show everything, even drawers" showeverything
)))
867 (defcustom org-startup-truncated t
868 "Non-nil means entering Org-mode will set `truncate-lines'.
869 This is useful since some lines containing links can be very long and
870 uninteresting. Also tables look terrible when wrapped."
874 (defcustom org-startup-indented nil
875 "Non-nil means turn on `org-indent-mode' on startup.
876 This can also be configured on a per-file basis by adding one of
877 the following lines anywhere in the buffer:
881 :group
'org-structure
883 (const :tag
"Not" nil
)
884 (const :tag
"Globally (slow on startup in large files)" t
)))
886 (defcustom org-use-sub-superscripts t
887 "Non-nil means interpret \"_\" and \"^\" for display.
889 If you want to control how Org exports those characters, see
890 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
891 used to be an alias for `org-export-with-sub-superscripts' in
892 Org <8.0, it is not anymore.
894 When this option is turned on, you can use TeX-like syntax for
895 sub- and superscripts within the buffer. Several characters after
896 \"_\" or \"^\" will be considered as a single item - so grouping
897 with {} is normally not needed. For example, the following things
898 will be parsed as single sub- or superscripts:
900 10^24 or 10^tau several digits will be considered 1 item.
901 10^-12 or 10^-tau a leading sign with digits or a word
902 x^2-y^3 will be read as x^2 - y^3, because items are
903 terminated by almost any nonword/nondigit char.
904 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
906 Still, ambiguity is possible. So when in doubt, use {} to enclose
907 the sub/superscript. If you set this variable to the symbol `{}',
908 the braces are *required* in order to trigger interpretations as
909 sub/superscript. This can be helpful in documents that need \"_\"
910 frequently in plain text."
913 :package-version
'(Org .
"8.0")
915 (const :tag
"Always interpret" t
)
916 (const :tag
"Only with braces" {})
917 (const :tag
"Never interpret" nil
)))
919 (defcustom org-startup-with-beamer-mode nil
920 "Non-nil means turn on `org-beamer-mode' on startup.
921 This can also be configured on a per-file basis by adding one of
922 the following lines anywhere in the buffer:
929 (defcustom org-startup-align-all-tables nil
930 "Non-nil means align all tables when visiting a file.
931 This is useful when the column width in tables is forced with <N> cookies
932 in table fields. Such tables will look correct only after the first re-align.
933 This can also be configured on a per-file basis by adding one of
934 the following lines anywhere in the buffer:
940 (defcustom org-startup-with-inline-images nil
941 "Non-nil means show inline images when loading a new Org file.
942 This can also be configured on a per-file basis by adding one of
943 the following lines anywhere in the buffer:
944 #+STARTUP: inlineimages
945 #+STARTUP: noinlineimages"
950 (defcustom org-startup-with-latex-preview nil
951 "Non-nil means preview LaTeX fragments when loading a new Org file.
953 This can also be configured on a per-file basis by adding one of
954 the following lines anywhere in the buffer:
955 #+STARTUP: latexpreview
956 #+STARTUP: nolatexpreview"
959 :package-version
'(Org .
"8.0")
962 (defcustom org-insert-mode-line-in-empty-file nil
963 "Non-nil means insert the first line setting Org-mode in empty files.
964 When the function `org-mode' is called interactively in an empty file, this
965 normally means that the file name does not automatically trigger Org-mode.
966 To ensure that the file will always be in Org-mode in the future, a
967 line enforcing Org-mode will be inserted into the buffer, if this option
972 (defcustom org-replace-disputed-keys nil
973 "Non-nil means use alternative key bindings for some keys.
974 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
975 These keys are also used by other packages like shift-selection-mode'
976 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
977 If you want to use Org-mode together with one of these other modes,
978 or more generally if you would like to move some Org-mode commands to
979 other keys, set this variable and configure the keys with the variable
982 This option is only relevant at load-time of Org-mode, and must be set
983 *before* org.el is loaded. Changing it requires a restart of Emacs to
988 (defcustom org-use-extra-keys nil
989 "Non-nil means use extra key sequence definitions for certain commands.
990 This happens automatically if you run XEmacs or if `window-system'
991 is nil. This variable lets you do the same manually. You must
992 set it before loading org.
994 Example: on Carbon Emacs 22 running graphically, with an external
995 keyboard on a Powerbook, the default way of setting M-left might
996 not work for either Alt or ESC. Setting this variable will make
1001 (org-defvaralias 'org-CUA-compatible
'org-replace-disputed-keys
)
1003 (defcustom org-disputed-keys
1004 '(([(shift up
)] .
[(meta p
)])
1005 ([(shift down
)] .
[(meta n
)])
1006 ([(shift left
)] .
[(meta -
)])
1007 ([(shift right
)] .
[(meta +)])
1008 ([(control shift right
)] .
[(meta shift
+)])
1009 ([(control shift left
)] .
[(meta shift -
)]))
1010 "Keys for which Org-mode and other modes compete.
1011 This is an alist, cars are the default keys, second element specifies
1012 the alternative to use when `org-replace-disputed-keys' is t.
1014 Keys can be specified in any syntax supported by `define-key'.
1015 The value of this option takes effect only at Org-mode's startup,
1016 therefore you'll have to restart Emacs to apply it after changing."
1020 (defun org-key (key)
1021 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1022 Or return the original if not disputed.
1023 Also apply the translations defined in `org-xemacs-key-equivalents'."
1024 (when org-replace-disputed-keys
1025 (let* ((nkey (key-description key
))
1026 (x (org-find-if (lambda (x)
1027 (equal (key-description (car x
)) nkey
))
1028 org-disputed-keys
)))
1029 (setq key
(if x
(cdr x
) key
))))
1030 (when (featurep 'xemacs
)
1031 (setq key
(or (cdr (assoc key org-xemacs-key-equivalents
)) key
)))
1034 (defun org-find-if (predicate seq
)
1037 (if (funcall predicate
(car seq
))
1038 (throw 'exit
(car seq
))
1041 (defun org-defkey (keymap key def
)
1042 "Define a key, possibly translated, as returned by `org-key'."
1043 (define-key keymap
(org-key key
) def
))
1045 (defcustom org-ellipsis nil
1046 "The ellipsis to use in the Org-mode outline.
1047 When nil, just use the standard three dots.
1048 When a string, use that string instead.
1049 When a face, use the standard 3 dots, but with the specified face.
1050 The change affects only Org-mode (which will then use its own display table).
1051 Changing this requires executing \\[org-mode] in a buffer to become
1054 :type
'(choice (const :tag
"Default" nil
)
1055 (face :tag
"Face" :value org-warning
)
1056 (string :tag
"String" :value
"...#")))
1058 (defvar org-display-table nil
1059 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1061 (defgroup org-keywords nil
1062 "Keywords in Org-mode."
1066 (defcustom org-closed-keep-when-no-todo nil
1067 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1069 :group
'org-keywords
1071 :package-version
'(Org .
"8.0")
1074 (defgroup org-structure nil
1075 "Options concerning the general structure of Org-mode files."
1076 :tag
"Org Structure"
1079 (defgroup org-reveal-location nil
1080 "Options about how to make context of a location visible."
1081 :tag
"Org Reveal Location"
1082 :group
'org-structure
)
1084 (defconst org-context-choice
1086 (const :tag
"Always" t
)
1087 (const :tag
"Never" nil
)
1088 (repeat :greedy t
:tag
"Individual contexts"
1090 (choice :tag
"Context"
1097 (const bookmark-jump
)
1101 "Contexts for the reveal options.")
1103 (defcustom org-show-hierarchy-above
'((default . t
))
1104 "Non-nil means show full hierarchy when revealing a location.
1105 Org-mode often shows locations in an org-mode file which might have
1106 been invisible before. When this is set, the hierarchy of headings
1107 above the exposed location is shown.
1108 Turning this off for example for sparse trees makes them very compact.
1109 Instead of t, this can also be an alist specifying this option for different
1110 contexts. Valid contexts are
1111 agenda when exposing an entry from the agenda
1112 org-goto when using the command `org-goto' on key C-c C-j
1113 occur-tree when using the command `org-occur' on key C-c /
1114 tags-tree when constructing a sparse tree based on tags matches
1115 link-search when exposing search matches associated with a link
1116 mark-goto when exposing the jump goal of a mark
1117 bookmark-jump when exposing a bookmark location
1118 isearch when exiting from an incremental search
1119 default default for all contexts not set explicitly"
1120 :group
'org-reveal-location
1121 :type org-context-choice
)
1123 (defcustom org-show-following-heading
'((default . nil
))
1124 "Non-nil means show following heading when revealing a location.
1125 Org-mode often shows locations in an org-mode file which might have
1126 been invisible before. When this is set, the heading following the
1128 Turning this off for example for sparse trees makes them very compact,
1129 but makes it harder to edit the location of the match. In such a case,
1130 use the command \\[org-reveal] to show more context.
1131 Instead of t, this can also be an alist specifying this option for different
1132 contexts. See `org-show-hierarchy-above' for valid contexts."
1133 :group
'org-reveal-location
1134 :type org-context-choice
)
1136 (defcustom org-show-siblings
'((default . nil
) (isearch t
) (bookmark-jump t
))
1137 "Non-nil means show all sibling heading when revealing a location.
1138 Org-mode often shows locations in an org-mode file which might have
1139 been invisible before. When this is set, the sibling of the current entry
1140 heading are all made visible. If `org-show-hierarchy-above' is t,
1141 the same happens on each level of the hierarchy above the current entry.
1143 By default this is on for the isearch context, off for all other contexts.
1144 Turning this off for example for sparse trees makes them very compact,
1145 but makes it harder to edit the location of the match. In such a case,
1146 use the command \\[org-reveal] to show more context.
1147 Instead of t, this can also be an alist specifying this option for different
1148 contexts. See `org-show-hierarchy-above' for valid contexts."
1149 :group
'org-reveal-location
1150 :type org-context-choice
1152 :package-version
'(Org .
"8.0"))
1154 (defcustom org-show-entry-below
'((default . nil
))
1155 "Non-nil means show the entry below a headline when revealing a location.
1156 Org-mode often shows locations in an org-mode file which might have
1157 been invisible before. When this is set, the text below the headline that is
1158 exposed is also shown.
1160 By default this is off for all contexts.
1161 Instead of t, this can also be an alist specifying this option for different
1162 contexts. See `org-show-hierarchy-above' for valid contexts."
1163 :group
'org-reveal-location
1164 :type org-context-choice
)
1166 (defcustom org-indirect-buffer-display
'other-window
1167 "How should indirect tree buffers be displayed?
1168 This applies to indirect buffers created with the commands
1169 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1171 current-window Display in the current window
1172 other-window Just display in another window.
1173 dedicated-frame Create one new frame, and re-use it each time.
1174 new-frame Make a new frame each time. Note that in this case
1175 previously-made indirect buffers are kept, and you need to
1176 kill these buffers yourself."
1177 :group
'org-structure
1178 :group
'org-agenda-windows
1180 (const :tag
"In current window" current-window
)
1181 (const :tag
"In current frame, other window" other-window
)
1182 (const :tag
"Each time a new frame" new-frame
)
1183 (const :tag
"One dedicated frame" dedicated-frame
)))
1185 (defcustom org-use-speed-commands nil
1186 "Non-nil means activate single letter commands at beginning of a headline.
1187 This may also be a function to test for appropriate locations where speed
1188 commands should be active.
1190 For example, to activate speed commands when the point is on any
1191 star at the beginning of the headline, you can do this:
1193 (setq org-use-speed-commands
1194 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1195 :group
'org-structure
1197 (const :tag
"Never" nil
)
1198 (const :tag
"At beginning of headline stars" t
)
1201 (defcustom org-speed-commands-user nil
1202 "Alist of additional speed commands.
1203 This list will be checked before `org-speed-commands-default'
1204 when the variable `org-use-speed-commands' is non-nil
1205 and when the cursor is at the beginning of a headline.
1206 The car if each entry is a string with a single letter, which must
1207 be assigned to `self-insert-command' in the global map.
1208 The cdr is either a command to be called interactively, a function
1209 to be called, or a form to be evaluated.
1210 An entry that is just a list with a single string will be interpreted
1211 as a descriptive headline that will be added when listing the speed
1212 commands in the Help buffer using the `?' speed command."
1213 :group
'org-structure
1214 :type
'(repeat :value
("k" . ignore
)
1215 (choice :value
("k" . ignore
)
1216 (list :tag
"Descriptive Headline" (string :tag
"Headline"))
1217 (cons :tag
"Letter and Command"
1218 (string :tag
"Command letter")
1223 (defcustom org-bookmark-names-plist
1224 '(:last-capture
"org-capture-last-stored"
1225 :last-refile
"org-refile-last-stored"
1226 :last-capture-marker
"org-capture-last-stored-marker")
1227 "Names for bookmarks automatically set by some Org commands.
1228 This can provide strings as names for a number of bookmarks Org sets
1229 automatically. The following keys are currently implemented:
1231 :last-capture-marker
1233 When a key does not show up in the property list, the corresponding bookmark
1235 :group
'org-structure
1238 (defgroup org-cycle nil
1239 "Options concerning visibility cycling in Org-mode."
1241 :group
'org-structure
)
1243 (defcustom org-cycle-skip-children-state-if-no-children t
1244 "Non-nil means skip CHILDREN state in entries that don't have any."
1248 (defcustom org-cycle-max-level nil
1249 "Maximum level which should still be subject to visibility cycling.
1250 Levels higher than this will, for cycling, be treated as text, not a headline.
1251 When `org-odd-levels-only' is set, a value of N in this variable actually
1252 means 2N-1 stars as the limiting headline.
1253 When nil, cycle all levels.
1254 Note that the limiting level of cycling is also influenced by
1255 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1256 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1260 (const :tag
"No limit" nil
)
1261 (integer :tag
"Maximum level")))
1263 (defcustom org-hide-block-startup nil
1264 "Non-nil means entering Org-mode will fold all blocks.
1265 This can also be set in on a per-file basis with
1267 #+STARTUP: hideblocks
1268 #+STARTUP: showblocks"
1273 (defcustom org-cycle-global-at-bob nil
1274 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1275 This makes it possible to do global cycling without having to use S-TAB or
1276 \\[universal-argument] TAB. For this special case to work, the first line
1277 of the buffer must not be a headline -- it may be empty or some other text.
1278 When used in this way, `org-cycle-hook' is disabled temporarily to make
1279 sure the cursor stays at the beginning of the buffer. When this option is
1280 nil, don't do anything special at the beginning of the buffer."
1284 (defcustom org-cycle-level-after-item
/entry-creation t
1285 "Non-nil means cycle entry level or item indentation in new empty entries.
1287 When the cursor is at the end of an empty headline, i.e., with only stars
1288 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1289 and then all possible ancestor states, before returning to the original state.
1290 This makes data entry extremely fast: M-RET to create a new headline,
1291 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1293 When the cursor is at the end of an empty plain list item, one TAB will
1294 make it a subitem, two or more tabs will back up to make this an item
1295 higher up in the item hierarchy."
1299 (defcustom org-cycle-emulate-tab t
1300 "Where should `org-cycle' emulate TAB.
1302 white Only in completely white lines
1303 whitestart Only at the beginning of lines, before the first non-white char
1304 t Everywhere except in headlines
1305 exc-hl-bol Everywhere except at the start of a headline
1306 If TAB is used in a place where it does not emulate TAB, the current subtree
1307 visibility is cycled."
1309 :type
'(choice (const :tag
"Never" nil
)
1310 (const :tag
"Only in completely white lines" white
)
1311 (const :tag
"Before first char in a line" whitestart
)
1312 (const :tag
"Everywhere except in headlines" t
)
1313 (const :tag
"Everywhere except at bol in headlines" exc-hl-bol
)))
1315 (defcustom org-cycle-separator-lines
2
1316 "Number of empty lines needed to keep an empty line between collapsed trees.
1317 If you leave an empty line between the end of a subtree and the following
1318 headline, this empty line is hidden when the subtree is folded.
1319 Org-mode will leave (exactly) one empty line visible if the number of
1320 empty lines is equal or larger to the number given in this variable.
1321 So the default 2 means at least 2 empty lines after the end of a subtree
1322 are needed to produce free space between a collapsed subtree and the
1325 If the number is negative, and the number of empty lines is at least -N,
1326 all empty lines are shown.
1328 Special case: when 0, never leave empty lines in collapsed view."
1331 (put 'org-cycle-separator-lines
'safe-local-variable
'integerp
)
1333 (defcustom org-pre-cycle-hook nil
1334 "Hook that is run before visibility cycling is happening.
1335 The function(s) in this hook must accept a single argument which indicates
1336 the new state that will be set right after running this hook. The
1337 argument is a symbol. Before a global state change, it can have the values
1338 `overview', `content', or `all'. Before a local state change, it can have
1339 the values `folded', `children', or `subtree'."
1343 (defcustom org-cycle-hook
'(org-cycle-hide-archived-subtrees
1344 org-cycle-hide-drawers
1345 org-cycle-hide-inline-tasks
1346 org-cycle-show-empty-lines
1347 org-optimize-window-after-visibility-change
)
1348 "Hook that is run after `org-cycle' has changed the buffer visibility.
1349 The function(s) in this hook must accept a single argument which indicates
1350 the new state that was set by the most recent `org-cycle' command. The
1351 argument is a symbol. After a global state change, it can have the values
1352 `overview', `contents', or `all'. After a local state change, it can have
1353 the values `folded', `children', or `subtree'."
1357 (defgroup org-edit-structure nil
1358 "Options concerning structure editing in Org-mode."
1359 :tag
"Org Edit Structure"
1360 :group
'org-structure
)
1362 (defcustom org-odd-levels-only nil
1363 "Non-nil means skip even levels and only use odd levels for the outline.
1364 This has the effect that two stars are being added/taken away in
1365 promotion/demotion commands. It also influences how levels are
1366 handled by the exporters.
1367 Changing it requires restart of `font-lock-mode' to become effective
1368 for fontification also in regions already fontified.
1369 You may also set this on a per-file basis by adding one of the following
1370 lines to the buffer:
1374 :group
'org-edit-structure
1375 :group
'org-appearance
1378 (defcustom org-adapt-indentation t
1379 "Non-nil means adapt indentation to outline node level.
1381 When this variable is set, Org assumes that you write outlines by
1382 indenting text in each node to align with the headline (after the stars).
1383 The following issues are influenced by this variable:
1385 - When this is set and the *entire* text in an entry is indented, the
1386 indentation is increased by one space in a demotion command, and
1387 decreased by one in a promotion command. If any line in the entry
1388 body starts with text at column 0, indentation is not changed at all.
1390 - Property drawers and planning information is inserted indented when
1391 this variable s set. When nil, they will not be indented.
1393 - TAB indents a line relative to context. The lines below a headline
1394 will be indented when this variable is set.
1396 Note that this is all about true indentation, by adding and removing
1397 space characters. See also `org-indent.el' which does level-dependent
1398 indentation in a virtual way, i.e. at display time in Emacs."
1399 :group
'org-edit-structure
1402 (defcustom org-special-ctrl-a
/e nil
1403 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1405 When t, `C-a' will bring back the cursor to the beginning of the
1406 headline text, i.e. after the stars and after a possible TODO
1407 keyword. In an item, this will be the position after bullet and
1408 check-box, if any. When the cursor is already at that position,
1409 another `C-a' will bring it to the beginning of the line.
1411 `C-e' will jump to the end of the headline, ignoring the presence
1412 of tags in the headline. A second `C-e' will then jump to the
1413 true end of the line, after any tags. This also means that, when
1414 this variable is non-nil, `C-e' also will never jump beyond the
1415 end of the heading of a folded section, i.e. not after the
1418 When set to the symbol `reversed', the first `C-a' or `C-e' works
1419 normally, going to the true line boundary first. Only a directly
1420 following, identical keypress will bring the cursor to the
1423 This may also be a cons cell where the behavior for `C-a' and
1424 `C-e' is set separately."
1425 :group
'org-edit-structure
1427 (const :tag
"off" nil
)
1428 (const :tag
"on: after stars/bullet and before tags first" t
)
1429 (const :tag
"reversed: true line boundary first" reversed
)
1430 (cons :tag
"Set C-a and C-e separately"
1431 (choice :tag
"Special C-a"
1432 (const :tag
"off" nil
)
1433 (const :tag
"on: after stars/bullet first" t
)
1434 (const :tag
"reversed: before stars/bullet first" reversed
))
1435 (choice :tag
"Special C-e"
1436 (const :tag
"off" nil
)
1437 (const :tag
"on: before tags first" t
)
1438 (const :tag
"reversed: after tags first" reversed
)))))
1439 (org-defvaralias 'org-special-ctrl-a
'org-special-ctrl-a
/e
)
1441 (defcustom org-special-ctrl-k nil
1442 "Non-nil means `C-k' will behave specially in headlines.
1443 When nil, `C-k' will call the default `kill-line' command.
1444 When t, the following will happen while the cursor is in the headline:
1446 - When the cursor is at the beginning of a headline, kill the entire
1447 line and possible the folded subtree below the line.
1448 - When in the middle of the headline text, kill the headline up to the tags.
1449 - When after the headline text, kill the tags."
1450 :group
'org-edit-structure
1453 (defcustom org-ctrl-k-protect-subtree nil
1454 "Non-nil means, do not delete a hidden subtree with C-k.
1455 When set to the symbol `error', simply throw an error when C-k is
1456 used to kill (part-of) a headline that has hidden text behind it.
1457 Any other non-nil value will result in a query to the user, if it is
1458 OK to kill that hidden subtree. When nil, kill without remorse."
1459 :group
'org-edit-structure
1462 (const :tag
"Do not protect hidden subtrees" nil
)
1463 (const :tag
"Protect hidden subtrees with a security query" t
)
1464 (const :tag
"Never kill a hidden subtree with C-k" error
)))
1466 (defcustom org-special-ctrl-o t
1467 "Non-nil means, make `C-o' insert a row in tables."
1468 :group
'org-edit-structure
1471 (defcustom org-catch-invisible-edits nil
1472 "Check if in invisible region before inserting or deleting a character.
1475 nil Do not check, so just do invisible edits.
1476 error Throw an error and do nothing.
1477 show Make point visible, and do the requested edit.
1478 show-and-error Make point visible, then throw an error and abort the edit.
1479 smart Make point visible, and do insertion/deletion if it is
1480 adjacent to visible text and the change feels predictable.
1481 Never delete a previously invisible character or add in the
1482 middle or right after an invisible region. Basically, this
1483 allows insertion and backward-delete right before ellipses.
1484 FIXME: maybe in this case we should not even show?"
1485 :group
'org-edit-structure
1488 (const :tag
"Do not check" nil
)
1489 (const :tag
"Throw error when trying to edit" error
)
1490 (const :tag
"Unhide, but do not do the edit" show-and-error
)
1491 (const :tag
"Show invisible part and do the edit" show
)
1492 (const :tag
"Be smart and do the right thing" smart
)))
1494 (defcustom org-yank-folded-subtrees t
1495 "Non-nil means when yanking subtrees, fold them.
1496 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1497 it starts with a heading and all other headings in it are either children
1498 or siblings, then fold all the subtrees. However, do this only if no
1499 text after the yank would be swallowed into a folded tree by this action."
1500 :group
'org-edit-structure
1503 (defcustom org-yank-adjusted-subtrees nil
1504 "Non-nil means when yanking subtrees, adjust the level.
1505 With this setting, `org-paste-subtree' is used to insert the subtree, see
1506 this function for details."
1507 :group
'org-edit-structure
1510 (defcustom org-M-RET-may-split-line
'((default . t
))
1511 "Non-nil means M-RET will split the line at the cursor position.
1512 When nil, it will go to the end of the line before making a
1514 You may also set this option in a different way for different
1515 contexts. Valid contexts are:
1517 headline when creating a new headline
1518 item when creating a new item
1519 table in a table field
1520 default the value to be used for all contexts not explicitly
1522 :group
'org-structure
1525 (const :tag
"Always" t
)
1526 (const :tag
"Never" nil
)
1527 (repeat :greedy t
:tag
"Individual contexts"
1529 (choice :tag
"Context"
1537 (defcustom org-insert-heading-respect-content nil
1538 "Non-nil means insert new headings after the current subtree.
1539 When nil, the new heading is created directly after the current line.
1540 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1541 this variable on for the duration of the command."
1542 :group
'org-structure
1545 (defcustom org-blank-before-new-entry
'((heading . auto
)
1546 (plain-list-item . auto
))
1547 "Should `org-insert-heading' leave a blank line before new heading/item?
1548 The value is an alist, with `heading' and `plain-list-item' as CAR,
1549 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1550 which case Org will look at the surrounding headings/items and try to
1551 make an intelligent decision whether to insert a blank line or not.
1553 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1554 the setting here is ignored and no empty line is inserted to avoid breaking
1555 the list structure."
1556 :group
'org-edit-structure
1558 (cons (const heading
)
1559 (choice (const :tag
"Never" nil
)
1560 (const :tag
"Always" t
)
1561 (const :tag
"Auto" auto
)))
1562 (cons (const plain-list-item
)
1563 (choice (const :tag
"Never" nil
)
1564 (const :tag
"Always" t
)
1565 (const :tag
"Auto" auto
)))))
1567 (defcustom org-insert-heading-hook nil
1568 "Hook being run after inserting a new heading."
1569 :group
'org-edit-structure
1572 (defcustom org-enable-fixed-width-editor t
1573 "Non-nil means lines starting with \":\" are treated as fixed-width.
1574 This currently only means they are never auto-wrapped.
1575 When nil, such lines will be treated like ordinary lines."
1576 :group
'org-edit-structure
1579 (defcustom org-goto-auto-isearch t
1580 "Non-nil means typing characters in `org-goto' starts incremental search.
1581 When nil, you can use these keybindings to navigate the buffer:
1583 q Quit the org-goto interface
1584 n Go to the next visible heading
1585 p Go to the previous visible heading
1586 f Go one heading forward on same level
1587 b Go one heading backward on same level
1588 u Go one heading up"
1589 :group
'org-edit-structure
1592 (defgroup org-sparse-trees nil
1593 "Options concerning sparse trees in Org-mode."
1594 :tag
"Org Sparse Trees"
1595 :group
'org-structure
)
1597 (defcustom org-highlight-sparse-tree-matches t
1598 "Non-nil means highlight all matches that define a sparse tree.
1599 The highlights will automatically disappear the next time the buffer is
1600 changed by an edit command."
1601 :group
'org-sparse-trees
1604 (defcustom org-remove-highlights-with-change t
1605 "Non-nil means any change to the buffer will remove temporary highlights.
1606 Such highlights are created by `org-occur' and `org-clock-display'.
1607 When nil, `C-c C-c' needs to be used to get rid of the highlights.
1608 The highlights created by `org-toggle-latex-fragment' always need
1609 `C-c C-x C-l' to be removed."
1610 :group
'org-sparse-trees
1615 (defcustom org-occur-hook
'(org-first-headline-recenter)
1616 "Hook that is run after `org-occur' has constructed a sparse tree.
1617 This can be used to recenter the window to show as much of the structure
1619 :group
'org-sparse-trees
1622 (defgroup org-imenu-and-speedbar nil
1623 "Options concerning imenu and speedbar in Org-mode."
1624 :tag
"Org Imenu and Speedbar"
1625 :group
'org-structure
)
1627 (defcustom org-imenu-depth
2
1628 "The maximum level for Imenu access to Org-mode headlines.
1629 This also applied for speedbar access."
1630 :group
'org-imenu-and-speedbar
1633 (defgroup org-table nil
1634 "Options concerning tables in Org-mode."
1638 (defcustom org-enable-table-editor
'optimized
1639 "Non-nil means lines starting with \"|\" are handled by the table editor.
1640 When nil, such lines will be treated like ordinary lines.
1642 When equal to the symbol `optimized', the table editor will be optimized to
1644 - Automatic overwrite mode in front of whitespace in table fields.
1645 This makes the structure of the table stay in tact as long as the edited
1646 field does not exceed the column width.
1647 - Minimize the number of realigns. Normally, the table is aligned each time
1648 TAB or RET are pressed to move to another field. With optimization this
1649 happens only if changes to a field might have changed the column width.
1650 Optimization requires replacing the functions `self-insert-command',
1651 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1652 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1653 very good at guessing when a re-align will be necessary, but you can always
1654 force one with \\[org-ctrl-c-ctrl-c].
1656 If you would like to use the optimized version in Org-mode, but the
1657 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1659 This variable can be used to turn on and off the table editor during a session,
1660 but in order to toggle optimization, a restart is required.
1662 See also the variable `org-table-auto-blank-field'."
1665 (const :tag
"off" nil
)
1667 (const :tag
"on, optimized" optimized
)))
1669 (defcustom org-self-insert-cluster-for-undo
(or (featurep 'xemacs
)
1670 (version<= emacs-version
"24.1"))
1671 "Non-nil means cluster self-insert commands for undo when possible.
1672 If this is set, then, like in the Emacs command loop, 20 consecutive
1673 characters will be undone together.
1674 This is configurable, because there is some impact on typing performance."
1678 (defcustom org-table-tab-recognizes-table.el t
1679 "Non-nil means TAB will automatically notice a table.el table.
1680 When it sees such a table, it moves point into it and - if necessary -
1681 calls `table-recognize-table'."
1682 :group
'org-table-editing
1685 (defgroup org-link nil
1686 "Options concerning links in Org-mode."
1690 (defvar org-link-abbrev-alist-local nil
1691 "Buffer-local version of `org-link-abbrev-alist', which see.
1692 The value of this is taken from the #+LINK lines.")
1693 (make-variable-buffer-local 'org-link-abbrev-alist-local
)
1695 (defcustom org-link-abbrev-alist nil
1696 "Alist of link abbreviations.
1697 The car of each element is a string, to be replaced at the start of a link.
1698 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1699 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1701 [[linkkey:tag][description]]
1703 The 'linkkey' must be a word word, starting with a letter, followed
1704 by letters, numbers, '-' or '_'.
1706 If REPLACE is a string, the tag will simply be appended to create the link.
1707 If the string contains \"%s\", the tag will be inserted there. If the string
1708 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1709 at that point (see the function `url-hexify-string'). If the string contains
1710 the specifier \"%(my-function)\", then the custom function `my-function' will
1711 be invoked: this function takes the tag as its only argument and must return
1714 REPLACE may also be a function that will be called with the tag as the
1715 only argument to create the link, which should be returned as a string.
1717 See the manual for examples."
1721 (string :tag
"Protocol")
1723 (string :tag
"Format")
1726 (defcustom org-descriptive-links t
1727 "Non-nil means Org will display descriptive links.
1728 E.g. [[http://orgmode.org][Org website]] will be displayed as
1729 \"Org Website\", hiding the link itself and just displaying its
1730 description. When set to `nil', Org will display the full links
1733 You can interactively set the value of this variable by calling
1734 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1738 (defcustom org-link-file-path-type
'adaptive
1739 "How the path name in file links should be stored.
1742 relative Relative to the current directory, i.e. the directory of the file
1743 into which the link is being inserted.
1744 absolute Absolute path, if possible with ~ for home directory.
1745 noabbrev Absolute path, no abbreviation of home directory.
1746 adaptive Use relative path for files in the current directory and sub-
1747 directories of it. For other files, use an absolute path."
1755 (defvaralias 'org-activate-links
'org-highlight-links
)
1756 (defcustom org-highlight-links
'(bracket angle plain radio tag date footnote
)
1757 "Types of links that should be highlighted in Org-mode files.
1759 This is a list of symbols, each one of them leading to the
1760 highlighting of a certain link type.
1762 You can still open links that are not highlighted.
1764 In principle, it does not hurt to turn on highlighting for all
1765 link types. There may be a small gain when turning off unused
1766 link types. The types are:
1768 bracket The recommended [[link][description]] or [[link]] links with hiding.
1769 angle Links in angular brackets that may contain whitespace like
1770 <bbdb:Carsten Dominik>.
1771 plain Plain links in normal text, no whitespace, like http://google.com.
1772 radio Text that is matched by a radio target, see manual for details.
1773 tag Tag settings in a headline (link to tag search).
1774 date Time stamps (link to calendar).
1775 footnote Footnote labels.
1777 If you set this variable during an Emacs session, use `org-mode-restart'
1778 in the Org buffer so that the change takes effect."
1780 :group
'org-appearance
1781 :type
'(set :greedy t
1782 (const :tag
"Double bracket links" bracket
)
1783 (const :tag
"Angular bracket links" angle
)
1784 (const :tag
"Plain text links" plain
)
1785 (const :tag
"Radio target matches" radio
)
1786 (const :tag
"Tags" tag
)
1787 (const :tag
"Timestamps" date
)
1788 (const :tag
"Footnotes" footnote
)))
1790 (defcustom org-make-link-description-function nil
1791 "Function to use for generating link descriptions from links.
1792 When nil, the link location will be used. This function must take
1793 two parameters: the first one is the link, the second one is the
1794 description generated by `org-insert-link'. The function should
1795 return the description to use."
1797 :type
'(choice (const nil
) (function)))
1799 (defgroup org-link-store nil
1800 "Options concerning storing links in Org-mode."
1801 :tag
"Org Store Link"
1804 (defcustom org-url-hexify-p t
1805 "When non-nil, hexify URL when creating a link."
1808 :group
'org-link-store
)
1810 (defcustom org-email-link-description-format
"Email %c: %.30s"
1811 "Format of the description part of a link to an email or usenet message.
1812 The following %-escapes will be replaced by corresponding information:
1814 %F full \"From\" field
1815 %f name, taken from \"From\" field, address if no name
1816 %T full \"To\" field
1817 %t first name in \"To\" field, address if no name
1818 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1819 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1824 You may use normal field width specification between the % and the letter.
1825 This is for example useful to limit the length of the subject.
1827 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1828 :group
'org-link-store
1831 (defcustom org-from-is-user-regexp
1833 (when (and user-mail-address
(not (string= user-mail-address
"")))
1834 (setq r1
(concat "\\<" (regexp-quote user-mail-address
) "\\>")))
1835 (when (and user-full-name
(not (string= user-full-name
"")))
1836 (setq r2
(concat "\\<" (regexp-quote user-full-name
) "\\>")))
1837 (if (and r1 r2
) (concat r1
"\\|" r2
) (or r1 r2
)))
1838 "Regexp matched against the \"From:\" header of an email or usenet message.
1839 It should match if the message is from the user him/herself."
1840 :group
'org-link-store
1843 (defcustom org-context-in-file-links t
1844 "Non-nil means file links from `org-store-link' contain context.
1845 A search string will be added to the file name with :: as separator and
1846 used to find the context when the link is activated by the command
1847 `org-open-at-point'. When this option is t, the entire active region
1848 will be placed in the search string of the file link. If set to a
1849 positive integer, only the first n lines of context will be stored.
1851 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1852 negates this setting for the duration of the command."
1853 :group
'org-link-store
1854 :type
'(choice boolean integer
))
1856 (defcustom org-keep-stored-link-after-insertion nil
1857 "Non-nil means keep link in list for entire session.
1859 The command `org-store-link' adds a link pointing to the current
1860 location to an internal list. These links accumulate during a session.
1861 The command `org-insert-link' can be used to insert links into any
1862 Org-mode file (offering completion for all stored links). When this
1863 option is nil, every link which has been inserted once using \\[org-insert-link]
1864 will be removed from the list, to make completing the unused links
1866 :group
'org-link-store
1869 (defgroup org-link-follow nil
1870 "Options concerning following links in Org-mode."
1871 :tag
"Org Follow Link"
1874 (defcustom org-link-translation-function nil
1875 "Function to translate links with different syntax to Org syntax.
1876 This can be used to translate links created for example by the Planner
1877 or emacs-wiki packages to Org syntax.
1878 The function must accept two parameters, a TYPE containing the link
1879 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1880 which is everything after the link protocol. It should return a cons
1881 with possibly modified values of type and path.
1882 Org contains a function for this, so if you set this variable to
1883 `org-translate-link-from-planner', you should be able follow many
1884 links created by planner."
1885 :group
'org-link-follow
1886 :type
'(choice (const nil
) (function)))
1888 (defcustom org-follow-link-hook nil
1889 "Hook that is run after a link has been followed."
1890 :group
'org-link-follow
1893 (defcustom org-tab-follows-link nil
1894 "Non-nil means on links TAB will follow the link.
1895 Needs to be set before org.el is loaded.
1896 This really should not be used, it does not make sense, and the
1897 implementation is bad."
1898 :group
'org-link-follow
1901 (defcustom org-return-follows-link nil
1902 "Non-nil means on links RET will follow the link.
1903 In tables, the special behavior of RET has precedence."
1904 :group
'org-link-follow
1907 (defcustom org-mouse-1-follows-link
1908 (if (boundp 'mouse-1-click-follows-link
) mouse-1-click-follows-link t
)
1909 "Non-nil means mouse-1 on a link will follow the link.
1910 A longer mouse click will still set point. Does not work on XEmacs.
1911 Needs to be set before org.el is loaded."
1912 :group
'org-link-follow
1914 :package-version
'(Org .
"8.3")
1916 (const :tag
"A double click follows the link" double
)
1917 (const :tag
"Unconditionally follow the link with mouse-1" t
)
1918 (integer :tag
"mouse-1 click does not follow the link if longer than N ms" 450)))
1920 (defcustom org-mark-ring-length
4
1921 "Number of different positions to be recorded in the ring.
1922 Changing this requires a restart of Emacs to work correctly."
1923 :group
'org-link-follow
1926 (defcustom org-link-search-must-match-exact-headline
'query-to-create
1927 "Non-nil means internal links in Org files must exactly match a headline.
1928 When nil, the link search tries to match a phrase with all words
1929 in the search text."
1930 :group
'org-link-follow
1933 (const :tag
"Use fuzzy text search" nil
)
1934 (const :tag
"Match only exact headline" t
)
1935 (const :tag
"Match exact headline or query to create it"
1938 (defcustom org-link-frame-setup
1939 '((vm . vm-visit-folder-other-frame
)
1940 (vm-imap . vm-visit-imap-folder-other-frame
)
1941 (gnus . org-gnus-no-new-news
)
1942 (file . find-file-other-window
)
1943 (wl . wl-other-frame
))
1944 "Setup the frame configuration for following links.
1945 When following a link with Emacs, it may often be useful to display
1946 this link in another window or frame. This variable can be used to
1947 set this up for the different types of links.
1950 `vm-visit-folder-other-window'
1951 `vm-visit-folder-other-frame'
1952 For Gnus, use any of
1955 `org-gnus-no-new-news'
1956 For FILE, use any of
1958 `find-file-other-window'
1959 `find-file-other-frame'
1960 For Wanderlust use any of
1963 For the calendar, use the variable `calendar-setup'.
1964 For BBDB, it is currently only possible to display the matches in
1966 :group
'org-link-follow
1970 (const vm-visit-folder
)
1971 (const vm-visit-folder-other-window
)
1972 (const vm-visit-folder-other-frame
)))
1973 (cons (const vm-imap
)
1975 (const vm-visit-imap-folder
)
1976 (const vm-visit-imap-folder-other-window
)
1977 (const vm-visit-imap-folder-other-frame
)))
1981 (const gnus-other-frame
)
1982 (const org-gnus-no-new-news
)))
1986 (const find-file-other-window
)
1987 (const find-file-other-frame
)))
1991 (const wl-other-frame
)))))
1993 (defcustom org-display-internal-link-with-indirect-buffer nil
1994 "Non-nil means use indirect buffer to display infile links.
1995 Activating internal links (from one location in a file to another location
1996 in the same file) normally just jumps to the location. When the link is
1997 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1999 another window. When this option is set, the other window actually displays
2000 an indirect buffer clone of the current buffer, to avoid any visibility
2001 changes to the current buffer."
2002 :group
'org-link-follow
2005 (defcustom org-open-non-existing-files nil
2006 "Non-nil means `org-open-file' will open non-existing files.
2007 When nil, an error will be generated.
2008 This variable applies only to external applications because they
2009 might choke on non-existing files. If the link is to a file that
2010 will be opened in Emacs, the variable is ignored."
2011 :group
'org-link-follow
2014 (defcustom org-open-directory-means-index-dot-org nil
2015 "Non-nil means a link to a directory really means to index.org.
2016 When nil, following a directory link will run dired or open a finder/explorer
2017 window on that directory."
2018 :group
'org-link-follow
2021 (defcustom org-confirm-shell-link-function
'yes-or-no-p
2022 "Non-nil means ask for confirmation before executing shell links.
2023 Shell links can be dangerous: just think about a link
2025 [[shell:rm -rf ~/*][Google Search]]
2027 This link would show up in your Org-mode document as \"Google Search\",
2028 but really it would remove your entire home directory.
2029 Therefore we advise against setting this variable to nil.
2030 Just change it to `y-or-n-p' if you want to confirm with a
2031 single keystroke rather than having to type \"yes\"."
2032 :group
'org-link-follow
2034 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2035 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2036 (const :tag
"no confirmation (dangerous)" nil
)))
2037 (put 'org-confirm-shell-link-function
2038 'safe-local-variable
2039 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2041 (defcustom org-confirm-shell-link-not-regexp
""
2042 "A regexp to skip confirmation for shell links."
2043 :group
'org-link-follow
2047 (defcustom org-confirm-elisp-link-function
'yes-or-no-p
2048 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2049 Elisp links can be dangerous: just think about a link
2051 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2053 This link would show up in your Org-mode document as \"Google Search\",
2054 but really it would remove your entire home directory.
2055 Therefore we advise against setting this variable to nil.
2056 Just change it to `y-or-n-p' if you want to confirm with a
2057 single keystroke rather than having to type \"yes\"."
2058 :group
'org-link-follow
2060 (const :tag
"with yes-or-no (safer)" yes-or-no-p
)
2061 (const :tag
"with y-or-n (faster)" y-or-n-p
)
2062 (const :tag
"no confirmation (dangerous)" nil
)))
2063 (put 'org-confirm-shell-link-function
2064 'safe-local-variable
2065 (lambda (x) (member x
'(yes-or-no-p y-or-n-p
))))
2067 (defcustom org-confirm-elisp-link-not-regexp
""
2068 "A regexp to skip confirmation for Elisp links."
2069 :group
'org-link-follow
2073 (defconst org-file-apps-defaults-gnu
2077 "Default file applications on a UNIX or GNU/Linux system.
2078 See `org-file-apps'.")
2080 (defconst org-file-apps-defaults-macosx
2083 (system .
"open %s")
2085 ("eps.gz" .
"gv %s")
2087 ("fig" .
"xfig %s"))
2088 "Default file applications on a MacOS X system.
2089 The system \"open\" is known as a default, but we use X11 applications
2090 for some files for which the OS does not have a good default.
2091 See `org-file-apps'.")
2093 (defconst org-file-apps-defaults-windowsnt
2097 (list (if (featurep 'xemacs
)
2098 'mswindows-shell-execute
2102 (list (if (featurep 'xemacs
)
2103 'mswindows-shell-execute
2106 "Default file applications on a Windows NT system.
2107 The system \"open\" is used for most files.
2108 See `org-file-apps'.")
2110 (defcustom org-file-apps
2111 '((auto-mode . emacs
)
2112 ("\\.mm\\'" . default
)
2113 ("\\.x?html?\\'" . default
)
2114 ("\\.pdf\\'" . default
))
2115 "External applications for opening `file:path' items in a document.
2116 Org-mode uses system defaults for different file types, but
2117 you can use this variable to set the application for a given file
2118 extension. The entries in this list are cons cells where the car identifies
2119 files and the cdr the corresponding command. Possible values for the
2121 \"string\" A string as a file identifier can be interpreted in different
2122 ways, depending on its contents:
2124 - Alphanumeric characters only:
2125 Match links with this file extension.
2126 Example: (\"pdf\" . \"evince %s\")
2127 to open PDFs with evince.
2129 - Regular expression: Match links where the
2130 filename matches the regexp. If you want to
2131 use groups here, use shy groups.
2133 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2134 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2135 to open *.html and *.xhtml with firefox.
2137 - Regular expression which contains (non-shy) groups:
2138 Match links where the whole link, including \"::\", and
2139 anything after that, matches the regexp.
2140 In a custom command string, %1, %2, etc. are replaced with
2141 the parts of the link that were matched by the groups.
2142 For backwards compatibility, if a command string is given
2143 that does not use any of the group matches, this case is
2144 handled identically to the second one (i.e. match against
2146 In a custom lisp form, you can access the group matches with
2147 (match-string n link).
2149 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2150 to open [[file:document.pdf::5]] with evince at page 5.
2152 `directory' Matches a directory
2153 `remote' Matches a remote file, accessible through tramp or efs.
2154 Remote files most likely should be visited through Emacs
2155 because external applications cannot handle such paths.
2156 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2157 so all files Emacs knows how to handle. Using this with
2158 command `emacs' will open most files in Emacs. Beware that this
2159 will also open html files inside Emacs, unless you add
2160 (\"html\" . default) to the list as well.
2161 t Default for files not matched by any of the other options.
2162 `system' The system command to open files, like `open' on Windows
2163 and Mac OS X, and mailcap under GNU/Linux. This is the command
2164 that will be selected if you call `C-c C-o' with a double
2165 \\[universal-argument] \\[universal-argument] prefix.
2167 Possible values for the command are:
2168 `emacs' The file will be visited by the current Emacs process.
2169 `default' Use the default application for this file type, which is the
2170 association for t in the list, most likely in the system-specific
2172 This can be used to overrule an unwanted setting in the
2173 system-specific variable.
2174 `system' Use the system command for opening files, like \"open\".
2175 This command is specified by the entry whose car is `system'.
2176 Most likely, the system-specific version of this variable
2177 does define this command, but you can overrule/replace it
2179 string A command to be executed by a shell; %s will be replaced
2180 by the path to the file.
2181 sexp A Lisp form which will be evaluated. The file path will
2182 be available in the Lisp variable `file'.
2183 For more examples, see the system specific constants
2184 `org-file-apps-defaults-macosx'
2185 `org-file-apps-defaults-windowsnt'
2186 `org-file-apps-defaults-gnu'."
2187 :group
'org-link-follow
2189 (cons (choice :value
""
2190 (string :tag
"Extension")
2191 (const :tag
"System command to open files" system
)
2192 (const :tag
"Default for unrecognized files" t
)
2193 (const :tag
"Remote file" remote
)
2194 (const :tag
"Links to a directory" directory
)
2195 (const :tag
"Any files that have Emacs modes"
2198 (const :tag
"Visit with Emacs" emacs
)
2199 (const :tag
"Use default" default
)
2200 (const :tag
"Use the system command" system
)
2201 (string :tag
"Command")
2202 (sexp :tag
"Lisp form")))))
2204 (defcustom org-doi-server-url
"http://dx.doi.org/"
2205 "The URL of the DOI server."
2208 :group
'org-link-follow
)
2210 (defgroup org-refile nil
2211 "Options concerning refiling entries in Org-mode."
2215 (defcustom org-directory
"~/org"
2216 "Directory with org files.
2217 This is just a default location to look for Org files. There is no need
2218 at all to put your files into this directory. It is only used in the
2219 following situations:
2221 1. When a capture template specifies a target file that is not an
2222 absolute path. The path will then be interpreted relative to
2224 2. When a capture note is filed away in an interactive way (when exiting the
2225 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2226 with `org-directory' as the default path."
2231 (defcustom org-default-notes-file
(convert-standard-filename "~/.notes")
2232 "Default target for storing notes.
2233 Used as a fall back file for org-capture.el, for templates that
2234 do not specify a target file."
2238 (const :tag
"Default from remember-data-file" nil
)
2241 (defcustom org-goto-interface
'outline
2242 "The default interface to be used for `org-goto'.
2244 outline The interface shows an outline of the relevant file
2245 and the correct heading is found by moving through
2246 the outline or by searching with incremental search.
2247 outline-path-completion Headlines in the current buffer are offered via
2248 completion. This is the interface also used by
2249 the refile command."
2252 (const :tag
"Outline" outline
)
2253 (const :tag
"Outline-path-completion" outline-path-completion
)))
2255 (defcustom org-goto-max-level
5
2256 "Maximum target level when running `org-goto' with refile interface."
2260 (defcustom org-reverse-note-order nil
2261 "Non-nil means store new notes at the beginning of a file or entry.
2262 When nil, new notes will be filed to the end of a file or entry.
2263 This can also be a list with cons cells of regular expressions that
2264 are matched against file names, and values."
2268 (const :tag
"Reverse always" t
)
2269 (const :tag
"Reverse never" nil
)
2270 (repeat :tag
"By file name regexp"
2271 (cons regexp boolean
))))
2273 (defcustom org-log-refile nil
2274 "Information to record when a task is refiled.
2276 Possible values are:
2278 nil Don't add anything
2279 time Add a time stamp to the task
2280 note Prompt for a note and add it with template `org-log-note-headings'
2282 This option can also be set with on a per-file-basis with
2284 #+STARTUP: nologrefile
2285 #+STARTUP: logrefile
2286 #+STARTUP: lognoterefile
2288 You can have local logging settings for a subtree by setting the LOGGING
2289 property to one or more of these keywords.
2291 When bulk-refiling from the agenda, the value `note' is forbidden and
2292 will temporarily be changed to `time'."
2294 :group
'org-progress
2297 (const :tag
"No logging" nil
)
2298 (const :tag
"Record timestamp" time
)
2299 (const :tag
"Record timestamp with note." note
)))
2301 (defcustom org-refile-targets nil
2302 "Targets for refiling entries with \\[org-refile].
2303 This is a list of cons cells. Each cell contains:
2304 - a specification of the files to be considered, either a list of files,
2305 or a symbol whose function or variable value will be used to retrieve
2306 a file name or a list of file names. If you use `org-agenda-files' for
2307 that, all agenda files will be scanned for targets. Nil means consider
2308 headings in the current buffer.
2309 - A specification of how to find candidate refile targets. This may be
2311 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2312 This tag has to be present in all target headlines, inheritance will
2314 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2316 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2317 headlines that are refiling targets.
2318 - a cons cell (:level . N). Any headline of level N is considered a target.
2319 Note that, when `org-odd-levels-only' is set, level corresponds to
2320 order in hierarchy, not to the number of stars.
2321 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2322 Note that, when `org-odd-levels-only' is set, level corresponds to
2323 order in hierarchy, not to the number of stars.
2325 Each element of this list generates a set of possible targets.
2326 The union of these sets is presented (with completion) to
2327 the user by `org-refile'.
2329 You can set the variable `org-refile-target-verify-function' to a function
2330 to verify each headline found by the simple criteria above.
2332 When this variable is nil, all top-level headlines in the current buffer
2333 are used, equivalent to the value `((nil . (:level . 1))'."
2337 (choice :value org-agenda-files
2338 (const :tag
"All agenda files" org-agenda-files
)
2339 (const :tag
"Current buffer" nil
)
2340 (function) (variable) (file))
2341 (choice :tag
"Identify target headline by"
2342 (cons :tag
"Specific tag" (const :value
:tag
) (string))
2343 (cons :tag
"TODO keyword" (const :value
:todo
) (string))
2344 (cons :tag
"Regular expression" (const :value
:regexp
) (regexp))
2345 (cons :tag
"Level number" (const :value
:level
) (integer))
2346 (cons :tag
"Max Level number" (const :value
:maxlevel
) (integer))))))
2348 (defcustom org-refile-target-verify-function nil
2349 "Function to verify if the headline at point should be a refile target.
2350 The function will be called without arguments, with point at the
2351 beginning of the headline. It should return t and leave point
2352 where it is if the headline is a valid target for refiling.
2354 If the target should not be selected, the function must return nil.
2355 In addition to this, it may move point to a place from where the search
2356 should be continued. For example, the function may decide that the entire
2357 subtree of the current entry should be excluded and move point to the end
2364 (defcustom org-refile-use-cache nil
2365 "Non-nil means cache refile targets to speed up the process.
2366 The cache for a particular file will be updated automatically when
2367 the buffer has been killed, or when any of the marker used for flagging
2368 refile targets no longer points at a live buffer.
2369 If you have added new entries to a buffer that might themselves be targets,
2370 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2371 find that easier, `C-u C-u C-u C-c C-w'."
2376 (defcustom org-refile-use-outline-path nil
2377 "Non-nil means provide refile targets as paths.
2378 So a level 3 headline will be available as level1/level2/level3.
2380 When the value is `file', also include the file name (without directory)
2381 into the path. In this case, you can also stop the completion after
2382 the file name, to get entries inserted as top level in the file.
2384 When `full-file-path', include the full file path."
2387 (const :tag
"Not" nil
)
2388 (const :tag
"Yes" t
)
2389 (const :tag
"Start with file name" file
)
2390 (const :tag
"Start with full file path" full-file-path
)))
2392 (defcustom org-outline-path-complete-in-steps t
2393 "Non-nil means complete the outline path in hierarchical steps.
2394 When Org-mode uses the refile interface to select an outline path
2395 \(see variable `org-refile-use-outline-path'), the completion of
2396 the path can be done is a single go, or if can be done in steps down
2397 the headline hierarchy. Going in steps is probably the best if you
2398 do not use a special completion package like `ido' or `icicles'.
2399 However, when using these packages, going in one step can be very
2400 fast, while still showing the whole path to the entry."
2404 (defcustom org-refile-allow-creating-parent-nodes nil
2405 "Non-nil means allow to create new nodes as refile targets.
2406 New nodes are then created by adding \"/new node name\" to the completion
2407 of an existing node. When the value of this variable is `confirm',
2408 new node creation must be confirmed by the user (recommended).
2409 When nil, the completion must match an existing entry.
2411 Note that, if the new heading is not seen by the criteria
2412 listed in `org-refile-targets', multiple instances of the same
2413 heading would be created by trying again to file under the new
2417 (const :tag
"Never" nil
)
2418 (const :tag
"Always" t
)
2419 (const :tag
"Prompt for confirmation" confirm
)))
2421 (defcustom org-refile-active-region-within-subtree nil
2422 "Non-nil means also refile active region within a subtree.
2424 By default `org-refile' doesn't allow refiling regions if they
2425 don't contain a set of subtrees, but it might be convenient to
2426 do so sometimes: in that case, the first line of the region is
2427 converted to a headline before refiling."
2432 (defgroup org-todo nil
2433 "Options concerning TODO items in Org-mode."
2437 (defgroup org-progress nil
2438 "Options concerning Progress logging in Org-mode."
2442 (defvar org-todo-interpretation-widgets
2443 '((:tag
"Sequence (cycling hits every state)" sequence
)
2444 (:tag
"Type (cycling directly to DONE)" type
))
2445 "The available interpretation symbols for customizing `org-todo-keywords'.
2446 Interested libraries should add to this list.")
2448 (defcustom org-todo-keywords
'((sequence "TODO" "DONE"))
2449 "List of TODO entry keyword sequences and their interpretation.
2450 \\<org-mode-map>This is a list of sequences.
2452 Each sequence starts with a symbol, either `sequence' or `type',
2453 indicating if the keywords should be interpreted as a sequence of
2454 action steps, or as different types of TODO items. The first
2455 keywords are states requiring action - these states will select a headline
2456 for inclusion into the global TODO list Org-mode produces. If one of
2457 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2458 signify that no further action is necessary. If \"|\" is not found,
2459 the last keyword is treated as the only DONE state of the sequence.
2461 The command \\[org-todo] cycles an entry through these states, and one
2462 additional state where no keyword is present. For details about this
2463 cycling, see the manual.
2465 TODO keywords and interpretation can also be set on a per-file basis with
2466 the special #+SEQ_TODO and #+TYP_TODO lines.
2468 Each keyword can optionally specify a character for fast state selection
2469 \(in combination with the variable `org-use-fast-todo-selection')
2470 and specifiers for state change logging, using the same syntax that
2471 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2472 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2473 indicates to record a time stamp each time this state is selected.
2475 Each keyword may also specify if a timestamp or a note should be
2476 recorded when entering or leaving the state, by adding additional
2477 characters in the parenthesis after the keyword. This looks like this:
2478 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2479 record only the time of the state change. With X and Y being either
2480 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2481 Y when leaving the state if and only if the *target* state does not
2482 define X. You may omit any of the fast-selection key or X or /Y,
2483 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2485 For backward compatibility, this variable may also be just a list
2486 of keywords. In this case the interpretation (sequence or type) will be
2487 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2489 :group
'org-keywords
2491 (repeat :tag
"Old syntax, just keywords"
2492 (string :tag
"Keyword"))
2493 (repeat :tag
"New syntax"
2496 :tag
"Interpretation"
2497 ;;Quick and dirty way to see
2498 ;;`org-todo-interpretations'. This takes the
2499 ;;place of item arguments
2507 org-todo-interpretation-widgets
))
2510 (string :tag
"Keyword"))))))
2512 (defvar org-todo-keywords-1 nil
2513 "All TODO and DONE keywords active in a buffer.")
2514 (make-variable-buffer-local 'org-todo-keywords-1
)
2515 (defvar org-todo-keywords-for-agenda nil
)
2516 (defvar org-done-keywords-for-agenda nil
)
2517 (defvar org-todo-keyword-alist-for-agenda nil
)
2518 (defvar org-tag-alist-for-agenda nil
2519 "Alist of all tags from all agenda files.")
2520 (defvar org-tag-groups-alist-for-agenda nil
2521 "Alist of all groups tags from all current agenda files.")
2522 (defvar org-tag-groups-alist nil
)
2523 (make-variable-buffer-local 'org-tag-groups-alist
)
2524 (defvar org-agenda-contributing-files nil
)
2525 (defvar org-not-done-keywords nil
)
2526 (make-variable-buffer-local 'org-not-done-keywords
)
2527 (defvar org-done-keywords nil
)
2528 (make-variable-buffer-local 'org-done-keywords
)
2529 (defvar org-todo-heads nil
)
2530 (make-variable-buffer-local 'org-todo-heads
)
2531 (defvar org-todo-sets nil
)
2532 (make-variable-buffer-local 'org-todo-sets
)
2533 (defvar org-todo-log-states nil
)
2534 (make-variable-buffer-local 'org-todo-log-states
)
2535 (defvar org-todo-kwd-alist nil
)
2536 (make-variable-buffer-local 'org-todo-kwd-alist
)
2537 (defvar org-todo-key-alist nil
)
2538 (make-variable-buffer-local 'org-todo-key-alist
)
2539 (defvar org-todo-key-trigger nil
)
2540 (make-variable-buffer-local 'org-todo-key-trigger
)
2542 (defcustom org-todo-interpretation
'sequence
2543 "Controls how TODO keywords are interpreted.
2544 This variable is in principle obsolete and is only used for
2545 backward compatibility, if the interpretation of todo keywords is
2546 not given already in `org-todo-keywords'. See that variable for
2549 :group
'org-keywords
2550 :type
'(choice (const sequence
)
2553 (defcustom org-use-fast-todo-selection t
2554 "Non-nil means use the fast todo selection scheme with C-c C-t.
2555 This variable describes if and under what circumstances the cycling
2556 mechanism for TODO keywords will be replaced by a single-key, direct
2559 When nil, fast selection is never used.
2561 When the symbol `prefix', it will be used when `org-todo' is called
2562 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2563 `C-u t' in an agenda buffer.
2565 When t, fast selection is used by default. In this case, the prefix
2566 argument forces cycling instead.
2568 In all cases, the special interface is only used if access keys have
2569 actually been assigned by the user, i.e. if keywords in the configuration
2570 are followed by a letter in parenthesis, like TODO(t)."
2573 (const :tag
"Never" nil
)
2574 (const :tag
"By default" t
)
2575 (const :tag
"Only with C-u C-c C-t" prefix
)))
2577 (defcustom org-provide-todo-statistics t
2578 "Non-nil means update todo statistics after insert and toggle.
2579 ALL-HEADLINES means update todo statistics by including headlines
2580 with no TODO keyword as well, counting them as not done.
2581 A list of TODO keywords means the same, but skip keywords that are
2583 When set to a list of two lists, the first list contains keywords
2584 to consider as TODO keywords, the second list contains keywords
2585 to consider as DONE keywords.
2587 When this is set, todo statistics is updated in the parent of the
2588 current entry each time a todo state is changed."
2591 (const :tag
"Yes, only for TODO entries" t
)
2592 (const :tag
"Yes, including all entries" all-headlines
)
2593 (repeat :tag
"Yes, for TODOs in this list"
2594 (string :tag
"TODO keyword"))
2595 (list :tag
"Yes, for TODOs and DONEs in these lists"
2596 (repeat (string :tag
"TODO keyword"))
2597 (repeat (string :tag
"DONE keyword")))
2598 (other :tag
"No TODO statistics" nil
)))
2600 (defcustom org-hierarchical-todo-statistics t
2601 "Non-nil means TODO statistics covers just direct children.
2602 When nil, all entries in the subtree are considered.
2603 This has only an effect if `org-provide-todo-statistics' is set.
2604 To set this to nil for only a single subtree, use a COOKIE_DATA
2605 property and include the word \"recursive\" into the value."
2609 (defcustom org-after-todo-state-change-hook nil
2610 "Hook which is run after the state of a TODO item was changed.
2611 The new state (a string with a TODO keyword, or nil) is available in the
2612 Lisp variable `org-state'."
2616 (defvar org-blocker-hook nil
2617 "Hook for functions that are allowed to block a state change.
2619 Functions in this hook should not modify the buffer.
2620 Each function gets as its single argument a property list,
2621 see `org-trigger-hook' for more information about this list.
2623 If any of the functions in this hook returns nil, the state change
2626 (defvar org-trigger-hook nil
2627 "Hook for functions that are triggered by a state change.
2629 Each function gets as its single argument a property list with at
2630 least the following elements:
2632 (:type type-of-change :position pos-at-entry-start
2633 :from old-state :to new-state)
2635 Depending on the type, more properties may be present.
2637 This mechanism is currently implemented for:
2641 :type todo-state-change
2642 :from previous state (keyword as a string), or nil, or a symbol
2643 'todo' or 'done', to indicate the general type of state.
2644 :to new state, like in :from")
2646 (defcustom org-enforce-todo-dependencies nil
2647 "Non-nil means undone TODO entries will block switching the parent to DONE.
2648 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2649 be blocked if any prior sibling is not yet done.
2650 Finally, if the parent is blocked because of ordered siblings of its own,
2651 the child will also be blocked."
2652 :set
(lambda (var val
)
2655 (add-hook 'org-blocker-hook
2656 'org-block-todo-from-children-or-siblings-or-parent
)
2657 (remove-hook 'org-blocker-hook
2658 'org-block-todo-from-children-or-siblings-or-parent
)))
2662 (defcustom org-enforce-todo-checkbox-dependencies nil
2663 "Non-nil means unchecked boxes will block switching the parent to DONE.
2664 When this is nil, checkboxes have no influence on switching TODO states.
2665 When non-nil, you first need to check off all check boxes before the TODO
2666 entry can be switched to DONE.
2667 This variable needs to be set before org.el is loaded, and you need to
2668 restart Emacs after a change to make the change effective. The only way
2669 to change is while Emacs is running is through the customize interface."
2670 :set
(lambda (var val
)
2673 (add-hook 'org-blocker-hook
2674 'org-block-todo-from-checkboxes
)
2675 (remove-hook 'org-blocker-hook
2676 'org-block-todo-from-checkboxes
)))
2680 (defcustom org-treat-insert-todo-heading-as-state-change nil
2681 "Non-nil means inserting a TODO heading is treated as state change.
2682 So when the command \\[org-insert-todo-heading] is used, state change
2683 logging will apply if appropriate. When nil, the new TODO item will
2684 be inserted directly, and no logging will take place."
2688 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2689 "Non-nil means switching TODO states with S-cursor counts as state change.
2690 This is the default behavior. However, setting this to nil allows a
2691 convenient way to select a TODO state and bypass any logging associated
2696 (defcustom org-todo-state-tags-triggers nil
2697 "Tag changes that should be triggered by TODO state changes.
2698 This is a list. Each entry is
2700 (state-change (tag . flag) .......)
2702 State-change can be a string with a state, and empty string to indicate the
2703 state that has no TODO keyword, or it can be one of the symbols `todo'
2704 or `done', meaning any not-done or done state, respectively."
2708 (cons (choice :tag
"When changing to"
2709 (const :tag
"Not-done state" todo
)
2710 (const :tag
"Done state" done
)
2711 (string :tag
"State"))
2713 (cons :tag
"Tag action"
2715 (choice (const :tag
"Add" t
) (const :tag
"Remove" nil
)))))))
2717 (defcustom org-log-done nil
2718 "Information to record when a task moves to the DONE state.
2720 Possible values are:
2722 nil Don't add anything, just change the keyword
2723 time Add a time stamp to the task
2724 note Prompt for a note and add it with template `org-log-note-headings'
2726 This option can also be set with on a per-file-basis with
2728 #+STARTUP: nologdone
2730 #+STARTUP: lognotedone
2732 You can have local logging settings for a subtree by setting the LOGGING
2733 property to one or more of these keywords."
2735 :group
'org-progress
2737 (const :tag
"No logging" nil
)
2738 (const :tag
"Record CLOSED timestamp" time
)
2739 (const :tag
"Record CLOSED timestamp with note." note
)))
2741 ;; Normalize old uses of org-log-done.
2743 ((eq org-log-done t
) (setq org-log-done
'time
))
2744 ((and (listp org-log-done
) (memq 'done org-log-done
))
2745 (setq org-log-done
'note
)))
2747 (defcustom org-log-reschedule nil
2748 "Information to record when the scheduling date of a tasks is modified.
2750 Possible values are:
2752 nil Don't add anything, just change the date
2753 time Add a time stamp to the task
2754 note Prompt for a note and add it with template `org-log-note-headings'
2756 This option can also be set with on a per-file-basis with
2758 #+STARTUP: nologreschedule
2759 #+STARTUP: logreschedule
2760 #+STARTUP: lognotereschedule"
2762 :group
'org-progress
2764 (const :tag
"No logging" nil
)
2765 (const :tag
"Record timestamp" time
)
2766 (const :tag
"Record timestamp with note." note
)))
2768 (defcustom org-log-redeadline nil
2769 "Information to record when the deadline date of a tasks is modified.
2771 Possible values are:
2773 nil Don't add anything, just change the date
2774 time Add a time stamp to the task
2775 note Prompt for a note and add it with template `org-log-note-headings'
2777 This option can also be set with on a per-file-basis with
2779 #+STARTUP: nologredeadline
2780 #+STARTUP: logredeadline
2781 #+STARTUP: lognoteredeadline
2783 You can have local logging settings for a subtree by setting the LOGGING
2784 property to one or more of these keywords."
2786 :group
'org-progress
2788 (const :tag
"No logging" nil
)
2789 (const :tag
"Record timestamp" time
)
2790 (const :tag
"Record timestamp with note." note
)))
2792 (defcustom org-log-note-clock-out nil
2793 "Non-nil means record a note when clocking out of an item.
2794 This can also be configured on a per-file basis by adding one of
2795 the following lines anywhere in the buffer:
2797 #+STARTUP: lognoteclock-out
2798 #+STARTUP: nolognoteclock-out"
2800 :group
'org-progress
2803 (defcustom org-log-done-with-time t
2804 "Non-nil means the CLOSED time stamp will contain date and time.
2805 When nil, only the date will be recorded."
2806 :group
'org-progress
2809 (defcustom org-log-note-headings
2810 '((done .
"CLOSING NOTE %t")
2811 (state .
"State %-12s from %-12S %t")
2812 (note .
"Note taken on %t")
2813 (reschedule .
"Rescheduled from %S on %t")
2814 (delschedule .
"Not scheduled, was %S on %t")
2815 (redeadline .
"New deadline from %S on %t")
2816 (deldeadline .
"Removed deadline, was %S on %t")
2817 (refile .
"Refiled on %t")
2819 "Headings for notes added to entries.
2820 The value is an alist, with the car being a symbol indicating the note
2821 context, and the cdr is the heading to be used. The heading may also be the
2823 %t in the heading will be replaced by a time stamp.
2824 %T will be an active time stamp instead the default inactive one
2825 %d will be replaced by a short-format time stamp.
2826 %D will be replaced by an active short-format time stamp.
2827 %s will be replaced by the new TODO state, in double quotes.
2828 %S will be replaced by the old TODO state, in double quotes.
2829 %u will be replaced by the user name.
2830 %U will be replaced by the full user name.
2832 In fact, it is not a good idea to change the `state' entry, because
2833 agenda log mode depends on the format of these entries."
2835 :group
'org-progress
2836 :type
'(list :greedy t
2837 (cons (const :tag
"Heading when closing an item" done
) string
)
2839 "Heading when changing todo state (todo sequence only)"
2841 (cons (const :tag
"Heading when just taking a note" note
) string
)
2842 (cons (const :tag
"Heading when rescheduling" reschedule
) string
)
2843 (cons (const :tag
"Heading when an item is no longer scheduled" delschedule
) string
)
2844 (cons (const :tag
"Heading when changing deadline" redeadline
) string
)
2845 (cons (const :tag
"Heading when deleting a deadline" deldeadline
) string
)
2846 (cons (const :tag
"Heading when refiling" refile
) string
)
2847 (cons (const :tag
"Heading when clocking out" clock-out
) string
)))
2849 (unless (assq 'note org-log-note-headings
)
2850 (push '(note .
"%t") org-log-note-headings
))
2852 (defcustom org-log-into-drawer nil
2853 "Non-nil means insert state change notes and time stamps into a drawer.
2854 When nil, state changes notes will be inserted after the headline and
2855 any scheduling and clock lines, but not inside a drawer.
2857 The value of this variable should be the name of the drawer to use.
2858 LOGBOOK is proposed as the default drawer for this purpose, you can
2859 also set this to a string to define the drawer of your choice.
2861 A value of t is also allowed, representing \"LOGBOOK\".
2863 A value of t or nil can also be set with on a per-file-basis with
2865 #+STARTUP: logdrawer
2866 #+STARTUP: nologdrawer
2868 If this variable is set, `org-log-state-notes-insert-after-drawers'
2871 You can set the property LOG_INTO_DRAWER to overrule this setting for
2874 :group
'org-progress
2876 (const :tag
"Not into a drawer" nil
)
2877 (const :tag
"LOGBOOK" t
)
2878 (string :tag
"Other")))
2880 (org-defvaralias 'org-log-state-notes-into-drawer
'org-log-into-drawer
)
2882 (defun org-log-into-drawer ()
2883 "Return the value of `org-log-into-drawer', but let properties overrule.
2884 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2885 used instead of the default value."
2886 (let ((p (org-entry-get nil
"LOG_INTO_DRAWER" 'inherit t
)))
2888 ((not p
) org-log-into-drawer
)
2889 ((equal p
"nil") nil
)
2890 ((equal p
"t") "LOGBOOK")
2893 (defcustom org-log-state-notes-insert-after-drawers nil
2894 "Non-nil means insert state change notes after any drawers in entry.
2895 Only the drawers that *immediately* follow the headline and the
2896 deadline/scheduled line are skipped.
2897 When nil, insert notes right after the heading and perhaps the line
2898 with deadline/scheduling if present.
2900 This variable will have no effect if `org-log-into-drawer' is
2903 :group
'org-progress
2906 (defcustom org-log-states-order-reversed t
2907 "Non-nil means the latest state note will be directly after heading.
2908 When nil, the state change notes will be ordered according to time.
2910 This option can also be set with on a per-file-basis with
2912 #+STARTUP: logstatesreversed
2913 #+STARTUP: nologstatesreversed"
2915 :group
'org-progress
2918 (defcustom org-todo-repeat-to-state nil
2919 "The TODO state to which a repeater should return the repeating task.
2920 By default this is the first task in a TODO sequence, or the previous state
2921 in a TODO_TYP set. But you can specify another task here.
2922 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2925 :type
'(choice (const :tag
"Head of sequence" nil
)
2926 (string :tag
"Specific state")))
2928 (defcustom org-log-repeat
'time
2929 "Non-nil means record moving through the DONE state when triggering repeat.
2930 An auto-repeating task is immediately switched back to TODO when
2931 marked DONE. If you are not logging state changes (by adding \"@\"
2932 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2933 record a closing note, there will be no record of the task moving
2934 through DONE. This variable forces taking a note anyway.
2936 nil Don't force a record
2937 time Record a time stamp
2938 note Prompt for a note and add it with template `org-log-note-headings'
2940 This option can also be set with on a per-file-basis with
2942 #+STARTUP: nologrepeat
2943 #+STARTUP: logrepeat
2944 #+STARTUP: lognoterepeat
2946 You can have local logging settings for a subtree by setting the LOGGING
2947 property to one or more of these keywords."
2949 :group
'org-progress
2951 (const :tag
"Don't force a record" nil
)
2952 (const :tag
"Force recording the DONE state" time
)
2953 (const :tag
"Force recording a note with the DONE state" note
)))
2956 (defgroup org-priorities nil
2957 "Priorities in Org-mode."
2958 :tag
"Org Priorities"
2961 (defcustom org-enable-priority-commands t
2962 "Non-nil means priority commands are active.
2963 When nil, these commands will be disabled, so that you never accidentally
2965 :group
'org-priorities
2968 (defcustom org-highest-priority ?A
2969 "The highest priority of TODO items. A character like ?A, ?B etc.
2970 Must have a smaller ASCII number than `org-lowest-priority'."
2971 :group
'org-priorities
2974 (defcustom org-lowest-priority ?C
2975 "The lowest priority of TODO items. A character like ?A, ?B etc.
2976 Must have a larger ASCII number than `org-highest-priority'."
2977 :group
'org-priorities
2980 (defcustom org-default-priority ?B
2981 "The default priority of TODO items.
2982 This is the priority an item gets if no explicit priority is given.
2983 When starting to cycle on an empty priority the first step in the cycle
2984 depends on `org-priority-start-cycle-with-default'. The resulting first
2985 step priority must not exceed the range from `org-highest-priority' to
2986 `org-lowest-priority' which means that `org-default-priority' has to be
2987 in this range exclusive or inclusive the range boundaries. Else the
2988 first step refuses to set the default and the second will fall back
2989 to (depending on the command used) the highest or lowest priority."
2990 :group
'org-priorities
2993 (defcustom org-priority-start-cycle-with-default t
2994 "Non-nil means start with default priority when starting to cycle.
2995 When this is nil, the first step in the cycle will be (depending on the
2996 command used) one higher or lower than the default priority.
2997 See also `org-default-priority'."
2998 :group
'org-priorities
3001 (defcustom org-get-priority-function nil
3002 "Function to extract the priority from a string.
3003 The string is normally the headline. If this is nil Org computes the
3004 priority from the priority cookie like [#A] in the headline. It returns
3005 an integer, increasing by 1000 for each priority level.
3006 The user can set a different function here, which should take a string
3007 as an argument and return the numeric priority."
3008 :group
'org-priorities
3014 (defgroup org-time nil
3015 "Options concerning time stamps and deadlines in Org-mode."
3019 (defcustom org-insert-labeled-timestamps-at-point nil
3020 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
3021 When nil, these labeled time stamps are forces into the second line of an
3022 entry, just after the headline. When scheduling from the global TODO list,
3023 the time stamp will always be forced into the second line."
3027 (defcustom org-time-stamp-rounding-minutes
'(0 5)
3028 "Number of minutes to round time stamps to.
3029 These are two values, the first applies when first creating a time stamp.
3030 The second applies when changing it with the commands `S-up' and `S-down'.
3031 When changing the time stamp, this means that it will change in steps
3032 of N minutes, as given by the second value.
3034 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3035 numbers should be factors of 60, so for example 5, 10, 15.
3037 When this is larger than 1, you can still force an exact time stamp by using
3038 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3039 and by using a prefix arg to `S-up/down' to specify the exact number
3040 of minutes to shift."
3042 :get
(lambda (var) ; Make sure both elements are there
3043 (if (integerp (default-value var
))
3044 (list (default-value var
) 5)
3045 (default-value var
)))
3047 (integer :tag
"when inserting times")
3048 (integer :tag
"when modifying times")))
3050 ;; Normalize old customizations of this variable.
3051 (when (integerp org-time-stamp-rounding-minutes
)
3052 (setq org-time-stamp-rounding-minutes
3053 (list org-time-stamp-rounding-minutes
3054 org-time-stamp-rounding-minutes
)))
3056 (defcustom org-display-custom-times nil
3057 "Non-nil means overlay custom formats over all time stamps.
3058 The formats are defined through the variable `org-time-stamp-custom-formats'.
3059 To turn this on on a per-file basis, insert anywhere in the file:
3060 #+STARTUP: customtime"
3064 (make-variable-buffer-local 'org-display-custom-times
)
3066 (defcustom org-time-stamp-custom-formats
3067 '("<%m/%d/%y %a>" .
"<%m/%d/%y %a %H:%M>") ; american
3068 "Custom formats for time stamps. See `format-time-string' for the syntax.
3069 These are overlaid over the default ISO format if the variable
3070 `org-display-custom-times' is set. Time like %H:%M should be at the
3071 end of the second format. The custom formats are also honored by export
3072 commands, if custom time display is turned on at the time of export."
3076 (defun org-time-stamp-format (&optional long inactive
)
3077 "Get the right format for a time string."
3078 (let ((f (if long
(cdr org-time-stamp-formats
)
3079 (car org-time-stamp-formats
))))
3081 (concat "[" (substring f
1 -
1) "]")
3084 (defcustom org-time-clocksum-format
3085 '(:days
"%dd " :hours
"%d" :require-hours t
:minutes
":%02d" :require-minutes t
)
3086 "The format string used when creating CLOCKSUM lines.
3087 This is also used when Org mode generates a time duration.
3089 The value can be a single format string containing two
3090 %-sequences, which will be filled with the number of hours and
3091 minutes in that order.
3093 Alternatively, the value can be a plist associating any of the
3094 keys :years, :months, :weeks, :days, :hours or :minutes with
3095 format strings. The time duration is formatted using only the
3096 time components that are needed and concatenating the results.
3097 If a time unit in absent, it falls back to the next smallest
3100 The keys :require-years, :require-months, :require-days,
3101 :require-weeks, :require-hours, :require-minutes are also
3102 meaningful. A non-nil value for these keys indicates that the
3103 corresponding time component should always be included, even if
3109 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3112 means durations longer than a day will be expressed in days,
3113 hours and minutes, and durations less than a day will always be
3114 expressed in hours and minutes (even for durations less than an
3119 \(:days \"%dd\" :minutes \"%dm\")
3121 means durations longer than a day will be expressed in days and
3122 minutes, and durations less than a day will be expressed entirely
3123 in minutes (even for durations longer than an hour)."
3127 :package-version
'(Org .
"8.0")
3128 :type
'(choice (string :tag
"Format string")
3130 (group :inline t
(const :tag
"Years" :years
)
3131 (string :tag
"Format string"))
3133 (const :tag
"Always show years" :require-years
)
3135 (group :inline t
(const :tag
"Months" :months
)
3136 (string :tag
"Format string"))
3138 (const :tag
"Always show months" :require-months
)
3140 (group :inline t
(const :tag
"Weeks" :weeks
)
3141 (string :tag
"Format string"))
3143 (const :tag
"Always show weeks" :require-weeks
)
3145 (group :inline t
(const :tag
"Days" :days
)
3146 (string :tag
"Format string"))
3148 (const :tag
"Always show days" :require-days
)
3150 (group :inline t
(const :tag
"Hours" :hours
)
3151 (string :tag
"Format string"))
3153 (const :tag
"Always show hours" :require-hours
)
3155 (group :inline t
(const :tag
"Minutes" :minutes
)
3156 (string :tag
"Format string"))
3158 (const :tag
"Always show minutes" :require-minutes
)
3161 (defcustom org-time-clocksum-use-fractional nil
3162 "When non-nil, \\[org-clock-display] uses fractional times.
3163 See `org-time-clocksum-format' for more on time clock formats."
3169 (defcustom org-time-clocksum-use-effort-durations nil
3170 "When non-nil, \\[org-clock-display] uses effort durations.
3171 E.g. by default, one day is considered to be a 8 hours effort,
3172 so a task that has been clocked for 16 hours will be displayed
3173 as during 2 days in the clock display or in the clocktable.
3175 See `org-effort-durations' on how to set effort durations
3176 and `org-time-clocksum-format' for more on time clock formats."
3180 :package-version
'(Org .
"8.0")
3183 (defcustom org-time-clocksum-fractional-format
"%.2f"
3184 "The format string used when creating CLOCKSUM lines,
3185 or when Org mode generates a time duration, if
3186 `org-time-clocksum-use-fractional' is enabled.
3188 The value can be a single format string containing one
3189 %-sequence, which will be filled with the number of hours as
3192 Alternatively, the value can be a plist associating any of the
3193 keys :years, :months, :weeks, :days, :hours or :minutes with
3194 a format string. The time duration is formatted using the
3195 largest time unit which gives a non-zero integer part. If all
3196 specified formats have zero integer part, the smallest time unit
3199 :type
'(choice (string :tag
"Format string")
3200 (set (group :inline t
(const :tag
"Years" :years
)
3201 (string :tag
"Format string"))
3202 (group :inline t
(const :tag
"Months" :months
)
3203 (string :tag
"Format string"))
3204 (group :inline t
(const :tag
"Weeks" :weeks
)
3205 (string :tag
"Format string"))
3206 (group :inline t
(const :tag
"Days" :days
)
3207 (string :tag
"Format string"))
3208 (group :inline t
(const :tag
"Hours" :hours
)
3209 (string :tag
"Format string"))
3210 (group :inline t
(const :tag
"Minutes" :minutes
)
3211 (string :tag
"Format string")))))
3213 (defcustom org-deadline-warning-days
14
3214 "Number of days before expiration during which a deadline becomes active.
3215 This variable governs the display in sparse trees and in the agenda.
3216 When 0 or negative, it means use this number (the absolute value of it)
3217 even if a deadline has a different individual lead time specified.
3219 Custom commands can set this variable in the options section."
3221 :group
'org-agenda-daily
/weekly
3224 (defcustom org-scheduled-delay-days
0
3225 "Number of days before a scheduled item becomes active.
3226 This variable governs the display in sparse trees and in the agenda.
3227 The default value (i.e. 0) means: don't delay scheduled item.
3228 When negative, it means use this number (the absolute value of it)
3229 even if a scheduled item has a different individual delay time
3232 Custom commands can set this variable in the options section."
3234 :group
'org-agenda-daily
/weekly
3236 :package-version
'(Org .
"8.0")
3239 (defcustom org-read-date-prefer-future t
3240 "Non-nil means assume future for incomplete date input from user.
3241 This affects the following situations:
3242 1. The user gives a month but not a year.
3243 For example, if it is April and you enter \"feb 2\", this will be read
3244 as Feb 2, *next* year. \"May 5\", however, will be this year.
3245 2. The user gives a day, but no month.
3246 For example, if today is the 15th, and you enter \"3\", Org-mode will
3247 read this as the third of *next* month. However, if you enter \"17\",
3248 it will be considered as *this* month.
3250 If you set this variable to the symbol `time', then also the following
3253 3. If the user gives a time.
3254 If the time is before now, it will be interpreted as tomorrow.
3256 Currently none of this works for ISO week specifications.
3258 When this option is nil, the current day, month and year will always be
3261 See also `org-agenda-jump-prefer-future'."
3264 (const :tag
"Never" nil
)
3265 (const :tag
"Check month and day" t
)
3266 (const :tag
"Check month, day, and time" time
)))
3268 (defcustom org-agenda-jump-prefer-future
'org-read-date-prefer-future
3269 "Should the agenda jump command prefer the future for incomplete dates?
3270 The default is to do the same as configured in `org-read-date-prefer-future'.
3271 But you can also set a deviating value here.
3272 This may t or nil, or the symbol `org-read-date-prefer-future'."
3277 (const :tag
"Use org-read-date-prefer-future"
3278 org-read-date-prefer-future
)
3279 (const :tag
"Never" nil
)
3280 (const :tag
"Always" t
)))
3282 (defcustom org-read-date-force-compatible-dates t
3283 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3285 Depending on the system Emacs is running on, certain dates cannot
3286 be represented with the type used internally to represent time.
3287 Dates between 1970-1-1 and 2038-1-1 can always be represented
3288 correctly. Some systems allow for earlier dates, some for later,
3289 some for both. One way to find out it to insert any date into an
3290 Org buffer, putting the cursor on the year and hitting S-up and
3291 S-down to test the range.
3293 When this variable is set to t, the date/time prompt will not let
3294 you specify dates outside the 1970-2037 range, so it is certain that
3295 these dates will work in whatever version of Emacs you are
3296 running, and also that you can move a file from one Emacs implementation
3297 to another. WHenever Org is forcing the year for you, it will display
3300 When this variable is nil, Org will check if the date is
3301 representable in the specific Emacs implementation you are using.
3302 If not, it will force a year, usually the current year, and beep
3303 to remind you. Currently this setting is not recommended because
3304 the likelihood that you will open your Org files in an Emacs that
3305 has limited date range is not negligible.
3307 A workaround for this problem is to use diary sexp dates for time
3308 stamps outside of this range."
3313 (defcustom org-read-date-display-live t
3314 "Non-nil means display current interpretation of date prompt live.
3315 This display will be in an overlay, in the minibuffer."
3319 (defcustom org-read-date-popup-calendar t
3320 "Non-nil means pop up a calendar when prompting for a date.
3321 In the calendar, the date can be selected with mouse-1. However, the
3322 minibuffer will also be active, and you can simply enter the date as well.
3323 When nil, only the minibuffer will be available."
3326 (org-defvaralias 'org-popup-calendar-for-date-prompt
3327 'org-read-date-popup-calendar
)
3329 (make-obsolete-variable
3330 'org-read-date-minibuffer-setup-hook
3331 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3332 (defcustom org-read-date-minibuffer-setup-hook nil
3333 "Hook to be used to set up keys for the date/time interface.
3334 Add key definitions to `minibuffer-local-map', which will be a
3337 WARNING: This option is obsolete, you should use
3338 `org-read-date-minibuffer-local-map' to set up keys."
3342 (defcustom org-extend-today-until
0
3343 "The hour when your day really ends. Must be an integer.
3344 This has influence for the following applications:
3345 - When switching the agenda to \"today\". It it is still earlier than
3346 the time given here, the day recognized as TODAY is actually yesterday.
3347 - When a date is read from the user and it is still before the time given
3348 here, the current date and time will be assumed to be yesterday, 23:59.
3349 Also, timestamps inserted in capture templates follow this rule.
3351 IMPORTANT: This is a feature whose implementation is and likely will
3352 remain incomplete. Really, it is only here because past midnight seems to
3353 be the favorite working time of John Wiegley :-)"
3357 (defcustom org-use-effective-time nil
3358 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3359 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3360 \"effective time\" of any timestamps between midnight and 8am will be
3361 23:59 of the previous day."
3366 (defcustom org-use-last-clock-out-time-as-effective-time nil
3367 "When non-nil, use the last clock out time for `org-todo'.
3368 Note that this option has precedence over the combined use of
3369 `org-use-effective-time' and `org-extend-today-until'."
3372 :package-version
'(Org .
"8.0")
3375 (defcustom org-edit-timestamp-down-means-later nil
3376 "Non-nil means S-down will increase the time in a time stamp.
3377 When nil, S-up will increase."
3381 (defcustom org-calendar-follow-timestamp-change t
3382 "Non-nil means make the calendar window follow timestamp changes.
3383 When a timestamp is modified and the calendar window is visible, it will be
3384 moved to the new date."
3388 (defgroup org-tags nil
3389 "Options concerning tags in Org-mode."
3393 (defcustom org-tag-alist nil
3394 "List of tags allowed in Org-mode files.
3395 When this list is nil, Org-mode will base TAG input on what is already in the
3397 The value of this variable is an alist, the car of each entry must be a
3398 keyword as a string, the cdr may be a character that is used to select
3399 that tag through the fast-tag-selection interface.
3400 See the manual for details."
3404 (cons (string :tag
"Tag name")
3405 (character :tag
"Access char"))
3406 (list :tag
"Start radio group"
3408 (option (string :tag
"Group description")))
3409 (list :tag
"Group tags delimiter"
3411 (list :tag
"End radio group"
3413 (option (string :tag
"Group description")))
3414 (const :tag
"New line" (:newline
)))))
3416 (defcustom org-tag-persistent-alist nil
3417 "List of tags that will always appear in all Org-mode files.
3418 This is in addition to any in buffer settings or customizations
3420 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3421 The value of this variable is an alist, the car of each entry must be a
3422 keyword as a string, the cdr may be a character that is used to select
3423 that tag through the fast-tag-selection interface.
3424 See the manual for details.
3425 To disable these tags on a per-file basis, insert anywhere in the file:
3430 (cons (string :tag
"Tag name")
3431 (character :tag
"Access char"))
3432 (const :tag
"Start radio group" (:startgroup
))
3433 (const :tag
"Group tags delimiter" (:grouptags
))
3434 (const :tag
"End radio group" (:endgroup
))
3435 (const :tag
"New line" (:newline
)))))
3437 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3438 "If non-nil, always offer completion for all tags of all agenda files.
3439 Instead of customizing this variable directly, you might want to
3440 set it locally for capture buffers, because there no list of
3441 tags in that file can be created dynamically (there are none).
3443 (add-hook 'org-capture-mode-hook
3445 (set (make-local-variable
3446 'org-complete-tags-always-offer-all-agenda-tags)
3452 (defvar org-file-tags nil
3453 "List of tags that can be inherited by all entries in the file.
3454 The tags will be inherited if the variable `org-use-tag-inheritance'
3455 says they should be.
3456 This variable is populated from #+FILETAGS lines.")
3458 (defcustom org-use-fast-tag-selection
'auto
3459 "Non-nil means use fast tag selection scheme.
3460 This is a special interface to select and deselect tags with single keys.
3461 When nil, fast selection is never used.
3462 When the symbol `auto', fast selection is used if and only if selection
3463 characters for tags have been configured, either through the variable
3464 `org-tag-alist' or through a #+TAGS line in the buffer.
3465 When t, fast selection is always used and selection keys are assigned
3466 automatically if necessary."
3469 (const :tag
"Always" t
)
3470 (const :tag
"Never" nil
)
3471 (const :tag
"When selection characters are configured" auto
)))
3473 (defcustom org-fast-tag-selection-single-key nil
3474 "Non-nil means fast tag selection exits after first change.
3475 When nil, you have to press RET to exit it.
3476 During fast tag selection, you can toggle this flag with `C-c'.
3477 This variable can also have the value `expert'. In this case, the window
3478 displaying the tags menu is not even shown, until you press C-c again."
3481 (const :tag
"No" nil
)
3482 (const :tag
"Yes" t
)
3483 (const :tag
"Expert" expert
)))
3485 (defvar org-fast-tag-selection-include-todo nil
3486 "Non-nil means fast tags selection interface will also offer TODO states.
3487 This is an undocumented feature, you should not rely on it.")
3489 (defcustom org-tags-column
(if (featurep 'xemacs
) -
76 -
77)
3490 "The column to which tags should be indented in a headline.
3491 If this number is positive, it specifies the column. If it is negative,
3492 it means that the tags should be flushright to that column. For example,
3493 -80 works well for a normal 80 character screen.
3494 When 0, place tags directly after headline text, with only one space in
3499 (defcustom org-auto-align-tags t
3500 "Non-nil keeps tags aligned when modifying headlines.
3501 Some operations (i.e. demoting) change the length of a headline and
3502 therefore shift the tags around. With this option turned on, after
3503 each such operation the tags are again aligned to `org-tags-column'."
3507 (defcustom org-use-tag-inheritance t
3508 "Non-nil means tags in levels apply also for sublevels.
3509 When nil, only the tags directly given in a specific line apply there.
3510 This may also be a list of tags that should be inherited, or a regexp that
3511 matches tags that should be inherited. Additional control is possible
3512 with the variable `org-tags-exclude-from-inheritance' which gives an
3513 explicit list of tags to be excluded from inheritance, even if the value of
3514 `org-use-tag-inheritance' would select it for inheritance.
3516 If this option is t, a match early-on in a tree can lead to a large
3517 number of matches in the subtree when constructing the agenda or creating
3518 a sparse tree. If you only want to see the first match in a tree during
3519 a search, check out the variable `org-tags-match-list-sublevels'."
3522 (const :tag
"Not" nil
)
3523 (const :tag
"Always" t
)
3524 (repeat :tag
"Specific tags" (string :tag
"Tag"))
3525 (regexp :tag
"Tags matched by regexp")))
3527 (defcustom org-tags-exclude-from-inheritance nil
3528 "List of tags that should never be inherited.
3529 This is a way to exclude a few tags from inheritance. For way to do
3530 the opposite, to actively allow inheritance for selected tags,
3531 see the variable `org-use-tag-inheritance'."
3533 :type
'(repeat (string :tag
"Tag")))
3535 (defun org-tag-inherit-p (tag)
3536 "Check if TAG is one that should be inherited."
3538 ((member tag org-tags-exclude-from-inheritance
) nil
)
3539 ((eq org-use-tag-inheritance t
) t
)
3540 ((not org-use-tag-inheritance
) nil
)
3541 ((stringp org-use-tag-inheritance
)
3542 (string-match org-use-tag-inheritance tag
))
3543 ((listp org-use-tag-inheritance
)
3544 (member tag org-use-tag-inheritance
))
3545 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3547 (defcustom org-tags-match-list-sublevels t
3548 "Non-nil means list also sublevels of headlines matching a search.
3549 This variable applies to tags/property searches, and also to stuck
3550 projects because this search is based on a tags match as well.
3552 When set to the symbol `indented', sublevels are indented with
3555 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3556 the sublevels of a headline matching a tag search often also match
3557 the same search. Listing all of them can create very long lists.
3558 Setting this variable to nil causes subtrees of a match to be skipped.
3560 This variable is semi-obsolete and probably should always be true. It
3561 is better to limit inheritance to certain tags using the variables
3562 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3565 (const :tag
"No, don't list them" nil
)
3566 (const :tag
"Yes, do list them" t
)
3567 (const :tag
"List them, indented with leading dots" indented
)))
3569 (defcustom org-tags-sort-function nil
3570 "When set, tags are sorted using this function as a comparator."
3573 (const :tag
"No sorting" nil
)
3574 (const :tag
"Alphabetical" string
<)
3575 (const :tag
"Reverse alphabetical" string
>)
3576 (function :tag
"Custom function" nil
)))
3578 (defvar org-tags-history nil
3579 "History of minibuffer reads for tags.")
3580 (defvar org-last-tags-completion-table nil
3581 "The last used completion table for tags.")
3582 (defvar org-after-tags-change-hook nil
3583 "Hook that is run after the tags in a line have changed.")
3585 (defgroup org-properties nil
3586 "Options concerning properties in Org-mode."
3587 :tag
"Org Properties"
3590 (defcustom org-property-format
"%-10s %s"
3591 "How property key/value pairs should be formatted by `indent-line'.
3592 When `indent-line' hits a property definition, it will format the line
3593 according to this format, mainly to make sure that the values are
3594 lined-up with respect to each other."
3595 :group
'org-properties
3598 (defcustom org-properties-postprocess-alist nil
3599 "Alist of properties and functions to adjust inserted values.
3600 Elements of this alist must be of the form
3602 ([string] [function])
3604 where [string] must be a property name and [function] must be a
3605 lambda expression: this lambda expression must take one argument,
3606 the value to adjust, and return the new value as a string.
3608 For example, this element will allow the property \"Remaining\"
3609 to be updated wrt the relation between the \"Effort\" property
3610 and the clock summary:
3612 ((\"Remaining\" (lambda(value)
3613 (let ((clocksum (org-clock-sum-current-item))
3614 (effort (org-duration-string-to-minutes
3615 (org-entry-get (point) \"Effort\"))))
3616 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3617 :group
'org-properties
3619 :type
'(alist :key-type
(string :tag
"Property")
3620 :value-type
(function :tag
"Function")))
3622 (defcustom org-use-property-inheritance nil
3623 "Non-nil means properties apply also for sublevels.
3625 This setting is chiefly used during property searches. Turning it on can
3626 cause significant overhead when doing a search, which is why it is not
3629 When nil, only the properties directly given in the current entry count.
3630 When t, every property is inherited. The value may also be a list of
3631 properties that should have inheritance, or a regular expression matching
3632 properties that should be inherited.
3634 However, note that some special properties use inheritance under special
3635 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3636 and the properties ending in \"_ALL\" when they are used as descriptor
3637 for valid values of a property.
3639 Note for programmers:
3640 When querying an entry with `org-entry-get', you can control if inheritance
3641 should be used. By default, `org-entry-get' looks only at the local
3642 properties. You can request inheritance by setting the inherit argument
3643 to t (to force inheritance) or to `selective' (to respect the setting
3645 :group
'org-properties
3647 (const :tag
"Not" nil
)
3648 (const :tag
"Always" t
)
3649 (repeat :tag
"Specific properties" (string :tag
"Property"))
3650 (regexp :tag
"Properties matched by regexp")))
3652 (defun org-property-inherit-p (property)
3653 "Check if PROPERTY is one that should be inherited."
3655 ((eq org-use-property-inheritance t
) t
)
3656 ((not org-use-property-inheritance
) nil
)
3657 ((stringp org-use-property-inheritance
)
3658 (string-match org-use-property-inheritance property
))
3659 ((listp org-use-property-inheritance
)
3660 (member property org-use-property-inheritance
))
3661 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3663 (defcustom org-columns-default-format
"%25ITEM %TODO %3PRIORITY %TAGS"
3664 "The default column format, if no other format has been defined.
3665 This variable can be set on the per-file basis by inserting a line
3667 #+COLUMNS: %25ITEM ....."
3668 :group
'org-properties
3671 (defcustom org-columns-ellipses
".."
3672 "The ellipses to be used when a field in column view is truncated.
3673 When this is the empty string, as many characters as possible are shown,
3674 but then there will be no visual indication that the field has been truncated.
3675 When this is a string of length N, the last N characters of a truncated
3676 field are replaced by this string. If the column is narrower than the
3677 ellipses string, only part of the ellipses string will be shown."
3678 :group
'org-properties
3681 (defcustom org-columns-modify-value-for-display-function nil
3682 "Function that modifies values for display in column view.
3683 For example, it can be used to cut out a certain part from a time stamp.
3684 The function must take 2 arguments:
3686 column-title The title of the column (*not* the property name)
3687 value The value that should be modified.
3689 The function should return the value that should be displayed,
3690 or nil if the normal value should be used."
3691 :group
'org-properties
3692 :type
'(choice (const nil
) (function)))
3694 (defconst org-global-properties-fixed
3695 '(("VISIBILITY_ALL" .
"folded children content all")
3696 ("CLOCK_MODELINE_TOTAL_ALL" .
"current today repeat all auto"))
3697 "List of property/value pairs that can be inherited by any entry.
3699 These are fixed values, for the preset properties. The user variable
3700 that can be used to add to this list is `org-global-properties'.
3702 The entries in this list are cons cells where the car is a property
3703 name and cdr is a string with the value. If the value represents
3704 multiple items like an \"_ALL\" property, separate the items by
3707 (defcustom org-global-properties nil
3708 "List of property/value pairs that can be inherited by any entry.
3710 This list will be combined with the constant `org-global-properties-fixed'.
3712 The entries in this list are cons cells where the car is a property
3713 name and cdr is a string with the value.
3715 You can set buffer-local values for the same purpose in the variable
3716 `org-file-properties' this by adding lines like
3718 #+PROPERTY: NAME VALUE"
3719 :group
'org-properties
3721 (cons (string :tag
"Property")
3722 (string :tag
"Value"))))
3724 (defvar org-file-properties nil
3725 "List of property/value pairs that can be inherited by any entry.
3726 Valid for the current buffer.
3727 This variable is populated from #+PROPERTY lines.")
3728 (make-variable-buffer-local 'org-file-properties
)
3730 (defgroup org-agenda nil
3731 "Options concerning agenda views in Org-mode."
3735 (defvar org-category nil
3736 "Variable used by org files to set a category for agenda display.
3737 Such files should use a file variable to set it, for example
3739 # -*- mode: org; org-category: \"ELisp\"
3741 or contain a special line
3745 If the file does not specify a category, then file's base name
3747 (make-variable-buffer-local 'org-category
)
3748 (put 'org-category
'safe-local-variable
(lambda (x) (or (symbolp x
) (stringp x
))))
3750 (defcustom org-agenda-files nil
3751 "The files to be used for agenda display.
3752 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3753 \\[org-remove-file]. You can also use customize to edit the list.
3755 If an entry is a directory, all files in that directory that are matched by
3756 `org-agenda-file-regexp' will be part of the file list.
3758 If the value of the variable is not a list but a single file name, then
3759 the list of agenda files is actually stored and maintained in that file, one
3760 agenda file per line. In this file paths can be given relative to
3761 `org-directory'. Tilde expansion and environment variable substitution
3765 (repeat :tag
"List of files and directories" file
)
3766 (file :tag
"Store list in a file\n" :value
"~/.agenda_files")))
3768 (defcustom org-agenda-file-regexp
"\\`[^.].*\\.org\\'"
3769 "Regular expression to match files for `org-agenda-files'.
3770 If any element in the list in that variable contains a directory instead
3771 of a normal file, all files in that directory that are matched by this
3772 regular expression will be included."
3776 (defcustom org-agenda-text-search-extra-files nil
3777 "List of extra files to be searched by text search commands.
3778 These files will be searched in addition to the agenda files by the
3779 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3780 Note that these files will only be searched for text search commands,
3781 not for the other agenda views like todo lists, tag searches or the weekly
3782 agenda. This variable is intended to list notes and possibly archive files
3783 that should also be searched by these two commands.
3784 In fact, if the first element in the list is the symbol `agenda-archives',
3785 then all archive files of all agenda files will be added to the search
3788 :type
'(set :greedy t
3789 (const :tag
"Agenda Archives" agenda-archives
)
3790 (repeat :inline t
(file))))
3792 (org-defvaralias 'org-agenda-multi-occur-extra-files
3793 'org-agenda-text-search-extra-files
)
3795 (defcustom org-agenda-skip-unavailable-files nil
3796 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3797 A nil value means to remove them, after a query, from the list."
3801 (defcustom org-calendar-to-agenda-key
[?c
]
3802 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3803 The command `org-calendar-goto-agenda' will be bound to this key. The
3804 default is the character `c' because then `c' can be used to switch back and
3805 forth between agenda and calendar."
3809 (defcustom org-calendar-insert-diary-entry-key
[?i
]
3810 "The key to be installed in `calendar-mode-map' for adding diary entries.
3811 This option is irrelevant until `org-agenda-diary-file' has been configured
3812 to point to an Org-mode file. When that is the case, the command
3813 `org-agenda-diary-entry' will be bound to the key given here, by default
3814 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3815 if you want to continue doing this, you need to change this to a different
3820 (defcustom org-agenda-diary-file
'diary-file
3821 "File to which to add new entries with the `i' key in agenda and calendar.
3822 When this is the symbol `diary-file', the functionality in the Emacs
3823 calendar will be used to add entries to the `diary-file'. But when this
3824 points to a file, `org-agenda-diary-entry' will be used instead."
3827 (const :tag
"The standard Emacs diary file" diary-file
)
3828 (file :tag
"Special Org file diary entries")))
3830 (eval-after-load "calendar"
3832 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3833 'org-calendar-goto-agenda
)
3834 (add-hook 'calendar-mode-hook
3836 (unless (eq org-agenda-diary-file
'diary-file
)
3837 (define-key calendar-mode-map
3838 org-calendar-insert-diary-entry-key
3839 'org-agenda-diary-entry
))))))
3841 (defgroup org-latex nil
3842 "Options for embedding LaTeX code into Org-mode."
3846 (defcustom org-format-latex-options
3847 '(:foreground default
:background default
:scale
1.0
3848 :html-foreground
"Black" :html-background
"Transparent"
3849 :html-scale
1.0 :matchers
("begin" "$1" "$" "$$" "\\(" "\\["))
3850 "Options for creating images from LaTeX fragments.
3851 This is a property list with the following properties:
3852 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3853 `default' means use the foreground of the default face.
3854 `auto' means use the foreground from the text face.
3855 :background the background color, or \"Transparent\".
3856 `default' means use the background of the default face.
3857 `auto' means use the background from the text face.
3858 :scale a scaling factor for the size of the images, to get more pixels
3859 :html-foreground, :html-background, :html-scale
3860 the same numbers for HTML export.
3861 :matchers a list indicating which matchers should be used to
3862 find LaTeX fragments. Valid members of this list are:
3863 \"begin\" find environments
3864 \"$1\" find single characters surrounded by $.$
3865 \"$\" find math expressions surrounded by $...$
3866 \"$$\" find math expressions surrounded by $$....$$
3867 \"\\(\" find math expressions surrounded by \\(...\\)
3868 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3872 (defcustom org-format-latex-signal-error t
3873 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3874 When nil, just push out a message."
3879 (defcustom org-latex-to-mathml-jar-file nil
3880 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3881 Use this to specify additional executable file say a jar file.
3883 When using MathToWeb as the converter, specify the full-path to
3884 your mathtoweb.jar file."
3888 (const :tag
"None" nil
)
3889 (file :tag
"JAR file" :must-match t
)))
3891 (defcustom org-latex-to-mathml-convert-command nil
3892 "Command to convert LaTeX fragments to MathML.
3893 Replace format-specifiers in the command as noted below and use
3894 `shell-command' to convert LaTeX to MathML.
3895 %j: Executable file in fully expanded form as specified by
3896 `org-latex-to-mathml-jar-file'.
3897 %I: Input LaTeX file in fully expanded form
3898 %o: Output MathML file
3899 This command is used by `org-create-math-formula'.
3901 When using MathToWeb as the converter, set this to
3902 \"java -jar %j -unicode -force -df %o %I\"."
3906 (const :tag
"None" nil
)
3907 (string :tag
"\nShell command")))
3909 (defcustom org-latex-create-formula-image-program
'dvipng
3910 "Program to convert LaTeX fragments with.
3912 dvipng Process the LaTeX fragments to dvi file, then convert
3913 dvi files to png files using dvipng.
3914 This will also include processing of non-math environments.
3915 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3916 to convert pdf files to png files"
3920 (const :tag
"dvipng" dvipng
)
3921 (const :tag
"imagemagick" imagemagick
)))
3923 (defcustom org-latex-preview-ltxpng-directory
"ltxpng/"
3924 "Path to store latex preview images.
3925 A relative path here creates many directories relative to the
3926 processed org files paths. An absolute path puts all preview
3927 images at the same place."
3932 (defun org-format-latex-mathml-available-p ()
3933 "Return t if `org-latex-to-mathml-convert-command' is usable."
3935 (when (and (boundp 'org-latex-to-mathml-convert-command
)
3936 org-latex-to-mathml-convert-command
)
3937 (let ((executable (car (split-string
3938 org-latex-to-mathml-convert-command
))))
3939 (when (executable-find executable
)
3941 "%j" org-latex-to-mathml-convert-command
)
3942 (file-readable-p org-latex-to-mathml-jar-file
)
3945 (defcustom org-format-latex-header
"\\documentclass{article}
3946 \\usepackage[usenames]{color}
3949 \\pagestyle{empty} % do not remove
3950 % The settings below are copied from fullpage.sty
3951 \\setlength{\\textwidth}{\\paperwidth}
3952 \\addtolength{\\textwidth}{-3cm}
3953 \\setlength{\\oddsidemargin}{1.5cm}
3954 \\addtolength{\\oddsidemargin}{-2.54cm}
3955 \\setlength{\\evensidemargin}{\\oddsidemargin}
3956 \\setlength{\\textheight}{\\paperheight}
3957 \\addtolength{\\textheight}{-\\headheight}
3958 \\addtolength{\\textheight}{-\\headsep}
3959 \\addtolength{\\textheight}{-\\footskip}
3960 \\addtolength{\\textheight}{-3cm}
3961 \\setlength{\\topmargin}{1.5cm}
3962 \\addtolength{\\topmargin}{-2.54cm}"
3963 "The document header used for processing LaTeX fragments.
3964 It is imperative that this header make sure that no page number
3965 appears on the page. The package defined in the variables
3966 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3967 will either replace the placeholder \"[PACKAGES]\" in this
3968 header, or they will be appended."
3972 (defun org-set-packages-alist (var val
)
3973 "Set the packages alist and make sure it has 3 elements per entry."
3974 (set var
(mapcar (lambda (x)
3975 (if (and (consp x
) (= (length x
) 2))
3976 (list (car x
) (nth 1 x
) t
)
3980 (defun org-get-packages-alist (var)
3981 "Get the packages alist and make sure it has 3 elements per entry."
3983 (if (and (consp x
) (= (length x
) 2))
3984 (list (car x
) (nth 1 x
) t
)
3986 (default-value var
)))
3988 (defcustom org-latex-default-packages-alist
3989 '(("AUTO" "inputenc" t
)
3993 ("" "longtable" nil
)
3997 ("normalem" "ulem" t
)
4005 "Alist of default packages to be inserted in the header.
4007 Change this only if one of the packages here causes an
4008 incompatibility with another package you are using.
4010 The packages in this list are needed by one part or another of
4011 Org mode to function properly:
4013 - inputenc, fontenc: for basic font and character selection
4014 - fixltx2e: Important patches of LaTeX itself
4015 - graphicx: for including images
4016 - longtable: For multipage tables
4017 - float, wrapfig: for figure placement
4018 - rotating: for sideways figures and tables
4019 - ulem: for underline and strike-through
4020 - amsmath: for subscript and superscript and math environments
4021 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4022 for interpreting the entities in `org-entities'. You can skip
4023 some of these packages if you don't use any of their symbols.
4024 - hyperref: for cross references
4026 Therefore you should not modify this variable unless you know
4027 what you are doing. The one reason to change it anyway is that
4028 you might be loading some other package that conflicts with one
4029 of the default packages. Each element is either a cell or
4032 A cell is of the format:
4034 \( \"options\" \"package\" SNIPPET-FLAG).
4036 If SNIPPET-FLAG is non-nil, the package also needs to be included
4037 when compiling LaTeX snippets into images for inclusion into
4040 A string will be inserted as-is in the header of the document."
4042 :group
'org-export-latex
4043 :set
'org-set-packages-alist
4044 :get
'org-get-packages-alist
4048 (list :tag
"options/package pair"
4049 (string :tag
"options")
4050 (string :tag
"package")
4051 (boolean :tag
"Snippet"))
4052 (string :tag
"A line of LaTeX"))))
4054 (defcustom org-latex-packages-alist nil
4055 "Alist of packages to be inserted in every LaTeX header.
4057 These will be inserted after `org-latex-default-packages-alist'.
4058 Each element is either a cell or a string.
4060 A cell is of the format:
4062 \(\"options\" \"package\" SNIPPET-FLAG)
4064 SNIPPET-FLAG, when non-nil, indicates that this package is also
4065 needed when turning LaTeX snippets into images for inclusion into
4068 A string will be inserted as-is in the header of the document.
4070 Make sure that you only list packages here which:
4072 - you want in every file;
4073 - do not conflict with the setup in `org-format-latex-header';
4074 - do not conflict with the default packages in
4075 `org-latex-default-packages-alist'."
4077 :group
'org-export-latex
4078 :set
'org-set-packages-alist
4079 :get
'org-get-packages-alist
4082 (list :tag
"options/package pair"
4083 (string :tag
"options")
4084 (string :tag
"package")
4085 (boolean :tag
"Snippet"))
4086 (string :tag
"A line of LaTeX"))))
4088 (defgroup org-appearance nil
4089 "Settings for Org-mode appearance."
4090 :tag
"Org Appearance"
4093 (defcustom org-level-color-stars-only nil
4094 "Non-nil means fontify only the stars in each headline.
4095 When nil, the entire headline is fontified.
4096 Changing it requires restart of `font-lock-mode' to become effective
4097 also in regions already fontified."
4098 :group
'org-appearance
4101 (defcustom org-hide-leading-stars nil
4102 "Non-nil means hide the first N-1 stars in a headline.
4103 This works by using the face `org-hide' for these stars. This
4104 face is white for a light background, and black for a dark
4105 background. You may have to customize the face `org-hide' to
4107 Changing it requires restart of `font-lock-mode' to become effective
4108 also in regions already fontified.
4109 You may also set this on a per-file basis by adding one of the following
4110 lines to the buffer:
4112 #+STARTUP: hidestars
4113 #+STARTUP: showstars"
4114 :group
'org-appearance
4117 (defcustom org-hidden-keywords nil
4118 "List of symbols corresponding to keywords to be hidden the org buffer.
4119 For example, a value '(title) for this list will make the document's title
4120 appear in the buffer without the initial #+TITLE: keyword."
4121 :group
'org-appearance
4123 :type
'(set (const :tag
"#+AUTHOR" author
)
4124 (const :tag
"#+DATE" date
)
4125 (const :tag
"#+EMAIL" email
)
4126 (const :tag
"#+TITLE" title
)))
4128 (defcustom org-custom-properties nil
4129 "List of properties (as strings) with a special meaning.
4130 The default use of these custom properties is to let the user
4131 hide them with `org-toggle-custom-properties-visibility'."
4132 :group
'org-properties
4133 :group
'org-appearance
4135 :type
'(repeat (string :tag
"Property Name")))
4137 (defcustom org-fontify-done-headline nil
4138 "Non-nil means change the face of a headline if it is marked DONE.
4139 Normally, only the TODO/DONE keyword indicates the state of a headline.
4140 When this is non-nil, the headline after the keyword is set to the
4141 `org-headline-done' as an additional indication."
4142 :group
'org-appearance
4145 (defcustom org-fontify-emphasized-text t
4146 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4147 Changing this variable requires a restart of Emacs to take effect."
4148 :group
'org-appearance
4151 (defcustom org-fontify-whole-heading-line nil
4152 "Non-nil means fontify the whole line for headings.
4153 This is useful when setting a background color for the
4155 :group
'org-appearance
4158 (defcustom org-highlight-latex-and-related nil
4159 "Non-nil means highlight LaTeX related syntax in the buffer.
4160 When non nil, the value should be a list containing any of the
4162 `latex' Highlight LaTeX snippets and environments.
4163 `script' Highlight subscript and superscript.
4164 `entities' Highlight entities."
4165 :group
'org-appearance
4167 :package-version
'(Org .
"8.0")
4169 (const :tag
"No highlighting" nil
)
4170 (set :greedy t
:tag
"Highlight"
4171 (const :tag
"LaTeX snippets and environments" latex
)
4172 (const :tag
"Subscript and superscript" script
)
4173 (const :tag
"Entities" entities
))))
4175 (defcustom org-hide-emphasis-markers nil
4176 "Non-nil mean font-lock should hide the emphasis marker characters."
4177 :group
'org-appearance
4180 (defcustom org-hide-macro-markers nil
4181 "Non-nil mean font-lock should hide the brackets marking macro calls."
4182 :group
'org-appearance
4185 (defcustom org-pretty-entities nil
4186 "Non-nil means show entities as UTF8 characters.
4187 When nil, the \\name form remains in the buffer."
4188 :group
'org-appearance
4192 (defcustom org-pretty-entities-include-sub-superscripts t
4193 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4194 :group
'org-appearance
4198 (defvar org-emph-re nil
4199 "Regular expression for matching emphasis.
4200 After a match, the match groups contain these elements:
4201 0 The match of the full regular expression, including the characters
4202 before and after the proper match
4203 1 The character before the proper match, or empty at beginning of line
4204 2 The proper match, including the leading and trailing markers
4205 3 The leading marker like * or /, indicating the type of highlighting
4206 4 The text between the emphasis markers, not including the markers
4207 5 The character after the match, empty at the end of a line")
4208 (defvar org-verbatim-re nil
4209 "Regular expression for matching verbatim text.")
4210 (defvar org-emphasis-regexp-components
) ; defined just below
4211 (defvar org-emphasis-alist
) ; defined just below
4212 (defun org-set-emph-re (var val
)
4213 "Set variable and compute the emphasis regular expression."
4215 (when (and (boundp 'org-emphasis-alist
)
4216 (boundp 'org-emphasis-regexp-components
)
4217 org-emphasis-alist org-emphasis-regexp-components
)
4218 (let* ((e org-emphasis-regexp-components
)
4224 (body1 (concat body
"*?"))
4225 (markers (mapconcat 'car org-emphasis-alist
""))
4226 (vmarkers (mapconcat
4227 (lambda (x) (if (eq (nth 2 x
) 'verbatim
) (car x
) ""))
4228 org-emphasis-alist
"")))
4229 ;; make sure special characters appear at the right position in the class
4230 (if (string-match "\\^" markers
)
4231 (setq markers
(concat (replace-match "" t t markers
) "^")))
4232 (if (string-match "-" markers
)
4233 (setq markers
(concat (replace-match "" t t markers
) "-")))
4234 (if (string-match "\\^" vmarkers
)
4235 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "^")))
4236 (if (string-match "-" vmarkers
)
4237 (setq vmarkers
(concat (replace-match "" t t vmarkers
) "-")))
4239 (setq body1
(concat body1
"\\(?:\n" body
"*?\\)\\{0,"
4240 (int-to-string nl
) "\\}")))
4243 (concat "\\([" pre
"]\\|^\\)"
4245 "\\([" markers
"]\\)"
4253 "\\([" post
"]\\|$\\)"))
4254 (setq org-verbatim-re
4255 (concat "\\([" pre
"]\\|^\\)"
4257 "\\([" vmarkers
"]\\)"
4265 "\\([" post
"]\\|$\\)")))))
4267 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4268 ;; set this option proved cumbersome. See this message/thread:
4269 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4270 (defvar org-emphasis-regexp-components
4271 '(" \t('\"{" "- \t.,:!?;'\")}\\[" " \t\r\n,\"'" "." 1)
4272 "Components used to build the regular expression for emphasis.
4273 This is a list with five entries. Terminology: In an emphasis string
4274 like \" *strong word* \", we call the initial space PREMATCH, the final
4275 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4276 and \"trong wor\" is the body. The different components in this variable
4277 specify what is allowed/forbidden in each part:
4279 pre Chars allowed as prematch. Beginning of line will be allowed too.
4280 post Chars allowed as postmatch. End of line will be allowed too.
4281 border The chars *forbidden* as border characters.
4282 body-regexp A regexp like \".\" to match a body character. Don't use
4283 non-shy groups here, and don't allow newline here.
4284 newline The maximum number of newlines allowed in an emphasis exp.
4286 You need to reload Org or to restart Emacs after customizing this.")
4288 (defcustom org-emphasis-alist
4292 ("=" org-verbatim verbatim
)
4293 ("~" org-code verbatim
)
4294 ("+" ,(if (featurep 'xemacs
) 'org-table
'(:strike-through t
))))
4295 "Alist of characters and faces to emphasize text.
4296 Text starting and ending with a special character will be emphasized,
4297 for example *bold*, _underlined_ and /italic/. This variable sets the
4298 marker characters and the face to be used by font-lock for highlighting
4299 in Org-mode Emacs buffers.
4301 You need to reload Org or to restart Emacs after customizing this."
4302 :group
'org-appearance
4303 :set
'org-set-emph-re
4305 :package-version
'(Org .
"8.0")
4308 (string :tag
"Marker character")
4310 (face :tag
"Font-lock-face")
4311 (plist :tag
"Face property list"))
4312 (option (const verbatim
)))))
4314 (defvar org-protecting-blocks
4315 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4316 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4317 This is needed for font-lock setup.")
4319 ;;; Miscellaneous options
4321 (defgroup org-completion nil
4322 "Completion in Org-mode."
4323 :tag
"Org Completion"
4326 (defcustom org-completion-use-ido nil
4327 "Non-nil means use ido completion wherever possible.
4328 Note that `ido-mode' must be active for this variable to be relevant.
4329 If you decide to turn this variable on, you might well want to turn off
4330 `org-outline-path-complete-in-steps'.
4331 See also `org-completion-use-iswitchb'."
4332 :group
'org-completion
4335 (defcustom org-completion-use-iswitchb nil
4336 "Non-nil means use iswitchb completion wherever possible.
4337 Note that `iswitchb-mode' must be active for this variable to be relevant.
4338 If you decide to turn this variable on, you might well want to turn off
4339 `org-outline-path-complete-in-steps'.
4340 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4341 :group
'org-completion
4344 (defcustom org-completion-fallback-command
'hippie-expand
4345 "The expansion command called by \\[pcomplete] in normal context.
4346 Normal means, no org-mode-specific context."
4347 :group
'org-completion
4350 ;;; Functions and variables from their packages
4351 ;; Declared here to avoid compiler warnings
4354 (defvar outline-mode-menu-heading
)
4355 (defvar outline-mode-menu-show
)
4356 (defvar outline-mode-menu-hide
)
4357 (defvar zmacs-regions
) ; XEmacs regions
4360 (defvar mark-active
)
4363 (declare-function calendar-absolute-from-iso
"cal-iso" (date))
4364 (declare-function calendar-forward-day
"cal-move" (arg))
4365 (declare-function calendar-goto-date
"cal-move" (date))
4366 (declare-function calendar-goto-today
"cal-move" ())
4367 (declare-function calendar-iso-from-absolute
"cal-iso" (date))
4368 (defvar calc-embedded-close-formula
)
4369 (defvar calc-embedded-open-formula
)
4370 (declare-function cdlatex-tab
"ext:cdlatex" ())
4371 (declare-function cdlatex-compute-tables
"ext:cdlatex" ())
4372 (declare-function dired-get-filename
"dired" (&optional localp no-error-if-not-filep
))
4373 (defvar font-lock-unfontify-region-function
)
4374 (declare-function iswitchb-read-buffer
"iswitchb"
4375 (prompt &optional default require-match start matches-set
))
4376 (defvar iswitchb-temp-buflist
)
4377 (declare-function org-gnus-follow-link
"org-gnus" (&optional group article
))
4378 (defvar org-agenda-tags-todo-honor-ignore-options
)
4379 (declare-function org-agenda-skip
"org-agenda" ())
4381 org-agenda-format-item
"org-agenda"
4382 (extra txt
&optional level category tags dotime noprefix remove-re habitp
))
4383 (declare-function org-agenda-new-marker
"org-agenda" (&optional pos
))
4384 (declare-function org-agenda-change-all-lines
"org-agenda"
4385 (newhead hdmarker
&optional fixface just-this
))
4386 (declare-function org-agenda-set-restriction-lock
"org-agenda" (&optional type
))
4387 (declare-function org-agenda-maybe-redo
"org-agenda" ())
4388 (declare-function org-agenda-save-markers-for-cut-and-paste
"org-agenda"
4390 (declare-function org-agenda-copy-local-variable
"org-agenda" (var))
4391 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4392 "org-agenda" (&optional end
))
4393 (declare-function org-inlinetask-remove-END-maybe
"org-inlinetask" ())
4394 (declare-function org-inlinetask-in-task-p
"org-inlinetask" ())
4395 (declare-function org-inlinetask-goto-beginning
"org-inlinetask" ())
4396 (declare-function org-inlinetask-goto-end
"org-inlinetask" ())
4397 (declare-function org-indent-mode
"org-indent" (&optional arg
))
4398 (declare-function parse-time-string
"parse-time" (string))
4399 (declare-function org-attach-reveal
"org-attach" (&optional if-exists
))
4400 (declare-function orgtbl-send-table
"org-table" (&optional maybe
))
4401 (defvar remember-data-file
)
4402 (defvar texmathp-why
)
4403 (declare-function speedbar-line-directory
"speedbar" (&optional depth
))
4404 (declare-function table--at-cell-p
"table" (position &optional object at-column
))
4405 (declare-function calc-eval
"calc" (str &optional separator
&rest args
))
4408 (defun turn-on-orgtbl ()
4409 "Unconditionally turn on `orgtbl-mode'."
4410 (require 'org-table
)
4413 (defun org-at-table-p (&optional table-type
)
4414 "Return t if the cursor is inside an org-type table.
4415 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4416 (if org-enable-table-editor
4418 (beginning-of-line 1)
4419 (looking-at (if table-type org-table-any-line-regexp
4420 org-table-line-regexp
)))
4422 (defsubst org-table-p
() (org-at-table-p))
4424 (defun org-at-table.el-p
()
4425 "Return t if and only if we are at a table.el table."
4426 (and (org-at-table-p 'any
)
4428 (goto-char (org-table-begin 'any
))
4429 (looking-at org-table1-hline-regexp
))))
4431 (defun org-table-recognize-table.el
()
4432 "If there is a table.el table nearby, recognize it and move into it."
4433 (if org-table-tab-recognizes-table.el
4434 (if (org-at-table.el-p
)
4436 (beginning-of-line 1)
4437 (if (looking-at org-table-dataline-regexp
)
4439 (if (looking-at org-table1-hline-regexp
)
4441 (beginning-of-line 2)
4442 (if (looking-at org-table-any-border-regexp
)
4443 (beginning-of-line -
1)))))
4444 (if (re-search-forward "|" (org-table-end t
) t
)
4447 (if (table--at-cell-p (point))
4449 (message "recognizing table.el table...")
4450 (table-recognize-table)
4451 (message "recognizing table.el table...done")))
4452 (error "This should not happen"))
4457 (defun org-at-table-hline-p ()
4458 "Return t if the cursor is inside a hline in a table."
4459 (if org-enable-table-editor
4461 (beginning-of-line 1)
4462 (looking-at org-table-hline-regexp
))
4465 (defun org-table-map-tables (function &optional quietly
)
4466 "Apply FUNCTION to the start of all tables in the buffer."
4470 (goto-char (point-min))
4471 (while (re-search-forward org-table-any-line-regexp nil t
)
4473 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4474 (beginning-of-line 1)
4475 (when (and (looking-at org-table-line-regexp
)
4476 ;; Exclude tables in src/example/verbatim/clocktable blocks
4477 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4478 (save-excursion (funcall function
))
4479 (or (looking-at org-table-line-regexp
)
4481 (re-search-forward org-table-any-border-regexp nil
1))))
4482 (unless quietly
(message "Mapping tables: done")))
4484 (declare-function org-clock-save-markers-for-cut-and-paste
"org-clock" (beg end
))
4485 (declare-function org-clock-update-mode-line
"org-clock" ())
4486 (declare-function org-resolve-clocks
"org-clock"
4487 (&optional also-non-dangling-p prompt last-valid
))
4489 (defun org-at-TBLFM-p (&optional pos
)
4490 "Return t when point (or POS) is in #+TBLFM line."
4493 (goto-char (or pos
(point)))
4494 (beginning-of-line 1)
4495 (looking-at org-TBLFM-regexp
)))
4497 (defvar org-clock-start-time
)
4498 (defvar org-clock-marker
(make-marker)
4499 "Marker recording the last clock-in.")
4500 (defvar org-clock-hd-marker
(make-marker)
4501 "Marker recording the last clock-in, but the headline position.")
4502 (defvar org-clock-heading
""
4503 "The heading of the current clock entry.")
4504 (defun org-clock-is-active ()
4505 "Return the buffer where the clock is currently running.
4506 Return nil if no clock is running."
4507 (marker-buffer org-clock-marker
))
4509 (defun org-check-running-clock ()
4510 "Check if the current buffer contains the running clock.
4511 If yes, offer to stop it and to save the buffer with the changes."
4512 (when (and (equal (marker-buffer org-clock-marker
) (current-buffer))
4513 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4516 (when (y-or-n-p "Save changed buffer?")
4519 (defun org-clocktable-try-shift (dir n
)
4520 "Check if this line starts a clock table, if yes, shift the time block."
4521 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4522 (org-clocktable-shift dir n
)))
4525 (defun org-clock-persistence-insinuate ()
4526 "Set up hooks for clock persistence."
4527 (require 'org-clock
)
4528 (add-hook 'org-mode-hook
'org-clock-load
)
4529 (add-hook 'kill-emacs-hook
'org-clock-save
))
4531 (defgroup org-archive nil
4532 "Options concerning archiving in Org-mode."
4534 :group
'org-structure
)
4536 (defcustom org-archive-location
"%s_archive::"
4537 "The location where subtrees should be archived.
4539 The value of this variable is a string, consisting of two parts,
4540 separated by a double-colon. The first part is a filename and
4541 the second part is a headline.
4543 When the filename is omitted, archiving happens in the same file.
4544 %s in the filename will be replaced by the current file
4545 name (without the directory part). Archiving to a different file
4546 is useful to keep archived entries from contributing to the
4549 The archived entries will be filed as subtrees of the specified
4550 headline. When the headline is omitted, the subtrees are simply
4551 filed away at the end of the file, as top-level entries. Also in
4552 the heading you can use %s to represent the file name, this can be
4553 useful when using the same archive for a number of different files.
4555 Here are a few examples:
4557 If the current file is Projects.org, archive in file
4558 Projects.org_archive, as top-level trees. This is the default.
4560 \"::* Archived Tasks\"
4561 Archive in the current file, under the top-level headline
4562 \"* Archived Tasks\".
4564 \"~/org/archive.org::\"
4565 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4567 \"~/org/archive.org::* From %s\"
4568 Archive in file ~/org/archive.org (absolute path), under headlines
4569 \"From FILENAME\" where file name is the current file name.
4571 \"~/org/datetree.org::datetree/* Finished Tasks\"
4572 The \"datetree/\" string is special, signifying to archive
4573 items to the datetree. Items are placed in either the CLOSED
4574 date of the item, or the current date if there is no CLOSED date.
4575 The heading will be a subentry to the current date. There doesn't
4576 need to be a heading, but there always needs to be a slash after
4577 datetree. For example, to store archived items directly in the
4578 datetree, use \"~/org/datetree.org::datetree/\".
4580 \"basement::** Finished Tasks\"
4581 Archive in file ./basement (relative path), as level 3 trees
4582 below the level 2 heading \"** Finished Tasks\".
4584 You may set this option on a per-file basis by adding to the buffer a
4587 #+ARCHIVE: basement::** Finished Tasks
4589 You may also define it locally for a subtree by setting an ARCHIVE property
4590 in the entry. If such a property is found in an entry, or anywhere up
4591 the hierarchy, it will be used."
4595 (defcustom org-agenda-skip-archived-trees t
4596 "Non-nil means the agenda will skip any items located in archived trees.
4597 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4598 variable is no longer recommended, you should leave it at the value t.
4599 Instead, use the key `v' to cycle the archives-mode in the agenda."
4601 :group
'org-agenda-skip
4604 (defcustom org-columns-skip-archived-trees t
4605 "Non-nil means ignore archived trees when creating column view."
4607 :group
'org-properties
4610 (defcustom org-cycle-open-archived-trees nil
4611 "Non-nil means `org-cycle' will open archived trees.
4612 An archived tree is a tree marked with the tag ARCHIVE.
4613 When nil, archived trees will stay folded. You can still open them with
4614 normal outline commands like `show-all', but not with the cycling commands."
4619 (defcustom org-sparse-tree-open-archived-trees nil
4620 "Non-nil means sparse tree construction shows matches in archived trees.
4621 When nil, matches in these trees are highlighted, but the trees are kept in
4624 :group
'org-sparse-trees
4627 (defcustom org-sparse-tree-default-date-type
'scheduled-or-deadline
4628 "The default date type when building a sparse tree.
4629 When this is nil, a date is a scheduled or a deadline timestamp.
4630 Otherwise, these types are allowed:
4633 active: only active timestamps (<...>)
4634 inactive: only inactive timestamps (<...)
4635 scheduled: only scheduled timestamps
4636 deadline: only deadline timestamps"
4637 :type
'(choice (const :tag
"Scheduled or deadline" scheduled-or-deadline
)
4638 (const :tag
"All timestamps" all
)
4639 (const :tag
"Only active timestamps" active
)
4640 (const :tag
"Only inactive timestamps" inactive
)
4641 (const :tag
"Only scheduled timestamps" scheduled
)
4642 (const :tag
"Only deadline timestamps" deadline
)
4643 (const :tag
"Only closed timestamps" closed
))
4645 :group
'org-sparse-trees
)
4647 (defun org-cycle-hide-archived-subtrees (state)
4648 "Re-hide all archived subtrees after a visibility state change."
4649 (when (and (not org-cycle-open-archived-trees
)
4650 (not (memq state
'(overview folded
))))
4652 (let* ((globalp (memq state
'(contents all
)))
4653 (beg (if globalp
(point-min) (point)))
4654 (end (if globalp
(point-max) (org-end-of-subtree t
))))
4655 (org-hide-archived-subtrees beg end
)
4657 (if (looking-at (concat ".*:" org-archive-tag
":"))
4658 (message "%s" (substitute-command-keys
4659 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4661 (defun org-force-cycle-archived ()
4662 "Cycle subtree even if it is archived."
4664 (setq this-command
'org-cycle
)
4665 (let ((org-cycle-open-archived-trees t
))
4666 (call-interactively 'org-cycle
)))
4668 (defun org-hide-archived-subtrees (beg end
)
4669 "Re-hide all archived subtrees after a visibility state change."
4671 (let* ((re (concat ":" org-archive-tag
":")))
4673 (while (re-search-forward re end t
)
4674 (when (org-at-heading-p)
4675 (org-flag-subtree t
)
4676 (org-end-of-subtree t
))))))
4678 (declare-function outline-end-of-heading
"outline" ())
4679 (declare-function outline-flag-region
"outline" (from to flag
))
4680 (defun org-flag-subtree (flag)
4682 (org-back-to-heading t
)
4683 (outline-end-of-heading)
4684 (outline-flag-region (point)
4685 (progn (org-end-of-subtree t
) (point))
4688 (defalias 'org-advertized-archive-subtree
'org-archive-subtree
)
4690 ;; Declare Column View Code
4692 (declare-function org-columns-number-to-string
"org-colview" (n fmt
&optional printf
))
4693 (declare-function org-columns-get-format-and-top-level
"org-colview" ())
4694 (declare-function org-columns-compute
"org-colview" (property))
4698 (declare-function org-id-store-link
"org-id")
4699 (declare-function org-id-locations-load
"org-id")
4700 (declare-function org-id-locations-save
"org-id")
4701 (defvar org-id-track-globally
)
4703 ;;; Variables for pre-computed regular expressions, all buffer local
4705 (defvar org-todo-regexp nil
4706 "Matches any of the TODO state keywords.")
4707 (make-variable-buffer-local 'org-todo-regexp
)
4708 (defvar org-not-done-regexp nil
4709 "Matches any of the TODO state keywords except the last one.")
4710 (make-variable-buffer-local 'org-not-done-regexp
)
4711 (defvar org-not-done-heading-regexp nil
4712 "Matches a TODO headline that is not done.")
4713 (make-variable-buffer-local 'org-not-done-regexp
)
4714 (defvar org-todo-line-regexp nil
4715 "Matches a headline and puts TODO state into group 2 if present.")
4716 (make-variable-buffer-local 'org-todo-line-regexp
)
4717 (defvar org-complex-heading-regexp nil
4718 "Matches a headline and puts everything into groups:
4720 group 2: The todo keyword, maybe
4721 group 3: Priority cookie
4722 group 4: True headline
4724 (make-variable-buffer-local 'org-complex-heading-regexp
)
4725 (defvar org-complex-heading-regexp-format nil
4726 "Printf format to make regexp to match an exact headline.
4727 This regexp will match the headline of any node which has the
4728 exact headline text that is put into the format, but may have any
4729 TODO state, priority and tags.")
4730 (make-variable-buffer-local 'org-complex-heading-regexp-format
)
4731 (defvar org-todo-line-tags-regexp nil
4732 "Matches a headline and puts TODO state into group 2 if present.
4733 Also put tags into group 4 if tags are present.")
4734 (make-variable-buffer-local 'org-todo-line-tags-regexp
)
4735 (defvar org-ds-keyword-length
12
4736 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4737 (make-variable-buffer-local 'org-ds-keyword-length
)
4738 (defvar org-deadline-regexp nil
4739 "Matches the DEADLINE keyword.")
4740 (make-variable-buffer-local 'org-deadline-regexp
)
4741 (defvar org-deadline-time-regexp nil
4742 "Matches the DEADLINE keyword together with a time stamp.")
4743 (make-variable-buffer-local 'org-deadline-time-regexp
)
4744 (defvar org-deadline-time-hour-regexp nil
4745 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4746 (make-variable-buffer-local 'org-deadline-time-hour-regexp
)
4747 (defvar org-deadline-line-regexp nil
4748 "Matches the DEADLINE keyword and the rest of the line.")
4749 (make-variable-buffer-local 'org-deadline-line-regexp
)
4750 (defvar org-scheduled-regexp nil
4751 "Matches the SCHEDULED keyword.")
4752 (make-variable-buffer-local 'org-scheduled-regexp
)
4753 (defvar org-scheduled-time-regexp nil
4754 "Matches the SCHEDULED keyword together with a time stamp.")
4755 (make-variable-buffer-local 'org-scheduled-time-regexp
)
4756 (defvar org-scheduled-time-hour-regexp nil
4757 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4758 (make-variable-buffer-local 'org-scheduled-time-hour-regexp
)
4759 (defvar org-closed-time-regexp nil
4760 "Matches the CLOSED keyword together with a time stamp.")
4761 (make-variable-buffer-local 'org-closed-time-regexp
)
4763 (defvar org-keyword-time-regexp nil
4764 "Matches any of the 4 keywords, together with the time stamp.")
4765 (make-variable-buffer-local 'org-keyword-time-regexp
)
4766 (defvar org-keyword-time-not-clock-regexp nil
4767 "Matches any of the 3 keywords, together with the time stamp.")
4768 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp
)
4769 (defvar org-maybe-keyword-time-regexp nil
4770 "Matches a timestamp, possibly preceded by a keyword.")
4771 (make-variable-buffer-local 'org-maybe-keyword-time-regexp
)
4772 (defvar org-all-time-keywords nil
4773 "List of time keywords.")
4774 (make-variable-buffer-local 'org-all-time-keywords
)
4776 (defconst org-plain-time-of-day-regexp
4779 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4782 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4784 "Regular expression to match a plain time or time range.
4785 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4786 groups carry important information:
4788 1 the first time, range or not
4789 8 the second time, if it is a range.")
4791 (defconst org-plain-time-extension-regexp
4794 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4795 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4796 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4797 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4798 groups carry important information:
4801 9 minutes of duration")
4803 (defconst org-stamp-time-of-day-regexp
4805 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4806 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4808 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4809 "Regular expression to match a timestamp time or time range.
4810 After a match, the following groups carry important information:
4812 1 date plus weekday, for back referencing to make sure both times are on the same day
4813 2 the first time, range or not
4814 4 the second time, if it is a range.")
4816 (defconst org-startup-options
4817 '(("fold" org-startup-folded t
)
4818 ("overview" org-startup-folded t
)
4819 ("nofold" org-startup-folded nil
)
4820 ("showall" org-startup-folded nil
)
4821 ("showeverything" org-startup-folded showeverything
)
4822 ("content" org-startup-folded content
)
4823 ("indent" org-startup-indented t
)
4824 ("noindent" org-startup-indented nil
)
4825 ("hidestars" org-hide-leading-stars t
)
4826 ("showstars" org-hide-leading-stars nil
)
4827 ("odd" org-odd-levels-only t
)
4828 ("oddeven" org-odd-levels-only nil
)
4829 ("align" org-startup-align-all-tables t
)
4830 ("noalign" org-startup-align-all-tables nil
)
4831 ("inlineimages" org-startup-with-inline-images t
)
4832 ("noinlineimages" org-startup-with-inline-images nil
)
4833 ("latexpreview" org-startup-with-latex-preview t
)
4834 ("nolatexpreview" org-startup-with-latex-preview nil
)
4835 ("customtime" org-display-custom-times t
)
4836 ("logdone" org-log-done time
)
4837 ("lognotedone" org-log-done note
)
4838 ("nologdone" org-log-done nil
)
4839 ("lognoteclock-out" org-log-note-clock-out t
)
4840 ("nolognoteclock-out" org-log-note-clock-out nil
)
4841 ("logrepeat" org-log-repeat state
)
4842 ("lognoterepeat" org-log-repeat note
)
4843 ("logdrawer" org-log-into-drawer t
)
4844 ("nologdrawer" org-log-into-drawer nil
)
4845 ("logstatesreversed" org-log-states-order-reversed t
)
4846 ("nologstatesreversed" org-log-states-order-reversed nil
)
4847 ("nologrepeat" org-log-repeat nil
)
4848 ("logreschedule" org-log-reschedule time
)
4849 ("lognotereschedule" org-log-reschedule note
)
4850 ("nologreschedule" org-log-reschedule nil
)
4851 ("logredeadline" org-log-redeadline time
)
4852 ("lognoteredeadline" org-log-redeadline note
)
4853 ("nologredeadline" org-log-redeadline nil
)
4854 ("logrefile" org-log-refile time
)
4855 ("lognoterefile" org-log-refile note
)
4856 ("nologrefile" org-log-refile nil
)
4857 ("fninline" org-footnote-define-inline t
)
4858 ("nofninline" org-footnote-define-inline nil
)
4859 ("fnlocal" org-footnote-section nil
)
4860 ("fnauto" org-footnote-auto-label t
)
4861 ("fnprompt" org-footnote-auto-label nil
)
4862 ("fnconfirm" org-footnote-auto-label confirm
)
4863 ("fnplain" org-footnote-auto-label plain
)
4864 ("fnadjust" org-footnote-auto-adjust t
)
4865 ("nofnadjust" org-footnote-auto-adjust nil
)
4866 ("constcgs" constants-unit-system cgs
)
4867 ("constSI" constants-unit-system SI
)
4868 ("noptag" org-tag-persistent-alist nil
)
4869 ("hideblocks" org-hide-block-startup t
)
4870 ("nohideblocks" org-hide-block-startup nil
)
4871 ("beamer" org-startup-with-beamer-mode t
)
4872 ("entitiespretty" org-pretty-entities t
)
4873 ("entitiesplain" org-pretty-entities nil
))
4874 "Variable associated with STARTUP options for org-mode.
4875 Each element is a list of three items: the startup options (as written
4876 in the #+STARTUP line), the corresponding variable, and the value to set
4877 this variable to if the option is found. An optional forth element PUSH
4878 means to push this value onto the list in the variable.")
4880 (defun org-update-property-plist (key val props
)
4881 "Update PROPS with KEY and VAL."
4882 (let* ((appending (string= "+" (substring key
(- (length key
) 1))))
4883 (key (if appending
(substring key
0 (- (length key
) 1)) key
))
4884 (remainder (org-remove-if (lambda (p) (string= (car p
) key
)) props
))
4885 (previous (cdr (assoc key props
))))
4887 (cons (cons key
(if previous
(concat previous
" " val
) val
)) remainder
)
4888 (cons (cons key val
) remainder
))))
4890 (defcustom org-group-tags t
4891 "When non-nil (the default), use group tags.
4892 This can be turned on/off through `org-toggle-tags-groups'."
4897 (defvar org-inhibit-startup nil
) ; Dynamically-scoped param.
4899 (defun org-toggle-tags-groups ()
4900 "Toggle support for group tags.
4901 Support for group tags is controlled by the option
4902 `org-group-tags', which is non-nil by default."
4904 (setq org-group-tags
(not org-group-tags
))
4905 (cond ((and (derived-mode-p 'org-agenda-mode
)
4908 ((derived-mode-p 'org-mode
)
4909 (let ((org-inhibit-startup t
)) (org-mode))))
4910 (message "Groups tags support has been turned %s"
4911 (if org-group-tags
"on" "off")))
4913 (defun org-set-regexps-and-options-for-tags ()
4914 "Precompute variables used for tags."
4915 (when (derived-mode-p 'org-mode
)
4916 (org-set-local 'org-file-tags nil
)
4917 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4920 tags ftags key value
)
4924 (goto-char (point-min))
4925 (while (re-search-forward re nil t
)
4926 (setq key
(upcase (org-match-string-no-properties 1))
4927 value
(org-match-string-no-properties 2))
4928 (if (stringp value
) (setq value
(org-trim value
)))
4931 (setq tags
(append tags
(if tags
'("\\n") nil
)
4932 (org-split-string value splitre
))))
4933 ((equal key
"FILETAGS")
4934 (when (string-match "\\S-" value
)
4939 (mapcar (lambda (x) (org-split-string x
":"))
4940 (org-split-string value
)))))))))))
4941 ;; Process the file tags.
4942 (and ftags
(org-set-local 'org-file-tags
4943 (mapcar 'org-add-prop-inherited ftags
)))
4944 (org-set-local 'org-tag-groups-alist nil
)
4945 ;; Process the tags.
4946 (when (and (not tags
) org-tag-alist
)
4949 (lambda (tg) (cond ((eq (car tg
) :startgroup
) "{")
4950 ((eq (car tg
) :endgroup
) "}")
4951 ((eq (car tg
) :grouptags
) ":")
4952 ((eq (car tg
) :newline
) "\n")
4954 (if (characterp (cdr tg
))
4955 (format "(%s)" (char-to-string (cdr tg
))) "")))))
4958 (while (setq e
(pop tags
))
4961 (progn (push '(:startgroup
) tgs
)
4962 (when (equal (nth 1 tags
) ":")
4963 (push (list (replace-regexp-in-string
4964 "(.+)$" "" (nth 0 tags
)))
4965 org-tag-groups-alist
)
4967 ((equal e
":") (push '(:grouptags
) tgs
))
4968 ((equal e
"}") (push '(:endgroup
) tgs
) (if g
(setq g nil
)))
4969 ((equal e
"\\n") (push '(:newline
) tgs
))
4970 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e
)
4971 (push (cons (match-string 1 e
)
4972 (string-to-char (match-string 2 e
))) tgs
)
4974 (setcar org-tag-groups-alist
4975 (append (car org-tag-groups-alist
)
4976 (list (match-string 1 e
)))))
4977 (if g
(setq g
(1+ g
))))
4978 (t (push (list e
) tgs
)
4980 (setcar org-tag-groups-alist
4981 (append (car org-tag-groups-alist
) (list e
))))
4982 (if g
(setq g
(1+ g
))))))
4983 (org-set-local 'org-tag-alist nil
)
4984 (while (setq e
(pop tgs
))
4985 (or (and (stringp (car e
))
4986 (assoc (car e
) org-tag-alist
))
4987 (push e org-tag-alist
)))
4988 ;; Return a list with tag variables
4989 (list org-file-tags org-tag-alist org-tag-groups-alist
)))))
4991 (defvar org-ota nil
)
4992 (defun org-set-regexps-and-options ()
4993 "Precompute regular expressions used in the current buffer."
4994 (when (derived-mode-p 'org-mode
)
4995 (org-set-local 'org-todo-kwd-alist nil
)
4996 (org-set-local 'org-todo-key-alist nil
)
4997 (org-set-local 'org-todo-key-trigger nil
)
4998 (org-set-local 'org-todo-keywords-1 nil
)
4999 (org-set-local 'org-done-keywords nil
)
5000 (org-set-local 'org-todo-heads nil
)
5001 (org-set-local 'org-todo-sets nil
)
5002 (org-set-local 'org-todo-log-states nil
)
5003 (org-set-local 'org-file-properties nil
)
5004 (let ((re (org-make-options-regexp
5005 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
5006 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
5007 "SETUPFILE" "OPTIONS")
5008 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
5010 (scripts org-use-sub-superscripts
)
5011 kwds kws0 kwsa key log value cat arch const links hw dws
5012 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
5017 (goto-char (point-min))
5024 (insert ext-setup-or-nil
)
5025 (let ((major-mode 'org-mode
) org-ota
)
5026 (setq ret
(save-match-data
5027 (org-set-regexps-and-options-for-tags)))))
5028 ;; Append setupfile tags to existing tags
5031 (delq nil
(append org-file-tags
(nth 0 ret
)))
5033 (delq nil
(append org-tag-alist
(nth 1 ret
)))
5034 org-tag-groups-alist
5035 (delq nil
(append org-tag-groups-alist
(nth 2 ret
))))))
5036 (and ext-setup-or-nil
5037 (string-match re ext-setup-or-nil start
)
5038 (setq start
(match-end 0)))
5039 (and (setq ext-setup-or-nil nil start
0)
5040 (re-search-forward re nil t
)))
5041 (setq key
(upcase (match-string 1 ext-setup-or-nil
))
5042 value
(org-match-string-no-properties 2 ext-setup-or-nil
))
5043 (if (stringp value
) (setq value
(org-trim value
)))
5045 ((equal key
"CATEGORY")
5047 ((member key
'("SEQ_TODO" "TODO"))
5048 (push (cons 'sequence
(org-split-string value splitre
)) kwds
))
5049 ((equal key
"TYP_TODO")
5050 (push (cons 'type
(org-split-string value splitre
)) kwds
))
5051 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key
)
5052 ;; general TODO-like setup
5053 (push (cons (intern (downcase (match-string 1 key
)))
5054 (org-split-string value splitre
)) kwds
))
5055 ((equal key
"COLUMNS")
5056 (org-set-local 'org-columns-default-format value
))
5058 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value
)
5059 (push (cons (match-string 1 value
)
5060 (org-trim (match-string 2 value
)))
5062 ((equal key
"PRIORITIES")
5063 (setq prio
(org-split-string value
" +")))
5064 ((equal key
"PROPERTY")
5065 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value
)
5066 (setq props
(org-update-property-plist (match-string 1 value
)
5067 (match-string 2 value
)
5069 ((equal key
"CONSTANTS")
5070 (org-table-set-constants))
5071 ((equal key
"STARTUP")
5072 (let ((opts (org-split-string value splitre
))
5074 (while (setq l
(pop opts
))
5075 (when (setq l
(assoc l org-startup-options
))
5076 (setq var
(nth 1 l
) val
(nth 2 l
))
5078 (set (make-local-variable var
) val
)
5079 (if (not (listp (symbol-value var
)))
5080 (set (make-local-variable var
) nil
))
5081 (set (make-local-variable var
) (symbol-value var
))
5082 (add-to-list var val
))))))
5083 ((equal key
"ARCHIVE")
5085 (remove-text-properties 0 (length arch
)
5086 '(face t fontified t
) arch
))
5087 ((equal key
"OPTIONS")
5088 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value
)
5089 (setq scripts
(read (match-string 2 value
)))))
5090 ((and (equal key
"SETUPFILE")
5091 ;; Prevent checking in Gnus messages
5092 (not buffer-read-only
))
5093 (setq setup-contents
(org-file-contents
5095 (org-remove-double-quotes value
))
5097 (if (not ext-setup-or-nil
)
5098 (setq ext-setup-or-nil setup-contents start
0)
5099 (setq ext-setup-or-nil
5100 (concat (substring ext-setup-or-nil
0 start
)
5101 "\n" setup-contents
"\n"
5102 (substring ext-setup-or-nil start
)))))))
5103 ;; search for property blocks
5104 (goto-char (point-min))
5105 (while (re-search-forward org-block-regexp nil t
)
5106 (when (equal "PROPERTY" (upcase (match-string 1)))
5107 (setq value
(replace-regexp-in-string
5108 "[\n\r]" " " (match-string 4)))
5109 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value
)
5110 (setq props
(org-update-property-plist (match-string 1 value
)
5111 (match-string 2 value
)
5113 (org-set-local 'org-use-sub-superscripts scripts
)
5115 (org-set-local 'org-category
(intern cat
))
5116 (push (cons "CATEGORY" cat
) props
))
5118 (if (< (length prio
) 3) (setq prio
'("A" "C" "B")))
5119 (setq prio
(mapcar 'string-to-char prio
))
5120 (org-set-local 'org-highest-priority
(nth 0 prio
))
5121 (org-set-local 'org-lowest-priority
(nth 1 prio
))
5122 (org-set-local 'org-default-priority
(nth 2 prio
)))
5123 (and props
(org-set-local 'org-file-properties
(nreverse props
)))
5124 (and arch
(org-set-local 'org-archive-location arch
))
5125 (and links
(setq org-link-abbrev-alist-local
(nreverse links
)))
5126 ;; Process the TODO keywords
5128 ;; Use the global values as if they had been given locally.
5129 (setq kwds
(default-value 'org-todo-keywords
))
5130 (if (stringp (car kwds
))
5131 (setq kwds
(list (cons org-todo-interpretation
5132 (default-value 'org-todo-keywords
)))))
5133 (setq kwds
(reverse kwds
)))
5134 (setq kwds
(nreverse kwds
))
5136 (while (setq kws
(pop kwds
))
5138 (run-hook-with-args-until-success
5139 'org-todo-setup-filter-hook kws
)
5141 (setq inter
(pop kws
) sep
(member "|" kws
)
5142 kws0
(delete "|" (copy-sequence kws
))
5147 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x
)
5149 (setq kw
(match-string 1 x
)
5150 key
(and (match-end 2) (match-string 2 x
))
5151 log
(org-extract-log-state-settings x
))
5152 (push (cons kw
(and key
(string-to-char key
))) kwsa
)
5153 (and log
(push log org-todo-log-states
))
5155 (error "Invalid TODO keyword %s" x
)))
5157 kwsa
(if kwsa
(append '((:startgroup
))
5161 dws
(if sep
(org-remove-keyword-keys (cdr sep
)) (last kws1
))
5162 tail
(list inter hw
(car dws
) (org-last dws
))))
5163 (add-to-list 'org-todo-heads hw
'append
)
5164 (push kws1 org-todo-sets
)
5165 (setq org-done-keywords
(append org-done-keywords dws nil
))
5166 (setq org-todo-key-alist
(append org-todo-key-alist kwsa
))
5167 (mapc (lambda (x) (push (cons x tail
) org-todo-kwd-alist
)) kws1
)
5168 (setq org-todo-keywords-1
(append org-todo-keywords-1 kws1 nil
)))
5169 (setq org-todo-sets
(nreverse org-todo-sets
)
5170 org-todo-kwd-alist
(nreverse org-todo-kwd-alist
)
5171 org-todo-key-trigger
(delq nil
(mapcar 'cdr org-todo-key-alist
))
5172 org-todo-key-alist
(org-assign-fast-keys org-todo-key-alist
)))
5173 ;; Compute the regular expressions and other local variables.
5174 ;; Using `org-outline-regexp-bol' would complicate them much,
5175 ;; because of the fixed white space at the end of that string.
5176 (if (not org-done-keywords
)
5177 (setq org-done-keywords
(and org-todo-keywords-1
5178 (list (org-last org-todo-keywords-1
)))))
5179 (setq org-ds-keyword-length
(+ 2 (max (length org-deadline-string
)
5180 (length org-scheduled-string
)
5181 (length org-clock-string
)
5182 (length org-closed-string
)))
5183 org-not-done-keywords
5184 (org-delete-all org-done-keywords
(copy-sequence org-todo-keywords-1
))
5187 (mapconcat 'regexp-quote org-todo-keywords-1
"\\|")
5191 (mapconcat 'regexp-quote org-not-done-keywords
"\\|")
5193 org-not-done-heading-regexp
5194 (format org-heading-keyword-regexp-format org-not-done-regexp
)
5195 org-todo-line-regexp
5196 (format org-heading-keyword-maybe-regexp-format org-todo-regexp
)
5197 org-complex-heading-regexp
5198 (concat "^\\(\\*+\\)"
5199 "\\(?: +" org-todo-regexp
"\\)?"
5200 "\\(?: +\\(\\[#.\\]\\)\\)?"
5201 "\\(?: +\\(.*?\\)\\)??"
5202 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5204 org-complex-heading-regexp-format
5205 (concat "^\\(\\*+\\)"
5206 "\\(?: +" org-todo-regexp
"\\)?"
5207 "\\(?: +\\(\\[#.\\]\\)\\)?"
5209 ;; Stats cookies can be stuck to body.
5210 "\\(?:\\[[0-9%%/]+\\] *\\)*"
5212 "\\(?: *\\[[0-9%%/]+\\]\\)*"
5214 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5216 org-todo-line-tags-regexp
5217 (concat "^\\(\\*+\\)"
5218 "\\(?: +" org-todo-regexp
"\\)?"
5219 "\\(?: +\\(.*?\\)\\)??"
5220 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5222 org-deadline-regexp
(concat "\\<" org-deadline-string
)
5223 org-deadline-time-regexp
5224 (concat "\\<" org-deadline-string
" *<\\([^>]+\\)>")
5225 org-deadline-time-hour-regexp
5226 (concat "\\<" org-deadline-string
5227 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5228 org-deadline-line-regexp
5229 (concat "\\<\\(" org-deadline-string
"\\).*")
5230 org-scheduled-regexp
5231 (concat "\\<" org-scheduled-string
)
5232 org-scheduled-time-regexp
5233 (concat "\\<" org-scheduled-string
" *<\\([^>]+\\)>")
5234 org-scheduled-time-hour-regexp
5235 (concat "\\<" org-scheduled-string
5236 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5237 org-closed-time-regexp
5238 (concat "\\<" org-closed-string
" *\\[\\([^]]+\\)\\]")
5239 org-keyword-time-regexp
5240 (concat "\\<\\(" org-scheduled-string
5241 "\\|" org-deadline-string
5242 "\\|" org-closed-string
5243 "\\|" org-clock-string
"\\)"
5244 " *[[<]\\([^]>]+\\)[]>]")
5245 org-keyword-time-not-clock-regexp
5246 (concat "\\<\\(" org-scheduled-string
5247 "\\|" org-deadline-string
5248 "\\|" org-closed-string
5250 " *[[<]\\([^]>]+\\)[]>]")
5251 org-maybe-keyword-time-regexp
5252 (concat "\\(\\<\\(" org-scheduled-string
5253 "\\|" org-deadline-string
5254 "\\|" org-closed-string
5255 "\\|" org-clock-string
"\\)\\)?"
5256 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5257 org-all-time-keywords
5258 (mapcar (lambda (w) (substring w
0 -
1))
5259 (list org-scheduled-string org-deadline-string
5260 org-clock-string org-closed-string
)))
5262 (org-compute-latex-and-related-regexp))))
5264 (defun org-file-contents (file &optional noerror
)
5265 "Return the contents of FILE, as a string."
5266 (if (and file
(file-readable-p file
))
5268 (insert-file-contents file
)
5270 (funcall (if noerror
'message
'error
)
5271 "Cannot read file \"%s\"%s"
5273 (let ((from (buffer-file-name (buffer-base-buffer))))
5274 (if from
(concat " (referenced in file \"" from
"\")") "")))))
5276 (defun org-extract-log-state-settings (x)
5277 "Extract the log state setting from a TODO keyword string.
5278 This will extract info from a string like \"WAIT(w@/!)\"."
5279 (let (kw key log1 log2
)
5280 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x
)
5281 (setq kw
(match-string 1 x
)
5282 key
(and (match-end 2) (match-string 2 x
))
5283 log1
(and (match-end 3) (match-string 3 x
))
5284 log2
(and (match-end 4) (match-string 4 x
)))
5287 (and log1
(if (equal log1
"!") 'time
'note
))
5288 (and log2
(if (equal log2
"!") 'time
'note
)))))))
5290 (defun org-remove-keyword-keys (list)
5291 "Remove a pair of parenthesis at the end of each string in LIST."
5293 (if (string-match "(.*)$" x
)
5294 (substring x
0 (match-beginning 0))
5298 (defun org-assign-fast-keys (alist)
5299 "Assign fast keys to a keyword-key alist.
5300 Respect keys that are already there."
5301 (let (new e
(alt ?
0))
5302 (while (setq e
(pop alist
))
5303 (if (or (memq (car e
) '(:newline
:grouptags
:endgroup
:startgroup
))
5304 (cdr e
)) ;; Key already assigned.
5306 (let ((clist (string-to-list (downcase (car e
))))
5307 (used (append new alist
)))
5308 (when (= (car clist
) ?
@)
5310 (while (and clist
(rassoc (car clist
) used
))
5313 (while (rassoc alt used
)
5315 (push (cons (car e
) (or (car clist
) alt
)) new
))))
5318 ;;; Some variables used in various places
5320 (defvar org-window-configuration nil
5321 "Used in various places to store a window configuration.")
5322 (defvar org-selected-window nil
5323 "Used in various places to store a window configuration.")
5324 (defvar org-finish-function nil
5325 "Function to be called when `C-c C-c' is used.
5326 This is for getting out of special buffers like capture.")
5329 ;; FIXME: Occasionally check by commenting these, to make sure
5330 ;; no other functions uses these, forgetting to let-bind them.
5331 (org-no-warnings (defvar entry
)) ;; unprefixed, from calendar.el
5332 (defvar org-last-state
)
5333 (org-no-warnings (defvar date
)) ;; unprefixed, from calendar.el
5335 ;; Defined somewhere in this file, but used before definition.
5336 (defvar org-entities
) ;; defined in org-entities.el
5337 (defvar org-struct-menu
)
5338 (defvar org-org-menu
)
5339 (defvar org-tbl-menu
)
5341 ;;;; Define the Org-mode
5343 ;; We use a before-change function to check if a table might need
5345 (defvar org-table-may-need-update t
5346 "Indicates that a table might need an update.
5347 This variable is set by `org-before-change-function'.
5348 `org-table-align' sets it back to nil.")
5349 (defun org-before-change-function (beg end
)
5350 "Every change indicates that a table might need an update."
5351 (setq org-table-may-need-update t
))
5352 (defvar org-mode-map
)
5353 (defvar org-inhibit-startup-visibility-stuff nil
) ; Dynamically-scoped param.
5354 (defvar org-agenda-keep-modes nil
) ; Dynamically-scoped param.
5355 (defvar org-inhibit-logging nil
) ; Dynamically-scoped param.
5356 (defvar org-inhibit-blocking nil
) ; Dynamically-scoped param.
5357 (defvar org-table-buffer-is-an nil
)
5359 (defvar bidi-paragraph-direction
)
5360 (defvar buffer-face-mode-face
)
5363 (if (and (not (keymapp outline-mode-map
)) (featurep 'allout
))
5364 (error "Conflict with outdated version of allout.el. Load org.el before allout.el, or upgrade to newer allout, for example by switching to Emacs 22"))
5365 (require 'noutline
"noutline" 'noerror
) ;; stock XEmacs does not have it
5367 ;; Other stuff we need.
5368 (require 'time-date
)
5369 (unless (fboundp 'time-subtract
) (defalias 'time-subtract
'subtract-time
))
5373 ;; (require 'org-macs) moved higher up in the file before it is first used
5374 (require 'org-entities
)
5375 ;; (require 'org-compat) moved higher up in the file before it is first used
5376 (require 'org-faces
)
5378 (require 'org-pcomplete
)
5380 (require 'org-footnote
)
5381 (require 'org-macro
)
5387 (define-derived-mode org-mode outline-mode
"Org"
5388 "Outline-based notes management and organizer, alias
5389 \"Carsten's outline-mode for keeping track of everything.\"
5391 Org-mode develops organizational tasks around a NOTES file which
5392 contains information about projects as plain text. Org-mode is
5393 implemented on top of outline-mode, which is ideal to keep the content
5394 of large files well structured. It supports ToDo items, deadlines and
5395 time stamps, which magically appear in the diary listing of the Emacs
5396 calendar. Tables are easily created with a built-in table editor.
5397 Plain text URL-like links connect to websites, emails (VM), Usenet
5398 messages (Gnus), BBDB entries, and any files related to the project.
5399 For printing and sharing of notes, an Org-mode file (or a part of it)
5400 can be exported as a structured ASCII or HTML file.
5402 The following commands are available:
5406 ;; Get rid of Outline menus, they are not needed
5407 ;; Need to do this here because define-derived-mode sets up
5408 ;; the keymap so late. Still, it is a waste to call this each time
5409 ;; we switch another buffer into org-mode.
5410 (if (featurep 'xemacs
)
5411 (when (boundp 'outline-mode-menu-heading
)
5412 ;; Assume this is Greg's port, it uses easymenu
5413 (easy-menu-remove outline-mode-menu-heading
)
5414 (easy-menu-remove outline-mode-menu-show
)
5415 (easy-menu-remove outline-mode-menu-hide
))
5416 (define-key org-mode-map
[menu-bar headings
] 'undefined
)
5417 (define-key org-mode-map
[menu-bar hide
] 'undefined
)
5418 (define-key org-mode-map
[menu-bar show
] 'undefined
))
5420 (org-load-modules-maybe)
5421 (easy-menu-add org-org-menu
)
5422 (easy-menu-add org-tbl-menu
)
5423 (org-install-agenda-files-menu)
5424 (if org-descriptive-links
(add-to-invisibility-spec '(org-link)))
5425 (add-to-invisibility-spec '(org-cwidth))
5426 (add-to-invisibility-spec '(org-hide-block . t
))
5427 (when (featurep 'xemacs
)
5428 (org-set-local 'line-move-ignore-invisible t
))
5429 (org-set-local 'outline-regexp org-outline-regexp
)
5430 (org-set-local 'outline-level
'org-outline-level
)
5431 (setq bidi-paragraph-direction
'left-to-right
)
5432 (when (and org-ellipsis
5433 (fboundp 'set-display-table-slot
) (boundp 'buffer-display-table
)
5434 (fboundp 'make-glyph-code
))
5435 (unless org-display-table
5436 (setq org-display-table
(make-display-table)))
5437 (set-display-table-slot
5440 (lambda (c) (make-glyph-code c
(and (not (stringp org-ellipsis
))
5442 (if (stringp org-ellipsis
) org-ellipsis
"..."))))
5443 (setq buffer-display-table org-display-table
))
5444 (org-set-regexps-and-options-for-tags)
5445 (org-set-regexps-and-options)
5446 (org-set-font-lock-defaults)
5447 (when (and org-tag-faces
(not org-tags-special-faces-re
))
5448 ;; tag faces set outside customize.... force initialization.
5449 (org-set-tag-faces 'org-tag-faces org-tag-faces
))
5451 (org-set-local 'calc-embedded-open-mode
"# ")
5452 ;; Modify a few syntax entries
5453 (modify-syntax-entry ?
@ "w")
5454 (modify-syntax-entry ?
\" "\"")
5455 (modify-syntax-entry ?
\\ "_")
5456 (modify-syntax-entry ?~
"_")
5457 (if org-startup-truncated
(setq truncate-lines t
))
5458 (when org-startup-indented
(require 'org-indent
) (org-indent-mode 1))
5459 (org-set-local 'font-lock-unfontify-region-function
5460 'org-unfontify-region
)
5461 ;; Activate before-change-function
5462 (org-set-local 'org-table-may-need-update t
)
5463 (org-add-hook 'before-change-functions
'org-before-change-function nil
5465 ;; Check for running clock before killing a buffer
5466 (org-add-hook 'kill-buffer-hook
'org-check-running-clock nil
'local
)
5467 ;; Initialize macros templates.
5468 (org-macro-initialize-templates)
5469 ;; Initialize radio targets.
5470 (org-update-radio-target-regexp)
5472 (org-set-local 'indent-line-function
'org-indent-line
)
5473 (org-set-local 'indent-region-function
'org-indent-region
)
5474 ;; Filling and auto-filling.
5477 (org-setup-comments-handling)
5478 ;; Initialize cache.
5479 (org-element-cache-reset)
5480 ;; Beginning/end of defun
5481 (org-set-local 'beginning-of-defun-function
'org-backward-element
)
5482 (org-set-local 'end-of-defun-function
5484 (if (not (org-at-heading-p))
5485 (org-forward-element)
5486 (org-forward-element)
5487 (forward-char -
1))))
5488 ;; Next error for sparse trees
5489 (org-set-local 'next-error-function
'org-occur-next-match
)
5490 ;; Make sure dependence stuff works reliably, even for users who set it
5492 (if org-enforce-todo-dependencies
5493 (add-hook 'org-blocker-hook
5494 'org-block-todo-from-children-or-siblings-or-parent
)
5495 (remove-hook 'org-blocker-hook
5496 'org-block-todo-from-children-or-siblings-or-parent
))
5497 (if org-enforce-todo-checkbox-dependencies
5498 (add-hook 'org-blocker-hook
5499 'org-block-todo-from-checkboxes
)
5500 (remove-hook 'org-blocker-hook
5501 'org-block-todo-from-checkboxes
))
5503 ;; Align options lines
5505 'align-mode-rules-list
5506 '((org-in-buffer-settings
5507 (regexp .
"^[ \t]*#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5508 (modes .
'(org-mode)))))
5511 (org-set-local 'imenu-create-index-function
5512 'org-imenu-get-tree
)
5514 ;; Make isearch reveal context
5515 (if (or (featurep 'xemacs
)
5516 (not (boundp 'outline-isearch-open-invisible-function
)))
5517 ;; Emacs 21 and XEmacs make use of the hook
5518 (org-add-hook 'isearch-mode-end-hook
'org-isearch-end
'append
'local
)
5519 ;; Emacs 22 deals with this through a special variable
5520 (org-set-local 'outline-isearch-open-invisible-function
5521 (lambda (&rest ignore
) (org-show-context 'isearch
))))
5523 ;; Setup the pcomplete hooks
5524 (set (make-local-variable 'pcomplete-command-completion-function
)
5525 'org-pcomplete-initial
)
5526 (set (make-local-variable 'pcomplete-command-name-function
)
5527 'org-command-at-point
)
5528 (set (make-local-variable 'pcomplete-default-completion-function
)
5530 (set (make-local-variable 'pcomplete-parse-arguments-function
)
5531 'org-parse-arguments
)
5532 (set (make-local-variable 'pcomplete-termination-string
) "")
5533 (when (>= emacs-major-version
23)
5534 (set (make-local-variable 'buffer-face-mode-face
) 'org-default
))
5536 ;; If empty file that did not turn on org-mode automatically, make it to.
5537 (if (and org-insert-mode-line-in-empty-file
5538 (org-called-interactively-p 'any
)
5539 (= (point-min) (point-max)))
5540 (insert "# -*- mode: org -*-\n\n"))
5541 (unless org-inhibit-startup
5543 (and org-startup-with-beamer-mode
(org-beamer-mode))
5544 (when org-startup-align-all-tables
5545 (org-table-map-tables 'org-table-align
'quietly
))
5546 (when org-startup-with-inline-images
5547 (org-display-inline-images))
5548 (when org-startup-with-latex-preview
5549 (org-toggle-latex-fragment))
5550 (unless org-inhibit-startup-visibility-stuff
5551 (org-set-startup-visibility))
5552 (org-refresh-effort-properties)))
5553 ;; Try to set org-hide correctly
5554 (let ((foreground (org-find-invisible-foreground)))
5556 (set-face-foreground 'org-hide foreground
))))
5558 ;; Update `customize-package-emacs-version-alist'
5559 (add-to-list 'customize-package-emacs-version-alist
5560 '(Org ("6.21b" .
"23.1") ("6.33x" .
"23.2")
5561 ("7.8.11" .
"24.1") ("7.9.4" .
"24.3")
5562 ("8.2.6" .
"24.4")))
5564 (defvar org-mode-transpose-word-syntax-table
5565 (let ((st (make-syntax-table)))
5566 (mapc (lambda(c) (modify-syntax-entry
5567 (string-to-char (car c
)) "w p" st
))
5571 (when (fboundp 'abbrev-table-put
)
5572 (abbrev-table-put org-mode-abbrev-table
5573 :parents
(list text-mode-abbrev-table
)))
5575 (defun org-find-invisible-foreground ()
5576 (let ((candidates (remove
5579 (list (face-background 'default
)
5580 (face-background 'org-default
))
5583 (when (boundp alist
)
5584 (cdr (assoc 'background-color
(symbol-value alist
)))))
5585 '(default-frame-alist initial-frame-alist window-system-default-frame-alist
))
5586 (list (face-foreground 'org-hide
))))))
5587 (car (remove nil candidates
))))
5589 (defun org-current-time (&optional rounding-minutes past
)
5590 "Current time, possibly rounded to ROUNDING-MINUTES.
5591 When ROUNDING-MINUTES is not an integer, fall back on the car of
5592 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5593 the rounding returns a past time."
5594 (let ((r (or (and (integerp rounding-minutes
) rounding-minutes
)
5595 (car org-time-stamp-rounding-minutes
)))
5596 (time (decode-time)) res
)
5601 (append (list 0 (* r
(floor (+ .5 (/ (float (nth 1 time
)) r
)))))
5603 (if (and past
(< (org-float-time (time-subtract (current-time) res
)) 0))
5604 (seconds-to-time (- (org-float-time res
) (* r
60)))
5608 "Return today date, considering `org-extend-today-until'."
5610 (time-subtract (current-time)
5611 (list 0 (* 3600 org-extend-today-until
) 0))))
5613 ;;;; Font-Lock stuff, including the activators
5615 (defvar org-mouse-map
(make-sparse-keymap))
5616 (org-defkey org-mouse-map
[mouse-2
] 'org-open-at-mouse
)
5617 (org-defkey org-mouse-map
[mouse-3
] 'org-find-file-at-mouse
)
5618 (when org-mouse-1-follows-link
5619 (org-defkey org-mouse-map
[follow-link
] 'mouse-face
))
5620 (when org-tab-follows-link
5621 (org-defkey org-mouse-map
[(tab)] 'org-open-at-point
)
5622 (org-defkey org-mouse-map
"\C-i" 'org-open-at-point
))
5624 (require 'font-lock
)
5626 (defconst org-non-link-chars
"]\t\n\r<>")
5627 (defvar org-link-types
'("http" "https" "ftp" "mailto" "file" "file+emacs"
5628 "file+sys" "news" "shell" "elisp" "doi" "message"
5630 (defvar org-link-types-re nil
5631 "Matches a link that has a url-like prefix like \"http:\"")
5632 (defvar org-link-re-with-space nil
5633 "Matches a link with spaces, optional angular brackets around it.")
5634 (defvar org-link-re-with-space2 nil
5635 "Matches a link with spaces, optional angular brackets around it.")
5636 (defvar org-link-re-with-space3 nil
5637 "Matches a link with spaces, only for internal part in bracket links.")
5638 (defvar org-angle-link-re nil
5639 "Matches link with angular brackets, spaces are allowed.")
5640 (defvar org-plain-link-re nil
5641 "Matches plain link, without spaces.")
5642 (defvar org-bracket-link-regexp nil
5643 "Matches a link in double brackets.")
5644 (defvar org-bracket-link-analytic-regexp nil
5645 "Regular expression used to analyze links.
5646 Here is what the match groups contain after a match:
5652 (defvar org-bracket-link-analytic-regexp
++ nil
5653 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5654 (defvar org-any-link-re nil
5655 "Regular expression matching any link.")
5657 (defconst org-match-sexp-depth
3
5658 "Number of stacked braces for sub/superscript matching.")
5660 (defun org-create-multibrace-regexp (left right n
)
5661 "Create a regular expression which will match a balanced sexp.
5662 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5663 as single character strings.
5664 The regexp returned will match the entire expression including the
5665 delimiters. It will also define a single group which contains the
5666 match except for the outermost delimiters. The maximum depth of
5667 stacked delimiters is N. Escaping delimiters is not possible."
5668 (let* ((nothing (concat "[^" left right
"]*?"))
5671 (next (concat "\\(?:" nothing left nothing right
"\\)+" nothing
)))
5674 re
(concat re or next
)
5675 next
(concat "\\(?:" nothing left next right
"\\)+" nothing
)))
5676 (concat left
"\\(" re
"\\)" right
)))
5678 (defconst org-match-substring-regexp
5680 "\\(\\S-\\)\\([_^]\\)\\("
5681 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)"
5683 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth
) "\\)"
5685 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5686 "The regular expression matching a sub- or superscript.")
5688 (defconst org-match-substring-with-braces-regexp
5690 "\\(\\S-\\)\\([_^]\\)"
5691 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth
) "\\)")
5692 "The regular expression matching a sub- or superscript, forcing braces.")
5694 (defun org-make-link-regexps ()
5695 "Update the link regular expressions.
5696 This should be called after the variable `org-link-types' has changed."
5697 (let ((types-re (regexp-opt org-link-types t
)))
5698 (setq org-link-types-re
5699 (concat "\\`" types-re
":")
5700 org-link-re-with-space
5701 (concat "<?" types-re
":"
5702 "\\([^" org-non-link-chars
" ]"
5703 "[^" org-non-link-chars
"]*"
5704 "[^" org-non-link-chars
" ]\\)>?")
5705 org-link-re-with-space2
5706 (concat "<?" types-re
":"
5707 "\\([^" org-non-link-chars
" ]"
5709 "[^" org-non-link-chars
" ]\\)>?")
5710 org-link-re-with-space3
5711 (concat "<?" types-re
":"
5712 "\\([^" org-non-link-chars
" ]"
5715 (concat "<" types-re
":"
5716 "\\([^" org-non-link-chars
" ]"
5717 "[^" org-non-link-chars
"]*"
5722 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5723 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5724 org-bracket-link-regexp
5725 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5726 org-bracket-link-analytic-regexp
5729 "\\(" types-re
":\\)?"
5732 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5734 org-bracket-link-analytic-regexp
++
5737 "\\(" (regexp-opt (cons "coderef" org-link-types
) t
) ":\\)?"
5740 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5743 (concat "\\(" org-bracket-link-regexp
"\\)\\|\\("
5744 org-angle-link-re
"\\)\\|\\("
5745 org-plain-link-re
"\\)"))))
5747 (org-make-link-regexps)
5749 (defvar org-emph-face nil
)
5751 (defun org-do-emphasis-faces (limit)
5752 "Run through the buffer and emphasize strings."
5754 (while (and (not rtn
) (re-search-forward org-emph-re limit t
))
5755 (let* ((border (char-after (match-beginning 3)))
5756 (bre (regexp-quote (char-to-string border
))))
5757 (if (and (not (= border
(char-after (match-beginning 4))))
5758 (not (save-match-data
5759 (string-match (concat bre
".*" bre
)
5760 (replace-regexp-in-string
5762 (substring (match-string 2) 1 -
1))))))
5765 (setq a
(assoc (match-string 3) org-emphasis-alist
))
5766 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5770 (org-remove-flyspell-overlays-in
5771 (match-beginning 0) (match-end 0)))
5772 (add-text-properties (match-beginning 2) (match-end 2)
5773 '(font-lock-multiline t org-emphasis t
))
5774 (when org-hide-emphasis-markers
5775 (add-text-properties (match-end 4) (match-beginning 5)
5776 '(invisible org-link
))
5777 (add-text-properties (match-beginning 3) (match-end 3)
5778 '(invisible org-link
))))))
5779 (goto-char (1+ (match-beginning 0))))
5782 (defun org-emphasize (&optional char
)
5783 "Insert or change an emphasis, i.e. a font like bold or italic.
5784 If there is an active region, change that region to a new emphasis.
5785 If there is no region, just insert the marker characters and position
5786 the cursor between them.
5787 CHAR should be the marker character. If it is a space, it means to
5788 remove the emphasis of the selected region.
5789 If CHAR is not given (for example in an interactive call) it will be
5792 (let ((erc org-emphasis-regexp-components
)
5794 (string "") beg end move c s
)
5795 (if (org-region-active-p)
5796 (setq beg
(region-beginning) end
(region-end)
5797 string
(buffer-substring beg end
))
5801 (message "Emphasis marker or tag: [%s]"
5802 (mapconcat (lambda(e) (car e
)) org-emphasis-alist
""))
5803 (setq char
(read-char-exclusive)))
5804 (if (equal char ?\
)
5805 (setq s
"" move nil
)
5806 (unless (assoc (char-to-string char
) org-emphasis-alist
)
5807 (user-error "No such emphasis marker: \"%c\"" char
))
5808 (setq s
(char-to-string char
)))
5809 (while (and (> (length string
) 1)
5810 (equal (substring string
0 1) (substring string -
1))
5811 (assoc (substring string
0 1) org-emphasis-alist
))
5812 (setq string
(substring string
1 -
1)))
5813 (setq string
(concat s string s
))
5814 (if beg
(delete-region beg end
))
5816 (string-match (concat "[" (nth 0 erc
) "\n]")
5817 (char-to-string (char-before (point)))))
5820 (string-match (concat "[" (nth 1 erc
) "\n]")
5821 (char-to-string (char-after (point)))))
5822 (insert " ") (backward-char 1))
5824 (and move
(backward-char 1))))
5826 (defconst org-nonsticky-props
5827 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link
))
5829 (defsubst org-rear-nonsticky-at
(pos)
5830 (add-text-properties (1- pos
) pos
(list 'rear-nonsticky org-nonsticky-props
)))
5832 (defun org-activate-plain-links (limit)
5833 "Add link properties for plain links."
5835 (when (and (re-search-forward (concat org-plain-link-re
) limit t
)
5836 (not (member 'org-tag
5837 (get-text-property (1- (match-beginning 0)) 'face
)))
5838 (not (org-in-src-block-p)))
5839 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5840 (setq f
(get-text-property (match-beginning 0) 'face
))
5841 (setq hl
(org-match-string-no-properties 0))
5842 (if (or (eq f
'org-tag
)
5843 (and (listp f
) (memq 'org-tag f
)))
5845 (add-text-properties (match-beginning 0) (match-end 0)
5846 (list 'mouse-face
'highlight
5848 'htmlize-link
`(:uri
,hl
)
5849 'keymap org-mouse-map
))
5850 (org-rear-nonsticky-at (match-end 0)))
5853 (defun org-activate-code (limit)
5854 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t
)
5856 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5857 (remove-text-properties (match-beginning 0) (match-end 0)
5858 '(display t invisible t intangible t
))
5861 (defcustom org-src-fontify-natively t
5862 "When non-nil, fontify code in code blocks."
5865 :package-version
'(Org .
"8.3")
5866 :group
'org-appearance
5869 (defcustom org-allow-promoting-top-level-subtree nil
5870 "When non-nil, allow promoting a top level subtree.
5871 The leading star of the top level headline will be replaced
5875 :group
'org-appearance
)
5877 (defun org-fontify-meta-lines-and-blocks (limit)
5879 (org-fontify-meta-lines-and-blocks-1 limit
)
5880 (error (message "org-mode fontification error"))))
5882 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5883 "Fontify #+ lines and blocks."
5884 (let ((case-fold-search t
))
5885 (if (re-search-forward
5886 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5888 (let ((beg (match-beginning 0))
5889 (block-start (match-end 0))
5891 (lang (match-string 7))
5892 (beg1 (line-beginning-position 2))
5893 (dc1 (downcase (match-string 2)))
5894 (dc3 (downcase (match-string 3)))
5895 end end1 quoting block-type ovl
)
5897 ((member dc1
'("+html:" "+ascii:" "+latex:"))
5898 ;; a single line of backend-specific content
5899 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5900 (remove-text-properties (match-beginning 0) (match-end 0)
5901 '(display t invisible t intangible t
))
5902 (add-text-properties (match-beginning 1) (match-end 3)
5903 '(font-lock-fontified t face org-meta-line
))
5904 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5905 '(font-lock-fontified t face org-block
))
5906 ; for backend-specific code
5908 ((and (match-end 4) (equal dc3
"+begin"))
5910 (setq block-type
(downcase (match-string 5))
5911 quoting
(member block-type org-protecting-blocks
))
5912 (when (re-search-forward
5913 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5914 nil t
) ;; on purpose, we look further than LIMIT
5915 (setq end
(min (point-max) (match-end 0))
5916 end1
(min (point-max) (1- (match-beginning 0))))
5917 (setq block-end
(match-beginning 0))
5919 (org-remove-flyspell-overlays-in beg1 end1
)
5920 (remove-text-properties beg end
5921 '(display t invisible t intangible t
)))
5922 (add-text-properties
5923 beg end
'(font-lock-fontified t font-lock-multiline t
))
5924 (add-text-properties beg beg1
'(face org-meta-line
))
5925 (org-remove-flyspell-overlays-in beg beg1
)
5926 (add-text-properties ; For end_src
5927 end1
(min (point-max) (1+ end
)) '(face org-meta-line
))
5928 (org-remove-flyspell-overlays-in end1 end
)
5930 ((and lang
(not (string= lang
"")) org-src-fontify-natively
)
5931 (org-src-font-lock-fontify-block lang block-start block-end
)
5932 (add-text-properties beg1 block-end
'(src-block t
)))
5934 (add-text-properties beg1
(min (point-max) (1+ end1
))
5935 '(face org-block
))) ; end of source block
5936 ((not org-fontify-quote-and-verse-blocks
))
5937 ((string= block-type
"quote")
5938 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-quote
)))
5939 ((string= block-type
"verse")
5940 (add-text-properties beg1
(min (point-max) (1+ end1
)) '(face org-verse
))))
5941 (add-text-properties beg beg1
'(face org-block-begin-line
))
5942 (add-text-properties (min (point-max) (1+ end
)) (min (point-max) (1+ end1
))
5943 '(face org-block-end-line
))
5945 ((member dc1
'("+title:" "+author:" "+email:" "+date:"))
5946 (org-remove-flyspell-overlays-in
5948 (if (equal "+title:" dc1
) (match-end 2) (match-end 0)))
5949 (add-text-properties
5951 (if (member (intern (substring dc1
1 -
1)) org-hidden-keywords
)
5952 '(font-lock-fontified t invisible t
)
5953 '(font-lock-fontified t face org-document-info-keyword
)))
5954 (add-text-properties
5955 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5956 (if (string-equal dc1
"+title:")
5957 '(font-lock-fontified t face org-document-title
)
5958 '(font-lock-fontified t face org-document-info
))))
5959 ((or (equal dc1
"+results")
5960 (member dc1
'("+begin:" "+end:" "+caption:" "+label:"
5961 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5962 "+call:" "+header:" "+headers:" "+name:"))
5963 (and (match-end 4) (equal dc3
"+attr")))
5964 (org-remove-flyspell-overlays-in
5966 (if (equal "+caption:" dc1
) (match-end 2) (match-end 0)))
5967 (add-text-properties
5969 '(font-lock-fontified t face org-meta-line
))
5971 ((member dc3
'(" " ""))
5972 (org-remove-flyspell-overlays-in beg
(match-end 0))
5973 (add-text-properties
5975 '(font-lock-fontified t face font-lock-comment-face
)))
5976 (t ;; just any other in-buffer setting, but not indented
5977 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5978 (add-text-properties
5980 '(font-lock-fontified t face org-meta-line
))
5983 (defun org-fontify-drawers (limit)
5985 (when (re-search-forward org-drawer-regexp limit t
)
5986 (add-text-properties
5987 (match-beginning 0) (match-end 0)
5988 '(font-lock-fontified t face org-special-keyword
))
5989 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5992 (defun org-fontify-macros (limit)
5994 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t
)
5995 (add-text-properties
5996 (match-beginning 0) (match-end 0)
5997 '(font-lock-fontified t face org-macro
))
5998 (when org-hide-macro-markers
5999 (add-text-properties (match-end 2) (match-beginning 2)
6001 (add-text-properties (match-beginning 1) (match-end 1)
6003 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6006 (defun org-activate-angle-links (limit)
6007 "Add text properties for angle links."
6008 (if (and (re-search-forward org-angle-link-re limit t
)
6009 (not (org-in-src-block-p)))
6011 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6012 (add-text-properties (match-beginning 0) (match-end 0)
6013 (list 'mouse-face
'highlight
6014 'keymap org-mouse-map
))
6015 (org-rear-nonsticky-at (match-end 0))
6018 (defun org-activate-footnote-links (limit)
6019 "Add text properties for footnotes."
6020 (let ((fn (org-footnote-next-reference-or-definition limit
)))
6022 (let* ((beg (nth 1 fn
))
6025 (referencep (/= (line-beginning-position) beg
)))
6026 (when (and referencep
(nth 3 fn
))
6029 (search-forward (or label
"fn:"))
6030 (org-remove-flyspell-overlays-in beg
(match-end 0))))
6031 (add-text-properties beg end
6032 (list 'mouse-face
'highlight
6033 'keymap org-mouse-map
6035 (if referencep
"Footnote reference"
6036 "Footnote definition")
6037 'font-lock-fontified t
6038 'font-lock-multiline t
6039 'face
'org-footnote
))))))
6041 (defun org-activate-bracket-links (limit)
6042 "Add text properties for bracketed links."
6043 (if (and (re-search-forward org-bracket-link-regexp limit t
)
6044 (not (org-in-src-block-p)))
6045 (let* ((hl (org-match-string-no-properties 1))
6046 (help (concat "LINK: " (save-match-data (org-link-unescape hl
))))
6047 (ip (org-maybe-intangible
6048 (list 'invisible
'org-link
6049 'keymap org-mouse-map
'mouse-face
'highlight
6050 'font-lock-multiline t
'help-echo help
6051 'htmlize-link
`(:uri
,hl
))))
6052 (vp (list 'keymap org-mouse-map
'mouse-face
'highlight
6053 'font-lock-multiline t
'help-echo help
6054 'htmlize-link
`(:uri
,hl
))))
6055 ;; We need to remove the invisible property here. Table narrowing
6056 ;; may have made some of this invisible.
6057 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6058 (remove-text-properties (match-beginning 0) (match-end 0)
6062 (add-text-properties (match-beginning 0) (match-beginning 3) ip
)
6063 (org-rear-nonsticky-at (match-beginning 3))
6064 (add-text-properties (match-beginning 3) (match-end 3) vp
)
6065 (org-rear-nonsticky-at (match-end 3))
6066 (add-text-properties (match-end 3) (match-end 0) ip
)
6067 (org-rear-nonsticky-at (match-end 0)))
6068 (add-text-properties (match-beginning 0) (match-beginning 1) ip
)
6069 (org-rear-nonsticky-at (match-beginning 1))
6070 (add-text-properties (match-beginning 1) (match-end 1) vp
)
6071 (org-rear-nonsticky-at (match-end 1))
6072 (add-text-properties (match-end 1) (match-end 0) ip
)
6073 (org-rear-nonsticky-at (match-end 0)))
6076 (defun org-activate-dates (limit)
6077 "Add text properties for dates."
6078 (if (and (re-search-forward org-tsr-regexp-both limit t
)
6079 (not (equal (char-before (match-beginning 0)) 91)))
6081 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6082 (add-text-properties (match-beginning 0) (match-end 0)
6083 (list 'mouse-face
'highlight
6084 'keymap org-mouse-map
))
6085 (org-rear-nonsticky-at (match-end 0))
6086 (when org-display-custom-times
6088 (org-display-custom-time (match-beginning 3) (match-end 3)))
6089 (org-display-custom-time (match-beginning 1) (match-end 1)))
6092 (defvar org-target-link-regexp nil
6093 "Regular expression matching radio targets in plain text.")
6094 (make-variable-buffer-local 'org-target-link-regexp
)
6096 (defconst org-target-regexp
(let ((border "[^<>\n\r \t]"))
6097 (format "<<\\(%s\\|%s[^<>\n\r]*%s\\)>>"
6098 border border border
))
6099 "Regular expression matching a link target.")
6101 (defconst org-radio-target-regexp
(format "<%s>" org-target-regexp
)
6102 "Regular expression matching a radio target.")
6104 (defconst org-any-target-regexp
6105 (format "%s\\|%s" org-radio-target-regexp org-target-regexp
)
6106 "Regular expression matching any target.")
6108 (defun org-activate-target-links (limit)
6109 "Add text properties for target matches."
6110 (when org-target-link-regexp
6111 (let ((case-fold-search t
))
6112 (if (re-search-forward org-target-link-regexp limit t
)
6114 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6115 (add-text-properties (match-beginning 1) (match-end 1)
6116 (list 'mouse-face
'highlight
6117 'keymap org-mouse-map
6118 'help-echo
"Radio target link"
6119 'org-linked-text t
))
6120 (org-rear-nonsticky-at (match-end 1))
6123 (defun org-update-radio-target-regexp ()
6124 "Find all radio targets in this file and update the regular expression.
6125 Also refresh fontification if needed."
6127 (let ((old-regexp org-target-link-regexp
)
6128 (before-re "\\(?:^\\|[^[:alnum:]]\\)\\(")
6129 (after-re "\\)\\(?:$\\|[^[:alnum:]]\\)")
6131 (org-with-wide-buffer
6132 (goto-char (point-min))
6134 (while (re-search-forward org-radio-target-regexp nil t
)
6135 ;; Make sure point is really within the object.
6137 (let ((obj (org-element-context)))
6138 (when (eq (org-element-type obj
) 'radio-target
)
6139 (add-to-list 'rtn
(org-element-property :value obj
)))))
6141 (setq org-target-link-regexp
6146 (replace-regexp-in-string
6147 " +" "\\s-+" (regexp-quote x
) t t
))
6151 (unless (equal old-regexp org-target-link-regexp
)
6153 (let ((regexp (cond ((not old-regexp
) org-target-link-regexp
)
6154 ((not org-target-link-regexp
) old-regexp
)
6159 (substring re
(length before-re
)
6160 (- (length after-re
))))
6161 (list old-regexp org-target-link-regexp
)
6164 (org-with-wide-buffer
6165 (goto-char (point-min))
6166 (while (re-search-forward regexp nil t
)
6167 (org-element-cache-refresh (match-beginning 1)))))
6168 ;; Re fontify buffer.
6169 (when (memq 'radio org-highlight-links
)
6170 (org-restart-font-lock)))))
6172 (defun org-hide-wide-columns (limit)
6174 (setq s
(text-property-any (point) (or limit
(point-max))
6177 (setq e
(next-single-property-change s
'org-cwidth
))
6178 (add-text-properties s e
(org-maybe-intangible '(invisible org-cwidth
)))
6182 (defvar org-latex-and-related-regexp nil
6183 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6185 (defun org-compute-latex-and-related-regexp ()
6186 "Compute regular expression for LaTeX, entities and sub/superscript.
6187 Result depends on variable `org-highlight-latex-and-related'."
6189 'org-latex-and-related-regexp
6191 (cond ((not (memq 'script org-highlight-latex-and-related
)) nil
)
6192 ((eq org-use-sub-superscripts
'{})
6193 (list org-match-substring-with-braces-regexp
))
6194 (org-use-sub-superscripts (list org-match-substring-regexp
))))
6196 (when (memq 'latex org-highlight-latex-and-related
)
6197 (let ((matchers (plist-get org-format-latex-options
:matchers
)))
6200 (and (member (car x
) matchers
) (nth 1 x
)))
6201 org-latex-regexps
)))))
6203 (when (memq 'entities org-highlight-latex-and-related
)
6204 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6205 (mapconcat 'identity
(append re-latex re-entities re-sub
) "\\|"))))
6207 (defun org-do-latex-and-related (limit)
6208 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6209 LIMIT bounds the search for syntax to highlight. Stop at first
6210 highlighted object, if any. Return t if some highlighting was
6211 done, nil otherwise."
6212 (when (org-string-nw-p org-latex-and-related-regexp
)
6214 (while (re-search-forward org-latex-and-related-regexp limit t
)
6215 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6217 '(org-code org-verbatim underline
))
6218 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6222 (font-lock-prepend-text-property
6223 (+ offset
(match-beginning 0)) (match-end 0)
6224 'face
'org-latex-and-related
)
6225 (add-text-properties (+ offset
(match-beginning 0)) (match-end 0)
6226 '(font-lock-multiline t
)))
6230 (defun org-restart-font-lock ()
6231 "Restart `font-lock-mode', to force refontification."
6232 (when (and (boundp 'font-lock-mode
) font-lock-mode
)
6234 (font-lock-mode 1)))
6236 (defun org-activate-tags (limit)
6237 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t
)
6239 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6240 (add-text-properties (match-beginning 1) (match-end 1)
6241 (list 'mouse-face
'highlight
6242 'keymap org-mouse-map
))
6243 (org-rear-nonsticky-at (match-end 1))
6246 (defun org-outline-level ()
6247 "Compute the outline level of the heading at point.
6248 If this is called at a normal headline, the level is the number of stars.
6249 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6251 (if (not (ignore-errors (org-back-to-heading t
)))
6253 (looking-at org-outline-regexp
)
6254 (1- (- (match-end 0) (match-beginning 0))))))
6256 (defvar org-font-lock-keywords nil
)
6258 (defsubst org-re-property
(property &optional literal allow-null
)
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."
6269 (format "\\(?1::\\(?2:%s\\):\\)"
6270 (if literal property
(regexp-quote property
)))
6272 "\\(?:\\(?3:$\\)\\|[ \t]+\\(?3:.*?\\)\\)\\(?5:[ \t]*\\)$"
6273 "[ \t]+\\(?3:[^ \r\t\n]+.*?\\)\\(?5:[ \t]*\\)$")))
6275 (defconst org-property-re
6276 (org-re-property ".*?" 'literal t
)
6277 "Regular expression matching a property line.
6278 There are four matching groups:
6279 1: :PROPKEY: including the leading and trailing colon,
6280 2: PROPKEY without the leading and trailing colon,
6281 3: PROPVAL without leading or trailing spaces,
6282 4: the indentation of the current line,
6283 5: trailing whitespace.")
6285 (defvar org-font-lock-hook nil
6286 "Functions to be called for special font lock stuff.")
6288 (defvar org-font-lock-set-keywords-hook nil
6289 "Functions that can manipulate `org-font-lock-extra-keywords'.
6290 This is called after `org-font-lock-extra-keywords' is defined, but before
6291 it is installed to be used by font lock. This can be useful if something
6292 needs to be inserted at a specific position in the font-lock sequence.")
6294 (defun org-font-lock-hook (limit)
6295 "Run `org-font-lock-hook' within LIMIT."
6296 (run-hook-with-args 'org-font-lock-hook limit
))
6298 (defun org-set-font-lock-defaults ()
6299 "Set font lock defaults for the current buffer."
6300 (let* ((em org-fontify-emphasized-text
)
6301 (lk org-highlight-links
)
6302 (org-font-lock-extra-keywords
6305 '(org-font-lock-hook)
6307 `(,(if org-fontify-whole-heading-line
6308 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6309 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6310 (1 (org-get-level-face 1))
6311 (2 (org-get-level-face 2))
6312 (3 (org-get-level-face 3)))
6314 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6317 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t
))
6318 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t
))
6319 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t
))
6320 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t
))
6322 '(org-fontify-drawers)
6324 (list org-property-re
6325 '(1 'org-special-keyword t
)
6326 '(3 'org-property-value t
))
6328 (if (memq 'tag lk
) '(org-activate-tags (1 'org-tag prepend
)))
6329 (if (memq 'angle lk
) '(org-activate-angle-links (0 'org-link t
)))
6330 (if (memq 'plain lk
) '(org-activate-plain-links (0 'org-link t
)))
6331 (if (memq 'bracket lk
) '(org-activate-bracket-links (0 'org-link t
)))
6332 (if (memq 'radio lk
) '(org-activate-target-links (1 'org-link t
)))
6333 (if (memq 'date lk
) '(org-activate-dates (0 'org-date t
)))
6334 (if (memq 'footnote lk
) '(org-activate-footnote-links))
6336 (list org-any-target-regexp
'(0 'org-target t
))
6338 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t
))
6340 '(org-fontify-macros)
6341 '(org-hide-wide-columns (0 nil append
))
6343 (list (format org-heading-keyword-regexp-format
6345 '(2 (org-get-todo-face 2) t
))
6347 (if org-fontify-done-headline
6348 (list (format org-heading-keyword-regexp-format
6351 (mapconcat 'regexp-quote org-done-keywords
"\\|")
6353 '(2 'org-headline-done t
))
6356 '(org-font-lock-add-priority-faces)
6358 '(org-font-lock-add-tag-faces)
6360 (if (and org-group-tags org-tag-groups-alist
)
6361 (list (concat org-outline-regexp-bol
".+\\(:"
6362 (regexp-opt (mapcar 'car org-tag-groups-alist
))
6364 '(1 'org-tag-group prepend
)))
6366 (list (concat "\\<" org-comment-string
) '(0 'org-special-keyword t
))
6367 (list (concat "\\<" org-deadline-string
) '(0 'org-special-keyword t
))
6368 (list (concat "\\<" org-scheduled-string
) '(0 'org-special-keyword t
))
6369 (list (concat "\\<" org-closed-string
) '(0 'org-special-keyword t
))
6370 (list (concat "\\<" org-clock-string
) '(0 'org-special-keyword t
))
6373 (if (featurep 'xemacs
)
6374 '(org-do-emphasis-faces (0 nil append
))
6375 '(org-do-emphasis-faces)))
6377 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6378 1 'org-checkbox prepend
)
6379 (if (cdr (assq 'checkbox org-list-automatic-rules
))
6380 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6381 (0 (org-get-checkbox-statistics-face) t
)))
6382 ;; Description list items
6383 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6384 1 'org-list-dt prepend
)
6385 ;; ARCHIVEd headings
6387 org-outline-regexp-bol
6388 "\\(.*:" org-archive-tag
":.*\\)")
6389 '(1 'org-archived prepend
))
6391 '(org-do-latex-and-related)
6392 '(org-fontify-entities)
6393 '(org-raise-scripts)
6395 '(org-activate-code (1 'org-code t
))
6398 "^\\*\\(?: +%s\\)?\\(?: +\\[#[A-Z0-9]\\]\\)? +\\(?9:%s\\)\\(?: \\|$\\)"
6401 '(9 'org-special-keyword t
))
6402 ;; Blocks and meta lines
6403 '(org-fontify-meta-lines-and-blocks))))
6404 (setq org-font-lock-extra-keywords
(delq nil org-font-lock-extra-keywords
))
6405 (run-hooks 'org-font-lock-set-keywords-hook
)
6406 ;; Now set the full font-lock-keywords
6407 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords
)
6408 (org-set-local 'font-lock-defaults
6409 '(org-font-lock-keywords t nil nil backward-paragraph
))
6410 (kill-local-variable 'font-lock-keywords
) nil
))
6412 (defun org-toggle-pretty-entities ()
6413 "Toggle the composition display of entities as UTF8 characters."
6415 (org-set-local 'org-pretty-entities
(not org-pretty-entities
))
6416 (org-restart-font-lock)
6417 (if org-pretty-entities
6418 (message "Entities are now displayed as UTF8 characters")
6421 (org-decompose-region (point-min) (point-max))
6422 (message "Entities are now displayed as plain text"))))
6424 (defvar org-custom-properties-overlays nil
6425 "List of overlays used for custom properties.")
6426 (make-variable-buffer-local 'org-custom-properties-overlays
)
6428 (defun org-toggle-custom-properties-visibility ()
6429 "Display or hide properties in `org-custom-properties'."
6431 (if org-custom-properties-overlays
6432 (progn (mapc 'delete-overlay org-custom-properties-overlays
)
6433 (setq org-custom-properties-overlays nil
))
6434 (unless (not org-custom-properties
)
6438 (goto-char (point-min))
6439 (while (re-search-forward org-property-re nil t
)
6441 (when (equal p
(substring (match-string 1) 1 -
1))
6442 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6443 (overlay-put o
'invisible t
)
6444 (overlay-put o
'org-custom-property t
)
6445 (push o org-custom-properties-overlays
))))
6446 org-custom-properties
)))))))
6448 (defun org-fontify-entities (limit)
6449 "Find an entity to fontify."
6451 (when org-pretty-entities
6453 (while (re-search-forward
6454 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6456 (if (and (not (org-at-comment-p))
6457 (setq ee
(org-entity-get (match-string 1)))
6458 (= (length (nth 6 ee
)) 1))
6460 ((end (if (equal (match-string 2) "{}")
6463 (add-text-properties
6464 (match-beginning 0) end
6465 (list 'font-lock-fontified t
))
6466 (compose-region (match-beginning 0) end
6472 (defun org-fontify-like-in-org-mode (s &optional odd-levels
)
6473 "Fontify string S like in Org-mode."
6476 (let ((org-odd-levels-only odd-levels
))
6484 (defun org-get-level-face (n)
6485 "Get the right face for match N in font-lock matching of headlines."
6486 (setq org-l
(- (match-end 2) (match-beginning 1) 1))
6487 (if org-odd-levels-only
(setq org-l
(1+ (/ org-l
2))))
6488 (if org-cycle-level-faces
6489 (setq org-f
(nth (%
(1- org-l
) org-n-level-faces
) org-level-faces
))
6490 (setq org-f
(nth (1- (min org-l org-n-level-faces
)) org-level-faces
)))
6492 ((eq n
1) (if org-hide-leading-stars
'org-hide org-f
))
6494 (t (if org-level-color-stars-only nil org-f
))))
6497 (defun org-get-todo-face (kwd)
6498 "Get the right face for a TODO keyword KWD.
6499 If KWD is a number, get the corresponding match group."
6500 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6501 (or (org-face-from-face-or-color
6502 'todo
'org-todo
(cdr (assoc kwd org-todo-keyword-faces
)))
6503 (and (member kwd org-done-keywords
) 'org-done
)
6506 (defun org-face-from-face-or-color (context inherit face-or-color
)
6507 "Create a face list that inherits INHERIT, but sets the foreground color.
6508 When FACE-OR-COLOR is not a string, just return it."
6509 (if (stringp face-or-color
)
6510 (list :inherit inherit
6511 (cdr (assoc context org-faces-easy-properties
))
6515 (defun org-font-lock-add-tag-faces (limit)
6516 "Add the special tag faces."
6517 (when (and org-tag-faces org-tags-special-faces-re
)
6518 (while (re-search-forward org-tags-special-faces-re limit t
)
6519 (add-text-properties (match-beginning 1) (match-end 1)
6520 (list 'face
(org-get-tag-face 1)
6521 'font-lock-fontified t
))
6522 (backward-char 1))))
6524 (defun org-font-lock-add-priority-faces (limit)
6525 "Add the special priority faces."
6526 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t
)
6527 (when (save-match-data (org-at-heading-p))
6528 (add-text-properties
6529 (match-beginning 0) (match-end 0)
6530 (list 'face
(or (org-face-from-face-or-color
6531 'priority
'org-priority
6532 (cdr (assoc (char-after (match-beginning 1))
6533 org-priority-faces
)))
6535 'font-lock-fontified t
)))))
6537 (defun org-get-tag-face (kwd)
6538 "Get the right face for a TODO keyword KWD.
6539 If KWD is a number, get the corresponding match group."
6540 (if (numberp kwd
) (setq kwd
(match-string kwd
)))
6541 (or (org-face-from-face-or-color
6542 'tag
'org-tag
(cdr (assoc kwd org-tag-faces
)))
6545 (defun org-unfontify-region (beg end
&optional maybe_loudly
)
6546 "Remove fontification and activation overlays from links."
6547 (font-lock-default-unfontify-region beg end
)
6548 (let* ((buffer-undo-list t
)
6549 (inhibit-read-only t
) (inhibit-point-motion-hooks t
)
6550 (inhibit-modification-hooks t
)
6551 deactivate-mark buffer-file-name buffer-file-truename
)
6552 (org-decompose-region beg end
)
6553 (remove-text-properties beg end
6554 '(mouse-face t keymap t org-linked-text t
6555 invisible t intangible t
6557 (org-remove-font-lock-display-properties beg end
)))
6559 (defconst org-script-display
'(((raise -
0.3) (height 0.7))
6560 ((raise 0.3) (height 0.7))
6563 "Display properties for showing superscripts and subscripts.")
6565 (defun org-remove-font-lock-display-properties (beg end
)
6566 "Remove specific display properties that have been added by font lock.
6567 The will remove the raise properties that are used to show superscripts
6571 (setq next
(next-single-property-change beg
'display nil end
)
6572 prop
(get-text-property beg
'display
))
6573 (if (member prop org-script-display
)
6574 (put-text-property beg next
'display nil
))
6577 (defun org-raise-scripts (limit)
6578 "Add raise properties to sub/superscripts."
6579 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts
)
6580 (if (re-search-forward
6581 (if (eq org-use-sub-superscripts t
)
6582 org-match-substring-regexp
6583 org-match-substring-with-braces-regexp
)
6585 (let* ((pos (point)) table-p comment-p
6586 (mpos (match-beginning 3))
6587 (emph-p (get-text-property mpos
'org-emphasis
))
6588 (link-p (get-text-property mpos
'mouse-face
))
6589 (keyw-p (eq 'org-special-keyword
(get-text-property mpos
'face
))))
6590 (goto-char (point-at-bol))
6591 (setq table-p
(org-looking-at-p org-table-dataline-regexp
)
6592 comment-p
(org-looking-at-p "^[ \t]*#[ +]"))
6595 (if (member (char-after) '(?_ ?^
)) (goto-char (1- pos
)))
6596 (if (or comment-p emph-p link-p keyw-p
)
6598 (put-text-property (match-beginning 3) (match-end 0)
6600 (if (equal (char-after (match-beginning 2)) ?^
)
6601 (nth (if table-p
3 1) org-script-display
)
6602 (nth (if table-p
2 0) org-script-display
)))
6603 (add-text-properties (match-beginning 2) (match-end 2)
6605 'org-dwidth t
'org-dwidth-n
1))
6606 (if (and (eq (char-after (match-beginning 3)) ?
{)
6607 (eq (char-before (match-end 3)) ?
}))
6609 (add-text-properties
6610 (match-beginning 3) (1+ (match-beginning 3))
6611 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))
6612 (add-text-properties
6613 (1- (match-end 3)) (match-end 3)
6614 (list 'invisible t
'org-dwidth t
'org-dwidth-n
1))))
6617 ;;;; Visibility cycling, including org-goto and indirect buffer
6621 (defvar org-cycle-global-status nil
)
6622 (make-variable-buffer-local 'org-cycle-global-status
)
6623 (put 'org-cycle-global-status
'org-state t
)
6624 (defvar org-cycle-subtree-status nil
)
6625 (make-variable-buffer-local 'org-cycle-subtree-status
)
6626 (put 'org-cycle-subtree-status
'org-state t
)
6628 (defvar org-inlinetask-min-level
)
6630 (defun org-unlogged-message (&rest args
)
6631 "Display a message, but avoid logging it in the *Messages* buffer."
6632 (let ((message-log-max nil
))
6633 (apply 'message args
)))
6636 (defun org-cycle (&optional arg
)
6637 "TAB-action and visibility cycling for Org-mode.
6639 This is the command invoked in Org-mode by the TAB key. Its main purpose
6640 is outline visibility cycling, but it also invokes other actions
6641 in special contexts.
6643 - When this function is called with a prefix argument, rotate the entire
6644 buffer through 3 states (global cycling)
6645 1. OVERVIEW: Show only top-level headlines.
6646 2. CONTENTS: Show all headlines of all levels, but no body text.
6647 3. SHOW ALL: Show everything.
6648 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6649 determined by the variable `org-startup-folded', and by any VISIBILITY
6650 properties in the buffer.
6651 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6652 including any drawers.
6654 - When inside a table, re-align the table and move to the next field.
6656 - When point is at the beginning of a headline, rotate the subtree started
6657 by this line through 3 different states (local cycling)
6658 1. FOLDED: Only the main headline is shown.
6659 2. CHILDREN: The main headline and the direct children are shown.
6660 From this state, you can move to one of the children
6661 and zoom in further.
6662 3. SUBTREE: Show the entire subtree, including body text.
6663 If there is no subtree, switch directly from CHILDREN to FOLDED.
6665 - When point is at the beginning of an empty headline and the variable
6666 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6667 of the headline by demoting and promoting it to likely levels. This
6668 speeds up creation document structure by pressing TAB once or several
6669 times right after creating a new headline.
6671 - When there is a numeric prefix, go up to a heading with level ARG, do
6672 a `show-subtree' and return to the previous cursor position. If ARG
6673 is negative, go up that many levels.
6675 - When point is not at the beginning of a headline, execute the global
6676 binding for TAB, which is re-indenting the line. See the option
6677 `org-cycle-emulate-tab' for details.
6679 - Special case: if point is at the beginning of the buffer and there is
6680 no headline in line 1, this function will act as if called with prefix arg
6681 (C-u TAB, same as S-TAB) also when called without prefix arg.
6682 But only if also the variable `org-cycle-global-at-bob' is t."
6684 (org-load-modules-maybe)
6685 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook
)
6686 (and org-cycle-level-after-item
/entry-creation
6687 (or (org-cycle-level)
6688 (org-cycle-item-indentation))))
6690 (or org-cycle-max-level
6691 (and (boundp 'org-inlinetask-min-level
)
6692 org-inlinetask-min-level
6693 (1- org-inlinetask-min-level
))))
6694 (nstars (and limit-level
6695 (if org-odd-levels-only
6696 (and limit-level
(1- (* limit-level
2)))
6699 (if (not (derived-mode-p 'org-mode
))
6701 (concat "\\*" (if nstars
(format "\\{1,%d\\} " nstars
) "+ "))))
6702 (bob-special (and org-cycle-global-at-bob
(not arg
) (bobp)
6703 (not (looking-at org-outline-regexp
))))
6706 (delq 'org-optimize-window-after-visibility-change
6707 (copy-sequence org-cycle-hook
))
6711 (if (or bob-special
(equal arg
'(4)))
6712 ;; special case: use global cycling
6718 (setq last-command
'dummy
)
6719 (org-set-startup-visibility)
6720 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6724 (org-unlogged-message "Entire buffer visible, including drawers"))
6726 ;; Try cdlatex TAB completion
6727 ((org-try-cdlatex-tab))
6729 ;; Table: enter it or move to the next field.
6730 ((org-at-table-p 'any
)
6731 (if (org-at-table.el-p
)
6732 (message "Use C-c ' to edit table.el tables")
6733 (if arg
(org-table-edit-field t
)
6734 (org-table-justify-field-maybe)
6735 (call-interactively 'org-table-next-field
))))
6737 ((run-hook-with-args-until-success
6738 'org-tab-after-check-for-table-hook
))
6740 ;; Global cycling: delegate to `org-cycle-internal-global'.
6741 ((eq arg t
) (org-cycle-internal-global))
6743 ;; Drawers: delegate to `org-flag-drawer'.
6745 (beginning-of-line 1)
6746 (looking-at org-drawer-regexp
))
6747 (org-flag-drawer ; toggle block visibility
6748 (not (get-char-property (match-end 0) 'invisible
))))
6750 ;; Show-subtree, ARG levels up from here.
6753 (org-back-to-heading)
6754 (outline-up-heading (if (< arg
0) (- arg
)
6755 (- (funcall outline-level
) arg
)))
6756 (org-show-subtree)))
6758 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6759 ((and (featurep 'org-inlinetask
)
6760 (org-inlinetask-at-task-p)
6761 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6762 (org-inlinetask-toggle-visibility))
6764 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6765 ((and (or (and org-cycle-include-plain-lists
(org-at-item-p))
6766 (save-excursion (beginning-of-line 1)
6767 (looking-at org-outline-regexp
)))
6768 (or (bolp) (not (eq org-cycle-emulate-tab
'exc-hl-bol
))))
6769 (org-cycle-internal-local))
6771 ;; From there: TAB emulation and template completion.
6772 (buffer-read-only (org-back-to-heading))
6774 ((run-hook-with-args-until-success
6775 'org-tab-after-check-for-cycling-hook
))
6777 ((org-try-structure-completion))
6779 ((run-hook-with-args-until-success
6780 'org-tab-before-tab-emulation-hook
))
6782 ((and (eq org-cycle-emulate-tab
'exc-hl-bol
)
6784 (not (looking-at org-outline-regexp
))))
6785 (call-interactively (global-key-binding "\t")))
6787 ((if (and (memq org-cycle-emulate-tab
'(white whitestart
))
6788 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6789 (or (and (eq org-cycle-emulate-tab
'white
)
6790 (= (match-end 0) (point-at-eol)))
6791 (and (eq org-cycle-emulate-tab
'whitestart
)
6792 (>= (match-end 0) pos
))))
6794 (eq org-cycle-emulate-tab t
))
6795 (call-interactively (global-key-binding "\t")))
6798 (org-back-to-heading)
6801 (defun org-cycle-internal-global ()
6802 "Do the global cycling action."
6803 ;; Hack to avoid display of messages for .org attachments in Gnus
6804 (let ((ga (string-match "\\*fontification" (buffer-name))))
6806 ((and (eq last-command this-command
)
6807 (eq org-cycle-global-status
'overview
))
6808 ;; We just created the overview - now do table of contents
6809 ;; This can be slow in very large buffers, so indicate action
6810 (run-hook-with-args 'org-pre-cycle-hook
'contents
)
6811 (unless ga
(org-unlogged-message "CONTENTS..."))
6813 (unless ga
(org-unlogged-message "CONTENTS...done"))
6814 (setq org-cycle-global-status
'contents
)
6815 (run-hook-with-args 'org-cycle-hook
'contents
))
6817 ((and (eq last-command this-command
)
6818 (eq org-cycle-global-status
'contents
))
6819 ;; We just showed the table of contents - now show everything
6820 (run-hook-with-args 'org-pre-cycle-hook
'all
)
6822 (unless ga
(org-unlogged-message "SHOW ALL"))
6823 (setq org-cycle-global-status
'all
)
6824 (run-hook-with-args 'org-cycle-hook
'all
))
6827 ;; Default action: go to overview
6828 (run-hook-with-args 'org-pre-cycle-hook
'overview
)
6830 (unless ga
(org-unlogged-message "OVERVIEW"))
6831 (setq org-cycle-global-status
'overview
)
6832 (run-hook-with-args 'org-cycle-hook
'overview
)))))
6834 (defvar org-called-with-limited-levels nil
6835 "Non-nil when `org-with-limited-levels' is currently active.")
6837 (defun org-cycle-internal-local ()
6838 "Do the local cycling action."
6839 (let ((goal-column 0) eoh eol eos has-children children-skipped struct
)
6840 ;; First, determine end of headline (EOH), end of subtree or item
6841 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6846 (setq struct
(org-list-struct))
6847 (setq eoh
(point-at-eol))
6848 (setq eos
(org-list-get-item-end-before-blank (point) struct
))
6849 (setq has-children
(org-list-has-child-p (point) struct
)))
6850 (org-back-to-heading)
6851 (setq eoh
(save-excursion (outline-end-of-heading) (point)))
6852 (setq eos
(save-excursion (org-end-of-subtree t t
)
6853 (when (bolp) (backward-char)) (point)))
6856 (let ((level (funcall outline-level
)))
6857 (outline-next-heading)
6858 (and (org-at-heading-p t
)
6859 (> (funcall outline-level
) level
))))
6861 (org-list-search-forward (org-item-beginning-re) eos t
)))))
6862 ;; Determine end invisible part of buffer (EOL)
6863 (beginning-of-line 2)
6864 ;; XEmacs doesn't have `next-single-char-property-change'
6865 (if (featurep 'xemacs
)
6866 (while (and (not (eobp)) ;; this is like `next-line'
6867 (get-char-property (1- (point)) 'invisible
))
6868 (beginning-of-line 2))
6869 (while (and (not (eobp)) ;; this is like `next-line'
6870 (get-char-property (1- (point)) 'invisible
))
6871 (goto-char (next-single-char-property-change (point) 'invisible
))
6872 (and (eolp) (beginning-of-line 2))))
6874 ;; Find out what to do next and set `this-command'
6877 ;; Nothing is hidden behind this heading
6878 (unless (org-before-first-heading-p)
6879 (run-hook-with-args 'org-pre-cycle-hook
'empty
))
6880 (org-unlogged-message "EMPTY ENTRY")
6881 (setq org-cycle-subtree-status nil
)
6884 (outline-next-heading)
6885 (if (outline-invisible-p) (org-flag-heading nil
))))
6886 ((and (or (>= eol eos
)
6887 (not (string-match "\\S-" (buffer-substring eol eos
))))
6889 (not (setq children-skipped
6890 org-cycle-skip-children-state-if-no-children
))))
6891 ;; Entire subtree is hidden in one line: children view
6892 (unless (org-before-first-heading-p)
6893 (run-hook-with-args 'org-pre-cycle-hook
'children
))
6895 (org-list-set-item-visibility (point-at-bol) struct
'children
)
6897 (org-with-limited-levels (show-children))
6898 ;; FIXME: This slows down the func way too much.
6899 ;; How keep drawers hidden in subtree anyway?
6900 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6901 ;; (org-cycle-hide-drawers 'subtree))
6903 ;; Fold every list in subtree to top-level items.
6904 (when (eq org-cycle-include-plain-lists
'integrate
)
6906 (org-back-to-heading)
6907 (while (org-list-search-forward (org-item-beginning-re) eos t
)
6908 (beginning-of-line 1)
6909 (let* ((struct (org-list-struct))
6910 (prevs (org-list-prevs-alist struct
))
6911 (end (org-list-get-bottom-point struct
)))
6912 (mapc (lambda (e) (org-list-set-item-visibility e struct
'folded
))
6913 (org-list-get-all-items (point) struct prevs
))
6914 (goto-char (if (< end eos
) end eos
)))))))
6915 (org-unlogged-message "CHILDREN")
6918 (outline-next-heading)
6919 (if (outline-invisible-p) (org-flag-heading nil
)))
6920 (setq org-cycle-subtree-status
'children
)
6921 (unless (org-before-first-heading-p)
6922 (run-hook-with-args 'org-cycle-hook
'children
)))
6923 ((or children-skipped
6924 (and (eq last-command this-command
)
6925 (eq org-cycle-subtree-status
'children
)))
6926 ;; We just showed the children, or no children are there,
6927 ;; now show everything.
6928 (unless (org-before-first-heading-p)
6929 (run-hook-with-args 'org-pre-cycle-hook
'subtree
))
6930 (outline-flag-region eoh eos nil
)
6931 (org-unlogged-message
6932 (if children-skipped
"SUBTREE (NO CHILDREN)" "SUBTREE"))
6933 (setq org-cycle-subtree-status
'subtree
)
6934 (unless (org-before-first-heading-p)
6935 (run-hook-with-args 'org-cycle-hook
'subtree
)))
6937 ;; Default action: hide the subtree.
6938 (run-hook-with-args 'org-pre-cycle-hook
'folded
)
6939 (outline-flag-region eoh eos t
)
6940 (org-unlogged-message "FOLDED")
6941 (setq org-cycle-subtree-status
'folded
)
6942 (unless (org-before-first-heading-p)
6943 (run-hook-with-args 'org-cycle-hook
'folded
))))))
6946 (defun org-global-cycle (&optional arg
)
6947 "Cycle the global visibility. For details see `org-cycle'.
6948 With \\[universal-argument] prefix arg, switch to startup visibility.
6949 With a numeric prefix, show all headlines up to that level."
6951 (let ((org-cycle-include-plain-lists
6952 (if (derived-mode-p 'org-mode
) org-cycle-include-plain-lists nil
)))
6956 (hide-sublevels arg
)
6957 (setq org-cycle-global-status
'contents
))
6959 (org-set-startup-visibility)
6960 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6962 (org-cycle '(4))))))
6964 (defun org-set-startup-visibility ()
6965 "Set the visibility required by startup options and properties."
6967 ((eq org-startup-folded t
)
6969 ((eq org-startup-folded
'content
)
6971 ((or (eq org-startup-folded
'showeverything
)
6972 (eq org-startup-folded nil
))
6974 (unless (eq org-startup-folded
'showeverything
)
6975 (if org-hide-block-startup
(org-hide-block-all))
6976 (org-set-visibility-according-to-property 'no-cleanup
)
6977 (org-cycle-hide-archived-subtrees 'all
)
6978 (org-cycle-hide-drawers 'all
)
6979 (org-cycle-show-empty-lines t
)))
6981 (defun org-set-visibility-according-to-property (&optional no-cleanup
)
6982 "Switch subtree visibilities according to :VISIBILITY: property."
6984 (let (org-show-entry-below state
)
6986 (goto-char (point-min))
6987 (while (re-search-forward
6988 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6990 (setq state
(match-string 1))
6992 (org-back-to-heading t
)
6996 ((equal state
'("fold" "folded"))
6998 ((equal state
"children")
6999 (org-show-hidden-entry)
7001 ((equal state
"content")
7004 (org-narrow-to-subtree)
7006 ((member state
'("all" "showall"))
7009 (org-cycle-hide-archived-subtrees 'all
)
7010 (org-cycle-hide-drawers 'all
)
7011 (org-cycle-show-empty-lines 'all
)))))
7013 ;; This function uses outline-regexp instead of the more fundamental
7014 ;; org-outline-regexp so that org-cycle-global works outside of Org
7015 ;; buffers, where outline-regexp is needed.
7016 (defun org-overview ()
7017 "Switch to overview mode, showing only top-level headlines.
7018 This shows all headlines with a level equal or greater than the level
7019 of the first headline in the buffer. This is important, because if the
7020 first headline is not level one, then (hide-sublevels 1) gives confusing
7026 (goto-char (point-min))
7027 (if (re-search-forward (concat "^" outline-regexp
) nil t
)
7029 (goto-char (match-beginning 0))
7030 (funcall outline-level
))))))
7031 (and level
(hide-sublevels level
)))))
7033 (defun org-content (&optional arg
)
7034 "Show all headlines in the buffer, like a table of contents.
7035 With numerical argument N, show content up to level N."
7039 ;; Visit all headings and show their offspring
7040 (and (integerp arg
) (org-overview))
7041 (goto-char (point-max))
7043 (while (and (progn (condition-case nil
7044 (outline-previous-visible-heading 1)
7045 (error (goto-char (point-min))))
7047 (looking-at org-outline-regexp
))
7049 (show-children (1- arg
))
7051 (if (bobp) (throw 'exit nil
))))))
7053 (defun org-optimize-window-after-visibility-change (state)
7054 "Adjust the window after a change in outline visibility.
7055 This function is the default value of the hook `org-cycle-hook'."
7056 (when (get-buffer-window (current-buffer))
7058 ((eq state
'content
) nil
)
7059 ((eq state
'all
) nil
)
7060 ((eq state
'folded
) nil
)
7061 ((eq state
'children
) (or (org-subtree-end-visible-p) (recenter 1)))
7062 ((eq state
'subtree
) (or (org-subtree-end-visible-p) (recenter 1))))))
7064 (defun org-remove-empty-overlays-at (pos)
7065 "Remove outline overlays that do not contain non-white stuff."
7068 (and (eq 'outline
(overlay-get o
'invisible
))
7069 (not (string-match "\\S-" (buffer-substring (overlay-start o
)
7071 (delete-overlay o
)))
7074 (defun org-clean-visibility-after-subtree-move ()
7075 "Fix visibility issues after moving a subtree."
7076 ;; First, find a reasonable region to look at:
7077 ;; Start two siblings above, end three below
7078 (let* ((beg (save-excursion
7079 (and (org-get-last-sibling)
7080 (org-get-last-sibling))
7082 (end (save-excursion
7083 (and (org-get-next-sibling)
7084 (org-get-next-sibling)
7085 (org-get-next-sibling))
7086 (if (org-at-heading-p)
7089 (level (looking-at "\\*+"))
7090 (re (if level
(concat "^" (regexp-quote (match-string 0)) " "))))
7093 (narrow-to-region beg end
)
7095 ;; Properly fold already folded siblings
7096 (goto-char (point-min))
7097 (while (re-search-forward re nil t
)
7098 (if (and (not (outline-invisible-p))
7100 (goto-char (point-at-eol)) (outline-invisible-p)))
7102 (org-cycle-show-empty-lines 'overview
)
7103 (org-cycle-hide-drawers 'overview
)))))
7105 (defun org-cycle-show-empty-lines (state)
7106 "Show empty lines above all visible headlines.
7107 The region to be covered depends on STATE when called through
7108 `org-cycle-hook'. Lisp program can use t for STATE to get the
7109 entire buffer covered. Note that an empty line is only shown if there
7110 are at least `org-cycle-separator-lines' empty lines before the headline."
7111 (when (not (= org-cycle-separator-lines
0))
7113 (let* ((n (abs org-cycle-separator-lines
))
7115 ((= n
1) "\\(\n[ \t]*\n\\*+\\) ")
7116 ((= n
2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7117 (t (let ((ns (number-to-string (- n
2))))
7118 (concat "^\\(?:[ \t]*\n\\)\\{" ns
"," ns
"\\}"
7119 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7122 ((memq state
'(overview contents t
))
7123 (setq beg
(point-min) end
(point-max)))
7124 ((memq state
'(children folded
))
7125 (setq beg
(point) end
(progn (org-end-of-subtree t t
)
7126 (beginning-of-line 2)
7130 (while (re-search-forward re end t
)
7131 (unless (get-char-property (match-end 1) 'invisible
)
7132 (setq e
(match-end 1))
7133 (if (< org-cycle-separator-lines
0)
7134 (setq b
(save-excursion
7135 (goto-char (match-beginning 0))
7136 (org-back-over-empty-lines)
7138 (goto-char (max (point-min) (1- (point))))
7142 (setq b
(match-beginning 1)))
7143 (outline-flag-region b e nil
)))))))
7144 ;; Never hide empty lines at the end of the file.
7146 (goto-char (point-max))
7147 (outline-previous-heading)
7148 (outline-end-of-heading)
7149 (if (and (looking-at "[ \t\n]+")
7150 (= (match-end 0) (point-max)))
7151 (outline-flag-region (point) (match-end 0) nil
))))
7153 (defun org-show-empty-lines-in-parent ()
7154 "Move to the parent and re-show empty lines before visible headlines."
7156 (let ((context (if (org-up-heading-safe) 'children
'overview
)))
7157 (org-cycle-show-empty-lines context
))))
7159 (defun org-files-list ()
7160 "Return `org-agenda-files' list, plus all open org-mode files.
7161 This is useful for operations that need to scan all of a user's
7162 open and agenda-wise Org files."
7163 (let ((files (mapcar 'expand-file-name
(org-agenda-files))))
7164 (dolist (buf (buffer-list))
7165 (with-current-buffer buf
7166 (if (and (derived-mode-p 'org-mode
) (buffer-file-name))
7167 (let ((file (expand-file-name (buffer-file-name))))
7168 (unless (member file files
)
7169 (push file files
))))))
7172 (defsubst org-entry-beginning-position
()
7173 "Return the beginning position of the current entry."
7174 (save-excursion (outline-back-to-heading t
) (point)))
7176 (defsubst org-entry-end-position
()
7177 "Return the end position of the current entry."
7178 (save-excursion (outline-next-heading) (point)))
7180 (defun org-cycle-hide-drawers (state &optional exceptions
)
7181 "Re-hide all drawers after a visibility state change.
7182 When non-nil, optional argument EXCEPTIONS is a list of strings
7183 specifying which drawers should not be hidden."
7184 (when (and (derived-mode-p 'org-mode
)
7185 (not (memq state
'(overview folded contents
))))
7187 (let* ((globalp (memq state
'(contents all
)))
7188 (beg (if globalp
(point-min) (point)))
7189 (end (if globalp
(point-max)
7190 (if (eq state
'children
)
7191 (save-excursion (outline-next-heading) (point))
7192 (org-end-of-subtree t
)))))
7194 (while (re-search-forward org-drawer-regexp
(max end
(point)) t
)
7195 (unless (member-ignore-case (match-string 1) exceptions
)
7196 (let ((drawer (org-element-at-point)))
7197 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7198 (org-flag-drawer t drawer
)
7199 ;; Make sure to skip drawer entirely or we might flag
7200 ;; it another time when matching its ending line with
7201 ;; `org-drawer-regexp'.
7202 (goto-char (org-element-property :end drawer
))))))))))
7204 (defun org-cycle-hide-inline-tasks (state)
7205 "Re-hide inline tasks when switching to 'contents or 'children
7209 (when (org-bound-and-true-p org-inlinetask-min-level
)
7210 (hide-sublevels (1- org-inlinetask-min-level
))))
7212 (when (featurep 'org-inlinetask
)
7214 (while (and (outline-next-heading)
7215 (org-inlinetask-at-task-p))
7216 (org-inlinetask-toggle-visibility)
7217 (org-inlinetask-goto-end)))))))
7219 (defun org-flag-drawer (flag &optional element
)
7220 "When FLAG is non-nil, hide the drawer we are at.
7221 Otherwise make it visible. When optional argument ELEMENT is
7222 a parsed drawer, as returned by `org-element-at-point', hide or
7223 show that drawer instead."
7224 (when (save-excursion
7226 (org-looking-at-p org-drawer-regexp
))
7227 (let ((drawer (or element
(org-element-at-point))))
7228 (when (memq (org-element-type drawer
) '(drawer property-drawer
))
7229 (let ((post (org-element-property :post-affiliated drawer
)))
7231 (outline-flag-region
7232 (progn (goto-char post
) (line-end-position))
7233 (progn (goto-char (org-element-property :end drawer
))
7234 (skip-chars-backward " \r\t\n")
7235 (line-end-position))
7237 ;; When the drawer is hidden away, make sure point lies in
7238 ;; a visible part of the buffer.
7239 (when (and flag
(> (line-beginning-position) post
))
7240 (goto-char post
)))))))
7242 (defun org-subtree-end-visible-p ()
7243 "Is the end of the current subtree visible?"
7244 (pos-visible-in-window-p
7245 (save-excursion (org-end-of-subtree t
) (point))))
7247 (defun org-first-headline-recenter ()
7248 "Move cursor to the first headline and recenter the headline."
7249 (goto-char (point-min))
7250 (when (re-search-forward (concat "^\\(" org-outline-regexp
"\\)") nil t
)
7251 (set-window-start (selected-window) (point-at-bol))))
7253 ;;; Saving and restoring visibility
7255 (defun org-outline-overlay-data (&optional use-markers
)
7256 "Return a list of the locations of all outline overlays.
7257 These are overlays with the `invisible' property value `outline'.
7258 The return value is a list of cons cells, with start and stop
7259 positions for each overlay.
7260 If USE-MARKERS is set, return the positions as markers."
7267 (when (eq (overlay-get o
'invisible
) 'outline
)
7268 (setq beg
(overlay-start o
)
7269 end
(overlay-end o
))
7270 (and beg end
(> end beg
)
7272 (cons (copy-marker beg
)
7273 (copy-marker end t
))
7275 (overlays-in (point-min) (point-max))))))))
7277 (defun org-set-outline-overlay-data (data)
7278 "Create visibility overlays for all positions in DATA.
7279 DATA should have been made by `org-outline-overlay-data'."
7286 (outline-flag-region (car c
) (cdr c
) t
))
7289 ;;; Folding of blocks
7291 (defvar org-hide-block-overlays nil
7292 "Overlays hiding blocks.")
7293 (make-variable-buffer-local 'org-hide-block-overlays
)
7295 (defun org-block-map (function &optional start end
)
7296 "Call FUNCTION at the head of all source blocks in the current buffer.
7297 Optional arguments START and END can be used to limit the range."
7298 (let ((start (or start
(point-min)))
7299 (end (or end
(point-max))))
7302 (while (and (< (point) end
) (re-search-forward org-block-regexp end t
))
7305 (goto-char (match-beginning 0))
7306 (funcall function
)))))))
7308 (defun org-hide-block-toggle-all ()
7309 "Toggle the visibility of all blocks in the current buffer."
7310 (org-block-map 'org-hide-block-toggle
))
7312 (defun org-hide-block-all ()
7313 "Fold all blocks in the current buffer."
7315 (org-show-block-all)
7316 (org-block-map 'org-hide-block-toggle-maybe
))
7318 (defun org-show-block-all ()
7319 "Unfold all blocks in the current buffer."
7321 (mapc 'delete-overlay org-hide-block-overlays
)
7322 (setq org-hide-block-overlays nil
))
7324 (defun org-hide-block-toggle-maybe ()
7325 "Toggle visibility of block at point."
7327 (let ((case-fold-search t
))
7329 (beginning-of-line 1)
7330 (looking-at org-block-regexp
))
7331 (progn (org-hide-block-toggle)
7332 t
) ;; to signal that we took action
7333 nil
))) ;; to signal that we did not
7335 (defun org-hide-block-toggle (&optional force
)
7336 "Toggle the visibility of the current block.
7337 When optional argument FORCE is `off', make block visible. If it
7338 is non-nil, hide it unconditionally."
7340 (let ((element (org-element-at-point)))
7341 (unless (memq (org-element-type element
)
7342 '(center-block comment-block dynamic-block example-block
7343 export-block quote-block special-block
7344 src-block verse-block
))
7345 (user-error "Not at a block"))
7346 (let* ((start (save-excursion
7347 (goto-char (org-element-property :post-affiliated element
))
7348 (line-end-position)))
7349 (end (save-excursion
7350 (goto-char (org-element-property :end element
))
7351 (skip-chars-backward " \r\t\n")
7352 (line-end-position)))
7353 (overlays (overlays-at start
)))
7355 ;; Do nothing when not before or at the block opening line or
7356 ;; at the block closing line.
7357 ((let ((eol (line-end-position)))
7358 (and (> eol start
) (/= eol end
))))
7359 ((and (not (eq force
'off
))
7360 (not (memq t
(mapcar
7362 (eq (overlay-get o
'invisible
) 'org-hide-block
))
7364 (let ((ov (make-overlay start end
)))
7365 (overlay-put ov
'invisible
'org-hide-block
)
7366 ;; Make the block accessible to `isearch'.
7368 ov
'isearch-open-invisible
7370 (when (memq ov org-hide-block-overlays
)
7371 (setq org-hide-block-overlays
(delq ov org-hide-block-overlays
)))
7372 (when (eq (overlay-get ov
'invisible
) 'org-hide-block
)
7373 (delete-overlay ov
))))
7374 (push ov org-hide-block-overlays
)
7375 ;; When the block is hidden away, make sure point is left in
7376 ;; a visible part of the buffer.
7377 (when (> (line-beginning-position) start
)
7379 (beginning-of-line))))
7380 ((or (not force
) (eq force
'off
))
7381 (dolist (ov overlays
)
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 (let ((org-show-hierarchy-above t)
7525 (org-show-siblings t)
7526 (org-show-following-heading t))
7527 (goto-char org-goto-start-pos)
7528 (and (outline-invisible-p) (org-show-context)))
7529 (goto-char (point-min)))
7530 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7531 (message "Select location and press RET")
7532 (use-local-map org-goto-map)
7534 (kill-buffer "*org-goto*")
7535 (cons org-goto-selected-point org-goto-exit-command))))
7537 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7538 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7539 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7540 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7542 (defun org-goto-local-search-headings (string bound noerror)
7543 "Search and make sure that any matches are in headlines."
7545 (while (if isearch-forward
7546 (search-forward string bound noerror)
7547 (search-backward string bound noerror))
7548 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7549 (and (member :headline context)
7550 (not (member :tags context))))
7551 (throw 'return (point))))))
7553 (defun org-goto-local-auto-isearch ()
7556 (goto-char (point-min))
7557 (let ((keys (this-command-keys)))
7558 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7560 (isearch-process-search-char (string-to-char keys)))))
7562 (defun org-goto-ret (&optional arg)
7563 "Finish `org-goto' by going to the new location."
7565 (setq org-goto-selected-point (point)
7566 org-goto-exit-command 'return)
7569 (defun org-goto-left ()
7570 "Finish `org-goto' by going to the new location."
7572 (if (org-at-heading-p)
7574 (beginning-of-line 1)
7575 (setq org-goto-selected-point (point)
7576 org-goto-exit-command 'left)
7578 (user-error "Not on a heading")))
7580 (defun org-goto-right ()
7581 "Finish `org-goto' by going to the new location."
7583 (if (org-at-heading-p)
7585 (setq org-goto-selected-point (point)
7586 org-goto-exit-command 'right)
7588 (user-error "Not on a heading")))
7590 (defun org-goto-quit ()
7591 "Finish `org-goto' without cursor motion."
7593 (setq org-goto-selected-point nil)
7594 (setq org-goto-exit-command 'quit)
7597 ;;; Indirect buffer display of subtrees
7599 (defvar org-indirect-dedicated-frame nil
7600 "This is the frame being used for indirect tree display.")
7601 (defvar org-last-indirect-buffer nil)
7603 (defun org-tree-to-indirect-buffer (&optional arg)
7604 "Create indirect buffer and narrow it to current subtree.
7605 With a numerical prefix ARG, go up to this level and then take that tree.
7606 If ARG is negative, go up that many levels.
7608 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7609 indirect buffer previously made with this command, to avoid proliferation of
7610 indirect buffers. However, when you call the command with a \
7611 \\[universal-argument] prefix, or
7612 when `org-indirect-buffer-display' is `new-frame', the last buffer
7613 is kept so that you can work with several indirect buffers at the same time.
7614 If `org-indirect-buffer-display' is `dedicated-frame', the \
7615 \\[universal-argument] prefix also
7616 requests that a new frame be made for the new buffer, so that the dedicated
7617 frame is not changed."
7619 (let ((cbuf (current-buffer))
7620 (cwin (selected-window))
7622 beg end level heading ibuf)
7624 (org-back-to-heading t)
7626 (setq level (org-outline-level))
7627 (if (< arg 0) (setq arg (+ level arg)))
7628 (while (> (setq level (org-outline-level)) arg)
7629 (org-up-heading-safe)))
7631 heading (org-get-heading))
7632 (org-end-of-subtree t t)
7633 (if (org-at-heading-p) (backward-char 1))
7635 (if (and (buffer-live-p org-last-indirect-buffer)
7636 (not (eq org-indirect-buffer-display 'new-frame))
7638 (kill-buffer org-last-indirect-buffer))
7639 (setq ibuf (org-get-indirect-buffer cbuf heading)
7640 org-last-indirect-buffer ibuf)
7642 ((or (eq org-indirect-buffer-display 'new-frame)
7643 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7644 (select-frame (make-frame))
7645 (delete-other-windows)
7646 (org-pop-to-buffer-same-window ibuf)
7647 (org-set-frame-title heading))
7648 ((eq org-indirect-buffer-display 'dedicated-frame)
7650 (select-frame (or (and org-indirect-dedicated-frame
7651 (frame-live-p org-indirect-dedicated-frame)
7652 org-indirect-dedicated-frame)
7653 (setq org-indirect-dedicated-frame (make-frame)))))
7654 (delete-other-windows)
7655 (org-pop-to-buffer-same-window ibuf)
7656 (org-set-frame-title (concat "Indirect: " heading)))
7657 ((eq org-indirect-buffer-display 'current-window)
7658 (org-pop-to-buffer-same-window ibuf))
7659 ((eq org-indirect-buffer-display 'other-window)
7660 (pop-to-buffer ibuf))
7661 (t (error "Invalid value")))
7662 (if (featurep 'xemacs)
7663 (save-excursion (org-mode) (turn-on-font-lock)))
7664 (narrow-to-region beg end)
7667 (run-hook-with-args 'org-cycle-hook 'all)
7668 (and (window-live-p cwin) (select-window cwin))))
7670 (defun org-get-indirect-buffer (&optional buffer heading)
7671 (setq buffer (or buffer (current-buffer)))
7672 (let ((n 1) (base (buffer-name buffer)) bname)
7673 (while (buffer-live-p
7677 (if heading (concat heading "-" (number-to-string n))
7678 (number-to-string n))))))
7681 (make-indirect-buffer buffer bname 'clone)
7682 (error (make-indirect-buffer buffer bname)))))
7684 (defun org-set-frame-title (title)
7685 "Set the title of the current frame to the string TITLE."
7686 ;; FIXME: how to name a single frame in XEmacs???
7687 (unless (featurep 'xemacs)
7688 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7690 ;;;; Structure editing
7692 ;;; Inserting headlines
7694 (defun org-previous-line-empty-p (&optional next)
7695 "Is the previous line a blank line?
7696 When NEXT is non-nil, check the next line instead."
7699 (or (beginning-of-line (if next 2 0)) t)
7701 (looking-at "[ \t]*$")))))
7703 (defun org-insert-heading (&optional arg invisible-ok)
7704 "Insert a new heading or an item with the same depth at point.
7706 If point is at the beginning of a heading or a list item, insert
7707 a new heading or a new item above the current one. If point is
7708 at the beginning of a normal line, turn the line into a heading.
7710 If point is in the middle of a headline or a list item, split the
7711 headline or the item and create a new headline/item with the text
7712 in the current line after point \(see `org-M-RET-may-split-line'
7713 on how to modify this behavior).
7715 With one universal prefix argument, set the user option
7716 `org-insert-heading-respect-content' to t for the duration of
7717 the command. This modifies the behavior described above in this
7718 ways: on list items and at the beginning of normal lines, force
7719 the insertion of a heading after the current subtree.
7721 With two universal prefix arguments, insert the heading at the
7722 end of the grandparent subtree. For example, if point is within
7723 a 2nd-level heading, then it will insert a 2nd-level heading at
7724 the end of the 1st-level parent heading.
7726 If point is at the beginning of a headline, insert a sibling
7727 before the current headline. If point is not at the beginning,
7728 split the line and create a new headline with the text in the
7729 current line after point \(see `org-M-RET-may-split-line' on how
7730 to modify this behavior).
7732 If point is at the beginning of a normal line, turn this line
7735 When INVISIBLE-OK is set, stop at invisible headlines when going
7736 back. This is important for non-interactive uses of the
7739 (if (org-called-interactively-p 'any) (org-reveal))
7740 (let ((itemp (org-in-item-p))
7741 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7742 (respect-content (or org-insert-heading-respect-content
7744 (initial-content "")
7745 (adjust-empty-lines t))
7749 ((or (= (buffer-size) 0)
7750 (and (not (save-excursion
7751 (and (ignore-errors (org-back-to-heading invisible-ok))
7752 (org-at-heading-p))))
7753 (or arg (not itemp))))
7754 ;; At beginning of buffer or so high up that only a heading
7756 (cond ((and (bolp) (not respect-content)) (insert "* "))
7757 ((not respect-content)
7758 (unless may-split (end-of-line))
7760 ((re-search-forward org-outline-regexp-bol nil t)
7764 (t (goto-char (point-max))
7766 (run-hooks 'org-insert-heading-hook))
7768 ((and itemp (not (member arg '((4) (16)))))
7773 ;; Maybe move at the end of the subtree
7774 (when (equal arg '(16))
7775 (org-up-heading-safe)
7776 (org-end-of-subtree t))
7781 (on-heading (org-at-heading-p))
7782 (empty-line-p (if on-heading
7783 (org-previous-line-empty-p)
7784 ;; We will decide later
7786 ;; Get a level string to fall back on
7788 (if (org-before-first-heading-p) "*"
7790 (org-back-to-heading t)
7791 (if (org-previous-line-empty-p) (setq empty-line-p t))
7792 (looking-at org-outline-regexp)
7793 (make-string (1- (length (match-string 0))) ?*))))
7798 (org-back-to-heading invisible-ok)
7799 (when (and (not on-heading)
7800 (featurep 'org-inlinetask)
7801 (integerp org-inlinetask-min-level)
7802 (>= (length (match-string 0))
7803 org-inlinetask-min-level))
7804 ;; Find a heading level before the inline task
7805 (while (and (setq level (org-up-heading-safe))
7806 (>= level org-inlinetask-min-level)))
7807 (if (org-at-heading-p)
7808 (org-back-to-heading invisible-ok)
7809 (error "This should not happen")))
7810 (unless (and (save-excursion
7812 (org-backward-heading-same-level
7814 (= (point) (match-beginning 0)))
7815 (not (org-previous-line-empty-p t)))
7816 (setq empty-line-p (or empty-line-p
7817 (org-previous-line-empty-p))))
7819 (error (or fix-level "* ")))))
7820 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7821 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7822 pos hide-previous previous-pos)
7824 ;; If we insert after content, move there and clean up whitespace
7825 (when (and respect-content
7826 (not (org-looking-at-p org-outline-regexp-bol)))
7827 (if (not (org-before-first-heading-p))
7828 (org-end-of-subtree nil t)
7829 (re-search-forward org-outline-regexp-bol)
7830 (beginning-of-line 0))
7831 (skip-chars-backward " \r\n")
7832 (and (not (looking-back "^\\*+"))
7833 (looking-at "[ \t]+") (replace-match ""))
7834 (unless (eobp) (forward-char 1))
7835 (when (looking-at "^\\*")
7836 (unless (bobp) (backward-char 1))
7839 ;; If we are splitting, grab the text that should be moved to the new headline
7841 (if (org-on-heading-p)
7842 ;; This is a heading, we split intelligently (keeping tags)
7843 (let ((pos (point)))
7844 (goto-char (point-at-bol))
7845 (unless (looking-at org-complex-heading-regexp)
7846 (error "This should not happen"))
7847 (when (and (match-beginning 4)
7848 (> pos (match-beginning 4))
7849 (< pos (match-end 4)))
7850 (setq initial-content (buffer-substring pos (match-end 4)))
7852 (delete-region (point) (match-end 4))
7853 (if (looking-at "[ \t]*$")
7855 (insert (make-string (length initial-content) ?\ )))
7856 (setq initial-content (org-trim initial-content)))
7859 (setq initial-content
7860 (org-trim (buffer-substring (point) (point-at-eol))))
7861 (delete-region (point) (point-at-eol))))
7863 ;; If we are at the beginning of the line, insert before it. Else after
7865 ((and (bolp) (looking-at "[ \t]*$")))
7866 ((and (bolp) (not (looking-at "[ \t]*$")))
7869 (goto-char (point-at-eol))
7872 ;; Insert the new heading
7875 (insert initial-content)
7876 (when adjust-empty-lines
7878 (and blank (not (org-previous-line-empty-p))))
7879 (org-N-empty-lines-before-current (if blank 1 0))))
7880 (run-hooks 'org-insert-heading-hook)))))))
7882 (defun org-N-empty-lines-before-current (N)
7883 "Make the number of empty lines before current exactly N.
7884 So this will delete or add empty lines."
7886 (goto-char (point-at-bol))
7887 (if (looking-back "\\s-+" nil 'greedy)
7889 (or (bobp) (insert "\n"))
7894 (defun org-get-heading (&optional no-tags no-todo)
7895 "Return the heading of the current entry, without the stars.
7896 When NO-TAGS is non-nil, don't include tags.
7897 When NO-TODO is non-nil, don't include TODO keywords."
7899 (org-back-to-heading t)
7901 ((and no-tags no-todo)
7902 (looking-at org-complex-heading-regexp)
7905 (looking-at (concat org-outline-regexp
7907 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7910 (looking-at org-todo-line-regexp)
7912 (t (looking-at org-heading-regexp)
7913 (match-string 2)))))
7915 (defvar orgstruct-mode) ; defined below
7917 (defun org-heading-components ()
7918 "Return the components of the current heading.
7919 This is a list with the following elements:
7920 - the level as an integer
7921 - the reduced level, different if `org-odd-levels-only' is set.
7922 - the TODO keyword, or nil
7923 - the priority character, like ?A, or nil if no priority is given
7924 - the headline text itself, or the tags string if no headline text
7925 - the tags string, or nil."
7927 (org-back-to-heading t)
7928 (if (let (case-fold-search)
7932 org-complex-heading-regexp)))
7934 (list (length (match-string 1))
7935 (org-reduced-level (length (match-string 1)))
7940 (list (length (match-string 1))
7941 (org-reduced-level (length (match-string 1)))
7942 (org-match-string-no-properties 2)
7943 (and (match-end 3) (aref (match-string 3) 2))
7944 (org-match-string-no-properties 4)
7945 (org-match-string-no-properties 5))))))
7947 (defun org-get-entry ()
7948 "Get the entry text, after heading, entire subtree."
7950 (org-back-to-heading t)
7951 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7953 (defun org-insert-heading-after-current ()
7954 "Insert a new heading with same level as current, after current subtree."
7956 (org-back-to-heading)
7957 (org-insert-heading)
7958 (org-move-subtree-down)
7961 (defun org-insert-heading-respect-content (&optional invisible-ok)
7962 "Insert heading with `org-insert-heading-respect-content' set to t."
7964 (org-insert-heading '(4) invisible-ok))
7966 (defun org-insert-todo-heading-respect-content (&optional force-state)
7967 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7969 (org-insert-todo-heading force-state '(4)))
7971 (defun org-insert-todo-heading (arg &optional force-heading)
7972 "Insert a new heading with the same level and TODO state as current heading.
7973 If the heading has no TODO state, or if the state is DONE, use the first
7974 state (TODO by default). Also with one prefix arg, force first state. With
7975 two prefix args, force inserting at the end of the parent subtree."
7977 (when (or force-heading (not (org-insert-item 'checkbox)))
7978 (org-insert-heading (or (and (equal arg '(16)) '(16))
7981 (org-back-to-heading)
7982 (outline-previous-heading)
7983 (looking-at org-todo-line-regexp))
7986 (if (or (equal arg '(4))
7987 (not (match-beginning 2))
7988 (member (match-string 2) org-done-keywords))
7989 (car org-todo-keywords-1)
7993 (run-hook-with-args-until-success
7994 'org-todo-get-default-hook new-mark-x nil)
7996 (beginning-of-line 1)
7997 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7998 (if org-treat-insert-todo-heading-as-state-change
8000 (insert new-mark " "))))
8001 (when org-provide-todo-statistics
8002 (org-update-parent-todo-statistics))))
8004 (defun org-insert-subheading (arg)
8005 "Insert a new subheading and demote it.
8006 Works for outline headings and for plain lists alike."
8008 (org-insert-heading arg)
8010 ((org-at-heading-p) (org-do-demote))
8011 ((org-at-item-p) (org-indent-item))))
8013 (defun org-insert-todo-subheading (arg)
8014 "Insert a new subheading with TODO keyword or checkbox and demote it.
8015 Works for outline headings and for plain lists alike."
8017 (org-insert-todo-heading arg)
8019 ((org-at-heading-p) (org-do-demote))
8020 ((org-at-item-p) (org-indent-item))))
8022 ;;; Promotion and Demotion
8024 (defvar org-after-demote-entry-hook nil
8025 "Hook run after an entry has been demoted.
8026 The cursor will be at the beginning of the entry.
8027 When a subtree is being demoted, the hook will be called for each node.")
8029 (defvar org-after-promote-entry-hook nil
8030 "Hook run after an entry has been promoted.
8031 The cursor will be at the beginning of the entry.
8032 When a subtree is being promoted, the hook will be called for each node.")
8034 (defun org-promote-subtree ()
8035 "Promote the entire subtree.
8036 See also `org-promote'."
8039 (org-with-limited-levels (org-map-tree 'org-promote)))
8040 (org-fix-position-after-promote))
8042 (defun org-demote-subtree ()
8043 "Demote the entire subtree. See `org-demote'.
8044 See also `org-promote'."
8047 (org-with-limited-levels (org-map-tree 'org-demote)))
8048 (org-fix-position-after-promote))
8051 (defun org-do-promote ()
8052 "Promote the current heading higher up the tree.
8053 If the region is active in `transient-mark-mode', promote all headings
8057 (if (org-region-active-p)
8058 (org-map-region 'org-promote (region-beginning) (region-end))
8060 (org-fix-position-after-promote))
8062 (defun org-do-demote ()
8063 "Demote the current heading lower down the tree.
8064 If the region is active in `transient-mark-mode', demote all headings
8068 (if (org-region-active-p)
8069 (org-map-region 'org-demote (region-beginning) (region-end))
8071 (org-fix-position-after-promote))
8073 (defun org-fix-position-after-promote ()
8074 "Make sure that after pro/demotion cursor position is right."
8075 (let ((pos (point)))
8076 (when (save-excursion
8077 (beginning-of-line 1)
8078 (looking-at org-todo-line-regexp)
8079 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
8080 (cond ((eobp) (insert " "))
8081 ((eolp) (insert " "))
8082 ((equal (char-after) ?\ ) (forward-char 1))))))
8084 (defun org-current-level ()
8085 "Return the level of the current entry, or nil if before the first headline.
8086 The level is the number of stars at the beginning of the headline."
8088 (org-with-limited-levels
8089 (if (ignore-errors (org-back-to-heading t))
8090 (funcall outline-level)))))
8092 (defun org-get-previous-line-level ()
8093 "Return the outline depth of the last headline before the current line.
8094 Returns 0 for the first headline in the buffer, and nil if before the
8096 (and (org-current-level)
8097 (or (and (/= (line-beginning-position) (point-min))
8098 (save-excursion (beginning-of-line 0) (org-current-level)))
8101 (defun org-reduced-level (l)
8102 "Compute the effective level of a heading.
8103 This takes into account the setting of `org-odd-levels-only'."
8106 (org-odd-levels-only (1+ (floor (/ l 2))))
8109 (defun org-level-increment ()
8110 "Return the number of stars that will be added or removed at a
8111 time to headlines when structure editing, based on the value of
8112 `org-odd-levels-only'."
8113 (if org-odd-levels-only 2 1))
8115 (defun org-get-valid-level (level &optional change)
8116 "Rectify a level change under the influence of `org-odd-levels-only'
8117 LEVEL is a current level, CHANGE is by how much the level should be
8118 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8119 even level numbers will become the next higher odd number."
8120 (if org-odd-levels-only
8121 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8122 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8123 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8124 (max 1 (+ level (or change 0)))))
8126 (if (boundp 'define-obsolete-function-alias)
8127 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8128 (define-obsolete-function-alias 'org-get-legal-level
8129 'org-get-valid-level)
8130 (define-obsolete-function-alias 'org-get-legal-level
8131 'org-get-valid-level "23.1")))
8133 (defun org-promote ()
8134 "Promote the current heading higher up the tree.
8135 If the region is active in `transient-mark-mode', promote all headings
8137 (org-back-to-heading t)
8138 (let* ((level (save-match-data (funcall outline-level)))
8139 (after-change-functions (remove 'flyspell-after-change-function
8140 after-change-functions))
8141 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8142 (diff (abs (- level (length up-head) -1))))
8143 (cond ((and (= level 1) org-called-with-limited-levels
8144 org-allow-promoting-top-level-subtree)
8145 (replace-match "# " nil t))
8147 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8148 (t (replace-match up-head nil t)))
8149 ;; Fixup tag positioning
8151 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8152 (if org-adapt-indentation (org-fixup-indentation (- diff))))
8153 (run-hooks 'org-after-promote-entry-hook)))
8155 (defun org-demote ()
8156 "Demote the current heading lower down the tree.
8157 If the region is active in `transient-mark-mode', demote all headings
8159 (org-back-to-heading t)
8160 (let* ((level (save-match-data (funcall outline-level)))
8161 (after-change-functions (remove 'flyspell-after-change-function
8162 after-change-functions))
8163 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8164 (diff (abs (- level (length down-head) -1))))
8165 (replace-match down-head nil t)
8166 ;; Fixup tag positioning
8167 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8168 (if org-adapt-indentation (org-fixup-indentation diff))
8169 (run-hooks 'org-after-demote-entry-hook)))
8171 (defun org-cycle-level ()
8172 "Cycle the level of an empty headline through possible states.
8173 This goes first to child, then to parent, level, then up the hierarchy.
8174 After top level, it switches back to sibling level."
8176 (let ((org-adapt-indentation nil))
8177 (when (org-point-at-end-of-empty-headline)
8178 (setq this-command 'org-cycle-level) ; Only needed for caching
8179 (let ((cur-level (org-current-level))
8180 (prev-level (org-get-previous-line-level)))
8182 ;; If first headline in file, promote to top-level.
8184 (loop repeat (/ (- cur-level 1) (org-level-increment))
8185 do (org-do-promote)))
8186 ;; If same level as prev, demote one.
8187 ((= prev-level cur-level)
8189 ;; If parent is top-level, promote to top level if not already.
8191 (loop repeat (/ (- cur-level 1) (org-level-increment))
8192 do (org-do-promote)))
8193 ;; If top-level, return to prev-level.
8195 (loop repeat (/ (- prev-level 1) (org-level-increment))
8196 do (org-do-demote)))
8197 ;; If less than prev-level, promote one.
8198 ((< cur-level prev-level)
8200 ;; If deeper than prev-level, promote until higher than
8202 ((> cur-level prev-level)
8203 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8204 do (org-do-promote))))
8207 (defun org-map-tree (fun)
8208 "Call FUN for every heading underneath the current one."
8209 (org-back-to-heading)
8210 (let ((level (funcall outline-level)))
8214 (outline-next-heading)
8215 (> (funcall outline-level) level))
8219 (defun org-map-region (fun beg end)
8220 "Call FUN for every heading between BEG and END."
8221 (let ((org-ignore-region t))
8223 (setq end (copy-marker end))
8225 (if (and (re-search-forward org-outline-regexp-bol nil t)
8229 (outline-next-heading)
8234 (defvar org-property-end-re) ; silence byte-compiler
8235 (defun org-fixup-indentation (diff)
8236 "Change the indentation in the current entry by DIFF.
8237 However, if any line in the current entry has no indentation, or if it
8238 would end up with no indentation after the change, nothing at all is done."
8240 (let ((end (save-excursion (outline-next-heading)
8242 (prohibit (if (> diff 0)
8244 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8246 (unless (save-excursion (end-of-line 1)
8247 (re-search-forward prohibit end t))
8248 (while (and (< (point) end)
8249 (re-search-forward "^[ \t]+" end t))
8250 (goto-char (match-end 0))
8251 (setq col (current-column))
8252 (if (< diff 0) (replace-match ""))
8253 (org-indent-to-column (+ diff col))))
8254 (move-marker end nil))))
8256 (defun org-convert-to-odd-levels ()
8257 "Convert an org-mode file with all levels allowed to one with odd levels.
8258 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8261 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8262 (let ((outline-level 'org-outline-level)
8263 (org-odd-levels-only nil) n)
8265 (goto-char (point-min))
8266 (while (re-search-forward "^\\*\\*+ " nil t)
8267 (setq n (- (length (match-string 0)) 2))
8268 (while (>= (setq n (1- n)) 0)
8270 (end-of-line 1))))))
8272 (defun org-convert-to-oddeven-levels ()
8273 "Convert an org-mode file with only odd levels to one with odd/even levels.
8274 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8275 file contains a section with an even level, conversion would
8276 destroy the structure of the file. An error is signaled in this
8279 (goto-char (point-min))
8280 ;; First check if there are no even levels
8281 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8282 (org-show-context t)
8283 (error "Not all levels are odd in this file. Conversion not possible"))
8284 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8285 (let ((outline-regexp org-outline-regexp)
8286 (outline-level 'org-outline-level)
8287 (org-odd-levels-only nil) n)
8289 (goto-char (point-min))
8290 (while (re-search-forward "^\\*\\*+ " nil t)
8291 (setq n (/ (1- (length (match-string 0))) 2))
8292 (while (>= (setq n (1- n)) 0)
8294 (end-of-line 1))))))
8296 (defun org-tr-level (n)
8297 "Make N odd if required."
8298 (if org-odd-levels-only (1+ (/ n 2)) n))
8300 ;;; Vertical tree motion, cutting and pasting of subtrees
8302 (defun org-move-subtree-up (&optional arg)
8303 "Move the current subtree up past ARG headlines of the same level."
8305 (org-move-subtree-down (- (prefix-numeric-value arg))))
8307 (defun org-move-subtree-down (&optional arg)
8308 "Move the current subtree down past ARG headlines of the same level."
8310 (setq arg (prefix-numeric-value arg))
8311 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8312 'org-get-last-sibling))
8313 (ins-point (make-marker))
8315 (col (current-column))
8316 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8318 (org-back-to-heading)
8321 (setq ne-beg (org-back-over-empty-lines))
8324 (save-excursion (outline-end-of-heading)
8325 (setq folded (outline-invisible-p)))
8326 (progn (org-end-of-subtree nil t)
8327 (unless (eobp) (backward-char))))
8328 (outline-next-heading)
8329 (setq ne-end (org-back-over-empty-lines))
8332 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8333 ;; include less whitespace
8336 (forward-line (- ne-beg ne-end))
8337 (setq beg (point))))
8338 ;; Find insertion point, with error handling
8340 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8341 (progn (goto-char beg0)
8342 (user-error "Cannot move past superior level or buffer limit")))
8343 (setq cnt (1- cnt)))
8345 ;; Moving forward - still need to move over subtree
8346 (progn (org-end-of-subtree t t)
8348 (org-back-over-empty-lines)
8349 (or (bolp) (newline)))))
8350 (setq ne-ins (org-back-over-empty-lines))
8351 (move-marker ins-point (point))
8352 (setq txt (buffer-substring beg end))
8353 (org-save-markers-in-region beg end)
8354 (delete-region beg end)
8355 (org-remove-empty-overlays-at beg)
8356 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8357 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8358 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8359 (let ((bbb (point)))
8360 (insert-before-markers txt)
8361 (org-reinstall-markers-in-region bbb)
8362 (move-marker ins-point bbb))
8363 (or (bolp) (insert "\n"))
8364 (setq ins-end (point))
8365 (goto-char ins-point)
8366 (org-skip-whitespace)
8367 (when (and (< arg 0)
8368 (org-first-sibling-p)
8370 ;; Move whitespace back to beginning
8373 (let ((kill-whole-line t))
8374 (kill-line (- ne-ins ne-beg)) (point)))
8375 (insert (make-string (- ne-ins ne-beg) ?\n)))
8376 (move-marker ins-point nil)
8381 (org-cycle-hide-drawers 'children))
8382 (org-clean-visibility-after-subtree-move)
8383 ;; move back to the initial column we were at
8384 (move-to-column col)))
8386 (defvar org-subtree-clip ""
8387 "Clipboard for cut and paste of subtrees.
8388 This is actually only a copy of the kill, because we use the normal kill
8389 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8391 (defvar org-subtree-clip-folded nil
8392 "Was the last copied subtree folded?
8393 This is used to fold the tree back after pasting.")
8395 (defun org-cut-subtree (&optional n)
8396 "Cut the current subtree into the clipboard.
8397 With prefix arg N, cut this many sequential subtrees.
8398 This is a short-hand for marking the subtree and then cutting it."
8400 (org-copy-subtree n 'cut))
8402 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8403 "Copy the current subtree it in the clipboard.
8404 With prefix arg N, copy this many sequential subtrees.
8405 This is a short-hand for marking the subtree and then copying it.
8406 If CUT is non-nil, actually cut the subtree.
8407 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8408 of some markers in the region, even if CUT is non-nil. This is
8409 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8411 (let (beg end folded (beg0 (point)))
8412 (if (org-called-interactively-p 'any)
8413 (org-back-to-heading nil) ; take what looks like a subtree
8414 (org-back-to-heading t)) ; take what is really there
8416 (skip-chars-forward " \t\r\n")
8419 (outline-next-heading)
8420 (save-excursion (outline-end-of-heading)
8421 (setq folded (outline-invisible-p)))
8422 (ignore-errors (org-forward-heading-same-level (1- n) t))
8423 (org-end-of-subtree t t)))
8427 (setq org-subtree-clip-folded folded)
8428 (when (or cut force-store-markers)
8429 (org-save-markers-in-region beg end))
8430 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8431 (setq org-subtree-clip (current-kill 0))
8432 (message "%s: Subtree(s) with %d characters"
8433 (if cut "Cut" "Copied")
8434 (length org-subtree-clip)))))
8436 (defun org-paste-subtree (&optional level tree for-yank remove)
8437 "Paste the clipboard as a subtree, with modification of headline level.
8438 The entire subtree is promoted or demoted in order to match a new headline
8441 If the cursor is at the beginning of a headline, the same level as
8442 that headline is used to paste the tree.
8444 If not, the new level is derived from the *visible* headings
8445 before and after the insertion point, and taken to be the inferior headline
8446 level of the two. So if the previous visible heading is level 3 and the
8447 next is level 4 (or vice versa), level 4 will be used for insertion.
8448 This makes sure that the subtree remains an independent subtree and does
8449 not swallow low level entries.
8451 You can also force a different level, either by using a numeric prefix
8452 argument, or by inserting the heading marker by hand. For example, if the
8453 cursor is after \"*****\", then the tree will be shifted to level 5.
8455 If optional TREE is given, use this text instead of the kill ring.
8457 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8458 move back over whitespace before inserting, and move point to the end of
8459 the inserted text when done.
8461 When REMOVE is non-nil, remove the subtree from the clipboard."
8463 (setq tree (or tree (and kill-ring (current-kill 0))))
8464 (unless (org-kill-is-subtree-p tree)
8466 (substitute-command-keys
8467 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8468 (org-with-limited-levels
8469 (let* ((visp (not (outline-invisible-p)))
8471 (^re_ "\\(\\*+\\)[ \t]*")
8472 (old-level (if (string-match org-outline-regexp-bol txt)
8473 (- (match-end 0) (match-beginning 0) 1)
8475 (force-level (cond (level (prefix-numeric-value level))
8476 ((and (looking-at "[ \t]*$")
8478 "^\\*+$" (buffer-substring
8479 (point-at-bol) (point))))
8480 (- (match-end 0) (match-beginning 0)))
8482 (looking-at org-outline-regexp))
8483 (- (match-end 0) (point) 1))))
8484 (previous-level (save-excursion
8487 (outline-previous-visible-heading 1)
8488 (if (looking-at ^re_)
8489 (- (match-end 0) (match-beginning 0) 1)
8492 (next-level (save-excursion
8495 (or (looking-at org-outline-regexp)
8496 (outline-next-visible-heading 1))
8497 (if (looking-at ^re_)
8498 (- (match-end 0) (match-beginning 0) 1)
8501 (new-level (or force-level (max previous-level next-level)))
8502 (shift (if (or (= old-level -1)
8504 (= old-level new-level))
8506 (- new-level old-level)))
8507 (delta (if (> shift 0) -1 1))
8508 (func (if (> shift 0) 'org-demote 'org-promote))
8509 (org-odd-levels-only nil)
8511 ;; Remove the forced level indicator
8513 (delete-region (point-at-bol) (point)))
8515 (beginning-of-line (if (bolp) 1 2))
8517 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8518 (insert-before-markers txt)
8519 (unless (string-match "\n\\'" txt) (insert "\n"))
8520 (setq newend (point))
8521 (org-reinstall-markers-in-region beg)
8524 (skip-chars-forward " \t\n\r")
8526 (if (and (outline-invisible-p) visp)
8527 (save-excursion (outline-show-heading)))
8528 ;; Shift if necessary
8531 (narrow-to-region beg end)
8532 (while (not (= shift 0))
8533 (org-map-region func (point-min) (point-max))
8534 (setq shift (+ delta shift)))
8535 (goto-char (point-min))
8536 (setq newend (point-max))))
8537 (when (or (org-called-interactively-p 'interactive) for-yank)
8538 (message "Clipboard pasted as level %d subtree" new-level))
8539 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8541 (eq org-subtree-clip (current-kill 0))
8542 org-subtree-clip-folded)
8543 ;; The tree was folded before it was killed/copied
8545 (and for-yank (goto-char newend))
8546 (and remove (setq kill-ring (cdr kill-ring))))))
8548 (defun org-kill-is-subtree-p (&optional txt)
8549 "Check if the current kill is an outline subtree, or a set of trees.
8550 Returns nil if kill does not start with a headline, or if the first
8551 headline level is not the largest headline level in the tree.
8552 So this will actually accept several entries of equal levels as well,
8553 which is OK for `org-paste-subtree'.
8554 If optional TXT is given, check this string instead of the current kill."
8555 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8556 (re (org-get-limited-outline-regexp))
8557 (^re (concat "^" re))
8558 (start-level (and kill
8560 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8562 (- (match-end 2) (match-beginning 2) 1)))
8563 (start (1+ (or (match-beginning 2) -1))))
8564 (if (not start-level)
8566 nil) ;; does not even start with a heading
8568 (while (setq start (string-match ^re kill (1+ start)))
8569 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8573 (defvar org-markers-to-move nil
8574 "Markers that should be moved with a cut-and-paste operation.
8575 Those markers are stored together with their positions relative to
8576 the start of the region.")
8578 (defun org-save-markers-in-region (beg end)
8579 "Check markers in region.
8580 If these markers are between BEG and END, record their position relative
8581 to BEG, so that after moving the block of text, we can put the markers back
8583 This function gets called just before an entry or tree gets cut from the
8584 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8585 called immediately, to move the markers with the entries."
8586 (setq org-markers-to-move nil)
8587 (when (featurep 'org-clock)
8588 (org-clock-save-markers-for-cut-and-paste beg end))
8589 (when (featurep 'org-agenda)
8590 (org-agenda-save-markers-for-cut-and-paste beg end)))
8592 (defun org-check-and-save-marker (marker beg end)
8593 "Check if MARKER is between BEG and END.
8594 If yes, remember the marker and the distance to BEG."
8595 (when (and (marker-buffer marker)
8596 (equal (marker-buffer marker) (current-buffer)))
8597 (if (and (>= marker beg) (< marker end))
8598 (push (cons marker (- marker beg)) org-markers-to-move))))
8600 (defun org-reinstall-markers-in-region (beg)
8601 "Move all remembered markers to their position relative to BEG."
8603 (move-marker (car x) (+ beg (cdr x))))
8604 org-markers-to-move)
8605 (setq org-markers-to-move nil))
8607 (defun org-narrow-to-subtree ()
8608 "Narrow buffer to the current subtree."
8612 (org-with-limited-levels
8614 (progn (org-back-to-heading t) (point))
8615 (progn (org-end-of-subtree t t)
8616 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8619 (defun org-narrow-to-block ()
8620 "Narrow buffer to the current block."
8622 (let* ((case-fold-search t)
8623 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8624 "^[ \t]*#\\+end_.*")))
8626 (narrow-to-region (car blockp) (cdr blockp))
8627 (user-error "Not in a block"))))
8630 (defvar org-property-drawer-re))
8632 (defvar org-property-start-re) ;; defined below
8633 (defun org-clone-subtree-with-time-shift (n &optional shift)
8634 "Clone the task (subtree) at point N times.
8635 The clones will be inserted as siblings.
8637 In interactive use, the user will be prompted for the number of
8638 clones to be produced. If the entry has a timestamp, the user
8639 will also be prompted for a time shift, which may be a repeater
8640 as used in time stamps, for example `+3d'. To disable this,
8641 you can call the function with a universal prefix argument.
8643 When a valid repeater is given and the entry contains any time
8644 stamps, the clones will become a sequence in time, with time
8645 stamps in the subtree shifted for each clone produced. If SHIFT
8646 is nil or the empty string, time stamps will be left alone. The
8647 ID property of the original subtree is removed.
8649 If the original subtree did contain time stamps with a repeater,
8650 the following will happen:
8651 - the repeater will be removed in each clone
8652 - an additional clone will be produced, with the current, unshifted
8653 date(s) in the entry.
8654 - the original entry will be placed *after* all the clones, with
8656 - the start days in the repeater in the original entry will be shifted
8657 to past the last clone.
8658 In this way you can spell out a number of instances of a repeating task,
8659 and still retain the repeater to cover future instances of the task."
8660 (interactive "nNumber of clones to produce: ")
8663 (if (and (not (equal current-prefix-arg '(4)))
8665 (re-search-forward org-ts-regexp-both
8667 (org-end-of-subtree t)
8669 (read-from-minibuffer
8670 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8671 ""))) ;; No time shift
8673 (drawer-re org-drawer-regexp)
8674 (org-clock-re (format "^[ \t]*%s.*$" org-clock-string))
8675 beg end template task idprop
8676 shift-n shift-what doshift nmin nmax)
8677 (if (not (and (integerp n) (> n 0)))
8678 (user-error "Invalid number of replications %s" n))
8679 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8680 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8682 (user-error "Invalid shift specification %s" shift))
8684 (setq shift-n (string-to-number (match-string 1 shift))
8685 shift-what (cdr (assoc (match-string 2 shift)
8686 '(("d" . day) ("w" . week)
8687 ("m" . month) ("y" . year))))))
8688 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8689 (setq nmin 1 nmax n)
8690 (org-back-to-heading t)
8692 (setq idprop (org-entry-get nil "ID"))
8693 (org-end-of-subtree t t)
8694 (or (bolp) (insert "\n"))
8696 (setq template (buffer-substring beg end))
8698 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8699 (delete-region beg end)
8701 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8703 (loop for n from nmin to nmax do
8708 (goto-char (point-min))
8710 (and idprop (if org-clone-delete-id
8711 (org-entry-delete nil "ID")
8712 (org-id-get-create t)))
8714 (while (re-search-forward org-clock-re nil t)
8716 (goto-char (point-min))
8717 (while (re-search-forward drawer-re nil t)
8718 (org-remove-empty-drawer-at (point))))
8719 (goto-char (point-min))
8721 (while (re-search-forward org-ts-regexp-both nil t)
8722 (org-timestamp-change (* n shift-n) shift-what))
8723 (unless (= n n-no-remove)
8724 (goto-char (point-min))
8725 (while (re-search-forward org-ts-regexp nil t)
8727 (goto-char (match-beginning 0))
8728 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8729 (delete-region (match-beginning 1) (match-end 1)))))))
8730 (setq task (buffer-string)))
8736 (defun org-sort (with-case)
8737 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8738 Optional argument WITH-CASE means sort case-sensitively."
8741 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8742 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8744 (org-call-with-arg 'org-sort-entries with-case))))
8746 (defun org-sort-remove-invisible (s)
8747 "Remove invisible links from string S."
8748 (remove-text-properties 0 (length s) org-rm-props s)
8749 (while (string-match org-bracket-link-regexp s)
8750 (setq s (replace-match (if (match-end 2)
8752 (match-string 1 s)) t t s)))
8753 (let ((st (format " %s " s)))
8754 (while (string-match org-emph-re st)
8755 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8756 (setq s (substring st 1 -1)))
8759 (defvar org-priority-regexp) ; defined later in the file
8761 (defvar org-after-sorting-entries-or-items-hook nil
8762 "Hook that is run after a bunch of entries or items have been sorted.
8763 When children are sorted, the cursor is in the parent line when this
8764 hook gets called. When a region or a plain list is sorted, the cursor
8765 will be in the first entry of the sorted region/list.")
8767 (defun org-sort-entries
8768 (&optional with-case sorting-type getkey-func compare-func property)
8769 "Sort entries on a certain level of an outline tree.
8770 If there is an active region, the entries in the region are sorted.
8771 Else, if the cursor is before the first entry, sort the top-level items.
8772 Else, the children of the entry at point are sorted.
8774 Sorting can be alphabetically, numerically, by date/time as given by
8775 a time stamp, by a property, by priority order, or by a custom function.
8777 The command prompts for the sorting type unless it has been given to the
8778 function through the SORTING-TYPE argument, which needs to be a character,
8779 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F ?k ?K). Here is
8780 the precise meaning of each character:
8782 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8783 c By creation time, which is assumed to be the first inactive time stamp
8784 at the beginning of a line.
8785 d By deadline date/time.
8787 n Numerically, by converting the beginning of the entry/item to a number.
8788 o By order of TODO keywords.
8789 p By priority according to the cookie.
8790 r By the value of a property.
8791 s By scheduled date/time.
8792 t By date/time, either the first active time stamp in the entry, or, if
8793 none exist, by the first inactive one.
8795 Capital letters will reverse the sort order.
8797 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8798 called with point at the beginning of the record. It must return either
8799 a string or a number that should serve as the sorting key for that record.
8801 Comparing entries ignores case by default. However, with an optional argument
8802 WITH-CASE, the sorting considers case as well.
8804 Sorting is done against the visible part of the headlines, it ignores hidden
8807 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8809 (let ((case-func (if with-case 'identity 'downcase))
8811 ;; The clock marker is lost when using `sort-subr', let's
8812 ;; store the clocking string.
8813 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8815 (goto-char org-clock-marker)
8816 (looking-back "^.*") (match-string-no-properties 0))))
8817 start beg end stars re re2
8819 ;; Find beginning and end of region to sort
8821 ((org-region-active-p)
8822 ;; we will sort the region
8823 (setq end (region-end)
8825 (goto-char (region-beginning))
8826 (if (not (org-at-heading-p)) (outline-next-heading))
8827 (setq start (point)))
8828 ((or (org-at-heading-p)
8829 (ignore-errors (progn (org-back-to-heading) t)))
8830 ;; we will sort the children of the current headline
8831 (org-back-to-heading)
8833 end (progn (org-end-of-subtree t t)
8834 (or (bolp) (insert "\n"))
8835 (when (>= (org-back-over-empty-lines) 1)
8841 (outline-next-heading))
8843 ;; we will sort the top-level entries in this file
8844 (goto-char (point-min))
8845 (or (org-at-heading-p) (outline-next-heading))
8846 (setq start (point))
8847 (goto-char (point-max))
8848 (beginning-of-line 1)
8849 (when (looking-at ".*?\\S-")
8850 ;; File ends in a non-white line
8853 (setq end (point-max))
8854 (setq what "top-level")
8859 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8861 (looking-at "\\(\\*+\\)")
8862 (setq stars (match-string 1)
8863 re (concat "^" (regexp-quote stars) " +")
8864 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8865 txt (buffer-substring beg end))
8866 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8867 (if (and (not (equal stars "*")) (string-match re2 txt))
8868 (user-error "Region to sort contains a level above the first entry"))
8870 (unless sorting-type
8872 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8873 [t]ime
[s]cheduled [d]eadline [c]reated cloc[k]ing
8874 A/N/P/R/O/F/T/S/D/C/K means reversed:"
8876 (setq sorting-type (read-char-exclusive))
8879 (and (= (downcase sorting-type) ?f)
8881 (org-icompleting-read "Sort using function: "
8882 obarray 'fboundp t nil nil))
8883 (setq getkey-func (intern getkey-func))))
8885 (and (= (downcase sorting-type) ?r)
8888 (org-icompleting-read "Property: "
8889 (mapcar 'list (org-buffer-property-keys t))
8892 (when (member sorting-type '(?k ?K)) (org-clock-sum))
8893 (message "Sorting entries...")
8896 (narrow-to-region start end)
8897 (let ((dcst (downcase sorting-type))
8898 (case-fold-search nil)
8899 (now (current-time)))
8901 (/= dcst sorting-type)
8902 ;; This function moves to the beginning character of the "record" to
8905 (if (re-search-forward re nil t)
8906 (goto-char (match-beginning 0))
8907 (goto-char (point-max))))
8908 ;; This function moves to the last character of the "record" being
8913 (outline-forward-same-level 1)
8915 (goto-char (point-max))))))
8916 ;; This function returns the value that gets sorted against.
8920 (if (looking-at org-complex-heading-regexp)
8921 (string-to-number (org-sort-remove-invisible (match-string 4)))
8924 (if (looking-at org-complex-heading-regexp)
8925 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8928 (or (get-text-property (point) :org-clock-minutes) 0))
8930 (let ((end (save-excursion (outline-next-heading) (point))))
8931 (if (or (re-search-forward org-ts-regexp end t)
8932 (re-search-forward org-ts-regexp-both end t))
8933 (org-time-string-to-seconds (match-string 0))
8934 (org-float-time now))))
8936 (let ((end (save-excursion (outline-next-heading) (point))))
8937 (if (re-search-forward
8938 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8940 (org-time-string-to-seconds (match-string 0))
8941 (org-float-time now))))
8943 (let ((end (save-excursion (outline-next-heading) (point))))
8944 (if (re-search-forward org-scheduled-time-regexp end t)
8945 (org-time-string-to-seconds (match-string 1))
8946 (org-float-time now))))
8948 (let ((end (save-excursion (outline-next-heading) (point))))
8949 (if (re-search-forward org-deadline-time-regexp end t)
8950 (org-time-string-to-seconds (match-string 1))
8951 (org-float-time now))))
8953 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8954 (string-to-char (match-string 2))
8955 org-default-priority))
8957 (or (org-entry-get nil property) ""))
8959 (if (looking-at org-complex-heading-regexp)
8960 (let* ((m (match-string 2))
8961 (s (if (member m org-done-keywords) '- '+)))
8962 (- 99 (funcall s (length (member m org-todo-keywords-1)))))))
8966 (setq tmp (funcall getkey-func))
8967 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8969 (error "Invalid key function `%s'" getkey-func)))
8970 (t (error "Invalid sorting type `%c'" sorting-type))))
8973 ((= dcst ?a) 'string<)
8974 ((= dcst ?f) compare-func)
8975 ((member dcst '(?p ?t ?s ?d ?c ?k)) '<)))))
8976 (run-hooks 'org-after-sorting-entries-or-items-hook)
8977 ;; Reset the clock marker if needed
8981 (search-forward cmstr nil t)
8982 (move-marker org-clock-marker (point))))
8983 (message "Sorting entries...done")))
8985 (defun org-do-sort (table what &optional with-case sorting-type)
8986 "Sort TABLE of WHAT according to SORTING-TYPE.
8987 The user will be prompted for the SORTING-TYPE if the call to this
8988 function does not specify it.
8989 WHAT is only for the prompt, to indicate what is being sorted.
8990 The sorting key will be extracted from the car of the elements of
8992 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8993 (unless sorting-type
8995 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8997 (setq sorting-type (read-char-exclusive)))
8998 (let ((dcst (downcase sorting-type))
8999 extractfun comparefun)
9000 ;; Define the appropriate functions
9003 (setq extractfun 'string-to-number
9004 comparefun (if (= dcst sorting-type) '< '>)))
9006 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
9007 (lambda(x) (downcase (org-sort-remove-invisible x))))
9008 comparefun (if (= dcst sorting-type)
9010 (lambda (a b) (and (not (string< a b))
9011 (not (string= a b)))))))
9015 (cond ((or (string-match org-ts-regexp x)
9016 (string-match org-ts-regexp-both x))
9018 (org-time-string-to-time (match-string 0 x))))
9019 ((string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" x)
9020 (org-hh:mm-string-to-minutes x))
9022 comparefun (if (= dcst sorting-type) '< '>)))
9023 (t (error "Invalid sorting type `%c'" sorting-type)))
9025 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
9027 (lambda (a b) (funcall comparefun (car a) (car b))))))
9030 ;;; The orgstruct minor mode
9032 ;; Define a minor mode which can be used in other modes in order to
9033 ;; integrate the org-mode structure editing commands.
9035 ;; This is really a hack, because the org-mode structure commands use
9036 ;; keys which normally belong to the major mode. Here is how it
9037 ;; works: The minor mode defines all the keys necessary to operate the
9038 ;; structure commands, but wraps the commands into a function which
9039 ;; tests if the cursor is currently at a headline or a plain list
9040 ;; item. If that is the case, the structure command is used,
9041 ;; temporarily setting many Org-mode variables like regular
9042 ;; expressions for filling etc. However, when any of those keys is
9043 ;; used at a different location, function uses `key-binding' to look
9044 ;; up if the key has an associated command in another currently active
9045 ;; keymap (minor modes, major mode, global), and executes that
9046 ;; command. There might be problems if any of the keys is otherwise
9047 ;; used as a prefix key.
9049 (defcustom orgstruct-heading-prefix-regexp ""
9050 "Regexp that matches the custom prefix of Org headlines in
9051 orgstruct(++)-mode."
9054 :package-version '(Org . "8.3")
9056 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
9058 (defcustom orgstruct-setup-hook nil
9059 "Hook run after orgstruct-mode-map is filled."
9062 :package-version '(Org . "8.0")
9065 (defvar orgstruct-initialized nil)
9067 (defvar org-local-vars nil
9068 "List of local variables, for use by `orgstruct-mode'.")
9071 (define-minor-mode orgstruct-mode
9072 "Toggle the minor mode `orgstruct-mode'.
9073 This mode is for using Org-mode structure commands in other
9074 modes. The following keys behave as if Org-mode were active, if
9075 the cursor is on a headline, or on a plain list item (both as
9076 defined by Org-mode)."
9077 nil " OrgStruct" (make-sparse-keymap)
9078 (funcall (if orgstruct-mode
9079 'add-to-invisibility-spec
9080 'remove-from-invisibility-spec)
9082 (when orgstruct-mode
9083 (org-load-modules-maybe)
9084 (unless orgstruct-initialized
9086 (setq orgstruct-initialized t))))
9089 (defun turn-on-orgstruct ()
9090 "Unconditionally turn on `orgstruct-mode'."
9093 (defvar org-fb-vars nil)
9094 (make-variable-buffer-local 'org-fb-vars)
9095 (defun orgstruct++-mode (&optional arg)
9096 "Toggle `orgstruct-mode', the enhanced version of it.
9097 In addition to setting orgstruct-mode, this also exports all
9098 indentation and autofilling variables from org-mode into the
9099 buffer. It will also recognize item context in multiline items."
9101 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
9103 (progn (orgstruct-mode -1)
9105 (org-set-local (car v)
9106 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
9109 (setq org-fb-vars nil)
9110 (unless org-local-vars
9111 (setq org-local-vars (org-get-local-variables)))
9116 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
9117 (symbol-name (car x)))
9118 (setq var (car x) val (nth 1 x))
9119 (push (list var `(quote ,(eval var))) org-fb-vars)
9120 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
9122 (org-set-local 'orgstruct-is-++ t))))
9124 (defvar orgstruct-is-++ nil
9125 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9126 (make-variable-buffer-local 'orgstruct-is-++)
9129 (defun turn-on-orgstruct++ ()
9130 "Unconditionally turn on `orgstruct++-mode'."
9131 (orgstruct++-mode 1))
9133 (defun orgstruct-error ()
9134 "Error when there is no default binding for a structure key."
9136 (funcall (if (fboundp 'user-error)
9139 "This key has no function outside structure elements"))
9141 (defun orgstruct-setup ()
9142 "Setup orgstruct keymap."
9143 (dolist (cell '((org-demote . t)
9147 (org-shiftmetaleft . t)
9148 (org-shiftmetaright . t)
9149 org-backward-element
9150 org-backward-heading-same-level
9155 org-forward-heading-same-level
9157 org-insert-heading-respect-content
9158 org-kill-note-or-show-branches
9163 org-narrow-to-subtree
9178 outline-next-visible-heading
9179 outline-previous-visible-heading
9183 (let ((f (or (car-safe cell) cell))
9184 (disable-when-heading-prefix (cdr-safe cell)))
9186 (let ((new-bindings))
9187 (dolist (binding (nconc (where-is-internal f org-mode-map)
9188 (where-is-internal f outline-mode-map)))
9189 (push binding new-bindings)
9190 ;; TODO use local-function-key-map
9191 (dolist (rep '(("<tab>" . "TAB")
9192 ("<return>" . "RET")
9193 ("<escape>" . "ESC")
9194 ("<delete>" . "DEL")))
9195 (setq binding (read-kbd-macro
9196 (let ((case-fold-search))
9197 (replace-regexp-in-string
9198 (regexp-quote (cdr rep))
9200 (key-description binding)))))
9201 (pushnew binding new-bindings :test 'equal)))
9202 (dolist (binding new-bindings)
9203 (let ((key (lookup-key orgstruct-mode-map binding)))
9204 (when (or (not key) (numberp key))
9206 (org-defkey orgstruct-mode-map
9208 (orgstruct-make-binding
9209 f binding disable-when-heading-prefix))))))))))
9210 (run-hooks 'orgstruct-setup-hook))
9212 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9213 "Create a function for binding in the structure minor mode.
9214 FUN is the command to call inside a table. KEY is the key that
9215 should be checked in for a command to execute outside of tables.
9216 Non-nil `disable-when-heading-prefix' means to disable the command
9217 if `orgstruct-heading-prefix-regexp' is not empty."
9218 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9221 (while (fboundp (intern nname))
9222 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9223 (setq name (intern nname)))
9225 (let ((bindings '((org-heading-regexp
9227 orgstruct-heading-prefix-regexp
9228 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9230 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9231 (org-outline-regexp-bol
9232 (concat "^" org-outline-regexp))
9233 (outline-regexp org-outline-regexp)
9234 (outline-heading-end-regexp "\n")
9235 (outline-level 'org-outline-level)
9236 (outline-heading-alist))))
9238 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9239 "Outside of structure, run the binding of `"
9240 (key-description key) "'."
9241 (when disable-when-heading-prefix
9243 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9244 "back to the default binding due to limitations of Org's implementation of\n"
9245 "`" (symbol-name fun) "'.")))
9248 ,(and disable-when-heading-prefix
9249 '(not (string= orgstruct-heading-prefix-regexp ""))))
9254 (org-context-p 'headline 'item
9256 '(org-insert-heading
9257 org-insert-heading-respect-content
9259 '(when orgstruct-is-++
9262 (let* ((orgstruct-mode)
9264 (loop with key = ,key
9267 ("<\\([^>]*\\)tab>" . "\\1TAB")
9268 ("<\\([^>]*\\)return>" . "\\1RET")
9269 ("<\\([^>]*\\)escape>" . "\\1ESC")
9270 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9273 (setq key (read-kbd-macro
9274 (let ((case-fold-search))
9275 (replace-regexp-in-string
9278 (key-description key))))))
9279 thereis (key-binding key))))
9280 (if (keymapp binding)
9281 (org-set-transient-map binding)
9282 (let ((func (or binding
9284 'orgstruct-error))))
9286 (call-interactively func)))))
9287 (org-run-like-in-org-mode
9291 (call-interactively ',fun)))))))))
9294 (defun org-contextualize-keys (alist contexts)
9295 "Return valid elements in ALIST depending on CONTEXTS.
9297 `org-agenda-custom-commands' or `org-capture-templates' are the
9298 values used for ALIST, and `org-agenda-custom-commands-contexts'
9299 or `org-capture-templates-contexts' are the associated contexts
9302 ;; normalize contexts
9304 (lambda(c) (cond ((listp (cadr c))
9305 (list (car c) (car c) (cadr c)))
9306 ((string= "" (cadr c))
9307 (list (car c) (car c) (caddr c)))
9310 ;; loop over all commands or templates
9311 (while (setq c (pop a))
9314 ((not (assoc (car c) contexts))
9316 ((and (assoc (car c) contexts)
9317 (setq vrules (org-contextualize-validate-key
9320 (when (not (equal (car vr) (cadr vr)))
9321 (setq repl vr))) vrules)
9322 (if (not repl) (push c r)
9323 (push (cadr repl) s)
9326 (cdr (or (assoc (cadr repl) alist)
9327 (error "Undefined key `%s' as contextual replacement for `%s'"
9328 (cadr repl) (car c)))))
9330 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9335 (let ((tpl (car x)))
9339 (equal y tpl)) s))) x)))
9342 (defun org-contextualize-validate-key (key contexts)
9343 "Check CONTEXTS for agenda or capture KEY."
9345 (while (setq r (pop contexts))
9349 (and (equal key (car r))
9350 (if (functionp rr) (funcall rr)
9351 (or (and (eq (car rr) 'in-file)
9353 (string-match (cdr rr) (buffer-file-name)))
9354 (and (eq (car rr) 'in-mode)
9355 (string-match (cdr rr) (symbol-name major-mode)))
9356 (and (eq (car rr) 'in-buffer)
9357 (string-match (cdr rr) (buffer-name)))
9358 (when (and (eq (car rr) 'not-in-file)
9360 (not (string-match (cdr rr) (buffer-file-name))))
9361 (when (eq (car rr) 'not-in-mode)
9362 (not (string-match (cdr rr) (symbol-name major-mode))))
9363 (when (eq (car rr) 'not-in-buffer)
9364 (not (string-match (cdr rr) (buffer-name)))))))
9367 (delete-dups (delq nil res))))
9369 (defun org-context-p (&rest contexts)
9370 "Check if local context is any of CONTEXTS.
9371 Possible values in the list of contexts are `table', `headline', and `item'."
9372 (let ((pos (point)))
9373 (goto-char (point-at-bol))
9374 (prog1 (or (and (memq 'table contexts)
9375 (looking-at "[ \t]*|"))
9376 (and (memq 'headline contexts)
9377 (looking-at org-outline-regexp))
9378 (and (memq 'item contexts)
9379 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9380 (and (memq 'item-body contexts)
9384 (defun org-get-local-variables ()
9385 "Return a list of all local variables in an Org mode buffer."
9387 (with-current-buffer (get-buffer-create "*Org tmp*")
9390 (setq varlist (buffer-local-variables)))
9391 (kill-buffer "*Org tmp*")
9398 (list (car x) (cdr x))))
9399 (if (and (not (get (car x) 'org-state))
9401 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9402 (symbol-name (car x))))
9406 (defun org-clone-local-variables (from-buffer &optional regexp)
9407 "Clone local variables from FROM-BUFFER.
9408 Optional argument REGEXP selects variables to clone."
9411 (and (symbolp (car pair))
9413 (string-match regexp (symbol-name (car pair))))
9414 (set (make-local-variable (car pair))
9416 (buffer-local-variables from-buffer)))
9419 (defun org-run-like-in-org-mode (cmd)
9420 "Run a command, pretending that the current buffer is in Org-mode.
9421 This will temporarily bind local variables that are typically bound in
9422 Org-mode to the values they have in Org-mode, and then interactively
9424 (org-load-modules-maybe)
9425 (unless org-local-vars
9426 (setq org-local-vars (org-get-local-variables)))
9428 (dolist (var org-local-vars)
9429 (when (or (not (boundp (car var)))
9430 (eq (symbol-value (car var))
9431 (default-value (car var))))
9432 (push (list (car var) `(quote ,(cadr var))) binds)))
9434 (call-interactively (quote ,cmd))))))
9436 (defun org-get-category (&optional pos force-refresh)
9437 "Get the category applying to position POS."
9439 (if force-refresh (org-refresh-category-properties))
9440 (let ((pos (or pos (point))))
9441 (or (get-text-property pos 'org-category)
9442 (progn (org-refresh-category-properties)
9443 (get-text-property pos 'org-category))))))
9445 ;;; Refresh properties
9447 (defun org-refresh-properties (dprop tprop)
9448 "Refresh buffer text properties.
9449 DPROP is the drawer property and TPROP is either the
9450 corresponding text property to set, or an alist with each element
9451 being a text property (as a symbol) and a function to apply to
9452 the value of the drawer property."
9453 (let ((case-fold-search t)
9454 (inhibit-read-only t))
9455 (org-with-silent-modifications
9459 (goto-char (point-min))
9460 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9461 (org-refresh-property tprop (org-match-string-no-properties 1))))))))
9463 (defun org-refresh-property (tprop p)
9464 "Refresh the buffer text property TPROP from the drawer property P.
9465 The refresh happens only for the current tree (not subtree)."
9467 (org-back-to-heading t)
9468 ;; tprop is a text property symbol
9471 (point) (or (outline-next-heading) (point-max)) tprop p)
9472 ;; tprop is an alist with (properties . function) elements
9476 (point-at-bol) (or (outline-next-heading) (point-max))
9478 (funcall (cdr al) p))))
9481 (defun org-refresh-category-properties ()
9482 "Refresh category text properties in the buffer."
9483 (let ((case-fold-search t)
9484 (inhibit-read-only t)
9486 ((null org-category)
9487 (if buffer-file-name
9488 (file-name-sans-extension
9489 (file-name-nondirectory buffer-file-name))
9491 ((symbolp org-category) (symbol-name org-category))
9493 beg end cat pos optionp)
9494 (org-with-silent-modifications
9498 (goto-char (point-min))
9499 (put-text-property (point) (point-max) 'org-category def-cat)
9500 (while (re-search-forward
9501 "^[ \t]*\\(\\(?:#\\+\\|:\\)CATEGORY:\\)\\(.*\\)" nil t)
9502 (setq pos (match-end 0)
9503 optionp (equal (char-after (match-beginning 0)) ?#)
9504 cat (org-trim (match-string 2)))
9506 (setq beg (point-at-bol) end (point-max))
9507 (org-back-to-heading t)
9508 (setq beg (point) end (org-end-of-subtree t t)))
9509 (put-text-property beg end 'org-category cat)
9510 (goto-char pos)))))))
9512 (defun org-refresh-stats-properties ()
9513 "Refresh stats text properties in the buffer."
9515 (org-with-silent-modifications
9519 (goto-char (point-min))
9520 (while (re-search-forward
9521 (concat org-outline-regexp-bol ".*"
9522 "\\(?:\\[\\([0-9]+\\)%\\|\\([0-9]+\\)/\\([0-9]+\\)\\]\\)")
9524 (setq stats (cond ((equal (match-string 3) "0") 0)
9526 (/ (* (string-to-number (match-string 2)) 100)
9527 (string-to-number (match-string 3))))
9528 (t (string-to-number (match-string 1)))))
9529 (org-back-to-heading t)
9530 (put-text-property (point) (progn (org-end-of-subtree t t) (point))
9531 'org-stats stats)))))))
9533 (defun org-refresh-effort-properties ()
9534 "Refresh effort properties"
9535 (org-refresh-properties
9537 '((effort . identity)
9538 (effort-minutes . org-duration-string-to-minutes))))
9542 ;;; Link abbreviations
9544 (defun org-link-expand-abbrev (link)
9545 "Apply replacements as defined in `org-link-abbrev-alist'."
9546 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9547 (let* ((key (match-string 1 link))
9548 (as (or (assoc key org-link-abbrev-alist-local)
9549 (assoc key org-link-abbrev-alist)))
9550 (tag (and (match-end 2) (match-string 3 link)))
9556 ((symbolp rpl) (funcall rpl tag))
9557 ((string-match "%(\\([^)]+\\))" rpl)
9560 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9561 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9562 ((string-match "%h" rpl)
9563 (replace-match (url-hexify-string (or tag "")) t t rpl))
9564 (t (concat rpl tag)))))
9567 ;;; Storing and inserting links
9569 (defvar org-insert-link-history nil
9570 "Minibuffer history for links inserted with `org-insert-link'.")
9572 (defvar org-stored-links nil
9573 "Contains the links stored with `org-store-link'.")
9575 (defvar org-store-link-plist nil
9576 "Plist with info about the most recently link created with `org-store-link'.")
9578 (defvar org-link-protocols nil
9579 "Link protocols added to Org-mode using `org-add-link-type'.")
9581 (defvar org-store-link-functions nil
9582 "List of functions that are called to create and store a link.
9583 Each function will be called in turn until one returns a non-nil
9584 value. Each function should check if it is responsible for creating
9585 this link (for example by looking at the major mode).
9586 If not, it must exit and return nil.
9587 If yes, it should return a non-nil value after a calling
9588 `org-store-link-props' with a list of properties and values.
9589 Special properties are:
9591 :type The link prefix, like \"http\". This must be given.
9592 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9593 This is obligatory as well.
9594 :description Optional default description for the second pair
9595 of brackets in an Org-mode link. The user can still change
9596 this when inserting this link into an Org-mode buffer.
9598 In addition to these, any additional properties can be specified
9599 and then used in capture templates.")
9601 (defun org-add-link-type (type &optional follow export)
9602 "Add TYPE to the list of `org-link-types'.
9603 Re-compute all regular expressions depending on `org-link-types'
9605 FOLLOW and EXPORT are two functions.
9607 FOLLOW should take the link path as the single argument and do whatever
9608 is necessary to follow the link, for example find a file or display
9611 EXPORT should format the link path for export to one of the export formats.
9612 It should be a function accepting three arguments:
9614 path the path of the link, the text after the prefix (like \"http:\")
9615 desc the description of the link, if any, or a description added by
9616 org-export-normalize-links if there is none
9617 format the export format, a symbol like `html' or `latex' or `ascii'..
9619 The function may use the FORMAT information to return different values
9620 depending on the format. The return value will be put literally into
9621 the exported file. If the return value is nil, this means Org should
9622 do what it normally does with links which do not have EXPORT defined.
9624 Org-mode has a built-in default for exporting links. If you are happy with
9625 this default, there is no need to define an export function for the link
9626 type. For a simple example of an export function, see `org-bbdb.el'."
9627 (add-to-list 'org-link-types type t)
9628 (org-make-link-regexps)
9629 (if (assoc type org-link-protocols)
9630 (setcdr (assoc type org-link-protocols) (list follow export))
9631 (push (list type follow export) org-link-protocols)))
9633 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9634 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9637 (defun org-store-link (arg)
9638 "\\<org-mode-map>Store an org-link to the current location.
9639 This link is added to `org-stored-links' and can later be inserted
9640 into an org-buffer with \\[org-insert-link].
9642 For some link types, a prefix arg is interpreted.
9643 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9644 For file links, arg negates `org-context-in-file-links'.
9646 A double prefix arg force skipping storing functions that are not
9649 A triple prefix arg force storing a link for each line in the
9652 (org-load-modules-maybe)
9653 (if (and (equal arg '(64)) (org-region-active-p))
9655 (let ((end (region-end)))
9656 (goto-char (region-beginning))
9658 (while (< (point-at-eol) end)
9659 (move-end-of-line 1) (activate-mark)
9660 (let (current-prefix-arg)
9661 (call-interactively 'org-store-link))
9662 (move-beginning-of-line 2)
9663 (set-mark (point)))))
9664 (org-with-limited-levels
9665 (setq org-store-link-plist nil)
9666 (let (link cpltxt desc description search
9667 txt custom-id agenda-link sfuns sfunsn)
9670 ;; Store a link using an external link type
9671 ((and (not (equal arg '(16)))
9674 nil (mapcar (lambda (f)
9675 (let (fs) (if (funcall f) (push f fs))))
9676 org-store-link-functions))
9677 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9678 (or (and (cdr sfuns)
9681 "Which function for creating the link? "
9682 sfunsn nil t (car sfunsn)))))
9683 (funcall (caar sfuns)))
9684 (setq link (plist-get org-store-link-plist :link)
9685 desc (or (plist-get org-store-link-plist
9686 :description) link))))
9688 ;; Store a link from a source code buffer
9689 ((org-src-edit-buffer-p)
9691 (while (or (not label)
9695 (goto-char (point-min))
9697 (regexp-quote (format org-coderef-label-format label))
9699 (when label (message "Label exists already") (sit-for 2))
9700 (setq label (read-string "Code line label: " label)))
9702 (setq link (format org-coderef-label-format label))
9703 (setq gc (- 79 (length link)))
9704 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9706 (setq link (concat "(" label ")") desc nil)))
9708 ;; We are in the agenda, link to referenced location
9709 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9710 (let ((m (or (get-text-property (point) 'org-hd-marker)
9711 (get-text-property (point) 'org-marker))))
9713 (org-with-point-at m
9715 (if (org-called-interactively-p 'any)
9716 (call-interactively 'org-store-link)
9717 (org-store-link nil)))))))
9719 ((eq major-mode 'calendar-mode)
9720 (let ((cd (calendar-cursor-to-date)))
9723 (car org-time-stamp-formats)
9725 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9727 (org-store-link-props :type "calendar" :date cd)))
9729 ((eq major-mode 'help-mode)
9730 (setq link (concat "help:" (save-excursion
9731 (goto-char (point-min))
9732 (looking-at "^[^ ]+")
9734 (org-store-link-props :type "help"))
9736 ((eq major-mode 'w3-mode)
9737 (setq cpltxt (if (and (buffer-name)
9738 (not (string-match "Untitled" (buffer-name))))
9741 link (url-view-url t))
9742 (org-store-link-props :type "w3" :url (url-view-url t)))
9744 ((eq major-mode 'image-mode)
9745 (setq cpltxt (concat "file:"
9746 (abbreviate-file-name buffer-file-name))
9748 (org-store-link-props :type "image" :file buffer-file-name))
9750 ;; In dired, store a link to the file of the current line
9751 ((derived-mode-p 'dired-mode)
9752 (let ((file (dired-get-filename nil t)))
9754 (abbreviate-file-name
9755 (expand-file-name (dired-get-filename nil t)))
9756 ;; otherwise, no file so use current directory.
9758 (setq cpltxt (concat "file:" file)
9761 ((setq search (run-hook-with-args-until-success
9762 'org-create-file-search-functions))
9763 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9765 (setq cpltxt (or description link)))
9767 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9768 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9770 ;; Store a link using the target at point
9771 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9774 (abbreviate-file-name
9775 (buffer-file-name (buffer-base-buffer)))
9776 "::" (match-string 1))
9778 ((and (featurep 'org-id)
9779 (or (eq org-id-link-to-org-use-id t)
9780 (and (org-called-interactively-p 'any)
9781 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9782 (and (eq org-id-link-to-org-use-id
9783 'create-if-interactive-and-no-custom-id)
9785 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9786 ;; Store a link using the ID at point
9787 (setq link (condition-case nil
9788 (prog1 (org-id-store-link)
9789 (setq desc (or (plist-get org-store-link-plist
9793 ;; Probably before first headline, link only to file
9795 (abbreviate-file-name
9796 (buffer-file-name (buffer-base-buffer))))))))
9798 ;; Just link to current headline
9799 (setq cpltxt (concat "file:"
9800 (abbreviate-file-name
9801 (buffer-file-name (buffer-base-buffer)))))
9802 ;; Add a context search string
9803 (when (org-xor org-context-in-file-links arg)
9804 (let* ((ee (org-element-at-point))
9805 (et (org-element-type ee))
9806 (ev (plist-get (cadr ee) :value))
9807 (ek (plist-get (cadr ee) :key))
9808 (eok (and (stringp ek) (string-match "name" ek))))
9810 ((org-at-heading-p) nil)
9811 ((and (eq et 'keyword) eok) ev)
9812 ((org-region-active-p)
9813 (buffer-substring (region-beginning) (region-end)))))
9814 (when (or (null txt) (string-match "\\S-" txt))
9818 (org-make-org-heading-search-string txt)
9820 desc (or (and (eq et 'keyword) eok ev)
9821 (nth 4 (ignore-errors (org-heading-components)))
9823 (if (string-match "::\\'" cpltxt)
9824 (setq cpltxt (substring cpltxt 0 -2)))
9825 (setq link cpltxt))))
9827 ((buffer-file-name (buffer-base-buffer))
9828 ;; Just link to this file here.
9829 (setq cpltxt (concat "file:"
9830 (abbreviate-file-name
9831 (buffer-file-name (buffer-base-buffer)))))
9832 ;; Add a context string.
9833 (when (org-xor org-context-in-file-links arg)
9834 (setq txt (if (org-region-active-p)
9835 (buffer-substring (region-beginning) (region-end))
9836 (buffer-substring (point-at-bol) (point-at-eol))))
9837 ;; Only use search option if there is some text.
9838 (when (string-match "\\S-" txt)
9840 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9844 ((org-called-interactively-p 'interactive)
9845 (user-error "No method for storing a link from this buffer"))
9847 (t (setq link nil)))
9849 ;; We're done setting link and desc, clean up
9850 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9851 (setq link (or link cpltxt)
9852 desc (or desc cpltxt))
9853 (cond ((equal desc "NONE") (setq desc nil))
9854 ((and desc (string-match org-bracket-link-analytic-regexp desc))
9855 (let ((d0 (match-string 3 desc))
9856 (p0 (match-string 5 desc)))
9858 (replace-regexp-in-string
9859 org-bracket-link-regexp
9861 (if (equal (length (match-string 0 desc))
9862 (length desc)) "*" "")) desc)))))
9865 (if (not (and (or (org-called-interactively-p 'any)
9866 executing-kbd-macro) link))
9867 (or agenda-link (and link (org-make-link-string link desc)))
9868 (push (list link desc) org-stored-links)
9869 (message "Stored: %s" (or desc link))
9871 (setq link (concat "file:" (abbreviate-file-name
9872 (buffer-file-name)) "::#" custom-id))
9873 (push (list link desc) org-stored-links))
9874 (car org-stored-links))))))
9876 (defun org-store-link-props (&rest plist)
9877 "Store link properties, extract names and addresses."
9879 (when (setq x (plist-get plist :from))
9880 (setq adr (mail-extract-address-components x))
9881 (setq plist (plist-put plist :fromname (car adr)))
9882 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9883 (when (setq x (plist-get plist :to))
9884 (setq adr (mail-extract-address-components x))
9885 (setq plist (plist-put plist :toname (car adr)))
9886 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9887 (let ((from (plist-get plist :from))
9888 (to (plist-get plist :to)))
9889 (when (and from to org-from-is-user-regexp)
9891 (plist-put plist :fromto
9892 (if (string-match org-from-is-user-regexp from)
9894 (concat "from %f"))))))
9895 (setq org-store-link-plist plist))
9897 (defun org-add-link-props (&rest plist)
9898 "Add these properties to the link property list."
9901 (setq key (pop plist) value (pop plist))
9902 (setq org-store-link-plist
9903 (plist-put org-store-link-plist key value)))))
9905 (defun org-email-link-description (&optional fmt)
9906 "Return the description part of an email link.
9907 This takes information from `org-store-link-plist' and formats it
9908 according to FMT (default from `org-email-link-description-format')."
9909 (setq fmt (or fmt org-email-link-description-format))
9910 (let* ((p org-store-link-plist)
9911 (to (plist-get p :toaddress))
9912 (from (plist-get p :fromaddress))
9915 (cons "%c" (plist-get p :fromto))
9916 (cons "%F" (plist-get p :from))
9917 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9918 (cons "%T" (plist-get p :to))
9919 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9920 (cons "%s" (plist-get p :subject))
9921 (cons "%d" (plist-get p :date))
9922 (cons "%m" (plist-get p :message-id)))))
9923 (when (string-match "%c" fmt)
9924 ;; Check if the user wrote this message
9925 (if (and org-from-is-user-regexp from to
9926 (save-match-data (string-match org-from-is-user-regexp from)))
9927 (setq fmt (replace-match "to %t" t t fmt))
9928 (setq fmt (replace-match "from %f" t t fmt))))
9929 (org-replace-escapes fmt table)))
9931 (defun org-make-org-heading-search-string (&optional string)
9932 "Make search string for the current headline or STRING."
9934 (and (derived-mode-p 'org-mode)
9936 (org-back-to-heading t)
9937 (org-element-property :raw-value (org-element-at-point))))))
9938 (lines org-context-in-file-links))
9939 (or string (setq s (concat "*" s))) ; Add * for headlines
9940 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9941 (when (and string (integerp lines) (> lines 0))
9942 (let ((slines (org-split-string s "\n")))
9943 (when (< lines (length slines))
9946 (reverse (nthcdr (- (length slines) lines)
9947 (reverse slines))) "\n")))))
9948 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9950 (defun org-make-link-string (link &optional description)
9951 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9952 (unless (string-match "\\S-" link)
9953 (error "Empty link"))
9954 (when (and description
9955 (stringp description)
9956 (not (string-match "\\S-" description)))
9957 (setq description nil))
9958 (when (stringp description)
9959 ;; Remove brackets from the description, they are fatal.
9960 (while (string-match "\\[" description)
9961 (setq description (replace-match "{" t t description)))
9962 (while (string-match "\\]" description)
9963 (setq description (replace-match "}" t t description))))
9964 (when (equal link description)
9965 ;; No description needed, it is identical
9966 (setq description nil))
9967 (when (and (not description)
9968 (not (string-match (org-image-file-name-regexp) link))
9969 (not (equal link (org-link-escape link))))
9970 (setq description (org-extract-attributes link)))
9972 (cond ((string-match (org-image-file-name-regexp) link) link)
9973 ((string-match org-link-types-re link)
9974 (concat (match-string 1 link)
9975 (org-link-escape (substring link (match-end 1)))))
9976 (t (org-link-escape link))))
9977 (concat "[[" link "]"
9978 (if description (concat "[" description "]") "")
9981 (defconst org-link-escape-chars
9984 "List of characters that should be escaped in a link when stored to Org.
9985 This is the list that is used for internal purposes.")
9987 (defconst org-link-escape-chars-browser
9990 "List of characters to be escaped before handing over to the browser.
9991 If you consider using this constant then you probably want to use
9992 the function `org-link-escape-browser' instead. See there why
9993 this constant is a candidate to be removed once Org drops support
9994 for Emacs 24.1 and 24.2.")
9996 (defun org-link-escape (text &optional table merge)
9997 "Return percent escaped representation of TEXT.
9998 TEXT is a string with the text to escape.
9999 Optional argument TABLE is a list with characters that should be
10000 escaped. When nil, `org-link-escape-chars' is used.
10001 If optional argument MERGE is set, merge TABLE into
10002 `org-link-escape-chars'."
10003 ;; Don't escape chars in internal links
10004 (if (string-match "^\\*[[:alnum:]]+" text)
10008 (mapc (lambda (defchr)
10009 (unless (member defchr table)
10010 (setq table (cons defchr table))))
10011 org-link-escape-chars))
10013 (setq table org-link-escape-chars)))
10016 (if (or (member char table)
10017 (and (or (< char 32) (= char ?\%) (> char 126))
10019 (mapconcat (lambda (sequence-element)
10020 (format "%%%.2X" sequence-element))
10021 (or (encode-coding-char char 'utf-8)
10022 (error "Unable to percent escape character: %s"
10023 (char-to-string char))) "")
10024 (char-to-string char))) text "")))
10026 (defun org-link-escape-browser (text)
10027 "Escape some characters before handing over to the browser.
10028 This function is a candidate to be removed together with the
10029 constant `org-link-escape-chars-browser' once Org drops support
10030 for Emacs 24.1 and 24.2. All calls to this function will have to
10031 be replaced with `url-encode-url' which is available since Emacs
10033 ;; Example with the Org link
10034 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10035 ;; to open the browser with +subject:"Release 8.2" filled into the
10036 ;; query field: In this case the variable TEXT contains the
10037 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
10038 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
10039 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
10040 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
10041 (if (fboundp 'url-encode-url)
10042 (url-encode-url text)
10043 (if (org-string-match-p
10044 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
10046 (org-link-escape text org-link-escape-chars-browser)
10049 (defun org-link-unescape (str)
10050 "Unhex hexified Unicode strings as returned from the JavaScript function
10051 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
10052 (unless (and (null str) (string= "" str))
10053 (let ((pos 0) (case-fold-search t) unhexed)
10054 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
10055 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
10056 (setq str (replace-match unhexed t t str))
10057 (setq pos (+ pos (length unhexed))))))
10060 (defun org-link-unescape-compound (hex)
10061 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
10062 Note: this function also decodes single byte encodings like
10063 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
10065 (let* ((bytes (cdr (split-string hex "%")))
10070 (let* ((val (string-to-number (pop bytes) 16))
10074 ((>= val 252) (cons 6 252))
10075 ((>= val 248) (cons 5 248))
10076 ((>= val 240) (cons 4 240))
10077 ((>= val 224) (cons 3 224))
10078 ((>= val 192) (cons 2 192))
10081 (if (>= val 192) (setq eat (car shift-xor)))
10082 (setq val (logxor val (cdr shift-xor)))
10083 (setq sum (+ (lsh sum (car shift-xor)) val))
10084 (if (> eat 0) (setq eat (- eat 1)))
10086 ((= 0 eat) ;multi byte
10087 (setq ret (concat ret (org-char-to-string sum)))
10089 ((not bytes) ; single byte(s)
10090 (setq ret (org-link-unescape-single-byte-sequence hex))))))
10093 (defun org-link-unescape-single-byte-sequence (hex)
10094 "Unhexify hex-encoded single byte character sequences."
10095 (mapconcat (lambda (byte)
10096 (char-to-string (string-to-number byte 16)))
10097 (cdr (split-string hex "%")) ""))
10099 (defun org-xor (a b)
10103 (defun org-fixup-message-id-for-http (s)
10104 "Replace special characters in a message id, so it can be used in an http query."
10105 (when (string-match "%" s)
10106 (setq s (mapconcat (lambda (c)
10109 (char-to-string c)))
10111 (while (string-match "<" s)
10112 (setq s (replace-match "%3C" t t s)))
10113 (while (string-match ">" s)
10114 (setq s (replace-match "%3E" t t s)))
10115 (while (string-match "@" s)
10116 (setq s (replace-match "%40" t t s)))
10119 (defun org-link-prettify (link)
10120 "Return a human-readable representation of LINK.
10121 The car of LINK must be a raw link.
10122 The cdr of LINK must be either a link description or nil."
10123 (let ((desc (or (cadr link) "<no description>")))
10124 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
10125 "<" (car link) ">")))
10128 (defun org-insert-link-global ()
10129 "Insert a link like Org-mode does.
10130 This command can be called in any mode to insert a link in Org-mode syntax."
10132 (org-load-modules-maybe)
10133 (org-run-like-in-org-mode 'org-insert-link))
10135 (defun org-insert-all-links (arg &optional pre post)
10136 "Insert all links in `org-stored-links'.
10137 When a universal prefix, do not delete the links from `org-stored-links'.
10138 When `ARG' is a number, insert the last N link(s).
10139 `PRE' and `POST' are optional arguments to define a string to
10140 prepend or to append."
10142 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
10143 (links (copy-seq org-stored-links))
10145 (po (or post "\n"))
10147 (if (null org-stored-links)
10148 (message "No link to insert")
10149 (while (and (or (listp arg) (>= arg cnt))
10150 (setq l (if (listp arg)
10152 (pop org-stored-links))))
10153 (setq cnt (1+ cnt))
10155 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
10158 (defun org-insert-last-stored-link (arg)
10159 "Insert the last link stored in `org-stored-links'."
10161 (org-insert-all-links arg "" "\n"))
10163 (defun org-link-fontify-links-to-this-file ()
10164 "Fontify links to the current file in `org-stored-links'."
10165 (let ((f (buffer-file-name)) a b)
10166 (setq a (mapcar (lambda(l)
10167 (let ((ll (car l)))
10168 (when (and (string-match "^file:\\(.+\\)::" ll)
10169 (equal f (expand-file-name (match-string 1 ll))))
10172 (when (featurep 'org-id)
10173 (setq b (mapcar (lambda(l)
10174 (let ((ll (car l)))
10175 (when (and (string-match "^id:\\(.+\\)$" ll)
10176 (equal f (expand-file-name
10177 (or (org-id-find-id-file
10178 (match-string 1 ll)) ""))))
10180 org-stored-links)))
10182 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10183 (delq nil (append a b)))))
10185 (defvar org-link-links-in-this-file nil)
10186 (defun org-insert-link (&optional complete-file link-location default-description)
10187 "Insert a link. At the prompt, enter the link.
10189 Completion can be used to insert any of the link protocol prefixes like
10190 http or ftp in use.
10192 The history can be used to select a link previously stored with
10193 `org-store-link'. When the empty string is entered (i.e. if you just
10194 press RET at the prompt), the link defaults to the most recently
10195 stored link. As SPC triggers completion in the minibuffer, you need to
10196 use M-SPC or C-q SPC to force the insertion of a space character.
10198 You will also be prompted for a description, and if one is given, it will
10199 be displayed in the buffer instead of the link.
10201 If there is already a link at point, this command will allow you to edit link
10202 and description parts.
10204 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10205 be selected using completion. The path to the file will be relative to the
10206 current directory if the file is in the current directory or a subdirectory.
10207 Otherwise, the link will be the absolute path as completed in the minibuffer
10208 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10209 option `org-link-file-path-type'.
10211 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10212 the current directory or below.
10214 With three \\[universal-argument] prefixes, negate the meaning of
10215 `org-keep-stored-link-after-insertion'.
10217 If `org-make-link-description-function' is non-nil, this function will be
10218 called with the link target, and the result will be the default
10221 If the LINK-LOCATION parameter is non-nil, this value will be
10222 used as the link location instead of reading one interactively.
10224 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10225 be used as the default description."
10227 (let* ((wcf (current-window-configuration))
10228 (origbuf (current-buffer))
10229 (region (if (org-region-active-p)
10230 (buffer-substring (region-beginning) (region-end))))
10231 (remove (and region (list (region-beginning) (region-end))))
10233 tmphist ; byte-compile incorrectly complains about this
10234 (link link-location)
10235 (abbrevs org-link-abbrev-alist-local)
10236 entry file all-prefixes auto-desc)
10238 (link-location) ; specified by arg, just use it.
10239 ((org-in-regexp org-bracket-link-regexp 1)
10240 ;; We do have a link at point, and we are going to edit it.
10241 (setq remove (list (match-beginning 0) (match-end 0)))
10242 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10243 (setq link (read-string "Link: "
10245 (org-match-string-no-properties 1)))))
10246 ((or (org-in-regexp org-angle-link-re)
10247 (org-in-regexp org-plain-link-re))
10248 ;; Convert to bracket link
10249 (setq remove (list (match-beginning 0) (match-end 0))
10250 link (read-string "Link: "
10251 (org-remove-angle-brackets (match-string 0)))))
10252 ((member complete-file '((4) (16)))
10253 ;; Completing read for file names.
10254 (setq link (org-file-complete-link complete-file)))
10256 ;; Read link, with completion for stored links.
10257 (org-link-fontify-links-to-this-file)
10258 (org-switch-to-buffer-other-window "*Org Links*")
10259 (with-current-buffer "*Org Links*"
10261 (insert "Insert a link.
10262 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10263 (when org-stored-links
10264 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10265 (insert (mapconcat 'org-link-prettify
10266 (reverse org-stored-links) "\n")))
10267 (goto-char (point-min)))
10268 (let ((cw (selected-window)))
10269 (select-window (get-buffer-window "*Org Links*" 'visible))
10270 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10271 (unless (pos-visible-in-window-p (point-max))
10272 (org-fit-window-to-buffer))
10273 (and (window-live-p cw) (select-window cw)))
10274 ;; Fake a link history, containing the stored links.
10275 (setq tmphist (append (mapcar 'car org-stored-links)
10276 org-insert-link-history))
10277 (setq all-prefixes (append (mapcar 'car abbrevs)
10278 (mapcar 'car org-link-abbrev-alist)
10283 (org-completing-read
10286 (mapcar (lambda (x) (concat x ":"))
10288 (mapcar 'car org-stored-links))
10291 (caar org-stored-links)))
10292 (if (not (string-match "\\S-" link))
10293 (user-error "No link selected"))
10295 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10297 (if (or (member link all-prefixes)
10298 (and (equal ":" (substring link -1))
10299 (member (substring link 0 -1) all-prefixes)
10300 (setq link (substring link 0 -1))))
10301 (setq link (with-current-buffer origbuf
10302 (org-link-try-special-completion link)))))
10303 (set-window-configuration wcf)
10304 (kill-buffer "*Org Links*"))
10305 (setq entry (assoc link org-stored-links))
10306 (or entry (push link org-insert-link-history))
10307 (setq desc (or desc (nth 1 entry)))))
10309 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10310 (not org-keep-stored-link-after-insertion))
10311 (setq org-stored-links (delq (assoc link org-stored-links)
10312 org-stored-links)))
10314 (if (and (string-match org-plain-link-re link)
10315 (not (string-match org-ts-regexp link)))
10316 ;; URL-like link, normalize the use of angular brackets.
10317 (setq link (org-remove-angle-brackets link)))
10319 ;; Check if we are linking to the current file with a search
10320 ;; option If yes, simplify the link by using only the search
10322 (when (and buffer-file-name
10323 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10324 (let* ((path (match-string 1 link))
10325 (case-fold-search nil)
10326 (search (match-string 2 link)))
10328 (if (equal (file-truename buffer-file-name) (file-truename path))
10329 ;; We are linking to this same file, with a search option
10330 (setq link search)))))
10332 ;; Check if we can/should use a relative path. If yes, simplify the link
10333 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10334 (let* ((type (match-string 1 link))
10335 (path (match-string 2 link))
10337 (case-fold-search nil))
10339 ((or (eq org-link-file-path-type 'absolute)
10340 (equal complete-file '(16)))
10341 (setq path (abbreviate-file-name (expand-file-name path))))
10342 ((eq org-link-file-path-type 'noabbrev)
10343 (setq path (expand-file-name path)))
10344 ((eq org-link-file-path-type 'relative)
10345 (setq path (file-relative-name path)))
10348 (if (string-match (concat "^" (regexp-quote
10350 (file-name-as-directory
10351 default-directory))))
10352 (expand-file-name path))
10353 ;; We are linking a file with relative path name.
10354 (setq path (substring (expand-file-name path)
10356 (setq path (abbreviate-file-name (expand-file-name path)))))))
10357 (setq link (concat type path))
10358 (if (equal desc origpath)
10359 (setq desc path))))
10361 (if org-make-link-description-function
10363 (or (condition-case nil
10364 (funcall org-make-link-description-function link desc)
10365 (error (progn (message "Can't get link description from `%s'"
10366 (symbol-name org-make-link-description-function))
10368 (read-string "Description: " default-description)))
10369 (if default-description (setq desc default-description)
10370 (setq desc (or (and auto-desc desc)
10371 (read-string "Description: " desc)))))
10373 (unless (string-match "\\S-" desc) (setq desc nil))
10374 (if remove (apply 'delete-region remove))
10375 (insert (org-make-link-string link desc))))
10377 (defun org-link-try-special-completion (type)
10378 "If there is completion support for link type TYPE, offer it."
10379 (let ((fun (intern (concat "org-" type "-complete-link"))))
10380 (if (functionp fun)
10382 (read-string "Link (no completion support): " (concat type ":")))))
10384 (defun org-file-complete-link (&optional arg)
10385 "Create a file link using completion."
10387 (setq file (org-iread-file-name "File: "))
10388 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10389 (pwd1 (file-name-as-directory (abbreviate-file-name
10390 (expand-file-name ".")))))
10395 (abbreviate-file-name (expand-file-name file)))))
10396 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10397 (setq link (concat "file:" (match-string 1 file))))
10398 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10399 (expand-file-name file))
10401 "file:" (match-string 1 (expand-file-name file)))))
10402 (t (setq link (concat "file:" file)))))
10405 (defun org-iread-file-name (&rest args)
10406 "Read-file-name using `ido-mode' speedup if available.
10407 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10408 See `read-file-name' for a description of parameters."
10409 (org-without-partial-completion
10410 (if (and org-completion-use-ido
10411 (fboundp 'ido-read-file-name)
10412 (boundp 'ido-mode) ido-mode
10413 (listp (second args)))
10414 (let ((ido-enter-matching-directory nil))
10415 (apply 'ido-read-file-name args))
10416 (apply 'read-file-name args))))
10418 (defun org-completing-read (&rest args)
10419 "Completing-read with SPACE being a normal character."
10420 (let ((enable-recursive-minibuffers t)
10421 (minibuffer-local-completion-map
10422 (copy-keymap minibuffer-local-completion-map)))
10423 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10424 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10425 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10426 (apply 'org-icompleting-read args)))
10428 (defun org-completing-read-no-i (&rest args)
10429 (let (org-completion-use-ido org-completion-use-iswitchb)
10430 (apply 'org-completing-read args)))
10432 (defun org-iswitchb-completing-read (prompt choices &rest args)
10433 "Use iswitch as a completing-read replacement to choose from choices.
10434 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10436 (let* ((iswitchb-use-virtual-buffers nil)
10437 (iswitchb-make-buflist-hook
10439 (setq iswitchb-temp-buflist choices))))
10440 (iswitchb-read-buffer prompt)))
10442 (defun org-icompleting-read (&rest args)
10443 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10444 (org-without-partial-completion
10445 (if (and org-completion-use-ido
10446 (fboundp 'ido-completing-read)
10447 (boundp 'ido-mode) ido-mode
10448 (listp (second args)))
10449 (let ((ido-enter-matching-directory nil))
10450 (apply 'ido-completing-read (concat (car args))
10451 (if (consp (car (nth 1 args)))
10452 (mapcar 'car (nth 1 args))
10455 (if (and org-completion-use-iswitchb
10456 (boundp 'iswitchb-mode) iswitchb-mode
10457 (listp (second args)))
10458 (apply 'org-iswitchb-completing-read (concat (car args))
10459 (if (consp (car (nth 1 args)))
10460 (mapcar 'car (nth 1 args))
10463 (apply 'completing-read args)))))
10465 (defun org-extract-attributes (s)
10466 "Extract the attributes cookie from a string and set as text property."
10467 (let (a attr (start 0) key value)
10469 (when (string-match "{{\\([^}]+\\)}}$" s)
10470 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10471 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10472 (setq key (match-string 1 a) value (match-string 2 a)
10473 start (match-end 0)
10474 attr (plist-put attr (intern key) value))))
10475 (org-add-props s nil 'org-attr attr))
10478 ;;; Opening/following a link
10480 (defvar org-link-search-failed nil)
10482 (defvar org-open-link-functions nil
10483 "Hook for functions finding a plain text link.
10484 These functions must take a single argument, the link content.
10485 They will be called for links that look like [[link text][description]]
10486 when LINK TEXT does not have a protocol like \"http:\" and does not look
10487 like a filename (e.g. \"./blue.png\").
10489 These functions will be called *before* Org attempts to resolve the
10490 link by doing text searches in the current buffer - so if you want a
10491 link \"[[target]]\" to still find \"<<target>>\", your function should
10492 handle this as a special case.
10494 When the function does handle the link, it must return a non-nil value.
10495 If it decides that it is not responsible for this link, it must return
10496 nil to indicate that that Org-mode can continue with other options
10497 like exact and fuzzy text search.")
10499 (defun org-next-link (&optional search-backward)
10500 "Move forward to the next link.
10501 If the link is in hidden text, expose it."
10503 (when (and org-link-search-failed (eq this-command last-command))
10504 (goto-char (point-min))
10505 (message "Link search wrapped back to beginning of buffer"))
10506 (setq org-link-search-failed nil)
10507 (let* ((pos (point))
10509 (a (assoc :link ct))
10510 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10511 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10512 ((looking-at org-any-link-re)
10513 ;; Don't stay stuck at link without an org-link face
10514 (forward-char (if search-backward -1 1))))
10515 (if (funcall srch-fun org-any-link-re nil t)
10517 (goto-char (match-beginning 0))
10518 (if (outline-invisible-p) (org-show-context)))
10520 (setq org-link-search-failed t)
10521 (message "No further link found"))))
10523 (defun org-previous-link ()
10524 "Move backward to the previous link.
10525 If the link is in hidden text, expose it."
10527 (funcall 'org-next-link t))
10529 (defun org-translate-link (s)
10530 "Translate a link string if a translation function has been defined."
10531 (if (and org-link-translation-function
10532 (fboundp org-link-translation-function)
10533 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10535 (setq s (funcall org-link-translation-function
10536 (match-string 1 s) (match-string 2 s)))
10537 (concat (car s) ":" (cdr s)))
10540 (defun org-translate-link-from-planner (type path)
10541 "Translate a link from Emacs Planner syntax so that Org can follow it.
10542 This is still an experimental function, your mileage may vary."
10544 ((member type '("http" "https" "news" "ftp"))
10545 ;; standard Internet links are the same.
10547 ((and (equal type "irc") (string-match "^//" path))
10548 ;; Planner has two / at the beginning of an irc link, we have 1.
10549 ;; We should have zero, actually....
10550 (setq path (substring path 1)))
10551 ((and (equal type "lisp") (string-match "^/" path))
10552 ;; Planner has a slash, we do not.
10553 (setq type "elisp" path (substring path 1)))
10554 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10555 ;; A typical message link. Planner has the id after the final slash,
10556 ;; we separate it with a hash mark
10557 (setq path (concat (match-string 1 path) "#"
10558 (org-remove-angle-brackets (match-string 2 path))))))
10561 (defun org-find-file-at-mouse (ev)
10562 "Open file link or URL at mouse."
10564 (mouse-set-point ev)
10565 (org-open-at-point 'in-emacs))
10567 (defun org-open-at-mouse (ev)
10568 "Open file link or URL at mouse.
10569 See the docstring of `org-open-file' for details."
10571 (mouse-set-point ev)
10572 (if (eq major-mode 'org-agenda-mode)
10573 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10574 (org-open-at-point))
10576 (defvar org-window-config-before-follow-link nil
10577 "The window configuration before following a link.
10578 This is saved in case the need arises to restore it.")
10580 (defvar org-open-link-marker (make-marker)
10581 "Marker pointing to the location where `org-open-at-point' was called.")
10584 (defun org-open-at-point-global ()
10585 "Follow a link like Org-mode does.
10586 This command can be called in any mode to follow a link that has
10589 (org-run-like-in-org-mode 'org-open-at-point))
10592 (defun org-open-link-from-string (s &optional arg reference-buffer)
10593 "Open a link in the string S, as if it was in Org-mode."
10594 (interactive "sLink: \nP")
10595 (let ((reference-buffer (or reference-buffer (current-buffer))))
10597 (let ((org-inhibit-startup (not reference-buffer)))
10600 (goto-char (point-min))
10601 (when reference-buffer
10602 (setq org-link-abbrev-alist-local
10603 (with-current-buffer reference-buffer
10604 org-link-abbrev-alist-local)))
10605 (org-open-at-point arg reference-buffer)))))
10607 (defvar org-open-at-point-functions nil
10608 "Hook that is run when following a link at point.
10610 Functions in this hook must return t if they identify and follow
10611 a link at point. If they don't find anything interesting at point,
10612 they must return nil.")
10614 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10615 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10616 (defun org-open-at-point (&optional arg reference-buffer)
10617 "Open link, timestamp, footnote or tags at point.
10619 When point is on a link, follow it. Normally, files will be
10620 opened by an appropriate application. If the optional prefix
10621 argument ARG is non-nil, Emacs will visit the file. With
10622 a double prefix argument, try to open outside of Emacs, in the
10623 application the system uses for this file type.
10625 When point is on a timestamp, open the agenda at the day
10628 When point is a footnote definition, move to the first reference
10629 found. If it is on a reference, move to the associated
10632 When point is on a headline, display a list of every link in the
10633 entry, so it is possible to pick one, or all, of them. If point
10634 is on a tag, call `org-tags-view' instead.
10636 When optional argument REFERENCE-BUFFER is non-nil, it should
10637 specify a buffer from where the link search should happen. This
10638 is used internally by `org-open-link-from-string'.
10640 On top of syntactically correct links, this function will open
10641 the link at point in comments or comment blocks and the first
10642 link in a property drawer line."
10644 ;; On a code block, open block's results.
10645 (unless (call-interactively 'org-babel-open-src-block-result)
10646 (org-load-modules-maybe)
10647 (move-marker org-open-link-marker (point))
10648 (setq org-window-config-before-follow-link (current-window-configuration))
10649 (org-remove-occur-highlights nil nil t)
10650 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10651 (let* ((context (org-element-context)) type value)
10652 ;; On an unsupported type, check if point is contained within
10654 (while (and (not (memq (setq type (org-element-type context))
10655 '(comment comment-block
10656 headline inlinetask link
10657 footnote-definition footnote-reference
10658 node-property timestamp)))
10659 (setq context (org-element-property :parent context))))
10660 (setq value (org-element-property :value context))
10662 ;; Blank lines at the beginning of buffer: bail out.
10663 ((not context) (user-error "No link found"))
10664 ;; Exception n°1: links in property drawers
10665 ((eq type 'node-property)
10666 (org-open-link-from-string
10667 (and (string-match org-any-link-re value)
10668 (match-string-no-properties 0 value))))
10669 ;; Exception n°2: links in comments.
10670 ((memq type '(comment comment-block))
10672 (skip-chars-forward "\\S-" (point-at-eol))
10673 (let ((string-rear (replace-regexp-in-string
10674 "^[ \t]*# [ \t]*" ""
10675 (buffer-substring (point) (line-beginning-position))))
10676 (string-front (buffer-substring (point) (line-end-position))))
10678 (let ((org-inhibit-startup t)) (org-mode))
10680 (goto-char (point-min))
10681 (when (and (search-forward string-rear nil t)
10682 (search-forward string-front (line-end-position) t))
10683 (goto-char (match-beginning 0))
10684 (org-open-at-point)
10685 (when (string= string-rear "") (forward-char)))))))
10686 ;; On a headline or an inlinetask, but not on a timestamp,
10687 ;; a link, a footnote reference or on tags.
10688 ((and (memq type '(headline inlinetask))
10690 (progn (save-excursion (beginning-of-line)
10691 (looking-at org-complex-heading-regexp))
10692 (or (not (match-beginning 5))
10693 (< (point) (match-beginning 5)))))
10694 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10696 (links-end (cdr data)))
10698 (dolist (link (if (stringp links) (list links) links))
10699 (search-forward link nil links-end)
10700 (goto-char (match-beginning 0))
10701 (org-open-at-point))
10702 (require 'org-attach)
10703 (org-attach-reveal 'if-exists))))
10704 ;; Do nothing on white spaces after an object, unless point
10705 ;; is right after it.
10708 (goto-char (org-element-property :end context))
10709 (skip-chars-backward " \t")
10711 (user-error "No link found"))
10712 ((eq type 'timestamp) (org-follow-timestamp-link))
10713 ;; On tags within a headline or an inlinetask.
10714 ((and (memq type '(headline inlinetask))
10715 (progn (save-excursion (beginning-of-line)
10716 (looking-at org-complex-heading-regexp))
10717 (and (match-beginning 5)
10718 (>= (point) (match-beginning 5)))))
10719 (org-tags-view arg (substring (match-string 5) 0 -1)))
10721 (let ((type (org-element-property :type context))
10722 (path (org-link-unescape (org-element-property :path context))))
10723 ;; Switch back to REFERENCE-BUFFER needed when called in
10724 ;; a temporary buffer through `org-open-link-from-string'.
10725 (with-current-buffer (or reference-buffer (current-buffer))
10727 ((equal type "file")
10728 (if (string-match "[*?{]" (file-name-nondirectory path))
10730 ;; Look into `org-link-protocols' in order to find
10731 ;; a DEDICATED-FUNCTION to open file. The function
10732 ;; will be applied on raw link instead of parsed
10733 ;; link due to the limitation in `org-add-link-type'
10734 ;; ("open" function called with a single argument).
10735 ;; If no such function is found, fallback to
10736 ;; `org-open-file'.
10738 ;; Note : "file+emacs" and "file+sys" types are
10739 ;; hard-coded in order to escape the previous
10741 (let* ((option (org-element-property :search-option context))
10742 (app (org-element-property :application context))
10743 (dedicated-function
10744 (nth 1 (assoc app org-link-protocols))))
10745 (if dedicated-function
10746 (funcall dedicated-function
10748 (and option (concat "::" option))))
10749 (apply 'org-open-file
10752 ((equal app "emacs") 'emacs)
10753 ((equal app "sys") 'system))
10754 (cond ((not option) nil)
10755 ((org-string-match-p "\\`[0-9]+\\'" option)
10756 (list (string-to-number option)))
10758 (org-link-unescape option)))))))))
10759 ((assoc type org-link-protocols)
10760 (funcall (nth 1 (assoc type org-link-protocols)) path))
10761 ((equal type "help")
10762 (let ((f-or-v (intern path)))
10763 (cond ((fboundp f-or-v) (describe-function f-or-v))
10764 ((boundp f-or-v) (describe-variable f-or-v))
10765 (t (error "Not a known function or variable")))))
10766 ((member type '("http" "https" "ftp" "mailto" "news"))
10767 (browse-url (org-link-escape-browser (concat type ":" path))))
10768 ((equal type "doi")
10770 (org-link-escape-browser (concat org-doi-server-url path))))
10771 ((equal type "message") (browse-url (concat type ":" path)))
10772 ((equal type "shell")
10773 (let ((buf (generate-new-buffer "*Org Shell Output*"))
10775 (if (or (and (org-string-nw-p
10776 org-confirm-shell-link-not-regexp)
10778 org-confirm-shell-link-not-regexp cmd))
10779 (not org-confirm-shell-link-function)
10780 (funcall org-confirm-shell-link-function
10781 (format "Execute \"%s\" in shell? "
10782 (org-add-props cmd nil
10783 'face 'org-warning))))
10785 (message "Executing %s" cmd)
10786 (shell-command cmd buf)
10787 (when (featurep 'midnight)
10788 (setq clean-buffer-list-kill-buffer-names
10790 clean-buffer-list-kill-buffer-names))))
10791 (user-error "Abort"))))
10792 ((equal type "elisp")
10794 (if (or (and (org-string-nw-p
10795 org-confirm-elisp-link-not-regexp)
10796 (org-string-match-p
10797 org-confirm-elisp-link-not-regexp cmd))
10798 (not org-confirm-elisp-link-function)
10799 (funcall org-confirm-elisp-link-function
10800 (format "Execute \"%s\" as elisp? "
10801 (org-add-props cmd nil
10802 'face 'org-warning))))
10803 (message "%s => %s" cmd
10804 (if (eq (string-to-char cmd) ?\()
10806 (call-interactively (read cmd))))
10807 (user-error "Abort"))))
10810 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10811 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10812 (unless (run-hook-with-args-until-success
10813 'org-open-link-functions path)
10814 (if (not arg) (org-mark-ring-push)
10815 (switch-to-buffer-other-window
10816 (org-get-buffer-for-internal-link (current-buffer))))
10817 (let ((cmd `(org-link-search
10818 ,(if (member type '("custom-id" "coderef"))
10819 (org-element-property :raw-link context)
10821 ,(cond ((equal arg '(4)) 'occur)
10822 ((equal arg '(16)) 'org-occur))
10823 ,(org-element-property :begin context))))
10824 (condition-case nil
10825 (let ((org-link-search-inhibit-query t))
10827 (error (progn (widen) (eval cmd)))))))
10828 (t (browse-url-at-point))))))
10829 ;; On a footnote reference or at a footnote definition's label.
10830 ((or (eq type 'footnote-reference)
10831 (and (eq type 'footnote-definition)
10833 ;; Do not validate action when point is on the
10834 ;; spaces right after the footnote label, in
10835 ;; order to be on par with behaviour on links.
10836 (skip-chars-forward " \t")
10838 (org-element-property :contents-begin context)))
10839 (if begin (< (point) begin)
10840 (= (org-element-property :post-affiliated context)
10841 (line-beginning-position)))))))
10842 (org-footnote-action))
10843 (t (user-error "No link found")))))
10844 (move-marker org-open-link-marker nil)
10845 (run-hook-with-args 'org-follow-link-hook)))
10847 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10848 "Offer links in the current entry and return the selected link.
10849 If there is only one link, return it.
10850 If NTH is an integer, return the NTH link found.
10851 If ZERO is a string, check also this string for a link, and if
10852 there is one, return it."
10853 (with-current-buffer buffer
10859 (in-emacs (if (integerp nth) nil nth))
10860 have-zero end links link c)
10861 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10862 (push (match-string 0 zero) links)
10863 (setq cnt (1- cnt) have-zero t))
10865 (org-back-to-heading t)
10866 (setq end (save-excursion (outline-next-heading) (point)))
10867 (while (re-search-forward org-any-link-re end t)
10868 (push (match-string 0) links))
10869 (setq links (org-uniquify (reverse links))))
10872 (message "No links"))
10873 ((equal (length links) 1)
10874 (setq link (car links)))
10875 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10876 (setq link (nth (if have-zero nth (1- nth)) links)))
10877 (t ; we have to select a link
10879 (save-window-excursion
10880 (delete-other-windows)
10881 (with-output-to-temp-buffer "*Select Link*"
10883 (if (not (string-match org-bracket-link-regexp l))
10884 (princ (format "[%c] %s\n" (incf cnt)
10885 (org-remove-angle-brackets l)))
10887 (princ (format "[%c] %s (%s)\n" (incf cnt)
10888 (match-string 3 l) (match-string 1 l)))
10889 (princ (format "[%c] %s\n" (incf cnt)
10890 (match-string 1 l))))))
10892 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10893 (message "Select link to open, RET to open all:")
10894 (setq c (read-char-exclusive))
10895 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10896 (when (equal c ?q) (user-error "Abort"))
10897 (if (equal c ?\C-m)
10899 (setq nth (- c ?0))
10900 (if have-zero (setq nth (1+ nth)))
10901 (unless (and (integerp nth) (>= (length links) nth))
10902 (user-error "Invalid link selection"))
10903 (setq link (nth (1- nth) links)))))
10904 (cons link end))))))
10906 ;; TODO: These functions are deprecated since `org-open-at-point'
10907 ;; hard-codes behaviour for "file+emacs" and "file+sys" types.
10908 (defun org-open-file-with-system (path)
10909 "Open file at PATH using the system way of opening it."
10910 (org-open-file path 'system))
10911 (defun org-open-file-with-emacs (path)
10912 "Open file at PATH in Emacs."
10913 (org-open-file path 'emacs))
10918 (defvar org-create-file-search-functions nil
10919 "List of functions to construct the right search string for a file link.
10920 These functions are called in turn with point at the location to
10921 which the link should point.
10923 A function in the hook should first test if it would like to
10924 handle this file type, for example by checking the `major-mode'
10925 or the file extension. If it decides not to handle this file, it
10926 should just return nil to give other functions a chance. If it
10927 does handle the file, it must return the search string to be used
10928 when following the link. The search string will be part of the
10929 file link, given after a double colon, and `org-open-at-point'
10930 will automatically search for it. If special measures must be
10931 taken to make the search successful, another function should be
10932 added to the companion hook `org-execute-file-search-functions',
10935 A function in this hook may also use `setq' to set the variable
10936 `description' to provide a suggestion for the descriptive text to
10937 be used for this link when it gets inserted into an Org-mode
10938 buffer with \\[org-insert-link].")
10940 (defvar org-execute-file-search-functions nil
10941 "List of functions to execute a file search triggered by a link.
10943 Functions added to this hook must accept a single argument, the
10944 search string that was part of the file link, the part after the
10945 double colon. The function must first check if it would like to
10946 handle this search, for example by checking the `major-mode' or
10947 the file extension. If it decides not to handle this search, it
10948 should just return nil to give other functions a chance. If it
10949 does handle the search, it must return a non-nil value to keep
10950 other functions from trying.
10952 Each function can access the current prefix argument through the
10953 variable `current-prefix-arg'. Note that a single prefix is used
10954 to force opening a link in Emacs, so it may be good to only use a
10955 numeric or double prefix to guide the search function.
10957 In case this is needed, a function in this hook can also restore
10958 the window configuration before `org-open-at-point' was called using:
10960 (set-window-configuration org-window-config-before-follow-link)")
10962 (defun org-link-search (s &optional type avoid-pos stealth)
10963 "Search for a link search option.
10964 If S is surrounded by forward slashes, it is interpreted as a
10965 regular expression. In org-mode files, this will create an `org-occur'
10966 sparse tree. In ordinary files, `occur' will be used to list matches.
10967 If the current buffer is in `dired-mode', grep will be used to search
10968 in all files. If AVOID-POS is given, ignore matches near that position.
10970 When optional argument STEALTH is non-nil, do not modify
10971 visibility around point, thus ignoring
10972 `org-show-hierarchy-above', `org-show-following-heading' and
10973 `org-show-siblings' variables."
10974 (let ((case-fold-search t)
10975 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10976 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10977 (append '(("") (" ") ("\t") ("\n"))
10978 org-emphasis-alist)
10981 (pre nil) (post nil)
10982 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10984 ;; First check if there are any special search functions
10985 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10986 ;; Now try the builtin stuff
10987 ((and (equal (string-to-char s0) ?#)
10990 (goto-char (point-min))
10993 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10994 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10995 (setq type 'dedicated
10996 pos (match-beginning 0))))
10997 ;; There is an exact target for this
10999 (org-back-to-heading t)))
11001 (goto-char (point-min))
11004 (concat "<<" (regexp-quote s0) ">>") nil t)
11005 (setq type 'dedicated
11006 pos (match-beginning 0))))
11007 ;; There is an exact target for this
11010 (goto-char (point-min))
11013 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
11014 (setq type 'dedicated pos (match-beginning 0))))
11015 ;; Found an element with a matching #+name affiliated keyword.
11017 ((and (string-match "^(\\(.*\\))$" s0)
11019 (goto-char (point-min))
11022 (concat "[^[]" (regexp-quote
11023 (format org-coderef-label-format
11024 (match-string 1 s0))))
11026 (setq type 'dedicated
11027 pos (1+ (match-beginning 0))))))
11028 ;; There is a coderef target for this
11030 ((string-match "^/\\(.*\\)/$" s)
11031 ;; A regular expression
11033 ((derived-mode-p 'org-mode)
11034 (org-occur (match-string 1 s)))
11035 (t (org-do-occur (match-string 1 s)))))
11036 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
11037 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
11038 (goto-char (point-min))
11040 ((let (case-fold-search)
11041 (re-search-forward (format org-complex-heading-regexp-format
11044 ;; OK, found a match
11045 (setq type 'dedicated)
11046 (goto-char (match-beginning 0)))
11047 ((and (not org-link-search-inhibit-query)
11048 (eq org-link-search-must-match-exact-headline 'query-to-create)
11049 (y-or-n-p "No match - create this as a new heading? "))
11050 (goto-char (point-max))
11051 (or (bolp) (newline))
11052 (insert "* " s "\n")
11053 (beginning-of-line 0))
11056 (error "No match"))))
11058 ;; A normal search string
11059 (when (equal (string-to-char s) ?*)
11060 ;; Anchor on headlines, post may include tags.
11061 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
11062 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
11063 s (substring s 1)))
11064 (remove-text-properties
11066 '(face nil mouse-face nil keymap nil fontified nil) s)
11067 ;; Make a series of regular expressions to find a match
11068 (setq words (org-split-string s "[ \n\r\t]+")
11070 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
11071 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
11073 re2a_ (concat "\\(" (mapconcat 'downcase words
11074 "[ \t\r\n]+") "\\)[ \t\r\n]")
11075 re2a (concat "[ \t\r\n]" re2a_)
11076 re4_ (concat "\\(" (mapconcat 'downcase words
11077 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
11078 re4 (concat "[^a-zA-Z_]" re4_)
11080 re1 (concat pre re2 post)
11081 re3 (concat pre (if pre re4_ re4) post)
11082 re5 (concat pre ".*" re4)
11083 re2 (concat pre re2)
11084 re2a (concat pre (if pre re2a_ re2a))
11085 re4 (concat pre (if pre re4_ re4))
11086 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
11087 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
11090 ((eq type 'org-occur) (org-occur reall))
11091 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
11092 (t (goto-char (point-min))
11094 (if (or (and (org-search-not-self 1 re0 nil t)
11095 (setq type 'dedicated))
11096 (org-search-not-self 1 re1 nil t)
11097 (org-search-not-self 1 re2 nil t)
11098 (org-search-not-self 1 re2a nil t)
11099 (org-search-not-self 1 re3 nil t)
11100 (org-search-not-self 1 re4 nil t)
11101 (org-search-not-self 1 re5 nil t))
11102 (goto-char (match-beginning 1))
11104 (error "No match"))))))
11105 (and (derived-mode-p 'org-mode)
11107 (org-show-context 'link-search))
11110 (defun org-search-not-self (group &rest args)
11111 "Execute `re-search-forward', but only accept matches that do not
11112 enclose the position of `org-open-link-marker'."
11113 (let ((m org-open-link-marker))
11115 (while (apply 're-search-forward args)
11116 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
11117 (goto-char (match-end group))
11118 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
11119 (> (match-beginning 0) (marker-position m))
11120 (< (match-end 0) (marker-position m)))
11122 (or (not (org-in-regexp
11123 org-bracket-link-analytic-regexp 1))
11124 (not (match-end 4)) ; no description
11125 (and (<= (match-beginning 4) (point))
11126 (>= (match-end 4) (point))))))
11127 (throw 'exit (point))))))))
11129 (defun org-get-buffer-for-internal-link (buffer)
11130 "Return a buffer to be used for displaying the link target of internal links."
11132 ((not org-display-internal-link-with-indirect-buffer)
11134 ((string-match "(Clone)$" (buffer-name buffer))
11135 (message "Buffer is already a clone, not making another one")
11136 ;; we also do not modify visibility in this case
11138 (t ; make a new indirect buffer for displaying the link
11139 (let* ((bn (buffer-name buffer))
11140 (ibn (concat bn "(Clone)"))
11141 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
11142 (with-current-buffer ib (org-overview))
11145 (defun org-do-occur (regexp &optional cleanup)
11146 "Call the Emacs command `occur'.
11147 If CLEANUP is non-nil, remove the printout of the regular expression
11148 in the *Occur* buffer. This is useful if the regex is long and not useful
11152 (let ((cwin (selected-window)) win beg end)
11153 (when (setq win (get-buffer-window "*Occur*"))
11154 (select-window win))
11155 (goto-char (point-min))
11156 (when (re-search-forward "match[a-z]+" nil t)
11157 (setq beg (match-end 0))
11158 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
11159 (setq end (1- (match-beginning 0)))))
11160 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
11161 (goto-char (point-min))
11162 (select-window cwin))))
11164 ;;; The mark ring for links jumps
11166 (defvar org-mark-ring nil
11167 "Mark ring for positions before jumps in Org-mode.")
11168 (defvar org-mark-ring-last-goto nil
11169 "Last position in the mark ring used to go back.")
11170 ;; Fill and close the ring
11171 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11172 (loop for i from 1 to org-mark-ring-length do
11173 (push (make-marker) org-mark-ring))
11174 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11177 (defun org-mark-ring-push (&optional pos buffer)
11178 "Put the current position or POS into the mark ring and rotate it."
11180 (setq pos (or pos (point)))
11181 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11182 (move-marker (car org-mark-ring)
11184 (or buffer (current-buffer)))
11186 (substitute-command-keys
11187 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11189 (defun org-mark-ring-goto (&optional n)
11190 "Jump to the previous position in the mark ring.
11191 With prefix arg N, jump back that many stored positions. When
11192 called several times in succession, walk through the entire ring.
11193 Org-mode commands jumping to a different position in the current file,
11194 or to another Org-mode file, automatically push the old position
11198 (if (eq last-command this-command)
11199 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11200 (setq p org-mark-ring))
11201 (setq org-mark-ring-last-goto p)
11203 (org-pop-to-buffer-same-window (marker-buffer m))
11205 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11207 (defun org-remove-angle-brackets (s)
11208 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11209 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11211 (defun org-add-angle-brackets (s)
11212 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11213 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11215 (defun org-remove-double-quotes (s)
11216 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11217 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11220 ;;; Following specific links
11222 (defun org-follow-timestamp-link ()
11223 "Open an agenda view for the time-stamp date/range at point."
11225 ((org-at-date-range-p t)
11226 (let ((org-agenda-start-on-weekday)
11227 (t1 (match-string 1))
11228 (t2 (match-string 2)) tt1 tt2)
11229 (setq tt1 (time-to-days (org-time-string-to-time t1))
11230 tt2 (time-to-days (org-time-string-to-time t2)))
11231 (let ((org-agenda-buffer-tmp-name
11232 (format "*Org Agenda(a:%s)"
11233 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11234 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11235 ((org-at-timestamp-p t)
11236 (let ((org-agenda-buffer-tmp-name
11237 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11238 (org-agenda-list nil (time-to-days (org-time-string-to-time
11239 (substring (match-string 1) 0 10)))
11241 (t (error "This should not happen"))))
11244 ;;; Following file links
11245 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11246 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11247 (declare-function mailcap-mime-info
11248 "mailcap" (string &optional request no-decode))
11249 (defvar org-wait nil)
11250 (defun org-open-file (path &optional in-emacs line search)
11251 "Open the file at PATH.
11252 First, this expands any special file name abbreviations. Then the
11253 configuration variable `org-file-apps' is checked if it contains an
11254 entry for this file type, and if yes, the corresponding command is launched.
11256 If no application is found, Emacs simply visits the file.
11258 With optional prefix argument IN-EMACS, Emacs will visit the file.
11259 With a double \\[universal-argument] \\[universal-argument] \
11260 prefix arg, Org tries to avoid opening in Emacs
11261 and to use an external application to visit the file.
11263 Optional LINE specifies a line to go to, optional SEARCH a string
11264 to search for. If LINE or SEARCH is given, the file will be
11265 opened in Emacs, unless an entry from org-file-apps that makes
11266 use of groups in a regexp matches.
11268 If you want to change the way frames are used when following a
11269 link, please customize `org-link-frame-setup'.
11271 If the file does not exist, an error is thrown."
11272 (let* ((file (if (equal path "")
11274 (substitute-in-file-name (expand-file-name path))))
11275 (file-apps (append org-file-apps (org-default-apps)))
11276 (apps (org-remove-if
11277 'org-file-apps-entry-match-against-dlink-p file-apps))
11278 (apps-dlink (org-remove-if-not
11279 'org-file-apps-entry-match-against-dlink-p file-apps))
11280 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11281 (dirp (if remp nil (file-directory-p file)))
11282 (file (if (and dirp org-open-directory-means-index-dot-org)
11283 (concat (file-name-as-directory file) "index.org")
11285 (a-m-a-p (assq 'auto-mode apps))
11286 (dfile (downcase file))
11287 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11288 (link (cond ((and (eq line nil)
11292 (concat file "::" (number-to-string line)))
11294 (concat file "::" search))))
11295 (dlink (downcase link))
11296 (old-buffer (current-buffer))
11298 (old-mode major-mode)
11299 ext cmd link-match-data)
11300 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11301 (setq ext (match-string 1 dfile))
11302 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11303 (setq ext (match-string 1 dfile))))
11305 ((member in-emacs '((16) system))
11306 (setq cmd (cdr (assoc 'system apps))))
11307 (in-emacs (setq cmd 'emacs))
11309 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11310 (and dirp (cdr (assoc 'directory apps)))
11311 ; first, try matching against apps-dlink
11312 ; if we get a match here, store the match data for later
11313 (let ((match (assoc-default dlink apps-dlink
11316 (progn (setq link-match-data (match-data))
11318 (progn (setq in-emacs (or in-emacs line search))
11319 nil))) ; if we have no match in apps-dlink,
11320 ; always open the file in emacs if line or search
11321 ; is given (for backwards compatibility)
11322 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11324 (cdr (assoc ext apps))
11325 (cdr (assoc t apps))))))
11326 (when (eq cmd 'system)
11327 (setq cmd (cdr (assoc 'system apps))))
11328 (when (eq cmd 'default)
11329 (setq cmd (cdr (assoc t apps))))
11330 (when (eq cmd 'mailcap)
11332 (mailcap-parse-mailcaps)
11333 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11334 (command (mailcap-mime-info mime-type)))
11335 (if (stringp command)
11337 (setq cmd 'emacs))))
11338 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11339 (not (file-exists-p file))
11340 (not org-open-non-existing-files))
11341 (user-error "No such file: %s" file))
11343 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11344 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11345 (while (string-match "['\"]%s['\"]" cmd)
11346 (setq cmd (replace-match "%s" t t cmd)))
11347 (while (string-match "%s" cmd)
11348 (setq cmd (replace-match
11350 (shell-quote-argument
11351 (convert-standard-filename file)))
11354 ;; Replace "%1", "%2" etc. in command with group matches from regex
11356 (let ((match-index 1)
11357 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11358 (set-match-data link-match-data)
11359 (while (<= match-index number-of-groups)
11360 (let ((regex (concat "%" (number-to-string match-index)))
11361 (replace-with (match-string match-index dlink)))
11362 (while (string-match regex cmd)
11363 (setq cmd (replace-match replace-with t t cmd))))
11364 (setq match-index (+ match-index 1)))))
11366 (save-window-excursion
11367 (message "Running %s...done" cmd)
11368 (start-process-shell-command cmd nil cmd)
11369 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11372 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11374 (if line (progn (org-goto-line line)
11375 (if (derived-mode-p 'org-mode)
11377 (if search (org-link-search search))))
11379 (let ((file (convert-standard-filename file)))
11381 (set-match-data link-match-data)
11383 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11384 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11385 (or (not (equal old-buffer (current-buffer)))
11386 (not (equal old-pos (point))))
11387 (org-mark-ring-push old-pos old-buffer))))
11389 (defun org-file-apps-entry-match-against-dlink-p (entry)
11390 "This function returns non-nil if `entry' uses a regular
11391 expression which should be matched against the whole link by
11394 It assumes that is the case when the entry uses a regular
11395 expression which has at least one grouping construct and the
11396 action is either a lisp form or a command string containing
11397 '%1', i.e. using at least one subexpression match as a
11399 (let ((selector (car entry))
11400 (action (cdr entry)))
11401 (if (stringp selector)
11402 (and (> (regexp-opt-depth selector) 0)
11403 (or (and (stringp action)
11404 (string-match "%[0-9]" action))
11408 (defun org-default-apps ()
11409 "Return the default applications for this operating system."
11411 ((eq system-type 'darwin)
11412 org-file-apps-defaults-macosx)
11413 ((eq system-type 'windows-nt)
11414 org-file-apps-defaults-windowsnt)
11415 (t org-file-apps-defaults-gnu)))
11417 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11418 "Convert extensions to regular expressions in the cars of LIST.
11419 Also, weed out any non-string entries, because the return value is used
11420 only for regexp matching.
11421 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11422 point to the symbol `emacs', indicating that the file should
11423 be opened in Emacs."
11426 (mapcar (lambda (x)
11427 (if (not (stringp (car x)))
11429 (if (string-match "\\W" (car x))
11431 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11434 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11436 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11437 (defun org-file-remote-p (file)
11438 "Test whether FILE specifies a location on a remote system.
11439 Return non-nil if the location is indeed remote.
11441 For example, the filename \"/user@host:/foo\" specifies a location
11442 on the system \"/user@host:\"."
11443 (cond ((fboundp 'file-remote-p)
11444 (file-remote-p file))
11445 ((fboundp 'tramp-handle-file-remote-p)
11446 (tramp-handle-file-remote-p file))
11447 ((and (boundp 'ange-ftp-name-format)
11448 (string-match (car ange-ftp-name-format) file))
11454 (defun org-get-org-file ()
11455 "Read a filename, with default directory `org-directory'."
11456 (let ((default (or org-default-notes-file remember-data-file)))
11457 (read-file-name (format "File name [%s]: " default)
11458 (file-name-as-directory org-directory)
11461 (defun org-notes-order-reversed-p ()
11462 "Check if the current file should receive notes in reversed order."
11464 ((not org-reverse-note-order) nil)
11465 ((eq t org-reverse-note-order) t)
11466 ((not (listp org-reverse-note-order)) nil)
11468 (let ((all org-reverse-note-order)
11470 (while (setq entry (pop all))
11471 (if (string-match (car entry) buffer-file-name)
11472 (throw 'exit (cdr entry))))
11475 (defvar org-refile-target-table nil
11476 "The list of refile targets, created by `org-refile'.")
11478 (defvar org-agenda-new-buffers nil
11479 "Buffers created to visit agenda files.")
11481 (defvar org-refile-cache nil
11482 "Cache for refile targets.")
11484 (defvar org-refile-markers nil
11485 "All the markers used for caching refile locations.")
11487 (defun org-refile-marker (pos)
11488 "Get a new refile marker, but only if caching is in use."
11489 (if (not org-refile-use-cache)
11491 (let ((m (make-marker)))
11492 (move-marker m pos)
11493 (push m org-refile-markers)
11496 (defun org-refile-cache-clear ()
11497 "Clear the refile cache and disable all the markers."
11498 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11499 (setq org-refile-markers nil)
11500 (setq org-refile-cache nil)
11501 (message "Refile cache has been cleared"))
11503 (defun org-refile-cache-check-set (set)
11504 "Check if all the markers in the cache still have live buffers."
11507 (while (and set (setq marker (nth 3 (pop set))))
11508 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11509 (when (and marker (null (marker-buffer marker)))
11510 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11512 (throw 'exit nil)))
11515 (defun org-refile-cache-put (set &rest identifiers)
11516 "Push the refile targets SET into the cache, under IDENTIFIERS."
11517 (let* ((key (sha1 (prin1-to-string identifiers)))
11518 (entry (assoc key org-refile-cache)))
11521 (push (cons key set) org-refile-cache))))
11523 (defun org-refile-cache-get (&rest identifiers)
11524 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11526 ((not org-refile-cache) nil)
11527 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11529 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11530 org-refile-cache))))
11531 (and set (org-refile-cache-check-set set) set)))))
11533 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11534 "Produce a table with refile targets."
11535 (let ((case-fold-search nil)
11536 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11537 (entries (or org-refile-targets '((nil . (:level . 1)))))
11538 targets tgs txt re files f desc descre fast-path-p level pos0)
11539 (message "Getting targets...")
11540 (with-current-buffer (or default-buffer (current-buffer))
11541 (while (setq entry (pop entries))
11542 (setq files (car entry) desc (cdr entry))
11543 (setq fast-path-p nil)
11545 ((null files) (setq files (list (current-buffer))))
11546 ((eq files 'org-agenda-files)
11547 (setq files (org-agenda-files 'unrestricted)))
11548 ((and (symbolp files) (fboundp files))
11549 (setq files (funcall files)))
11550 ((and (symbolp files) (boundp files))
11551 (setq files (symbol-value files))))
11552 (if (stringp files) (setq files (list files)))
11554 ((eq (car desc) :tag)
11555 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11556 ((eq (car desc) :todo)
11557 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11558 ((eq (car desc) :regexp)
11559 (setq descre (cdr desc)))
11560 ((eq (car desc) :level)
11561 (setq descre (concat "^\\*\\{" (number-to-string
11562 (if org-odd-levels-only
11563 (1- (* 2 (cdr desc)))
11566 ((eq (car desc) :maxlevel)
11567 (setq fast-path-p t)
11568 (setq descre (concat "^\\*\\{1," (number-to-string
11569 (if org-odd-levels-only
11570 (1- (* 2 (cdr desc)))
11573 (t (error "Bad refiling target description %s" desc)))
11574 (while (setq f (pop files))
11575 (with-current-buffer
11576 (if (bufferp f) f (org-get-agenda-file-buffer f))
11578 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11580 (if (bufferp f) (setq f (buffer-file-name
11581 (buffer-base-buffer f))))
11582 (setq f (and f (expand-file-name f)))
11583 (if (eq org-refile-use-outline-path 'file)
11584 (push (list (file-name-nondirectory f) f nil nil) tgs))
11588 (goto-char (point-min))
11589 (while (re-search-forward descre nil t)
11590 (goto-char (setq pos0 (point-at-bol)))
11592 (when org-refile-target-verify-function
11594 (or (funcall org-refile-target-verify-function)
11596 (when (and (looking-at org-complex-heading-regexp)
11597 (not (member (match-string 4) excluded-entries))
11599 (setq level (org-reduced-level
11600 (- (match-end 1) (match-beginning 1)))
11601 txt (org-link-display-format (match-string 4))
11602 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11603 re (format org-complex-heading-regexp-format
11604 (regexp-quote (match-string 4))))
11605 (when org-refile-use-outline-path
11606 (setq txt (mapconcat
11609 (if (eq org-refile-use-outline-path
11611 (list (file-name-nondirectory
11613 (buffer-base-buffer))))
11614 (if (eq org-refile-use-outline-path
11616 (list (buffer-file-name
11617 (buffer-base-buffer)))))
11618 (org-get-outline-path fast-path-p
11622 (push (list txt f re (org-refile-marker (point)))
11624 (when (= (point) pos0)
11625 ;; verification function has not moved point
11626 (goto-char (point-at-eol))))))))
11627 (when org-refile-use-cache
11628 (org-refile-cache-put tgs (buffer-file-name) descre))
11629 (setq targets (append tgs targets))))))
11630 (message "Getting targets...done")
11631 (nreverse targets)))
11633 (defun org-protect-slash (s)
11634 (while (string-match "/" s)
11635 (setq s (replace-match "\\" t t s)))
11638 (defvar org-olpa (make-vector 20 nil))
11640 (defun org-get-outline-path (&optional fastp level heading)
11641 "Return the outline path to the current entry, as a list.
11643 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11644 routine which makes outline path derivations for an entire file,
11645 avoiding backtracing. Refile target collection makes use of that."
11649 (error "Outline path failure, more than 19 levels"))
11650 (loop for i from level upto 19 do
11651 (aset org-olpa i nil))
11653 (delq nil (append org-olpa nil))
11654 (aset org-olpa level heading)))
11655 (let (rtn case-fold-search)
11659 (while (org-up-heading-safe)
11660 (when (looking-at org-complex-heading-regexp)
11662 (replace-regexp-in-string
11663 ;; Remove statistical/checkboxes cookies
11664 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11665 (org-match-string-no-properties 4)))
11669 (defun org-format-outline-path (path &optional width prefix separator)
11670 "Format the outline path PATH for display.
11671 WIDTH is the maximum number of characters that is available.
11672 PREFIX is a prefix to be included in the returned string,
11673 such as the file name.
11674 SEPARATOR is inserted between the different parts of the path,
11675 the default is \"/\"."
11676 (setq width (or width 79))
11677 (if prefix (setq width (- width (length prefix))))
11680 (let* ((nsteps (length path))
11681 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11682 (maxwidth (if (<= total-width width)
11683 10000 ;; everything fits
11684 ;; we need to shorten the level headings
11685 (/ (- width nsteps) nsteps)))
11686 (org-odd-levels-only nil)
11688 (total (1+ (length prefix))))
11689 (setq maxwidth (max maxwidth 10))
11691 (if prefix (or separator "/"))
11695 (if (and (= n nsteps) (< maxwidth 10000))
11696 (setq maxwidth (- total-width total)))
11697 (if (< (length h) maxwidth)
11698 (progn (setq total (+ total (length h) 1)) h)
11699 (setq h (substring h 0 (- maxwidth 2))
11700 total (+ total maxwidth 1))
11701 (if (string-match "[ \t]+\\'" h)
11702 (setq h (substring h 0 (match-beginning 0))))
11703 (setq h (concat h "..")))
11704 (org-add-props h nil 'face
11705 (nth (% (1- n) org-n-level-faces)
11708 path (or separator "/"))))))
11710 (defun org-display-outline-path (&optional file current separator just-return-string)
11711 "Display the current outline path in the echo area.
11713 If FILE is non-nil, prepend the output with the file name.
11714 If CURRENT is non-nil, append the current heading to the output.
11715 SEPARATOR is passed through to `org-format-outline-path'. It separates
11716 the different parts of the path and defaults to \"/\".
11717 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11719 (let* (case-fold-search
11720 (bfn (buffer-file-name (buffer-base-buffer)))
11721 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11723 (if current (setq path (append path
11725 (org-back-to-heading t)
11726 (if (looking-at org-complex-heading-regexp)
11727 (list (match-string 4)))))))
11729 (org-format-outline-path
11732 (and file bfn (concat (file-name-nondirectory bfn) separator))
11734 (if just-return-string
11735 (org-no-properties res)
11736 (org-unlogged-message "%s" res))))
11738 (defvar org-refile-history nil
11739 "History for refiling operations.")
11741 (defvar org-after-refile-insert-hook nil
11742 "Hook run after `org-refile' has inserted its stuff at the new location.
11743 Note that this is still *before* the stuff will be removed from
11744 the *old* location.")
11746 (defvar org-capture-last-stored-marker)
11747 (defvar org-refile-keep nil
11748 "Non-nil means `org-refile' will copy instead of refile.")
11751 "Like `org-refile', but copy."
11753 (let ((org-refile-keep t))
11754 (funcall 'org-refile nil nil nil "Copy")))
11756 (defun org-refile (&optional arg default-buffer rfloc msg)
11757 "Move the entry or entries at point to another heading.
11758 The list of target headings is compiled using the information in
11759 `org-refile-targets', which see.
11761 At the target location, the entry is filed as a subitem of the
11762 target heading. Depending on `org-reverse-note-order', the new
11763 subitem will either be the first or the last subitem.
11765 If there is an active region, all entries in that region will be
11766 refiled. However, the region must fulfill the requirement that
11767 the first heading sets the top-level of the moved text.
11769 With prefix arg ARG, the command will only visit the target
11770 location and not actually move anything.
11772 With a double prefix arg \\[universal-argument] \\[universal-argument], go to the location where the last
11773 refiling operation has put the subtree.
11775 With a numeric prefix argument of `2', refile to the running clock.
11777 With a numeric prefix argument of `3', emulate `org-refile-keep'
11778 being set to `t' and copy to the target location, don't move it.
11779 Beware that keeping refiled entries may result in duplicated ID
11782 RFLOC can be a refile location obtained in a different way.
11784 MSG is a string to replace \"Refile\" in the default prompt with
11785 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11787 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11789 If you are using target caching (see `org-refile-use-cache'), you
11790 have to clear the target cache in order to find new targets.
11791 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11792 prefix argument (`C-u C-u C-u C-c C-w')."
11794 (if (member arg '(0 (64)))
11795 (org-refile-cache-clear)
11796 (let* ((actionmsg (cond (msg msg)
11797 ((equal arg 3) "Refile (and keep)")
11799 (cbuf (current-buffer))
11800 (regionp (org-region-active-p))
11801 (region-start (and regionp (region-beginning)))
11802 (region-end (and regionp (region-end)))
11803 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11804 (org-refile-keep (if (equal arg 3) t org-refile-keep))
11805 pos it nbuf file re level reversed)
11806 (setq last-command nil)
11808 (goto-char region-start)
11809 (or (bolp) (goto-char (point-at-bol)))
11810 (setq region-start (point))
11811 (unless (or (org-kill-is-subtree-p
11812 (buffer-substring region-start region-end))
11813 (prog1 org-refile-active-region-within-subtree
11814 (let ((s (point-at-eol)))
11815 (org-toggle-heading)
11816 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11817 (user-error "The region is not a (sequence of) subtree(s)")))
11818 (if (equal arg '(16))
11819 (org-refile-goto-last-stored)
11822 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11824 (setq it (list (or org-clock-heading "running clock")
11826 (marker-buffer org-clock-hd-marker))
11828 (marker-position org-clock-hd-marker)))
11831 (let (heading-text)
11833 (unless (and arg (listp arg))
11834 (org-back-to-heading t)
11836 (replace-regexp-in-string
11837 org-bracket-link-regexp
11839 (nth 4 (org-heading-components)))))
11840 (org-refile-get-location
11841 (cond ((and arg (listp arg)) "Goto")
11842 (regionp (concat actionmsg " region to"))
11843 (t (concat actionmsg " subtree \""
11844 heading-text "\" to")))
11846 (and (not (equal '(4) arg))
11847 org-refile-allow-creating-parent-nodes)
11849 (setq file (nth 1 it)
11854 (equal (buffer-file-name) file)
11856 (and (>= pos region-start)
11857 (<= pos region-end))
11858 (and (>= pos (point))
11859 (< pos (save-excursion
11860 (org-end-of-subtree t t))))))
11861 (error "Cannot refile to position inside the tree or region"))
11862 (setq nbuf (or (find-buffer-visiting file)
11863 (find-file-noselect file)))
11864 (if (and arg (not (equal arg 3)))
11866 (org-pop-to-buffer-same-window nbuf)
11868 (org-show-context 'org-goto))
11871 (org-kill-new (buffer-substring region-start region-end))
11872 (org-save-markers-in-region region-start region-end))
11873 (org-copy-subtree 1 nil t))
11874 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11875 (find-file-noselect file)))
11876 (setq reversed (org-notes-order-reversed-p))
11883 (looking-at org-outline-regexp)
11884 (setq level (org-get-valid-level (funcall outline-level) 1))
11887 (or (outline-next-heading) (point-max))
11888 (or (save-excursion (org-get-next-sibling))
11889 (org-end-of-subtree t t)
11893 (goto-char (point-max))
11894 (goto-char (point-min))
11895 (or (outline-next-heading) (goto-char (point-max)))))
11896 (if (not (bolp)) (newline))
11897 (org-paste-subtree level nil nil t)
11898 (when org-log-refile
11899 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11900 (unless (eq org-log-refile 'note)
11901 (save-excursion (org-add-log-note))))
11902 (and org-auto-align-tags
11903 (let ((org-loop-over-headlines-in-active-region nil))
11904 (org-set-tags nil t)))
11905 (let ((bookmark-name (plist-get org-bookmark-names-plist
11907 (when bookmark-name
11908 (with-demoted-errors
11909 (bookmark-set bookmark-name))))
11910 ;; If we are refiling for capture, make sure that the
11911 ;; last-capture pointers point here
11912 (when (org-bound-and-true-p org-refile-for-capture)
11913 (let ((bookmark-name (plist-get org-bookmark-names-plist
11914 :last-capture-marker)))
11915 (when bookmark-name
11916 (with-demoted-errors
11917 (bookmark-set bookmark-name))))
11918 (move-marker org-capture-last-stored-marker (point)))
11919 (if (fboundp 'deactivate-mark) (deactivate-mark))
11920 (run-hooks 'org-after-refile-insert-hook))))
11921 (unless org-refile-keep
11923 (delete-region (point) (+ (point) (- region-end region-start)))
11925 (and (org-back-to-heading t) (point))
11926 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11927 (when (featurep 'org-inlinetask)
11928 (org-inlinetask-remove-END-maybe))
11929 (setq org-markers-to-move nil)
11930 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11932 (defun org-refile-goto-last-stored ()
11933 "Go to the location where the last refile was stored."
11935 (bookmark-jump (plist-get org-bookmark-names-plist :last-refile))
11936 (message "This is the location of the last refile"))
11938 (defun org-refile--get-location (refloc tbl)
11939 "When user refile to REFLOC, find the associated target in TBL.
11940 Also check `org-refile-target-table'."
11944 (lambda (r) (or (assoc r tbl)
11945 (assoc r org-refile-target-table)))
11946 (list (replace-regexp-in-string "/$" "" refloc)
11947 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11949 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11951 "Prompt the user for a refile location, using PROMPT.
11952 PROMPT should not be suffixed with a colon and a space, because
11953 this function appends the default value from
11954 `org-refile-history' automatically, if that is not empty.
11955 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11956 this is used for the GOTO interface."
11957 (let ((org-refile-targets org-refile-targets)
11958 (org-refile-use-outline-path org-refile-use-outline-path)
11960 (when (and (derived-mode-p 'org-mode)
11961 (not org-refile-use-cache)
11965 (setq excluded-entries
11966 (append excluded-entries (list (org-get-heading t t)))))))
11967 (setq org-refile-target-table
11968 (org-refile-get-targets default-buffer excluded-entries)))
11969 (unless org-refile-target-table
11970 (user-error "No refile targets"))
11971 (let* ((cbuf (current-buffer))
11972 (partial-completion-mode nil)
11973 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11974 (cfunc (if (and org-refile-use-outline-path
11975 org-outline-path-complete-in-steps)
11976 'org-olpath-completing-read
11977 'org-icompleting-read))
11978 (extra (if org-refile-use-outline-path "/" ""))
11979 (cbnex (concat (buffer-name) extra))
11980 (filename (and cfn (expand-file-name cfn)))
11983 (if (and (not (member org-refile-use-outline-path
11984 '(file full-file-path)))
11985 (not (equal filename (nth 1 x))))
11986 (cons (concat (car x) extra " ("
11987 (file-name-nondirectory (nth 1 x)) ")")
11989 (cons (concat (car x) extra) (cdr x))))
11990 org-refile-target-table))
11991 (completion-ignore-case t)
11993 (prompt (concat prompt
11994 (or (and (car org-refile-history)
11995 (concat " (default " (car org-refile-history) ")"))
11996 (and (assoc cbnex tbl) (setq cdef cbnex)
11997 (concat " (default " cbnex ")"))) ": "))
11998 pa answ parent-target child parent old-hist)
11999 (setq old-hist org-refile-history)
12000 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
12001 nil 'org-refile-history (or cdef (car org-refile-history))))
12002 (if (setq pa (org-refile--get-location answ tbl))
12004 (org-refile-check-position pa)
12005 (when (or (not org-refile-history)
12006 (not (eq old-hist org-refile-history))
12007 (not (equal (car pa) (car org-refile-history))))
12008 (setq org-refile-history
12009 (cons (car pa) (if (assoc (car org-refile-history) tbl)
12011 (cdr org-refile-history))))
12012 (if (equal (car org-refile-history) (nth 1 org-refile-history))
12013 (pop org-refile-history)))
12015 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
12017 (setq parent (match-string 1 answ)
12018 child (match-string 2 answ))
12019 (setq parent-target (org-refile--get-location parent tbl))
12020 (when (and parent-target
12021 (or (eq new-nodes t)
12022 (and (eq new-nodes 'confirm)
12023 (y-or-n-p (format "Create new node \"%s\"? "
12025 (org-refile-new-child parent-target child)))
12026 (user-error "Invalid target location")))))
12028 (declare-function org-string-nw-p "org-macs" (s))
12029 (defun org-refile-check-position (refile-pointer)
12030 "Check if the refile pointer matches the headline to which it points."
12031 (let* ((file (nth 1 refile-pointer))
12032 (re (nth 2 refile-pointer))
12033 (pos (nth 3 refile-pointer))
12035 (if (and (not (markerp pos)) (not file))
12036 (user-error "Please indicate a target file in the refile path")
12037 (when (org-string-nw-p re)
12038 (setq buffer (if (markerp pos)
12039 (marker-buffer pos)
12040 (or (find-buffer-visiting file)
12041 (find-file-noselect file))))
12042 (with-current-buffer buffer
12047 (beginning-of-line 1)
12048 (unless (org-looking-at-p re)
12049 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
12051 (defun org-refile-new-child (parent-target child)
12052 "Use refile target PARENT-TARGET to add new CHILD below it."
12053 (unless parent-target
12054 (error "Cannot find parent for new node"))
12055 (let ((file (nth 1 parent-target))
12056 (pos (nth 3 parent-target))
12058 (with-current-buffer (or (find-buffer-visiting file)
12059 (find-file-noselect file))
12065 (goto-char (point-max))
12066 (if (not (bolp)) (newline)))
12067 (when (looking-at org-outline-regexp)
12068 (setq level (funcall outline-level))
12069 (org-end-of-subtree t t))
12070 (org-back-over-empty-lines)
12071 (insert "\n" (make-string
12072 (if pos (org-get-valid-level level 1) 1) ?*)
12074 (beginning-of-line 0)
12075 (list (concat (car parent-target) "/" child) file "" (point)))))))
12077 (defun org-olpath-completing-read (prompt collection &rest args)
12078 "Read an outline path like a file name."
12079 (let ((thetable collection)
12080 (org-completion-use-ido nil) ; does not work with ido.
12081 (org-completion-use-iswitchb nil)) ; or iswitchb
12083 'org-icompleting-read prompt
12084 (lambda (string predicate &optional flag)
12085 (let (rtn r f (l (length string)))
12089 (try-completion string thetable))
12092 (setq rtn (all-completions string thetable predicate))
12095 (setq r (substring x l))
12096 (if (string-match " ([^)]*)$" x)
12097 (setq f (match-string 0 x))
12099 (if (string-match "/" r)
12100 (concat string (substring r 0 (match-end 0)) f)
12105 (assoc string thetable)))))
12108 ;;;; Dynamic blocks
12110 (defun org-find-dblock (name)
12111 "Find the first dynamic block with name NAME in the buffer.
12112 If not found, stay at current position and return nil."
12113 (let ((case-fold-search t) pos)
12115 (goto-char (point-min))
12116 (setq pos (and (re-search-forward
12117 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
12118 (match-beginning 0))))
12119 (if pos (goto-char pos))
12122 (defun org-create-dblock (plist)
12123 "Create a dynamic block section, with parameters taken from PLIST.
12124 PLIST must contain a :name entry which is used as the name of the block."
12125 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
12128 (let ((col (current-column))
12129 (name (plist-get plist :name)))
12130 (insert "#+BEGIN: " name)
12132 (if (eq (car plist) :name)
12133 (setq plist (cddr plist))
12134 (insert " " (prin1-to-string (pop plist)))))
12135 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
12136 (beginning-of-line -2)))
12138 (defun org-prepare-dblock ()
12139 "Prepare dynamic block for refresh.
12140 This empties the block, puts the cursor at the insert position and returns
12141 the property list including an extra property :name with the block name."
12142 (unless (looking-at org-dblock-start-re)
12143 (user-error "Not at a dynamic block"))
12144 (let* ((begdel (1+ (match-end 0)))
12145 (name (org-no-properties (match-string 1)))
12146 (params (append (list :name name)
12147 (read (concat "(" (match-string 3) ")")))))
12149 (beginning-of-line 1)
12150 (skip-chars-forward " \t")
12151 (setq params (plist-put params :indentation-column (current-column))))
12152 (unless (re-search-forward org-dblock-end-re nil t)
12153 (error "Dynamic block not terminated"))
12156 (list :content (buffer-substring
12157 begdel (match-beginning 0)))))
12158 (delete-region begdel (match-beginning 0))
12163 (defun org-map-dblocks (&optional command)
12164 "Apply COMMAND to all dynamic blocks in the current buffer.
12165 If COMMAND is not given, use `org-update-dblock'."
12166 (let ((cmd (or command 'org-update-dblock)))
12168 (goto-char (point-min))
12169 (while (re-search-forward org-dblock-start-re nil t)
12170 (goto-char (match-beginning 0))
12172 (condition-case nil
12174 (error (message "Error during update of dynamic block"))))
12175 (unless (re-search-forward org-dblock-end-re nil t)
12176 (error "Dynamic block not terminated"))))))
12178 (defun org-dblock-update (&optional arg)
12179 "User command for updating dynamic blocks.
12180 Update the dynamic block at point. With prefix ARG, update all dynamic
12181 blocks in the buffer."
12184 (org-update-all-dblocks)
12185 (or (looking-at org-dblock-start-re)
12186 (org-beginning-of-dblock))
12187 (org-update-dblock)))
12189 (defun org-update-dblock ()
12190 "Update the dynamic block at point.
12191 This means to empty the block, parse for parameters and then call
12192 the correct writing function."
12195 (let* ((win (selected-window))
12197 (line (org-current-line))
12198 (params (org-prepare-dblock))
12199 (name (plist-get params :name))
12200 (indent (plist-get params :indentation-column))
12201 (cmd (intern (concat "org-dblock-write:" name))))
12202 (message "Updating dynamic block `%s' at line %d..." name line)
12203 (funcall cmd params)
12204 (message "Updating dynamic block `%s' at line %d...done" name line)
12206 (when (and indent (> indent 0))
12207 (setq indent (make-string indent ?\ ))
12209 (select-window win)
12210 (org-beginning-of-dblock)
12212 (while (not (looking-at org-dblock-end-re))
12214 (beginning-of-line 2))
12215 (when (looking-at org-dblock-end-re)
12216 (and (looking-at "[ \t]+")
12217 (replace-match ""))
12218 (insert indent)))))))
12220 (defun org-beginning-of-dblock ()
12221 "Find the beginning of the dynamic block at point.
12222 Error if there is no such block at point."
12223 (let ((pos (point))
12226 (if (and (re-search-backward org-dblock-start-re nil t)
12227 (setq beg (match-beginning 0))
12228 (re-search-forward org-dblock-end-re nil t)
12229 (> (match-end 0) pos))
12232 (error "Not in a dynamic block"))))
12234 (defun org-update-all-dblocks ()
12235 "Update all dynamic blocks in the buffer.
12236 This function can be used in a hook."
12238 (when (derived-mode-p 'org-mode)
12239 (org-map-dblocks 'org-update-dblock)))
12244 (declare-function org-export-backend-name "org-export" (cl-x))
12245 (declare-function org-export-backend-options "org-export" (cl-x))
12246 (defun org-get-export-keywords ()
12247 "Return a list of all currently understood export keywords.
12248 Export keywords include options, block names, attributes and
12249 keywords relative to each registered export back-end."
12252 (org-bound-and-true-p org-export--registered-backends)
12253 (delq nil keywords))
12254 ;; Back-end name (for keywords, like #+LATEX:)
12255 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12256 (dolist (option-entry (org-export-backend-options backend))
12257 ;; Back-end options.
12258 (push (nth 1 option-entry) keywords)))))
12260 (defconst org-options-keywords
12261 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12262 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12263 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12264 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12265 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12267 (defcustom org-structure-template-alist
12268 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC")
12269 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE")
12270 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE")
12271 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE")
12272 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM")
12273 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER")
12274 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX")
12276 ("h" "#+BEGIN_HTML\n?\n#+END_HTML")
12278 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII")
12281 ("I" "#+INCLUDE: %file ?"))
12282 "Structure completion elements.
12283 This is a list of abbreviation keys and values. The value gets inserted
12284 if you type `<' followed by the key and then press the completion key,
12285 usually `TAB'. %file will be replaced by a file name after prompting
12286 for the file using completion. The cursor will be placed at the position
12287 of the `?` in the template.
12288 There are two templates for each key, the first uses the original Org syntax,
12289 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12290 the default when the /org-mtags.el/ module has been loaded. See also the
12291 variable `org-mtags-prefer-muse-templates'."
12292 :group 'org-completion
12295 (string :tag "Key")
12296 (string :tag "Template")))
12298 :package-version '(Org . "8.3"))
12300 (defun org-try-structure-completion ()
12301 "Try to complete a structure template before point.
12302 This looks for strings like \"<e\" on an otherwise empty line and
12304 (let ((l (buffer-substring (point-at-bol) (point)))
12306 (when (and (looking-at "[ \t]*$")
12307 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12308 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12309 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12310 (match-beginning 1)) a)
12313 (defun org-complete-expand-structure-template (start cell)
12314 "Expand a structure template."
12315 (let ((rpl (nth 1 cell))
12317 (delete-region start (point))
12318 (when (string-match "\\`[ \t]*#\\+" rpl)
12321 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12322 (setq ind (buffer-substring (point-at-bol) (point))))
12324 (setq start (point))
12325 (if (string-match "%file" rpl)
12326 (setq rpl (replace-match
12330 (abbreviate-file-name (read-file-name "Include file: ")))
12333 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12334 (concat "\n" ind)))
12336 (if (re-search-backward "\\?" start t) (delete-char 1))))
12338 ;;;; TODO, DEADLINE, Comments
12340 (defun org-toggle-comment ()
12341 "Change the COMMENT state of an entry."
12344 (org-back-to-heading)
12345 (looking-at org-complex-heading-regexp)
12346 (goto-char (or (match-end 3) (match-end 2) (match-end 1)))
12347 (skip-chars-forward " \t")
12348 (unless (memq (char-before) '(?\s ?\t)) (insert " "))
12349 (if (org-in-commented-heading-p t)
12350 (delete-region (point)
12351 (progn (search-forward " " (line-end-position) 'move)
12352 (skip-chars-forward " \t")
12354 (insert org-comment-string)
12355 (unless (eolp) (insert " ")))))
12357 (defvar org-last-todo-state-is-todo nil
12358 "This is non-nil when the last TODO state change led to a TODO state.
12359 If the last change removed the TODO tag or switched to DONE, then
12362 (defvar org-setting-tags nil) ; dynamically skipped
12364 (defvar org-todo-setup-filter-hook nil
12365 "Hook for functions that pre-filter todo specs.
12366 Each function takes a todo spec and returns either nil or the spec
12367 transformed into canonical form." )
12369 (defvar org-todo-get-default-hook nil
12370 "Hook for functions that get a default item for todo.
12371 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12372 nil or a string to be used for the todo mark." )
12374 (defvar org-agenda-headline-snapshot-before-repeat)
12376 (defun org-current-effective-time ()
12377 "Return current time adjusted for `org-extend-today-until' variable."
12378 (let* ((ct (org-current-time))
12379 (dct (decode-time ct))
12382 (org-use-last-clock-out-time-as-effective-time
12383 (or (org-clock-get-last-clock-out-time) ct))
12384 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12385 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12389 (defun org-todo-yesterday (&optional arg)
12390 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12392 (if (eq major-mode 'org-agenda-mode)
12393 (apply 'org-agenda-todo-yesterday arg)
12394 (let* ((hour (third (decode-time
12395 (org-current-time))))
12396 (org-extend-today-until (1+ hour)))
12399 (defvar org-block-entry-blocking ""
12400 "First entry preventing the TODO state change.")
12402 (defun org-cancel-repeater ()
12403 "Cancel a repeater by setting its numeric value to zero."
12406 (org-back-to-heading t)
12407 (let ((bound1 (point))
12408 (bound0 (save-excursion (outline-next-heading) (point))))
12409 (when (re-search-forward
12410 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12411 org-deadline-time-regexp "\\)\\|\\("
12412 org-ts-regexp "\\)")
12414 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12415 (replace-match "0" t nil nil 1))))))
12417 (defun org-todo (&optional arg)
12418 "Change the TODO state of an item.
12419 The state of an item is given by a keyword at the start of the heading,
12421 *** TODO Write paper
12424 The different keywords are specified in the variable `org-todo-keywords'.
12425 By default the available states are \"TODO\" and \"DONE\".
12426 So for this example: when the item starts with TODO, it is changed to DONE.
12427 When it starts with DONE, the DONE is removed. And when neither TODO nor
12428 DONE are present, add TODO at the beginning of the heading.
12430 With \\[universal-argument] prefix arg, use completion to determine the new \
12432 With numeric prefix arg, switch to that state.
12433 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12434 keywords (nextset).
12435 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12436 With a numeric prefix arg of 0, inhibit note taking for the change.
12437 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12439 When called through ELisp, arg is also interpreted in the following way:
12440 'none -> empty state
12441 \"\"(empty string) -> switch to empty state
12442 'done -> switch to DONE
12443 'nextset -> switch to the next set of keywords
12444 'previousset -> switch to the previous set of keywords
12445 \"WAITING\" -> switch to the specified keyword, but only if it
12446 really is a member of `org-todo-keywords'."
12448 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12449 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12450 'region-start-level 'region))
12451 org-loop-over-headlines-in-active-region)
12454 org-loop-over-headlines-in-active-region
12455 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12456 (if (equal arg '(16)) (setq arg 'nextset))
12457 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12458 (let ((org-blocker-hook org-blocker-hook)
12461 (when (equal arg '(64))
12462 (setq arg nil org-blocker-hook nil))
12463 (when (and org-blocker-hook
12464 (or org-inhibit-blocking
12465 (org-entry-get nil "NOBLOCKING")))
12466 (setq org-blocker-hook nil))
12469 (org-back-to-heading t)
12470 (when (org-in-commented-heading-p t)
12471 (org-toggle-comment)
12473 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12474 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12475 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12476 (let* ((match-data (match-data))
12477 (startpos (point-at-bol))
12478 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12479 (org-log-done org-log-done)
12480 (org-log-repeat org-log-repeat)
12481 (org-todo-log-states org-todo-log-states)
12482 (org-inhibit-logging
12484 (progn (setq arg nil) 'note) org-inhibit-logging))
12485 (this (match-string 1))
12486 (hl-pos (match-beginning 0))
12487 (head (org-get-todo-sequence-head this))
12488 (ass (assoc head org-todo-kwd-alist))
12489 (interpret (nth 1 ass))
12490 (done-word (nth 3 ass))
12491 (final-done-word (nth 4 ass))
12492 (org-last-state (or this ""))
12493 (completion-ignore-case t)
12494 (member (member this org-todo-keywords-1))
12495 (tail (cdr member))
12497 ((and org-todo-key-trigger
12498 (or (and (equal arg '(4))
12499 (eq org-use-fast-todo-selection 'prefix))
12500 (and (not arg) org-use-fast-todo-selection
12501 (not (eq org-use-fast-todo-selection
12503 ;; Use fast selection
12504 (org-fast-todo-selection))
12505 ((and (equal arg '(4))
12506 (or (not org-use-fast-todo-selection)
12507 (not org-todo-key-trigger)))
12508 ;; Read a state with completion
12509 (org-icompleting-read
12510 "State: " (mapcar 'list org-todo-keywords-1)
12514 (if tail (car tail) nil)
12515 (car org-todo-keywords-1)))
12517 (if (equal member org-todo-keywords-1)
12520 (nth (- (length org-todo-keywords-1)
12522 org-todo-keywords-1)
12523 (org-last org-todo-keywords-1))))
12524 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12525 (setq arg nil))) ; hack to fall back to cycling
12527 ;; user or caller requests a specific state
12529 ((equal arg "") nil)
12530 ((eq arg 'none) nil)
12531 ((eq arg 'done) (or done-word (car org-done-keywords)))
12533 (or (car (cdr (member head org-todo-heads)))
12534 (car org-todo-heads)))
12535 ((eq arg 'previousset)
12536 (let ((org-todo-heads (reverse org-todo-heads)))
12537 (or (car (cdr (member head org-todo-heads)))
12538 (car org-todo-heads))))
12539 ((car (member arg org-todo-keywords-1)))
12541 (user-error "State `%s' not valid in this file" arg))
12542 ((nth (1- (prefix-numeric-value arg))
12543 org-todo-keywords-1))))
12544 ((null member) (or head (car org-todo-keywords-1)))
12545 ((equal this final-done-word) nil) ;; -> make empty
12546 ((null tail) nil) ;; -> first entry
12547 ((memq interpret '(type priority))
12548 (if (eq this-command last-command)
12550 (if (> (length tail) 0)
12551 (or done-word (car org-done-keywords))
12556 (run-hook-with-args-until-success
12557 'org-todo-get-default-hook org-state org-last-state)
12559 (next (if org-state (concat " " org-state " ") " "))
12560 (change-plist (list :type 'todo-state-change :from this :to org-state
12561 :position startpos))
12563 (when org-blocker-hook
12564 (setq org-last-todo-state-is-todo
12565 (not (member this org-done-keywords)))
12566 (unless (save-excursion
12568 (org-with-wide-buffer
12569 (run-hook-with-args-until-failure
12570 'org-blocker-hook change-plist))))
12571 (if (org-called-interactively-p 'interactive)
12572 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12573 this org-state org-block-entry-blocking)
12575 (message "TODO state change from %s to %s blocked (by \"%s\")"
12576 this org-state org-block-entry-blocking)
12577 (throw 'exit nil))))
12578 (store-match-data match-data)
12579 (replace-match next t t)
12580 (cond ((equal this org-state)
12581 (message "TODO state was already %s" (org-trim next)))
12582 ((pos-visible-in-window-p hl-pos)
12583 (message "TODO state changed to %s" (org-trim next))))
12585 (setq head (org-get-todo-sequence-head org-state)
12586 ass (assoc head org-todo-kwd-alist)
12587 interpret (nth 1 ass)
12588 done-word (nth 3 ass)
12589 final-done-word (nth 4 ass)))
12590 (when (memq arg '(nextset previousset))
12591 (message "Keyword-Set %d/%d: %s"
12592 (- (length org-todo-sets) -1
12593 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12594 (length org-todo-sets)
12595 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12596 (setq org-last-todo-state-is-todo
12597 (not (member org-state org-done-keywords)))
12598 (setq now-done-p (and (member org-state org-done-keywords)
12599 (not (member this org-done-keywords))))
12600 (and logging (org-local-logging logging))
12601 (when (and (or org-todo-log-states org-log-done)
12602 (not (eq org-inhibit-logging t))
12603 (not (memq arg '(nextset previousset))))
12604 ;; we need to look at recording a time and note
12605 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12606 (nth 2 (assoc this org-todo-log-states))))
12607 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12608 (setq dolog 'time))
12609 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12611 (member org-state org-not-done-keywords)
12612 (not (member this org-not-done-keywords))))
12613 ;; This is now a todo state and was not one before
12614 ;; If there was a CLOSED time stamp, get rid of it.
12615 (org-add-planning-info nil nil 'closed))
12616 (when (and now-done-p org-log-done)
12617 ;; It is now done, and it was not done before
12618 (org-add-planning-info 'closed (org-current-effective-time))
12619 (if (and (not dolog) (eq 'note org-log-done))
12620 (org-add-log-setup 'done org-state this 'findpos 'note)))
12621 (when (and org-state dolog)
12622 ;; This is a non-nil state, and we need to log it
12623 (org-add-log-setup 'state org-state this 'findpos dolog)))
12624 ;; Fixup tag positioning
12625 (org-todo-trigger-tag-changes org-state)
12626 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12627 (when org-provide-todo-statistics
12628 (org-update-parent-todo-statistics))
12629 (run-hooks 'org-after-todo-state-change-hook)
12630 (if (and arg (not (member org-state org-done-keywords)))
12631 (setq head (org-get-todo-sequence-head org-state)))
12632 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12633 ;; Do we need to trigger a repeat?
12635 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12636 ;; This is for the agenda, take a snapshot of the headline.
12638 (setq org-agenda-headline-snapshot-before-repeat
12639 (org-get-heading))))
12640 (org-auto-repeat-maybe org-state))
12641 ;; Fixup cursor location if close to the keyword
12642 (if (and (outline-on-heading-p)
12644 (save-excursion (beginning-of-line 1)
12645 (looking-at org-todo-line-regexp))
12646 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12648 (goto-char (or (match-end 2) (match-end 1)))
12649 (and (looking-at " ") (just-one-space))))
12650 (when org-trigger-hook
12652 (run-hook-with-args 'org-trigger-hook change-plist)))
12653 (when commentp (org-toggle-comment))))))))
12655 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12656 "Block turning an entry into a TODO, using the hierarchy.
12657 This checks whether the current task should be blocked from state
12658 changes. Such blocking occurs when:
12660 1. The task has children which are not all in a completed state.
12662 2. A task has a parent with the property :ORDERED:, and there
12663 are siblings prior to the current task with incomplete
12666 3. The parent of the task is blocked because it has siblings that should
12667 be done first, or is child of a block grandparent TODO entry."
12669 (if (not org-enforce-todo-dependencies)
12670 t ; if locally turned off don't block
12672 ;; If this is not a todo state change, or if this entry is already DONE,
12674 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12675 (member (plist-get change-plist :from)
12676 (cons 'done org-done-keywords))
12677 (member (plist-get change-plist :to)
12678 (cons 'todo org-not-done-keywords))
12679 (not (plist-get change-plist :to)))
12680 (throw 'dont-block t))
12681 ;; If this task has children, and any are undone, it's blocked
12683 (org-back-to-heading t)
12684 (let ((this-level (funcall outline-level)))
12685 (outline-next-heading)
12686 (let ((child-level (funcall outline-level)))
12687 (while (and (not (eobp))
12688 (> child-level this-level))
12689 ;; this todo has children, check whether they are all
12691 (if (and (not (org-entry-is-done-p))
12692 (org-entry-is-todo-p))
12693 (progn (setq org-block-entry-blocking (org-get-heading))
12694 (throw 'dont-block nil)))
12695 (outline-next-heading)
12696 (setq child-level (funcall outline-level))))))
12697 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12698 ;; any previous siblings are undone, it's blocked
12700 (org-back-to-heading t)
12701 (let* ((pos (point))
12702 (parent-pos (and (org-up-heading-safe) (point))))
12703 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12704 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12706 (re-search-forward org-not-done-heading-regexp pos t))
12707 (setq org-block-entry-blocking (match-string 0))
12708 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12709 ;; Search further up the hierarchy, to see if an ancestor is blocked
12711 (goto-char parent-pos)
12712 (if (not (looking-at org-not-done-heading-regexp))
12713 (throw 'dont-block t)) ; do not block, parent is not a TODO
12715 (setq parent-pos (and (org-up-heading-safe) (point)))
12716 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12717 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12719 (re-search-forward org-not-done-heading-regexp pos t)
12720 (setq org-block-entry-blocking (org-get-heading)))
12721 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12723 (defcustom org-track-ordered-property-with-tag nil
12724 "Should the ORDERED property also be shown as a tag?
12725 The ORDERED property decides if an entry should require subtasks to be
12726 completed in sequence. Since a property is not very visible, setting
12727 this option means that toggling the ORDERED property with the command
12728 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12729 not relevant for the behavior, but it makes things more visible.
12731 Note that toggling the tag with tags commands will not change the property
12732 and therefore not influence behavior!
12734 This can be t, meaning the tag ORDERED should be used, It can also be a
12735 string to select a different tag for this task."
12738 (const :tag "No tracking" nil)
12739 (const :tag "Track with ORDERED tag" t)
12740 (string :tag "Use other tag")))
12742 (defun org-toggle-ordered-property ()
12743 "Toggle the ORDERED property of the current entry.
12744 For better visibility, you can track the value of this property with a tag.
12745 See variable `org-track-ordered-property-with-tag'."
12747 (let* ((t1 org-track-ordered-property-with-tag)
12748 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12750 (org-back-to-heading)
12751 (if (org-entry-get nil "ORDERED")
12753 (org-delete-property "ORDERED")
12754 (and tag (org-toggle-tag tag 'off))
12755 (message "Subtasks can be completed in arbitrary order"))
12756 (org-entry-put nil "ORDERED" "t")
12757 (and tag (org-toggle-tag tag 'on))
12758 (message "Subtasks must be completed in sequence")))))
12760 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12761 (defun org-block-todo-from-checkboxes (change-plist)
12762 "Block turning an entry into a TODO, using checkboxes.
12763 This checks whether the current task should be blocked from state
12764 changes because there are unchecked boxes in this entry."
12765 (if (not org-enforce-todo-checkbox-dependencies)
12766 t ; if locally turned off don't block
12768 ;; If this is not a todo state change, or if this entry is already DONE,
12770 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12771 (member (plist-get change-plist :from)
12772 (cons 'done org-done-keywords))
12773 (member (plist-get change-plist :to)
12774 (cons 'todo org-not-done-keywords))
12775 (not (plist-get change-plist :to)))
12776 (throw 'dont-block t))
12777 ;; If this task has checkboxes that are not checked, it's blocked
12779 (org-back-to-heading t)
12780 (let ((beg (point)) end)
12781 (outline-next-heading)
12784 (if (org-list-search-forward
12785 (concat (org-item-beginning-re)
12786 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12790 (if (boundp 'org-blocked-by-checkboxes)
12791 (setq org-blocked-by-checkboxes t))
12792 (throw 'dont-block nil)))))
12793 t))) ; do not block
12795 (defun org-entry-blocked-p ()
12796 "Is the current entry blocked?"
12797 (org-with-silent-modifications
12798 (if (org-entry-get nil "NOBLOCKING")
12799 nil ;; Never block this entry
12800 (not (run-hook-with-args-until-failure
12802 (list :type 'todo-state-change
12807 (defun org-update-statistics-cookies (all)
12808 "Update the statistics cookie, either from TODO or from checkboxes.
12809 This should be called with the cursor in a line with a statistics cookie."
12813 (org-update-checkbox-count 'all)
12814 (org-map-entries 'org-update-parent-todo-statistics))
12815 (if (not (org-at-heading-p))
12816 (org-update-checkbox-count)
12817 (let ((pos (point-marker))
12819 (ignore-errors (org-back-to-heading t))
12820 (if (not (org-at-heading-p))
12821 (org-update-checkbox-count)
12822 (setq l1 (org-outline-level))
12823 (setq end (save-excursion
12824 (outline-next-heading)
12825 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12827 (if (and (save-excursion
12829 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12830 (not (save-excursion (re-search-forward
12831 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12832 (org-update-checkbox-count)
12833 (if (and l2 (> l2 l1))
12836 (org-update-parent-todo-statistics))
12838 (beginning-of-line 1)
12839 (while (re-search-forward
12840 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12842 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12844 (move-marker pos nil)))))
12846 (defvar org-entry-property-inherited-from) ;; defined below
12847 (defun org-update-parent-todo-statistics ()
12848 "Update any statistics cookie in the parent of the current headline.
12849 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12850 the entire subtree and this will travel up the hierarchy and update
12851 statistics everywhere."
12852 (let* ((prop (save-excursion (org-up-heading-safe)
12853 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12854 (recursive (or (not org-hierarchical-todo-statistics)
12855 (and prop (string-match "\\<recursive\\>" prop))))
12856 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12859 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12860 level ltoggle l1 new ndel
12861 (cnt-all 0) (cnt-done 0) is-percent kwd
12862 checkbox-beg ov ovs ove cookie-present)
12865 (beginning-of-line 1)
12866 (setq ltoggle (funcall outline-level))
12867 ;; Three situations are to consider:
12869 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12870 ;; to the top-level ancestor on the headline;
12872 ;; 2. If parent has "recursive" property, repeat up to the
12873 ;; headline setting that property, taking inheritance into
12876 ;; 3. Else, move up to direct parent and proceed only once.
12877 (while (and (setq level (org-up-heading-safe))
12878 (or recursive first)
12880 (setq first nil cookie-present nil)
12884 (downcase (or (org-entry-get nil "COOKIE_DATA")
12887 (while (re-search-forward box-re (point-at-eol) t)
12888 (setq cnt-all 0 cnt-done 0 cookie-present t)
12889 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12891 (unless (outline-next-heading) (throw 'exit nil))
12892 (while (and (looking-at org-complex-heading-regexp)
12893 (> (setq l1 (length (match-string 1))) level))
12894 (setq kwd (and (or recursive (= l1 ltoggle))
12896 (if (or (eq org-provide-todo-statistics 'all-headlines)
12897 (and (eq org-provide-todo-statistics t)
12898 (or (member kwd org-done-keywords)))
12899 (and (listp org-provide-todo-statistics)
12900 (stringp (car org-provide-todo-statistics))
12901 (or (member kwd org-provide-todo-statistics)
12902 (member kwd org-done-keywords)))
12903 (and (listp org-provide-todo-statistics)
12904 (listp (car org-provide-todo-statistics))
12905 (or (member kwd (car org-provide-todo-statistics))
12906 (and (member kwd org-done-keywords)
12907 (member kwd (cadr org-provide-todo-statistics))))))
12908 (setq cnt-all (1+ cnt-all))
12909 (if (eq org-provide-todo-statistics t)
12910 (and kwd (setq cnt-all (1+ cnt-all)))))
12911 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12912 (member kwd org-done-keywords))
12913 (and (listp org-provide-todo-statistics)
12914 (listp (car org-provide-todo-statistics))
12915 (member kwd org-done-keywords)
12916 (member kwd (cadr org-provide-todo-statistics)))
12917 (and (listp org-provide-todo-statistics)
12918 (stringp (car org-provide-todo-statistics))
12919 (member kwd org-done-keywords)))
12920 (setq cnt-done (1+ cnt-done)))
12921 (outline-next-heading)))
12924 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12925 (format "[%d/%d]" cnt-done cnt-all))
12926 ndel (- (match-end 0) checkbox-beg))
12927 ;; handle overlays when updating cookie from column view
12928 (when (setq ov (car (overlays-at checkbox-beg)))
12929 (setq ovs (overlay-start ov) ove (overlay-end ov))
12930 (delete-overlay ov))
12931 (goto-char checkbox-beg)
12933 (delete-region (point) (+ (point) ndel))
12934 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12935 (when ov (move-overlay ov ovs ove)))
12936 (when cookie-present
12937 (run-hook-with-args 'org-after-todo-statistics-hook
12938 cnt-done (- cnt-all cnt-done))))))
12939 (run-hooks 'org-todo-statistics-hook)))
12941 (defvar org-after-todo-statistics-hook nil
12942 "Hook that is called after a TODO statistics cookie has been updated.
12943 Each function is called with two arguments: the number of not-done entries
12944 and the number of done entries.
12946 For example, the following function, when added to this hook, will switch
12947 an entry to DONE when all children are done, and back to TODO when new
12948 entries are set to a TODO status. Note that this hook is only called
12949 when there is a statistics cookie in the headline!
12951 (defun org-summary-todo (n-done n-not-done)
12952 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12953 (let (org-log-done org-log-states) ; turn off logging
12954 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12957 (defvar org-todo-statistics-hook nil
12958 "Hook that is run whenever Org thinks TODO statistics should be updated.
12959 This hook runs even if there is no statistics cookie present, in which case
12960 `org-after-todo-statistics-hook' would not run.")
12962 (defun org-todo-trigger-tag-changes (state)
12963 "Apply the changes defined in `org-todo-state-tags-triggers'."
12964 (let ((l org-todo-state-tags-triggers)
12966 (when (or (not state) (equal state ""))
12967 (setq changes (append changes (cdr (assoc "" l)))))
12968 (when (and (stringp state) (> (length state) 0))
12969 (setq changes (append changes (cdr (assoc state l)))))
12970 (when (member state org-not-done-keywords)
12971 (setq changes (append changes (cdr (assoc 'todo l)))))
12972 (when (member state org-done-keywords)
12973 (setq changes (append changes (cdr (assoc 'done l)))))
12974 (dolist (c changes)
12975 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12977 (defun org-local-logging (value)
12978 "Get logging settings from a property VALUE."
12980 ;; directly set the variables, they are already local.
12981 (setq org-log-done nil
12983 org-todo-log-states nil)
12984 (setq words (org-split-string value))
12985 (while (setq w (pop words))
12987 ((setq a (assoc w org-startup-options))
12988 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12989 (set (nth 1 a) (nth 2 a))))
12990 ((setq a (org-extract-log-state-settings w))
12991 (and (member (car a) org-todo-keywords-1)
12992 (push a org-todo-log-states)))))))
12994 (defun org-get-todo-sequence-head (kwd)
12995 "Return the head of the TODO sequence to which KWD belongs.
12996 If KWD is not set, check if there is a text property remembering the
13001 (or (get-text-property (point-at-bol) 'org-todo-head)
13003 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
13004 nil (point-at-eol)))
13005 (get-text-property p 'org-todo-head))))
13006 ((not (member kwd org-todo-keywords-1))
13007 (car org-todo-keywords-1))
13008 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
13010 (defun org-fast-todo-selection ()
13011 "Fast TODO keyword selection with single keys.
13012 Returns the new TODO keyword, or nil if no state change should occur."
13013 (let* ((fulltable org-todo-key-alist)
13014 (done-keywords org-done-keywords) ;; needed for the faces.
13015 (maxlen (apply 'max (mapcar
13017 (if (stringp (car x)) (string-width (car x)) 0))
13020 (fwidth (+ maxlen 3 1 3))
13021 (ncol (/ (- (window-width) 4) fwidth))
13025 (save-window-excursion
13027 (set-buffer (get-buffer-create " *Org todo*"))
13028 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
13030 (org-set-local 'org-done-keywords done-keywords)
13031 (setq tbl fulltable cnt 0)
13032 (while (setq e (pop tbl))
13034 ((equal e '(:startgroup))
13035 (push '() groups) (setq ingroup t)
13036 (when (not (= cnt 0))
13040 ((equal e '(:endgroup))
13041 (setq ingroup nil cnt 0)
13043 ((equal e '(:newline))
13044 (when (not (= cnt 0))
13048 (while (equal (car tbl) '(:newline))
13050 (setq tbl (cdr tbl)))))
13052 (setq tg (car e) c (cdr e))
13053 (if ingroup (push tg (car groups)))
13054 (setq tg (org-add-props tg nil 'face
13055 (org-get-todo-face tg)))
13056 (if (and (= cnt 0) (not ingroup)) (insert " "))
13057 (insert "[" c "] " tg (make-string
13058 (- fwidth 4 (length tg)) ?\ ))
13059 (when (= (setq cnt (1+ cnt)) ncol)
13061 (if ingroup (insert " "))
13064 (goto-char (point-min))
13065 (if (not expert) (org-fit-window-to-buffer))
13066 (message "[a-z..]:Set [SPC]:clear")
13067 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
13070 (and (= c ?q) (not (rassoc c fulltable))))
13071 (setq quit-flag t))
13073 ((setq e (rassoc c fulltable) tg (car e))
13075 (t (setq quit-flag t)))))))
13077 (defun org-entry-is-todo-p ()
13078 (member (org-get-todo-state) org-not-done-keywords))
13080 (defun org-entry-is-done-p ()
13081 (member (org-get-todo-state) org-done-keywords))
13083 (defun org-get-todo-state ()
13084 "Return the TODO keyword of the current subtree."
13086 (org-back-to-heading t)
13087 (and (looking-at org-todo-line-regexp)
13089 (match-string 2))))
13091 (defun org-at-date-range-p (&optional inactive-ok)
13092 "Is the cursor inside a date range?"
13096 (let ((pos (point)))
13097 (skip-chars-backward "^[<\r\n")
13098 (skip-chars-backward "<[")
13099 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13100 (>= (match-end 0) pos)
13102 (skip-chars-backward "^<[\r\n")
13103 (skip-chars-backward "<[")
13104 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
13105 (>= (match-end 0) pos)
13109 (defun org-get-repeat (&optional tagline)
13110 "Check if there is a deadline/schedule with repeater in this entry."
13113 (org-back-to-heading t)
13114 (and (re-search-forward (if tagline
13115 (concat tagline "\\s-*" org-repeat-re)
13117 (org-entry-end-position) t)
13118 (match-string-no-properties 1)))))
13120 (defvar org-last-changed-timestamp)
13121 (defvar org-last-inserted-timestamp)
13122 (defvar org-log-post-message)
13123 (defvar org-log-note-purpose)
13124 (defvar org-log-note-how nil)
13125 (defvar org-log-note-extra)
13126 (defun org-auto-repeat-maybe (done-word)
13127 "Check if the current headline contains a repeated deadline/schedule.
13128 If yes, set TODO state back to what it was and change the base date
13129 of repeating deadline/scheduled time stamps to new date.
13130 This function is run automatically after each state change to a DONE state."
13131 ;; last-state is dynamically scoped into this function
13132 (let* ((repeat (org-get-repeat))
13133 (aa (assoc org-last-state org-todo-kwd-alist))
13134 (interpret (nth 1 aa))
13136 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
13137 (msg "Entry repeats: ")
13139 (org-todo-log-states nil)
13140 re type n what ts time to-state)
13141 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
13142 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
13143 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
13144 org-todo-repeat-to-state))
13145 (unless (and to-state (member to-state org-todo-keywords-1))
13146 (setq to-state (if (eq interpret 'type) org-last-state head)))
13147 (org-todo to-state)
13148 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
13149 (org-entry-put nil "LAST_REPEAT" (format-time-string
13150 (org-time-stamp-format t t))))
13151 (when org-log-repeat
13152 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
13153 (memq 'org-add-log-note post-command-hook))
13154 ;; OK, we are already setup for some record
13155 (if (eq org-log-repeat 'note)
13156 ;; make sure we take a note, not only a time stamp
13157 (setq org-log-note-how 'note))
13158 ;; Set up for taking a record
13159 (org-add-log-setup 'state (or done-word (car org-done-keywords))
13161 'findpos org-log-repeat)))
13162 (org-back-to-heading t)
13163 (org-add-planning-info nil nil 'closed)
13164 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
13165 org-deadline-time-regexp "\\)\\|\\("
13166 org-ts-regexp "\\)"))
13167 (while (re-search-forward
13168 re (save-excursion (outline-next-heading) (point)) t)
13169 (setq type (if (match-end 1) org-scheduled-string
13170 (if (match-end 3) org-deadline-string "Plain:"))
13171 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
13172 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
13173 (setq n (string-to-number (match-string 2 ts))
13174 what (match-string 3 ts))
13175 (if (equal what "w") (setq n (* n 7) what "d"))
13176 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
13177 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
13178 ;; Preparation, see if we need to modify the start date for the change
13179 (when (match-end 1)
13180 (setq time (save-match-data (org-time-string-to-time ts)))
13182 ((equal (match-string 1 ts) ".")
13183 ;; Shift starting date to today
13184 (org-timestamp-change
13185 (- (org-today) (time-to-days time))
13187 ((equal (match-string 1 ts) "+")
13188 (let ((nshiftmax 10) (nshift 0))
13189 (while (or (= nshift 0)
13190 (<= (time-to-days time)
13191 (time-to-days (current-time))))
13192 (when (= (incf nshift) nshiftmax)
13193 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13194 (user-error "Abort")))
13195 (org-timestamp-change n (cdr (assoc what whata)))
13196 (org-at-timestamp-p t)
13197 (setq ts (match-string 1))
13198 (setq time (save-match-data (org-time-string-to-time ts)))))
13199 (org-timestamp-change (- n) (cdr (assoc what whata)))
13200 ;; rematch, so that we have everything in place for the real shift
13201 (org-at-timestamp-p t)
13202 (setq ts (match-string 1))
13203 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13204 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13205 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13206 (setq org-log-post-message msg)
13207 (message "%s" msg))))
13209 (defun org-show-todo-tree (arg)
13210 "Make a compact tree which shows all headlines marked with TODO.
13211 The tree will show the lines where the regexp matches, and all higher
13212 headlines above the match.
13213 With a \\[universal-argument] prefix, prompt for a regexp to match.
13214 With a numeric prefix N, construct a sparse tree for the Nth element
13215 of `org-todo-keywords-1'."
13217 (let ((case-fold-search nil)
13219 (cond ((null arg) org-not-done-regexp)
13221 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13222 (mapcar 'list org-todo-keywords-1))))
13224 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13226 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13227 (regexp-quote (nth (1- (prefix-numeric-value arg))
13228 org-todo-keywords-1)))
13229 (t (user-error "Invalid prefix argument: %s" arg)))))
13230 (message "%d TODO entries found"
13231 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13233 (defun org-deadline (arg &optional time)
13234 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13235 With one universal prefix argument, remove any deadline from the item.
13236 With two universal prefix arguments, prompt for a warning delay.
13237 With argument TIME, set the deadline at the corresponding date. TIME
13238 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13240 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13241 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13242 'region-start-level 'region))
13243 org-loop-over-headlines-in-active-region)
13245 `(org-deadline ',arg ,time)
13246 org-loop-over-headlines-in-active-region
13247 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13248 (let* ((old-date (org-entry-get nil "DEADLINE"))
13249 (old-date-time (if old-date (org-time-string-to-time old-date)))
13250 (repeater (and old-date
13252 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13254 (match-string 1 old-date))))
13257 (when (and old-date org-log-redeadline)
13258 (org-add-log-setup 'deldeadline nil old-date 'findpos
13259 org-log-redeadline))
13260 (org-remove-timestamp-with-keyword org-deadline-string)
13261 (message "Item no longer has a deadline."))
13264 (org-back-to-heading t)
13265 (if (re-search-forward
13266 org-deadline-time-regexp
13267 (save-excursion (outline-next-heading) (point)) t)
13268 (let* ((rpl0 (match-string 1))
13269 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13271 (concat org-deadline-string
13277 (org-read-date nil t nil "Warn starting from" old-date-time)))
13278 (time-to-days old-date-time))))
13280 (user-error "No deadline information to update"))))
13282 (org-add-planning-info 'deadline time 'closed)
13283 (when (and old-date org-log-redeadline
13284 (not (equal old-date
13285 (substring org-last-inserted-timestamp 1 -1))))
13286 (org-add-log-setup 'redeadline nil old-date 'findpos
13287 org-log-redeadline))
13290 (org-back-to-heading t)
13291 (when (re-search-forward (concat org-deadline-string " "
13292 org-last-inserted-timestamp)
13294 (outline-next-heading) (point)) t)
13295 (goto-char (1- (match-end 0)))
13296 (insert " " repeater)
13297 (setq org-last-inserted-timestamp
13298 (concat (substring org-last-inserted-timestamp 0 -1)
13300 (substring org-last-inserted-timestamp -1))))))
13301 (message "Deadline on %s" org-last-inserted-timestamp))))))
13303 (defun org-schedule (arg &optional time)
13304 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13305 With one universal prefix argument, remove any scheduling date from the item.
13306 With two universal prefix arguments, prompt for a delay cookie.
13307 With argument TIME, scheduled at the corresponding date. TIME can
13308 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13310 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13311 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13312 'region-start-level 'region))
13313 org-loop-over-headlines-in-active-region)
13315 `(org-schedule ',arg ,time)
13316 org-loop-over-headlines-in-active-region
13317 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13318 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13319 (old-date-time (if old-date (org-time-string-to-time old-date)))
13320 (repeater (and old-date
13322 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13324 (match-string 1 old-date))))
13328 (when (and old-date org-log-reschedule)
13329 (org-add-log-setup 'delschedule nil old-date 'findpos
13330 org-log-reschedule))
13331 (org-remove-timestamp-with-keyword org-scheduled-string)
13332 (message "Item is no longer scheduled.")))
13335 (org-back-to-heading t)
13336 (if (re-search-forward
13337 org-scheduled-time-regexp
13338 (save-excursion (outline-next-heading) (point)) t)
13339 (let* ((rpl0 (match-string 1))
13340 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13342 (concat org-scheduled-string
13348 (org-read-date nil t nil "Delay until" old-date-time)))
13349 (time-to-days old-date-time))))
13351 (user-error "No scheduled information to update"))))
13353 (org-add-planning-info 'scheduled time 'closed)
13354 (when (and old-date org-log-reschedule
13355 (not (equal old-date
13356 (substring org-last-inserted-timestamp 1 -1))))
13357 (org-add-log-setup 'reschedule nil old-date 'findpos
13358 org-log-reschedule))
13361 (org-back-to-heading t)
13362 (when (re-search-forward (concat org-scheduled-string " "
13363 org-last-inserted-timestamp)
13365 (outline-next-heading) (point)) t)
13366 (goto-char (1- (match-end 0)))
13367 (insert " " repeater)
13368 (setq org-last-inserted-timestamp
13369 (concat (substring org-last-inserted-timestamp 0 -1)
13371 (substring org-last-inserted-timestamp -1))))))
13372 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13374 (defun org-get-scheduled-time (pom &optional inherit)
13375 "Get the scheduled time as a time tuple, of a format suitable
13376 for calling org-schedule with, or if there is no scheduling,
13378 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13380 (apply 'encode-time (org-parse-time-string time)))))
13382 (defun org-get-deadline-time (pom &optional inherit)
13383 "Get the deadline as a time tuple, of a format suitable for
13384 calling org-deadline with, or if there is no scheduling, returns
13386 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13388 (apply 'encode-time (org-parse-time-string time)))))
13390 (defun org-remove-timestamp-with-keyword (keyword)
13391 "Remove all time stamps with KEYWORD in the current entry."
13392 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13395 (org-back-to-heading t)
13397 (outline-next-heading)
13398 (while (re-search-backward re beg t)
13400 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13401 (equal (char-before) ?\ ))
13402 (backward-delete-char 1)
13403 (if (string-match "^[ \t]*$" (buffer-substring
13404 (point-at-bol) (point-at-eol)))
13405 (delete-region (point-at-bol)
13406 (min (point-max) (1+ (point-at-eol))))))))))
13408 (defvar org-time-was-given) ; dynamically scoped parameter
13409 (defvar org-end-time-was-given) ; dynamically scoped parameter
13411 (defun org-add-planning-info (what &optional time &rest remove)
13412 "Insert new timestamp with keyword in the line directly after the headline.
13413 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13414 If non is given, the user is prompted for a date.
13415 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13418 (let (org-time-was-given org-end-time-was-given ts
13419 end default-time default-input)
13422 (when (and (memq what '(scheduled deadline))
13424 (and (stringp time)
13425 (string-match "^[-+]+[0-9]" time))))
13426 ;; Try to get a default date/time from existing timestamp
13428 (org-back-to-heading t)
13429 (setq end (save-excursion (outline-next-heading) (point)))
13430 (when (re-search-forward (if (eq what 'scheduled)
13431 org-scheduled-time-regexp
13432 org-deadline-time-regexp)
13434 (setq ts (match-string 1)
13436 (apply 'encode-time (org-parse-time-string ts))
13437 default-input (and ts (org-get-compact-tod ts))))))
13441 ;; This is a string (relative or absolute), set proper date
13442 (apply 'encode-time
13443 (org-read-date-analyze
13444 time default-time (decode-time default-time)))
13445 ;; If necessary, get the time from the user
13446 (or time (org-read-date nil 'to-time nil nil
13447 default-time default-input)))))
13449 (when (and org-insert-labeled-timestamps-at-point
13450 (member what '(scheduled deadline)))
13452 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13453 (org-insert-time-stamp time org-time-was-given
13454 nil nil nil (list org-end-time-was-given))
13458 (let (col list elt ts buffer-invisibility-spec)
13459 (org-back-to-heading t)
13460 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13461 (goto-char (match-end 1))
13462 (setq col (current-column))
13463 (goto-char (match-end 0))
13464 (if (eobp) (insert "\n") (forward-char 1))
13465 (when (and (not what)
13468 org-keyword-time-not-clock-regexp))))
13469 ;; Nothing to add, nothing to remove...... :-)
13471 (if (and (not (looking-at org-outline-regexp))
13472 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13474 (not (equal (match-string 1) org-clock-string)))
13475 (narrow-to-region (match-beginning 0) (match-end 0))
13476 (insert-before-markers "\n")
13478 (narrow-to-region (point) (point))
13479 (and org-adapt-indentation (org-indent-to-column col)))
13480 ;; Check if we have to remove something.
13481 (setq list (cons what remove))
13483 (setq elt (pop list))
13484 (when (or (and (eq elt 'scheduled)
13485 (re-search-forward org-scheduled-time-regexp nil t))
13486 (and (eq elt 'deadline)
13487 (re-search-forward org-deadline-time-regexp nil t))
13488 (and (eq elt 'closed)
13489 (re-search-forward org-closed-time-regexp nil t)))
13491 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13492 (and (looking-at "[ \t]+") (replace-match ""))
13493 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13496 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13497 (cond ((eq what 'scheduled) org-scheduled-string)
13498 ((eq what 'deadline) org-deadline-string)
13499 ((eq what 'closed) org-closed-string))
13501 (setq ts (org-insert-time-stamp
13503 (or org-time-was-given
13504 (and (eq what 'closed) org-log-done-with-time))
13506 nil nil (list org-end-time-was-given)))
13508 (if (not (or (bolp) (eq (char-before) ?\ )
13509 (memq (char-after) '(32 10))
13512 (goto-char (point-min))
13514 (if (and (looking-at "[ \t]*\n")
13515 (equal (char-before) ?\n))
13516 (delete-region (1- (point)) (point-at-eol)))
13519 (defvar org-log-note-marker (make-marker))
13520 (defvar org-log-note-purpose nil)
13521 (defvar org-log-note-state nil)
13522 (defvar org-log-note-previous-state nil)
13523 (defvar org-log-note-extra nil)
13524 (defvar org-log-note-window-configuration nil)
13525 (defvar org-log-note-return-to (make-marker))
13526 (defvar org-log-note-effective-time nil
13527 "Remembered current time so that dynamically scoped
13528 `org-extend-today-until' affects tha timestamps in state change
13531 (defvar org-log-post-message nil
13532 "Message to be displayed after a log note has been stored.
13533 The auto-repeater uses this.")
13535 (defun org-add-note ()
13536 "Add a note to the current entry.
13537 This is done in the same way as adding a state change note."
13539 (org-add-log-setup 'note nil nil 'findpos nil))
13541 (defvar org-property-end-re)
13542 (defun org-add-log-setup (&optional purpose state prev-state
13544 "Set up the post command hook to take a note.
13545 If this is about to TODO state change, the new state is expected in STATE.
13546 When FINDPOS is non-nil, find the correct position for the note in
13547 the current entry. If not, assume that it can be inserted at point.
13548 HOW is an indicator what kind of note should be created.
13549 EXTRA is additional text that will be inserted into the notes buffer."
13550 (let* ((org-log-into-drawer (org-log-into-drawer))
13551 (drawer (cond ((stringp org-log-into-drawer)
13552 org-log-into-drawer)
13553 (org-log-into-drawer "LOGBOOK"))))
13557 (org-back-to-heading t)
13558 (narrow-to-region (point) (save-excursion
13559 (outline-next-heading) (point)))
13560 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13561 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13563 (goto-char (match-end 0))
13566 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13569 (goto-char (match-end 0))
13570 (or org-log-states-order-reversed
13571 (and (re-search-forward org-property-end-re nil t)
13572 (goto-char (1- (match-beginning 0))))))
13573 (insert "\n:" drawer ":\n:END:")
13574 (beginning-of-line 0)
13576 (beginning-of-line 2)
13579 ((and org-log-state-notes-insert-after-drawers
13581 (forward-line) (looking-at org-drawer-regexp)))
13583 (while (looking-at org-drawer-regexp)
13584 (goto-char (match-end 0))
13585 (re-search-forward org-property-end-re (point-max) t)
13587 (forward-line -1)))
13588 (unless org-log-states-order-reversed
13589 (and (= (char-after) ?\n) (forward-char 1))
13590 (org-skip-over-state-notes)
13591 (skip-chars-backward " \t\n\r")))
13592 (move-marker org-log-note-marker (point))
13593 (setq org-log-note-purpose purpose
13594 org-log-note-state state
13595 org-log-note-previous-state prev-state
13596 org-log-note-how how
13597 org-log-note-extra extra
13598 org-log-note-effective-time (org-current-effective-time))
13599 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13601 (defun org-skip-over-state-notes ()
13602 "Skip past the list of State notes in an entry."
13603 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13604 (when (ignore-errors (goto-char (org-in-item-p)))
13605 (let* ((struct (org-list-struct))
13606 (prevs (org-list-prevs-alist struct)))
13607 (while (looking-at "[ \t]*- State")
13608 (goto-char (or (org-list-get-next-item (point) struct prevs)
13609 (org-list-get-item-end (point) struct)))))))
13611 (defun org-add-log-note (&optional purpose)
13612 "Pop up a window for taking a note, and add this note later at point."
13613 (remove-hook 'post-command-hook 'org-add-log-note)
13614 (setq org-log-note-window-configuration (current-window-configuration))
13615 (delete-other-windows)
13616 (move-marker org-log-note-return-to (point))
13617 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13618 (goto-char org-log-note-marker)
13619 (org-switch-to-buffer-other-window "*Org Note*")
13621 (if (memq org-log-note-how '(time state))
13622 (let (current-prefix-arg) (org-store-log-note))
13623 (let ((org-inhibit-startup t)) (org-mode))
13624 (insert (format "# Insert note for %s.
13625 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13627 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13628 ((eq org-log-note-purpose 'done) "closed todo item")
13629 ((eq org-log-note-purpose 'state)
13630 (format "state change from \"%s\" to \"%s\""
13631 (or org-log-note-previous-state "")
13632 (or org-log-note-state "")))
13633 ((eq org-log-note-purpose 'reschedule)
13635 ((eq org-log-note-purpose 'delschedule)
13636 "no longer scheduled")
13637 ((eq org-log-note-purpose 'redeadline)
13638 "changing deadline")
13639 ((eq org-log-note-purpose 'deldeadline)
13640 "removing deadline")
13641 ((eq org-log-note-purpose 'refile)
13643 ((eq org-log-note-purpose 'note)
13645 (t (error "This should not happen")))))
13646 (if org-log-note-extra (insert org-log-note-extra))
13647 (org-set-local 'org-finish-function 'org-store-log-note)
13648 (run-hooks 'org-log-buffer-setup-hook)))
13650 (defvar org-note-abort nil) ; dynamically scoped
13651 (defun org-store-log-note ()
13652 "Finish taking a log note, and insert it to where it belongs."
13653 (let ((txt (buffer-string)))
13654 (kill-buffer (current-buffer))
13655 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13657 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13658 (setq txt (replace-match "" t t txt)))
13659 (if (string-match "\\s-+\\'" txt)
13660 (setq txt (replace-match "" t t txt)))
13661 (setq lines (org-split-string txt "\n"))
13662 (when (and note (string-match "\\S-" note))
13664 (org-replace-escapes
13666 (list (cons "%u" (user-login-name))
13667 (cons "%U" user-full-name)
13668 (cons "%t" (format-time-string
13669 (org-time-stamp-format 'long 'inactive)
13670 org-log-note-effective-time))
13671 (cons "%T" (format-time-string
13672 (org-time-stamp-format 'long nil)
13673 org-log-note-effective-time))
13674 (cons "%d" (format-time-string
13675 (org-time-stamp-format nil 'inactive)
13676 org-log-note-effective-time))
13677 (cons "%D" (format-time-string
13678 (org-time-stamp-format nil nil)
13679 org-log-note-effective-time))
13680 (cons "%s" (if org-log-note-state
13681 (concat "\"" org-log-note-state "\"")
13683 (cons "%S" (if org-log-note-previous-state
13684 (concat "\"" org-log-note-previous-state "\"")
13686 (if lines (setq note (concat note " \\\\")))
13688 (when (or current-prefix-arg org-note-abort)
13689 (when org-log-into-drawer
13690 (org-remove-empty-drawer-at org-log-note-marker))
13693 (with-current-buffer (marker-buffer org-log-note-marker)
13695 (goto-char org-log-note-marker)
13696 (move-marker org-log-note-marker nil)
13698 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13699 (setq ind (save-excursion
13700 (if (ignore-errors (goto-char (org-in-item-p)))
13701 (let ((struct (org-list-struct)))
13703 (org-list-get-top-point struct) struct))
13704 (skip-chars-backward " \r\t\n")
13706 ((and (org-at-heading-p)
13707 org-adapt-indentation)
13708 (1+ (org-current-level)))
13709 ((org-at-heading-p) 0)
13710 (t (org-get-indentation))))))
13711 (setq bul (org-list-bullet-string "-"))
13712 (org-indent-line-to ind)
13713 (insert bul (pop lines))
13714 (let ((ind-body (+ (length bul) ind)))
13717 (org-indent-line-to ind-body)
13718 (insert (pop lines))))
13719 (message "Note stored")
13720 (org-back-to-heading t)
13721 (org-cycle-hide-drawers 'children))
13722 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13723 ;; from within `org-add-log-note' because `buffer-undo-list'
13724 ;; is then modified outside of `org-with-remote-undo'.
13725 (when (eq this-command 'org-agenda-todo)
13726 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13727 ;; Don't add undo information when called from `org-agenda-todo'
13728 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13729 (set-window-configuration org-log-note-window-configuration)
13730 (with-current-buffer (marker-buffer org-log-note-return-to)
13731 (goto-char org-log-note-return-to))
13732 (move-marker org-log-note-return-to nil)
13733 (and org-log-post-message (message "%s" org-log-post-message))))
13735 (defun org-remove-empty-drawer-at (pos)
13736 "Remove an empty drawer at position POS.
13737 POS may also be a marker."
13738 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13739 (org-with-wide-buffer
13741 (let ((drawer (org-element-at-point)))
13742 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13743 (not (org-element-property :contents-begin drawer)))
13744 (delete-region (org-element-property :begin drawer)
13745 (progn (goto-char (org-element-property :end drawer))
13746 (skip-chars-backward " \r\t\n")
13750 (defvar org-ts-type nil)
13751 (defun org-sparse-tree (&optional arg type)
13752 "Create a sparse tree, prompt for the details.
13753 This command can create sparse trees. You first need to select the type
13754 of match used to create the tree:
13756 t Show all TODO entries.
13757 T Show entries with a specific TODO keyword.
13758 m Show entries selected by a tags/property match.
13759 p Enter a property name and its value (both with completion on existing
13760 names/values) and show entries with that property.
13761 r Show entries matching a regular expression (`/' can be used as well).
13762 b Show deadlines and scheduled items before a date.
13763 a Show deadlines and scheduled items after a date.
13764 d Show deadlines due within `org-deadline-warning-days'.
13765 D Show deadlines and scheduled items between a date range."
13767 (setq type (or type org-sparse-tree-default-date-type))
13768 (setq org-ts-type type)
13769 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty
13770 [d]eadlines [b]efore-date [a]fter-date [D]ates range
13771 [c]ycle through date types: %s"
13773 (all "all timestamps")
13774 (scheduled "only scheduled")
13775 (deadline "only deadline")
13776 (active "only active timestamps")
13777 (inactive "only inactive timestamps")
13778 (scheduled-or-deadline "scheduled/deadline")
13779 (closed "with a closed time-stamp")
13780 (otherwise "scheduled/deadline")))
13781 (let ((answer (read-char-exclusive)))
13786 (cadr (memq type '(scheduled-or-deadline all scheduled deadline active
13787 inactive closed)))))
13788 (?d (call-interactively 'org-check-deadlines))
13789 (?b (call-interactively 'org-check-before-date))
13790 (?a (call-interactively 'org-check-after-date))
13791 (?D (call-interactively 'org-check-dates-range))
13792 (?t (call-interactively 'org-show-todo-tree))
13793 (?T (org-show-todo-tree '(4)))
13794 (?m (call-interactively 'org-match-sparse-tree))
13796 (let* ((kwd (org-icompleting-read
13797 "Property: " (mapcar 'list (org-buffer-property-keys))))
13798 (value (org-icompleting-read
13799 "Value: " (mapcar 'list (org-property-values kwd)))))
13800 (unless (string-match "\\`{.*}\\'" value)
13801 (setq value (concat "\"" value "\"")))
13802 (org-match-sparse-tree arg (concat kwd "=" value))))
13803 ((?r ?R ?/) (call-interactively 'org-occur))
13804 (otherwise (user-error "No such sparse tree command \"%c\"" answer)))))
13806 (defvar org-occur-highlights nil
13807 "List of overlays used for occur matches.")
13808 (make-variable-buffer-local 'org-occur-highlights)
13809 (defvar org-occur-parameters nil
13810 "Parameters of the active org-occur calls.
13811 This is a list, each call to org-occur pushes as cons cell,
13812 containing the regular expression and the callback, onto the list.
13813 The list can contain several entries if `org-occur' has been called
13814 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13815 will only contain one set of parameters. When the highlights are
13816 removed (for example with `C-c C-c', or with the next edit (depending
13817 on `org-remove-highlights-with-change'), this variable is emptied
13819 (make-variable-buffer-local 'org-occur-parameters)
13821 (defun org-occur (regexp &optional keep-previous callback)
13822 "Make a compact tree which shows all matches of REGEXP.
13823 The tree will show the lines where the regexp matches, and all higher
13824 headlines above the match. It will also show the heading after the match,
13825 to make sure editing the matching entry is easy.
13826 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13827 call to `org-occur' will be kept, to allow stacking of calls to this
13829 If CALLBACK is non-nil, it is a function which is called to confirm
13830 that the match should indeed be shown."
13831 (interactive "sRegexp: \nP")
13832 (when (equal regexp "")
13833 (user-error "Regexp cannot be empty"))
13834 (unless keep-previous
13835 (org-remove-occur-highlights nil nil t))
13836 (push (cons regexp callback) org-occur-parameters)
13839 (goto-char (point-min))
13840 (if (or (not keep-previous) ; do not want to keep
13841 (not org-occur-highlights)) ; no previous matches
13844 (while (re-search-forward regexp nil t)
13845 (when (or (not callback)
13846 (save-match-data (funcall callback)))
13847 (setq cnt (1+ cnt))
13848 (when org-highlight-sparse-tree-matches
13849 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13850 (org-show-context 'occur-tree))))
13851 (when org-remove-highlights-with-change
13852 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13854 (unless org-sparse-tree-open-archived-trees
13855 (org-hide-archived-subtrees (point-min) (point-max)))
13856 (run-hooks 'org-occur-hook)
13857 (if (org-called-interactively-p 'interactive)
13858 (message "%d match(es) for regexp %s" cnt regexp))
13861 (defun org-occur-next-match (&optional n reset)
13862 "Function for `next-error-function' to find sparse tree matches.
13863 N is the number of matches to move, when negative move backwards.
13864 RESET is entirely ignored - this function always goes back to the
13865 starting point when no match is found."
13866 (let* ((limit (if (< n 0) (point-min) (point-max)))
13867 (search-func (if (< n 0)
13868 'previous-single-char-property-change
13869 'next-single-char-property-change))
13874 (while (setq p1 (funcall search-func (point) 'org-type))
13875 (when (equal p1 limit)
13877 (user-error "No more matches"))
13878 (when (equal (get-char-property p1 'org-type) 'org-occur)
13882 (throw 'exit (point))))
13885 (user-error "No more matches"))))
13887 (defun org-show-context (&optional key)
13888 "Make sure point and context are visible.
13889 How much context is shown depends upon the variables
13890 `org-show-hierarchy-above', `org-show-following-heading',
13891 `org-show-entry-below' and `org-show-siblings'."
13892 (let ((heading-p (org-at-heading-p t))
13893 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13894 (following-p (org-get-alist-option org-show-following-heading key))
13895 (entry-p (org-get-alist-option org-show-entry-below key))
13896 (siblings-p (org-get-alist-option org-show-siblings key)))
13897 ;; Show heading or entry text
13898 (if (and heading-p (not entry-p))
13899 (org-flag-heading nil) ; only show the heading
13900 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13901 (org-show-hidden-entry))) ; show entire entry
13903 ;; Show next sibling, or heading below text
13905 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13906 (org-flag-heading nil))))
13907 (when siblings-p (org-show-siblings))
13909 ;; show all higher headings, possibly with siblings
13911 (while (and (ignore-errors (progn (org-up-heading-all 1) t))
13913 (org-flag-heading nil)
13914 (when siblings-p (org-show-siblings)))))))
13916 (defvar org-reveal-start-hook nil
13917 "Hook run before revealing a location.")
13919 (defun org-reveal (&optional siblings)
13920 "Show current entry, hierarchy above it, and the following headline.
13921 This can be used to show a consistent set of context around locations
13922 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13923 not t for the search context.
13925 With optional argument SIBLINGS, on each level of the hierarchy all
13926 siblings are shown. This repairs the tree structure to what it would
13927 look like when opened with hierarchical calls to `org-cycle'.
13928 With double optional argument \\[universal-argument] \\[universal-argument], \
13929 go to the parent and show the
13932 (run-hooks 'org-reveal-start-hook)
13933 (let ((org-show-hierarchy-above t)
13934 (org-show-following-heading t)
13935 (org-show-siblings (if siblings t org-show-siblings)))
13936 (org-show-context nil))
13937 (when (equal siblings '(16))
13939 (when (org-up-heading-safe)
13941 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13943 (defun org-highlight-new-match (beg end)
13944 "Highlight from BEG to END and mark the highlight is an occur headline."
13945 (let ((ov (make-overlay beg end)))
13946 (overlay-put ov 'face 'secondary-selection)
13947 (overlay-put ov 'org-type 'org-occur)
13948 (push ov org-occur-highlights)))
13950 (defun org-remove-occur-highlights (&optional beg end noremove)
13951 "Remove the occur highlights from the buffer.
13952 BEG and END are ignored. If NOREMOVE is nil, remove this function
13953 from the `before-change-functions' in the current buffer."
13955 (unless org-inhibit-highlight-removal
13956 (mapc 'delete-overlay org-occur-highlights)
13957 (setq org-occur-highlights nil)
13958 (setq org-occur-parameters nil)
13960 (remove-hook 'before-change-functions
13961 'org-remove-occur-highlights 'local))))
13965 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13966 "Regular expression matching the priority indicator.")
13968 (defvar org-remove-priority-next-time nil)
13970 (defun org-priority-up ()
13971 "Increase the priority of the current item."
13973 (org-priority 'up))
13975 (defun org-priority-down ()
13976 "Decrease the priority of the current item."
13978 (org-priority 'down))
13980 (defun org-priority (&optional action show)
13981 "Change the priority of an item.
13982 ACTION can be `set', `up', `down', or a character."
13984 (if (equal action '(4))
13985 (org-show-priority)
13986 (unless org-enable-priority-commands
13987 (user-error "Priority commands are disabled"))
13988 (setq action (or action 'set))
13989 (let (current new news have remove)
13991 (org-back-to-heading t)
13992 (if (looking-at org-priority-regexp)
13993 (setq current (string-to-char (match-string 2))
13996 ((eq action 'remove)
13997 (setq remove t new ?\ ))
13998 ((or (eq action 'set)
13999 (if (featurep 'xemacs) (characterp action) (integerp action)))
14000 (if (not (eq action 'set))
14002 (message "Priority %c-%c, SPC to remove: "
14003 org-highest-priority org-lowest-priority)
14005 (setq new (read-char-exclusive))))
14006 (if (and (= (upcase org-highest-priority) org-highest-priority)
14007 (= (upcase org-lowest-priority) org-lowest-priority))
14008 (setq new (upcase new)))
14009 (cond ((equal new ?\ ) (setq remove t))
14010 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
14011 (user-error "Priority must be between `%c' and `%c'"
14012 org-highest-priority org-lowest-priority))))
14015 (1- current) ; normal cycling
14016 ;; last priority was empty
14017 (if (eq last-command this-command)
14018 org-lowest-priority ; wrap around empty to lowest
14020 (if org-priority-start-cycle-with-default
14021 org-default-priority
14022 (1- org-default-priority))))))
14025 (1+ current) ; normal cycling
14026 ;; last priority was empty
14027 (if (eq last-command this-command)
14028 org-highest-priority ; wrap around empty to highest
14030 (if org-priority-start-cycle-with-default
14031 org-default-priority
14032 (1+ org-default-priority))))))
14033 (t (user-error "Invalid action")))
14034 (if (or (< (upcase new) org-highest-priority)
14035 (> (upcase new) org-lowest-priority))
14036 (if (and (memq action '(up down))
14037 (not have) (not (eq last-command this-command)))
14038 ;; `new' is from default priority
14040 "The default can not be set, see `org-default-priority' why")
14041 ;; normal cycling: `new' is beyond highest/lowest priority
14042 ;; and is wrapped around to the empty priority
14044 (setq news (format "%c" new))
14047 (replace-match "" t t nil 1)
14048 (replace-match news t t nil 2))
14050 (user-error "No priority cookie found in line")
14051 (let ((case-fold-search nil))
14052 (looking-at org-todo-line-regexp))
14055 (goto-char (match-end 2))
14056 (insert " [#" news "]"))
14057 (goto-char (match-beginning 3))
14058 (insert "[#" news "] "))))
14059 (org-set-tags nil 'align))
14061 (message "Priority removed")
14062 (message "Priority of current item set to %s" news)))))
14064 (defun org-show-priority ()
14065 "Show the priority of the current item.
14066 This priority is composed of the main priority given with the [#A] cookies,
14067 and by additional input from the age of a schedules or deadline entry."
14069 (let ((pri (if (eq major-mode 'org-agenda-mode)
14070 (org-get-at-bol 'priority)
14073 (beginning-of-line)
14074 (and (looking-at org-heading-regexp)
14075 (org-get-priority (match-string 0))))))))
14076 (message "Priority is %d" (if pri pri -1000))))
14078 (defun org-get-priority (s)
14079 "Find priority cookie and return priority."
14081 (if (functionp org-get-priority-function)
14082 (funcall org-get-priority-function)
14083 (if (not (string-match org-priority-regexp s))
14084 (* 1000 (- org-lowest-priority org-default-priority))
14085 (* 1000 (- org-lowest-priority
14086 (string-to-char (match-string 2 s))))))))
14090 (defvar org-agenda-archives-mode)
14091 (defvar org-map-continue-from nil
14092 "Position from where mapping should continue.
14093 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
14095 (defvar org-scanner-tags nil
14096 "The current tag list while the tags scanner is running.")
14097 (defvar org-trust-scanner-tags nil
14098 "Should `org-get-tags-at' use the tags for the scanner.
14099 This is for internal dynamical scoping only.
14100 When this is non-nil, the function `org-get-tags-at' will return the value
14101 of `org-scanner-tags' instead of building the list by itself. This
14102 can lead to large speed-ups when the tags scanner is used in a file with
14103 many entries, and when the list of tags is retrieved, for example to
14104 obtain a list of properties. Building the tags list for each entry in such
14105 a file becomes an N^2 operation - but with this variable set, it scales
14108 (defun org-scan-tags (action matcher todo-only &optional start-level)
14109 "Scan headline tags with inheritance and produce output ACTION.
14111 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
14112 or `agenda' to produce an entry list for an agenda view. It can also be
14113 a Lisp form or a function that should be called at each matched headline, in
14114 this case the return value is a list of all return values from these calls.
14116 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
14117 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
14118 only lines with a not-done TODO keyword are included in the output.
14119 This should be the same variable that was scoped into
14120 and set by `org-make-tags-matcher' when it constructed MATCHER.
14122 START-LEVEL can be a string with asterisks, reducing the scope to
14123 headlines matching this string."
14124 (require 'org-agenda)
14125 (let* ((re (concat "^"
14127 ;; Get the correct level to match
14128 (concat "\\*\\{" (number-to-string start-level) "\\} ")
14129 org-outline-regexp)
14131 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
14132 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
14133 (props (list 'face 'default
14134 'done-face 'org-agenda-done
14135 'undone-face 'default
14136 'mouse-face 'highlight
14137 'org-not-done-regexp org-not-done-regexp
14138 'org-todo-regexp org-todo-regexp
14139 'org-complex-heading-regexp org-complex-heading-regexp
14141 (format "mouse-2 or RET jump to org file %s"
14142 (abbreviate-file-name
14143 (or (buffer-file-name (buffer-base-buffer))
14144 (buffer-name (buffer-base-buffer)))))))
14145 (org-map-continue-from nil)
14146 lspos tags tags-list
14147 (tags-alist (list (cons 0 org-file-tags)))
14148 (llast 0) rtn rtn1 level category i txt
14149 todo marker entry priority)
14150 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
14151 (setq action (list 'lambda nil action)))
14153 (goto-char (point-min))
14154 (when (eq action 'sparse-tree)
14156 (org-remove-occur-highlights))
14157 (while (let (case-fold-search)
14158 (re-search-forward re nil t))
14159 (setq org-map-continue-from nil)
14161 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
14162 tags (if (match-end 4) (org-match-string-no-properties 4)))
14163 (goto-char (setq lspos (match-beginning 0)))
14164 (setq level (org-reduced-level (org-outline-level))
14165 category (org-get-category))
14166 (setq i llast llast level)
14167 ;; remove tag lists from same and sublevels
14168 (while (>= i level)
14169 (when (setq entry (assoc i tags-alist))
14170 (setq tags-alist (delete entry tags-alist)))
14172 ;; add the next tags
14174 (setq tags (org-split-string tags ":")
14176 (cons (cons level tags) tags-alist)))
14177 ;; compile tags for current headline
14179 (if org-use-tag-inheritance
14180 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14182 org-scanner-tags tags-list)
14183 (when org-use-tag-inheritance
14184 (setcdr (car tags-alist)
14185 (mapcar (lambda (x)
14186 (setq x (copy-sequence x))
14187 (org-add-prop-inherited x))
14188 (cdar tags-alist))))
14189 (when (and tags org-use-tag-inheritance
14190 (or (not (eq t org-use-tag-inheritance))
14191 org-tags-exclude-from-inheritance))
14192 ;; selective inheritance, remove uninherited ones
14193 (setcdr (car tags-alist)
14194 (org-remove-uninherited-tags (cdar tags-alist))))
14197 ;; eval matcher only when the todo condition is OK
14198 (and (or (not todo-only) (member todo org-not-done-keywords))
14199 (let ((case-fold-search t) (org-trust-scanner-tags t))
14202 ;; Call the skipper, but return t if it does not skip,
14203 ;; so that the `and' form continues evaluating
14205 (unless (eq action 'sparse-tree) (org-agenda-skip))
14208 ;; Check if timestamps are deselecting this entry
14209 (or (not todo-only)
14210 (and (member todo org-not-done-keywords)
14211 (or (not org-agenda-tags-todo-honor-ignore-options)
14212 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14214 ;; select this headline
14216 ((eq action 'sparse-tree)
14217 (and org-highlight-sparse-tree-matches
14218 (org-get-heading) (match-end 0)
14219 (org-highlight-new-match
14220 (match-beginning 1) (match-end 1)))
14221 (org-show-context 'tags-tree))
14222 ((eq action 'agenda)
14223 (setq txt (org-agenda-format-item
14226 (if (eq org-tags-match-list-sublevels 'indented)
14227 (make-string (1- level) ?.) "")
14231 priority (org-get-priority txt))
14233 (setq marker (org-agenda-new-marker))
14234 (org-add-props txt props
14235 'org-marker marker 'org-hd-marker marker 'org-category category
14237 'priority priority 'type "tagsmatch")
14239 ((functionp action)
14240 (setq org-map-continue-from nil)
14242 (setq rtn1 (funcall action))
14244 (t (user-error "Invalid action")))
14246 ;; if we are to skip sublevels, jump to end of subtree
14247 (unless org-tags-match-list-sublevels
14248 (org-end-of-subtree t)
14249 (backward-char 1))))
14250 ;; Get the correct position from where to continue
14251 (if org-map-continue-from
14252 (goto-char org-map-continue-from)
14253 (and (= (point) lspos) (end-of-line 1)))))
14254 (when (and (eq action 'sparse-tree)
14255 (not org-sparse-tree-open-archived-trees))
14256 (org-hide-archived-subtrees (point-min) (point-max)))
14259 (defun org-remove-uninherited-tags (tags)
14260 "Remove all tags that are not inherited from the list TAGS."
14262 ((eq org-use-tag-inheritance t)
14263 (if org-tags-exclude-from-inheritance
14264 (org-delete-all org-tags-exclude-from-inheritance tags)
14266 ((not org-use-tag-inheritance) nil)
14267 ((stringp org-use-tag-inheritance)
14270 (if (and (string-match org-use-tag-inheritance x)
14271 (not (member x org-tags-exclude-from-inheritance)))
14274 ((listp org-use-tag-inheritance)
14277 (if (member x org-use-tag-inheritance) x nil))
14280 (defun org-match-sparse-tree (&optional todo-only match)
14281 "Create a sparse tree according to tags string MATCH.
14282 MATCH can contain positive and negative selection of tags, like
14283 \"+WORK+URGENT-WITHBOSS\".
14284 If optional argument TODO-ONLY is non-nil, only select lines that are
14287 (org-agenda-prepare-buffers (list (current-buffer)))
14288 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14290 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14292 (defvar org-cached-props nil)
14293 (defun org-cached-entry-get (pom property)
14294 (if (or (eq t org-use-property-inheritance)
14295 (and (stringp org-use-property-inheritance)
14296 (string-match org-use-property-inheritance property))
14297 (and (listp org-use-property-inheritance)
14298 (member property org-use-property-inheritance)))
14299 ;; Caching is not possible, check it directly
14300 (org-entry-get pom property 'inherit)
14301 ;; Get all properties, so that we can do complicated checks easily
14302 (cdr (assoc property (or org-cached-props
14303 (setq org-cached-props
14304 (org-entry-properties pom)))))))
14306 (defun org-global-tags-completion-table (&optional files)
14307 "Return the list of all tags in all agenda buffer/files.
14308 Optional FILES argument is a list of files which can be used
14309 instead of the agenda files."
14316 (set-buffer (find-file-noselect file))
14317 (append (org-get-buffer-tags)
14318 (mapcar (lambda (x) (if (stringp (car-safe x))
14319 (list (car-safe x)) nil))
14321 (if (and files (car files))
14323 (org-agenda-files))))))))
14325 (defun org-make-tags-matcher (match)
14326 "Create the TAGS/TODO matcher form for the selection string MATCH.
14328 The variable `todo-only' is scoped dynamically into this function.
14329 It will be set to t if the matcher restricts matching to TODO entries,
14330 otherwise will not be touched.
14332 Returns a cons of the selection string MATCH and the constructed
14333 lisp form implementing the matcher. The matcher is to be evaluated
14334 at an Org entry, with point on the headline, and returns t if the
14335 entry matches the selection string MATCH. The returned lisp form
14336 references two variables with information about the entry, which
14337 must be bound around the form's evaluation: todo, the TODO keyword
14338 at the entry (or nil of none); and tags-list, the list of all tags
14339 at the entry including inherited ones. Additionally, the category
14340 of the entry (if any) must be specified as the text property
14341 'org-category on the headline.
14343 See also `org-scan-tags'.
14345 (declare (special todo-only))
14346 (unless (boundp 'todo-only)
14347 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14349 ;; Get a new match request, with completion against the global
14350 ;; tags table and the local tags in current buffer
14351 (let ((org-last-tags-completion-table
14353 (delq nil (append (org-get-buffer-tags)
14354 (org-global-tags-completion-table))))))
14355 (setq match (org-completing-read-no-i
14356 "Match: " 'org-tags-completion-function nil nil nil
14357 'org-tags-history))))
14359 ;; Parse the string and create a lisp form
14360 (let ((match0 match)
14361 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14363 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14364 orterms term orlist re-p str-p level-p level-op time-p
14365 prop-p pn pv po gv rest (start 0) (ss 0))
14366 ;; Expand group tags
14367 (setq match (org-tags-expand match))
14369 ;; Check if there is a TODO part of this match, which would be the
14370 ;; part after a "/". TO make sure that this slash is not part of
14371 ;; a property value to be matched against, we also check that there
14372 ;; is no " after that slash.
14373 ;; First, find the last slash
14374 (while (string-match "/+" match ss)
14375 (setq start (match-beginning 0) ss (match-end 0)))
14376 (if (and (string-match "/+" match start)
14377 (not (save-match-data (string-match "\"" match start))))
14378 ;; match contains also a todo-matching request
14380 (setq tagsmatch (substring match 0 (match-beginning 0))
14381 todomatch (substring match (match-end 0)))
14382 (if (string-match "^!" todomatch)
14383 (setq todo-only t todomatch (substring todomatch 1)))
14384 (if (string-match "^\\s-*$" todomatch)
14385 (setq todomatch nil)))
14386 ;; only matching tags
14387 (setq tagsmatch match todomatch nil))
14389 ;; Make the tags matcher
14390 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14391 (setq tagsmatcher t)
14392 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14393 (while (setq term (pop orterms))
14394 (while (and (equal (substring term -1) "\\") orterms)
14395 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14396 (while (string-match re term)
14397 (setq rest (substring term (match-end 0))
14398 minus (and (match-end 1)
14399 (equal (match-string 1 term) "-"))
14400 tag (save-match-data (replace-regexp-in-string
14402 (match-string 2 term)))
14403 re-p (equal (string-to-char tag) ?{)
14404 level-p (match-end 4)
14405 prop-p (match-end 5)
14407 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14409 (setq level-op (org-op-to-function (match-string 3 term)))
14410 `(,level-op level ,(string-to-number
14411 (match-string 4 term))))
14413 (setq pn (match-string 5 term)
14414 po (match-string 6 term)
14415 pv (match-string 7 term)
14416 re-p (equal (string-to-char pv) ?{)
14417 str-p (equal (string-to-char pv) ?\")
14418 time-p (save-match-data
14419 (string-match "^\"[[<].*[]>]\"$" pv))
14420 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14421 (if time-p (setq pv (org-matcher-time pv)))
14422 (setq po (org-op-to-function po (if time-p 'time str-p)))
14424 ((equal pn "CATEGORY")
14425 (setq gv '(get-text-property (point) 'org-category)))
14429 (setq gv `(org-cached-entry-get nil ,pn))))
14432 `(not (string-match ,pv (or ,gv "")))
14433 `(string-match ,pv (or ,gv "")))
14435 `(,po (or ,gv "") ,pv)
14436 `(,po (string-to-number (or ,gv ""))
14437 ,(string-to-number pv) ))))
14438 (t `(member ,tag tags-list)))
14439 mm (if minus (list 'not mm) mm)
14441 (push mm tagsmatcher))
14442 (push (if (> (length tagsmatcher) 1)
14443 (cons 'and tagsmatcher)
14446 (setq tagsmatcher nil))
14447 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14449 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14450 ;; Make the todo matcher
14451 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14452 (setq todomatcher t)
14453 (setq orterms (org-split-string todomatch "|") orlist nil)
14454 (while (setq term (pop orterms))
14455 (while (string-match re term)
14456 (setq minus (and (match-end 1)
14457 (equal (match-string 1 term) "-"))
14458 kwd (match-string 2 term)
14459 re-p (equal (string-to-char kwd) ?{)
14460 term (substring term (match-end 0))
14462 `(string-match ,(substring kwd 1 -1) todo)
14463 (list 'equal 'todo kwd))
14464 mm (if minus (list 'not mm) mm))
14465 (push mm todomatcher))
14466 (push (if (> (length todomatcher) 1)
14467 (cons 'and todomatcher)
14470 (setq todomatcher nil))
14471 (setq todomatcher (if (> (length orlist) 1)
14472 (cons 'or orlist) (car orlist))))
14474 ;; Return the string and lisp forms of the matcher
14475 (setq matcher (if todomatcher
14476 (list 'and tagsmatcher todomatcher)
14479 (setq matcher (list 'and '(member todo org-not-done-keywords)
14481 (cons match0 matcher)))
14483 (defun org-tags-expand (match &optional single-as-list downcased)
14484 "Expand group tags in MATCH.
14486 This replaces every group tag in MATCH with a regexp tag search.
14487 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14488 will be replaced like this:
14490 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14491 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14492 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14494 Replacing by a regexp preserves the structure of the match.
14495 E.g., this expansion
14497 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14499 will match anything tagged with \"Lab\" and \"Home\", or tagged
14500 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14502 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14503 assumed to be a single group tag, and the function will return
14504 the list of tags in this group.
14506 When DOWNCASE is non-nil, expand downcased TAGS."
14508 (let* ((case-fold-search t)
14509 (stable org-mode-syntax-table)
14510 (tal (or org-tag-groups-alist-for-agenda
14511 org-tag-groups-alist))
14513 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14514 (tml (mapcar 'car tal))
14515 (rtnmatch match) rpl)
14516 ;; @ and _ are allowed as word-components in tags
14517 (modify-syntax-entry ?@ "w" stable)
14518 (modify-syntax-entry ?_ "w" stable)
14520 (with-syntax-table stable
14522 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14523 (regexp-opt tml) "\\>\\)") rtnmatch)))
14524 (let* ((dir (match-string 1 rtnmatch))
14525 (tag (match-string 2 rtnmatch))
14526 (tag (if downcased (downcase tag) tag)))
14527 (setq tml (delete tag tml))
14528 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14529 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14530 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14531 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14532 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14534 (or (reverse rpl) (list rtnmatch))
14536 (if single-as-list (list (if downcased (downcase match) match))
14539 (defun org-op-to-function (op &optional stringp)
14540 "Turn an operator into the appropriate function."
14543 ((equal op "<" ) '(< string< org-time<))
14544 ((equal op ">" ) '(> org-string> org-time>))
14545 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14546 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14547 ((member op '("=" "==")) '(= string= org-time=))
14548 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14549 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14551 (defun org<> (a b) (not (= a b)))
14552 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14553 (defun org-string>= (a b) (not (string< a b)))
14554 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14555 (defun org-string<> (a b) (not (string= a b)))
14556 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14557 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14558 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14559 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14560 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14561 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14563 "Convert S to a floating point time.
14564 If S is already a number, just return it. If it is a string, parse
14565 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14569 (condition-case nil
14570 (float-time (apply 'encode-time (org-parse-time-string s)))
14574 (defun org-time-today ()
14575 "Time in seconds today at 0:00.
14576 Returns the float number of seconds since the beginning of the
14577 epoch to the beginning of today (00:00)."
14578 (float-time (apply 'encode-time
14579 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14581 (defun org-matcher-time (s)
14582 "Interpret a time comparison value."
14585 ((string= s "<now>") (float-time))
14586 ((string= s "<today>") (org-time-today))
14587 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14588 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14589 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14590 (+ (org-time-today)
14591 (* (string-to-number (match-string 1 s))
14592 (cdr (assoc (match-string 2 s)
14593 '(("d" . 86400.0) ("w" . 604800.0)
14594 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14597 (defun org-match-any-p (re list)
14598 "Does re match any element of list?"
14599 (setq list (mapcar (lambda (x) (string-match re x)) list))
14602 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14603 (defvar org-tags-overlay (make-overlay 1 1))
14604 (org-detach-overlay org-tags-overlay)
14606 (defun org-get-local-tags-at (&optional pos)
14607 "Get a list of tags defined in the current headline."
14608 (org-get-tags-at pos 'local))
14610 (defun org-get-local-tags ()
14611 "Get a list of tags defined in the current headline."
14612 (org-get-tags-at nil 'local))
14614 (defun org-get-tags-at (&optional pos local)
14615 "Get a list of all headline tags applicable at POS.
14616 POS defaults to point. If tags are inherited, the list contains
14617 the targets in the same sequence as the headlines appear, i.e.
14618 the tags of the current headline come last.
14619 When LOCAL is non-nil, only return tags from the current headline,
14620 ignore inherited ones."
14622 (if (and org-trust-scanner-tags
14623 (or (not pos) (equal pos (point)))
14626 (let (tags ltags lastpos parent)
14630 (goto-char (or pos (point)))
14633 (condition-case nil
14635 (org-back-to-heading t)
14636 (while (not (equal lastpos (point)))
14637 (setq lastpos (point))
14639 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14640 (setq ltags (org-split-string
14641 (org-match-string-no-properties 1) ":"))
14643 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14646 (org-remove-uninherited-tags ltags)
14649 (or org-use-tag-inheritance (throw 'done t))
14650 (if local (throw 'done t))
14651 (or (org-up-heading-safe) (error nil))
14656 (reverse (delete-dups
14658 (org-remove-uninherited-tags
14659 org-file-tags) tags)))))))))
14661 (defun org-add-prop-inherited (s)
14662 (add-text-properties 0 (length s) '(inherited t) s)
14665 (defun org-toggle-tag (tag &optional onoff)
14666 "Toggle the tag TAG for the current line.
14667 If ONOFF is `on' or `off', don't toggle but set to this state."
14670 (org-back-to-heading t)
14671 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14674 (setq current (match-string 1))
14675 (replace-match ""))
14677 (setq current (nreverse (org-split-string current ":")))
14681 (or (member tag current) (push tag current)))
14683 (or (not (member tag current)) (setq current (delete tag current))))
14684 (t (if (member tag current)
14685 (setq current (delete tag current))
14687 (push tag current))))
14691 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14692 (org-set-tags nil t))
14693 (delete-horizontal-space))
14694 (run-hooks 'org-after-tags-change-hook))
14697 (defun org-align-tags-here (to-col)
14698 ;; Assumes that this is a headline
14699 "Align tags on the current headline to TO-COL."
14700 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14701 (beginning-of-line 1)
14702 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14703 (< pos (match-beginning 2)))
14705 (setq tags-l (- (match-end 2) (match-beginning 2)))
14706 (goto-char (match-beginning 1))
14708 (delete-region (point) (1+ (match-beginning 2)))
14709 (setq ncol (max (current-column)
14713 (- (abs to-col) tags-l))))
14715 (insert (make-string (- ncol (current-column)) ?\ ))
14716 (setq ncol (current-column))
14717 (when indent-tabs-mode (tabify p (point-at-eol)))
14718 (org-move-to-column (min ncol col)))
14721 (defun org-set-tags-command (&optional arg just-align)
14722 "Call the set-tags command for the current entry."
14724 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14725 (org-set-tags arg just-align)
14727 (unless (and (org-region-active-p)
14728 org-loop-over-headlines-in-active-region)
14729 (org-back-to-heading t))
14730 (org-set-tags arg just-align))))
14732 (defun org-set-tags-to (data)
14733 "Set the tags of the current entry to DATA, replacing the current tags.
14734 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14735 If DATA is nil or the empty string, any tags will be removed."
14736 (interactive "sTags: ")
14740 ((equal data "") "")
14742 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14745 (concat ":" (mapconcat 'identity data ":") ":"))))
14748 (org-back-to-heading t)
14749 (when (looking-at org-complex-heading-regexp)
14752 (goto-char (match-beginning 5))
14754 (delete-region (point) (point-at-eol))
14755 (org-set-tags nil 'align))
14756 (goto-char (point-at-eol))
14758 (org-set-tags nil 'align)))
14759 (beginning-of-line 1)
14760 (if (looking-at ".*?\\([ \t]+\\)$")
14761 (delete-region (match-beginning 1) (match-end 1))))))
14763 (defun org-align-all-tags ()
14764 "Align the tags i all headings."
14767 (or (ignore-errors (org-back-to-heading t))
14768 (outline-next-heading))
14769 (if (org-at-heading-p)
14771 (message "No headings"))))
14773 (defvar org-indent-indentation-per-level)
14774 (defun org-set-tags (&optional arg just-align)
14775 "Set the tags for the current headline.
14776 With prefix ARG, realign all tags in headings in the current buffer.
14777 When JUST-ALIGN is non-nil, only align tags."
14779 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14780 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14781 'region-start-level 'region))
14782 org-loop-over-headlines-in-active-region)
14784 ;; We don't use ARG and JUST-ALIGN here because these args
14785 ;; are not useful when looping over headlines.
14787 org-loop-over-headlines-in-active-region
14788 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14789 (let* ((re org-outline-regexp-bol)
14790 (current (unless arg (org-get-tags-string)))
14791 (col (current-column))
14792 (org-setting-tags t)
14793 table current-tags inherited-tags ; computed below when needed
14794 tags p0 c0 c1 rpl di tc level)
14797 (goto-char (point-min))
14798 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14799 (while (re-search-forward re nil t)
14800 (org-set-tags nil t)
14802 (message "All tags realigned to column %d" org-tags-column))
14804 (setq tags current)
14805 ;; Get a new set of tags from the user
14807 (setq table (append org-tag-persistent-alist
14808 (or org-tag-alist (org-get-buffer-tags))
14810 org-complete-tags-always-offer-all-agenda-tags
14811 (org-global-tags-completion-table
14812 (org-agenda-files))))
14813 org-last-tags-completion-table table
14814 current-tags (org-split-string current ":")
14815 inherited-tags (nreverse
14816 (nthcdr (length current-tags)
14817 (nreverse (org-get-tags-at))))
14819 (if (or (eq t org-use-fast-tag-selection)
14820 (and org-use-fast-tag-selection
14821 (delq nil (mapcar 'cdr table))))
14822 (org-fast-tag-selection
14823 current-tags inherited-tags table
14824 (if org-fast-tag-selection-include-todo
14825 org-todo-key-alist))
14826 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14828 (org-icompleting-read "Tags: "
14829 'org-tags-completion-function
14830 nil nil current 'org-tags-history))))))
14831 (while (string-match "[-+&]+" tags)
14832 ;; No boolean logic, just a list
14833 (setq tags (replace-match ":" t t tags))))
14835 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14837 (if org-tags-sort-function
14838 (setq tags (mapconcat 'identity
14839 (sort (org-split-string
14840 tags (org-re "[^[:alnum:]_@#%]+"))
14841 org-tags-sort-function) ":")))
14843 (if (string-match "\\`[\t ]*\\'" tags)
14845 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14846 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14848 ;; Insert new tags at the correct column
14849 (beginning-of-line 1)
14850 (setq level (or (and (looking-at org-outline-regexp)
14851 (- (match-end 0) (point) 1))
14854 ((and (equal current "") (equal tags "")))
14855 ((re-search-forward
14856 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14858 (if (equal tags "")
14860 (goto-char (match-beginning 0))
14861 (setq c0 (current-column)
14862 ;; compute offset for the case of org-indent-mode active
14863 di (if (org-bound-and-true-p org-indent-mode)
14864 (* (1- org-indent-indentation-per-level) (1- level))
14866 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14867 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14868 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14869 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14870 (replace-match rpl t t)
14871 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14873 (t (error "Tags alignment failed")))
14874 (org-move-to-column col)
14876 (run-hooks 'org-after-tags-change-hook))))))
14878 (defun org-change-tag-in-region (beg end tag off)
14879 "Add or remove TAG for each entry in the region.
14880 This works in the agenda, and also in an org-mode buffer."
14882 (list (region-beginning) (region-end)
14883 (let ((org-last-tags-completion-table
14884 (if (derived-mode-p 'org-mode)
14886 (delq nil (append (org-get-buffer-tags)
14887 (org-global-tags-completion-table))))
14888 (org-global-tags-completion-table))))
14889 (org-icompleting-read
14890 "Tag: " 'org-tags-completion-function nil nil nil
14891 'org-tags-history))
14893 (message "[s]et or
[r]emove? ")
14894 (equal (read-char-exclusive) ?r))))
14895 (if (fboundp 'deactivate-mark) (deactivate-mark))
14896 (let ((agendap (equal major-mode 'org-agenda-mode))
14897 l1 l2 m buf pos newhead (cnt 0))
14899 (setq l2 (1- (org-current-line)))
14901 (setq l1 (org-current-line))
14902 (loop for l from l1 to l2 do
14904 (setq m (get-text-property (point) 'org-hd-marker))
14905 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14907 (setq buf (if agendap (marker-buffer m) (current-buffer))
14908 pos (if agendap m (point)))
14909 (with-current-buffer buf
14913 (setq cnt (1+ cnt))
14914 (org-toggle-tag tag (if off 'off 'on))
14915 (setq newhead (org-get-heading)))))
14916 (and agendap (org-agenda-change-all-lines newhead m))))
14917 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14919 (defun org-tags-completion-function (string predicate &optional flag)
14920 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14921 (confirm (lambda (x) (stringp (car x)))))
14922 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14923 (setq s1 (match-string 1 string)
14924 s2 (match-string 2 string))
14925 (setq s1 "" s2 string))
14929 (setq rtn (try-completion s2 ctable confirm))
14932 (concat s1 s2 (substring rtn (length s2))
14933 (if (and org-add-colon-after-tag-completion
14934 (assoc rtn ctable))
14939 (all-completions s2 ctable confirm))
14942 (assoc s2 ctable)))))
14944 (defun org-fast-tag-insert (kwd tags face &optional end)
14945 "Insert KDW, and the TAGS, the latter with face FACE.
14947 (insert (format "%-12s" (concat kwd ":"))
14948 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14951 (defun org-fast-tag-show-exit (flag)
14954 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14955 (replace-match ""))
14958 (org-move-to-column (- (window-width) 19) t)
14959 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14961 (defun org-set-current-tags-overlay (current prefix)
14962 "Add an overlay to CURRENT tag with PREFIX."
14963 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14964 (if (featurep 'xemacs)
14965 (org-overlay-display org-tags-overlay (concat prefix s)
14966 'secondary-selection)
14967 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14968 (org-overlay-display org-tags-overlay (concat prefix s)))))
14970 (defvar org-last-tag-selection-key nil)
14971 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14972 "Fast tag selection with single keys.
14973 CURRENT is the current list of tags in the headline, INHERITED is the
14974 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14975 possibly with grouping information. TODO-TABLE is a similar table with
14976 TODO keywords, should these have keys assigned to them.
14977 If the keys are nil, a-z are automatically assigned.
14978 Returns the new tags string, or nil to not change the current settings."
14979 (let* ((fulltable (append table todo-table))
14980 (maxlen (apply 'max (mapcar
14982 (if (stringp (car x)) (string-width (car x)) 0))
14984 (buf (current-buffer))
14985 (expert (eq org-fast-tag-selection-single-key 'expert))
14987 (fwidth (+ maxlen 3 1 3))
14988 (ncol (/ (- (window-width) 4) fwidth))
14991 tg cnt e c char c1 c2 ntable tbl rtn
14992 ov-start ov-end ov-prefix
14993 (exit-after-next org-fast-tag-selection-single-key)
14994 (done-keywords org-done-keywords)
14997 (beginning-of-line 1)
14999 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15000 (setq ov-start (match-beginning 1)
15001 ov-end (match-end 1)
15003 (setq ov-start (1- (point-at-eol))
15004 ov-end (1+ ov-start))
15005 (skip-chars-forward "^\n\r")
15008 (buffer-substring (1- (point)) (point))
15009 (if (> (current-column) org-tags-column)
15011 (make-string (- org-tags-column (current-column)) ?\ ))))))
15012 (move-overlay org-tags-overlay ov-start ov-end)
15013 (save-window-excursion
15015 (set-buffer (get-buffer-create " *Org tags*"))
15016 (delete-other-windows)
15017 (set-window-buffer (split-window-vertically) (get-buffer-create " *Org tags*"))
15018 (org-switch-to-buffer-other-window " *Org tags*"))
15020 (org-set-local 'org-done-keywords done-keywords)
15021 (org-fast-tag-insert "Inherited" inherited i-face "\n")
15022 (org-fast-tag-insert "Current" current c-face "\n\n")
15023 (org-fast-tag-show-exit exit-after-next)
15024 (org-set-current-tags-overlay current ov-prefix)
15025 (setq tbl fulltable char ?a cnt 0)
15026 (while (setq e (pop tbl))
15028 ((equal (car e) :startgroup)
15029 (push '() groups) (setq ingroup t)
15030 (when (not (= cnt 0))
15033 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
15034 ((equal (car e) :endgroup)
15035 (setq ingroup nil cnt 0)
15036 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
15037 ((equal e '(:newline))
15038 (when (not (= cnt 0))
15042 (while (equal (car tbl) '(:newline))
15044 (setq tbl (cdr tbl)))))
15045 ((equal e '(:grouptags)) nil)
15047 (setq tg (copy-sequence (car e)) c2 nil)
15050 ;; automatically assign a character.
15051 (setq c1 (string-to-char
15052 (downcase (substring
15053 tg (if (= (string-to-char tg) ?@) 1 0)))))
15054 (if (or (rassoc c1 ntable) (rassoc c1 table))
15055 (while (or (rassoc char ntable) (rassoc char table))
15056 (setq char (1+ char)))
15058 (setq c (or c2 char)))
15059 (if ingroup (push tg (car groups)))
15060 (setq tg (org-add-props tg nil 'face
15062 ((not (assoc tg table))
15063 (org-get-todo-face tg))
15064 ((member tg current) c-face)
15065 ((member tg inherited) i-face))))
15066 (if (equal (caar tbl) :grouptags)
15067 (org-add-props tg nil 'face 'org-tag-group))
15068 (if (and (= cnt 0) (not ingroup)) (insert " "))
15069 (insert "[" c "] " tg (make-string
15070 (- fwidth 4 (length tg)) ?\ ))
15071 (push (cons tg c) ntable)
15072 (when (= (setq cnt (1+ cnt)) ncol)
15074 (if ingroup (insert " "))
15076 (setq ntable (nreverse ntable))
15078 (goto-char (point-min))
15079 (if (not expert) (org-fit-window-to-buffer))
15083 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
15084 (if (not groups) "no " "")
15085 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
15086 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
15087 (setq org-last-tag-selection-key c)
15089 ((= c ?\r) (throw 'exit t))
15091 (setq groups (not groups))
15092 (goto-char (point-min))
15093 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
15096 (org-fast-tag-show-exit
15097 (setq exit-after-next (not exit-after-next)))
15099 (delete-other-windows)
15100 (set-window-buffer (split-window-vertically) " *Org tags*")
15101 (org-switch-to-buffer-other-window " *Org tags*")
15102 (org-fit-window-to-buffer)))
15104 (and (= c ?q) (not (rassoc c ntable))))
15105 (org-detach-overlay org-tags-overlay)
15106 (setq quit-flag t))
15109 (if exit-after-next (setq exit-after-next 'now)))
15111 (condition-case nil
15112 (setq tg (org-icompleting-read
15115 (with-current-buffer buf
15116 (org-get-buffer-tags)))))
15117 (quit (setq tg "")))
15118 (when (string-match "\\S-" tg)
15119 (add-to-list 'buffer-tags (list tg))
15120 (if (member tg current)
15121 (setq current (delete tg current))
15122 (push tg current)))
15123 (if exit-after-next (setq exit-after-next 'now)))
15124 ((setq e (rassoc c todo-table) tg (car e))
15125 (with-current-buffer buf
15126 (save-excursion (org-todo tg)))
15127 (if exit-after-next (setq exit-after-next 'now)))
15128 ((setq e (rassoc c ntable) tg (car e))
15129 (if (member tg current)
15130 (setq current (delete tg current))
15131 (loop for g in groups do
15134 (setq current (delete x current)))
15137 (if exit-after-next (setq exit-after-next 'now))))
15139 ;; Create a sorted list
15143 (assoc b (cdr (memq (assoc a ntable) ntable))))))
15144 (if (eq exit-after-next 'now) (throw 'exit t))
15145 (goto-char (point-min))
15146 (beginning-of-line 2)
15147 (delete-region (point) (point-at-eol))
15148 (org-fast-tag-insert "Current" current c-face)
15149 (org-set-current-tags-overlay current ov-prefix)
15150 (while (re-search-forward
15151 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
15152 (setq tg (match-string 1))
15153 (add-text-properties
15154 (match-beginning 1) (match-end 1)
15157 ((member tg current) c-face)
15158 ((member tg inherited) i-face)
15159 (t (get-text-property (match-beginning 1) 'face))))))
15160 (goto-char (point-min)))))
15161 (org-detach-overlay org-tags-overlay)
15163 (mapconcat 'identity current ":")
15166 (defun org-get-tags-string ()
15167 "Get the TAGS string in the current headline."
15168 (unless (org-at-heading-p t)
15169 (user-error "Not on a heading"))
15171 (beginning-of-line 1)
15172 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15173 (org-match-string-no-properties 1)
15176 (defun org-get-tags ()
15177 "Get the list of tags specified in the current headline."
15178 (org-split-string (org-get-tags-string) ":"))
15180 (defun org-get-buffer-tags ()
15181 "Get a table of all tags used in the buffer, for completion."
15184 (goto-char (point-min))
15185 (while (re-search-forward
15186 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
15187 (when (equal (char-after (point-at-bol 0)) ?*)
15188 (mapc (lambda (x) (add-to-list 'tags x))
15189 (org-split-string (org-match-string-no-properties 1) ":")))))
15190 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
15191 (mapcar 'list tags)))
15193 ;;;; The mapping API
15195 (defun org-map-entries (func &optional match scope &rest skip)
15196 "Call FUNC at each headline selected by MATCH in SCOPE.
15198 FUNC is a function or a lisp form. The function will be called without
15199 arguments, with the cursor positioned at the beginning of the headline.
15200 The return values of all calls to the function will be collected and
15201 returned as a list.
15203 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15204 does not need to preserve point. After evaluation, the cursor will be
15205 moved to the end of the line (presumably of the headline of the
15206 processed entry) and search continues from there. Under some
15207 circumstances, this may not produce the wanted results. For example,
15208 if you have removed (e.g. archived) the current (sub)tree it could
15209 mean that the next entry will be skipped entirely. In such cases, you
15210 can specify the position from where search should continue by making
15211 FUNC set the variable `org-map-continue-from' to the desired buffer
15214 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15215 Only headlines that are matched by this query will be considered during
15216 the iteration. When MATCH is nil or t, all headlines will be
15217 visited by the iteration.
15219 SCOPE determines the scope of this command. It can be any of:
15221 nil The current buffer, respecting the restriction if any
15222 tree The subtree started with the entry at point
15223 region The entries within the active region, if any
15225 The entries within the active region, but only those at
15226 the same level than the first one.
15227 file The current buffer, without restriction
15229 The current buffer, and any archives associated with it
15230 agenda All agenda files
15231 agenda-with-archives
15232 All agenda files with any archive files associated with them
15234 If this is a list, all files in the list will be scanned
15236 The remaining args are treated as settings for the skipping facilities of
15237 the scanner. The following items can be given here:
15239 archive skip trees with the archive tag
15240 comment skip trees with the COMMENT keyword
15241 function or Emacs Lisp form:
15242 will be used as value for `org-agenda-skip-function', so
15243 whenever the function returns a position, FUNC will not be
15244 called for that entry and search will continue from the
15247 If your function needs to retrieve the tags including inherited tags
15248 at the *current* entry, you can use the value of the variable
15249 `org-scanner-tags' which will be much faster than getting the value
15250 with `org-get-tags-at'. If your function gets properties with
15251 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15252 to t around the call to `org-entry-properties' to get the same speedup.
15253 Note that if your function moves around to retrieve tags and properties at
15254 a *different* entry, you cannot use these techniques."
15255 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15256 (not (org-region-active-p)))
15257 (let* ((org-agenda-archives-mode nil) ; just to make sure
15258 (org-agenda-skip-archived-trees (memq 'archive skip))
15259 (org-agenda-skip-comment-trees (memq 'comment skip))
15260 (org-agenda-skip-function
15261 (car (org-delete-all '(comment archive) skip)))
15262 (org-tags-match-list-sublevels t)
15263 (start-level (eq scope 'region-start-level))
15265 org-todo-keywords-for-agenda
15266 org-done-keywords-for-agenda
15267 org-todo-keyword-alist-for-agenda
15268 org-tag-alist-for-agenda
15272 ((eq match t) (setq matcher t))
15273 ((eq match nil) (setq matcher t))
15274 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15278 (cond ((eq scope 'tree)
15279 (org-back-to-heading t)
15280 (org-narrow-to-subtree)
15282 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15283 (org-region-active-p))
15284 ;; If needed, set start-level to a string like "2"
15287 (goto-char (region-beginning))
15288 (unless (org-at-heading-p) (outline-next-heading))
15289 (setq start-level (org-current-level))))
15290 (narrow-to-region (region-beginning)
15292 (goto-char (region-end))
15293 (unless (and (bolp) (org-at-heading-p))
15294 (outline-next-heading))
15300 (org-agenda-prepare-buffers
15301 (list (buffer-file-name (current-buffer))))
15302 (setq res (org-scan-tags func matcher todo-only start-level)))
15303 ;; Get the right scope
15305 ((and scope (listp scope) (symbolp (car scope)))
15306 (setq scope (eval scope)))
15307 ((eq scope 'agenda)
15308 (setq scope (org-agenda-files t)))
15309 ((eq scope 'agenda-with-archives)
15310 (setq scope (org-agenda-files t))
15311 (setq scope (org-add-archive-files scope)))
15313 (setq scope (list (buffer-file-name))))
15314 ((eq scope 'file-with-archives)
15315 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15316 (org-agenda-prepare-buffers scope)
15317 (while (setq file (pop scope))
15318 (with-current-buffer (org-find-base-buffer-visiting file)
15322 (goto-char (point-min))
15323 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15328 ;;; Setting and retrieving properties
15330 (defconst org-special-properties
15331 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15332 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15333 "The special properties valid in Org-mode.
15335 These are properties that are not defined in the property drawer,
15336 but in some other way.")
15338 (defconst org-default-properties
15339 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15340 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15341 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15342 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15343 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15344 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15345 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15346 "Some properties that are used by Org-mode for various purposes.
15347 Being in this list makes sure that they are offered for completion.")
15349 (defun org-property-action ()
15350 "Do an action on properties."
15353 (org-at-property-p)
15354 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15355 (setq c (read-char-exclusive))
15358 (call-interactively 'org-set-property))
15360 (call-interactively 'org-delete-property))
15362 (call-interactively 'org-delete-property-globally))
15364 (call-interactively 'org-compute-property-at-point))
15365 (t (user-error "No such property action %c" c)))))
15367 (defun org-inc-effort ()
15368 "Increment the value of the effort property in the current entry."
15370 (org-set-effort nil t))
15372 (defvar org-clock-effort) ;; Defined in org-clock.el
15373 (defvar org-clock-current-task) ;; Defined in org-clock.el
15374 (defun org-set-effort (&optional value increment)
15375 "Set the effort property of the current entry.
15376 With numerical prefix arg, use the nth allowed value, 0 stands for the
15377 10th allowed value.
15379 When INCREMENT is non-nil, set the property to the next allowed value."
15381 (if (equal value 0) (setq value 10))
15382 (let* ((completion-ignore-case t)
15383 (prop org-effort-property)
15384 (cur (org-entry-get nil prop))
15385 (allowed (org-property-get-allowed-values nil prop 'table))
15386 (existing (mapcar 'list (org-property-values prop)))
15387 (heading (nth 4 (org-heading-components)))
15390 ((stringp value) value)
15391 ((and allowed (integerp value))
15392 (or (car (nth (1- value) allowed))
15393 (car (org-last allowed))))
15394 ((and allowed increment)
15395 (or (caadr (member (list cur) allowed))
15396 (user-error "Allowed effort values are not set")))
15398 (message "Select 1-9,0, [RET%s]: %s"
15399 (if cur (concat "=" cur) "")
15400 (mapconcat 'car allowed " "))
15401 (setq rpl (read-char-exclusive))
15402 (if (equal rpl ?\r)
15404 (setq rpl (- rpl ?0))
15405 (if (equal rpl 0) (setq rpl 10))
15406 (if (and (> rpl 0) (<= rpl (length allowed)))
15407 (car (nth (1- rpl) allowed))
15408 (org-completing-read "Effort: " allowed nil))))
15410 (let (org-completion-use-ido org-completion-use-iswitchb)
15411 (org-completing-read
15412 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15413 (concat "[" cur "]") "")
15415 existing nil nil "" nil cur))))))
15416 (unless (equal (org-entry-get nil prop) val)
15417 (org-entry-put nil prop val))
15418 (org-refresh-property
15419 '((effort . identity)
15420 (effort-minutes . org-duration-string-to-minutes))
15422 (when (string= heading org-clock-current-task)
15423 (setq org-clock-effort (get-text-property (point-at-bol) 'effort))
15424 (org-clock-update-mode-line))
15425 (message "%s is now %s" prop val)))
15427 (defun org-at-property-p ()
15428 "Non-nil when point is inside a property drawer.
15429 See `org-property-re' for match data, if applicable."
15430 (when (eq (org-element-type (org-element-at-point)) 'node-property)
15432 (beginning-of-line)
15433 (looking-at org-property-re))))
15435 (defun org-get-property-block (&optional beg end force)
15436 "Return the (beg . end) range of the body of the property drawer.
15437 BEG and END are the beginning and end of the current subtree, or of
15438 the part before the first headline. If they are not given, they will
15439 be found. If the drawer does not exist and FORCE is non-nil, create
15443 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15444 (progn (org-back-to-heading t) (point))))
15445 (end (or end (and (not (outline-next-heading)) (point-max))
15448 (if (re-search-forward org-property-start-re end t)
15449 (setq beg (1+ (match-end 0)))
15452 (org-insert-property-drawer)
15453 (setq end (progn (outline-next-heading) (point))))
15456 (if (re-search-forward org-property-start-re end t)
15457 (setq beg (1+ (match-end 0)))))
15458 (if (re-search-forward org-property-end-re end t)
15459 (setq end (match-beginning 0))
15460 (or force (throw 'exit nil))
15464 (insert ":END:\n"))
15467 (defun org-entry-properties (&optional pom which specific)
15468 "Get all properties of the entry at point-or-marker POM.
15469 This includes the TODO keyword, the tags, time strings for deadline,
15470 scheduled, and clocking, and any additional properties defined in the
15471 entry. The return value is an alist, keys may occur multiple times
15472 if the property key was used several times.
15473 POM may also be nil, in which case the current entry is used.
15474 If WHICH is nil or `all', get all properties. If WHICH is
15475 `special' or `standard', only get that subclass. If WHICH
15476 is a string only get exactly this property. SPECIFIC can be a string, the
15477 specific property we are interested in. Specifying it can speed
15478 things up because then unnecessary parsing is avoided."
15479 (setq which (or which 'all))
15480 (org-with-wide-buffer
15481 (org-with-point-at pom
15482 (let ((clockstr (substring org-clock-string 0 -1))
15483 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15484 (case-fold-search nil)
15485 beg end range props sum-props key key1 value string clocksum clocksumt)
15486 (when (and (derived-mode-p 'org-mode)
15487 (ignore-errors (org-back-to-heading t)))
15489 (setq sum-props (get-text-property (point) 'org-summaries))
15490 (setq clocksum (get-text-property (point) :org-clock-minutes)
15491 clocksumt (get-text-property (point) :org-clock-minutes-today))
15492 (outline-next-heading)
15494 (when (memq which '(all special))
15495 ;; Get the special properties, like TODO and tags
15497 (when (and (or (not specific) (string= specific "TODO"))
15498 (looking-at org-todo-line-regexp) (match-end 2))
15499 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15500 (when (and (or (not specific) (string= specific "PRIORITY"))
15501 (looking-at org-priority-regexp))
15502 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15503 (when (or (not specific) (string= specific "FILE"))
15504 (push (cons "FILE" buffer-file-name) props))
15505 (when (and (or (not specific) (string= specific "TAGS"))
15506 (setq value (org-get-tags-string))
15507 (string-match "\\S-" value))
15508 (push (cons "TAGS" value) props))
15509 (when (and (or (not specific) (string= specific "ALLTAGS"))
15510 (setq value (org-get-tags-at)))
15511 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15514 (when (or (not specific) (string= specific "BLOCKED"))
15515 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15516 (when (or (not specific)
15518 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15519 "TIMESTAMP" "TIMESTAMP_IA")))
15521 (while (and (re-search-forward org-maybe-keyword-time-regexp end t)
15522 (not (text-property-any 0 (length (match-string 0))
15523 'face 'font-lock-comment-face
15524 (match-string 0))))
15525 (setq key (if (match-end 1)
15526 (substring (org-match-string-no-properties 1)
15528 string (if (equal key clockstr)
15530 (buffer-substring-no-properties
15531 (match-beginning 3) (goto-char
15533 (substring (org-match-string-no-properties 3)
15535 ;; Get the correct property name from the key. This is
15536 ;; necessary if the user has configured time keywords.
15537 (setq key1 (concat key ":"))
15541 (if (= (char-after (match-beginning 3)) ?\[)
15542 "TIMESTAMP_IA" "TIMESTAMP")))
15543 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15544 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15545 ((equal key1 org-closed-string) (setq key "CLOSED"))
15546 ((equal key1 org-clock-string) (setq key "CLOCK")))
15547 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15549 (push (cons key string) props)
15550 ;; no need to search further if match is found
15552 (when (or (equal key "CLOCK") (not (assoc key props)))
15553 (push (cons key string) props)))))))
15555 (when (memq which '(all standard))
15556 ;; Get the standard properties, like :PROP: ...
15557 (setq range (org-get-property-block beg end))
15559 (goto-char (car range))
15560 (while (re-search-forward org-property-re
15562 (setq key (org-match-string-no-properties 2)
15563 value (org-trim (or (org-match-string-no-properties 3) "")))
15564 (unless (member key excluded)
15565 (push (cons key (or value "")) props)))))
15567 (push (cons "CLOCKSUM"
15568 (org-columns-number-to-string (/ (float clocksum) 60.)
15572 (push (cons "CLOCKSUM_T"
15573 (org-columns-number-to-string (/ (float clocksumt) 60.)
15576 (unless (assoc "CATEGORY" props)
15577 (push (cons "CATEGORY" (org-get-category)) props))
15578 (append sum-props (nreverse props)))))))
15580 (defun org-entry-get (pom property &optional inherit literal-nil)
15581 "Get value of PROPERTY for entry or content at point-or-marker POM.
15582 If INHERIT is non-nil and the entry does not have the property,
15583 then also check higher levels of the hierarchy.
15584 If INHERIT is the symbol `selective', use inheritance only if the setting
15585 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15586 If the property is present but empty, the return value is the empty string.
15587 If the property is not present at all, nil is returned.
15589 Return the value as a string.
15591 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15592 do not interpret it as the list atom nil. This is used for inheritance
15593 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15594 (org-with-point-at pom
15595 (if (and inherit (if (eq inherit 'selective)
15596 (org-property-inherit-p property)
15598 (org-entry-get-with-inheritance property literal-nil)
15599 (if (member property org-special-properties)
15600 ;; We need a special property. Use `org-entry-properties'
15601 ;; to retrieve it, but specify the wanted property
15602 (cdr (assoc property (org-entry-properties nil 'special property)))
15603 (org-with-wide-buffer
15604 (let ((range (org-get-property-block)))
15605 (when (and range (not (eq (car range) (cdr range)))
15607 (goto-char (car range))
15609 (concat (org-re-property property) "\\|"
15610 (org-re-property (concat property "+")))
15613 (list (or (assoc property org-file-properties)
15614 (assoc property org-global-properties)
15615 (assoc property org-global-properties-fixed))))
15617 (when (re-search-forward
15618 (org-re-property key) (cdr range) t)
15620 (org-update-property-plist
15623 (org-match-string-no-properties 3) "")
15626 (goto-char (car range))
15627 (funcall ap property)
15628 (goto-char (car range))
15629 (while (funcall ap (concat property "+")))
15630 (setq val (cdr (assoc property props)))
15631 (when val (if literal-nil val (org-not-nil val)))))))))))
15633 (defun org-property-or-variable-value (var &optional inherit)
15634 "Check if there is a property fixing the value of VAR.
15635 If yes, return this value. If not, return the current value of the variable."
15636 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15637 (if (and prop (stringp prop) (string-match "\\S-" prop))
15639 (symbol-value var))))
15641 (defun org-entry-delete (pom property)
15642 "Delete the property PROPERTY from entry at point-or-marker POM."
15643 (unless (member property org-special-properties)
15644 (org-with-point-at pom
15645 (let ((range (org-get-property-block)))
15647 (goto-char (car range))
15649 (org-re-property property nil t)
15652 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15653 (org-remove-empty-drawer-at (car range))
15657 ;; Multi-values properties are properties that contain multiple values
15658 ;; These values are assumed to be single words, separated by whitespace.
15659 (defun org-entry-add-to-multivalued-property (pom property value)
15660 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15661 (let* ((old (org-entry-get pom property))
15662 (values (and old (org-split-string old "[ \t]"))))
15663 (setq value (org-entry-protect-space value))
15664 (unless (member value values)
15665 (setq values (append values (list value)))
15666 (org-entry-put pom property
15667 (mapconcat 'identity values " ")))))
15669 (defun org-entry-remove-from-multivalued-property (pom property value)
15670 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15671 (let* ((old (org-entry-get pom property))
15672 (values (and old (org-split-string old "[ \t]"))))
15673 (setq value (org-entry-protect-space value))
15674 (when (member value values)
15675 (setq values (delete value values))
15676 (org-entry-put pom property
15677 (mapconcat 'identity values " ")))))
15679 (defun org-entry-member-in-multivalued-property (pom property value)
15680 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15681 (let* ((old (org-entry-get pom property))
15682 (values (and old (org-split-string old "[ \t]"))))
15683 (setq value (org-entry-protect-space value))
15684 (member value values)))
15686 (defun org-entry-get-multivalued-property (pom property)
15687 "Return a list of values in a multivalued property."
15688 (let* ((value (org-entry-get pom property))
15689 (values (and value (org-split-string value "[ \t]"))))
15690 (mapcar 'org-entry-restore-space values)))
15692 (defun org-entry-put-multivalued-property (pom property &rest values)
15693 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15694 VALUES should be a list of strings. Spaces will be protected."
15695 (org-entry-put pom property
15696 (mapconcat 'org-entry-protect-space values " "))
15697 (let* ((value (org-entry-get pom property))
15698 (values (and value (org-split-string value "[ \t]"))))
15699 (mapcar 'org-entry-restore-space values)))
15701 (defun org-entry-protect-space (s)
15702 "Protect spaces and newline in string S."
15703 (while (string-match " " s)
15704 (setq s (replace-match "%20" t t s)))
15705 (while (string-match "\n" s)
15706 (setq s (replace-match "%0A" t t s)))
15709 (defun org-entry-restore-space (s)
15710 "Restore spaces and newline in string S."
15711 (while (string-match "%20" s)
15712 (setq s (replace-match " " t t s)))
15713 (while (string-match "%0A" s)
15714 (setq s (replace-match "\n" t t s)))
15717 (defvar org-entry-property-inherited-from (make-marker)
15718 "Marker pointing to the entry from where a property was inherited.
15719 Each call to `org-entry-get-with-inheritance' will set this marker to the
15720 location of the entry where the inheritance search matched. If there was
15721 no match, the marker will point nowhere.
15722 Note that also `org-entry-get' calls this function, if the INHERIT flag
15725 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15726 "Get PROPERTY of entry or content at point, search higher levels if needed.
15727 The search will stop at the first ancestor which has the property defined.
15728 If the value found is \"nil\", return nil to show that the property
15729 should be considered as undefined (this is the meaning of nil here).
15730 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15731 (move-marker org-entry-property-inherited-from nil)
15738 (when (setq tmp (org-entry-get nil property nil literal-nil))
15739 (or (ignore-errors (org-back-to-heading t))
15740 (goto-char (point-min)))
15741 (move-marker org-entry-property-inherited-from (point))
15743 (or (ignore-errors (org-up-heading-safe))
15744 (throw 'ex nil))))))
15746 (cdr (assoc property org-file-properties))
15747 (cdr (assoc property org-global-properties))
15748 (cdr (assoc property org-global-properties-fixed))))
15749 (if literal-nil tmp (org-not-nil tmp))))
15751 (defvar org-property-changed-functions nil
15752 "Hook called when the value of a property has changed.
15753 Each hook function should accept two arguments, the name of the property
15754 and the new value.")
15756 (defun org-entry-put (pom property value)
15757 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15758 If the value is `nil', it is converted to the empty string.
15759 If it is not a string, an error is raised."
15760 (cond ((null value) (setq value ""))
15761 ((not (stringp value))
15762 (error "Properties values should be strings.")))
15763 (org-with-point-at pom
15764 (org-back-to-heading t)
15765 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15768 ((equal property "TODO")
15769 (when (and (string-match "\\S-" value)
15770 (not (member value org-todo-keywords-1)))
15771 (user-error "\"%s\" is not a valid TODO state" value))
15772 (if (or (not value)
15773 (not (string-match "\\S-" value)))
15774 (setq value 'none))
15776 (org-set-tags nil 'align))
15777 ((equal property "PRIORITY")
15778 (org-priority (if (and value (string-match "\\S-" value))
15779 (string-to-char value) ?\ ))
15780 (org-set-tags nil 'align))
15781 ((equal property "CLOCKSUM")
15782 (if (not (re-search-forward
15783 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15784 (error "Cannot find a clock log")
15785 (goto-char (- (match-end 1) 2))
15787 ((eq value 'earlier) (org-timestamp-down))
15788 ((eq value 'later) (org-timestamp-up)))
15789 (org-clock-sum-current-item)))
15790 ((equal property "SCHEDULED")
15791 (if (re-search-forward org-scheduled-time-regexp end t)
15793 ((eq value 'earlier) (org-timestamp-change -1 'day))
15794 ((eq value 'later) (org-timestamp-change 1 'day))
15795 (t (call-interactively 'org-schedule)))
15796 (call-interactively 'org-schedule)))
15797 ((equal property "DEADLINE")
15798 (if (re-search-forward org-deadline-time-regexp end t)
15800 ((eq value 'earlier) (org-timestamp-change -1 'day))
15801 ((eq value 'later) (org-timestamp-change 1 'day))
15802 (t (call-interactively 'org-deadline)))
15803 (call-interactively 'org-deadline)))
15804 ((member property org-special-properties)
15805 (error "The %s property can not yet be set with `org-entry-put'"
15807 (t ; a non-special property
15808 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15809 (setq range (org-get-property-block beg end 'force))
15810 (goto-char (car range))
15811 (if (re-search-forward
15812 (org-re-property property nil t) (cdr range) t)
15814 (delete-region (match-beginning 0) (match-end 0))
15815 (goto-char (match-beginning 0)))
15816 (goto-char (cdr range))
15820 (insert ":" property ":")
15821 (and value (insert " " value))
15822 (org-indent-line)))))
15823 (run-hook-with-args 'org-property-changed-functions property value)))
15825 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15826 "Get all property keys in the current buffer.
15827 With INCLUDE-SPECIALS, also list the special properties that reflect things
15828 like tags and TODO state.
15829 With INCLUDE-DEFAULTS, also include properties that has special meaning
15830 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15832 With INCLUDE-COLUMNS, also include property names given in COLUMN
15833 formats in the current buffer."
15834 (let (rtn range cfmt s p)
15838 (goto-char (point-min))
15839 (while (re-search-forward org-property-start-re nil t)
15841 (setq range (or (org-get-property-block)
15843 (format "Malformed drawer at %d, repair?" (point)))
15844 (org-get-property-block nil nil t)
15845 (throw 'cont nil))))
15846 (goto-char (car range))
15847 (while (re-search-forward org-property-re
15849 (add-to-list 'rtn (org-match-string-no-properties 2)))
15850 (outline-next-heading)))))
15852 (when include-specials
15853 (setq rtn (append org-special-properties rtn)))
15855 (when include-defaults
15856 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15857 (add-to-list 'rtn org-effort-property))
15859 (when include-columns
15863 (goto-char (point-min))
15864 (while (re-search-forward
15865 "^[ \t]*\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15867 (setq cfmt (match-string 2) s 0)
15868 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15870 (setq s (match-end 0)
15871 p (match-string 1 cfmt))
15872 (unless (or (equal p "ITEM")
15873 (member p org-special-properties))
15874 (add-to-list 'rtn (match-string 1 cfmt))))))))
15876 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15878 (defun org-property-values (key)
15879 "Return a list of all values of property KEY in the current buffer."
15883 (goto-char (point-min))
15884 (let ((re (org-re-property key))
15886 (while (re-search-forward re nil t)
15887 (add-to-list 'values (org-trim (match-string 3))))
15888 (delete "" values)))))
15890 (defun org-insert-property-drawer ()
15891 "Insert a property drawer into the current entry."
15892 (org-back-to-heading t)
15893 (looking-at org-outline-regexp)
15894 (let ((indent (if org-adapt-indentation
15895 (- (match-end 0) (match-beginning 0))
15898 (re (concat "^[ \t]*" org-keyword-time-regexp))
15899 (org-clock-re (format "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|%s\\|:END:\\)"
15901 (org-skip-line-list (list org-clock-string ":END:"))
15903 (outline-next-heading)
15906 (while (re-search-forward re end t))
15907 (setq hiddenp (outline-invisible-p))
15909 (and (equal (char-after) ?\n) (forward-char 1))
15910 (while (looking-at org-clock-re)
15911 (if (member (match-string 1) org-skip-line-list)
15912 ;; just skip this line
15913 (beginning-of-line 2)
15914 ;; Drawer start, find the end
15915 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15916 (beginning-of-line 1)))
15917 (org-skip-over-state-notes)
15918 (skip-chars-backward " \t\n\r")
15919 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15921 (goto-char (point-at-eol))
15922 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15923 (beginning-of-line 0)
15924 (org-indent-to-column indent)
15925 (beginning-of-line 2)
15926 (org-indent-to-column indent)
15927 (beginning-of-line 0)
15930 (org-back-to-heading t)
15932 (org-flag-drawer t))))
15934 (defun org-insert-drawer (&optional arg drawer)
15935 "Insert a drawer at point.
15937 Optional argument DRAWER, when non-nil, is a string representing
15938 drawer's name. Otherwise, the user is prompted for a name.
15940 If a region is active, insert the drawer around that region
15943 Point is left between drawer's boundaries."
15945 (let* ((drawer (if arg "PROPERTIES"
15946 (or drawer (read-from-minibuffer "Drawer: ")))))
15948 ;; With C-u, fall back on `org-insert-property-drawer'
15949 (arg (org-insert-property-drawer))
15951 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
15952 (user-error "Invalid drawer name"))
15953 ;; With an active region, insert a drawer at point.
15954 ((not (org-region-active-p))
15956 (unless (bolp) (insert "\n"))
15957 (insert (format ":%s:\n\n:END:\n" drawer))
15958 (forward-line -2)))
15959 ;; Otherwise, insert the drawer at point
15961 (let ((rbeg (region-beginning))
15962 (rend (copy-marker (region-end))))
15966 (beginning-of-line)
15967 (when (save-excursion
15968 (re-search-forward org-outline-regexp-bol rend t))
15969 (user-error "Drawers cannot contain headlines"))
15970 ;; Position point at the beginning of the first
15971 ;; non-blank line in region. Insert drawer's opening
15972 ;; there, then indent it.
15973 (org-skip-whitespace)
15974 (beginning-of-line)
15975 (insert ":" drawer ":\n")
15977 (indent-for-tab-command)
15978 ;; Move point to the beginning of the first blank line
15979 ;; after the last non-blank line in region. Insert
15980 ;; drawer's closing, then indent it.
15982 (skip-chars-backward " \r\t\n")
15984 (deactivate-mark t)
15985 (indent-for-tab-command)
15986 (unless (eolp) (insert "\n")))
15987 ;; Clear marker, whatever the outcome of insertion is.
15988 (set-marker rend nil)))))))
15990 (defvar org-property-set-functions-alist nil
15991 "Property set function alist.
15992 Each entry should have the following format:
15994 (PROPERTY . READ-FUNCTION)
15996 The read function will be called with the same argument as
15997 `org-completing-read'.")
15999 (defun org-set-property-function (property)
16000 "Get the function that should be used to set PROPERTY.
16001 This is computed according to `org-property-set-functions-alist'."
16002 (or (cdr (assoc property org-property-set-functions-alist))
16003 'org-completing-read))
16005 (defun org-read-property-value (property)
16006 "Read PROPERTY value from user."
16007 (let* ((completion-ignore-case t)
16008 (allowed (org-property-get-allowed-values nil property 'table))
16009 (cur (org-entry-get nil property))
16010 (prompt (concat property " value"
16011 (if (and cur (string-match "\\S-" cur))
16012 (concat " [" cur "]") "") ": "))
16013 (set-function (org-set-property-function property))
16015 (funcall set-function prompt allowed nil
16016 (not (get-text-property 0 'org-unrestricted
16018 (let (org-completion-use-ido org-completion-use-iswitchb)
16019 (funcall set-function prompt
16020 (mapcar 'list (org-property-values property))
16021 nil nil "" nil cur)))))
16024 (defvar org-last-set-property nil)
16025 (defvar org-last-set-property-value nil)
16026 (defun org-read-property-name ()
16027 "Read a property name."
16028 (let* ((completion-ignore-case t)
16029 (keys (org-buffer-property-keys nil t t))
16030 (default-prop (or (save-excursion
16032 (beginning-of-line)
16033 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
16034 (null (string= (match-string 1) "END"))
16035 (match-string 1))))
16036 org-last-set-property))
16037 (property (org-icompleting-read
16039 (if default-prop (concat " [" default-prop "]") "")
16041 (mapcar 'list keys)
16044 (if (member property keys)
16046 (or (cdr (assoc (downcase property)
16047 (mapcar (lambda (x) (cons (downcase x) x))
16051 (defun org-set-property-and-value (use-last)
16052 "Allow to set [PROPERTY]: [value] direction from prompt.
16053 When use-default, don't even ask, just use the last
16054 \"[PROPERTY]: [value]\" string from the history."
16056 (let* ((completion-ignore-case t)
16057 (pv (or (and use-last org-last-set-property-value)
16058 (org-completing-read
16059 "Enter a \"[Property]: [value]\" pair: "
16060 nil nil nil nil nil
16061 org-last-set-property-value)))
16063 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
16064 (setq prop (match-string 1 pv)
16065 val (match-string 2 pv))
16066 (org-set-property prop val))))
16068 (defun org-set-property (property value)
16069 "In the current entry, set PROPERTY to VALUE.
16070 When called interactively, this will prompt for a property name, offering
16071 completion on existing and default properties. And then it will prompt
16072 for a value, offering completion either on allowed values (via an inherited
16073 xxx_ALL property) or on existing values in other instances of this property
16074 in the current file."
16075 (interactive (list nil nil))
16076 (let* ((property (or property (org-read-property-name)))
16077 (value (or value (org-read-property-value property)))
16078 (fn (cdr (assoc property org-properties-postprocess-alist))))
16079 (setq org-last-set-property property)
16080 (setq org-last-set-property-value (concat property ": " value))
16081 ;; Possibly postprocess the inserted value:
16082 (when fn (setq value (funcall fn value)))
16083 (unless (equal (org-entry-get nil property) value)
16084 (org-entry-put nil property value))))
16086 (defun org-delete-property (property)
16087 "In the current entry, delete PROPERTY."
16089 (let* ((completion-ignore-case t)
16090 (cat (org-entry-get (point) "CATEGORY"))
16091 (props0 (org-entry-properties nil 'standard))
16092 (props (if cat props0
16093 (delete `("CATEGORY" . ,(org-get-category)) props0)))
16094 (prop (if (< 1 (length props))
16095 (org-icompleting-read "Property: " props nil t)
16099 (message "No property to delete in this entry")
16100 (org-entry-delete nil property)
16101 (message "Property \"%s\" deleted" property)))
16103 (defun org-delete-property-globally (property)
16104 "Remove PROPERTY globally, from all entries."
16106 (let* ((completion-ignore-case t)
16107 (prop (org-icompleting-read
16108 "Globally remove property: "
16109 (mapcar 'list (org-buffer-property-keys)))))
16114 (goto-char (point-min))
16116 (while (re-search-forward
16117 (org-re-property property)
16119 (setq cnt (1+ cnt))
16120 (delete-region (match-beginning 0) (1+ (point-at-eol))))
16121 (message "Property \"%s\" removed from %d entries" property cnt)))))
16123 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
16125 (defun org-compute-property-at-point ()
16126 "Compute the property at point.
16127 This looks for an enclosing column format, extracts the operator and
16128 then applies it to the property in the column format's scope."
16130 (unless (org-at-property-p)
16131 (user-error "Not at a property"))
16132 (let ((prop (org-match-string-no-properties 2)))
16133 (org-columns-get-format-and-top-level)
16134 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
16135 (user-error "No operator defined for property %s" prop))
16136 (org-columns-compute prop)))
16138 (defvar org-property-allowed-value-functions nil
16139 "Hook for functions supplying allowed values for a specific property.
16140 The functions must take a single argument, the name of the property, and
16141 return a flat list of allowed values. If \":ETC\" is one of
16142 the values, this means that these values are intended as defaults for
16143 completion, but that other values should be allowed too.
16144 The functions must return nil if they are not responsible for this
16147 (defun org-property-get-allowed-values (pom property &optional table)
16148 "Get allowed values for the property PROPERTY.
16149 When TABLE is non-nil, return an alist that can directly be used for
16153 ((equal property "TODO")
16154 (setq vals (org-with-point-at pom
16155 (append org-todo-keywords-1 '("")))))
16156 ((equal property "PRIORITY")
16157 (let ((n org-lowest-priority))
16158 (while (>= n org-highest-priority)
16159 (push (char-to-string n) vals)
16161 ((member property org-special-properties))
16162 ((setq vals (run-hook-with-args-until-success
16163 'org-property-allowed-value-functions property)))
16165 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
16166 (when (and vals (string-match "\\S-" vals))
16167 (setq vals (car (read-from-string (concat "(" vals ")"))))
16168 (setq vals (mapcar (lambda (x)
16169 (cond ((stringp x) x)
16170 ((numberp x) (number-to-string x))
16171 ((symbolp x) (symbol-name x))
16174 (when (member ":ETC" vals)
16175 (setq vals (remove ":ETC" vals))
16176 (org-add-props (car vals) '(org-unrestricted t)))
16177 (if table (mapcar 'list vals) vals)))
16179 (defun org-property-previous-allowed-value (&optional previous)
16180 "Switch to the next allowed value for this property."
16182 (org-property-next-allowed-value t))
16184 (defun org-property-next-allowed-value (&optional previous)
16185 "Switch to the next allowed value for this property."
16187 (unless (org-at-property-p)
16188 (user-error "Not at a property"))
16189 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
16190 (key (match-string 2))
16191 (value (match-string 3))
16192 (allowed (or (org-property-get-allowed-values (point) key)
16193 (and (member value '("[ ]" "[-]" "[X]"))
16195 (heading (save-match-data (nth 4 (org-heading-components))))
16198 (user-error "Allowed values for this property have not been defined"))
16199 (if previous (setq allowed (reverse allowed)))
16200 (if (member value allowed)
16201 (setq nval (car (cdr (member value allowed)))))
16202 (setq nval (or nval (car allowed)))
16203 (if (equal nval value)
16204 (user-error "Only one allowed value for this property"))
16205 (org-at-property-p)
16206 (replace-match (concat " :" key ": " nval) t t)
16208 (beginning-of-line 1)
16209 (skip-chars-forward " \t")
16210 (when (equal prop org-effort-property)
16211 (org-refresh-property
16212 '((effort . identity)
16213 (effort-minutes . org-duration-string-to-minutes))
16215 (when (string= org-clock-current-task heading)
16216 (setq org-clock-effort nval)
16217 (org-clock-update-mode-line)))
16218 (run-hook-with-args 'org-property-changed-functions key nval)))
16220 (defun org-find-olp (path &optional this-buffer)
16221 "Return a marker pointing to the entry at outline path OLP.
16222 If anything goes wrong, throw an error.
16223 You can wrap this call to catch the error like this:
16225 (condition-case msg
16226 (org-mobile-locate-entry (match-string 4))
16227 (error (nth 1 msg)))
16229 The return value will then be either a string with the error message,
16230 or a marker if everything is OK.
16232 If THIS-BUFFER is set, the outline path does not contain a file,
16234 (let* ((file (if this-buffer buffer-file-name (pop path)))
16235 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16239 limit re end found pos heading cnt flevel)
16240 (unless buffer (error "File not found :%s" file))
16241 (with-current-buffer buffer
16245 (setq limit (point-max))
16246 (goto-char (point-min))
16247 (while (setq heading (pop path))
16248 (setq re (format org-complex-heading-regexp-format
16249 (regexp-quote heading)))
16250 (setq cnt 0 pos (point))
16251 (while (re-search-forward re end t)
16252 (setq level (- (match-end 1) (match-beginning 1)))
16253 (if (and (>= level lmin) (<= level lmax))
16254 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16255 (when (= cnt 0) (error "Heading not found on level %d: %s"
16257 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16260 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16261 (setq end (save-excursion (org-end-of-subtree t t))))
16262 (when (org-at-heading-p)
16263 (point-marker)))))))
16265 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16266 "Find node HEADING in BUFFER.
16267 Return a marker to the heading if it was found, or nil if not.
16268 If POS-ONLY is set, return just the position instead of a marker.
16270 The heading text must match exact, but it may have a TODO keyword,
16271 a priority cookie and tags in the standard locations."
16272 (with-current-buffer (or buffer (current-buffer))
16276 (goto-char (point-min))
16277 (let (case-fold-search)
16278 (if (re-search-forward
16279 (format org-complex-heading-regexp-format
16280 (regexp-quote heading)) nil t)
16282 (match-beginning 0)
16283 (move-marker (make-marker) (match-beginning 0)))))))))
16285 (defun org-find-exact-heading-in-directory (heading &optional dir)
16286 "Find Org node headline HEADING in all .org files in directory DIR.
16287 When the target headline is found, return a marker to this location."
16288 (let ((files (directory-files (or dir default-directory)
16289 t "\\`[^.#].*\\.org\\'"))
16290 file visiting m buffer)
16292 (while (setq file (pop files))
16293 (message "trying %s" file)
16294 (setq visiting (org-find-base-buffer-visiting file))
16295 (setq buffer (or visiting (find-file-noselect file)))
16296 (setq m (org-find-exact-headline-in-buffer
16298 (when (and (not m) (not visiting)) (kill-buffer buffer))
16299 (and m (throw 'found m))))))
16301 (defun org-find-entry-with-id (ident)
16302 "Locate the entry that contains the ID property with exact value IDENT.
16303 IDENT can be a string, a symbol or a number, this function will search for
16304 the string representation of it.
16305 Return the position where this entry starts, or nil if there is no such entry."
16306 (interactive "sID: ")
16308 ((stringp ident) ident)
16309 ((symbol-name ident) (symbol-name ident))
16310 ((numberp ident) (number-to-string ident))
16311 (t (error "IDENT %s must be a string, symbol or number" ident))))
16312 (case-fold-search nil))
16316 (goto-char (point-min))
16317 (when (re-search-forward
16318 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16320 (org-back-to-heading t)
16325 (defvar org-last-changed-timestamp nil)
16326 (defvar org-last-inserted-timestamp nil
16327 "The last time stamp inserted with `org-insert-time-stamp'.")
16328 (defvar org-ts-what) ; dynamically scoped parameter
16330 (defun org-time-stamp (arg &optional inactive)
16331 "Prompt for a date/time and insert a time stamp.
16332 If the user specifies a time like HH:MM or if this command is
16333 called with at least one prefix argument, the time stamp contains
16334 the date and the time. Otherwise, only the date is be included.
16336 All parts of a date not specified by the user is filled in from
16337 the current date/time. So if you just press return without
16338 typing anything, the time stamp will represent the current
16341 If there is already a timestamp at the cursor, it will be
16344 With two universal prefix arguments, insert an active timestamp
16345 with the current time without prompting the user.
16347 When called from lisp, the timestamp is inactive if INACTIVE is
16352 ;; Default time is either today, or, when entering a range,
16353 ;; the range start.
16354 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16356 (re-search-backward
16357 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16358 (- (point) 20) t)))
16359 (apply 'encode-time (org-parse-time-string (match-string 1)))
16361 (default-input (and ts (org-get-compact-tod ts)))
16362 (repeater (save-excursion
16364 (beginning-of-line)
16365 (when (re-search-forward
16366 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16367 (save-excursion (progn (end-of-line) (point))) t)
16368 (match-string 0)))))
16369 org-time-was-given org-end-time-was-given time)
16371 ((and (org-at-timestamp-p t)
16372 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16373 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16375 (setq time (let ((this-command this-command))
16376 (org-read-date arg 'totime nil nil
16377 default-time default-input inactive)))
16378 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16379 ((org-at-timestamp-p t)
16380 (setq time (let ((this-command this-command))
16381 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16382 (when (org-at-timestamp-p t) ; just to get the match data
16383 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16385 (setq org-last-changed-timestamp
16386 (org-insert-time-stamp
16387 time (or org-time-was-given arg)
16388 inactive nil nil (list org-end-time-was-given)))
16389 (when repeater (goto-char (1- (point))) (insert " " repeater)
16390 (setq org-last-changed-timestamp
16391 (concat (substring org-last-inserted-timestamp 0 -1)
16392 " " repeater ">"))))
16393 (message "Timestamp updated"))
16395 (org-insert-time-stamp (current-time) t inactive))
16397 (setq time (let ((this-command this-command))
16398 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16399 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16400 nil nil (list org-end-time-was-given))))))
16402 ;; FIXME: can we use this for something else, like computing time differences?
16403 (defun org-get-compact-tod (s)
16404 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16405 (let* ((t1 (match-string 1 s))
16406 (h1 (string-to-number (match-string 2 s)))
16407 (m1 (string-to-number (match-string 3 s)))
16408 (t2 (and (match-end 4) (match-string 5 s)))
16409 (h2 (and t2 (string-to-number (match-string 6 s))))
16410 (m2 (and t2 (string-to-number (match-string 7 s))))
16414 (setq dh (- h2 h1) dm (- m2 m1))
16415 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16416 (concat t1 "+" (number-to-string dh)
16417 (and (/= 0 dm) (format ":%02d" dm)))))))
16419 (defun org-time-stamp-inactive (&optional arg)
16420 "Insert an inactive time stamp.
16421 An inactive time stamp is enclosed in square brackets instead of angle
16422 brackets. It is inactive in the sense that it does not trigger agenda entries,
16423 does not link to the calendar and cannot be changed with the S-cursor keys.
16424 So these are more for recording a certain time/date."
16426 (org-time-stamp arg 'inactive))
16428 (defvar org-date-ovl (make-overlay 1 1))
16429 (overlay-put org-date-ovl 'face 'org-date-selected)
16430 (org-detach-overlay org-date-ovl)
16432 (defvar org-ans1) ; dynamically scoped parameter
16433 (defvar org-ans2) ; dynamically scoped parameter
16435 (defvar org-plain-time-of-day-regexp) ; defined below
16437 (defvar org-overriding-default-time nil) ; dynamically scoped
16438 (defvar org-read-date-overlay nil)
16439 (defvar org-dcst nil) ; dynamically scoped
16440 (defvar org-read-date-history nil)
16441 (defvar org-read-date-final-answer nil)
16442 (defvar org-read-date-analyze-futurep nil)
16443 (defvar org-read-date-analyze-forced-year nil)
16444 (defvar org-read-date-inactive)
16446 (defvar org-read-date-minibuffer-local-map
16447 (let* ((org-replace-disputed-keys nil)
16448 (map (make-sparse-keymap)))
16449 (set-keymap-parent map minibuffer-local-map)
16450 (org-defkey map (kbd ".")
16451 (lambda () (interactive)
16452 ;; Are we at the beginning of the prompt?
16453 (if (looking-back "^[^:]+: ")
16454 (org-eval-in-calendar '(calendar-goto-today))
16456 (org-defkey map (kbd "C-.")
16457 (lambda () (interactive)
16458 (org-eval-in-calendar '(calendar-goto-today))))
16459 (org-defkey map [(meta shift left)]
16460 (lambda () (interactive)
16461 (org-eval-in-calendar '(calendar-backward-month 1))))
16462 (org-defkey map [(meta shift right)]
16463 (lambda () (interactive)
16464 (org-eval-in-calendar '(calendar-forward-month 1))))
16465 (org-defkey map [(meta shift up)]
16466 (lambda () (interactive)
16467 (org-eval-in-calendar '(calendar-backward-year 1))))
16468 (org-defkey map [(meta shift down)]
16469 (lambda () (interactive)
16470 (org-eval-in-calendar '(calendar-forward-year 1))))
16471 (org-defkey map [?\e (shift left)]
16472 (lambda () (interactive)
16473 (org-eval-in-calendar '(calendar-backward-month 1))))
16474 (org-defkey map [?\e (shift right)]
16475 (lambda () (interactive)
16476 (org-eval-in-calendar '(calendar-forward-month 1))))
16477 (org-defkey map [?\e (shift up)]
16478 (lambda () (interactive)
16479 (org-eval-in-calendar '(calendar-backward-year 1))))
16480 (org-defkey map [?\e (shift down)]
16481 (lambda () (interactive)
16482 (org-eval-in-calendar '(calendar-forward-year 1))))
16483 (org-defkey map [(shift up)]
16484 (lambda () (interactive)
16485 (org-eval-in-calendar '(calendar-backward-week 1))))
16486 (org-defkey map [(shift down)]
16487 (lambda () (interactive)
16488 (org-eval-in-calendar '(calendar-forward-week 1))))
16489 (org-defkey map [(shift left)]
16490 (lambda () (interactive)
16491 (org-eval-in-calendar '(calendar-backward-day 1))))
16492 (org-defkey map [(shift right)]
16493 (lambda () (interactive)
16494 (org-eval-in-calendar '(calendar-forward-day 1))))
16495 (org-defkey map "!"
16496 (lambda () (interactive)
16497 (org-eval-in-calendar '(diary-view-entries))
16499 (org-defkey map ">"
16500 (lambda () (interactive)
16501 (org-eval-in-calendar '(scroll-calendar-left 1))))
16502 (org-defkey map "<"
16503 (lambda () (interactive)
16504 (org-eval-in-calendar '(scroll-calendar-right 1))))
16505 (org-defkey map "\C-v"
16506 (lambda () (interactive)
16507 (org-eval-in-calendar
16508 '(calendar-scroll-left-three-months 1))))
16509 (org-defkey map "\M-v"
16510 (lambda () (interactive)
16511 (org-eval-in-calendar
16512 '(calendar-scroll-right-three-months 1))))
16514 "Keymap for minibuffer commands when using `org-read-date'.")
16517 (defvar org-defdecode)
16518 (defvar org-with-time)
16520 (defun org-read-date (&optional org-with-time to-time from-string prompt
16521 default-time default-input inactive)
16522 "Read a date, possibly a time, and make things smooth for the user.
16523 The prompt will suggest to enter an ISO date, but you can also enter anything
16524 which will at least partially be understood by `parse-time-string'.
16525 Unrecognized parts of the date will default to the current day, month, year,
16526 hour and minute. If this command is called to replace a timestamp at point,
16527 or to enter the second timestamp of a range, the default time is taken
16528 from the existing stamp. Furthermore, the command prefers the future,
16529 so if you are giving a date where the year is not given, and the day-month
16530 combination is already past in the current year, it will assume you
16531 mean next year. For details, see the manual. A few examples:
16533 3-2-5 --> 2003-02-05
16534 feb 15 --> currentyear-02-15
16535 2/15 --> currentyear-02-15
16536 sep 12 9 --> 2009-09-12
16537 12:45 --> today 12:45
16538 22 sept 0:34 --> currentyear-09-22 0:34
16539 12 --> currentyear-currentmonth-12
16540 Fri --> nearest Friday after today
16541 -Tue --> last Tuesday
16544 Furthermore you can specify a relative date by giving, as the *first* thing
16545 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16546 change in days weeks, months, years.
16547 With a single plus or minus, the date is relative to today. With a double
16548 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16549 +4d --> four days from today
16550 +4 --> same as above
16551 +2w --> two weeks from today
16552 ++5 --> five days from default date
16554 The function understands only English month and weekday abbreviations.
16556 While prompting, a calendar is popped up - you can also select the
16557 date with the mouse (button 1). The calendar shows a period of three
16558 months. To scroll it to other months, use the keys `>' and `<'.
16559 If you don't like the calendar, turn it off with
16560 \(setq org-read-date-popup-calendar nil)
16562 With optional argument TO-TIME, the date will immediately be converted
16563 to an internal time.
16564 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16565 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16566 still enter a time, and this function will inform the calling routine
16567 about this change. The calling routine may then choose to change the
16568 format used to insert the time stamp into the buffer to include the time.
16569 With optional argument FROM-STRING, read from this string instead from
16570 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16571 the time/date that is used for everything that is not specified by the
16573 (require 'parse-time)
16574 (let* ((org-time-stamp-rounding-minutes
16575 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16576 (org-dcst org-display-custom-times)
16577 (ct (org-current-time))
16578 (org-def (or org-overriding-default-time default-time ct))
16579 (org-defdecode (decode-time org-def))
16581 (when (< (nth 2 org-defdecode) org-extend-today-until)
16582 (setcar (nthcdr 2 org-defdecode) -1)
16583 (setcar (nthcdr 1 org-defdecode) 59)
16584 (setq org-def (apply 'encode-time org-defdecode)
16585 org-defdecode (decode-time org-def)))))
16586 (mouse-autoselect-window nil) ; Don't let the mouse jump
16587 (calendar-frame-setup nil)
16588 (calendar-setup nil)
16589 (calendar-move-hook nil)
16590 (calendar-view-diary-initially-flag nil)
16591 (calendar-view-holidays-initially-flag nil)
16592 (timestr (format-time-string
16593 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16594 (prompt (concat (if prompt (concat prompt " ") "")
16595 (format "Date+time [%s]: " timestr)))
16596 ans (org-ans0 "") org-ans1 org-ans2 final)
16599 (from-string (setq ans from-string))
16600 (org-read-date-popup-calendar
16602 (save-window-excursion
16604 (org-eval-in-calendar '(setq cursor-type nil) t)
16607 (calendar-forward-day (- (time-to-days org-def)
16608 (calendar-absolute-from-gregorian
16609 (calendar-current-date))))
16610 (org-eval-in-calendar nil t)
16611 (let* ((old-map (current-local-map))
16612 (map (copy-keymap calendar-mode-map))
16613 (minibuffer-local-map
16614 (copy-keymap org-read-date-minibuffer-local-map)))
16615 (org-defkey map (kbd "RET") 'org-calendar-select)
16616 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16617 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16620 (use-local-map map)
16621 (setq org-read-date-inactive inactive)
16622 (add-hook 'post-command-hook 'org-read-date-display)
16623 (setq org-ans0 (read-string prompt default-input
16624 'org-read-date-history nil))
16625 ;; org-ans0: from prompt
16626 ;; org-ans1: from mouse click
16627 ;; org-ans2: from calendar motion
16628 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16629 (remove-hook 'post-command-hook 'org-read-date-display)
16630 (use-local-map old-map)
16631 (when org-read-date-overlay
16632 (delete-overlay org-read-date-overlay)
16633 (setq org-read-date-overlay nil)))))
16634 (bury-buffer "*Calendar*")))))
16636 (t ; Naked prompt only
16638 (setq ans (read-string prompt default-input
16639 'org-read-date-history timestr))
16640 (when org-read-date-overlay
16641 (delete-overlay org-read-date-overlay)
16642 (setq org-read-date-overlay nil)))))
16644 (setq final (org-read-date-analyze ans org-def org-defdecode))
16646 (when org-read-date-analyze-forced-year
16647 (message "Year was forced into %s"
16648 (if org-read-date-force-compatible-dates
16649 "compatible range (1970-2037)"
16650 "range representable on this machine"))
16653 ;; One round trip to get rid of 34th of August and stuff like that....
16654 (setq final (decode-time (apply 'encode-time final)))
16656 (setq org-read-date-final-answer ans)
16659 (apply 'encode-time final)
16660 (if (and (boundp 'org-time-was-given) org-time-was-given)
16661 (format "%04d-%02d-%02d %02d:%02d"
16662 (nth 5 final) (nth 4 final) (nth 3 final)
16663 (nth 2 final) (nth 1 final))
16664 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16666 (defun org-read-date-display ()
16667 "Display the current date prompt interpretation in the minibuffer."
16668 (when org-read-date-display-live
16669 (when org-read-date-overlay
16670 (delete-overlay org-read-date-overlay))
16671 (when (minibufferp (current-buffer))
16674 (while (not (equal (buffer-substring
16675 (max (point-min) (- (point) 4)) (point))
16678 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16679 " " (or org-ans1 org-ans2)))
16680 (org-end-time-was-given nil)
16681 (f (org-read-date-analyze ans org-def org-defdecode))
16683 org-time-stamp-custom-formats
16684 org-time-stamp-formats))
16685 (fmt (if (or org-with-time
16686 (and (boundp 'org-time-was-given) org-time-was-given))
16689 (txt (format-time-string fmt (apply 'encode-time f)))
16690 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16691 (txt (concat "=> " txt)))
16692 (when (and org-end-time-was-given
16693 (string-match org-plain-time-of-day-regexp txt))
16694 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16695 org-end-time-was-given
16696 (substring txt (match-end 0)))))
16697 (when org-read-date-analyze-futurep
16698 (setq txt (concat txt " (=>F)")))
16699 (setq org-read-date-overlay
16700 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16701 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16703 (defun org-read-date-analyze (ans org-def org-defdecode)
16704 "Analyze the combined answer of the date prompt."
16705 ;; FIXME: cleanup and comment
16706 (let ((nowdecode (decode-time (current-time)))
16707 delta deltan deltaw deltadef year month day
16708 hour minute second wday pm h2 m2 tl wday1
16709 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16710 (setq org-read-date-analyze-futurep nil
16711 org-read-date-analyze-forced-year nil)
16712 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16715 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16716 (setq ans (replace-match "" t t ans)
16718 deltaw (nth 1 delta)
16719 deltadef (nth 2 delta)))
16721 ;; Check if there is an iso week date in there. If yes, store the
16722 ;; info and postpone interpreting it until the rest of the parsing
16724 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16725 (setq iso-year (if (match-end 1)
16726 (org-small-year-to-year
16727 (string-to-number (match-string 1 ans))))
16728 iso-weekday (if (match-end 3)
16729 (string-to-number (match-string 3 ans)))
16730 iso-week (string-to-number (match-string 2 ans)))
16731 (setq ans (replace-match "" t t ans)))
16733 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16734 (when (string-match
16735 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16736 (setq year (if (match-end 2)
16737 (string-to-number (match-string 2 ans))
16738 (progn (setq kill-year t)
16739 (string-to-number (format-time-string "%Y"))))
16740 month (string-to-number (match-string 3 ans))
16741 day (string-to-number (match-string 4 ans)))
16742 (if (< year 100) (setq year (+ 2000 year)))
16743 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16746 ;; Help matching dotted european dates
16747 (when (string-match
16748 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16749 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16751 (string-to-number (format-time-string "%Y")))
16752 day (string-to-number (match-string 1 ans))
16753 month (string-to-number (match-string 2 ans))
16754 ans (replace-match (format "%04d-%02d-%02d" year month day)
16757 ;; Help matching american dates, like 5/30 or 5/30/7
16758 (when (string-match
16759 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16760 (setq year (if (match-end 4)
16761 (string-to-number (match-string 4 ans))
16762 (progn (setq kill-year t)
16763 (string-to-number (format-time-string "%Y"))))
16764 month (string-to-number (match-string 1 ans))
16765 day (string-to-number (match-string 2 ans)))
16766 (if (< year 100) (setq year (+ 2000 year)))
16767 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16769 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16770 ;; If there is a time with am/pm, and *no* time without it, we convert
16771 ;; so that matching will be successful.
16772 (loop for i from 1 to 2 do ; twice, for end time as well
16773 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16774 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16775 (setq hour (string-to-number (match-string 1 ans))
16776 minute (if (match-end 3)
16777 (string-to-number (match-string 3 ans))
16780 (string-to-char (downcase (match-string 4 ans)))))
16781 (if (and (= hour 12) (not pm))
16783 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16784 (setq ans (replace-match (format "%02d:%02d" hour minute)
16787 ;; Check if a time range is given as a duration
16788 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16789 (setq hour (string-to-number (match-string 1 ans))
16790 h2 (+ hour (string-to-number (match-string 3 ans)))
16791 minute (string-to-number (match-string 2 ans))
16792 m2 (+ minute (if (match-end 5) (string-to-number
16793 (match-string 5 ans))0)))
16794 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16795 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16798 ;; Check if there is a time range
16799 (when (boundp 'org-end-time-was-given)
16800 (setq org-time-was-given nil)
16801 (when (and (string-match org-plain-time-of-day-regexp ans)
16803 (setq org-end-time-was-given (match-string 8 ans))
16804 (setq ans (concat (substring ans 0 (match-beginning 7))
16805 (substring ans (match-end 7))))))
16807 (setq tl (parse-time-string ans)
16808 day (or (nth 3 tl) (nth 3 org-defdecode))
16809 month (or (nth 4 tl)
16810 (if (and org-read-date-prefer-future
16811 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16812 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16813 (nth 4 org-defdecode)))
16814 year (or (and (not kill-year) (nth 5 tl))
16815 (if (and org-read-date-prefer-future
16816 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16817 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16818 (nth 5 org-defdecode)))
16819 hour (or (nth 2 tl) (nth 2 org-defdecode))
16820 minute (or (nth 1 tl) (nth 1 org-defdecode))
16821 second (or (nth 0 tl) 0)
16824 (when (and (eq org-read-date-prefer-future 'time)
16825 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16826 (equal day (nth 3 nowdecode))
16827 (equal month (nth 4 nowdecode))
16828 (equal year (nth 5 nowdecode))
16830 (or (< (nth 2 tl) (nth 2 nowdecode))
16831 (and (= (nth 2 tl) (nth 2 nowdecode))
16833 (< (nth 1 tl) (nth 1 nowdecode)))))
16837 ;; Special date definitions below
16840 ;; There was an iso week
16843 (setq year (or iso-year year)
16844 day (or iso-weekday wday 1)
16845 wday nil ; to make sure that the trigger below does not match
16846 iso-date (calendar-gregorian-from-absolute
16847 (calendar-absolute-from-iso
16848 (list iso-week day year))))
16849 ; FIXME: Should we also push ISO weeks into the future?
16850 ; (when (and org-read-date-prefer-future
16852 ; (< (calendar-absolute-from-gregorian iso-date)
16853 ; (time-to-days (current-time))))
16854 ; (setq year (1+ year)
16855 ; iso-date (calendar-gregorian-from-absolute
16856 ; (calendar-absolute-from-iso
16857 ; (list iso-week day year)))))
16858 (setq month (car iso-date)
16859 year (nth 2 iso-date)
16860 day (nth 1 iso-date)))
16864 (let ((now (decode-time (current-time))))
16865 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16866 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16867 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16868 ((equal deltaw "m") (setq month (+ month deltan)))
16869 ((equal deltaw "y") (setq year (+ year deltan)))))
16870 ((and wday (not (nth 3 tl)))
16871 ;; Weekday was given, but no day, so pick that day in the week
16872 ;; on or after the derived date.
16873 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16874 (unless (equal wday wday1)
16875 (setq day (+ day (% (- wday wday1 -7) 7))))))
16876 (if (and (boundp 'org-time-was-given)
16878 (setq org-time-was-given t))
16879 (if (< year 100) (setq year (+ 2000 year)))
16880 ;; Check of the date is representable
16881 (if org-read-date-force-compatible-dates
16884 (setq year 1970 org-read-date-analyze-forced-year t))
16886 (setq year 2037 org-read-date-analyze-forced-year t)))
16887 (condition-case nil
16888 (ignore (encode-time second minute hour day month year))
16890 (setq year (nth 5 org-defdecode))
16891 (setq org-read-date-analyze-forced-year t))))
16892 (setq org-read-date-analyze-futurep futurep)
16893 (list second minute hour day month year)))
16895 (defvar parse-time-weekdays)
16896 (defun org-read-date-get-relative (s today default)
16897 "Check string S for special relative date string.
16898 TODAY and DEFAULT are internal times, for today and for a default.
16899 Return shift list (N what def-flag)
16900 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16901 N is the number of WHATs to shift.
16902 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16903 the DEFAULT date rather than TODAY."
16904 (require 'parse-time)
16908 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16910 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16911 "\\([ \t]\\|$\\)") s)
16912 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16913 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16914 (string-to-char (substring (match-string 1 s) -1))
16916 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16917 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16918 (what (if (match-end 3) (match-string 3 s) "d"))
16919 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16920 (date (if rel default today))
16921 (wday (nth 6 (decode-time date)))
16925 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16926 (if (= delta 0) (setq delta 7))
16929 (setq delta (- delta 7))
16930 (if (= delta 0) (setq delta -7))))
16931 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16932 (list delta "d" rel))
16933 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16935 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16936 "Turn a user-specified date into the internal representation.
16937 The internal representation needed by the calendar is (month day year).
16938 This is a wrapper to handle the brain-dead convention in calendar that
16939 user function argument order change dependent on argument order."
16940 (if (boundp 'calendar-date-style)
16942 ((eq calendar-date-style 'american)
16943 (list arg1 arg2 arg3))
16944 ((eq calendar-date-style 'european)
16945 (list arg2 arg1 arg3))
16946 ((eq calendar-date-style 'iso)
16947 (list arg2 arg3 arg1)))
16948 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16949 (if (org-bound-and-true-p european-calendar-style)
16950 (list arg2 arg1 arg3)
16951 (list arg1 arg2 arg3)))))
16953 (defun org-eval-in-calendar (form &optional keepdate)
16954 "Eval FORM in the calendar window and return to current window.
16955 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16956 otherwise stick to the current value of `org-ans2'."
16957 (let ((sf (selected-frame))
16958 (sw (selected-window)))
16959 (select-window (get-buffer-window "*Calendar*" t))
16961 (when (and (not keepdate) (calendar-cursor-to-date))
16962 (let* ((date (calendar-cursor-to-date))
16963 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16964 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16965 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16967 (org-select-frame-set-input-focus sf)))
16969 (defun org-calendar-select ()
16970 "Return to `org-read-date' with the date currently selected.
16971 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16973 (when (calendar-cursor-to-date)
16974 (let* ((date (calendar-cursor-to-date))
16975 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16976 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16977 (if (active-minibuffer-window) (exit-minibuffer))))
16979 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16980 "Insert a date stamp for the date given by the internal TIME.
16981 WITH-HM means use the stamp format that includes the time of the day.
16982 INACTIVE means use square brackets instead of angular ones, so that the
16983 stamp will not contribute to the agenda.
16984 PRE and POST are optional strings to be inserted before and after the
16986 The command returns the inserted time stamp."
16987 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16989 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16990 (insert-before-markers (or pre ""))
16991 (when (listp extra)
16992 (setq extra (car extra))
16993 (if (and (stringp extra)
16994 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16995 (setq extra (format "-%02d:%02d"
16996 (string-to-number (match-string 1 extra))
16997 (string-to-number (match-string 2 extra))))
17000 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
17001 (insert-before-markers (setq stamp (format-time-string fmt time)))
17002 (insert-before-markers (or post ""))
17003 (setq org-last-inserted-timestamp stamp)))
17005 (defun org-toggle-time-stamp-overlays ()
17006 "Toggle the use of custom time stamp formats."
17008 (setq org-display-custom-times (not org-display-custom-times))
17009 (unless org-display-custom-times
17010 (let ((p (point-min)) (bmp (buffer-modified-p)))
17011 (while (setq p (next-single-property-change p 'display))
17012 (if (and (get-text-property p 'display)
17013 (eq (get-text-property p 'face) 'org-date))
17014 (remove-text-properties
17015 p (setq p (next-single-property-change p 'display))
17017 (set-buffer-modified-p bmp)))
17018 (if (featurep 'xemacs)
17019 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
17020 (org-restart-font-lock)
17021 (setq org-table-may-need-update t)
17022 (if org-display-custom-times
17023 (message "Time stamps are overlaid with custom format")
17024 (message "Time stamp overlays removed")))
17026 (defun org-display-custom-time (beg end)
17027 "Overlay modified time stamp format over timestamp between BEG and END."
17028 (let* ((ts (buffer-substring beg end))
17029 t1 w1 with-hm tf time str w2 (off 0))
17031 (setq t1 (org-parse-time-string ts t))
17032 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
17033 (setq off (- (match-end 0) (match-beginning 0)))))
17034 (setq end (- end off))
17035 (setq w1 (- end beg)
17036 with-hm (and (nth 1 t1) (nth 2 t1))
17037 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
17038 time (org-fix-decoded-time t1)
17040 (format-time-string
17041 (substring tf 1 -1) (apply 'encode-time time))
17042 nil 'mouse-face 'highlight)
17044 (if (not (= w2 w1))
17045 (add-text-properties (1+ beg) (+ 2 beg)
17046 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
17047 (if (featurep 'xemacs)
17049 (put-text-property beg end 'invisible t)
17050 (put-text-property beg end 'end-glyph (make-glyph str)))
17051 (put-text-property beg end 'display str))))
17053 (defun org-translate-time (string)
17054 "Translate all timestamps in STRING to custom format.
17055 But do this only if the variable `org-display-custom-times' is set."
17056 (when org-display-custom-times
17059 (re org-ts-regexp-both)
17060 t1 with-hm inactive tf time str beg end)
17061 (while (setq start (string-match re string start))
17062 (setq beg (match-beginning 0)
17064 t1 (save-match-data
17065 (org-parse-time-string (substring string beg end) t))
17066 with-hm (and (nth 1 t1) (nth 2 t1))
17067 inactive (equal (substring string beg (1+ beg)) "[")
17068 tf (funcall (if with-hm 'cdr 'car)
17069 org-time-stamp-custom-formats)
17070 time (org-fix-decoded-time t1)
17071 str (format-time-string
17073 (if inactive "[" "<") (substring tf 1 -1)
17074 (if inactive "]" ">"))
17075 (apply 'encode-time time))
17076 string (replace-match str t t string)
17077 start (+ start (length str)))))))
17080 (defun org-fix-decoded-time (time)
17081 "Set 0 instead of nil for the first 6 elements of time.
17082 Don't touch the rest."
17084 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
17086 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
17088 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
17089 "Difference between TIMESTAMP-STRING and now in days.
17090 If SECONDS is non-nil, return the difference in seconds."
17091 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
17092 (- (funcall fdiff (org-time-string-to-time timestamp-string))
17093 (funcall fdiff (current-time)))))
17095 (defun org-deadline-close (timestamp-string &optional ndays)
17096 "Is the time in TIMESTAMP-STRING close to the current date?"
17097 (setq ndays (or ndays (org-get-wdays timestamp-string)))
17098 (and (< (org-time-stamp-to-now timestamp-string) ndays)
17099 (not (org-entry-is-done-p))))
17101 (defun org-get-wdays (ts &optional delay zero-delay)
17102 "Get the deadline lead time appropriate for timestring TS.
17103 When DELAY is non-nil, get the delay time for scheduled items
17104 instead of the deadline lead time. When ZERO-DELAY is non-nil
17105 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
17106 don't try to find the delay cookie in the scheduled timestamp."
17107 (let ((tv (if delay org-scheduled-delay-days
17108 org-deadline-warning-days)))
17110 ((or (and delay (< tv 0))
17111 (and delay zero-delay (<= tv 0))
17112 (and (not delay) (<= tv 0)))
17113 ;; Enforce this value no matter what
17115 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
17116 ;; lead time is specified.
17117 (floor (* (string-to-number (match-string 1 ts))
17118 (cdr (assoc (match-string 2 ts)
17119 '(("d" . 1) ("w" . 7)
17120 ("m" . 30.4) ("y" . 365.25)
17121 ("h" . 0.041667)))))))
17122 ;; go for the default.
17125 (defun org-calendar-select-mouse (ev)
17126 "Return to `org-read-date' with the date currently selected.
17127 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
17129 (mouse-set-point ev)
17130 (when (calendar-cursor-to-date)
17131 (let* ((date (calendar-cursor-to-date))
17132 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
17133 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
17134 (if (active-minibuffer-window) (exit-minibuffer))))
17136 (defun org-check-deadlines (ndays)
17137 "Check if there are any deadlines due or past due.
17138 A deadline is considered due if it happens within `org-deadline-warning-days'
17139 days from today's date. If the deadline appears in an entry marked DONE,
17140 it is not shown. The prefix arg NDAYS can be used to test that many
17141 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
17143 (let* ((org-warn-days
17145 ((equal ndays '(4)) 100000)
17146 (ndays (prefix-numeric-value ndays))
17147 (t (abs org-deadline-warning-days))))
17148 (case-fold-search nil)
17149 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17151 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
17153 (message "%d deadlines past-due or due within %d days"
17154 (org-occur regexp nil callback)
17157 (defsubst org-re-timestamp (type)
17158 "Return a regexp for timestamp TYPE.
17159 Allowed values for TYPE are:
17161 all: all timestamps
17162 active: only active timestamps (<...>)
17163 inactive: only inactive timestamps ([...])
17164 scheduled: only scheduled timestamps
17165 deadline: only deadline timestamps
17166 closed: only closed time-stamps
17168 When TYPE is nil, fall back on returning a regexp that matches
17169 both scheduled and deadline timestamps."
17170 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9>
\n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
17171 ((eq type 'active) org-ts-regexp)
17172 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]")
17173 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
17174 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
17175 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^
\n>]*?\\)\\]"))
17176 ((eq type 'scheduled-or-deadline)
17177 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
17179 (defun org-check-before-date (date)
17180 "Check if there are deadlines or scheduled entries before DATE."
17181 (interactive (list (org-read-date)))
17182 (let ((case-fold-search nil)
17183 (regexp (org-re-timestamp org-ts-type))
17185 (lambda () (time-less-p
17186 (org-time-string-to-time (match-string 1))
17187 (org-time-string-to-time date)))))
17188 (message "%d entries before %s"
17189 (org-occur regexp nil callback) date)))
17191 (defun org-check-after-date (date)
17192 "Check if there are deadlines or scheduled entries after DATE."
17193 (interactive (list (org-read-date)))
17194 (let ((case-fold-search nil)
17195 (regexp (org-re-timestamp org-ts-type))
17199 (org-time-string-to-time (match-string 1))
17200 (org-time-string-to-time date))))))
17201 (message "%d entries after %s"
17202 (org-occur regexp nil callback) date)))
17204 (defun org-check-dates-range (start-date end-date)
17205 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17206 (interactive (list (org-read-date nil nil nil "Range starts")
17207 (org-read-date nil nil nil "Range end")))
17208 (let ((case-fold-search nil)
17209 (regexp (org-re-timestamp org-ts-type))
17212 (let ((match (match-string 1)))
17215 (org-time-string-to-time match)
17216 (org-time-string-to-time start-date)))
17218 (org-time-string-to-time match)
17219 (org-time-string-to-time end-date)))))))
17220 (message "%d entries between %s and %s"
17221 (org-occur regexp nil callback) start-date end-date)))
17223 (defun org-evaluate-time-range (&optional to-buffer)
17224 "Evaluate a time range by computing the difference between start and end.
17225 Normally the result is just printed in the echo area, but with prefix arg
17226 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17227 If the time range is actually in a table, the result is inserted into the
17229 For time difference computation, a year is assumed to be exactly 365
17230 days in order to avoid rounding problems."
17233 (org-clock-update-time-maybe)
17235 (unless (org-at-date-range-p t)
17236 (goto-char (point-at-bol))
17237 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17238 (if (not (org-at-date-range-p t))
17239 (user-error "Not at a time-stamp range, and none found in current line")))
17240 (let* ((ts1 (match-string 1))
17241 (ts2 (match-string 2))
17242 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17243 (match-end (match-end 0))
17244 (time1 (org-time-string-to-time ts1))
17245 (time2 (org-time-string-to-time ts2))
17246 (t1 (org-float-time time1))
17247 (t2 (org-float-time time2))
17248 (diff (abs (- t2 t1)))
17249 (negative (< (- t2 t1) 0))
17250 ;; (ys (floor (* 365 24 60 60)))
17253 (fy "%dy %dd %02d:%02d")
17255 (fd "%dd %02d:%02d")
17260 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17262 d (floor (/ diff ds)) diff (mod diff ds)
17263 h (floor (/ diff hs)) diff (mod diff hs)
17264 m (floor (/ diff 60)))
17265 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17267 d (floor (+ (/ diff ds) 0.5))
17269 (if (not to-buffer)
17270 (message "%s" (org-make-tdiff-string y d h m))
17271 (if (org-at-table-p)
17273 (goto-char match-end)
17275 (and (looking-at " *|") (goto-char (match-end 0))))
17276 (goto-char match-end))
17278 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17279 (replace-match ""))
17280 (if negative (insert " -"))
17281 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17282 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17283 (insert " " (format fh h m))))
17284 (if align (org-table-align))
17285 (message "Time difference inserted")))))
17287 (defun org-make-tdiff-string (y d h m)
17290 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17292 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17294 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17296 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17298 (apply 'format fmt (nreverse l))))
17300 (defun org-time-string-to-time (s &optional buffer pos)
17301 "Convert a timestamp string into internal time."
17302 (condition-case errdata
17303 (apply 'encode-time (org-parse-time-string s))
17304 (error (error "Bad timestamp `%s'%s\nError was: %s"
17305 s (if (not (and buffer pos))
17307 (format " at %d in buffer `%s'" pos buffer))
17310 (defun org-time-string-to-seconds (s)
17311 "Convert a timestamp string to a number of seconds."
17312 (org-float-time (org-time-string-to-time s)))
17314 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17315 "Convert a time stamp to an absolute day number.
17316 If there is a specifier for a cyclic time stamp, get the closest
17318 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17319 The variable `date' is bound by the calendar when this is called."
17321 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17322 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17325 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17326 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17327 (time-to-days (current-time))) (match-string 0 s)
17330 (condition-case errdata
17331 (apply 'encode-time (org-parse-time-string s))
17332 (error (error "Bad timestamp `%s'%s\nError was: %s"
17333 s (if (not (and buffer pos))
17335 (format " at %d in buffer `%s'" pos buffer))
17336 (cdr errdata))))))))
17338 (defun org-days-to-iso-week (days)
17339 "Return the iso week number."
17341 (car (calendar-iso-from-absolute days)))
17343 (defun org-small-year-to-year (year)
17344 "Convert 2-digit years into 4-digit years.
17345 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17346 The year 2000 cannot be abbreviated. Any year larger than 99
17347 is returned unchanged."
17349 (setq year (+ 2000 year))
17351 (setq year (+ 1900 year))))
17354 (defun org-time-from-absolute (d)
17355 "Return the time corresponding to date D.
17356 D may be an absolute day number, or a calendar-type list (month day year)."
17357 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17358 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17360 (defun org-calendar-holiday ()
17361 "List of holidays, for Diary display in Org-mode."
17362 (require 'holidays)
17364 (if (fboundp 'calendar-check-holidays)
17365 'calendar-check-holidays 'check-calendar-holidays) date)))
17366 (if hl (mapconcat 'identity hl "; "))))
17368 (defun org-diary-sexp-entry (sexp entry date)
17369 "Process a SEXP diary ENTRY for DATE."
17370 (require 'diary-lib)
17371 (let ((result (if calendar-debug-sexp
17372 (let ((stack-trace-on-error t))
17373 (eval (car (read-from-string sexp))))
17374 (condition-case nil
17375 (eval (car (read-from-string sexp)))
17378 (message "Bad sexp at line %d in %s: %s"
17380 (buffer-file-name) sexp)
17382 (cond ((stringp result) (split-string result "; "))
17383 ((and (consp result)
17384 (not (consp (cdr result)))
17385 (stringp (cdr result))) (cdr result))
17386 ((and (consp result)
17387 (stringp (car result))) result)
17390 (defun org-diary-to-ical-string (frombuf)
17391 "Get iCalendar entries from diary entries in buffer FROMBUF.
17392 This uses the icalendar.el library."
17393 (let* ((tmpdir (if (featurep 'xemacs)
17395 temporary-file-directory))
17396 (tmpfile (make-temp-name
17397 (expand-file-name "orgics" tmpdir)))
17399 (with-current-buffer frombuf
17400 (icalendar-export-region (point-min) (point-max) tmpfile)
17401 (setq buf (find-buffer-visiting tmpfile))
17403 (goto-char (point-min))
17404 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17405 (setq b (match-beginning 0)))
17406 (goto-char (point-max))
17407 (if (re-search-backward "^END:VEVENT" nil t)
17408 (setq e (match-end 0)))
17409 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17411 (delete-file tmpfile)
17414 (defun org-closest-date (start current change prefer show-all)
17415 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17416 When PREFER is `past', return a date that is either CURRENT or past.
17417 When PREFER is `future', return a date that is either CURRENT or future.
17418 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17419 ;; Make the proper lists from the dates
17421 (let ((a1 '(("h" . hour)
17426 (shour (nth 2 (org-parse-time-string start)))
17427 dn dw sday cday n1 n2 n0
17428 d m y y1 y2 date1 date2 nmonths nm ny m2)
17430 (setq start (org-date-to-gregorian start)
17431 current (org-date-to-gregorian
17434 (time-to-days (current-time))))
17435 sday (calendar-absolute-from-gregorian start)
17436 cday (calendar-absolute-from-gregorian current))
17438 (if (<= cday sday) (throw 'exit sday))
17440 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17441 (setq dn (string-to-number (match-string 1 change))
17442 dw (cdr (assoc (match-string 2 change) a1)))
17443 (user-error "Invalid change specifier: %s" change))
17444 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17447 (let ((missing-hours
17448 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17450 (setq n1 (if (zerop missing-hours) cday
17451 (- cday (1+ (floor (/ missing-hours 24)))))
17452 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17454 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17457 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17458 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17459 (setq date1 (list m d y1)
17460 n1 (calendar-absolute-from-gregorian date1)
17461 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17462 n2 (calendar-absolute-from-gregorian date2)))
17464 ;; approx number of month between the two dates
17465 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17466 ;; How often does dn fit in there?
17467 (setq d (nth 1 start) m (car start) y (nth 2 start)
17468 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17470 ny (floor (/ m 12))
17473 (while (> m 12) (setq m (- m 12) y (1+ y)))
17474 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17475 (setq m2 (+ m dn) y2 y)
17476 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17477 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17478 (while (<= n2 cday)
17479 (setq n1 n2 m m2 y y2)
17480 (setq m2 (+ m dn) y2 y)
17481 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17482 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17483 ;; Make sure n1 is the earlier date
17484 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17487 ((eq prefer 'past) (if (= cday n2) n2 n1))
17488 ((eq prefer 'future) (if (= cday n1) n1 n2))
17489 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17491 ((eq prefer 'past) (if (= cday n2) n2 n1))
17492 ((eq prefer 'future) (if (= cday n1) n1 n2))
17493 (t (if (= cday n1) n1 n2)))))))
17495 (defun org-date-to-gregorian (date)
17496 "Turn any specification of DATE into a Gregorian date for the calendar."
17497 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17498 ((and (listp date) (= (length date) 3)) date)
17500 (setq date (org-parse-time-string date))
17501 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17503 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17505 (defun org-parse-time-string (s &optional nodefault)
17506 "Parse the standard Org-mode time string.
17507 This should be a lot faster than the normal `parse-time-string'.
17508 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17509 hour and minute fields will be nil if not given."
17510 (cond ((string-match org-ts-regexp0 s)
17512 (if (or (match-beginning 8) (not nodefault))
17513 (string-to-number (or (match-string 8 s) "0")))
17514 (if (or (match-beginning 7) (not nodefault))
17515 (string-to-number (or (match-string 7 s) "0")))
17516 (string-to-number (match-string 4 s))
17517 (string-to-number (match-string 3 s))
17518 (string-to-number (match-string 2 s))
17520 ((string-match "^<[^>]+>$" s)
17521 (decode-time (seconds-to-time (org-matcher-time s))))
17522 (t (error "Not a standard Org-mode time string: %s" s))))
17524 (defun org-timestamp-up (&optional arg)
17525 "Increase the date item at the cursor by one.
17526 If the cursor is on the year, change the year. If it is on the month,
17527 the day or the time, change that.
17528 With prefix ARG, change by that many units."
17530 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17532 (defun org-timestamp-down (&optional arg)
17533 "Decrease the date item at the cursor by one.
17534 If the cursor is on the year, change the year. If it is on the month,
17535 the day or the time, change that.
17536 With prefix ARG, change by that many units."
17538 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17540 (defun org-timestamp-up-day (&optional arg)
17541 "Increase the date in the time stamp by one day.
17542 With prefix ARG, change that many days."
17544 (if (and (not (org-at-timestamp-p t))
17545 (org-at-heading-p))
17547 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17549 (defun org-timestamp-down-day (&optional arg)
17550 "Decrease the date in the time stamp by one day.
17551 With prefix ARG, change that many days."
17553 (if (and (not (org-at-timestamp-p t))
17554 (org-at-heading-p))
17556 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17558 (defun org-at-timestamp-p (&optional inactive-ok)
17559 "Determine if the cursor is in or at a timestamp."
17561 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17563 (ans (or (looking-at tsr)
17565 (skip-chars-backward "^[<\n\r\t")
17566 (if (> (point) (point-min)) (backward-char 1))
17567 (and (looking-at tsr)
17568 (> (- (match-end 0) pos) -1))))))
17570 (boundp 'org-ts-what)
17573 ((= pos (match-beginning 0)) 'bracket)
17574 ;; Point is considered to be "on the bracket" whether
17575 ;; it's really on it or right after it.
17576 ((= pos (1- (match-end 0))) 'bracket)
17577 ((= pos (match-end 0)) 'after)
17578 ((org-pos-in-match-range pos 2) 'year)
17579 ((org-pos-in-match-range pos 3) 'month)
17580 ((org-pos-in-match-range pos 7) 'hour)
17581 ((org-pos-in-match-range pos 8) 'minute)
17582 ((or (org-pos-in-match-range pos 4)
17583 (org-pos-in-match-range pos 5)) 'day)
17584 ((and (> pos (or (match-end 8) (match-end 5)))
17585 (< pos (match-end 0)))
17586 (- pos (or (match-end 8) (match-end 5))))
17590 (defun org-toggle-timestamp-type ()
17591 "Toggle the type (<active> or [inactive]) of a time stamp."
17593 (when (org-at-timestamp-p t)
17594 (let ((beg (match-beginning 0)) (end (match-end 0))
17595 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17598 (while (re-search-forward "[][<>]" end t)
17599 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17601 (message "Timestamp is now %sactive"
17602 (if (equal (char-after beg) ?<) "" "in")))))
17604 (defun org-at-clock-log-p nil
17605 "Is the cursor on the clock log line?"
17607 (move-beginning-of-line 1)
17608 (looking-at org-clock-line-re)))
17610 (defvar org-clock-history) ; defined in org-clock.el
17611 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17612 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17613 "Change the date in the time stamp at point.
17614 The date will be changed by N times WHAT. WHAT can be `day', `month',
17615 `year', `minute', `second'. If WHAT is not given, the cursor position
17616 in the timestamp determines what will be changed.
17617 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17618 (let ((origin (point)) origin-cat
17620 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17623 ts time time0 fixnext clrgx)
17624 (if (not (org-at-timestamp-p t))
17625 (user-error "Not at a timestamp"))
17626 (if (and (not what) (eq org-ts-what 'bracket))
17627 (org-toggle-timestamp-type)
17628 ;; Point isn't on brackets. Remember the part of the time-stamp
17629 ;; the point was in. Indeed, size of time-stamps may change,
17630 ;; but point must be kept in the same category nonetheless.
17631 (setq origin-cat org-ts-what)
17632 (if (and (not what) (not (eq org-ts-what 'day))
17633 org-display-custom-times
17634 (get-text-property (point) 'display)
17635 (not (get-text-property (1- (point)) 'display)))
17636 (setq org-ts-what 'day))
17637 (setq org-ts-what (or what org-ts-what)
17638 inactive (= (char-after (match-beginning 0)) ?\[)
17639 ts (match-string 0))
17641 (when (string-match
17642 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17644 (setq extra (match-string 1 ts))
17645 (if suppress-tmp-delay
17646 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17647 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17649 (setq time0 (org-parse-time-string ts))
17651 (eq org-ts-what 'minute)
17652 (not current-prefix-arg))
17653 ;; This looks like s-up and s-down. Change by one rounding step.
17654 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17655 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17656 (setcar (cdr time0) (+ (nth 1 time0)
17657 (if (> n 0) (- rem) (- dm rem))))))
17659 (encode-time (or (car time0) 0)
17660 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17661 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17662 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17663 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17664 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17666 (when (and (member org-ts-what '(hour minute))
17668 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17669 (setq extra (org-modify-ts-extra
17671 (if (eq org-ts-what 'hour) 2 5)
17673 (when (integerp org-ts-what)
17674 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17675 (if (eq what 'calendar)
17676 (let ((cal-date (org-get-date-from-calendar)))
17677 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17678 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17679 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17680 (setcar time0 (or (car time0) 0))
17681 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17682 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17683 (setq time (apply 'encode-time time0))))
17684 ;; Insert the new time-stamp, and ensure point stays in the same
17685 ;; category as before (i.e. not after the last position in that
17687 (let ((pos (point)))
17688 ;; Stay before inserted string. `save-excursion' is of no use.
17689 (setq org-last-changed-timestamp
17690 (org-insert-time-stamp time with-hm inactive nil nil extra))
17693 (looking-at org-ts-regexp3)
17695 ;; `day' category ends before `hour' if any, or at
17696 ;; the end of the day name.
17697 ((eq origin-cat 'day)
17698 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17699 ((eq origin-cat 'hour) (min (match-end 7) origin))
17700 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17701 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17702 ;; `year' and `month' have both fixed size: point
17703 ;; couldn't have moved into another part.
17705 ;; Update clock if on a CLOCK line.
17706 (org-clock-update-time-maybe)
17707 ;; Maybe adjust the closest clock in `org-clock-history'
17708 (when org-clock-adjust-closest
17709 (if (not (and (org-at-clock-log-p)
17710 (< 1 (length (delq nil (mapcar 'marker-position
17711 org-clock-history))))))
17712 (message "No clock to adjust")
17713 (cond ((save-excursion ; fix previous clock?
17714 (re-search-backward org-ts-regexp0 nil t)
17715 (org-looking-back (concat org-clock-string " \\[")))
17716 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17717 ((save-excursion ; fix next clock?
17718 (re-search-backward org-ts-regexp0 nil t)
17719 (looking-at (concat org-ts-regexp0 "\\] =>")))
17720 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17721 (save-window-excursion
17722 ;; Find closest clock to point, adjust the previous/next one in history
17723 (let* ((p (save-excursion (org-back-to-heading t)))
17724 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17726 (+ fixnext (- (length cl) (or (length (member (apply 'min cl) cl)) 100))))
17727 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17729 (message "No clock to adjust")
17731 (org-goto-marker-or-bmk clfixpos)
17733 (when (re-search-forward clrgx nil t)
17734 (goto-char (match-beginning 1))
17735 (let (org-clock-adjust-closest)
17736 (org-timestamp-change n org-ts-what updown))
17737 (message "Clock adjusted in %s for heading: %s"
17738 (file-name-nondirectory (buffer-file-name))
17739 (org-get-heading t t)))))))))
17740 ;; Try to recenter the calendar window, if any.
17741 (if (and org-calendar-follow-timestamp-change
17742 (get-buffer-window "*Calendar*" t)
17743 (memq org-ts-what '(day month year)))
17744 (org-recenter-calendar (time-to-days time))))))
17746 (defun org-modify-ts-extra (s pos n dm)
17747 "Change the different parts of the lead-time and repeat fields in timestamp."
17748 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17750 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17752 ((or (org-pos-in-match-range pos 2)
17753 (org-pos-in-match-range pos 3))
17754 (setq m (string-to-number (match-string 3 s))
17755 h (string-to-number (match-string 2 s)))
17756 (if (org-pos-in-match-range pos 2)
17758 (setq n (* dm (org-no-warnings (signum n))))
17759 (when (not (= 0 (setq rem (% m dm))))
17760 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17762 (if (< m 0) (setq m (+ m 60) h (1- h)))
17763 (if (> m 59) (setq m (- m 60) h (1+ h)))
17764 (setq h (min 24 (max 0 h)))
17765 (setq ng 1 new (format "-%02d:%02d" h m)))
17766 ((org-pos-in-match-range pos 6)
17767 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17768 ((org-pos-in-match-range pos 5)
17769 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17771 ((org-pos-in-match-range pos 9)
17772 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17773 ((org-pos-in-match-range pos 8)
17774 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17778 (substring s 0 (match-beginning ng))
17780 (substring s (match-end ng))))))
17783 (defun org-recenter-calendar (date)
17784 "If the calendar is visible, recenter it to DATE."
17785 (let ((cwin (get-buffer-window "*Calendar*" t)))
17787 (let ((calendar-move-hook nil))
17788 (with-selected-window cwin
17789 (calendar-goto-date (if (listp date) date
17790 (calendar-gregorian-from-absolute date))))))))
17792 (defun org-goto-calendar (&optional arg)
17793 "Go to the Emacs calendar at the current date.
17794 If there is a time stamp in the current line, go to that date.
17795 A prefix ARG can be used to force the current date."
17797 (let ((tsr org-ts-regexp) diff
17798 (calendar-move-hook nil)
17799 (calendar-view-holidays-initially-flag nil)
17800 (calendar-view-diary-initially-flag nil))
17801 (if (or (org-at-timestamp-p)
17803 (beginning-of-line 1)
17804 (looking-at (concat ".*" tsr))))
17805 (let ((d1 (time-to-days (current-time)))
17807 (org-time-string-to-time (match-string 1)))))
17808 (setq diff (- d2 d1))))
17810 (calendar-goto-today)
17811 (if (and diff (not arg)) (calendar-forward-day diff))))
17813 (defun org-get-date-from-calendar ()
17814 "Return a list (month day year) of date at point in calendar."
17815 (with-current-buffer "*Calendar*"
17817 (calendar-cursor-to-date))))
17819 (defun org-date-from-calendar ()
17820 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17821 If there is already a time stamp at the cursor position, update it."
17823 (if (org-at-timestamp-p t)
17824 (org-timestamp-change 0 'calendar)
17825 (let ((cal-date (org-get-date-from-calendar)))
17826 (org-insert-time-stamp
17827 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17829 (defcustom org-effort-durations
17832 ("w" . ,(* 60 8 5))
17833 ("m" . ,(* 60 8 5 4))
17834 ("y" . ,(* 60 8 5 40)))
17835 "Conversion factor to minutes for an effort modifier.
17837 Each entry has the form (MODIFIER . MINUTES).
17839 In an effort string, a number followed by MODIFIER is multiplied
17840 by the specified number of MINUTES to obtain an effort in
17843 For example, if the value of this variable is ((\"hours\" . 60)), then an
17844 effort string \"2hours\" is equivalent to 120 minutes."
17847 :type '(alist :key-type (string :tag "Modifier")
17848 :value-type (number :tag "Minutes")))
17850 (defun org-minutes-to-clocksum-string (m)
17851 "Format number of minutes as a clocksum string.
17852 The format is determined by `org-time-clocksum-format',
17853 `org-time-clocksum-use-fractional' and
17854 `org-time-clocksum-fractional-format' and
17855 `org-time-clocksum-use-effort-durations'."
17856 (let ((clocksum "")
17857 (m (round m)) ; Don't allow fractions of minutes
17859 (setq h (if org-time-clocksum-use-effort-durations
17860 (cdr (assoc "h" org-effort-durations)) 60)
17861 d (if org-time-clocksum-use-effort-durations
17862 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17863 w (if org-time-clocksum-use-effort-durations
17864 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17865 mo (if org-time-clocksum-use-effort-durations
17866 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17867 y (if org-time-clocksum-use-effort-durations
17868 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17869 ;; fractional format
17870 (if org-time-clocksum-use-fractional
17872 ;; single format string
17873 ((stringp org-time-clocksum-fractional-format)
17874 (format org-time-clocksum-fractional-format (/ m (float h))))
17875 ;; choice of fractional formats for different time units
17876 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17877 (> (/ (truncate m) (* y d h)) 0))
17878 (format fmt (/ m (* y d (float h)))))
17879 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17880 (> (/ (truncate m) (* mo d h)) 0))
17881 (format fmt (/ m (* mo d (float h)))))
17882 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17883 (> (/ (truncate m) (* w d h)) 0))
17884 (format fmt (/ m (* w d (float h)))))
17885 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17886 (> (/ (truncate m) (* d h)) 0))
17887 (format fmt (/ m (* d (float h)))))
17888 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17889 (> (/ (truncate m) h) 0))
17890 (format fmt (/ m (float h))))
17891 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17893 ;; fall back to smallest time unit with a format
17894 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17895 (format fmt (/ m (float h))))
17896 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17897 (format fmt (/ m (* d (float h)))))
17898 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17899 (format fmt (/ m (* w d (float h)))))
17900 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17901 (format fmt (/ m (* mo d (float h)))))
17902 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17903 (format fmt (/ m (* y d (float h))))))
17904 ;; standard (non-fractional) format, with single format string
17905 (if (stringp org-time-clocksum-format)
17906 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17907 ;; separate formats components
17908 (and (setq fmt (plist-get org-time-clocksum-format :years))
17909 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17910 (plist-get org-time-clocksum-format :require-years))
17911 (setq clocksum (concat clocksum (format fmt n))
17912 m (- m (* n y d h))))
17913 (and (setq fmt (plist-get org-time-clocksum-format :months))
17914 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17915 (plist-get org-time-clocksum-format :require-months))
17916 (setq clocksum (concat clocksum (format fmt n))
17917 m (- m (* n mo d h))))
17918 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17919 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17920 (plist-get org-time-clocksum-format :require-weeks))
17921 (setq clocksum (concat clocksum (format fmt n))
17922 m (- m (* n w d h))))
17923 (and (setq fmt (plist-get org-time-clocksum-format :days))
17924 (or (> (setq n (/ (truncate m) (* d h))) 0)
17925 (plist-get org-time-clocksum-format :require-days))
17926 (setq clocksum (concat clocksum (format fmt n))
17927 m (- m (* n d h))))
17928 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17929 (or (> (setq n (/ (truncate m) h)) 0)
17930 (plist-get org-time-clocksum-format :require-hours))
17931 (setq clocksum (concat clocksum (format fmt n))
17933 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17934 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17935 (setq clocksum (concat clocksum (format fmt m))))
17936 ;; return formatted time duration
17939 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17940 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17941 "Org mode version 8.0")
17943 (defun org-hours-to-clocksum-string (n)
17944 (org-minutes-to-clocksum-string (* n 60)))
17946 (defun org-hh:mm-string-to-minutes (s)
17947 "Convert a string H:MM to a number of minutes.
17948 If the string is just a number, interpret it as minutes.
17949 In fact, the first hh:mm or number in the string will be taken,
17950 there can be extra stuff in the string.
17951 If no number is found, the return value is 0."
17954 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17955 (+ (* (string-to-number (match-string 1 s)) 60)
17956 (string-to-number (match-string 2 s))))
17957 ((string-match "\\([0-9]+\\)" s)
17958 (string-to-number (match-string 1 s)))
17961 (defcustom org-image-actual-width t
17962 "Should we use the actual width of images when inlining them?
17964 When set to `t', always use the image width.
17966 When set to a number, use imagemagick (when available) to set
17967 the image's width to this value.
17969 When set to a number in a list, try to get the width from any
17970 #+ATTR.* keyword if it matches a width specification like
17972 #+ATTR_HTML: :width 300px
17974 and fall back on that number if none is found.
17976 When set to nil, try to get the width from an #+ATTR.* keyword
17977 and fall back on the original width if none is found.
17979 This requires Emacs >= 24.1, build with imagemagick support."
17980 :group 'org-appearance
17982 :package-version '(Org . "8.0")
17984 (const :tag "Use the image width" t)
17985 (integer :tag "Use a number of pixels")
17986 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17987 (const :tag "Use #+ATTR* or don't resize" nil)))
17989 (defcustom org-agenda-inhibit-startup nil
17990 "Inhibit startup when preparing agenda buffers.
17991 When this variable is `t', the initialization of the Org agenda
17992 buffers is inhibited: e.g. the visibility state is not set, the
17993 tables are not re-aligned, etc."
17996 :group 'org-agenda)
17998 (define-obsolete-variable-alias
17999 'org-agenda-ignore-drawer-properties
18000 'org-agenda-ignore-properties "24.5")
18002 (defcustom org-agenda-ignore-properties nil
18003 "Avoid updating text properties when building the agenda.
18004 Properties are used to prepare buffers for effort estimates,
18005 appointments, statistics and subtree-local categories.
18006 If you don't use these in the agenda, you can add them to this
18007 list and agenda building will be a bit faster.
18008 The value is a list, with zero or more of the symbols `effort', `appt',
18009 `stats' or `category'."
18010 :type '(set :greedy t
18016 :package-version '(Org . "8.3")
18017 :group 'org-agenda)
18019 (defun org-duration-string-to-minutes (s &optional output-to-string)
18020 "Convert a duration string S to minutes.
18022 A bare number is interpreted as minutes, modifiers can be set by
18023 customizing `org-effort-durations' (which see).
18025 Entries containing a colon are interpreted as H:MM by
18026 `org-hh:mm-string-to-minutes'."
18028 (re (concat "\\([0-9.]+\\) *\\("
18029 (regexp-opt (mapcar 'car org-effort-durations))
18031 (while (string-match re s)
18032 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
18033 (string-to-number (match-string 1 s))))
18034 (setq s (replace-match "" nil t s)))
18035 (setq result (floor result))
18036 (incf result (org-hh:mm-string-to-minutes s))
18037 (if output-to-string (number-to-string result) result)))
18041 (defun org-save-all-org-buffers ()
18042 "Save all Org-mode buffers without user confirmation."
18044 (message "Saving all Org-mode buffers...")
18045 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
18046 (when (featurep 'org-id) (org-id-locations-save))
18047 (message "Saving all Org-mode buffers... done"))
18049 (defun org-revert-all-org-buffers ()
18050 "Revert all Org-mode buffers.
18051 Prompt for confirmation when there are unsaved changes.
18052 Be sure you know what you are doing before letting this function
18053 overwrite your changes.
18055 This function is useful in a setup where one tracks org files
18056 with a version control system, to revert on one machine after pulling
18057 changes from another. I believe the procedure must be like this:
18059 1. M-x org-save-all-org-buffers
18060 2. Pull changes from the other machine, resolve conflicts
18061 3. M-x org-revert-all-org-buffers"
18063 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
18064 (user-error "Abort"))
18066 (save-window-excursion
18069 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
18070 (with-current-buffer b buffer-file-name))
18071 (org-pop-to-buffer-same-window b)
18072 (revert-buffer t 'no-confirm)))
18074 (when (and (featurep 'org-id) org-id-track-globally)
18075 (org-id-locations-load)))))
18080 (defun org-switchb (&optional arg)
18081 "Switch between Org buffers.
18082 With one prefix argument, restrict available buffers to files.
18083 With two prefix arguments, restrict available buffers to agenda files.
18085 Defaults to `iswitchb' for buffer name completion.
18086 Set `org-completion-use-ido' to make it use ido instead."
18088 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
18089 ((equal arg '(16)) (org-buffer-list 'agenda))
18090 (t (org-buffer-list))))
18091 (org-completion-use-iswitchb org-completion-use-iswitchb)
18092 (org-completion-use-ido org-completion-use-ido))
18093 (unless (or org-completion-use-ido org-completion-use-iswitchb)
18094 (setq org-completion-use-iswitchb t))
18095 (org-pop-to-buffer-same-window
18096 (org-icompleting-read "Org buffer: "
18097 (mapcar 'list (mapcar 'buffer-name blist))
18100 ;;; Define some older names previously used for this functionality
18102 (defalias 'org-ido-switchb 'org-switchb)
18104 (defalias 'org-iswitchb 'org-switchb)
18106 (defun org-buffer-list (&optional predicate exclude-tmp)
18107 "Return a list of Org buffers.
18108 PREDICATE can be `export', `files' or `agenda'.
18110 export restrict the list to Export buffers.
18111 files restrict the list to buffers visiting Org files.
18112 agenda restrict the list to buffers visiting agenda files.
18114 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
18116 (agenda-files (and (eq predicate 'agenda)
18117 (mapcar 'file-truename (org-agenda-files t))))
18120 ((eq predicate 'files)
18121 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
18122 ((eq predicate 'export)
18123 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
18124 ((eq predicate 'agenda)
18126 (with-current-buffer b
18127 (and (derived-mode-p 'org-mode)
18128 (setq bfn (buffer-file-name b))
18129 (member (file-truename bfn) agenda-files)))))
18130 (t (lambda (b) (with-current-buffer b
18131 (or (derived-mode-p 'org-mode)
18132 (string-match "\*Org .*Export"
18133 (buffer-name b)))))))))
18137 (if (and (funcall filter b)
18138 (or (not exclude-tmp)
18139 (not (string-match "tmp" (buffer-name b)))))
18144 (defun org-agenda-files (&optional unrestricted archives)
18145 "Get the list of agenda files.
18146 Optional UNRESTRICTED means return the full list even if a restriction
18147 is currently in place.
18148 When ARCHIVES is t, include all archive files that are really being
18149 used by the agenda files. If ARCHIVE is `ifmode', do this only if
18150 `org-agenda-archives-mode' is t."
18153 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
18154 ((stringp org-agenda-files) (org-read-agenda-file-list))
18155 ((listp org-agenda-files) org-agenda-files)
18156 (t (error "Invalid value of `org-agenda-files'")))))
18157 (setq files (apply 'append
18158 (mapcar (lambda (f)
18159 (if (file-directory-p f)
18161 f t org-agenda-file-regexp)
18164 (when org-agenda-skip-unavailable-files
18165 (setq files (delq nil
18168 (and (file-readable-p file) file)))
18170 (when (or (eq archives t)
18171 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
18172 (setq files (org-add-archive-files files)))
18175 (defun org-agenda-file-p (&optional file)
18176 "Return non-nil, if FILE is an agenda file.
18177 If FILE is omitted, use the file associated with the current
18179 (member (or file (buffer-file-name))
18180 (org-agenda-files t)))
18182 (defun org-edit-agenda-file-list ()
18183 "Edit the list of agenda files.
18184 Depending on setup, this either uses customize to edit the variable
18185 `org-agenda-files', or it visits the file that is holding the list. In the
18186 latter case, the buffer is set up in a way that saving it automatically kills
18187 the buffer and restores the previous window configuration."
18189 (if (stringp org-agenda-files)
18190 (let ((cw (current-window-configuration)))
18191 (find-file org-agenda-files)
18192 (org-set-local 'org-window-configuration cw)
18193 (org-add-hook 'after-save-hook
18195 (set-window-configuration
18196 (prog1 org-window-configuration
18197 (kill-buffer (current-buffer))))
18198 (org-install-agenda-files-menu)
18199 (message "New agenda file list installed"))
18201 (message "%s" (substitute-command-keys
18202 "Edit list and finish with \\[save-buffer]")))
18203 (customize-variable 'org-agenda-files)))
18205 (defun org-store-new-agenda-file-list (list)
18206 "Set new value for the agenda file list and save it correctly."
18207 (if (stringp org-agenda-files)
18208 (let ((fe (org-read-agenda-file-list t)) b u)
18209 (while (setq b (find-buffer-visiting org-agenda-files))
18211 (with-temp-file org-agenda-files
18214 (lambda (f) ;; Keep un-expanded entries.
18215 (if (setq u (assoc f fe))
18220 (let ((org-mode-hook nil) (org-inhibit-startup t)
18221 (org-insert-mode-line-in-empty-file nil))
18222 (setq org-agenda-files list)
18223 (customize-save-variable 'org-agenda-files org-agenda-files))))
18225 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18226 "Read the list of agenda files from a file.
18227 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18228 filenames, used by `org-store-new-agenda-file-list' to write back
18229 un-expanded file names."
18230 (when (file-directory-p org-agenda-files)
18231 (error "`org-agenda-files' cannot be a single directory"))
18232 (when (stringp org-agenda-files)
18234 (insert-file-contents org-agenda-files)
18237 (let ((e (expand-file-name (substitute-in-file-name f)
18239 (if pair-with-expansion
18242 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18245 (defun org-cycle-agenda-files ()
18246 "Cycle through the files in `org-agenda-files'.
18247 If the current buffer visits an agenda file, find the next one in the list.
18248 If the current buffer does not, find the first agenda file."
18250 (let* ((fs (org-agenda-files t))
18251 (files (append fs (list (car fs))))
18252 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18254 (unless files (user-error "No agenda files"))
18256 (while (setq file (pop files))
18257 (if (equal (file-truename file) tcf)
18259 (find-file (car files))
18261 (find-file (car fs)))
18262 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18264 (defun org-agenda-file-to-front (&optional to-end)
18265 "Move/add the current file to the top of the agenda file list.
18266 If the file is not present in the list, it is added to the front. If it is
18267 present, it is moved there. With optional argument TO-END, add/move to the
18270 (let ((org-agenda-skip-unavailable-files nil)
18271 (file-alist (mapcar (lambda (x)
18272 (cons (file-truename x) x))
18273 (org-agenda-files t)))
18274 (ctf (file-truename
18275 (or buffer-file-name
18276 (user-error "Please save the current buffer to a file"))))
18278 (setq x (assoc ctf file-alist) had x)
18280 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18282 (setq file-alist (append (delq x file-alist) (list x)))
18283 (setq file-alist (cons x (delq x file-alist))))
18284 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18285 (org-install-agenda-files-menu)
18286 (message "File %s to %s of agenda file list"
18287 (if had "moved" "added") (if to-end "end" "front"))))
18289 (defun org-remove-file (&optional file)
18290 "Remove current file from the list of files in variable `org-agenda-files'.
18291 These are the files which are being checked for agenda entries.
18292 Optional argument FILE means use this file instead of the current."
18294 (let* ((org-agenda-skip-unavailable-files nil)
18295 (file (or file buffer-file-name
18296 (user-error "Current buffer does not visit a file")))
18297 (true-file (file-truename file))
18298 (afile (abbreviate-file-name file))
18299 (files (delq nil (mapcar
18301 (if (equal true-file
18304 (org-agenda-files t)))))
18305 (if (not (= (length files) (length (org-agenda-files t))))
18307 (org-store-new-agenda-file-list files)
18308 (org-install-agenda-files-menu)
18309 (message "Removed file: %s" afile))
18310 (message "File was not in list: %s (not removed)" afile))))
18312 (defun org-file-menu-entry (file)
18313 (vector file (list 'find-file file) t))
18315 (defun org-check-agenda-file (file)
18316 "Make sure FILE exists. If not, ask user what to do."
18317 (when (not (file-exists-p file))
18318 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18319 (abbreviate-file-name file))
18320 (let ((r (downcase (read-char-exclusive))))
18323 (org-remove-file file)
18324 (throw 'nextfile t))
18325 (t (user-error "Abort"))))))
18327 (defun org-get-agenda-file-buffer (file)
18328 "Get an agenda buffer visiting FILE.
18329 If the buffer needs to be created, add it to the list of buffers
18330 which might be released later."
18331 (let ((buf (org-find-base-buffer-visiting file)))
18333 buf ; just return it
18334 ;; Make a new buffer and remember it
18335 (setq buf (find-file-noselect file))
18336 (if buf (push buf org-agenda-new-buffers))
18339 (defun org-release-buffers (blist)
18340 "Release all buffers in list, asking the user for confirmation when needed.
18341 When a buffer is unmodified, it is just killed. When modified, it is saved
18342 \(if the user agrees) and then killed."
18344 (while (setq buf (pop blist))
18345 (setq file (buffer-file-name buf))
18346 (when (and (buffer-modified-p buf)
18348 (y-or-n-p (format "Save file %s? " file)))
18349 (with-current-buffer buf (save-buffer)))
18350 (kill-buffer buf))))
18352 (defun org-agenda-prepare-buffers (files)
18353 "Create buffers for all agenda files, protect archived trees and comments."
18355 (let ((pa '(:org-archived t))
18356 (pc '(:org-comment t))
18357 (pall '(:org-archived t :org-comment t))
18358 (inhibit-read-only t)
18359 (org-inhibit-startup org-agenda-inhibit-startup)
18360 (rea (concat ":" org-archive-tag ":"))
18362 (setq org-tag-alist-for-agenda nil
18363 org-tag-groups-alist-for-agenda nil)
18366 (while (setq file (pop files))
18370 (org-check-agenda-file file)
18371 (set-buffer (org-get-agenda-file-buffer file)))
18373 (org-set-regexps-and-options-for-tags)
18375 (goto-char (point-min))
18376 (let ((case-fold-search t))
18377 (when (search-forward "#+setupfile" nil t)
18378 ;; Don't set all regexps and options systematically as
18379 ;; this is only run for setting agenda tags from setup
18381 (org-set-regexps-and-options)))
18382 (or (memq 'category org-agenda-ignore-properties)
18383 (org-refresh-category-properties))
18384 (or (memq 'stats org-agenda-ignore-properties)
18385 (org-refresh-stats-properties))
18386 (or (memq 'effort org-agenda-ignore-properties)
18387 (org-refresh-effort-properties))
18388 (or (memq 'appt org-agenda-ignore-properties)
18389 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18390 (setq org-todo-keywords-for-agenda
18391 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18392 (setq org-done-keywords-for-agenda
18393 (append org-done-keywords-for-agenda org-done-keywords))
18394 (setq org-todo-keyword-alist-for-agenda
18395 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18396 (setq org-tag-alist-for-agenda
18398 (append org-tag-alist-for-agenda
18400 org-tag-persistent-alist)))
18402 (setq org-tag-groups-alist-for-agenda
18403 (org-uniquify-alist
18404 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18405 (org-with-silent-modifications
18407 (remove-text-properties (point-min) (point-max) pall)
18408 (when org-agenda-skip-archived-trees
18409 (goto-char (point-min))
18410 (while (re-search-forward rea nil t)
18411 (if (org-at-heading-p t)
18412 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18413 (goto-char (point-min))
18414 (setq re (format "^\\* .*\\<%s\\>" org-comment-string))
18415 (while (re-search-forward re nil t)
18416 (when (save-match-data (org-in-commented-heading-p t))
18417 (add-text-properties
18418 (match-beginning 0) (org-end-of-subtree t) pc)))))
18419 (goto-char pos)))))
18420 (setq org-todo-keywords-for-agenda
18421 (org-uniquify org-todo-keywords-for-agenda))
18422 (setq org-todo-keyword-alist-for-agenda
18423 (org-uniquify org-todo-keyword-alist-for-agenda))))
18426 ;;;; CDLaTeX minor mode
18428 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18429 "Keymap for the minor `org-cdlatex-mode'.")
18431 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18432 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18433 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18434 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18435 (org-defkey org-cdlatex-mode-map "\C-c{" 'org-cdlatex-environment-indent)
18437 (defvar org-cdlatex-texmathp-advice-is-done nil
18438 "Flag remembering if we have applied the advice to texmathp already.")
18440 (define-minor-mode org-cdlatex-mode
18441 "Toggle the minor `org-cdlatex-mode'.
18442 This mode supports entering LaTeX environment and math in LaTeX fragments
18444 \\{org-cdlatex-mode-map}"
18446 (when org-cdlatex-mode
18448 (run-hooks 'cdlatex-mode-hook)
18449 (cdlatex-compute-tables))
18450 (unless org-cdlatex-texmathp-advice-is-done
18451 (setq org-cdlatex-texmathp-advice-is-done t)
18452 (defadvice texmathp (around org-math-always-on activate)
18453 "Always return t in org-mode buffers.
18454 This is because we want to insert math symbols without dollars even outside
18455 the LaTeX math segments. If Orgmode thinks that point is actually inside
18456 an embedded LaTeX fragment, let texmathp do its job.
18457 \\[org-cdlatex-mode-map]"
18461 ((not (derived-mode-p 'org-mode)) ad-do-it)
18462 ((eq this-command 'cdlatex-math-symbol)
18463 (setq ad-return-value t
18464 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18466 (let ((p (org-inside-LaTeX-fragment-p)))
18467 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18468 (setq ad-return-value t
18469 texmathp-why '("Org-mode embedded math" . 0))
18470 (if p ad-do-it)))))))))
18472 (defun turn-on-org-cdlatex ()
18473 "Unconditionally turn on `org-cdlatex-mode'."
18474 (org-cdlatex-mode 1))
18476 (defun org-try-cdlatex-tab ()
18477 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18478 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18479 - inside a LaTeX fragment, or
18480 - after the first word in a line, where an abbreviation expansion could
18481 insert a LaTeX environment."
18482 (when org-cdlatex-mode
18484 ;; Before any word on the line: No expansion possible.
18485 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18486 ;; Just after first word on the line: Expand it. Make sure it
18487 ;; cannot happen on headlines, though.
18489 (skip-chars-backward "a-zA-Z0-9*")
18490 (skip-chars-backward " \t")
18491 (and (bolp) (not (org-at-heading-p))))
18493 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18495 (defun org-cdlatex-underscore-caret (&optional arg)
18496 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18497 Revert to the normal definition outside of these fragments."
18499 (if (org-inside-LaTeX-fragment-p)
18500 (call-interactively 'cdlatex-sub-superscript)
18501 (let (org-cdlatex-mode)
18502 (call-interactively (key-binding (vector last-input-event))))))
18504 (defun org-cdlatex-math-modify (&optional arg)
18505 "Execute `cdlatex-math-modify' in LaTeX fragments.
18506 Revert to the normal definition outside of these fragments."
18508 (if (org-inside-LaTeX-fragment-p)
18509 (call-interactively 'cdlatex-math-modify)
18510 (let (org-cdlatex-mode)
18511 (call-interactively (key-binding (vector last-input-event))))))
18513 (defun org-cdlatex-environment-indent (&optional environment item)
18514 "Execute `cdlatex-environment' and indent the inserted environment."
18516 (cdlatex-environment environment item)
18517 (let ((element (org-element-at-point)))
18518 (org-indent-region (org-element-property :begin element)
18519 (org-element-property :end element))))
18522 ;;;; LaTeX fragments
18524 (defun org-inside-LaTeX-fragment-p ()
18525 "Test if point is inside a LaTeX fragment.
18526 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18527 sequence appearing also before point.
18528 Even though the matchers for math are configurable, this function assumes
18529 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18530 delimiters are skipped when they have been removed by customization.
18531 The return value is nil, or a cons cell with the delimiter and the
18532 position of this delimiter.
18534 This function does a reasonably good job, but can locally be fooled by
18535 for example currency specifications. For example it will assume being in
18536 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18537 fragments that are properly closed, but during editing, we have to live
18538 with the uncertainty caused by missing closing delimiters. This function
18539 looks only before point, not after."
18541 (let ((pos (point))
18542 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18544 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18546 dd-on str (start 0) m re)
18549 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18550 re (nth 1 (assoc "$" org-latex-regexps)))
18551 (while (string-match re str start)
18553 ((= (match-end 0) (length str))
18554 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18555 ((= (match-end 0) (- (length str) 5))
18557 (t (setq start (match-end 0))))))
18558 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18560 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18561 (and (match-beginning 2) (throw 'exit nil))
18563 (while (re-search-backward "\\$\\$" lim t)
18564 (setq dd-on (not dd-on)))
18566 (if dd-on (cons "$$" m))))))
18568 (defun org-inside-latex-macro-p ()
18569 "Is point inside a LaTeX macro or its arguments?"
18572 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18574 (defvar org-latex-fragment-image-overlays nil
18575 "List of overlays carrying the images of latex fragments.")
18576 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18578 (defun org-remove-latex-fragment-image-overlays ()
18579 "Remove all overlays with LaTeX fragment images in current buffer."
18580 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18581 (setq org-latex-fragment-image-overlays nil))
18583 (define-obsolete-function-alias
18584 'org-preview-latex-fragment 'org-toggle-latex-fragment "24.4")
18585 (defun org-toggle-latex-fragment (&optional subtree)
18586 "Preview the LaTeX fragment at point, or all locally or globally.
18587 If the cursor is in a LaTeX fragment, create the image and overlay
18588 it over the source code. If there is no fragment at point, display
18589 all fragments in the current text, from one headline to the next. With
18590 prefix SUBTREE, display all fragments in the current subtree. With a
18591 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18592 the cursor is before the first headline,
18593 display all fragments in the buffer.
18594 The images can be removed again with \\[org-toggle-latex-fragment]."
18596 (unless buffer-file-name
18597 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18598 (if org-latex-fragment-image-overlays
18599 (progn (org-remove-latex-fragment-image-overlays)
18600 (message "LaTeX fragments images removed"))
18601 (when (display-graphic-p)
18602 (org-remove-latex-fragment-image-overlays)
18605 (let (beg end at msg)
18607 ((or (equal subtree '(16))
18608 (not (save-excursion
18609 (re-search-backward org-outline-regexp-bol nil t))))
18610 (setq beg (point-min) end (point-max)
18611 msg "Creating images for buffer...%s"))
18612 ((equal subtree '(4))
18613 (org-back-to-heading)
18614 (setq beg (point) end (org-end-of-subtree t)
18615 msg "Creating images for subtree...%s"))
18617 (if (setq at (org-inside-LaTeX-fragment-p))
18618 (goto-char (max (point-min) (- (cdr at) 2)))
18619 (org-back-to-heading))
18620 (setq beg (point) end (progn (outline-next-heading) (point))
18621 msg (if at "Creating image...%s"
18622 "Creating images for entry...%s"))))
18624 (narrow-to-region beg end)
18627 (concat org-latex-preview-ltxpng-directory
18628 (file-name-sans-extension
18629 (file-name-nondirectory buffer-file-name)))
18630 default-directory 'overlays msg at 'forbuffer
18631 org-latex-create-formula-image-program)
18632 (message msg "done. Use `C-c C-x C-l' to remove images.")))))))
18634 (defun org-format-latex (prefix &optional dir overlays msg at
18635 forbuffer processing-type)
18636 "Replace LaTeX fragments with links to an image, and produce images.
18637 Some of the options can be changed using the variable
18638 `org-format-latex-options'."
18639 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18640 (let* ((prefixnodir (file-name-nondirectory prefix))
18641 (absprefix (expand-file-name prefix dir))
18642 (todir (file-name-directory absprefix))
18643 (opt org-format-latex-options)
18644 (optnew org-format-latex-options)
18645 (matchers (plist-get opt :matchers))
18646 (re-list org-latex-regexps)
18647 (cnt 0) txt hash link beg end re e checkdir
18649 m n block-type block linkfile movefile ov)
18650 ;; Check the different regular expressions
18651 (while (setq e (pop re-list))
18652 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18653 block (if block-type "\n\n" ""))
18654 (when (member m matchers)
18655 (goto-char (point-min))
18656 (while (re-search-forward re nil t)
18657 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18659 (not (eq (get-char-property (match-beginning n)
18661 'org-latex-overlay))))
18663 ((eq processing-type 'verbatim))
18664 ((eq processing-type 'mathjax)
18665 ;; Prepare for MathJax processing.
18666 (setq string (match-string n))
18667 (when (member m '("$" "$1"))
18669 (delete-region (match-beginning n) (match-end n))
18670 (goto-char (match-beginning n))
18671 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18672 ((or (eq processing-type 'dvipng)
18673 (eq processing-type 'imagemagick))
18674 ;; Process to an image.
18675 (setq txt (match-string n)
18676 beg (match-beginning n) end (match-end n)
18678 (let ((face (face-at-point))
18679 (fg (plist-get opt :foreground))
18680 (bg (plist-get opt :background))
18681 ;; Ensure full list is printed.
18682 print-length print-level)
18684 ;; Get the colors from the face at point.
18686 (when (eq fg 'auto)
18687 (setq fg (face-attribute face :foreground nil 'default)))
18688 (when (eq bg 'auto)
18689 (setq bg (face-attribute face :background nil 'default)))
18690 (setq optnew (copy-sequence opt))
18691 (plist-put optnew :foreground fg)
18692 (plist-put optnew :background bg))
18693 (setq hash (sha1 (prin1-to-string
18694 (list org-format-latex-header
18695 org-latex-default-packages-alist
18696 org-latex-packages-alist
18697 org-format-latex-options
18698 forbuffer txt fg bg)))
18699 linkfile (format "%s_%s.png" prefix hash)
18700 movefile (format "%s_%s.png" absprefix hash)))
18701 (setq link (concat block "[[file:" linkfile "]]" block))
18702 (if msg (message msg cnt))
18704 (unless checkdir ; Ensure the directory exists.
18706 (or (file-directory-p todir) (make-directory todir t)))
18707 (unless (file-exists-p movefile)
18708 (org-create-formula-image
18709 txt movefile optnew forbuffer processing-type))
18713 (if (eq (overlay-get o 'org-overlay-type)
18714 'org-latex-overlay)
18715 (delete-overlay o)))
18716 (overlays-in beg end))
18717 (setq ov (make-overlay beg end))
18718 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18719 (if (featurep 'xemacs)
18721 (overlay-put ov 'invisible t)
18724 (make-glyph (vector 'png :file movefile))))
18727 (list 'image :type 'png :file movefile :ascent 'center)))
18728 (push ov org-latex-fragment-image-overlays)
18730 (delete-region beg end)
18731 (insert (org-add-props link
18732 (list 'org-latex-src
18733 (replace-regexp-in-string
18735 'org-latex-src-embed-type
18736 (if block-type 'paragraph 'character))))))
18737 ((eq processing-type 'mathml)
18738 ;; Process to MathML
18739 (unless (save-match-data (org-format-latex-mathml-available-p))
18740 (user-error "LaTeX to MathML converter not configured"))
18741 (setq txt (match-string n)
18742 beg (match-beginning n) end (match-end n)
18744 (if msg (message msg cnt))
18746 (delete-region beg end)
18747 (insert (org-format-latex-as-mathml
18748 txt block-type prefix dir)))
18750 (error "Unknown conversion type %s for LaTeX fragments"
18751 processing-type)))))))))
18753 (defun org-create-math-formula (latex-frag &optional mathml-file)
18754 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18755 Use `org-latex-to-mathml-convert-command'. If the conversion is
18756 sucessful, return the portion between \"<math...> </math>\"
18757 elements otherwise return nil. When MATHML-FILE is specified,
18758 write the results in to that file. When invoked as an
18759 interactive command, prompt for LATEX-FRAG, with initial value
18760 set to the current active region and echo the results for user
18762 (interactive (list (let ((frag (when (org-region-active-p)
18763 (buffer-substring-no-properties
18764 (region-beginning) (region-end)))))
18765 (read-string "LaTeX Fragment: " frag nil frag))))
18766 (unless latex-frag (user-error "Invalid LaTeX fragment"))
18767 (let* ((tmp-in-file (file-relative-name
18768 (make-temp-name (expand-file-name "ltxmathml-in"))))
18769 (ignore (write-region latex-frag nil tmp-in-file))
18770 (tmp-out-file (file-relative-name
18771 (make-temp-name (expand-file-name "ltxmathml-out"))))
18773 org-latex-to-mathml-convert-command
18774 `((?j . ,(shell-quote-argument
18775 (expand-file-name org-latex-to-mathml-jar-file)))
18776 (?I . ,(shell-quote-argument tmp-in-file))
18777 (?o . ,(shell-quote-argument tmp-out-file)))))
18778 mathml shell-command-output)
18779 (when (org-called-interactively-p 'any)
18780 (unless (org-format-latex-mathml-available-p)
18781 (user-error "LaTeX to MathML converter not configured")))
18782 (message "Running %s" cmd)
18783 (setq shell-command-output (shell-command-to-string cmd))
18785 (when (file-readable-p tmp-out-file)
18786 (with-current-buffer (find-file-noselect tmp-out-file t)
18787 (goto-char (point-min))
18788 (when (re-search-forward
18791 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18793 (regexp-quote "</math>")) nil t)
18794 (prog1 (match-string 0) (kill-buffer))))))
18798 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18800 (write-region mathml nil mathml-file))
18801 (when (org-called-interactively-p 'any)
18803 ((message "LaTeX to MathML conversion failed")
18804 (message shell-command-output)))
18805 (delete-file tmp-in-file)
18806 (when (file-exists-p tmp-out-file)
18807 (delete-file tmp-out-file))
18810 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18811 prefix &optional dir)
18812 "Use `org-create-math-formula' but check local cache first."
18813 (let* ((absprefix (expand-file-name prefix dir))
18814 (print-length nil) (print-level nil)
18815 (formula-id (concat
18820 org-latex-to-mathml-convert-command)))))
18821 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18822 (formula-cache-dir (file-name-directory formula-cache)))
18824 (unless (file-directory-p formula-cache-dir)
18825 (make-directory formula-cache-dir t))
18827 (unless (file-exists-p formula-cache)
18828 (org-create-math-formula latex-frag formula-cache))
18830 (if (file-exists-p formula-cache)
18831 ;; Successful conversion. Return the link to MathML file.
18833 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18834 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18835 'org-latex-src-embed-type (if latex-frag-type
18836 'paragraph 'character)))
18837 ;; Failed conversion. Return the LaTeX fragment verbatim
18840 (defun org-create-formula-image (string tofile options buffer &optional type)
18841 "Create an image from LaTeX source using dvipng or convert.
18842 This function calls either `org-create-formula-image-with-dvipng'
18843 or `org-create-formula-image-with-imagemagick' depending on the
18844 value of `org-latex-create-formula-image-program' or on the value
18845 of the optional TYPE variable.
18847 Note: ultimately these two function should be combined as they
18848 share a good deal of logic."
18849 (org-check-external-command
18850 "latex" "needed to convert LaTeX fragments to images")
18852 (case (or type org-latex-create-formula-image-program)
18854 (org-check-external-command
18855 "dvipng" "needed to convert LaTeX fragments to images")
18856 'org-create-formula-image-with-dvipng)
18858 (org-check-external-command
18859 "convert" "you need to install imagemagick")
18860 'org-create-formula-image-with-imagemagick)
18862 "Invalid value of `org-latex-create-formula-image-program'")))
18863 string tofile options buffer))
18865 (declare-function org-export-get-backend "ox" (name))
18866 (declare-function org-export--get-global-options "ox" (&optional backend))
18867 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18868 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18869 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18870 (defun org-create-formula--latex-header ()
18871 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18872 (let ((info (org-combine-plists (org-export--get-global-options
18873 (org-export-get-backend 'latex))
18874 (org-export--get-inbuffer-options
18875 (org-export-get-backend 'latex)))))
18876 (org-latex-guess-babel-language
18877 (org-latex-guess-inputenc
18878 (org-splice-latex-header
18879 org-format-latex-header
18880 org-latex-default-packages-alist
18881 org-latex-packages-alist t
18882 (plist-get info :latex-header)))
18885 ;; This function borrows from Ganesh Swami's latex2png.el
18886 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18887 "This calls dvipng."
18888 (require 'ox-latex)
18889 (let* ((tmpdir (if (featurep 'xemacs)
18891 temporary-file-directory))
18892 (texfilebase (make-temp-name
18893 (expand-file-name "orgtex" tmpdir)))
18894 (texfile (concat texfilebase ".tex"))
18895 (dvifile (concat texfilebase ".dvi"))
18896 (pngfile (concat texfilebase ".png"))
18897 (fnh (if (featurep 'xemacs)
18898 (font-height (face-font 'default))
18899 (face-attribute 'default :height nil)))
18900 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18901 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18902 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18904 (bg (or (plist-get options (if buffer :background :html-background))
18906 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18907 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18908 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18909 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18910 (let ((latex-header (org-create-formula--latex-header)))
18911 (with-temp-file texfile
18912 (insert latex-header)
18913 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18914 (let ((dir default-directory))
18917 (call-process "latex" nil nil nil texfile))
18919 (if (not (file-exists-p dvifile))
18920 (progn (message "Failed to create dvi file from %s" texfile) nil)
18922 (if (featurep 'xemacs)
18923 (call-process "dvipng" nil nil nil
18928 (call-process "dvipng" nil nil nil
18931 ;;"-x" scale "-y" scale
18935 (if (not (file-exists-p pngfile))
18936 (if org-format-latex-signal-error
18937 (error "Failed to create png file from %s" texfile)
18938 (message "Failed to create png file from %s" texfile)
18940 ;; Use the requested file name and clean up
18941 (copy-file pngfile tofile 'replace)
18942 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18943 (if (file-exists-p (concat texfilebase e))
18944 (delete-file (concat texfilebase e))))
18947 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18948 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18949 "This calls convert, which is included into imagemagick."
18950 (require 'ox-latex)
18951 (let* ((tmpdir (if (featurep 'xemacs)
18953 temporary-file-directory))
18954 (texfilebase (make-temp-name
18955 (expand-file-name "orgtex" tmpdir)))
18956 (texfile (concat texfilebase ".tex"))
18957 (pdffile (concat texfilebase ".pdf"))
18958 (pngfile (concat texfilebase ".png"))
18959 (fnh (if (featurep 'xemacs)
18960 (font-height (face-font 'default))
18961 (face-attribute 'default :height nil)))
18962 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18963 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18964 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18966 (bg (or (plist-get options (if buffer :background :html-background))
18968 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18969 (setq fg (org-latex-color-format fg)))
18970 (if (eq bg 'default) (setq bg (org-latex-color :background))
18971 (setq bg (org-latex-color-format
18972 (if (string= bg "Transparent") "white" bg))))
18973 (let ((latex-header (org-create-formula--latex-header)))
18974 (with-temp-file texfile
18975 (insert latex-header)
18976 (insert "\n\\begin{document}\n"
18977 "\\definecolor{fg}{rgb}{" fg "}\n"
18978 "\\definecolor{bg}{rgb}{" bg "}\n"
18979 "\n\\pagecolor{bg}\n"
18983 "\n\\end{document}\n")))
18984 (org-latex-compile texfile t)
18985 (if (not (file-exists-p pdffile))
18986 (progn (message "Failed to create pdf file from %s" texfile) nil)
18988 (if (featurep 'xemacs)
18989 (call-process "convert" nil nil nil
18995 ;; "-sharpen" "0x1.0"
18997 (call-process "convert" nil nil nil
19003 ;; "-sharpen" "0x1.0"
19005 (if (not (file-exists-p pngfile))
19006 (if org-format-latex-signal-error
19007 (error "Failed to create png file from %s" texfile)
19008 (message "Failed to create png file from %s" texfile)
19010 ;; Use the requested file name and clean up
19011 (copy-file pngfile tofile 'replace)
19012 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
19013 (if (file-exists-p (concat texfilebase e))
19014 (delete-file (concat texfilebase e))))
19017 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
19018 "Fill a LaTeX header template TPL.
19019 In the template, the following place holders will be recognized:
19021 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
19022 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
19023 [PACKAGES] \\usepackage statements for PKG
19024 [NO-PACKAGES] do not include PKG
19025 [EXTRA] the string EXTRA
19026 [NO-EXTRA] do not include EXTRA
19028 For backward compatibility, if both the positive and the negative place
19029 holder is missing, the positive one (without the \"NO-\") will be
19030 assumed to be present at the end of the template.
19031 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
19033 SNIPPETS-P indicates if this is run to create snippet images for HTML."
19034 (let (rpl (end ""))
19035 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
19036 (setq rpl (if (or (match-end 1) (not def-pkg))
19037 "" (org-latex-packages-to-string def-pkg snippets-p t))
19038 tpl (replace-match rpl t t tpl))
19039 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
19041 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
19042 (setq rpl (if (or (match-end 1) (not pkg))
19043 "" (org-latex-packages-to-string pkg snippets-p t))
19044 tpl (replace-match rpl t t tpl))
19047 (org-latex-packages-to-string pkg snippets-p)))))
19049 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
19050 (setq rpl (if (or (match-end 1) (not extra))
19051 "" (concat extra "\n"))
19052 tpl (replace-match rpl t t tpl))
19053 (if (and extra (string-match "\\S-" extra))
19054 (setq end (concat end "\n" extra))))
19056 (if (string-match "\\S-" end)
19057 (concat tpl "\n" end)
19060 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
19061 "Turn an alist of packages into a string with the \\usepackage macros."
19062 (setq pkg (mapconcat (lambda(p)
19065 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
19066 (format "%% Package %s omitted" (cadr p)))
19067 ((equal "" (car p))
19068 (format "\\usepackage{%s}" (cadr p)))
19070 (format "\\usepackage[%s]{%s}"
19071 (car p) (cadr p)))))
19074 (if newline (concat pkg "\n") pkg))
19076 (defun org-dvipng-color (attr)
19077 "Return a RGB color specification for dvipng."
19078 (apply 'format "rgb %s %s %s"
19079 (mapcar 'org-normalize-color
19080 (if (featurep 'xemacs)
19081 (color-rgb-components
19082 (face-property 'default
19083 (cond ((eq attr :foreground) 'foreground)
19084 ((eq attr :background) 'background))))
19085 (color-values (face-attribute 'default attr nil))))))
19087 (defun org-dvipng-color-format (color-name)
19088 "Convert COLOR-NAME to a RGB color value for dvipng."
19089 (apply 'format "rgb %s %s %s"
19090 (mapcar 'org-normalize-color
19091 (color-values color-name))))
19093 (defun org-latex-color (attr)
19094 "Return a RGB color for the LaTeX color package."
19095 (apply 'format "%s,%s,%s"
19096 (mapcar 'org-normalize-color
19097 (if (featurep 'xemacs)
19098 (color-rgb-components
19099 (face-property 'default
19100 (cond ((eq attr :foreground) 'foreground)
19101 ((eq attr :background) 'background))))
19102 (color-values (face-attribute 'default attr nil))))))
19104 (defun org-latex-color-format (color-name)
19105 "Convert COLOR-NAME to a RGB color value."
19106 (apply 'format "%s,%s,%s"
19107 (mapcar 'org-normalize-color
19108 (color-values color-name))))
19110 (defun org-normalize-color (value)
19111 "Return string to be used as color value for an RGB component."
19112 (format "%g" (/ value 65535.0)))
19118 (defvar org-inline-image-overlays nil)
19119 (make-variable-buffer-local 'org-inline-image-overlays)
19121 (defun org-toggle-inline-images (&optional include-linked)
19122 "Toggle the display of inline images.
19123 INCLUDE-LINKED is passed to `org-display-inline-images'."
19125 (if org-inline-image-overlays
19127 (org-remove-inline-images)
19128 (message "Inline image display turned off"))
19129 (org-display-inline-images include-linked)
19130 (if (and (org-called-interactively-p)
19131 org-inline-image-overlays)
19132 (message "%d images displayed inline"
19133 (length org-inline-image-overlays))
19134 (message "No images to display inline"))))
19136 (defun org-redisplay-inline-images ()
19137 "Refresh the display of inline images."
19139 (if (not org-inline-image-overlays)
19140 (org-toggle-inline-images)
19141 (org-toggle-inline-images)
19142 (org-toggle-inline-images)))
19144 (defun org-display-inline-images (&optional include-linked refresh beg end)
19145 "Display inline images.
19147 An inline image is a link which follows either of these
19150 1. Its path is a file with an extension matching return value
19151 from `image-file-name-regexp' and it has no contents.
19153 2. Its description consists in a single link of the previous
19156 When optional argument INCLUDE-LINKED is non-nil, also links with
19157 a text description part will be inlined. This can be nice for
19158 a quick look at those images, but it does not reflect what
19159 exported files will look like.
19161 When optional argument REFRESH is non-nil, refresh existing
19162 images between BEG and END. This will create new image displays
19163 only if necessary. BEG and END default to the buffer
19166 (when (display-graphic-p)
19168 (org-remove-inline-images)
19169 (when (fboundp 'clear-image-cache) (clear-image-cache)))
19170 (org-with-wide-buffer
19171 (goto-char (or beg (point-min)))
19172 (let ((case-fold-search t)
19173 (file-extension-re (org-image-file-name-regexp)))
19174 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
19175 (let ((link (save-match-data (org-element-context))))
19176 ;; Check if we're at an inline image.
19177 (when (and (equal (org-element-property :type link) "file")
19179 (not (org-element-property :contents-begin link)))
19180 (let ((parent (org-element-property :parent link)))
19181 (or (not (eq (org-element-type parent) 'link))
19182 (not (cdr (org-element-contents parent)))))
19183 (org-string-match-p file-extension-re
19184 (org-element-property :path link)))
19185 (let ((file (expand-file-name (org-element-property :path link))))
19186 (when (file-exists-p file)
19188 ;; Apply `org-image-actual-width' specifications.
19190 ((not (image-type-available-p 'imagemagick)) nil)
19191 ((eq org-image-actual-width t) nil)
19192 ((listp org-image-actual-width)
19194 ;; First try to find a width among
19195 ;; attributes associated to the paragraph
19196 ;; containing link.
19199 (while (and (setq e (org-element-property
19201 (not (eq (org-element-type e)
19206 (goto-char (org-element-property :begin paragraph))
19209 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19210 (org-element-property
19211 :post-affiliated paragraph)
19213 (string-to-number (match-string 1))))))
19214 ;; Otherwise, fall-back to provided number.
19215 (car org-image-actual-width)))
19216 ((numberp org-image-actual-width)
19217 org-image-actual-width)))
19218 (old (get-char-property-and-overlay
19219 (org-element-property :begin link)
19220 'org-image-overlay)))
19221 (if (and (car-safe old) refresh)
19222 (image-refresh (overlay-get (cdr old) 'display))
19223 (let ((image (create-image file
19224 (and width 'imagemagick)
19229 ;; If inline image is the description
19230 ;; of another link, be sure to
19231 ;; consider the latter as the one to
19232 ;; apply the overlay on.
19234 (org-element-property :parent link)))
19235 (if (eq (org-element-type parent) 'link)
19239 (org-element-property :begin link)
19242 (org-element-property :end link))
19243 (skip-chars-backward " \t")
19245 (overlay-put ov 'display image)
19246 (overlay-put ov 'face 'default)
19247 (overlay-put ov 'org-image-overlay t)
19249 ov 'modification-hooks
19250 (list 'org-display-inline-remove-overlay))
19251 (push ov org-inline-image-overlays)))))))))))))))
19253 (define-obsolete-function-alias
19254 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19256 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19257 "Remove inline-display overlay if a corresponding region is modified."
19258 (let ((inhibit-modification-hooks t))
19259 (when (and ov after)
19260 (delete ov org-inline-image-overlays)
19261 (delete-overlay ov))))
19263 (defun org-remove-inline-images ()
19264 "Remove inline display of images."
19266 (mapc 'delete-overlay org-inline-image-overlays)
19267 (setq org-inline-image-overlays nil))
19271 ;; Outline functions from `outline-mode-prefix-map'
19272 ;; that can be remapped in Org:
19273 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19274 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19275 (define-key org-mode-map [remap outline-forward-same-level]
19276 'org-forward-heading-same-level)
19277 (define-key org-mode-map [remap outline-backward-same-level]
19278 'org-backward-heading-same-level)
19279 (define-key org-mode-map [remap show-branches]
19280 'org-kill-note-or-show-branches)
19281 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19282 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19283 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19285 ;; Outline functions from `outline-mode-prefix-map' that can not
19286 ;; be remapped in Org:
19288 ;; - the column "key binding" shows whether the Outline function is still
19289 ;; available in Org mode on the same key that it has been bound to in
19291 ;; - "overridden": key used for a different functionality in Org mode
19292 ;; - else: key still bound to the same Outline function in Org mode
19294 ;; | Outline function | key binding | Org replacement |
19295 ;; |------------------------------------+-------------+-----------------------|
19296 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19297 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19298 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19299 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19300 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19301 ;; | `show-entry' | overridden | no replacement |
19302 ;; | `show-children' | `C-c C-i' | visibility cycling |
19303 ;; | `show-branches' | `C-c C-k' | still same function |
19304 ;; | `show-subtree' | overridden | visibility cycling |
19305 ;; | `show-all' | overridden | no replacement |
19306 ;; | `hide-subtree' | overridden | visibility cycling |
19307 ;; | `hide-body' | overridden | no replacement |
19308 ;; | `hide-entry' | overridden | visibility cycling |
19309 ;; | `hide-leaves' | overridden | no replacement |
19310 ;; | `hide-sublevels' | overridden | no replacement |
19311 ;; | `hide-other' | overridden | no replacement |
19313 ;; Make `C-c C-x' a prefix key
19314 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19316 ;; TAB key with modifiers
19317 (org-defkey org-mode-map "\C-i" 'org-cycle)
19318 (org-defkey org-mode-map [(tab)] 'org-cycle)
19319 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19320 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19321 ;; The following line is necessary under Suse GNU/Linux
19322 (unless (featurep 'xemacs)
19323 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19324 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19325 (define-key org-mode-map [backtab] 'org-shifttab)
19327 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19328 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19329 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19331 ;; Cursor keys with modifiers
19332 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19333 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19334 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19335 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19337 (org-defkey org-mode-map [(control meta shift right)] 'org-increase-number-at-point)
19338 (org-defkey org-mode-map [(control meta shift left)] 'org-decrease-number-at-point)
19339 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19340 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19341 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19342 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19344 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19345 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19346 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19347 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19349 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19350 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19351 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19352 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19355 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19356 (mapc (lambda (pair)
19357 (define-key org-babel-map (car pair) (cdr pair)))
19358 org-babel-key-bindings)
19360 ;;; Extra keys for tty access.
19361 ;; We only set them when really needed because otherwise the
19362 ;; menus don't show the simple keys
19364 (when (or org-use-extra-keys
19365 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19366 (not window-system))
19367 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19368 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19369 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19370 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19371 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19372 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19373 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19374 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19375 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19376 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19377 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19378 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19379 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19380 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19381 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19382 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19383 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19384 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19385 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19386 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19387 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19388 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19389 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19390 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19391 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19392 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19393 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19394 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19396 ;; All the other keys
19398 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19399 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19400 (if (boundp 'narrow-map)
19401 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19402 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19403 (if (boundp 'narrow-map)
19404 (org-defkey narrow-map "b" 'org-narrow-to-block)
19405 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19406 (if (boundp 'narrow-map)
19407 (org-defkey narrow-map "e" 'org-narrow-to-element)
19408 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19409 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19410 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19411 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19412 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19413 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19414 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19415 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19416 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19417 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19418 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19419 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19420 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19421 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19422 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19423 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19424 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19425 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19426 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19427 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19428 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19429 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19430 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19431 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19432 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19433 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19434 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19435 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19436 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19437 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19438 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19439 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19440 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19441 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19442 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19443 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19444 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19445 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19446 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19447 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19448 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19449 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19450 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19451 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19452 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19453 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19454 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19455 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19456 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19457 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19458 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19459 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19460 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19461 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19462 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19463 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19464 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19465 (org-defkey org-mode-map "\C-c^" 'org-sort)
19466 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19467 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19468 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19469 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19470 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19471 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19472 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19473 (org-defkey org-mode-map "\C-m" 'org-return)
19474 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19475 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19476 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19477 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19478 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19479 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19480 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19481 (org-defkey org-mode-map "\C-cp" 'orgtbl-ascii-plot)
19482 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19483 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19484 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19485 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19486 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19487 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19488 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19489 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19490 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19491 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19492 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19493 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19494 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19495 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19496 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19497 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19499 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19500 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19501 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19503 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19504 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19505 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19506 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19507 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19508 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19509 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19510 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19511 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19512 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19513 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-toggle-latex-fragment)
19514 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19515 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19516 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19517 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19518 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19519 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19520 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19521 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19522 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19523 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19524 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19525 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19527 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19528 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19529 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19530 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19531 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19533 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19535 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19537 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19538 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19540 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19543 (when (featurep 'xemacs)
19544 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19547 (defconst org-speed-commands-default
19549 ("Outline Navigation")
19550 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19551 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19552 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19553 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19554 ("F" . org-next-block)
19555 ("B" . org-previous-block)
19556 ("u" . (org-speed-move-safe 'outline-up-heading))
19558 ("g" . (org-refile t))
19559 ("Outline Visibility")
19561 ("C" . org-shifttab)
19562 (" " . org-display-outline-path)
19563 ("s" . org-narrow-to-subtree)
19564 ("=" . org-columns)
19565 ("Outline Structure Editing")
19567 ("D" . org-metadown)
19568 ("r" . org-metaright)
19569 ("l" . org-metaleft)
19570 ("R" . org-shiftmetaright)
19571 ("L" . org-shiftmetaleft)
19572 ("i" . (progn (forward-char 1) (call-interactively
19573 'org-insert-heading-respect-content)))
19576 ("a" . org-archive-subtree-default-with-confirmation)
19577 ("@" . org-mark-subtree)
19578 ("#" . org-toggle-comment)
19580 ("I" . org-clock-in)
19581 ("O" . org-clock-out)
19582 ("Meta Data Editing")
19584 ("," . (org-priority))
19585 ("0" . (org-priority ?\ ))
19586 ("1" . (org-priority ?A))
19587 ("2" . (org-priority ?B))
19588 ("3" . (org-priority ?C))
19589 (":" . org-set-tags-command)
19590 ("e" . org-set-effort)
19591 ("E" . org-inc-effort)
19592 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19593 (org-entry-put (point) "APPT_WARNTIME" m)))
19594 ("Agenda Views etc")
19596 ("/" . org-sparse-tree)
19598 ("o" . org-open-at-point)
19599 ("?" . org-speed-command-help)
19600 ("<" . (org-agenda-set-restriction-lock 'subtree))
19601 (">" . (org-agenda-remove-restriction-lock))
19603 "The default speed commands.")
19605 (defun org-print-speed-command (e)
19606 (if (> (length (car e)) 1)
19611 (princ (make-string (length (car e)) ?-))
19615 (if (symbolp (cdr e))
19616 (princ (symbol-name (cdr e)))
19620 (defun org-speed-command-help ()
19621 "Show the available speed commands."
19623 (if (not org-use-speed-commands)
19624 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19625 (with-output-to-temp-buffer "*Help*"
19626 (princ "User-defined Speed commands\n===========================\n")
19627 (mapc 'org-print-speed-command org-speed-commands-user)
19629 (princ "Built-in Speed commands\n=======================\n")
19630 (mapc 'org-print-speed-command org-speed-commands-default))
19631 (with-current-buffer "*Help*"
19632 (setq truncate-lines t))))
19634 (defun org-speed-move-safe (cmd)
19635 "Execute CMD, but make sure that the cursor always ends up in a headline.
19636 If not, return to the original position and throw an error."
19638 (let ((pos (point)))
19639 (call-interactively cmd)
19640 (unless (and (bolp) (org-at-heading-p))
19642 (error "Boundary reached while executing %s" cmd))))
19644 (defvar org-self-insert-command-undo-counter 0)
19646 (defvar org-table-auto-blank-field) ; defined in org-table.el
19647 (defvar org-speed-command nil)
19649 (define-obsolete-function-alias
19650 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19652 (defun org-speed-command-activate (keys)
19653 "Hook for activating single-letter speed commands.
19654 `org-speed-commands-default' specifies a minimal command set.
19655 Use `org-speed-commands-user' for further customization."
19656 (when (or (and (bolp) (looking-at org-outline-regexp))
19657 (and (functionp org-use-speed-commands)
19658 (funcall org-use-speed-commands)))
19659 (cdr (assoc keys (append org-speed-commands-user
19660 org-speed-commands-default)))))
19662 (define-obsolete-function-alias
19663 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19665 (defun org-babel-speed-command-activate (keys)
19666 "Hook for activating single-letter code block commands."
19667 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19668 (cdr (assoc keys org-babel-key-bindings))))
19670 (defcustom org-speed-command-hook
19671 '(org-speed-command-default-hook org-babel-speed-command-hook)
19672 "Hook for activating speed commands at strategic locations.
19673 Hook functions are called in sequence until a valid handler is
19676 Each hook takes a single argument, a user-pressed command key
19677 which is also a `self-insert-command' from the global map.
19679 Within the hook, examine the cursor position and the command key
19680 and return nil or a valid handler as appropriate. Handler could
19681 be one of an interactive command, a function, or a form.
19683 Set `org-use-speed-commands' to non-nil value to enable this
19684 hook. The default setting is `org-speed-command-activate'."
19685 :group 'org-structure
19689 (defun org-self-insert-command (N)
19690 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19691 If the cursor is in a table looking at whitespace, the whitespace is
19692 overwritten, and the table is not marked as requiring realignment."
19694 (org-check-before-invisible-edit 'insert)
19696 ((and org-use-speed-commands
19697 (setq org-speed-command
19698 (run-hook-with-args-until-success
19699 'org-speed-command-hook (this-command-keys))))
19701 ((commandp org-speed-command)
19702 (setq this-command org-speed-command)
19703 (call-interactively org-speed-command))
19704 ((functionp org-speed-command)
19705 (funcall org-speed-command))
19706 ((and org-speed-command (listp org-speed-command))
19707 (eval org-speed-command))
19708 (t (let (org-use-speed-commands)
19709 (call-interactively 'org-self-insert-command)))))
19713 ;; check if we blank the field, and if that triggers align
19714 (and (featurep 'org-table) org-table-auto-blank-field
19715 (member last-command
19716 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas-expand))
19717 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19718 ;; got extra space, this field does not determine column width
19719 (let (org-table-may-need-update) (org-table-blank-field))
19720 ;; no extra space, this field may determine column width
19721 (org-table-blank-field)))
19724 (looking-at "[^|\n]* |"))
19725 (let (org-table-may-need-update)
19726 (goto-char (1- (match-end 0)))
19727 (backward-delete-char 1)
19728 (goto-char (match-beginning 0))
19729 (self-insert-command N)))
19731 (setq org-table-may-need-update t)
19732 (self-insert-command N)
19733 (org-fix-tags-on-the-fly)
19734 (if org-self-insert-cluster-for-undo
19735 (if (not (eq last-command 'org-self-insert-command))
19736 (setq org-self-insert-command-undo-counter 1)
19737 (if (>= org-self-insert-command-undo-counter 20)
19738 (setq org-self-insert-command-undo-counter 1)
19739 (and (> org-self-insert-command-undo-counter 0)
19740 buffer-undo-list (listp buffer-undo-list)
19741 (not (cadr buffer-undo-list)) ; remove nil entry
19742 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19743 (setq org-self-insert-command-undo-counter
19744 (1+ org-self-insert-command-undo-counter))))))))
19746 (defun org-check-before-invisible-edit (kind)
19747 "Check is editing if kind KIND would be dangerous with invisible text around.
19748 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19749 ;; First, try to get out of here as quickly as possible, to reduce overhead
19750 (if (and org-catch-invisible-edits
19751 (or (not (boundp 'visible-mode)) (not visible-mode))
19752 (or (get-char-property (point) 'invisible)
19753 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19754 ;; OK, we need to take a closer look
19755 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19756 (invisible-before-point (if (bobp) nil (get-char-property
19757 (1- (point)) 'invisible)))
19758 (border-and-ok-direction
19760 ;; Check if we are acting predictably before invisible text
19761 (and invisible-at-point (not invisible-before-point)
19762 (memq kind '(insert delete-backward)))
19763 ;; Check if we are acting predictably after invisible text
19764 ;; This works not well, and I have turned it off. It seems
19765 ;; better to always show and stop after invisible text.
19766 ;; (and (not invisible-at-point) invisible-before-point
19767 ;; (memq kind '(insert delete)))
19769 (when (or (memq invisible-at-point '(outline org-hide-block t))
19770 (memq invisible-before-point '(outline org-hide-block t)))
19771 (if (eq org-catch-invisible-edits 'error)
19772 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19773 (if (and org-custom-properties-overlays
19774 (y-or-n-p "Display invisible properties in this buffer? "))
19775 (org-toggle-custom-properties-visibility)
19776 ;; Make the area visible
19778 (if invisible-before-point
19779 (goto-char (previous-single-char-property-change
19780 (point) 'invisible)))
19783 ((eq org-catch-invisible-edits 'show)
19784 ;; That's it, we do the edit after showing
19786 "Unfolding invisible region around point before editing")
19788 ((and (eq org-catch-invisible-edits 'smart)
19789 border-and-ok-direction)
19790 (message "Unfolding invisible region around point before editing"))
19792 ;; Don't do the edit, make the user repeat it in full visibility
19793 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19795 (defun org-fix-tags-on-the-fly ()
19796 (when (and (equal (char-after (point-at-bol)) ?*)
19797 (org-at-heading-p))
19798 (org-align-tags-here org-tags-column)))
19800 (defun org-delete-backward-char (N)
19801 "Like `delete-backward-char', insert whitespace at field end in tables.
19802 When deleting backwards, in tables this function will insert whitespace in
19803 front of the next \"|\" separator, to keep the table aligned. The table will
19804 still be marked for re-alignment if the field did fill the entire column,
19805 because, in this case the deletion might narrow the column."
19808 (org-check-before-invisible-edit 'delete-backward)
19809 (if (and (org-table-p)
19811 (string-match "|" (buffer-substring (point-at-bol) (point)))
19812 (looking-at ".*?|"))
19813 (let ((pos (point))
19814 (noalign (looking-at "[^|\n\r]* |"))
19815 (c org-table-may-need-update))
19816 (backward-delete-char N)
19817 (if (not overwrite-mode)
19819 (skip-chars-forward "^|")
19821 (goto-char (1- pos))))
19822 ;; noalign: if there were two spaces at the end, this field
19823 ;; does not determine the width of the column.
19824 (if noalign (setq org-table-may-need-update c)))
19825 (backward-delete-char N)
19826 (org-fix-tags-on-the-fly))))
19828 (defun org-delete-char (N)
19829 "Like `delete-char', but insert whitespace at field end in tables.
19830 When deleting characters, in tables this function will insert whitespace in
19831 front of the next \"|\" separator, to keep the table aligned. The table will
19832 still be marked for re-alignment if the field did fill the entire column,
19833 because, in this case the deletion might narrow the column."
19836 (org-check-before-invisible-edit 'delete)
19837 (if (and (org-table-p)
19839 (not (= (char-after) ?|))
19841 (if (looking-at ".*?|")
19842 (let ((pos (point))
19843 (noalign (looking-at "[^|\n\r]* |"))
19844 (c org-table-may-need-update))
19846 (concat (substring (match-string 0) 1 -1) " |") nil t)
19848 ;; noalign: if there were two spaces at the end, this field
19849 ;; does not determine the width of the column.
19850 (if noalign (setq org-table-may-need-update c)))
19853 (org-fix-tags-on-the-fly))))
19855 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19856 (put 'org-self-insert-command 'delete-selection
19858 (not (run-hook-with-args-until-success
19859 'self-insert-uses-region-functions))))
19860 (put 'orgtbl-self-insert-command 'delete-selection
19862 (not (run-hook-with-args-until-success
19863 'self-insert-uses-region-functions))))
19864 (put 'org-delete-char 'delete-selection 'supersede)
19865 (put 'org-delete-backward-char 'delete-selection 'supersede)
19866 (put 'org-yank 'delete-selection 'yank)
19868 ;; Make `flyspell-mode' delay after some commands
19869 (put 'org-self-insert-command 'flyspell-delayed t)
19870 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19871 (put 'org-delete-char 'flyspell-delayed t)
19872 (put 'org-delete-backward-char 'flyspell-delayed t)
19874 ;; Make pabbrev-mode expand after org-mode commands
19875 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19876 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19878 (defun org-remap (map &rest commands)
19879 "In MAP, remap the functions given in COMMANDS.
19880 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19883 (setq old (pop commands) new (pop commands))
19884 (if (fboundp 'command-remapping)
19885 (org-defkey map (vector 'remap old) new)
19886 (substitute-key-definition old new map global-map)))))
19888 (defun org-transpose-words ()
19889 "Transpose words for Org.
19890 This uses the `org-mode-transpose-word-syntax-table' syntax
19891 table, which interprets characters in `org-emphasis-alist' as
19892 word constituents."
19894 (with-syntax-table org-mode-transpose-word-syntax-table
19895 (call-interactively 'transpose-words)))
19896 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19898 (when (eq org-enable-table-editor 'optimized)
19899 ;; If the user wants maximum table support, we need to hijack
19900 ;; some standard editing functions
19901 (org-remap org-mode-map
19902 'self-insert-command 'org-self-insert-command
19903 'delete-char 'org-delete-char
19904 'delete-backward-char 'org-delete-backward-char)
19905 (org-defkey org-mode-map "|" 'org-force-self-insert))
19907 (defvar org-ctrl-c-ctrl-c-hook nil
19908 "Hook for functions attaching themselves to `C-c C-c'.
19910 This can be used to add additional functionality to the C-c C-c
19911 key which executes context-dependent commands. This hook is run
19912 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19913 run after the last test.
19915 Each function will be called with no arguments. The function
19916 must check if the context is appropriate for it to act. If yes,
19917 it should do its thing and then return a non-nil value. If the
19918 context is wrong, just do nothing and return nil.")
19920 (defvar org-ctrl-c-ctrl-c-final-hook nil
19921 "Hook for functions attaching themselves to `C-c C-c'.
19923 This can be used to add additional functionality to the C-c C-c
19924 key which executes context-dependent commands. This hook is run
19925 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19926 before the first test.
19928 Each function will be called with no arguments. The function
19929 must check if the context is appropriate for it to act. If yes,
19930 it should do its thing and then return a non-nil value. If the
19931 context is wrong, just do nothing and return nil.")
19933 (defvar org-tab-first-hook nil
19934 "Hook for functions to attach themselves to TAB.
19935 See `org-ctrl-c-ctrl-c-hook' for more information.
19936 This hook runs as the first action when TAB is pressed, even before
19937 `org-cycle' messes around with the `outline-regexp' to cater for
19938 inline tasks and plain list item folding.
19939 If any function in this hook returns t, any other actions that
19940 would have been caused by TAB (such as table field motion or visibility
19941 cycling) will not occur.")
19943 (defvar org-tab-after-check-for-table-hook nil
19944 "Hook for functions to attach themselves to TAB.
19945 See `org-ctrl-c-ctrl-c-hook' for more information.
19946 This hook runs after it has been established that the cursor is not in a
19947 table, but before checking if the cursor is in a headline or if global cycling
19949 If any function in this hook returns t, not other actions like visibility
19950 cycling will be done.")
19952 (defvar org-tab-after-check-for-cycling-hook nil
19953 "Hook for functions to attach themselves to TAB.
19954 See `org-ctrl-c-ctrl-c-hook' for more information.
19955 This hook runs after it has been established that not table field motion and
19956 not visibility should be done because of current context. This is probably
19957 the place where a package like yasnippets can hook in.")
19959 (defvar org-tab-before-tab-emulation-hook nil
19960 "Hook for functions to attach themselves to TAB.
19961 See `org-ctrl-c-ctrl-c-hook' for more information.
19962 This hook runs after every other options for TAB have been exhausted, but
19963 before indentation and \t insertion takes place.")
19965 (defvar org-metaleft-hook nil
19966 "Hook for functions attaching themselves to `M-left'.
19967 See `org-ctrl-c-ctrl-c-hook' for more information.")
19968 (defvar org-metaright-hook nil
19969 "Hook for functions attaching themselves to `M-right'.
19970 See `org-ctrl-c-ctrl-c-hook' for more information.")
19971 (defvar org-metaup-hook nil
19972 "Hook for functions attaching themselves to `M-up'.
19973 See `org-ctrl-c-ctrl-c-hook' for more information.")
19974 (defvar org-metadown-hook nil
19975 "Hook for functions attaching themselves to `M-down'.
19976 See `org-ctrl-c-ctrl-c-hook' for more information.")
19977 (defvar org-shiftmetaleft-hook nil
19978 "Hook for functions attaching themselves to `M-S-left'.
19979 See `org-ctrl-c-ctrl-c-hook' for more information.")
19980 (defvar org-shiftmetaright-hook nil
19981 "Hook for functions attaching themselves to `M-S-right'.
19982 See `org-ctrl-c-ctrl-c-hook' for more information.")
19983 (defvar org-shiftmetaup-hook nil
19984 "Hook for functions attaching themselves to `M-S-up'.
19985 See `org-ctrl-c-ctrl-c-hook' for more information.")
19986 (defvar org-shiftmetadown-hook nil
19987 "Hook for functions attaching themselves to `M-S-down'.
19988 See `org-ctrl-c-ctrl-c-hook' for more information.")
19989 (defvar org-metareturn-hook nil
19990 "Hook for functions attaching themselves to `M-RET'.
19991 See `org-ctrl-c-ctrl-c-hook' for more information.")
19992 (defvar org-shiftup-hook nil
19993 "Hook for functions attaching themselves to `S-up'.
19994 See `org-ctrl-c-ctrl-c-hook' for more information.")
19995 (defvar org-shiftup-final-hook nil
19996 "Hook for functions attaching themselves to `S-up'.
19997 This one runs after all other options except shift-select have been excluded.
19998 See `org-ctrl-c-ctrl-c-hook' for more information.")
19999 (defvar org-shiftdown-hook nil
20000 "Hook for functions attaching themselves to `S-down'.
20001 See `org-ctrl-c-ctrl-c-hook' for more information.")
20002 (defvar org-shiftdown-final-hook nil
20003 "Hook for functions attaching themselves to `S-down'.
20004 This one runs after all other options except shift-select have been excluded.
20005 See `org-ctrl-c-ctrl-c-hook' for more information.")
20006 (defvar org-shiftleft-hook nil
20007 "Hook for functions attaching themselves to `S-left'.
20008 See `org-ctrl-c-ctrl-c-hook' for more information.")
20009 (defvar org-shiftleft-final-hook nil
20010 "Hook for functions attaching themselves to `S-left'.
20011 This one runs after all other options except shift-select have been excluded.
20012 See `org-ctrl-c-ctrl-c-hook' for more information.")
20013 (defvar org-shiftright-hook nil
20014 "Hook for functions attaching themselves to `S-right'.
20015 See `org-ctrl-c-ctrl-c-hook' for more information.")
20016 (defvar org-shiftright-final-hook nil
20017 "Hook for functions attaching themselves to `S-right'.
20018 This one runs after all other options except shift-select have been excluded.
20019 See `org-ctrl-c-ctrl-c-hook' for more information.")
20021 (defun org-modifier-cursor-error ()
20022 "Throw an error, a modified cursor command was applied in wrong context."
20023 (user-error "This command is active in special context like tables, headlines or items"))
20025 (defun org-shiftselect-error ()
20026 "Throw an error because Shift-Cursor command was applied in wrong context."
20027 (if (and (boundp 'shift-select-mode) shift-select-mode)
20028 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
20029 (user-error "This command works only in special context like headlines or timestamps")))
20031 (defun org-call-for-shift-select (cmd)
20032 (let ((this-command-keys-shift-translated t))
20033 (call-interactively cmd)))
20035 (defun org-shifttab (&optional arg)
20036 "Global visibility cycling or move to previous table field.
20037 Call `org-table-previous-field' within a table.
20038 When ARG is nil, cycle globally through visibility states.
20039 When ARG is a numeric prefix, show contents of this level."
20042 ((org-at-table-p) (call-interactively 'org-table-previous-field))
20044 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
20045 (message "Content view to level: %d" arg)
20046 (org-content (prefix-numeric-value arg2))
20047 (org-cycle-show-empty-lines t)
20048 (setq org-cycle-global-status 'overview)))
20049 (t (call-interactively 'org-global-cycle))))
20051 (defun org-shiftmetaleft ()
20052 "Promote subtree or delete table column.
20053 Calls `org-promote-subtree', `org-outdent-item-tree', or
20054 `org-table-delete-column', depending on context. See the
20055 individual commands for more information."
20058 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
20059 ((org-at-table-p) (call-interactively 'org-table-delete-column))
20060 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
20061 ((if (not (org-region-active-p)) (org-at-item-p)
20062 (save-excursion (goto-char (region-beginning))
20064 (call-interactively 'org-outdent-item-tree))
20065 (t (org-modifier-cursor-error))))
20067 (defun org-shiftmetaright ()
20068 "Demote subtree or insert table column.
20069 Calls `org-demote-subtree', `org-indent-item-tree', or
20070 `org-table-insert-column', depending on context. See the
20071 individual commands for more information."
20074 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
20075 ((org-at-table-p) (call-interactively 'org-table-insert-column))
20076 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
20077 ((if (not (org-region-active-p)) (org-at-item-p)
20078 (save-excursion (goto-char (region-beginning))
20080 (call-interactively 'org-indent-item-tree))
20081 (t (org-modifier-cursor-error))))
20083 (defun org-shiftmetaup (&optional arg)
20084 "Drag the line at point up.
20085 In a table, kill the current row.
20086 On a clock timestamp, update the value of the timestamp like `S-<up>'
20087 but also adjust the previous clocked item in the clock history.
20088 Everywhere else, drag the line at point up."
20091 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
20092 ((org-at-table-p) (call-interactively 'org-table-kill-row))
20093 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20094 (call-interactively 'org-timestamp-up)))
20095 (t (call-interactively 'org-drag-line-backward))))
20097 (defun org-shiftmetadown (&optional arg)
20098 "Drag the line at point down.
20099 In a table, insert an empty row at the current line.
20100 On a clock timestamp, update the value of the timestamp like `S-<down>'
20101 but also adjust the previous clocked item in the clock history.
20102 Everywhere else, drag the line at point down."
20105 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
20106 ((org-at-table-p) (call-interactively 'org-table-insert-row))
20107 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
20108 (call-interactively 'org-timestamp-down)))
20109 (t (call-interactively 'org-drag-line-forward))))
20111 (defsubst org-hidden-tree-error ()
20113 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
20115 (defun org-metaleft (&optional arg)
20116 "Promote heading or move table column to left.
20117 Calls `org-do-promote' or `org-table-move-column', depending on context.
20118 With no specific context, calls the Emacs default `backward-word'.
20119 See the individual commands for more information."
20122 ((run-hook-with-args-until-success 'org-metaleft-hook))
20123 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
20124 ((org-with-limited-levels
20125 (or (org-at-heading-p)
20126 (and (org-region-active-p)
20128 (goto-char (region-beginning))
20129 (org-at-heading-p)))))
20130 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20131 (call-interactively 'org-do-promote))
20132 ;; At an inline task.
20133 ((org-at-heading-p)
20134 (call-interactively 'org-inlinetask-promote))
20135 ((or (org-at-item-p)
20136 (and (org-region-active-p)
20138 (goto-char (region-beginning))
20140 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20141 (call-interactively 'org-outdent-item))
20142 (t (call-interactively 'backward-word))))
20144 (defun org-metaright (&optional arg)
20145 "Demote a subtree, a list item or move table column to right.
20146 In front of a drawer or a block keyword, indent it correctly.
20147 With no specific context, calls the Emacs default `forward-word'.
20148 See the individual commands for more information."
20151 ((run-hook-with-args-until-success 'org-metaright-hook))
20152 ((org-at-table-p) (call-interactively 'org-table-move-column))
20153 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
20154 ((org-at-block-p) (call-interactively 'org-indent-block))
20155 ((org-with-limited-levels
20156 (or (org-at-heading-p)
20157 (and (org-region-active-p)
20159 (goto-char (region-beginning))
20160 (org-at-heading-p)))))
20161 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
20162 (call-interactively 'org-do-demote))
20163 ;; At an inline task.
20164 ((org-at-heading-p)
20165 (call-interactively 'org-inlinetask-demote))
20166 ((or (org-at-item-p)
20167 (and (org-region-active-p)
20169 (goto-char (region-beginning))
20171 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
20172 (call-interactively 'org-indent-item))
20173 (t (call-interactively 'forward-word))))
20175 (defun org-check-for-hidden (what)
20176 "Check if there are hidden headlines/items in the current visual line.
20177 WHAT can be either `headlines' or `items'. If the current line is
20178 an outline or item heading and it has a folded subtree below it,
20179 this function returns t, nil otherwise."
20181 ((eq what 'headlines) org-outline-regexp-bol)
20182 ((eq what 'items) (org-item-beginning-re))
20183 (t (error "This should not happen"))))
20187 (unless (org-region-active-p)
20188 (setq beg (point-at-bol))
20189 (beginning-of-line 2)
20190 (while (and (not (eobp)) ;; this is like `next-line'
20191 (get-char-property (1- (point)) 'invisible))
20192 (beginning-of-line 2))
20195 (goto-char (point-at-eol))
20196 (setq end (max end (point)))
20197 (while (re-search-forward re end t)
20198 (if (get-char-property (match-beginning 0) 'invisible)
20202 (defun org-metaup (&optional arg)
20203 "Move subtree up or move table row up.
20204 Calls `org-move-subtree-up' or `org-table-move-row' or
20205 `org-move-item-up', depending on context. See the individual commands
20206 for more information."
20209 ((run-hook-with-args-until-success 'org-metaup-hook))
20210 ((org-region-active-p)
20211 (let* ((a (min (region-beginning) (region-end)))
20212 (b (1- (max (region-beginning) (region-end))))
20213 (c (save-excursion (goto-char a)
20214 (move-beginning-of-line 0)))
20215 (d (save-excursion (goto-char a)
20216 (move-end-of-line 0) (point))))
20217 (transpose-regions a b c d)
20219 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20220 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20221 ((org-at-item-p) (call-interactively 'org-move-item-up))
20222 (t (org-drag-element-backward))))
20224 (defun org-metadown (&optional arg)
20225 "Move subtree down or move table row down.
20226 Calls `org-move-subtree-down' or `org-table-move-row' or
20227 `org-move-item-down', depending on context. See the individual
20228 commands for more information."
20231 ((run-hook-with-args-until-success 'org-metadown-hook))
20232 ((org-region-active-p)
20233 (let* ((a (min (region-beginning) (region-end)))
20234 (b (max (region-beginning) (region-end)))
20235 (c (save-excursion (goto-char b)
20236 (move-beginning-of-line 1)))
20237 (d (save-excursion (goto-char b)
20238 (move-end-of-line 1) (1+ (point)))))
20239 (transpose-regions a b c d)
20241 ((org-at-table-p) (call-interactively 'org-table-move-row))
20242 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20243 ((org-at-item-p) (call-interactively 'org-move-item-down))
20244 (t (org-drag-element-forward))))
20246 (defun org-shiftup (&optional arg)
20247 "Increase item in timestamp or increase priority of current headline.
20248 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20249 depending on context. See the individual commands for more information."
20252 ((run-hook-with-args-until-success 'org-shiftup-hook))
20253 ((and org-support-shift-select (org-region-active-p))
20254 (org-call-for-shift-select 'previous-line))
20255 ((org-at-timestamp-p t)
20256 (call-interactively (if org-edit-timestamp-down-means-later
20257 'org-timestamp-down 'org-timestamp-up)))
20258 ((and (not (eq org-support-shift-select 'always))
20259 org-enable-priority-commands
20260 (org-at-heading-p))
20261 (call-interactively 'org-priority-up))
20262 ((and (not org-support-shift-select) (org-at-item-p))
20263 (call-interactively 'org-previous-item))
20264 ((org-clocktable-try-shift 'up arg))
20265 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20266 (org-support-shift-select
20267 (org-call-for-shift-select 'previous-line))
20268 (t (org-shiftselect-error))))
20270 (defun org-shiftdown (&optional arg)
20271 "Decrease item in timestamp or decrease priority of current headline.
20272 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20273 depending on context. See the individual commands for more information."
20276 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20277 ((and org-support-shift-select (org-region-active-p))
20278 (org-call-for-shift-select 'next-line))
20279 ((org-at-timestamp-p t)
20280 (call-interactively (if org-edit-timestamp-down-means-later
20281 'org-timestamp-up 'org-timestamp-down)))
20282 ((and (not (eq org-support-shift-select 'always))
20283 org-enable-priority-commands
20284 (org-at-heading-p))
20285 (call-interactively 'org-priority-down))
20286 ((and (not org-support-shift-select) (org-at-item-p))
20287 (call-interactively 'org-next-item))
20288 ((org-clocktable-try-shift 'down arg))
20289 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20290 (org-support-shift-select
20291 (org-call-for-shift-select 'next-line))
20292 (t (org-shiftselect-error))))
20294 (defun org-shiftright (&optional arg)
20295 "Cycle the thing at point or in the current line, depending on context.
20296 Depending on context, this does one of the following:
20298 - switch a timestamp at point one day into the future
20299 - on a headline, switch to the next TODO keyword.
20300 - on an item, switch entire list to the next bullet type
20301 - on a property line, switch to the next allowed value
20302 - on a clocktable definition line, move time block into the future"
20305 ((run-hook-with-args-until-success 'org-shiftright-hook))
20306 ((and org-support-shift-select (org-region-active-p))
20307 (org-call-for-shift-select 'forward-char))
20308 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20309 ((and (not (eq org-support-shift-select 'always))
20310 (org-at-heading-p))
20311 (let ((org-inhibit-logging
20312 (not org-treat-S-cursor-todo-selection-as-state-change))
20313 (org-inhibit-blocking
20314 (not org-treat-S-cursor-todo-selection-as-state-change)))
20315 (org-call-with-arg 'org-todo 'right)))
20316 ((or (and org-support-shift-select
20317 (not (eq org-support-shift-select 'always))
20318 (org-at-item-bullet-p))
20319 (and (not org-support-shift-select) (org-at-item-p)))
20320 (org-call-with-arg 'org-cycle-list-bullet nil))
20321 ((and (not (eq org-support-shift-select 'always))
20322 (org-at-property-p))
20323 (call-interactively 'org-property-next-allowed-value))
20324 ((org-clocktable-try-shift 'right arg))
20325 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20326 (org-support-shift-select
20327 (org-call-for-shift-select 'forward-char))
20328 (t (org-shiftselect-error))))
20330 (defun org-shiftleft (&optional arg)
20331 "Cycle the thing at point or in the current line, depending on context.
20332 Depending on context, this does one of the following:
20334 - switch a timestamp at point one day into the past
20335 - on a headline, switch to the previous TODO keyword.
20336 - on an item, switch entire list to the previous bullet type
20337 - on a property line, switch to the previous allowed value
20338 - on a clocktable definition line, move time block into the past"
20341 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20342 ((and org-support-shift-select (org-region-active-p))
20343 (org-call-for-shift-select 'backward-char))
20344 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20345 ((and (not (eq org-support-shift-select 'always))
20346 (org-at-heading-p))
20347 (let ((org-inhibit-logging
20348 (not org-treat-S-cursor-todo-selection-as-state-change))
20349 (org-inhibit-blocking
20350 (not org-treat-S-cursor-todo-selection-as-state-change)))
20351 (org-call-with-arg 'org-todo 'left)))
20352 ((or (and org-support-shift-select
20353 (not (eq org-support-shift-select 'always))
20354 (org-at-item-bullet-p))
20355 (and (not org-support-shift-select) (org-at-item-p)))
20356 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20357 ((and (not (eq org-support-shift-select 'always))
20358 (org-at-property-p))
20359 (call-interactively 'org-property-previous-allowed-value))
20360 ((org-clocktable-try-shift 'left arg))
20361 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20362 (org-support-shift-select
20363 (org-call-for-shift-select 'backward-char))
20364 (t (org-shiftselect-error))))
20366 (defun org-shiftcontrolright ()
20367 "Switch to next TODO set."
20370 ((and org-support-shift-select (org-region-active-p))
20371 (org-call-for-shift-select 'forward-word))
20372 ((and (not (eq org-support-shift-select 'always))
20373 (org-at-heading-p))
20374 (org-call-with-arg 'org-todo 'nextset))
20375 (org-support-shift-select
20376 (org-call-for-shift-select 'forward-word))
20377 (t (org-shiftselect-error))))
20379 (defun org-shiftcontrolleft ()
20380 "Switch to previous TODO set."
20383 ((and org-support-shift-select (org-region-active-p))
20384 (org-call-for-shift-select 'backward-word))
20385 ((and (not (eq org-support-shift-select 'always))
20386 (org-at-heading-p))
20387 (org-call-with-arg 'org-todo 'previousset))
20388 (org-support-shift-select
20389 (org-call-for-shift-select 'backward-word))
20390 (t (org-shiftselect-error))))
20392 (defun org-shiftcontrolup (&optional n)
20393 "Change timestamps synchronously up in CLOCK log lines.
20394 Optional argument N tells to change by that many units."
20396 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20397 (let (org-support-shift-select)
20398 (org-clock-timestamps-up n))
20399 (user-error "Not at a clock log")))
20401 (defun org-shiftcontroldown (&optional n)
20402 "Change timestamps synchronously down in CLOCK log lines.
20403 Optional argument N tells to change by that many units."
20405 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20406 (let (org-support-shift-select)
20407 (org-clock-timestamps-down n))
20408 (user-error "Not at a clock log")))
20410 (defun org-increase-number-at-point (&optional inc)
20411 "Increment the number at point.
20412 With an optional prefix numeric argument INC, increment using
20413 this numeric value."
20415 (if (not (number-at-point))
20416 (user-error "Not on a number")
20417 (unless inc (setq inc 1))
20418 (let ((pos (point))
20419 (beg (skip-chars-backward "-+^/*0-9eE."))
20420 (end (skip-chars-forward "-+^/*0-9eE^.")) nap)
20421 (setq nap (buffer-substring-no-properties
20422 (+ pos beg) (+ pos beg end)))
20423 (delete-region (+ pos beg) (+ pos beg end))
20424 (insert (calc-eval (concat (number-to-string inc) "+" nap))))
20425 (when (org-at-table-p)
20427 (org-table-end-of-field 1))))
20429 (defun org-decrease-number-at-point (&optional inc)
20430 "Decrement the number at point.
20431 With an optional prefix numeric argument INC, decrement using
20432 this numeric value."
20434 (org-increase-number-at-point (- inc)))
20436 (defun org-ctrl-c-ret ()
20437 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20440 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20441 (t (call-interactively 'org-insert-heading))))
20443 (defun org-find-visible ()
20445 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20446 (get-char-property s 'invisible)))
20448 (defun org-find-invisible ()
20450 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20451 (not (get-char-property s 'invisible))))
20454 (defun org-copy-visible (beg end)
20455 "Copy the visible parts of the region."
20460 (narrow-to-region beg end)
20461 (setq s (goto-char (point-min)))
20462 (while (not (= (point) (point-max)))
20463 (goto-char (org-find-invisible))
20464 (push (buffer-substring s (point)) snippets)
20465 (setq s (goto-char (org-find-visible))))))
20466 (kill-new (apply 'concat (nreverse snippets)))))
20468 (defun org-copy-special ()
20469 "Copy region in table or copy current subtree.
20470 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20471 See the individual commands for more information."
20473 (call-interactively
20474 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20476 (defun org-cut-special ()
20477 "Cut region in table or cut current subtree.
20478 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20479 See the individual commands for more information."
20481 (call-interactively
20482 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20484 (defun org-paste-special (arg)
20485 "Paste rectangular region into table, or past subtree relative to level.
20486 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20487 See the individual commands for more information."
20489 (if (org-at-table-p)
20490 (org-table-paste-rectangle)
20491 (org-paste-subtree arg)))
20493 (defsubst org-in-fixed-width-region-p ()
20494 "Is point in a fixed-width region?"
20496 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20498 (defun org-edit-special (&optional arg)
20499 "Call a special editor for the element at point.
20500 When at a table, call the formula editor with `org-table-edit-formulas'.
20501 When in a source code block, call `org-edit-src-code'.
20502 When in a fixed-width region, call `org-edit-fixed-width-region'.
20503 When at an #+INCLUDE keyword, visit the included file.
20504 On a link, call `ffap' to visit the link at point.
20505 Otherwise, return a user error."
20507 (let ((element (org-element-at-point)))
20508 (assert (not buffer-read-only) nil
20509 "Buffer is read-only: %s" (buffer-name))
20510 (case (org-element-type element)
20512 (if (not arg) (org-edit-src-code)
20513 (let* ((info (org-babel-get-src-block-info))
20514 (lang (nth 0 info))
20515 (params (nth 2 info))
20516 (session (cdr (assq :session params))))
20517 (if (not session) (org-edit-src-code)
20518 ;; At a src-block with a session and function called with
20519 ;; an ARG: switch to the buffer related to the inferior
20522 (funcall (intern (concat "org-babel-prep-session:" lang))
20523 session params))))))
20525 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20526 (find-file-other-window
20527 (org-remove-double-quotes
20528 (car (org-split-string (org-element-property :value element)))))
20529 (user-error "No special environment to edit here")))
20531 (if (eq (org-element-property :type element) 'table.el)
20532 (org-edit-src-code)
20533 (call-interactively 'org-table-edit-formulas)))
20534 ;; Only Org tables contain `table-row' type elements.
20535 (table-row (call-interactively 'org-table-edit-formulas))
20536 ((example-block export-block) (org-edit-src-code))
20537 (fixed-width (org-edit-fixed-width-region))
20539 ;; No notable element at point. Though, we may be at a link,
20540 ;; which is an object. Thus, scan deeper.
20541 (if (eq (org-element-type (org-element-context element)) 'link)
20542 (call-interactively 'ffap)
20543 (user-error "No special environment to edit here"))))))
20545 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20546 (defun org-ctrl-c-ctrl-c (&optional arg)
20547 "Set tags in headline, or update according to changed information at point.
20549 This command does many different things, depending on context:
20551 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20552 this is what we do.
20554 - If the cursor is on a statistics cookie, update it.
20556 - If the cursor is in a headline, prompt for tags and insert them
20557 into the current line, aligned to `org-tags-column'. When called
20558 with prefix arg, realign all tags in the current buffer.
20560 - If the cursor is in one of the special #+KEYWORD lines, this
20561 triggers scanning the buffer for these lines and updating the
20564 - If the cursor is inside a table, realign the table. This command
20565 works even if the automatic table editor has been turned off.
20567 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20570 - If the cursor is at a footnote reference or definition, jump to
20571 the corresponding definition or references, respectively.
20573 - If the cursor is a the beginning of a dynamic block, update it.
20575 - If the current buffer is a capture buffer, close note and file it.
20577 - If the cursor is on a <<<target>>>, update radio targets and
20578 corresponding links in this buffer.
20580 - If the cursor is on a numbered item in a plain list, renumber the
20583 - If the cursor is on a checkbox, toggle it.
20585 - If the cursor is on a code block, evaluate it. The variable
20586 `org-confirm-babel-evaluate' can be used to control prompting
20587 before code block evaluation, by default every code block
20588 evaluation requires confirmation. Code block evaluation can be
20589 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20592 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20593 org-occur-highlights)
20594 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20595 (org-remove-occur-highlights)
20596 (message "Temporary highlights/overlays removed from current buffer"))
20597 ((and (local-variable-p 'org-finish-function (current-buffer))
20598 (fboundp org-finish-function))
20599 (funcall org-finish-function))
20600 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20602 (let* ((context (org-element-context)) (type (org-element-type context)))
20603 ;; Test if point is within a blank line.
20604 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20605 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20606 (user-error "C-c C-c can do nothing useful at this location"))
20608 ;; When at a link, act according to the parent instead.
20609 (link (setq context (org-element-property :parent context))
20610 (setq type (org-element-type context)))
20611 ;; Unsupported object types: refer to the first supported
20612 ;; element or object containing it.
20613 ((bold code entity export-snippet inline-babel-call inline-src-block
20614 italic latex-fragment line-break macro strike-through subscript
20615 superscript underline verbatim)
20616 (while (and (setq context (org-element-property :parent context))
20617 (not (memq (setq type (org-element-type context))
20618 '(radio-target paragraph verse-block
20620 ;; For convenience: at the first line of a paragraph on the
20621 ;; same line as an item, apply function on that item instead.
20622 (when (eq type 'paragraph)
20623 (let ((parent (org-element-property :parent context)))
20624 (when (and (eq (org-element-type parent) 'item)
20625 (= (point-at-bol) (org-element-property :begin parent)))
20626 (setq context parent type 'item))))
20627 ;; Act according to type of element or object at point.
20629 (clock (org-clock-update-time-maybe))
20632 (goto-char (org-element-property :post-affiliated context))
20633 (org-update-dblock)))
20634 (footnote-definition
20635 (goto-char (org-element-property :post-affiliated context))
20636 (call-interactively 'org-footnote-action))
20637 (footnote-reference (call-interactively 'org-footnote-action))
20638 ((headline inlinetask)
20639 (save-excursion (goto-char (org-element-property :begin context))
20640 (call-interactively 'org-set-tags)))
20642 ;; At an item: a double C-u set checkbox to "[-]"
20643 ;; unconditionally, whereas a single one will toggle its
20644 ;; presence. Without an universal argument, if the item
20645 ;; has a checkbox, toggle it. Otherwise repair the list.
20646 (let* ((box (org-element-property :checkbox context))
20647 (struct (org-element-property :structure context))
20648 (old-struct (copy-tree struct))
20649 (parents (org-list-parents-alist struct))
20650 (prevs (org-list-prevs-alist struct))
20651 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20652 (org-list-set-checkbox
20653 (org-element-property :begin context) struct
20654 (cond ((equal arg '(16)) "[-]")
20655 ((and (not box) (equal arg '(4))) "[ ]")
20656 ((or (not box) (equal arg '(4))) nil)
20657 ((eq box 'on) "[ ]")
20659 ;; Mimic `org-list-write-struct' but with grabbing
20660 ;; a return value from `org-list-struct-fix-box'.
20661 (org-list-struct-fix-ind struct parents 2)
20662 (org-list-struct-fix-item-end struct)
20663 (org-list-struct-fix-bul struct prevs)
20664 (org-list-struct-fix-ind struct parents)
20666 (org-list-struct-fix-box struct parents prevs orderedp)))
20667 (if (and box (equal struct old-struct))
20668 (if (equal arg '(16))
20669 (message "Checkboxes already reset")
20670 (user-error "Cannot toggle this checkbox: %s"
20672 "all subitems checked"
20673 "unchecked subitems")))
20674 (org-list-struct-apply-struct struct old-struct)
20675 (org-update-checkbox-count-maybe))
20677 (message "Checkboxes were removed due to empty box at line %d"
20678 (org-current-line block-item))))))
20680 (let ((org-inhibit-startup-visibility-stuff t)
20681 (org-startup-align-all-tables nil))
20682 (when (boundp 'org-table-coordinate-overlays)
20683 (mapc 'delete-overlay org-table-coordinate-overlays)
20684 (setq org-table-coordinate-overlays nil))
20685 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20686 (message "Local setup has been refreshed"))
20688 ;; At a plain list, with a double C-u argument, set
20689 ;; checkboxes of each item to "[-]", whereas a single one
20690 ;; will toggle their presence according to the state of the
20691 ;; first item in the list. Without an argument, repair the
20693 (let* ((begin (org-element-property :contents-begin context))
20694 (beginm (move-marker (make-marker) begin))
20695 (struct (org-element-property :structure context))
20696 (old-struct (copy-tree struct))
20697 (first-box (save-excursion
20699 (looking-at org-list-full-item-re)
20700 (match-string-no-properties 3)))
20701 (new-box (cond ((equal arg '(16)) "[-]")
20702 ((equal arg '(4)) (unless first-box "[ ]"))
20703 ((equal first-box "[X]") "[ ]")
20707 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20708 (org-list-get-all-items
20709 begin struct (org-list-prevs-alist struct))))
20710 ((and first-box (eq (point) begin))
20711 ;; For convenience, when point is at bol on the first
20712 ;; item of the list and no argument is provided, simply
20713 ;; toggle checkbox of that item, if any.
20714 (org-list-set-checkbox begin struct new-box)))
20715 (org-list-write-struct
20716 struct (org-list-parents-alist struct) old-struct)
20717 (org-update-checkbox-count-maybe)
20718 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20719 ((property-drawer node-property)
20720 (call-interactively 'org-property-action))
20721 ((radio-target target)
20722 (call-interactively 'org-update-radio-target-regexp))
20724 (call-interactively 'org-update-statistics-cookies))
20725 ((table table-cell table-row)
20726 ;; At a table, recalculate every field and align it. Also
20727 ;; send the table if necessary. If the table has
20728 ;; a `table.el' type, just give up. At a table row or
20729 ;; cell, maybe recalculate line but always align table.
20730 (if (eq (org-element-property :type context) 'table.el)
20731 (message "Use C-c ' to edit table.el tables")
20732 (let ((org-enable-table-editor t))
20733 (if (or (eq type 'table)
20734 ;; Check if point is at a TBLFM line.
20735 (and (eq type 'table-row)
20736 (= (point) (org-element-property :end context))))
20738 (if (org-at-TBLFM-p)
20739 (progn (require 'org-table)
20740 (org-table-calc-current-TBLFM))
20741 (goto-char (org-element-property :contents-begin context))
20742 (org-call-with-arg 'org-table-recalculate (or arg t))
20743 (orgtbl-send-table 'maybe)))
20744 (org-table-maybe-eval-formula)
20745 (cond (arg (call-interactively 'org-table-recalculate))
20746 ((org-table-maybe-recalculate-line))
20747 (t (org-table-align)))))))
20748 (timestamp (org-timestamp-change 0 'day))
20750 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20752 "C-c C-c can do nothing useful at this location")))))))))
20754 (defun org-mode-restart ()
20756 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20757 (funcall major-mode)
20758 (hack-local-variables)
20759 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20760 (org-indent-mode -1)))
20761 (message "%s restarted" major-mode))
20763 (defun org-kill-note-or-show-branches ()
20764 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20766 (if (not org-finish-function)
20769 (call-interactively 'show-branches))
20770 (let ((org-note-abort t))
20771 (funcall org-finish-function))))
20773 (defun org-open-line (n)
20774 "Insert a new row in tables, call `open-line' elsewhere.
20775 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20778 ((not org-special-ctrl-o)
20781 (org-table-insert-row))
20785 (defun org-return (&optional indent)
20786 "Goto next table row or insert a newline.
20787 Calls `org-table-next-row' or `newline', depending on context.
20788 See the individual commands for more information."
20792 ((or (bobp) (org-in-src-block-p))
20793 (if indent (newline-and-indent) (newline)))
20795 (org-table-justify-field-maybe)
20796 (call-interactively 'org-table-next-row))
20797 ;; when `newline-and-indent' is called within a list, make sure
20798 ;; text moved stays inside the item.
20799 ((and (org-in-item-p) indent)
20800 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20802 (save-match-data (newline))
20803 (org-indent-line-to (length (match-string 0))))
20804 (let ((ind (org-get-indentation)))
20806 (if (org-looking-back org-list-end-re)
20808 (org-indent-line-to ind)))))
20809 ((and org-return-follows-link
20810 (org-at-timestamp-p t)
20811 (not (eq org-ts-what 'after)))
20812 (org-follow-timestamp-link))
20813 ((and org-return-follows-link
20814 (let ((tprop (get-text-property (point) 'face)))
20815 (or (eq tprop 'org-link)
20816 (and (listp tprop) (memq 'org-link tprop)))))
20817 (call-interactively 'org-open-at-point))
20818 ((and (org-at-heading-p)
20820 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20824 (t (if indent (newline-and-indent) (newline))))))
20826 (defun org-return-indent ()
20827 "Goto next table row or insert a newline and indent.
20828 Calls `org-table-next-row' or `newline-and-indent', depending on
20829 context. See the individual commands for more information."
20833 (defun org-ctrl-c-star ()
20834 "Compute table, or change heading status of lines.
20835 Calls `org-table-recalculate' or `org-toggle-heading',
20836 depending on context."
20840 (call-interactively 'org-table-recalculate))
20842 ;; Convert all lines in region to list items
20843 (call-interactively 'org-toggle-heading))))
20845 (defun org-ctrl-c-minus ()
20846 "Insert separator line in table or modify bullet status of line.
20847 Also turns a plain line or a region of lines into list items.
20848 Calls `org-table-insert-hline', `org-toggle-item', or
20849 `org-cycle-list-bullet', depending on context."
20853 (call-interactively 'org-table-insert-hline))
20854 ((org-region-active-p)
20855 (call-interactively 'org-toggle-item))
20857 (call-interactively 'org-cycle-list-bullet))
20859 (call-interactively 'org-toggle-item))))
20861 (defun org-toggle-item (arg)
20862 "Convert headings or normal lines to items, items to normal lines.
20863 If there is no active region, only the current line is considered.
20865 If the first non blank line in the region is a headline, convert
20866 all headlines to items, shifting text accordingly.
20868 If it is an item, convert all items to normal lines.
20870 If it is normal text, change region into a list of items.
20871 With a prefix argument ARG, change the region in a single item."
20875 ;; Shift text in current section to IND, from point to END.
20876 ;; The function leaves point to END line.
20878 (let ((min-i 1000) (end (copy-marker end)))
20879 ;; First determine the minimum indentation (MIN-I) of
20883 (while (< (point) end)
20884 (let ((i (org-get-indentation)))
20886 ;; Skip blank lines and inline tasks.
20887 ((looking-at "^[ \t]*$"))
20888 ((looking-at org-outline-regexp-bol))
20889 ;; We can't find less than 0 indentation.
20890 ((zerop i) (throw 'exit (setq min-i 0)))
20891 ((< i min-i) (setq min-i i))))
20893 ;; Then indent each line so that a line indented to
20894 ;; MIN-I becomes indented to IND. Ignore blank lines
20895 ;; and inline tasks in the process.
20896 (let ((delta (- ind min-i)))
20897 (while (< (point) end)
20898 (unless (or (looking-at "^[ \t]*$")
20899 (looking-at org-outline-regexp-bol))
20900 (org-indent-line-to (+ (org-get-indentation) delta)))
20901 (forward-line)))))))
20904 ;; Return beginning of first non-blank line, starting from
20909 (skip-chars-forward " \r\t\n")
20912 ;; Determine boundaries of changes.
20913 (if (org-region-active-p)
20914 (setq beg (funcall skip-blanks (region-beginning))
20915 end (copy-marker (region-end)))
20916 (setq beg (funcall skip-blanks (point-at-bol))
20917 end (copy-marker (point-at-eol))))
20918 ;; Depending on the starting line, choose an action on the text
20919 ;; between BEG and END.
20920 (org-with-limited-levels
20924 ;; Case 1. Start at an item: de-itemize. Note that it only
20925 ;; happens when a region is active: `org-ctrl-c-minus'
20926 ;; would call `org-cycle-list-bullet' otherwise.
20928 (while (< (point) end)
20929 (when (org-at-item-p)
20930 (skip-chars-forward " \t")
20931 (delete-region (point) (match-end 0)))
20933 ;; Case 2. Start at an heading: convert to items.
20934 ((org-at-heading-p)
20935 (let* ((bul (org-list-bullet-string "-"))
20936 (bul-len (length bul))
20937 (done (org-entry-is-done-p))
20938 (todo (org-entry-is-todo-p))
20939 ;; Indentation of the first heading. It should be
20940 ;; relative to the indentation of its parent, if any.
20941 (start-ind (save-excursion
20943 ((not org-adapt-indentation) 0)
20944 ((not (outline-previous-heading)) 0)
20945 (t (length (match-string 0))))))
20946 ;; Level of first heading. Further headings will be
20947 ;; compared to it to determine hierarchy in the list.
20948 (ref-level (org-reduced-level (org-outline-level))))
20949 (when (or done todo) (org-todo ""))
20950 (while (< (point) end)
20951 (let* ((level (org-reduced-level (org-outline-level)))
20952 (delta (max 0 (- level ref-level))))
20953 ;; If current headline is less indented than the first
20954 ;; one, set it as reference, in order to preserve
20956 (when (< level ref-level) (setq ref-level level))
20957 (replace-match bul t t)
20958 (org-indent-line-to (+ start-ind (* delta bul-len)))
20959 (when (or done todo)
20960 (let* ((struct (org-list-struct))
20961 (old (copy-tree struct)))
20962 (org-list-set-checkbox (line-beginning-position)
20964 (if done "[X]" "[ ]"))
20965 (org-list-write-struct struct
20966 (org-list-parents-alist struct)
20968 ;; Ensure all text down to END (or SECTION-END) belongs
20969 ;; to the newly created item.
20970 (let ((section-end (save-excursion
20971 (or (outline-next-heading) (point)))))
20973 (funcall shift-text
20974 (+ start-ind (* (1+ delta) bul-len))
20975 (min end section-end)))))))
20976 ;; Case 3. Normal line with ARG: make the first line of region
20977 ;; an item, and shift indentation of others lines to
20978 ;; set them as item's body.
20979 (arg (let* ((bul (org-list-bullet-string "-"))
20980 (bul-len (length bul))
20981 (ref-ind (org-get-indentation)))
20982 (skip-chars-forward " \t")
20985 (while (< (point) end)
20986 ;; Ensure that lines less indented than first one
20987 ;; still get included in item body.
20988 (funcall shift-text
20989 (+ ref-ind bul-len)
20990 (min end (save-excursion (or (outline-next-heading)
20993 ;; Case 4. Normal line without ARG: turn each non-item line
20996 (while (< (point) end)
20997 (unless (or (org-at-heading-p) (org-at-item-p))
20998 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
21000 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
21001 (forward-line))))))))
21003 (defun org-toggle-heading (&optional nstars)
21004 "Convert headings to normal text, or items or text to headings.
21005 If there is no active region, only convert the current line.
21007 With a \\[universal-argument] prefix, convert the whole list at
21008 point into heading.
21012 - If the first non blank line is a headline, remove the stars
21013 from all headlines in the region.
21015 - If it is a normal line, turn each and every normal line (i.e.,
21016 not an heading or an item) in the region into headings. If you
21017 want to convert only the first line of this region, use one
21018 universal prefix argument.
21020 - If it is a plain list item, turn all plain list items into headings.
21022 When converting a line into a heading, the number of stars is chosen
21023 such that the lines become children of the current entry. However,
21024 when a numeric prefix argument is given, its value determines the
21025 number of stars to add."
21029 ;; Return beginning of first non-blank line, starting from
21034 (while (org-at-comment-p) (forward-line))
21035 (skip-chars-forward " \r\t\n")
21038 ;; Determine boundaries of changes. If a universal prefix has
21039 ;; been given, put the list in a region. If region ends at a bol,
21040 ;; do not consider the last line to be in the region.
21042 (when (and current-prefix-arg (org-at-item-p))
21043 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
21044 (org-mark-element))
21046 (if (org-region-active-p)
21047 (setq beg (funcall skip-blanks (region-beginning))
21048 end (copy-marker (save-excursion
21049 (goto-char (region-end))
21050 (if (bolp) (point) (point-at-eol)))))
21051 (setq beg (funcall skip-blanks (point-at-bol))
21052 end (copy-marker (point-at-eol))))
21053 ;; Ensure inline tasks don't count as headings.
21054 (org-with-limited-levels
21058 ;; Case 1. Started at an heading: de-star headings.
21059 ((org-at-heading-p)
21060 (while (< (point) end)
21061 (when (org-at-heading-p t)
21062 (looking-at org-outline-regexp) (replace-match "")
21065 ;; Case 2. Started at an item: change items into headlines.
21066 ;; One star will be added by `org-list-to-subtree'.
21068 (let* ((stars (make-string
21069 ;; subtract the star that will be added again by
21070 ;; `org-list-to-subtree'
21071 (if (numberp nstars) (1- nstars)
21072 (or (org-current-level) 0))
21075 (cond (nstars "") ; stars from prefix only
21076 ((equal stars "") "") ; before first heading
21077 (org-odd-levels-only "*") ; inside heading, odd
21078 (t "")))) ; inside heading, oddeven
21079 (while (< (point) end)
21080 (when (org-at-item-p)
21081 ;; Pay attention to cases when region ends before list.
21082 (let* ((struct (org-list-struct))
21083 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
21085 (narrow-to-region (point) list-end)
21087 (org-list-to-subtree
21088 (org-list-parse-list t)
21089 '(:istart (concat stars add-stars (funcall get-stars depth))
21090 :icount (concat stars add-stars (funcall get-stars depth)))))))
21093 ;; Case 3. Started at normal text: make every line an heading,
21094 ;; skipping headlines and items.
21097 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
21099 (cond (nstars "") ; stars from prefix only
21100 ((equal stars "") "*") ; before first heading
21101 (org-odd-levels-only "**") ; inside heading, odd
21102 (t "*"))) ; inside heading, oddeven
21103 (rpl (concat stars add-stars " "))
21104 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
21105 (while (< (point) (if (equal nstars '(4)) lend end))
21106 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
21107 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
21108 (replace-match (concat rpl (match-string 2))) (setq toggled t))
21109 (forward-line)))))))
21110 (unless toggled (message "Cannot toggle heading from here"))))
21112 (defun org-meta-return (&optional arg)
21113 "Insert a new heading or wrap a region in a table.
21114 Calls `org-insert-heading' or `org-table-wrap-region', depending
21115 on context. See the individual commands for more information."
21117 (org-check-before-invisible-edit 'insert)
21118 (or (run-hook-with-args-until-success 'org-metareturn-hook)
21119 (let* ((element (org-element-at-point))
21120 (type (org-element-type element)))
21121 (when (eq type 'table-row)
21122 (setq element (org-element-property :parent element))
21123 (setq type 'table))
21124 (if (and (eq type 'table)
21125 (eq (org-element-property :type element) 'org)
21126 (>= (point) (org-element-property :contents-begin element))
21127 (< (point) (org-element-property :contents-end element)))
21128 (call-interactively 'org-table-wrap-region)
21129 (call-interactively 'org-insert-heading)))))
21133 (defsubst org-in-subtree-not-table-p ()
21134 "Are we in a subtree and not in a table?"
21135 (and (not (org-before-first-heading-p))
21136 (not (org-at-table-p))))
21138 ;; Define the Org-mode menus
21139 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
21141 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
21142 ["Next Field" org-cycle (org-at-table-p)]
21143 ["Previous Field" org-shifttab (org-at-table-p)]
21144 ["Next Row" org-return (org-at-table-p)]
21146 ["Blank Field" org-table-blank-field (org-at-table-p)]
21147 ["Edit Field" org-table-edit-field (org-at-table-p)]
21148 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
21151 ["Move Column Left" org-metaleft (org-at-table-p)]
21152 ["Move Column Right" org-metaright (org-at-table-p)]
21153 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
21154 ["Insert Column" org-shiftmetaright (org-at-table-p)]
21155 ["Ascii plot" orgtbl-ascii-plot (org-at-table-p)])
21157 ["Move Row Up" org-metaup (org-at-table-p)]
21158 ["Move Row Down" org-metadown (org-at-table-p)]
21159 ["Delete Row" org-shiftmetaup (org-at-table-p)]
21160 ["Insert Row" org-shiftmetadown (org-at-table-p)]
21161 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
21163 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
21165 ["Copy Rectangle" org-copy-special (org-at-table-p)]
21166 ["Cut Rectangle" org-cut-special (org-at-table-p)]
21167 ["Paste Rectangle" org-paste-special (org-at-table-p)]
21168 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
21171 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
21172 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
21173 ["Edit Formulas" org-edit-special (org-at-table-p)]
21175 ["Recalculate line" org-table-recalculate (org-at-table-p)]
21176 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
21177 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
21179 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
21181 ["Sum Column/Rectangle" org-table-sum
21182 (or (org-at-table-p) (org-region-active-p))]
21183 ["Which Column?" org-table-current-column (org-at-table-p)])
21185 org-table-toggle-formula-debugger
21186 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
21187 ["Show Col/Row Numbers"
21188 org-table-toggle-coordinate-overlays
21190 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
21192 ["Create" org-table-create (and (not (org-at-table-p))
21193 org-enable-table-editor)]
21194 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
21195 ["Import from File" org-table-import (not (org-at-table-p))]
21196 ["Export to File" org-table-export (org-at-table-p)]
21198 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
21200 (easy-menu-define org-org-menu org-mode-map "Org menu"
21203 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
21204 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
21205 ["Sparse Tree..." org-sparse-tree t]
21206 ["Reveal Context" org-reveal t]
21207 ["Show All" show-all t]
21209 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
21211 ["New Heading" org-insert-heading t]
21212 ("Navigate Headings"
21213 ["Up" outline-up-heading t]
21214 ["Next" outline-next-visible-heading t]
21215 ["Previous" outline-previous-visible-heading t]
21216 ["Next Same Level" outline-forward-same-level t]
21217 ["Previous Same Level" outline-backward-same-level t]
21219 ["Jump" org-goto t])
21221 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
21223 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
21224 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
21226 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
21227 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
21228 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
21230 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
21232 ["Copy visible text" org-copy-visible t]
21234 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
21235 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21236 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21237 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21239 ["Sort Region/Children" org-sort t]
21241 ["Convert to odd levels" org-convert-to-odd-levels t]
21242 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21244 ["Emphasis..." org-emphasize t]
21245 ["Edit Source Example" org-edit-special t]
21247 ["Footnote new/jump" org-footnote-action t]
21248 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21250 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21252 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21253 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21254 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21258 ["Store Link (Global)" org-store-link t]
21259 ["Find existing link to here" org-occur-link-in-agenda-files t]
21260 ["Insert Link" org-insert-link t]
21261 ["Follow Link" org-open-at-point t]
21263 ["Next link" org-next-link t]
21264 ["Previous link" org-previous-link t]
21266 ["Descriptive Links"
21267 org-toggle-link-display
21269 :selected org-descriptive-links
21272 org-toggle-link-display
21274 :selected (not org-descriptive-links)])
21277 ["TODO/DONE/-" org-todo t]
21279 ["Next keyword" org-shiftright (org-at-heading-p)]
21280 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21281 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21282 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21283 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21284 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21285 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21287 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21288 :selected org-enforce-todo-dependencies :style toggle :active t]
21289 "Settings for tree at point"
21290 ["Do Children sequentially" org-toggle-ordered-property :style radio
21291 :selected (org-entry-get nil "ORDERED")
21292 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21293 ["Do Children parallel" org-toggle-ordered-property :style radio
21294 :selected (not (org-entry-get nil "ORDERED"))
21295 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21297 ["Set Priority" org-priority t]
21298 ["Priority Up" org-shiftup t]
21299 ["Priority Down" org-shiftdown t]
21301 ["Get news from all feeds" org-feed-update-all t]
21302 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21303 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21304 ("TAGS and Properties"
21305 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21306 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21308 ["Set property" org-set-property (not (org-before-first-heading-p))]
21309 ["Column view of properties" org-columns t]
21310 ["Insert Column View DBlock" org-insert-columns-dblock t])
21311 ("Dates and Scheduling"
21312 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21313 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21315 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21316 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21317 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21318 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21319 ["Compute Time Range" org-evaluate-time-range t]
21320 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21321 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21323 ["Custom time format" org-toggle-time-stamp-overlays
21324 :style radio :selected org-display-custom-times]
21326 ["Goto Calendar" org-goto-calendar t]
21327 ["Date from Calendar" org-date-from-calendar t]
21329 ["Start/Restart Timer" org-timer-start t]
21330 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21331 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21332 ["Insert Timer String" org-timer t]
21333 ["Insert Timer Item" org-timer-item t])
21335 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21336 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21337 ["Clock out" org-clock-out t]
21338 ["Clock cancel" org-clock-cancel t]
21340 ["Mark as default task" org-clock-mark-default-task t]
21341 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21342 ["Goto running clock" org-clock-goto t]
21344 ["Display times" org-clock-display t]
21345 ["Create clock table" org-clock-report t]
21347 ["Record DONE time"
21348 (progn (setq org-log-done (not org-log-done))
21349 (message "Switching to %s will %s record a timestamp"
21350 (car org-done-keywords)
21351 (if org-log-done "automatically" "not")))
21352 :style toggle :selected org-log-done])
21354 ["Agenda Command..." org-agenda t]
21355 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21356 ("File List for Agenda")
21357 ("Special views current file"
21358 ["TODO Tree" org-show-todo-tree t]
21359 ["Check Deadlines" org-check-deadlines t]
21360 ["Timeline" org-timeline t]
21361 ["Tags/Property tree" org-match-sparse-tree t])
21363 ["Export/Publish..." org-export-dispatch t]
21365 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21366 :selected org-cdlatex-mode]
21367 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21368 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21369 ["Modify math symbol" org-cdlatex-math-modify
21370 (org-inside-LaTeX-fragment-p)]
21371 ["Insert citation" org-reftex-citation t]
21373 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21376 ["Push Files and Views" org-mobile-push t]
21377 ["Get Captured and Flagged" org-mobile-pull t]
21378 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21380 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21383 ["Show Version" org-version t]
21384 ["Info Documentation" org-info t])
21386 ["Browse Org Group" org-customize t]
21388 ["Expand This Menu" org-create-customize-menu
21389 (fboundp 'customize-menu-create)])
21390 ["Send bug report" org-submit-bug-report t]
21393 ["Refresh setup current buffer" org-mode-restart t]
21394 ["Reload Org (after update)" org-reload t]
21395 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21398 (defun org-info (&optional node)
21399 "Read documentation for Org-mode in the info system.
21400 With optional NODE, go directly to that node."
21402 (info (format "(org)%s" (or node ""))))
21405 (defun org-submit-bug-report ()
21406 "Submit a bug report on Org-mode via mail.
21408 Don't hesitate to report any problems or inaccurate documentation.
21410 If you don't have setup sending mail from (X)Emacs, please copy the
21411 output buffer into your mail program, as it gives us important
21412 information about your Org-mode version and configuration."
21414 (require 'reporter)
21415 (org-load-modules-maybe)
21416 (org-require-autoloaded-modules)
21417 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21418 (reporter-submit-bug-report
21419 "emacs-orgmode@gnu.org"
21420 (org-version nil 'full)
21422 (save-window-excursion
21423 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21424 (delete-other-windows)
21426 (insert "You are about to submit a bug report to the Org-mode mailing list.
21428 We would like to add your full Org-mode and Outline configuration to the
21429 bug report. This greatly simplifies the work of the maintainer and
21430 other experts on the mailing list.
21432 HOWEVER, some variables you have customized may contain private
21433 information. The names of customers, colleagues, or friends, might
21434 appear in the form of file names, tags, todo states, or search strings.
21435 If you answer yes to the prompt, you might want to check and remove
21436 such private information before sending the email.")
21437 (add-text-properties (point-min) (point-max) '(face org-warning))
21438 (when (yes-or-no-p "Include your Org-mode configuration ")
21442 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21443 (or (and (symbol-value v)
21444 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21446 (get v 'custom-type) (get v 'standard-value)
21447 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21449 (kill-buffer (get-buffer "*Warn about privacy*"))
21452 "Remember to cover the basics, that is, what you expected to happen and
21453 what in fact did happen. You don't know how to make a good report? See
21455 http://orgmode.org/manual/Feedback.html#Feedback
21457 Your bug report will be posted to the Org-mode mailing list.
21458 ------------------------------------------------------------------------")
21460 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21461 (replace-match "\\1Bug: \\3 [\\2]")))))
21464 (defun org-install-agenda-files-menu ()
21465 (let ((bl (buffer-list)))
21468 (set-buffer (pop bl))
21469 (if (derived-mode-p 'org-mode) (setq bl nil)))
21470 (when (derived-mode-p 'org-mode)
21472 '("Org") "File List for Agenda"
21475 ["Edit File List" (org-edit-agenda-file-list) t]
21476 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21477 ["Remove Current File from List" org-remove-file t]
21478 ["Cycle through agenda files" org-cycle-agenda-files t]
21479 ["Occur in all agenda files" org-occur-in-agenda-files t]
21481 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21485 (defun org-require-autoloaded-modules ()
21488 '(org-agenda org-archive org-attach org-clock org-colview org-id
21489 org-table org-timer)))
21492 (defun org-reload (&optional uncompiled)
21493 "Reload all org lisp files.
21494 With prefix arg UNCOMPILED, load the uncompiled versions."
21496 (require 'loadhist)
21497 (let* ((org-dir (org-find-library-dir "org"))
21498 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21499 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21500 (remove-re (mapconcat 'identity
21501 (mapcar (lambda (f) (concat "^" f "$"))
21502 (list (if (featurep 'xemacs)
21504 "org-colview-xemacs")
21505 "org" "org-loaddefs" "org-version"))
21507 (feats (delete-dups
21508 (mapcar 'file-name-sans-extension
21509 (mapcar 'file-name-nondirectory
21511 (mapcar 'feature-file
21518 (if (and (string-match feature-re f)
21519 (not (string-match remove-re f)))
21523 (list "org-version" "org")))
21524 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21525 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21526 load-uncore load-misses)
21529 (mapcar (lambda (f)
21530 (or (org-load-noerror-mustsuffix (concat org-dir f))
21531 (and (string= org-dir contrib-dir)
21532 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21533 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21534 (add-to-list 'load-uncore f 'append)
21539 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21540 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21542 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21543 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21544 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21547 (defun org-customize ()
21548 "Call the customize function with org as argument."
21550 (org-load-modules-maybe)
21551 (org-require-autoloaded-modules)
21552 (customize-browse 'org))
21554 (defun org-create-customize-menu ()
21555 "Create a full customization menu for Org-mode, insert it into the menu."
21557 (org-load-modules-maybe)
21558 (org-require-autoloaded-modules)
21559 (if (fboundp 'customize-menu-create)
21562 '("Org") "Customize"
21563 `(["Browse Org group" org-customize t]
21565 ,(customize-menu-create 'org)
21566 ["Set" Custom-set t]
21567 ["Save" Custom-save t]
21568 ["Reset to Current" Custom-reset-current t]
21569 ["Reset to Saved" Custom-reset-saved t]
21570 ["Reset to Standard Settings" Custom-reset-standard t]))
21571 (message "\"Org\"-menu now contains full customization menu"))
21572 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21574 ;;;; Miscellaneous stuff
21576 ;;; Generally useful functions
21578 (defsubst org-get-at-eol (property n)
21579 "Get text property PROPERTY at the end of line less N characters."
21580 (get-text-property (- (point-at-eol) n) property))
21582 (defun org-find-text-property-in-string (prop s)
21583 "Return the first non-nil value of property PROP in string S."
21584 (or (get-text-property 0 prop s)
21585 (get-text-property (or (next-single-property-change 0 prop s) 0)
21588 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21589 "Display the given MESSAGE as a warning."
21590 (if (fboundp 'display-warning)
21591 (display-warning 'org message
21592 (if (featurep 'xemacs) 'warning :warning))
21593 (let ((buf (get-buffer-create "*Org warnings*")))
21594 (with-current-buffer buf
21595 (goto-char (point-max))
21596 (insert "Warning (Org): " message)
21599 (display-buffer buf)
21602 (defun org-eval (form)
21603 "Eval FORM and return result."
21604 (condition-case error
21606 (error (format "%%![Error: %s]" error))))
21608 (defun org-in-clocktable-p ()
21609 "Check if the cursor is in a clocktable."
21610 (let ((pos (point)) start)
21613 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21614 (setq start (match-beginning 0))
21615 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21616 (>= (match-end 0) pos)
21619 (defun org-in-verbatim-emphasis ()
21621 (and (org-in-regexp org-emph-re 2)
21622 (>= (point) (match-beginning 3))
21623 (<= (point) (match-end 4))
21624 (member (match-string 3) '("=" "~")))))
21626 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21627 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21628 (if (and marker (marker-buffer marker)
21629 (buffer-live-p (marker-buffer marker)))
21631 (org-pop-to-buffer-same-window (marker-buffer marker))
21632 (if (or (> marker (point-max)) (< marker (point-min)))
21635 (org-show-context 'org-goto))
21637 (bookmark-jump bookmark)
21638 (error "Cannot find location"))))
21640 (defun org-quote-csv-field (s)
21641 "Quote field for inclusion in CSV material."
21642 (if (string-match "[\",]" s)
21643 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21646 (defun org-force-self-insert (N)
21647 "Needed to enforce self-insert under remapping."
21649 (self-insert-command N))
21651 (defun org-string-width (s)
21652 "Compute width of string, ignoring invisible characters.
21653 This ignores character with invisibility property `org-link', and also
21654 characters with property `org-cwidth', because these will become invisible
21655 upon the next fontification round."
21657 (when (or (eq t buffer-invisibility-spec)
21658 (assq 'org-link buffer-invisibility-spec))
21659 (while (setq b (text-property-any 0 (length s)
21660 'invisible 'org-link s))
21661 (setq s (concat (substring s 0 b)
21662 (substring s (or (next-single-property-change
21663 b 'invisible s) (length s)))))))
21664 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21665 (setq s (concat (substring s 0 b)
21666 (substring s (or (next-single-property-change
21667 b 'org-cwidth s) (length s))))))
21668 (setq l (string-width s) b -1)
21669 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21670 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21673 (defun org-shorten-string (s maxlength)
21674 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21675 If the string is shorter or has length MAXLENGTH, just return the
21676 original string. If it is longer, the functions finds a space in the
21677 string, breaks this string off at that locations and adds three dots
21678 as ellipsis. Including the ellipsis, the string will not be longer
21679 than MAXLENGTH. If finding a good breaking point in the string does
21680 not work, the string is just chopped off in the middle of a word
21682 (if (<= (length s) maxlength)
21684 (let* ((n (max (- maxlength 4) 1))
21685 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21686 (if (string-match re s)
21687 (concat (match-string 1 s) "...")
21688 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21690 (defun org-get-indentation (&optional line)
21691 "Get the indentation of the current line, interpreting tabs.
21692 When LINE is given, assume it represents a line and compute its indentation."
21694 (if (string-match "^ *" (org-remove-tabs line))
21697 (beginning-of-line 1)
21698 (skip-chars-forward " \t")
21699 (current-column))))
21701 (defun org-get-string-indentation (s)
21702 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21703 (let ((n -1) (i 0) (w tab-width) c)
21705 (while (< (setq n (1+ n)) (length s))
21706 (setq c (aref s n))
21707 (cond ((= c ?\ ) (setq i (1+ i)))
21708 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21709 (t (throw 'exit t)))))
21712 (defun org-remove-tabs (s &optional width)
21713 "Replace tabulators in S with spaces.
21714 Assumes that s is a single line, starting in column 0."
21715 (setq width (or width tab-width))
21716 (while (string-match "\t" s)
21717 (setq s (replace-match
21719 (- (* width (/ (+ (match-beginning 0) width) width))
21720 (match-beginning 0)) ?\ )
21724 (defun org-fix-indentation (line ind)
21725 "Fix indentation in LINE.
21726 IND is a cons cell with target and minimum indentation.
21727 If the current indentation in LINE is smaller than the minimum,
21728 leave it alone. If it is larger than ind, set it to the target."
21729 (let* ((l (org-remove-tabs line))
21730 (i (org-get-indentation l))
21731 (i1 (car ind)) (i2 (cdr ind)))
21732 (if (>= i i2) (setq l (substring line i2)))
21734 (concat (make-string i1 ?\ ) l)
21737 (defun org-remove-indentation (code &optional n)
21738 "Remove the maximum common indentation from the lines in CODE.
21739 N may optionally be the number of spaces to remove."
21742 (org-do-remove-indentation n)
21745 (defun org-do-remove-indentation (&optional n)
21746 "Remove the maximum common indentation from the buffer."
21747 (untabify (point-min) (point-max))
21748 (let ((min 10000) re)
21751 (goto-char (point-min))
21752 (while (re-search-forward "^ *[^ \n]" nil t)
21753 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21754 (unless (or (= min 0) (= min 10000))
21755 (setq re (format "^ \\{%d\\}" min))
21756 (goto-char (point-min))
21757 (while (re-search-forward re nil t)
21762 (defun org-fill-template (template alist)
21763 "Find each %key of ALIST in TEMPLATE and replace it."
21764 (let ((case-fold-search nil)
21766 (setq alist (sort (copy-sequence alist)
21767 (lambda (a b) (< (length (car a)) (length (car b))))))
21768 (while (setq entry (pop alist))
21770 (replace-regexp-in-string
21771 (concat "%" (regexp-quote (car entry)))
21772 (or (cdr entry) "") template t t)))
21775 (defun org-base-buffer (buffer)
21776 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21779 (or (buffer-base-buffer buffer)
21782 (defun org-wrap (string &optional width lines)
21783 "Wrap string to either a number of lines, or a width in characters.
21784 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21785 that costs. If there is a word longer than WIDTH, the text is actually
21786 wrapped to the length of that word.
21787 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21788 many lines, whatever width that takes.
21789 The return value is a list of lines, without newlines at the end."
21790 (let* ((words (org-split-string string "[ \t\n]+"))
21791 (maxword (apply 'max (mapcar 'org-string-width words)))
21794 (org-do-wrap words (max maxword width)))
21797 (setq ll (org-do-wrap words maxword))
21798 (if (<= (length ll) lines)
21801 (while (> (length ll) lines)
21803 (setq ll (org-do-wrap words w)))
21805 (t (error "Cannot wrap this")))))
21807 (defun org-do-wrap (words width)
21808 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21811 (setq line (pop words))
21812 (while (and words (< (+ (length line) (length (car words))) width))
21813 (setq line (concat line " " (pop words))))
21814 (setq lines (push line lines)))
21817 (defun org-split-string (string &optional separators)
21818 "Splits STRING into substrings at SEPARATORS.
21819 No empty strings are returned if there are matches at the beginning
21820 and end of string."
21821 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21825 (while (and (string-match rexp string
21827 (= start (match-beginning 0))
21828 (< start (length string)))
21830 (< (match-beginning 0) (length string)))
21832 (or (eq (match-beginning 0) 0)
21833 (and (eq (match-beginning 0) (match-end 0))
21834 (eq (match-beginning 0) start))
21836 (cons (substring string start (match-beginning 0))
21838 (setq start (match-end 0)))
21839 (or (eq start (length string))
21841 (cons (substring string start)
21845 (defun org-quote-vert (s)
21846 "Replace \"|\" with \"\\vert\"."
21847 (while (string-match "|" s)
21848 (setq s (replace-match "\\vert" t t s)))
21851 (defun org-uuidgen-p (s)
21852 "Is S an ID created by UUIDGEN?"
21853 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21855 (defun org-in-src-block-p (&optional inside)
21856 "Whether point is in a code source block.
21857 When INSIDE is non-nil, don't consider we are within a src block
21858 when point is at #+BEGIN_SRC or #+END_SRC."
21859 (let ((case-fold-search t) ov)
21860 (or (and (eq (get-char-property (point) 'src-block) t))
21864 (beginning-of-line)
21865 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21867 (defun org-context ()
21868 "Return a list of contexts of the current cursor position.
21869 If several contexts apply, all are returned.
21870 Each context entry is a list with a symbol naming the context, and
21871 two positions indicating start and end of the context. Possible
21874 :headline anywhere in a headline
21875 :headline-stars on the leading stars in a headline
21876 :todo-keyword on a TODO keyword (including DONE) in a headline
21877 :tags on the TAGS in a headline
21878 :priority on the priority cookie in a headline
21879 :item on the first line of a plain list item
21880 :item-bullet on the bullet/number of a plain list item
21881 :checkbox on the checkbox in a plain list item
21882 :table in an org-mode table
21883 :table-special on a special filed in a table
21884 :table-table in a table.el table
21885 :clocktable in a clocktable
21886 :src-block in a source block
21887 :link on a hyperlink
21888 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
21889 :target on a <<target>>
21890 :radio-target on a <<<radio-target>>>
21891 :latex-fragment on a LaTeX fragment
21892 :latex-preview on a LaTeX fragment with overlaid preview image
21894 This function expects the position to be visible because it uses font-lock
21895 faces as a help to recognize the following contexts: :table-special, :link,
21897 (let* ((f (get-text-property (point) 'face))
21898 (faces (if (listp f) f (list f)))
21899 (case-fold-search t)
21900 (p (point)) clist o)
21901 ;; First the large context
21903 ((org-at-heading-p t)
21904 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21906 (beginning-of-line 1)
21907 (looking-at org-todo-line-tags-regexp))
21908 (push (org-point-in-group p 1 :headline-stars) clist)
21909 (push (org-point-in-group p 2 :todo-keyword) clist)
21910 (push (org-point-in-group p 4 :tags) clist))
21912 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21913 (if (looking-at "\\[#[A-Z0-9]\\]")
21914 (push (org-point-in-group p 0 :priority) clist)))
21917 (push (org-point-in-group p 2 :item-bullet) clist)
21918 (push (list :item (point-at-bol)
21919 (save-excursion (org-end-of-item) (point)))
21921 (and (org-at-item-checkbox-p)
21922 (push (org-point-in-group p 0 :checkbox) clist)))
21925 (push (list :table (org-table-begin) (org-table-end)) clist)
21926 (if (memq 'org-formula faces)
21927 (push (list :table-special
21928 (previous-single-property-change p 'face)
21929 (next-single-property-change p 'face)) clist)))
21930 ((org-at-table-p 'any)
21931 (push (list :table-table) clist)))
21934 (let ((case-fold-search t))
21935 ;; New the "medium" contexts: clocktables, source blocks
21936 (cond ((org-in-clocktable-p)
21937 (push (list :clocktable
21938 (and (or (looking-at "[ \t]*\\(#\\+BEGIN: clocktable\\)")
21939 (re-search-backward "[ \t]*\\(#+BEGIN: clocktable\\)" nil t))
21940 (match-beginning 1))
21941 (and (re-search-forward "[ \t]*#\\+END:?" nil t)
21942 (match-end 0))) clist))
21943 ((org-in-src-block-p)
21944 (push (list :src-block
21945 (and (or (looking-at "[ \t]*\\(#\\+BEGIN_SRC\\)")
21946 (re-search-backward "[ \t]*\\(#+BEGIN_SRC\\)" nil t))
21947 (match-beginning 1))
21948 (and (search-forward "#+END_SRC" nil t)
21949 (match-beginning 0))) clist))))
21952 ;; Now the small context
21954 ((org-at-timestamp-p)
21955 (push (org-point-in-group p 0 :timestamp) clist))
21956 ((memq 'org-link faces)
21958 (previous-single-property-change p 'face)
21959 (next-single-property-change p 'face)) clist))
21960 ((memq 'org-special-keyword faces)
21961 (push (list :keyword
21962 (previous-single-property-change p 'face)
21963 (next-single-property-change p 'face)) clist))
21965 (push (org-point-in-group p 0 :target) clist)
21966 (goto-char (1- (match-beginning 0)))
21967 (if (looking-at org-radio-target-regexp)
21968 (push (org-point-in-group p 0 :radio-target) clist))
21970 ((setq o (car (delq nil
21973 (if (memq x org-latex-fragment-image-overlays) x))
21974 (overlays-at (point))))))
21975 (push (list :latex-fragment
21976 (overlay-start o) (overlay-end o)) clist)
21977 (push (list :latex-preview
21978 (overlay-start o) (overlay-end o)) clist))
21979 ((org-inside-LaTeX-fragment-p)
21980 ;; FIXME: positions wrong.
21981 (push (list :latex-fragment (point) (point)) clist)))
21983 (setq clist (nreverse (delq nil clist)))
21986 ;; FIXME: Compare with at-regexp-p Do we need both?
21987 (defun org-in-regexp (re &optional nlines visually)
21988 "Check if point is inside a match of regexp.
21989 Normally only the current line is checked, but you can include NLINES extra
21990 lines both before and after point into the search.
21991 If VISUALLY is set, require that the cursor is not after the match but
21992 really on, so that the block visually is on the match."
21994 (let ((pos (point))
21995 (eol (point-at-eol (+ 1 (or nlines 0))))
21996 (inc (if visually 1 0)))
21998 (beginning-of-line (- 1 (or nlines 0)))
21999 (while (re-search-forward re eol t)
22000 (if (and (<= (match-beginning 0) pos)
22001 (>= (+ inc (match-end 0)) pos))
22002 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
22004 (defun org-at-regexp-p (regexp)
22005 "Is point inside a match of REGEXP in the current line?"
22008 (let ((pos (point)) (end (point-at-eol)))
22009 (beginning-of-line 1)
22010 (while (re-search-forward regexp end t)
22011 (if (and (<= (match-beginning 0) pos)
22012 (>= (match-end 0) pos))
22016 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
22017 "Non-nil when point is between matches of START-RE and END-RE.
22019 Also return a non-nil value when point is on one of the matches.
22021 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
22022 buffer positions. Default values are the positions of headlines
22023 surrounding the point.
22025 The functions returns a cons cell whose car (resp. cdr) is the
22026 position before START-RE (resp. after END-RE)."
22028 (let ((pos (point))
22029 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
22030 (limit-down (or lim-down (save-excursion (outline-next-heading))))
22033 ;; Point is on a block when on START-RE or if START-RE can be
22034 ;; found before it...
22035 (and (or (org-at-regexp-p start-re)
22036 (re-search-backward start-re limit-up t))
22037 (setq beg (match-beginning 0))
22038 ;; ... and END-RE after it...
22039 (goto-char (match-end 0))
22040 (re-search-forward end-re limit-down t)
22041 (> (setq end (match-end 0)) pos)
22042 ;; ... without another START-RE in-between.
22043 (goto-char (match-beginning 0))
22044 (not (re-search-backward start-re (1+ beg) t))
22046 (cons beg end))))))
22048 (defun org-in-block-p (names)
22049 "Non-nil when point belongs to a block whose name belongs to NAMES.
22051 NAMES is a list of strings containing names of blocks.
22053 Return first block name matched, or nil. Beware that in case of
22054 nested blocks, the returned name may not belong to the closest
22058 (let ((case-fold-search t)
22059 (lim-up (save-excursion (outline-previous-heading)))
22060 (lim-down (save-excursion (outline-next-heading))))
22061 (mapc (lambda (name)
22062 (let ((n (regexp-quote name)))
22063 (when (org-between-regexps-p
22064 (concat "^[ \t]*#\\+begin_" n)
22065 (concat "^[ \t]*#\\+end_" n)
22071 (defun org-in-drawer-p ()
22072 "Non-nil if point is within a drawer.
22073 If point is within a drawer, return it, as parsed data."
22074 (let ((element (save-match-data (org-element-at-point))))
22075 (while (and element (not (memq (org-element-type element)
22076 '(drawer property-drawer))))
22077 (setq element (org-element-property :parent element)))
22080 (defun org-occur-in-agenda-files (regexp &optional nlines)
22081 "Call `multi-occur' with buffers for all agenda files."
22082 (interactive "sOrg-files matching: \np")
22083 (let* ((files (org-agenda-files))
22084 (tnames (mapcar 'file-truename files))
22085 (extra org-agenda-text-search-extra-files)
22087 (when (eq (car extra) 'agenda-archives)
22088 (setq extra (cdr extra))
22089 (setq files (org-add-archive-files files)))
22090 (while (setq f (pop extra))
22091 (unless (member (file-truename f) tnames)
22092 (add-to-list 'files f 'append)
22093 (add-to-list 'tnames (file-truename f) 'append)))
22095 (mapcar (lambda (x)
22096 (with-current-buffer
22097 (or (get-file-buffer x) (find-file-noselect x))
22103 (if (boundp 'occur-mode-find-occurrence-hook)
22105 (add-hook 'occur-mode-find-occurrence-hook
22107 (when (derived-mode-p 'org-mode)
22110 (defadvice occur-mode-goto-occurrence
22111 (after org-occur-reveal activate)
22112 (and (derived-mode-p 'org-mode) (org-reveal)))
22113 (defadvice occur-mode-goto-occurrence-other-window
22114 (after org-occur-reveal activate)
22115 (and (derived-mode-p 'org-mode) (org-reveal)))
22116 (defadvice occur-mode-display-occurrence
22117 (after org-occur-reveal activate)
22118 (when (derived-mode-p 'org-mode)
22119 (let ((pos (occur-mode-find-occurrence)))
22120 (with-current-buffer (marker-buffer pos)
22125 (defun org-occur-link-in-agenda-files ()
22126 "Create a link and search for it in the agendas.
22127 The link is not stored in `org-stored-links', it is just created
22128 for the search purpose."
22130 (let ((link (condition-case nil
22131 (org-store-link nil)
22132 (error "Unable to create a link to here"))))
22133 (org-occur-in-agenda-files (regexp-quote link))))
22135 (defun org-reverse-string (string)
22136 "Return the reverse of STRING."
22137 (apply 'string (reverse (string-to-list string))))
22139 ;; defsubst org-uniquify must be defined before first use
22141 (defun org-uniquify-alist (alist)
22142 "Merge elements of ALIST with the same key.
22144 For example, in this alist:
22146 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
22147 => '((a 1 3) (b 2))
22149 merge (a 1) and (a 3) into (a 1 3).
22151 The function returns the new ALIST."
22156 (if (not (assoc (car e) rtn))
22158 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
22159 (setq rtn (assq-delete-all (car e) rtn))
22164 (defun org-delete-all (elts list)
22165 "Remove all elements in ELTS from LIST."
22167 (setq list (delete (pop elts) list)))
22170 (defun org-count (cl-item cl-seq)
22171 "Count the number of occurrences of ITEM in SEQ.
22172 Taken from `count' in cl-seq.el with all keyword arguments removed."
22173 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
22174 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
22175 (while (< cl-start cl-end)
22176 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
22177 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
22178 (setq cl-start (1+ cl-start)))
22181 (defun org-remove-if (predicate seq)
22182 "Remove everything from SEQ that fulfills PREDICATE."
22186 (if (not (funcall predicate e)) (push e res)))
22189 (defun org-remove-if-not (predicate seq)
22190 "Remove everything from SEQ that does not fulfill PREDICATE."
22194 (if (funcall predicate e) (push e res)))
22197 (defun org-reduce (cl-func cl-seq &rest cl-keys)
22198 "Reduce two-argument FUNCTION across SEQ.
22199 Taken from `reduce' in cl-seq.el with all keyword arguments but
22200 \":initial-value\" removed."
22201 (let ((cl-accum (cond ((memq :initial-value cl-keys)
22202 (cadr (memq :initial-value cl-keys)))
22203 (cl-seq (pop cl-seq))
22204 (t (funcall cl-func)))))
22206 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
22209 (defun org-every (pred seq)
22210 "Return true if PREDICATE is true of every element of SEQ.
22211 Adapted from `every' in cl.el."
22213 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
22216 (defun org-some (pred seq)
22217 "Return true if PREDICATE is true of any element of SEQ.
22218 Adapted from `some' in cl.el."
22220 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22223 (defun org-back-over-empty-lines ()
22224 "Move backwards over whitespace, to the beginning of the first empty line.
22225 Returns the number of empty lines passed."
22226 (let ((pos (point)))
22227 (if (cdr (assoc 'heading org-blank-before-new-entry))
22228 (skip-chars-backward " \t\n\r")
22230 (forward-line -1)))
22231 (beginning-of-line 2)
22232 (goto-char (min (point) pos))
22233 (count-lines (point) pos)))
22235 (defun org-skip-whitespace ()
22236 (skip-chars-forward " \t\n\r"))
22238 (defun org-point-in-group (point group &optional context)
22239 "Check if POINT is in match-group GROUP.
22240 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22241 match. If the match group does not exist or point is not inside it,
22243 (and (match-beginning group)
22244 (>= point (match-beginning group))
22245 (<= point (match-end group))
22247 (list context (match-beginning group) (match-end group))
22250 (defun org-switch-to-buffer-other-window (&rest args)
22251 "Switch to buffer in a second window on the current frame.
22252 In particular, do not allow pop-up frames.
22253 Returns the newly created buffer."
22255 (apply 'switch-to-buffer-other-window args)))
22257 (defun org-combine-plists (&rest plists)
22258 "Create a single property list from all plists in PLISTS.
22259 The process starts by copying the first list, and then setting properties
22260 from the other lists. Settings in the last list are the most significant
22261 ones and overrule settings in the other lists."
22262 (let ((rtn (copy-sequence (pop plists)))
22265 (setq ls (pop plists))
22267 (setq p (pop ls) v (pop ls))
22268 (setq rtn (plist-put rtn p v))))
22271 (defun org-replace-escapes (string table)
22272 "Replace %-escapes in STRING with values in TABLE.
22273 TABLE is an association list with keys like \"%a\" and string values.
22274 The sequences in STRING may contain normal field width and padding information,
22275 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22276 so values can contain further %-escapes if they are define later in TABLE."
22277 (let ((tbl (copy-alist table))
22278 (case-fold-search nil)
22281 (while (setq e (pop tbl))
22282 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22283 (when (and (cdr e) (string-match re (cdr e)))
22284 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22286 (add-text-properties 0 3 (list 'sref sref) safe)
22287 (setcdr e (replace-match safe t t (cdr e)))))
22288 (while (string-match re string)
22289 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22291 (setq string (replace-match rpl t t string))))
22292 (while (setq pchg (next-property-change pchg string))
22293 (let ((sref (get-text-property pchg 'sref string)))
22294 (when (and sref (string-match "SREF" string pchg))
22295 (setq string (replace-match sref t t string)))))
22298 (defun org-sublist (list start end)
22299 "Return a section of LIST, from START to END.
22300 Counting starts at 1."
22301 (let (rtn (c start))
22302 (setq list (nthcdr (1- start) list))
22303 (while (and list (<= c end))
22304 (push (pop list) rtn)
22308 (defun org-find-base-buffer-visiting (file)
22309 "Like `find-buffer-visiting' but always return the base buffer and
22310 not an indirect buffer."
22311 (let ((buf (or (get-file-buffer file)
22312 (find-buffer-visiting file))))
22314 (or (buffer-base-buffer buf) buf)
22317 (defun org-image-file-name-regexp (&optional extensions)
22318 "Return regexp matching the file names of images.
22319 If EXTENSIONS is given, only match these."
22320 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22321 (image-file-name-regexp)
22322 (let ((image-file-name-extensions
22324 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22325 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22327 (regexp-opt (nconc (mapcar 'upcase
22328 image-file-name-extensions)
22329 image-file-name-extensions)
22333 (defun org-file-image-p (file &optional extensions)
22334 "Return non-nil if FILE is an image."
22336 (string-match (org-image-file-name-regexp extensions) file)))
22338 (defun org-get-cursor-date (&optional with-time)
22339 "Return the date at cursor in as a time.
22340 This works in the calendar and in the agenda, anywhere else it just
22341 returns the current time.
22342 If WITH-TIME is non-nil, returns the time of the event at point (in
22343 the agenda) or the current time of the day."
22344 (let (date day defd tp tm hod mod)
22346 (setq tp (get-text-property (point) 'time))
22347 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22348 (setq hod (string-to-number (match-string 1 tp))
22349 mod (string-to-number (match-string 2 tp))))
22350 (or tp (setq hod (nth 2 (decode-time (current-time)))
22351 mod (nth 1 (decode-time (current-time))))))
22353 ((eq major-mode 'calendar-mode)
22354 (setq date (calendar-cursor-to-date)
22355 defd (encode-time 0 (or mod 0) (or hod 0)
22356 (nth 1 date) (nth 0 date) (nth 2 date))))
22357 ((eq major-mode 'org-agenda-mode)
22358 (setq day (get-text-property (point) 'day))
22360 (setq date (calendar-gregorian-from-absolute day)
22361 defd (encode-time 0 (or mod 0) (or hod 0)
22362 (nth 1 date) (nth 0 date) (nth 2 date))))))
22363 (or defd (current-time))))
22365 (defun org-mark-subtree (&optional up)
22366 "Mark the current subtree.
22367 This puts point at the start of the current subtree, and mark at
22368 the end. If a numeric prefix UP is given, move up into the
22369 hierarchy of headlines by UP levels before marking the subtree."
22371 (org-with-limited-levels
22372 (cond ((org-at-heading-p) (beginning-of-line))
22373 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22374 (t (outline-previous-visible-heading 1))))
22375 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22376 (if (org-called-interactively-p 'any)
22377 (call-interactively 'org-mark-element)
22378 (org-mark-element)))
22383 (defun org--get-expected-indentation (element contentsp)
22384 "Expected indentation column for current line, according to ELEMENT.
22385 ELEMENT is an element containing point. CONTENTSP is non-nil
22386 when indentation is to be computed according to contents of
22388 (let ((type (org-element-type element))
22389 (start (org-element-property :begin element)))
22390 (org-with-wide-buffer
22394 (footnote-definition 0)
22395 ((headline inlinetask nil)
22396 (if (not org-adapt-indentation) 0
22397 (let ((level (org-current-level)))
22398 (if level (1+ level) 0))))
22400 (org-list-item-body-column
22401 (org-element-property :post-affiliated element)))
22404 (org-get-indentation))))
22405 ((memq type '(headline inlinetask nil))
22406 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
22407 (org--get-expected-indentation element t)
22409 ((eq type 'footnote-definition) 0)
22410 ;; First paragraph of a footnote definition or an item.
22411 ;; Indent like parent.
22412 ((< (line-beginning-position) start)
22413 (org--get-expected-indentation
22414 (org-element-property :parent element) t))
22415 ;; At first line: indent according to previous sibling, if any,
22416 ;; ignoring footnote definitions and inline tasks, or parent's
22418 ((= (line-beginning-position) start)
22421 (if (= (point-min) start) (throw 'exit 0)
22422 (goto-char (1- start))
22423 (let ((previous (org-element-at-point)))
22424 (while (let ((parent (org-element-property :parent previous)))
22426 (setq previous parent)
22427 (<= (org-element-property :end parent) start))))
22428 (cond ((or (not previous)
22429 (> (org-element-property :end previous) start))
22430 (throw 'exit (org--get-expected-indentation previous t)))
22431 ((memq (org-element-type previous)
22432 '(footnote-definition inlinetask))
22433 (setq start (org-element-property :begin previous)))
22434 (t (goto-char (org-element-property :begin previous))
22435 (throw 'exit (org-get-indentation)))))))))
22436 ;; Otherwise, move to the first non-blank line above.
22438 (beginning-of-line)
22439 (let ((pos (point)))
22440 (skip-chars-backward " \r\t\n")
22442 ;; Two blank lines end a footnote definition or a plain
22443 ;; list. When we indent an empty line after them, the
22444 ;; containing list or footnote definition is over, so it
22445 ;; qualifies as a previous sibling. Therefore, we indent
22446 ;; like its first line.
22447 ((and (memq type '(footnote-definition plain-list))
22448 (> (count-lines (point) pos) 2))
22450 (org-get-indentation))
22451 ;; Line above is the first one of a paragraph at the
22452 ;; beginning of an item or a footnote definition. Indent
22454 ((< (line-beginning-position) start)
22455 (org--get-expected-indentation
22456 (org-element-property :parent element) t))
22457 ;; POS is after contents in a greater element. Indent like
22458 ;; the beginning of the element.
22460 ;; As a special case, if point is at the end of a footnote
22461 ;; definition or an item, indent like the very last element
22463 ((let ((cend (org-element-property :contents-end element)))
22464 (and cend (<= cend pos)))
22465 (if (memq type '(footnote-definition item plain-list))
22466 (org--get-expected-indentation (org-element-at-point) nil)
22468 (org-get-indentation)))
22469 ;; In any other case, indent like the current line.
22470 (t (org-get-indentation)))))))))
22472 (defun org--align-node-property ()
22473 "Align node property at point.
22474 Alignment is done according to `org-property-format', which see."
22475 (when (save-excursion
22476 (beginning-of-line)
22477 (looking-at org-property-re))
22479 (concat (match-string 4)
22481 (format org-property-format (match-string 1) (match-string 3))))
22484 (defun org-indent-line ()
22485 "Indent line depending on context.
22487 Indentation is done according to the following rules:
22489 - Footnote definitions, headlines and inline tasks have to
22492 - On the very first line of an element, consider, in order, the
22493 next rules until one matches:
22495 1. If there's a sibling element before, ignoring footnote
22496 definitions and inline tasks, indent like its first line.
22498 2. If element has a parent, indent like its contents. More
22499 precisely, if parent is an item, indent after the
22500 description part, if any, or the bullet (see
22501 ``org-list-description-max-indent'). Else, indent like
22502 parent's first line.
22504 3. Otherwise, indent relatively to current level, if
22505 `org-adapt-indentation' is non-nil, or to left margin.
22507 - On a blank line at the end of a plain list, an item, or
22508 a footnote definition, indent like the very last element
22511 - In the code part of a source block, use language major mode
22512 to indent current line if `org-src-tab-acts-natively' is
22513 non-nil. If it is nil, do nothing.
22515 - Otherwise, indent like the first non-blank line above.
22517 The function doesn't indent an item as it could break the whole
22518 list structure. Instead, use \\<org-mode-map>\\[org-shiftmetaleft] or \
22519 \\[org-shiftmetaright].
22521 Also align node properties according to `org-property-format'."
22525 (let ((indent-line-function
22526 (cadadr (assq 'indent-line-function org-fb-vars))))
22527 (indent-according-to-mode)))
22528 ((org-at-heading-p) 'noindent)
22530 (let* ((element (save-excursion (beginning-of-line) (org-element-at-point)))
22531 (type (org-element-type element)))
22532 (cond ((and (memq type '(plain-list item))
22533 (= (line-beginning-position)
22534 (org-element-property :post-affiliated element)))
22536 ((and (eq type 'src-block)
22537 org-src-tab-acts-natively
22538 (> (line-beginning-position)
22539 (org-element-property :post-affiliated element))
22540 (< (line-beginning-position)
22541 (org-with-wide-buffer
22542 (goto-char (org-element-property :end element))
22543 (skip-chars-backward " \r\t\n")
22544 (line-beginning-position))))
22545 (let ((org-src-strip-leading-and-trailing-blank-lines nil))
22546 (org-babel-do-key-sequence-in-edit-buffer (kbd "TAB"))))
22548 (let ((column (org--get-expected-indentation element nil)))
22549 ;; Preserve current column.
22550 (if (<= (current-column) (current-indentation))
22551 (org-indent-line-to column)
22552 (save-excursion (org-indent-line-to column))))
22553 ;; Align node property. Also preserve current column.
22554 (when (eq type 'node-property)
22555 (let ((column (current-column)))
22556 (org--align-node-property)
22557 (org-move-to-column column)))))))))
22559 (defun org-indent-region (start end)
22560 "Indent each non-blank line in the region.
22561 Called from a program, START and END specify the region to
22562 indent. The function will not indent contents of example blocks,
22563 verse blocks and export blocks as leading white spaces are
22564 assumed to be significant there."
22568 (beginning-of-line)
22571 ;; Set IND as indentation for all lines between point and
22572 ;; POS or END, whichever comes first. Blank lines are
22573 ;; ignored. Leave point after POS once done.
22574 (let ((limit (copy-marker (min end pos))))
22575 (while (< (point) limit)
22576 (unless (org-looking-at-p "[ \t]*$") (org-indent-line-to ind))
22578 (set-marker limit nil))))
22579 (end (copy-marker end)))
22580 (while (< (point) end)
22581 (if (or (org-looking-at-p " \r\t\n") (org-at-heading-p)) (forward-line)
22582 (let* ((element (org-element-at-point))
22583 (type (org-element-type element))
22584 (element-end (copy-marker (org-element-property :end element)))
22585 (ind (org--get-expected-indentation element nil)))
22586 (if (or (memq type '(paragraph table table-row))
22587 (not (or (org-element-property :contents-begin element)
22589 '(example-block export-block src-block)))))
22590 ;; Elements here are indented as a single block. Also
22591 ;; align node properties.
22593 (when (eq type 'node-property)
22594 (org--align-node-property)
22595 (beginning-of-line))
22596 (funcall indent-to ind element-end))
22597 ;; Elements in this category consist of three parts:
22598 ;; before the contents, the contents, and after the
22599 ;; contents. The contents are treated specially,
22600 ;; according to the element type, or not indented at
22601 ;; all. Other parts are indented as a single block.
22602 (let* ((post (copy-marker
22603 (org-element-property :post-affiliated element)))
22607 ((not (org-element-property :contents-begin element))
22608 ;; Fake contents for source blocks.
22609 (org-with-wide-buffer
22613 ((memq type '(footnote-definition item plain-list))
22614 ;; Contents in these elements could start on
22615 ;; the same line as the beginning of the
22616 ;; element. Make sure we start indenting
22617 ;; from the second line.
22618 (org-with-wide-buffer
22622 (t (org-element-property :contents-begin element)))))
22624 (or (org-element-property :contents-end element)
22625 ;; Fake contents for source blocks.
22626 (org-with-wide-buffer
22627 (goto-char element-end)
22628 (skip-chars-backward " \r\t\n")
22629 (line-beginning-position))))))
22630 (funcall indent-to ind cbeg)
22631 (when (< (point) end)
22633 ((example-block export-block verse-block))
22635 ;; In a source block, indent source code according
22636 ;; to language major mode, but only if
22637 ;; `org-src-tab-acts-natively' is non-nil.
22638 (when (and (< (point) end) org-src-tab-acts-natively)
22640 (let (org-src-strip-leading-and-trailing-blank-lines
22641 ;; Region boundaries in edit buffer.
22642 (start (1+ (- (point) cbeg)))
22643 (end (- (min cend end) cbeg)))
22644 (org-babel-do-in-edit-buffer
22645 (indent-region start end))))))
22646 (t (org-indent-region (point) (min cend end))))
22647 (goto-char (min cend end))
22648 (when (< (point) end) (funcall indent-to ind element-end)))
22649 (set-marker post nil)
22650 (set-marker cbeg nil)
22651 (set-marker cend nil)))
22652 (set-marker element-end nil))))
22653 (set-marker end nil))))
22655 (defun org-indent-drawer ()
22656 "Indent the drawer at point."
22658 (unless (save-excursion
22659 (beginning-of-line)
22660 (org-looking-at-p org-drawer-regexp))
22661 (user-error "Not at a drawer"))
22662 (let ((element (org-element-at-point)))
22663 (unless (memq (org-element-type element) '(drawer property-drawer))
22664 (user-error "Not at a drawer"))
22665 (org-with-wide-buffer
22666 (org-indent-region (org-element-property :begin element)
22667 (org-element-property :end element))))
22668 (message "Drawer at point indented"))
22670 (defun org-indent-block ()
22671 "Indent the block at point."
22673 (unless (save-excursion
22674 (beginning-of-line)
22675 (let ((case-fold-search t))
22676 (org-looking-at-p "[ \t]*#\\+\\(begin\\|end\\)_")))
22677 (user-error "Not at a block"))
22678 (let ((element (org-element-at-point)))
22679 (unless (memq (org-element-type element)
22680 '(comment-block center-block dynamic-block example-block
22681 export-block quote-block special-block
22682 src-block verse-block))
22683 (user-error "Not at a block"))
22684 (org-with-wide-buffer
22685 (org-indent-region (org-element-property :begin element)
22686 (org-element-property :end element))))
22687 (message "Block at point indented"))
22692 ;; We use our own fill-paragraph and auto-fill functions.
22694 ;; `org-fill-paragraph' relies on adaptive filling and context
22695 ;; checking. Appropriate `fill-prefix' is computed with
22696 ;; `org-adaptive-fill-function'.
22698 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22699 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22700 ;; `org-adaptive-fill-function' value. Internally,
22701 ;; `org-comment-line-break-function' breaks the line.
22703 ;; `org-setup-filling' installs filling and auto-filling related
22704 ;; variables during `org-mode' initialization.
22706 (defvar org-element-paragraph-separate) ; org-element.el
22707 (defun org-setup-filling ()
22708 (require 'org-element)
22709 ;; Prevent auto-fill from inserting unwanted new items.
22710 (when (boundp 'fill-nobreak-predicate)
22712 'fill-nobreak-predicate
22714 (append fill-nobreak-predicate
22715 '(org-fill-line-break-nobreak-p
22716 org-fill-paragraph-with-timestamp-nobreak-p)))))
22717 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22718 (org-set-local 'paragraph-start paragraph-ending)
22719 (org-set-local 'paragraph-separate paragraph-ending))
22720 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22721 (org-set-local 'auto-fill-inhibit-regexp nil)
22722 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22723 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22724 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22726 (defun org-fill-line-break-nobreak-p ()
22727 "Non-nil when a new line at point would create an Org line break."
22729 (skip-chars-backward "[ \t]")
22730 (skip-chars-backward "\\\\")
22731 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22733 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22734 "Non-nil when a new line at point would split a timestamp."
22735 (and (org-at-timestamp-p t)
22736 (not (looking-at org-ts-regexp-both))))
22738 (declare-function message-in-body-p "message" ())
22739 (defvar orgtbl-line-start-regexp) ; From org-table.el
22740 (defun org-adaptive-fill-function ()
22741 "Compute a fill prefix for the current line.
22742 Return fill prefix, as a string, or nil if current line isn't
22743 meant to be filled. For convenience, if `adaptive-fill-regexp'
22744 matches in paragraphs or comments, use it."
22746 (when (derived-mode-p 'message-mode)
22748 (beginning-of-line)
22749 (cond ((or (not (message-in-body-p))
22750 (looking-at orgtbl-line-start-regexp))
22752 ((looking-at message-cite-prefix-regexp)
22753 (throw 'exit (match-string-no-properties 0)))
22754 ((looking-at org-outline-regexp)
22755 (throw 'exit (make-string (length (match-string 0)) ?\s))))))
22756 (org-with-wide-buffer
22757 (unless (org-at-heading-p)
22758 (let* ((p (line-beginning-position))
22759 (element (save-excursion
22760 (beginning-of-line)
22761 (org-element-at-point)))
22762 (type (org-element-type element))
22763 (post-affiliated (org-element-property :post-affiliated element)))
22764 (unless (< p post-affiliated)
22768 (beginning-of-line)
22769 (looking-at "[ \t]*")
22770 (concat (match-string 0) "# ")))
22771 (footnote-definition "")
22773 (make-string (org-list-item-body-column post-affiliated) ?\s))
22775 ;; Fill prefix is usually the same as the current line,
22776 ;; unless the paragraph is at the beginning of an item.
22777 (let ((parent (org-element-property :parent element)))
22779 (beginning-of-line)
22780 (cond ((eq (org-element-type parent) 'item)
22781 (make-string (org-list-item-body-column
22782 (org-element-property :begin parent))
22784 ((and adaptive-fill-regexp
22786 ;; `adaptive-fill-function' to let
22787 ;; `fill-context-prefix' handle
22788 ;; `adaptive-fill-regexp' variable.
22789 (let (adaptive-fill-function)
22790 (fill-context-prefix
22792 (org-element-property :end element)))))
22793 ((looking-at "[ \t]+") (match-string 0))
22796 ;; Only fill contents if P is within block boundaries.
22797 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22800 (cend (save-excursion
22801 (goto-char (org-element-property :end element))
22802 (skip-chars-backward " \r\t\n")
22803 (line-beginning-position))))
22804 (when (and (>= p cbeg) (< p cend))
22805 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22809 (declare-function message-goto-body "message" ())
22810 (defvar message-cite-prefix-regexp) ; From message.el
22811 (defun org-fill-paragraph (&optional justify)
22812 "Fill element at point, when applicable.
22814 This function only applies to comment blocks, comments, example
22815 blocks and paragraphs. Also, as a special case, re-align table
22816 when point is at one.
22818 If JUSTIFY is non-nil (interactively, with prefix argument),
22819 justify as well. If `sentence-end-double-space' is non-nil, then
22820 period followed by one space does not end a sentence, so don't
22821 break a line there. The variable `fill-column' controls the
22824 For convenience, when point is at a plain list, an item or
22825 a footnote definition, try to fill the first paragraph within."
22827 (if (and (derived-mode-p 'message-mode)
22828 (or (not (message-in-body-p))
22829 (save-excursion (move-beginning-of-line 1)
22830 (looking-at message-cite-prefix-regexp))))
22831 ;; First ensure filling is correct in message-mode.
22832 (let ((fill-paragraph-function
22833 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22834 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22835 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22836 (paragraph-separate
22837 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22838 (fill-paragraph nil))
22839 (with-syntax-table org-mode-transpose-word-syntax-table
22840 ;; Move to end of line in order to get the first paragraph
22841 ;; within a plain list or a footnote definition.
22842 (let ((element (save-excursion
22844 (or (ignore-errors (org-element-at-point))
22845 (user-error "An element cannot be parsed line %d"
22846 (line-number-at-pos (point)))))))
22847 ;; First check if point is in a blank line at the beginning of
22848 ;; the buffer. In that case, ignore filling.
22849 (case (org-element-type element)
22850 ;; Use major mode filling function is src blocks.
22851 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22852 ;; Align Org tables, leave table.el tables as-is.
22853 (table-row (org-table-align) t)
22855 (when (eq (org-element-property :type element) 'org)
22857 (goto-char (org-element-property :post-affiliated element))
22858 (org-table-align)))
22861 ;; Paragraphs may contain `line-break' type objects.
22862 (let ((beg (max (point-min)
22863 (org-element-property :contents-begin element)))
22864 (end (min (point-max)
22865 (org-element-property :contents-end element))))
22866 ;; Do nothing if point is at an affiliated keyword.
22867 (if (< (line-end-position) beg) t
22868 (when (derived-mode-p 'message-mode)
22869 ;; In `message-mode', do not fill following citation
22870 ;; in current paragraph nor text before message body.
22871 (let ((body-start (save-excursion (message-goto-body))))
22872 (when body-start (setq beg (max body-start beg))))
22873 (when (save-excursion
22875 (concat "^" message-cite-prefix-regexp) end t))
22876 (setq end (match-beginning 0))))
22877 ;; Fill paragraph, taking line breaks into account.
22880 (let ((cuts (list beg)))
22881 (while (re-search-forward "\\\\\\\\[ \t]*\n" end t)
22882 (when (eq 'line-break
22884 (save-excursion (backward-char)
22885 (org-element-context))))
22886 (push (point) cuts)))
22887 (dolist (c (delq end cuts))
22888 (fill-region-as-paragraph c end justify)
22891 ;; Contents of `comment-block' type elements should be
22892 ;; filled as plain text, but only if point is within block
22895 (let* ((case-fold-search t)
22896 (beg (save-excursion
22897 (goto-char (org-element-property :begin element))
22898 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22901 (end (save-excursion
22902 (goto-char (org-element-property :end element))
22903 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22904 (line-beginning-position))))
22905 (if (or (< (point) beg) (> (point) end)) t
22906 (fill-region-as-paragraph
22907 (save-excursion (end-of-line)
22908 (re-search-backward "^[ \t]*$" beg 'move)
22909 (line-beginning-position))
22910 (save-excursion (beginning-of-line)
22911 (re-search-forward "^[ \t]*$" end 'move)
22912 (line-beginning-position))
22916 (let ((begin (org-element-property :post-affiliated element))
22917 (end (org-element-property :end element)))
22918 (when (and (>= (point) begin) (<= (point) end))
22919 (let ((begin (save-excursion
22921 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22922 (progn (forward-line) (point))
22924 (end (save-excursion
22926 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22927 (1- (line-beginning-position))
22928 (skip-chars-backward " \r\t\n")
22929 (line-end-position)))))
22930 ;; Do not fill comments when at a blank line.
22931 (when (> end begin)
22934 (beginning-of-line)
22935 (looking-at "[ \t]*#")
22936 (let ((comment-prefix (match-string 0)))
22937 (goto-char (match-end 0))
22938 (if (looking-at adaptive-fill-regexp)
22939 (concat comment-prefix (match-string 0))
22940 (concat comment-prefix " "))))))
22942 (fill-region-as-paragraph begin end justify))))))
22944 ;; Ignore every other element.
22947 (defun org-auto-fill-function ()
22948 "Auto-fill function."
22949 ;; Check if auto-filling is meaningful.
22950 (let ((fc (current-fill-column)))
22951 (when (and fc (> (current-column) fc))
22952 (let* ((fill-prefix (org-adaptive-fill-function))
22953 ;; Enforce empty fill prefix, if required. Otherwise, it
22954 ;; will be computed again.
22955 (adaptive-fill-mode (not (equal fill-prefix ""))))
22956 (when fill-prefix (do-auto-fill))))))
22958 (defun org-comment-line-break-function (&optional soft)
22959 "Break line at point and indent, continuing comment if within one.
22960 The inserted newline is marked hard if variable
22961 `use-hard-newlines' is true, unless optional argument SOFT is
22963 (if soft (insert-and-inherit ?\n) (newline 1))
22964 (save-excursion (forward-char -1) (delete-horizontal-space))
22965 (delete-horizontal-space)
22966 (indent-to-left-margin)
22967 (insert-before-markers-and-inherit fill-prefix))
22970 ;;; Fixed Width Areas
22972 (defun org-toggle-fixed-width ()
22973 "Toggle fixed-width markup.
22975 Add or remove fixed-width markup on current line, whenever it
22976 makes sense. Return an error otherwise.
22978 If a region is active and if it contains only fixed-width areas
22979 or blank lines, remove all fixed-width markup in it. If the
22980 region contains anything else, convert all non-fixed-width lines
22981 to fixed-width ones.
22983 Blank lines at the end of the region are ignored unless the
22984 region only contains such lines."
22986 (if (not (org-region-active-p))
22989 ;; Remove fixed width marker only in a fixed-with element.
22991 ;; Add fixed width maker in paragraphs, in blank lines after
22992 ;; elements or at the beginning of a headline or an inlinetask,
22993 ;; and before any one-line elements (e.g., a clock).
22995 (beginning-of-line)
22996 (let* ((element (org-element-at-point))
22997 (type (org-element-type element)))
22999 ((and (eq type 'fixed-width)
23000 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
23002 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
23003 ((and (memq type '(babel-call clock comment diary-sexp headline
23004 horizontal-rule keyword paragraph
23006 (<= (org-element-property :post-affiliated element) (point)))
23007 (skip-chars-forward " \t")
23009 ((and (org-looking-at-p "[ \t]*$")
23010 (or (eq type 'inlinetask)
23012 (skip-chars-forward " \r\t\n")
23013 (<= (org-element-property :end element) (point)))))
23014 (delete-region (point) (line-end-position))
23017 (t (user-error "Cannot insert a fixed-width line here")))))
23019 (let* ((begin (save-excursion
23020 (goto-char (region-beginning))
23021 (line-beginning-position)))
23024 (goto-char (region-end))
23025 (unless (eolp) (beginning-of-line))
23026 (if (save-excursion (re-search-backward "\\S-" begin t))
23027 (progn (skip-chars-backward " \r\t\n") (point))
23033 (skip-chars-forward " \r\t\n")
23034 (when (eobp) (throw 'not-all-p nil))
23035 (while (< (point) end)
23036 (let ((element (org-element-at-point)))
23037 (if (eq (org-element-type element) 'fixed-width)
23038 (goto-char (org-element-property :end element))
23039 (throw 'not-all-p nil))))
23041 (if all-fixed-width-p
23044 (while (< (point) end)
23045 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
23048 (if (= (line-end-position) (match-end 0)) 0 1)))
23050 (let ((min-ind (point-max)))
23051 ;; Find minimum indentation across all lines.
23054 (if (not (save-excursion (re-search-forward "\\S-" end t)))
23057 (while (< (point) end)
23058 (unless (org-looking-at-p "[ \t]*$")
23059 (let ((ind (org-get-indentation)))
23060 (setq min-ind (min min-ind ind))
23061 (when (zerop ind) (throw 'zerop t))))
23063 ;; Loop over all lines and add fixed-width markup everywhere
23064 ;; but in fixed-width lines.
23067 (while (< (point) end)
23069 ((org-at-heading-p)
23072 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
23075 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
23076 (let* ((element (org-element-at-point))
23077 (element-end (org-element-property :end element)))
23078 (if (eq (org-element-type element) 'fixed-width)
23079 (progn (goto-char element-end)
23080 (skip-chars-backward " \r\t\n")
23082 (let ((limit (min end element-end)))
23083 (while (< (point) limit)
23084 (org-move-to-column min-ind t)
23086 (forward-line))))))
23088 (org-move-to-column min-ind t)
23090 (forward-line)))))))
23091 (set-marker end nil))))
23096 ;; Org comments syntax is quite complex. It requires the entire line
23097 ;; to be just a comment. Also, even with the right syntax at the
23098 ;; beginning of line, some some elements (i.e. verse-block or
23099 ;; example-block) don't accept comments. Usual Emacs comment commands
23100 ;; cannot cope with those requirements. Therefore, Org replaces them.
23102 ;; Org still relies on `comment-dwim', but cannot trust
23103 ;; `comment-only-p'. So, `comment-region-function' and
23104 ;; `uncomment-region-function' both point
23105 ;; to`org-comment-or-uncomment-region'. Eventually,
23106 ;; `org-insert-comment' takes care of insertion of comments at the
23107 ;; beginning of line.
23109 ;; `org-setup-comments-handling' install comments related variables
23110 ;; during `org-mode' initialization.
23112 (defun org-setup-comments-handling ()
23114 (org-set-local 'comment-use-syntax nil)
23115 (org-set-local 'comment-start "# ")
23116 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
23117 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
23118 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
23119 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
23121 (defun org-insert-comment ()
23122 "Insert an empty comment above current line.
23123 If the line is empty, insert comment at its beginning. When
23124 point is within a source block, comment according to the related
23126 (if (let ((element (org-element-at-point)))
23127 (and (eq (org-element-type element) 'src-block)
23129 (goto-char (org-element-property :post-affiliated element))
23130 (line-end-position))
23133 (goto-char (org-element-property :end element))
23134 (skip-chars-backward " \r\t\n")
23135 (line-beginning-position))
23137 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23138 (beginning-of-line)
23139 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
23144 (defvar comment-empty-lines) ; From newcomment.el.
23145 (defun org-comment-or-uncomment-region (beg end &rest ignore)
23146 "Comment or uncomment each non-blank line in the region.
23147 Uncomment each non-blank line between BEG and END if it only
23148 contains commented lines. Otherwise, comment them. If region is
23149 strictly within a source block, use appropriate comment syntax."
23150 (if (let ((element (org-element-at-point)))
23151 (and (eq (org-element-type element) 'src-block)
23153 (goto-char (org-element-property :post-affiliated element))
23154 (line-end-position))
23156 (>= (save-excursion
23157 (goto-char (org-element-property :end element))
23158 (skip-chars-backward " \r\t\n")
23159 (line-beginning-position))
23161 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23164 (narrow-to-region (save-excursion (goto-char beg)
23165 (skip-chars-forward " \r\t\n" end)
23166 (line-beginning-position))
23167 (save-excursion (goto-char end)
23168 (skip-chars-backward " \r\t\n" beg)
23169 (line-end-position)))
23171 ;; UNCOMMENTP is non-nil when every non blank line between
23172 ;; BEG and END is a comment.
23174 (goto-char (point-min))
23175 (while (and (not (eobp))
23176 (let ((element (org-element-at-point)))
23177 (and (eq (org-element-type element) 'comment)
23178 (goto-char (min (point-max)
23179 (org-element-property
23180 :end element)))))))
23183 ;; Only blank lines and comments in region: uncomment it.
23185 (goto-char (point-min))
23186 (while (not (eobp))
23187 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
23188 (replace-match "" nil nil nil 1))
23190 ;; Comment each line in region.
23191 (let ((min-indent (point-max)))
23192 ;; First find the minimum indentation across all lines.
23194 (goto-char (point-min))
23195 (while (and (not (eobp)) (not (zerop min-indent)))
23196 (unless (looking-at "[ \t]*$")
23197 (setq min-indent (min min-indent (current-indentation))))
23199 ;; Then loop over all lines.
23201 (goto-char (point-min))
23202 (while (not (eobp))
23203 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
23204 ;; Don't get fooled by invisible text (e.g. link path)
23205 ;; when moving to column MIN-INDENT.
23206 (let ((buffer-invisibility-spec nil))
23207 (org-move-to-column min-indent t))
23208 (insert comment-start))
23209 (forward-line)))))))))
23211 (defun org-comment-dwim (arg)
23212 "Call `comment-dwim' within a source edit buffer if needed."
23214 (if (org-in-src-block-p)
23215 (org-babel-do-in-edit-buffer (call-interactively 'comment-dwim))
23216 (call-interactively 'comment-dwim)))
23221 ;; This section contains tools to operate on timestamp objects, as
23222 ;; returned by, e.g. `org-element-context'.
23224 (defun org-timestamp-has-time-p (timestamp)
23225 "Non-nil when TIMESTAMP has a time specified."
23226 (org-element-property :hour-start timestamp))
23228 (defun org-timestamp-format (timestamp format &optional end utc)
23229 "Format a TIMESTAMP element into a string.
23231 FORMAT is a format specifier to be passed to
23232 `format-time-string'.
23234 When optional argument END is non-nil, use end of date-range or
23235 time-range, if possible.
23237 When optional argument UTC is non-nil, time will be expressed as
23239 (format-time-string
23241 (apply 'encode-time
23244 (lambda (prop) (or (org-element-property prop timestamp) 0))
23245 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
23246 '(:minute-start :hour-start :day-start :month-start
23250 (defun org-timestamp-split-range (timestamp &optional end)
23251 "Extract a timestamp object from a date or time range.
23253 TIMESTAMP is a timestamp object. END, when non-nil, means extract
23254 the end of the range. Otherwise, extract its start.
23256 Return a new timestamp object sharing the same parent as
23258 (let ((type (org-element-property :type timestamp)))
23259 (if (memq type '(active inactive diary)) timestamp
23260 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
23262 (org-element-put-property
23263 split-ts :type (if (eq type 'active-range) 'active 'inactive))
23264 ;; Copy start properties over end properties if END is
23265 ;; non-nil. Otherwise, copy end properties over `start' ones.
23266 (let ((p-alist '((:minute-start . :minute-end)
23267 (:hour-start . :hour-end)
23268 (:day-start . :day-end)
23269 (:month-start . :month-end)
23270 (:year-start . :year-end))))
23271 (dolist (p-cell p-alist)
23272 (org-element-put-property
23274 (funcall (if end 'car 'cdr) p-cell)
23275 (org-element-property
23276 (funcall (if end 'cdr 'car) p-cell) split-ts)))
23277 ;; Eventually refresh `:raw-value'.
23278 (org-element-put-property split-ts :raw-value nil)
23279 (org-element-put-property
23280 split-ts :raw-value (org-element-interpret-data split-ts)))))))
23282 (defun org-timestamp-translate (timestamp &optional boundary)
23283 "Apply `org-translate-time' on a TIMESTAMP object.
23284 When optional argument BOUNDARY is non-nil, it is either the
23285 symbol `start' or `end'. In this case, only translate the
23286 starting or ending part of TIMESTAMP if it is a date or time
23287 range. Otherwise, translate both parts."
23288 (if (and (not boundary)
23289 (memq (org-element-property :type timestamp)
23290 '(active-range inactive-range)))
23292 (org-translate-time
23293 (org-element-property :raw-value
23294 (org-timestamp-split-range timestamp)))
23296 (org-translate-time
23297 (org-element-property :raw-value
23298 (org-timestamp-split-range timestamp t))))
23299 (org-translate-time
23300 (org-element-property
23302 (if (not boundary) timestamp
23303 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
23309 (defun org-reftex-citation ()
23310 "Use reftex-citation to insert a citation into the buffer.
23311 This looks for a line like
23313 #+BIBLIOGRAPHY: foo plain option:-d
23315 and derives from it that foo.bib is the bibliography file relevant
23316 for this document. It then installs the necessary environment for RefTeX
23317 to work in this buffer and calls `reftex-citation' to insert a citation
23320 Export of such citations to both LaTeX and HTML is handled by the contributed
23321 package ox-bibtex by Taru Karttunen."
23323 (let ((reftex-docstruct-symbol 'rds)
23324 (reftex-cite-format "\\cite{%l}")
23329 (let ((case-fold-search t)
23330 (re "^[ \t]*#\\+BIBLIOGRAPHY:[ \t]+\\([^ \t\n]+\\)"))
23331 (if (not (save-excursion
23332 (or (re-search-forward re nil t)
23333 (re-search-backward re nil t))))
23334 (user-error "No bibliography defined in file")
23335 (setq bib (concat (match-string 1) ".bib")
23336 rds (list (list 'bib bib)))))))
23337 (call-interactively 'reftex-citation)))
23339 ;;;; Functions extending outline functionality
23341 (defun org-beginning-of-line (&optional arg)
23342 "Go to the beginning of the current line. If that is invisible, continue
23343 to a visible line beginning. This makes the function of C-a more intuitive.
23344 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
23345 first attempt, and only move to after the tags when the cursor is already
23346 beyond the end of the headline."
23348 (let ((pos (point))
23349 (special (if (consp org-special-ctrl-a/e)
23350 (car org-special-ctrl-a/e)
23351 org-special-ctrl-a/e))
23352 deactivate-mark refpos)
23353 (if (org-bound-and-true-p visual-line-mode)
23354 (beginning-of-visual-line 1)
23355 (beginning-of-line 1))
23356 (if (and arg (fboundp 'move-beginning-of-line))
23357 (call-interactively 'move-beginning-of-line)
23361 (if (org-truely-invisible-p)
23362 (while (and (not (bobp)) (org-truely-invisible-p))
23364 (beginning-of-line 1))
23365 (forward-char 1))))
23368 ((and (looking-at org-complex-heading-regexp)
23369 (= (char-after (match-end 1)) ?\ ))
23370 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23374 (cond ((> pos refpos) refpos)
23375 ((= pos (point)) refpos)
23377 (cond ((> pos (point)) (point))
23378 ((not (eq last-command this-command)) (point))
23381 ;; Being at an item and not looking at an the item means point
23382 ;; was previously moved to beginning of a visual line, which
23383 ;; doesn't contain the item. Therefore, do nothing special,
23385 (when (looking-at org-list-full-item-re)
23386 ;; Set special position at first white space character after
23387 ;; bullet, and check-box, if any.
23388 (let ((after-bullet
23389 (let ((box (match-end 3)))
23390 (if (not box) (match-end 1)
23391 (let ((after (char-after box)))
23392 (if (and after (= after ? )) (1+ box) box))))))
23393 ;; Special case: Move point to special position when
23394 ;; currently after it or at beginning of line.
23396 (when (or (> pos after-bullet) (= (point) pos))
23397 (goto-char after-bullet))
23398 ;; Reversed case: Move point to special position when
23399 ;; point was already at beginning of line and command is
23401 (when (and (= (point) pos) (eq last-command this-command))
23402 (goto-char after-bullet))))))))
23404 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23405 (setq disable-point-adjustment
23406 (or (not (invisible-p (point)))
23407 (not (invisible-p (max (point-min) (1- (point))))))))
23409 (defun org-end-of-line (&optional arg)
23410 "Go to the end of the line.
23411 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23412 tags on the first attempt, and only move to after the tags when
23413 the cursor is already beyond the end of the headline."
23415 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23416 org-special-ctrl-a/e))
23417 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23418 'end-of-visual-line)
23419 ((fboundp 'move-end-of-line) 'move-end-of-line)
23422 (if (or (not special) arg) (call-interactively move-fun)
23423 (let* ((element (save-excursion (beginning-of-line)
23424 (org-element-at-point)))
23425 (type (org-element-type element)))
23427 ((memq type '(headline inlinetask))
23428 (let ((pos (point)))
23429 (beginning-of-line 1)
23430 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23432 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23433 (goto-char (match-beginning 1))
23434 (goto-char (match-end 0)))
23435 (if (or (< pos (match-end 0))
23436 (not (eq this-command last-command)))
23437 (goto-char (match-end 0))
23438 (goto-char (match-beginning 1))))
23439 (call-interactively move-fun))))
23440 ((outline-invisible-p (line-end-position))
23441 ;; If element is hidden, `move-end-of-line' would put point
23442 ;; after it. Use `end-of-line' to stay on current line.
23443 (call-interactively 'end-of-line))
23444 (t (call-interactively move-fun)))))
23445 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23446 (setq disable-point-adjustment
23447 (or (not (invisible-p (point)))
23448 (not (invisible-p (max (point-min) (1- (point))))))))
23450 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23451 (define-key org-mode-map "\C-e" 'org-end-of-line)
23453 (defun org-backward-sentence (&optional arg)
23454 "Go to beginning of sentence, or beginning of table field.
23455 This will call `backward-sentence' or `org-table-beginning-of-field',
23456 depending on context."
23459 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23460 (t (call-interactively 'backward-sentence))))
23462 (defun org-forward-sentence (&optional arg)
23463 "Go to end of sentence, or end of table field.
23464 This will call `forward-sentence' or `org-table-end-of-field',
23465 depending on context."
23468 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23469 (t (call-interactively 'forward-sentence))))
23471 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23472 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23474 (defun org-kill-line (&optional arg)
23475 "Kill line, to tags or end of line."
23478 ((or (not org-special-ctrl-k)
23480 (not (org-at-heading-p)))
23481 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23482 org-ctrl-k-protect-subtree)
23483 (if (or (eq org-ctrl-k-protect-subtree 'error)
23484 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23485 (user-error "C-k aborted as it would kill a hidden subtree")))
23486 (call-interactively
23487 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23488 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23489 (kill-region (point) (match-beginning 1))
23490 (org-set-tags nil t))
23491 (t (kill-region (point) (point-at-eol)))))
23493 (define-key org-mode-map "\C-k" 'org-kill-line)
23495 (defun org-yank (&optional arg)
23496 "Yank. If the kill is a subtree, treat it specially.
23497 This command will look at the current kill and check if is a single
23498 subtree, or a series of subtrees[1]. If it passes the test, and if the
23499 cursor is at the beginning of a line or after the stars of a currently
23500 empty headline, then the yank is handled specially. How exactly depends
23501 on the value of the following variables, both set by default.
23503 `org-yank-folded-subtrees'
23504 When set, the subtree(s) will be folded after insertion, but only
23505 if doing so would now swallow text after the yanked text.
23507 `org-yank-adjusted-subtrees'
23508 When set, the subtree will be promoted or demoted in order to
23509 fit into the local outline tree structure, which means that the
23510 level will be adjusted so that it becomes the smaller one of the
23511 two *visible* surrounding headings.
23513 Any prefix to this command will cause `yank' to be called directly with
23514 no special treatment. In particular, a simple \\[universal-argument] prefix \
23516 plainly yank the text as it is.
23518 \[1] The test checks if the first non-white line is a heading
23519 and if there are no other headings with fewer stars."
23521 (org-yank-generic 'yank arg))
23523 (defun org-yank-generic (command arg)
23524 "Perform some yank-like command.
23526 This function implements the behavior described in the `org-yank'
23527 documentation. However, it has been generalized to work for any
23528 interactive command with similar behavior."
23530 ;; pretend to be command COMMAND
23531 (setq this-command command)
23534 (call-interactively command)
23536 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23537 (and (org-kill-is-subtree-p)
23539 (and (looking-at "[ \t]*$")
23542 (buffer-substring (point-at-bol) (point)))))))
23545 ((and subtreep org-yank-folded-subtrees)
23546 (let ((beg (point))
23548 (if (and subtreep org-yank-adjusted-subtrees)
23549 (org-paste-subtree nil nil 'for-yank)
23550 (call-interactively command))
23554 (when (and (bolp) subtreep
23555 (not (setq swallowp
23556 (org-yank-folding-would-swallow-text beg end))))
23557 (org-with-limited-levels
23558 (or (looking-at org-outline-regexp)
23559 (re-search-forward org-outline-regexp-bol end t))
23560 (while (and (< (point) end) (looking-at org-outline-regexp))
23562 (org-cycle-show-empty-lines 'folded)
23563 (condition-case nil
23564 (outline-forward-same-level 1)
23565 (error (goto-char end))))))
23568 "Inserted text not folded because that would swallow text"))
23571 (skip-chars-forward " \t\n\r")
23572 (beginning-of-line 1)
23573 (push-mark beg 'nomsg)))
23574 ((and subtreep org-yank-adjusted-subtrees)
23575 (let ((beg (point-at-bol)))
23576 (org-paste-subtree nil nil 'for-yank)
23577 (push-mark beg 'nomsg)))
23579 (call-interactively command))))))
23581 (defun org-yank-folding-would-swallow-text (beg end)
23582 "Would hide-subtree at BEG swallow any text after END?"
23584 (org-with-limited-levels
23587 (when (or (looking-at org-outline-regexp)
23588 (re-search-forward org-outline-regexp-bol end t))
23589 (setq level (org-outline-level)))
23591 (skip-chars-forward " \t\r\n\v\f")
23593 (and (bolp) (looking-at org-outline-regexp)
23594 (<= (org-outline-level) level)))
23595 nil ; Nothing would be swallowed
23596 t))))) ; something would swallow
23598 (define-key org-mode-map "\C-y" 'org-yank)
23600 (defun org-truely-invisible-p ()
23601 "Check if point is at a character currently not visible.
23602 This version does not only check the character property, but also
23604 ;; Early versions of noutline don't have `outline-invisible-p'.
23605 (if (org-bound-and-true-p visible-mode)
23607 (outline-invisible-p)))
23609 (defun org-invisible-p2 ()
23610 "Check if point is at a character currently not visible."
23612 (if (and (eolp) (not (bobp))) (backward-char 1))
23613 ;; Early versions of noutline don't have `outline-invisible-p'.
23614 (outline-invisible-p)))
23616 (defun org-back-to-heading (&optional invisible-ok)
23617 "Call `outline-back-to-heading', but provide a better error message."
23618 (condition-case nil
23619 (outline-back-to-heading invisible-ok)
23620 (error (error "Before first headline at position %d in buffer %s"
23621 (point) (current-buffer)))))
23623 (defun org-before-first-heading-p ()
23624 "Before first heading?"
23627 (null (re-search-backward org-outline-regexp-bol nil t))))
23629 (defun org-at-heading-p (&optional ignored)
23630 (outline-on-heading-p t))
23631 ;; Compatibility alias with Org versions < 7.8.03
23632 (defalias 'org-on-heading-p 'org-at-heading-p)
23634 (defun org-in-commented-heading-p (&optional no-inheritance)
23635 "Non-nil if point is under a commented heading.
23636 This function also checks ancestors of the current headline,
23637 unless optional argument NO-INHERITANCE is non-nil."
23639 ((org-before-first-heading-p) nil)
23640 ((let ((headline (nth 4 (org-heading-components))))
23642 (let ((case-fold-search nil))
23643 (org-string-match-p (concat "^" org-comment-string "\\(?: \\|$\\)")
23645 (no-inheritance nil)
23647 (save-excursion (and (org-up-heading-safe) (org-in-commented-heading-p))))))
23649 (defun org-at-comment-p nil
23650 "Is cursor in a commented line?"
23653 (beginning-of-line)
23654 (looking-at "^[ \t]*# "))))
23656 (defun org-at-drawer-p nil
23657 "Is cursor at a drawer keyword?"
23659 (move-beginning-of-line 1)
23660 (looking-at org-drawer-regexp)))
23662 (defun org-at-block-p nil
23663 "Is cursor at a block keyword?"
23665 (move-beginning-of-line 1)
23666 (looking-at org-block-regexp)))
23668 (defun org-point-at-end-of-empty-headline ()
23669 "If point is at the end of an empty headline, return t, else nil.
23670 If the heading only contains a TODO keyword, it is still still considered
23672 (and (looking-at "[ \t]*$")
23673 (when org-todo-line-regexp
23675 (beginning-of-line 1)
23676 (let ((case-fold-search nil))
23677 (looking-at org-todo-line-regexp)
23678 (string= (match-string 3) ""))))))
23680 (defun org-at-heading-or-item-p ()
23681 (or (org-at-heading-p) (org-at-item-p)))
23683 (defun org-at-target-p ()
23684 (or (org-in-regexp org-radio-target-regexp)
23685 (org-in-regexp org-target-regexp)))
23686 ;; Compatibility alias with Org versions < 7.8.03
23687 (defalias 'org-on-target-p 'org-at-target-p)
23689 (defun org-up-heading-all (arg)
23690 "Move to the heading line of which the present line is a subheading.
23691 This function considers both visible and invisible heading lines.
23692 With argument, move up ARG levels."
23693 (if (fboundp 'outline-up-heading-all)
23694 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23695 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23697 (defun org-up-heading-safe ()
23698 "Move to the heading line of which the present line is a subheading.
23699 This version will not throw an error. It will return the level of the
23700 headline found, or nil if no higher level is found.
23702 Also, this function will be a lot faster than `outline-up-heading',
23703 because it relies on stars being the outline starters. This can really
23704 make a significant difference in outlines with very many siblings."
23705 (when (ignore-errors (org-back-to-heading t))
23706 (let ((level-up (1- (funcall outline-level))))
23707 (and (> level-up 0)
23708 (re-search-backward (format "^\\*\\{1,%d\\} " level-up) nil t)
23709 (funcall outline-level)))))
23711 (defun org-first-sibling-p ()
23712 "Is this heading the first child of its parents?"
23714 (let ((re org-outline-regexp-bol)
23716 (unless (org-at-heading-p t)
23717 (user-error "Not at a heading"))
23718 (setq level (funcall outline-level))
23720 (if (not (re-search-backward re nil t))
23722 (setq l (funcall outline-level))
23725 (defun org-goto-sibling (&optional previous)
23726 "Goto the next sibling, even if it is invisible.
23727 When PREVIOUS is set, go to the previous sibling instead. Returns t
23728 when a sibling was found. When none is found, return nil and don't
23730 (let ((fun (if previous 're-search-backward 're-search-forward))
23732 (re org-outline-regexp-bol)
23734 (when (ignore-errors (org-back-to-heading t))
23735 (setq level (funcall outline-level))
23737 (or previous (forward-char 1))
23738 (while (funcall fun re nil t)
23739 (setq l (funcall outline-level))
23740 (when (< l level) (goto-char pos) (throw 'exit nil))
23741 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23745 (defun org-show-siblings ()
23746 "Show all siblings of the current headline."
23748 (while (org-goto-sibling) (org-flag-heading nil)))
23750 (while (org-goto-sibling 'previous)
23751 (org-flag-heading nil))))
23753 (defun org-goto-first-child ()
23754 "Goto the first child, even if it is invisible.
23755 Return t when a child was found. Otherwise don't move point and
23757 (let (level (pos (point)) (re org-outline-regexp-bol))
23758 (when (ignore-errors (org-back-to-heading t))
23759 (setq level (outline-level))
23761 (if (and (re-search-forward re nil t) (> (outline-level) level))
23762 (progn (goto-char (match-beginning 0)) t)
23763 (goto-char pos) nil))))
23765 (defun org-show-hidden-entry ()
23766 "Show an entry where even the heading is hidden."
23770 (defun org-flag-heading (flag &optional entry)
23771 "Flag the current heading. FLAG non-nil means make invisible.
23772 When ENTRY is non-nil, show the entire entry."
23774 (org-back-to-heading t)
23775 ;; Check if we should show the entire entry
23780 (and (outline-next-heading)
23781 (org-flag-heading nil))))
23782 (outline-flag-region (max (point-min) (1- (point)))
23783 (save-excursion (outline-end-of-heading) (point))
23786 (defun org-get-next-sibling ()
23787 "Move to next heading of the same level, and return point.
23788 If there is no such heading, return nil.
23789 This is like outline-next-sibling, but invisible headings are ok."
23790 (let ((level (funcall outline-level)))
23791 (outline-next-heading)
23792 (while (and (not (eobp)) (> (funcall outline-level) level))
23793 (outline-next-heading))
23794 (if (or (eobp) (< (funcall outline-level) level))
23798 (defun org-get-last-sibling ()
23799 "Move to previous heading of the same level, and return point.
23800 If there is no such heading, return nil."
23801 (let ((opoint (point))
23802 (level (funcall outline-level)))
23803 (outline-previous-heading)
23804 (when (and (/= (point) opoint) (outline-on-heading-p t))
23805 (while (and (> (funcall outline-level) level)
23807 (outline-previous-heading))
23808 (if (< (funcall outline-level) level)
23812 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23813 "Goto to the end of a subtree."
23814 ;; This contains an exact copy of the original function, but it uses
23815 ;; `org-back-to-heading', to make it work also in invisible
23816 ;; trees. And is uses an invisible-ok argument.
23817 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23818 ;; Furthermore, when used inside Org, finding the end of a large subtree
23819 ;; with many children and grandchildren etc, this can be much faster
23820 ;; than the outline version.
23821 (org-back-to-heading invisible-ok)
23823 (level (funcall outline-level)))
23824 (if (and (derived-mode-p 'org-mode) (< level 1000))
23825 ;; A true heading (not a plain list item), in Org-mode
23826 ;; This means we can easily find the end by looking
23827 ;; only for the right number of stars. Using a regexp to do
23828 ;; this is so much faster than using a Lisp loop.
23829 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23831 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23832 ;; something else, do it the slow way
23833 (while (and (not (eobp))
23834 (or first (> (funcall outline-level) level)))
23836 (outline-next-heading)))
23838 (if (memq (preceding-char) '(?\n ?\^M))
23840 ;; Go to end of line before heading
23842 (if (memq (preceding-char) '(?\n ?\^M))
23843 ;; leave blank line before heading
23844 (forward-char -1))))))
23847 (defun org-end-of-meta-data-and-drawers ()
23848 "Jump to the first text after meta data and drawers in the current entry.
23849 This will move over empty lines, lines with planning time stamps,
23850 clocking lines, and drawers."
23851 (org-back-to-heading t)
23852 (let ((end (save-excursion (outline-next-heading) (point)))
23853 (re (concat "\\(" org-drawer-regexp "\\)"
23854 "\\|" "[ \t]*" org-keyword-time-regexp)))
23856 (while (re-search-forward re end t)
23857 (if (not (match-end 1))
23858 ;; empty or planning line
23860 ;; a drawer, find the end
23861 (re-search-forward "^[ \t]*:END:" end 'move)
23863 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23866 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23867 "Move forward to the ARG'th subheading at same level as this one.
23868 Stop at the first and last subheadings of a superior heading.
23869 Normally this only looks at visible headings, but when INVISIBLE-OK is
23870 non-nil it will also look at invisible ones."
23872 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23873 (if (and arg (< arg 0))
23874 (goto-char (point-min))
23875 (outline-next-heading))
23877 (let ((level (- (match-end 0) (match-beginning 0) 1))
23878 (f (if (and arg (< arg 0))
23879 're-search-backward
23880 're-search-forward))
23881 (count (if arg (abs arg) 1))
23883 (while (and (prog1 (> count 0)
23884 (forward-char (if (and arg (< arg 0)) -1 1)))
23885 (funcall f org-outline-regexp-bol nil 'move))
23886 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23887 (cond ((< l level) (setq count 0))
23891 (goto-char (line-beginning-position))
23892 (not (outline-invisible-p)))))
23893 (setq count (1- count))
23895 (setq result (point)))))))
23896 (goto-char result))
23897 (beginning-of-line 1)))
23899 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23900 "Move backward to the ARG'th subheading at same level as this one.
23901 Stop at the first and last subheadings of a superior heading."
23903 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23905 (defun org-next-block (arg &optional backward block-regexp)
23906 "Jump to the next block.
23907 With a prefix argument ARG, jump forward ARG many source blocks.
23908 When BACKWARD is non-nil, jump to the previous block.
23909 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23911 (let ((re (or block-regexp org-block-regexp))
23912 (re-search-fn (or (and backward 're-search-backward)
23913 're-search-forward)))
23914 (if (looking-at re) (forward-char 1))
23915 (condition-case nil
23916 (funcall re-search-fn re nil nil arg)
23917 (error (user-error "No %s code blocks"
23918 (if backward "previous" "further" ))))
23919 (goto-char (match-beginning 0)) (org-show-context)))
23921 (defun org-previous-block (arg &optional block-regexp)
23922 "Jump to the previous block.
23923 With a prefix argument ARG, jump backward ARG many source blocks.
23924 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23926 (org-next-block arg t block-regexp))
23928 (defun org-forward-paragraph ()
23929 "Move forward to beginning of next paragraph or equivalent.
23931 The function moves point to the beginning of the next visible
23932 structural element, which can be a paragraph, a table, a list
23933 item, etc. It also provides some special moves for convenience:
23935 - On an affiliated keyword, jump to the beginning of the
23937 - On an item or a footnote definition, move to the second
23938 element inside, if any.
23939 - On a table or a property drawer, jump after it.
23940 - On a verse or source block, stop after blank lines."
23942 (when (eobp) (user-error "Cannot move further down"))
23943 (let* ((deactivate-mark nil)
23944 (element (org-element-at-point))
23945 (type (org-element-type element))
23946 (post-affiliated (org-element-property :post-affiliated element))
23947 (contents-begin (org-element-property :contents-begin element))
23948 (contents-end (org-element-property :contents-end element))
23949 (end (let ((end (org-element-property :end element)) (parent element))
23950 (while (and (setq parent (org-element-property :parent parent))
23951 (= (org-element-property :contents-end parent) end))
23952 (setq end (org-element-property :end parent)))
23954 (cond ((not element)
23955 (skip-chars-forward " \r\t\n")
23956 (or (eobp) (beginning-of-line)))
23957 ;; On affiliated keywords, move to element's beginning.
23958 ((< (point) post-affiliated)
23959 (goto-char post-affiliated))
23960 ;; At a table row, move to the end of the table. Similarly,
23961 ;; at a node property, move to the end of the property
23963 ((memq type '(node-property table-row))
23964 (goto-char (org-element-property
23965 :end (org-element-property :parent element))))
23966 ((memq type '(property-drawer table)) (goto-char end))
23967 ;; Consider blank lines as separators in verse and source
23968 ;; blocks to ease editing.
23969 ((memq type '(src-block verse-block))
23970 (when (eq type 'src-block)
23972 (save-excursion (goto-char end)
23973 (skip-chars-backward " \r\t\n")
23974 (line-beginning-position))))
23975 (beginning-of-line)
23976 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23977 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23979 (skip-chars-forward " \r\t\n")
23980 (if (= (point) contents-end) (goto-char end)
23981 (beginning-of-line))))
23982 ;; With no contents, just skip element.
23983 ((not contents-begin) (goto-char end))
23984 ;; If contents are invisible, skip the element altogether.
23985 ((outline-invisible-p (line-end-position))
23988 (org-with-limited-levels (outline-next-visible-heading 1)))
23989 ;; At a plain list, make sure we move to the next item
23990 ;; instead of skipping the whole list.
23991 (plain-list (forward-char)
23992 (org-forward-paragraph))
23993 (otherwise (goto-char end))))
23994 ((>= (point) contents-end) (goto-char end))
23995 ((>= (point) contents-begin)
23996 ;; This can only happen on paragraphs and plain lists.
23998 (paragraph (goto-char end))
23999 ;; At a plain list, try to move to second element in
24000 ;; first item, if possible.
24001 (plain-list (end-of-line)
24002 (org-forward-paragraph))))
24003 ;; When contents start on the middle of a line (e.g. in
24004 ;; items and footnote definitions), try to reach first
24005 ;; element starting after current line.
24006 ((> (line-end-position) contents-begin)
24008 (org-forward-paragraph))
24009 (t (goto-char contents-begin)))))
24011 (defun org-backward-paragraph ()
24012 "Move backward to start of previous paragraph or equivalent.
24014 The function moves point to the beginning of the current
24015 structural element, which can be a paragraph, a table, a list
24016 item, etc., or to the beginning of the previous visible one if
24017 point is already there. It also provides some special moves for
24020 - On an affiliated keyword, jump to the first one.
24021 - On a table or a property drawer, move to its beginning.
24022 - On a verse or source block, stop before blank lines."
24024 (when (bobp) (user-error "Cannot move further up"))
24025 (let* ((deactivate-mark nil)
24026 (element (org-element-at-point))
24027 (type (org-element-type element))
24028 (contents-begin (org-element-property :contents-begin element))
24029 (contents-end (org-element-property :contents-end element))
24030 (post-affiliated (org-element-property :post-affiliated element))
24031 (begin (org-element-property :begin element)))
24033 ((not element) (goto-char (point-min)))
24036 (org-backward-paragraph))
24037 ((<= (point) post-affiliated) (goto-char begin))
24038 ((memq type '(node-property table-row))
24039 (goto-char (org-element-property
24040 :post-affiliated (org-element-property :parent element))))
24041 ((memq type '(property-drawer table)) (goto-char begin))
24042 ((memq type '(src-block verse-block))
24043 (when (eq type 'src-block)
24044 (setq contents-begin
24045 (save-excursion (goto-char begin) (forward-line) (point))))
24046 (if (= (point) contents-begin) (goto-char post-affiliated)
24047 ;; Inside a verse block, see blank lines as paragraph
24049 (let ((origin (point)))
24050 (skip-chars-backward " \r\t\n" contents-begin)
24051 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
24052 (skip-chars-forward " \r\t\n" origin)
24053 (if (= (point) origin) (goto-char contents-begin)
24054 (beginning-of-line))))))
24055 ((not contents-begin) (goto-char (or post-affiliated begin)))
24056 ((eq type 'paragraph)
24057 (goto-char contents-begin)
24058 ;; When at first paragraph in an item or a footnote definition,
24059 ;; move directly to beginning of line.
24060 (let ((parent-contents
24061 (org-element-property
24062 :contents-begin (org-element-property :parent element))))
24063 (when (and parent-contents (= parent-contents contents-begin))
24064 (beginning-of-line))))
24065 ;; At the end of a greater element, move to the beginning of the
24066 ;; last element within.
24067 ((>= (point) contents-end)
24068 (goto-char (1- contents-end))
24069 (org-backward-paragraph))
24070 (t (goto-char (or post-affiliated begin))))
24071 ;; Ensure we never leave point invisible.
24072 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
24074 (defun org-forward-element ()
24075 "Move forward by one element.
24076 Move to the next element at the same level, when possible."
24078 (cond ((eobp) (user-error "Cannot move further down"))
24079 ((org-with-limited-levels (org-at-heading-p))
24080 (let ((origin (point)))
24081 (goto-char (org-end-of-subtree nil t))
24082 (unless (org-with-limited-levels (org-at-heading-p))
24084 (user-error "Cannot move further down"))))
24086 (let* ((elem (org-element-at-point))
24087 (end (org-element-property :end elem))
24088 (parent (org-element-property :parent elem)))
24089 (cond ((and parent (= (org-element-property :contents-end parent) end))
24090 (goto-char (org-element-property :end parent)))
24091 ((integer-or-marker-p end) (goto-char end))
24092 (t (message "No element at point")))))))
24094 (defun org-backward-element ()
24095 "Move backward by one element.
24096 Move to the previous element at the same level, when possible."
24098 (cond ((bobp) (user-error "Cannot move further up"))
24099 ((org-with-limited-levels (org-at-heading-p))
24100 ;; At a headline, move to the previous one, if any, or stay
24102 (let ((origin (point)))
24103 (org-with-limited-levels (org-backward-heading-same-level 1))
24104 ;; When current headline has no sibling above, move to its
24106 (when (= (point) origin)
24107 (or (org-with-limited-levels (org-up-heading-safe))
24108 (progn (goto-char origin)
24109 (user-error "Cannot move further up"))))))
24111 (let* ((elem (org-element-at-point))
24112 (beg (org-element-property :begin elem)))
24114 ;; Move to beginning of current element if point isn't
24116 ((null beg) (message "No element at point"))
24117 ((/= (point) beg) (goto-char beg))
24119 (skip-chars-backward " \r\t\n")
24121 (let ((prev (org-element-at-point)))
24122 (goto-char (org-element-property :begin prev))
24123 (while (and (setq prev (org-element-property :parent prev))
24124 (<= (org-element-property :end prev) beg))
24125 (goto-char (org-element-property :begin prev)))))))))))
24127 (defun org-up-element ()
24128 "Move to upper element."
24130 (if (org-with-limited-levels (org-at-heading-p))
24131 (unless (org-up-heading-safe) (user-error "No surrounding element"))
24132 (let* ((elem (org-element-at-point))
24133 (parent (org-element-property :parent elem)))
24134 (if parent (goto-char (org-element-property :begin parent))
24135 (if (org-with-limited-levels (org-before-first-heading-p))
24136 (user-error "No surrounding element")
24137 (org-with-limited-levels (org-back-to-heading)))))))
24139 (defvar org-element-greater-elements)
24140 (defun org-down-element ()
24141 "Move to inner element."
24143 (let ((element (org-element-at-point)))
24145 ((memq (org-element-type element) '(plain-list table))
24146 (goto-char (org-element-property :contents-begin element))
24148 ((memq (org-element-type element) org-element-greater-elements)
24149 ;; If contents are hidden, first disclose them.
24150 (when (outline-invisible-p (line-end-position)) (org-cycle))
24151 (goto-char (or (org-element-property :contents-begin element)
24152 (user-error "No content for this element"))))
24153 (t (user-error "No inner element")))))
24155 (defun org-drag-element-backward ()
24156 "Move backward element at point."
24158 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
24159 (let* ((elem (org-element-at-point))
24162 (goto-char (org-element-property :begin elem))
24163 (skip-chars-backward " \r\t\n")
24165 (let* ((beg (org-element-property :begin elem))
24166 (prev (org-element-at-point))
24168 (while (and (setq up (org-element-property :parent up))
24169 (<= (org-element-property :end up) beg))
24172 ;; Error out if no previous element or previous element is
24173 ;; a parent of the current one.
24174 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
24175 (user-error "Cannot drag element backward")
24176 (let ((pos (point)))
24177 (org-element-swap-A-B prev-elem elem)
24178 (goto-char (+ (org-element-property :begin prev-elem)
24179 (- pos (org-element-property :begin elem)))))))))
24181 (defun org-drag-element-forward ()
24182 "Move forward element at point."
24184 (let* ((pos (point))
24185 (elem (org-element-at-point)))
24186 (when (= (point-max) (org-element-property :end elem))
24187 (user-error "Cannot drag element forward"))
24188 (goto-char (org-element-property :end elem))
24189 (let ((next-elem (org-element-at-point)))
24190 (when (or (org-element-nested-p elem next-elem)
24191 (and (eq (org-element-type next-elem) 'headline)
24192 (not (eq (org-element-type elem) 'headline))))
24194 (user-error "Cannot drag element forward"))
24195 ;; Compute new position of point: it's shifted by NEXT-ELEM
24196 ;; body's length (without final blanks) and by the length of
24197 ;; blanks between ELEM and NEXT-ELEM.
24198 (let ((size-next (- (save-excursion
24199 (goto-char (org-element-property :end next-elem))
24200 (skip-chars-backward " \r\t\n")
24202 ;; Small correction if buffer doesn't end
24203 ;; with a newline character.
24204 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
24205 (org-element-property :begin next-elem)))
24206 (size-blank (- (org-element-property :end elem)
24208 (goto-char (org-element-property :end elem))
24209 (skip-chars-backward " \r\t\n")
24212 (org-element-swap-A-B elem next-elem)
24213 (goto-char (+ pos size-next size-blank))))))
24215 (defun org-drag-line-forward (arg)
24216 "Drag the line at point ARG lines forward."
24218 (dotimes (n (abs arg))
24219 (let ((c (current-column)))
24222 (beginning-of-line 2)
24223 (transpose-lines 1)
24224 (beginning-of-line 0))
24225 (transpose-lines 1)
24226 (beginning-of-line -1))
24227 (org-move-to-column c))))
24229 (defun org-drag-line-backward (arg)
24230 "Drag the line at point ARG lines backward."
24232 (org-drag-line-forward (- arg)))
24234 (defun org-mark-element ()
24235 "Put point at beginning of this element, mark at end.
24237 Interactively, if this command is repeated or (in Transient Mark
24238 mode) if the mark is active, it marks the next element after the
24239 ones already marked."
24241 (let (deactivate-mark)
24242 (if (and (org-called-interactively-p 'any)
24243 (or (and (eq last-command this-command) (mark t))
24244 (and transient-mark-mode mark-active)))
24248 (goto-char (org-element-property :end (org-element-at-point)))))
24249 (let ((element (org-element-at-point)))
24251 (push-mark (org-element-property :end element) t t)
24252 (goto-char (org-element-property :begin element))))))
24254 (defun org-narrow-to-element ()
24255 "Narrow buffer to current element."
24257 (let ((elem (org-element-at-point)))
24259 ((eq (car elem) 'headline)
24261 (org-element-property :begin elem)
24262 (org-element-property :end elem)))
24263 ((memq (car elem) org-element-greater-elements)
24265 (org-element-property :contents-begin elem)
24266 (org-element-property :contents-end elem)))
24269 (org-element-property :begin elem)
24270 (org-element-property :end elem))))))
24272 (defun org-transpose-element ()
24273 "Transpose current and previous elements, keeping blank lines between.
24274 Point is moved after both elements."
24276 (org-skip-whitespace)
24277 (let ((end (org-element-property :end (org-element-at-point))))
24278 (org-drag-element-backward)
24281 (defun org-unindent-buffer ()
24282 "Un-indent the visible part of the buffer.
24283 Relative indentation (between items, inside blocks, etc.) isn't
24286 (unless (eq major-mode 'org-mode)
24287 (user-error "Cannot un-indent a buffer not in Org mode"))
24288 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
24289 unindent-tree ; For byte-compiler.
24295 (if (memq (org-element-type element) '(headline section))
24296 (funcall unindent-tree (org-element-contents element))
24300 (org-element-property :begin element)
24301 (org-element-property :end element))
24302 (org-do-remove-indentation)))))
24303 (reverse contents))))))
24304 (funcall unindent-tree (org-element-contents parse-tree))))
24306 (defun org-show-subtree ()
24307 "Show everything after this heading at deeper levels."
24309 (outline-flag-region
24312 (org-end-of-subtree t t))
24315 (defun org-show-entry ()
24316 "Show the body directly following this heading.
24317 Show the heading too, if it is currently invisible."
24321 (org-back-to-heading t)
24322 (outline-flag-region
24323 (max (point-min) (1- (point)))
24325 (if (re-search-forward
24326 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
24327 (match-beginning 1)
24330 (org-cycle-hide-drawers 'children))))
24332 (defun org-make-options-regexp (kwds &optional extra)
24333 "Make a regular expression for keyword lines."
24336 (mapconcat 'regexp-quote kwds "\\|")
24337 (if extra (concat "\\|" extra))
24338 "\\):[ \t]*\\(.*\\)"))
24340 ;; Make isearch reveal the necessary context
24341 (defun org-isearch-end ()
24342 "Reveal context after isearch exits."
24343 (when isearch-success ; only if search was successful
24344 (if (featurep 'xemacs)
24345 ;; Under XEmacs, the hook is run in the correct place,
24346 ;; we directly show the context.
24347 (org-show-context 'isearch)
24348 ;; In Emacs the hook runs *before* restoring the overlays.
24349 ;; So we have to use a one-time post-command-hook to do this.
24350 ;; (Emacs 22 has a special variable, see function `org-mode')
24351 (unless (and (boundp 'isearch-mode-end-hook-quit)
24352 isearch-mode-end-hook-quit)
24353 ;; Only when the isearch was not quitted.
24354 (org-add-hook 'post-command-hook 'org-isearch-post-command
24355 'append 'local)))))
24357 (defun org-isearch-post-command ()
24358 "Remove self from hook, and show context."
24359 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
24360 (org-show-context 'isearch))
24363 ;;;; Integration with and fixes for other packages
24367 (defvar org-imenu-markers nil
24368 "All markers currently used by Imenu.")
24369 (make-variable-buffer-local 'org-imenu-markers)
24371 (defun org-imenu-new-marker (&optional pos)
24372 "Return a new marker for use by Imenu, and remember the marker."
24373 (let ((m (make-marker)))
24374 (move-marker m (or pos (point)))
24375 (push m org-imenu-markers)
24378 (defun org-imenu-get-tree ()
24379 "Produce the index for Imenu."
24380 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24381 (setq org-imenu-markers nil)
24382 (let* ((n org-imenu-depth)
24383 (re (concat "^" (org-get-limited-outline-regexp)))
24384 (subs (make-vector (1+ n) nil))
24386 m level head0 head)
24390 (goto-char (point-max))
24391 (while (re-search-backward re nil t)
24392 (setq level (org-reduced-level (funcall outline-level)))
24393 (when (and (<= level n)
24394 (looking-at org-complex-heading-regexp)
24395 (setq head0 (org-match-string-no-properties 4)))
24396 (setq head (org-link-display-format head0)
24397 m (org-imenu-new-marker))
24398 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24399 (if (>= level last-level)
24400 (push (cons head m) (aref subs level))
24401 (push (cons head (aref subs (1+ level))) (aref subs level))
24402 (loop for i from (1+ level) to n do (aset subs i nil)))
24403 (setq last-level level)))))
24406 (eval-after-load "imenu"
24408 (add-hook 'imenu-after-jump-hook
24410 (if (derived-mode-p 'org-mode)
24411 (org-show-context 'org-goto))))))
24413 (defun org-link-display-format (link)
24414 "Replace a link with its the description.
24415 If there is no description, use the link target."
24417 (if (string-match org-bracket-link-analytic-regexp link)
24418 (replace-match (if (match-end 5)
24419 (match-string 5 link)
24420 (concat (match-string 1 link)
24421 (match-string 3 link)))
24425 (defun org-toggle-link-display ()
24426 "Toggle the literal or descriptive display of links."
24428 (if org-descriptive-links
24429 (progn (org-remove-from-invisibility-spec '(org-link))
24430 (org-restart-font-lock)
24431 (setq org-descriptive-links nil))
24432 (progn (add-to-invisibility-spec '(org-link))
24433 (org-restart-font-lock)
24434 (setq org-descriptive-links t))))
24436 ;; Speedbar support
24438 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24439 "Overlay marking the agenda restriction line in speedbar.")
24440 (overlay-put org-speedbar-restriction-lock-overlay
24441 'face 'org-agenda-restriction-lock)
24442 (overlay-put org-speedbar-restriction-lock-overlay
24443 'help-echo "Agendas are currently limited to this item.")
24444 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24446 (defun org-speedbar-set-agenda-restriction ()
24447 "Restrict future agenda commands to the location at point in speedbar.
24448 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24450 (require 'org-agenda)
24451 (let (p m tp np dir txt)
24453 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24455 (setq m (get-text-property p 'org-imenu-marker))
24456 (with-current-buffer (marker-buffer m)
24458 (org-agenda-set-restriction-lock 'subtree)))
24459 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24460 'speedbar-function 'speedbar-find-file))
24461 (setq tp (previous-single-property-change
24462 (1+ p) 'speedbar-function)
24463 np (next-single-property-change
24464 tp 'speedbar-function)
24465 dir (speedbar-line-directory)
24466 txt (buffer-substring-no-properties (or tp (point-min))
24467 (or np (point-max))))
24468 (with-current-buffer (find-file-noselect
24469 (let ((default-directory dir))
24470 (expand-file-name txt)))
24471 (unless (derived-mode-p 'org-mode)
24472 (user-error "Cannot restrict to non-Org-mode file"))
24473 (org-agenda-set-restriction-lock 'file)))
24474 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24475 (move-overlay org-speedbar-restriction-lock-overlay
24476 (point-at-bol) (point-at-eol))
24477 (setq current-prefix-arg nil)
24478 (org-agenda-maybe-redo)))
24480 (defvar speedbar-file-key-map)
24481 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24482 (eval-after-load "speedbar"
24484 (speedbar-add-supported-extension ".org")
24485 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24486 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24487 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24488 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24489 (add-hook 'speedbar-visiting-tag-hook
24490 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24492 ;;; Fixes and Hacks for problems with other packages
24494 (defun org-mode-flyspell-verify ()
24495 "Function used for `flyspell-generic-check-word-predicate'."
24496 (if (org-at-heading-p)
24497 ;; At a headline or an inlinetask, check title only. This is
24498 ;; faster than relying on `org-element-at-point'.
24499 (and (save-excursion (beginning-of-line)
24500 (and (let ((case-fold-search t))
24501 (not (looking-at "\\*+ END[ \t]*$")))
24502 (looking-at org-complex-heading-regexp)))
24503 (match-beginning 4)
24504 (>= (point) (match-beginning 4))
24505 (or (not (match-beginning 5))
24506 (< (point) (match-beginning 5))))
24507 (let* ((element (org-element-at-point))
24508 (post-affiliated (org-element-property :post-affiliated element))
24511 ;; Non-nil if checks can be done for object at point.
24513 (let ((object (save-excursion
24514 (when (org-looking-at-p "\\>") (backward-char))
24515 (org-element-context element))))
24516 (case (org-element-type object)
24517 ;; Prevent checks in links due to keybinding conflict
24519 ((code entity export-snippet inline-babel-call
24520 inline-src-block line-break latex-fragment link macro
24521 statistics-cookie target timestamp verbatim)
24523 (footnote-reference
24524 ;; Only in inline footnotes, within the definition.
24525 (and (eq (org-element-property :type object) 'inline)
24527 (goto-char (org-element-property :begin object))
24528 (search-forward ":" nil t 2))
24530 (otherwise t)))))))
24532 ;; Ignore checks in all affiliated keywords but captions.
24533 ((< (point) post-affiliated)
24534 (and (save-excursion
24535 (beginning-of-line)
24536 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24537 (> (point) (match-end 0))
24538 (funcall object-check)))
24539 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24540 ((and org-log-into-drawer
24541 (let ((log (or (org-string-nw-p org-log-into-drawer) "LOGBOOK"))
24543 (while (and parent (not (eq (org-element-type parent) 'drawer)))
24544 (setq parent (org-element-property :parent parent)))
24546 (eq (compare-strings
24548 (org-element-property :drawer-name parent) nil nil t)
24552 (case (org-element-type element)
24553 ((comment quote-section) t)
24555 ;; Allow checks between block markers, not on them.
24556 (and (> (line-beginning-position) post-affiliated)
24559 (skip-chars-forward " \r\t\n")
24560 (< (point) (org-element-property :end element)))))
24561 ;; Arbitrary list of keywords where checks are meaningful.
24562 ;; Make sure point is on the value part of the element.
24564 (and (member (org-element-property :key element)
24565 '("DESCRIPTION" "TITLE"))
24567 (beginning-of-line) (search-forward ":") (point))
24569 ;; Check is globally allowed in paragraphs verse blocks and
24570 ;; table rows (after affiliated keywords) but some objects
24571 ;; must not be affected.
24572 ((paragraph table-row verse-block)
24573 (and (>= (point) (org-element-property :contents-begin element))
24574 (< (point) (org-element-property :contents-end element))
24575 (funcall object-check)))))))))
24576 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24578 (defun org-remove-flyspell-overlays-in (beg end)
24579 "Remove flyspell overlays in region."
24580 (and (org-bound-and-true-p flyspell-mode)
24581 (fboundp 'flyspell-delete-region-overlays)
24582 (flyspell-delete-region-overlays beg end)))
24584 (defvar flyspell-delayed-commands)
24585 (eval-after-load "flyspell"
24586 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24588 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24589 (eval-after-load "bookmark"
24590 '(if (boundp 'bookmark-after-jump-hook)
24591 ;; We can use the hook
24592 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24593 ;; Hook not available, use advice
24594 (defadvice bookmark-jump (after org-make-visible activate)
24595 "Make the position visible."
24596 (org-bookmark-jump-unhide))))
24598 ;; Make sure saveplace shows the location if it was hidden
24599 (eval-after-load "saveplace"
24600 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24601 "Make the position visible."
24602 (org-bookmark-jump-unhide)))
24604 ;; Make sure ecb shows the location if it was hidden
24605 (eval-after-load "ecb"
24606 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24607 "Make hierarchy visible when jumping into location from ECB tree buffer."
24608 (if (derived-mode-p 'org-mode)
24609 (org-show-context))))
24611 (defun org-bookmark-jump-unhide ()
24612 "Unhide the current position, to show the bookmark location."
24613 (and (derived-mode-p 'org-mode)
24614 (or (outline-invisible-p)
24615 (save-excursion (goto-char (max (point-min) (1- (point))))
24616 (outline-invisible-p)))
24617 (org-show-context 'bookmark-jump)))
24619 (defun org-mark-jump-unhide ()
24620 "Make the point visible with `org-show-context' after jumping to the mark."
24621 (when (and (derived-mode-p 'org-mode)
24622 (outline-invisible-p))
24623 (org-show-context 'mark-goto)))
24625 (eval-after-load "simple"
24626 '(defadvice pop-to-mark-command (after org-make-visible activate)
24627 "Make the point visible with `org-show-context'."
24628 (org-mark-jump-unhide)))
24630 (eval-after-load "simple"
24631 '(defadvice exchange-point-and-mark (after org-make-visible activate)
24632 "Make the point visible with `org-show-context'."
24633 (org-mark-jump-unhide)))
24635 (eval-after-load "simple"
24636 '(defadvice pop-global-mark (after org-make-visible activate)
24637 "Make the point visible with `org-show-context'."
24638 (org-mark-jump-unhide)))
24640 ;; Make session.el ignore our circular variable
24641 (defvar session-globals-exclude)
24642 (eval-after-load "session"
24643 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24649 (run-hooks 'org-load-hook)
24651 ;;; org.el ends here