Small refactoring
[org-mode/org-kjn.git] / lisp / org.el
blob549f1f8c0f025442f18082f4923447ba408b3126
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.
5 ;;
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/>.
26 ;;; Commentary:
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
44 ;; linked webpages.
46 ;; Installation and Activation
47 ;; ---------------------------
48 ;; See the corresponding sections in the manual at
50 ;; http://orgmode.org/org.html#Installation
52 ;; Documentation
53 ;; -------------
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
63 ;;; Code:
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
72 (eval-when-compile
73 (require 'cl)
74 (require 'gnus-sum))
76 (require 'calendar)
77 (require 'find-func)
78 (require 'format-spec)
80 (load "org-loaddefs.el" t t t)
82 (require 'org-macs)
83 (require 'org-compat)
85 ;; `org-outline-regexp' ought to be a defconst but is let-bound in
86 ;; some places -- e.g. see the macro `org-with-limited-levels'.
88 ;; In Org buffers, the value of `outline-regexp' is that of
89 ;; `org-outline-regexp'. The only function still directly relying on
90 ;; `outline-regexp' is `org-overview' so that `org-cycle' can do its
91 ;; job when `orgstruct-mode' is active.
92 (defvar org-outline-regexp "\\*+ "
93 "Regexp to match Org headlines.")
95 (defvar org-outline-regexp-bol "^\\*+ "
96 "Regexp to match Org headlines.
97 This is similar to `org-outline-regexp' but additionally makes
98 sure that we are at the beginning of the line.")
100 (defvar org-heading-regexp "^\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
101 "Matches a headline, putting stars and text into groups.
102 Stars are put in group 1 and the trimmed body in group 2.")
104 ;; Emacs 22 calendar compatibility: Make sure the new variables are available
105 (unless (boundp 'calendar-view-holidays-initially-flag)
106 (org-defvaralias 'calendar-view-holidays-initially-flag
107 'view-calendar-holidays-initially))
108 (unless (boundp 'calendar-view-diary-initially-flag)
109 (org-defvaralias 'calendar-view-diary-initially-flag
110 'view-diary-entries-initially))
111 (unless (boundp 'diary-fancy-buffer)
112 (org-defvaralias 'diary-fancy-buffer 'fancy-diary-buffer))
114 (declare-function org-inlinetask-at-task-p "org-inlinetask" ())
115 (declare-function org-inlinetask-outline-regexp "org-inlinetask" ())
116 (declare-function org-inlinetask-toggle-visibility "org-inlinetask" ())
117 (declare-function org-pop-to-buffer-same-window "org-compat" (&optional buffer-or-name norecord label))
118 (declare-function org-clocktable-shift "org-clock" (dir n))
119 (declare-function org-clock-get-last-clock-out-time "org-clock" ())
120 (declare-function org-clock-update-time-maybe "org-clock" ())
121 (declare-function org-clock-remove-overlays "org-clock" (&optional beg end noremove))
122 (declare-function org-clock-timestamps-up "org-clock" (&optional n))
123 (declare-function org-clock-timestamps-down "org-clock" (&optional n))
124 (declare-function org-clock-sum-current-item "org-clock" (&optional tstart))
126 (declare-function org-babel-tangle-file "ob-tangle" (file &optional target-file lang))
127 (declare-function org-babel-do-in-edit-buffer "ob-core" (&rest body))
128 (declare-function orgtbl-mode "org-table" (&optional arg))
129 (declare-function org-clock-out "org-clock" (&optional switch-to-state fail-quietly at-time))
130 (declare-function org-beamer-mode "ox-beamer" ())
131 (declare-function org-table-blank-field "org-table" ())
132 (declare-function org-table-edit-field "org-table" (arg))
133 (declare-function org-table-insert-row "org-table" (&optional arg))
134 (declare-function org-table-justify-field-maybe "org-table" (&optional new))
135 (declare-function org-table-set-constants "org-table" ())
136 (declare-function org-table-calc-current-TBLFM "org-table" (&optional arg))
137 (declare-function org-id-get-create "org-id" (&optional force))
138 (declare-function org-add-archive-files "org-archive" (files))
139 (declare-function org-id-find-id-file "org-id" (id))
140 (declare-function org-tags-view "org-agenda" (&optional todo-only match))
141 (declare-function org-agenda-list "org-agenda" (&optional arg start-day span))
142 (declare-function org-agenda-redo "org-agenda" (&optional all))
143 (declare-function org-table-align "org-table" ())
144 (declare-function org-table-begin "org-table" (&optional table-type))
145 (declare-function org-table-end "org-table" (&optional table-type))
146 (declare-function org-table-paste-rectangle "org-table" ())
147 (declare-function org-table-maybe-eval-formula "org-table" ())
148 (declare-function org-table-maybe-recalculate-line "org-table" ())
150 (declare-function org-element--parse-objects "org-element"
151 (beg end acc restriction))
152 (declare-function org-element-at-point "org-element" ())
153 (declare-function org-element-cache-reset "org-element" (&optional all))
154 (declare-function org-element-contents "org-element" (element))
155 (declare-function org-element-context "org-element" (&optional element))
156 (declare-function org-element-interpret-data "org-element"
157 (data &optional parent))
158 (declare-function org-element-map "org-element"
159 (data types fun &optional info first-match no-recursion))
160 (declare-function org-element-nested-p "org-element" (elem-a elem-b))
161 (declare-function org-element-parse-buffer "org-element"
162 (&optional granularity visible-only))
163 (declare-function org-element-property "org-element" (property element))
164 (declare-function org-element-put-property "org-element"
165 (element property value))
166 (declare-function org-element-swap-A-B "org-element" (elem-a elem-b))
167 (declare-function org-element--parse-objects "org-element"
168 (beg end acc restriction))
169 (declare-function org-element-parse-buffer "org-element"
170 (&optional granularity visible-only))
171 (declare-function org-element-restriction "org-element" (element))
172 (declare-function org-element-type "org-element" (element))
174 (defsubst org-uniquify (list)
175 "Non-destructively remove duplicate elements from LIST."
176 (let ((res (copy-sequence list))) (delete-dups res)))
178 ;; load languages based on value of `org-babel-load-languages'
179 (defvar org-babel-load-languages)
181 ;;;###autoload
182 (defun org-babel-do-load-languages (sym value)
183 "Load the languages defined in `org-babel-load-languages'."
184 (set-default sym value)
185 (mapc (lambda (pair)
186 (let ((active (cdr pair)) (lang (symbol-name (car pair))))
187 (if active
188 (progn
189 (require (intern (concat "ob-" lang))))
190 (progn
191 (funcall 'fmakunbound
192 (intern (concat "org-babel-execute:" lang)))
193 (funcall 'fmakunbound
194 (intern (concat "org-babel-expand-body:" lang)))))))
195 org-babel-load-languages))
197 ;;;###autoload
198 (defun org-babel-load-file (file &optional compile)
199 "Load Emacs Lisp source code blocks in the Org-mode FILE.
200 This function exports the source code using `org-babel-tangle'
201 and then loads the resulting file using `load-file'. With prefix
202 arg (noninteractively: 2nd arg) COMPILE the tangled Emacs Lisp
203 file to byte-code before it is loaded."
204 (interactive "fFile to load: \nP")
205 (let* ((age (lambda (file)
206 (float-time
207 (time-subtract (current-time)
208 (nth 5 (or (file-attributes (file-truename file))
209 (file-attributes file)))))))
210 (base-name (file-name-sans-extension file))
211 (exported-file (concat base-name ".el")))
212 ;; tangle if the org-mode file is newer than the elisp file
213 (unless (and (file-exists-p exported-file)
214 (> (funcall age file) (funcall age exported-file)))
215 (setq exported-file
216 (car (org-babel-tangle-file file exported-file "emacs-lisp"))))
217 (message "%s %s"
218 (if compile
219 (progn (byte-compile-file exported-file 'load)
220 "Compiled and loaded")
221 (progn (load-file exported-file) "Loaded"))
222 exported-file)))
224 (defcustom org-babel-load-languages '((emacs-lisp . t))
225 "Languages which can be evaluated in Org-mode buffers.
226 This list can be used to load support for any of the languages
227 below, note that each language will depend on a different set of
228 system executables and/or Emacs modes. When a language is
229 \"loaded\", then code blocks in that language can be evaluated
230 with `org-babel-execute-src-block' bound by default to C-c
231 C-c (note the `org-babel-no-eval-on-ctrl-c-ctrl-c' variable can
232 be set to remove code block evaluation from the C-c C-c
233 keybinding. By default only Emacs Lisp (which has no
234 requirements) is loaded."
235 :group 'org-babel
236 :set 'org-babel-do-load-languages
237 :version "24.1"
238 :type '(alist :tag "Babel Languages"
239 :key-type
240 (choice
241 (const :tag "Awk" awk)
242 (const :tag "C" C)
243 (const :tag "R" R)
244 (const :tag "Asymptote" asymptote)
245 (const :tag "Calc" calc)
246 (const :tag "Clojure" clojure)
247 (const :tag "CSS" css)
248 (const :tag "Ditaa" ditaa)
249 (const :tag "Dot" dot)
250 (const :tag "Emacs Lisp" emacs-lisp)
251 (const :tag "Fortran" fortran)
252 (const :tag "Gnuplot" gnuplot)
253 (const :tag "Haskell" haskell)
254 (const :tag "IO" io)
255 (const :tag "J" J)
256 (const :tag "Java" java)
257 (const :tag "Javascript" js)
258 (const :tag "LaTeX" latex)
259 (const :tag "Ledger" ledger)
260 (const :tag "Lilypond" lilypond)
261 (const :tag "Lisp" lisp)
262 (const :tag "Makefile" makefile)
263 (const :tag "Maxima" maxima)
264 (const :tag "Matlab" matlab)
265 (const :tag "Mscgen" mscgen)
266 (const :tag "Ocaml" ocaml)
267 (const :tag "Octave" octave)
268 (const :tag "Org" org)
269 (const :tag "Perl" perl)
270 (const :tag "Pico Lisp" picolisp)
271 (const :tag "PlantUML" plantuml)
272 (const :tag "Python" python)
273 (const :tag "Ruby" ruby)
274 (const :tag "Sass" sass)
275 (const :tag "Scala" scala)
276 (const :tag "Scheme" scheme)
277 (const :tag "Screen" screen)
278 (const :tag "Shell Script" sh)
279 (const :tag "Shen" shen)
280 (const :tag "Sql" sql)
281 (const :tag "Sqlite" sqlite)
282 (const :tag "ebnf2ps" ebnf2ps))
283 :value-type (boolean :tag "Activate" :value t)))
285 ;;;; Customization variables
286 (defcustom org-clone-delete-id nil
287 "Remove ID property of clones of a subtree.
288 When non-nil, clones of a subtree don't inherit the ID property.
289 Otherwise they inherit the ID property with a new unique
290 identifier."
291 :type 'boolean
292 :version "24.1"
293 :group 'org-id)
295 ;;; Version
296 (org-check-version)
298 ;;;###autoload
299 (defun org-version (&optional here full message)
300 "Show the org-mode version in the echo area.
301 With prefix argument HERE, insert it at point.
302 When FULL is non-nil, use a verbose version string.
303 When MESSAGE is non-nil, display a message with the version."
304 (interactive "P")
305 (let* ((org-dir (ignore-errors (org-find-library-dir "org")))
306 (save-load-suffixes (when (boundp 'load-suffixes) load-suffixes))
307 (load-suffixes (list ".el"))
308 (org-install-dir (ignore-errors (org-find-library-dir "org-loaddefs")))
309 (org-trash (or
310 (and (fboundp 'org-release) (fboundp 'org-git-version))
311 (org-load-noerror-mustsuffix (concat org-dir "org-version"))))
312 (load-suffixes save-load-suffixes)
313 (org-version (org-release))
314 (git-version (org-git-version))
315 (version (format "Org-mode version %s (%s @ %s)"
316 org-version
317 git-version
318 (if org-install-dir
319 (if (string= org-dir org-install-dir)
320 org-install-dir
321 (concat "mixed installation! " org-install-dir " and " org-dir))
322 "org-loaddefs.el can not be found!")))
323 (version1 (if full version org-version)))
324 (if (org-called-interactively-p 'interactive)
325 (if here
326 (insert version)
327 (message version))
328 (if message (message version1))
329 version1)))
331 (defconst org-version (org-version))
334 ;;; Syntax Constants
336 ;;;; Block
338 (defconst org-block-regexp
339 "^[ \t]*#\\+begin_?\\([^ \n]+\\)\\(\\([^\n]+\\)\\)?\n\\([^\000]+?\\)#\\+end_?\\1[ \t]*$"
340 "Regular expression for hiding blocks.")
342 (defconst org-dblock-start-re
343 "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+\\(\\S-+\\)\\([ \t]+\\(.*\\)\\)?"
344 "Matches the start line of a dynamic block, with parameters.")
346 (defconst org-dblock-end-re "^[ \t]*#\\+\\(?:END\\|end\\)\\([: \t\r\n]\\|$\\)"
347 "Matches the end of a dynamic block.")
349 ;;;; Clock and Planning
351 (defconst org-clock-string "CLOCK:"
352 "String used as prefix for timestamps clocking work hours on an item.")
354 (defconst org-closed-string "CLOSED:"
355 "String used as the prefix for timestamps logging closing a TODO entry.")
357 (defconst org-deadline-string "DEADLINE:"
358 "String to mark deadline entries.
359 A deadline is this string, followed by a time stamp. Should be a word,
360 terminated by a colon. You can insert a schedule keyword and
361 a timestamp with \\[org-deadline].")
363 (defconst org-scheduled-string "SCHEDULED:"
364 "String to mark scheduled TODO entries.
365 A schedule is this string, followed by a time stamp. Should be a word,
366 terminated by a colon. You can insert a schedule keyword and
367 a timestamp with \\[org-schedule].")
369 (defconst org-planning-or-clock-line-re
370 (concat "^[ \t]*"
371 (regexp-opt
372 (list org-clock-string org-closed-string org-deadline-string
373 org-scheduled-string)
375 "Matches a line with planning or clock info.
376 Matched keyword is in group 1.")
378 ;;;; Drawer
380 (defconst org-drawer-regexp "^[ \t]*:\\(\\(?:\\w\\|[-_]\\)+\\):[ \t]*$"
381 "Matches first or last line of a hidden block.
382 Group 1 contains drawer's name or \"END\".")
384 (defconst org-property-start-re "^[ \t]*:PROPERTIES:[ \t]*$"
385 "Regular expression matching the first line of a property drawer.")
387 (defconst org-property-end-re "^[ \t]*:END:[ \t]*$"
388 "Regular expression matching the last line of a property drawer.")
390 (defconst org-clock-drawer-start-re "^[ \t]*:CLOCK:[ \t]*$"
391 "Regular expression matching the first line of a clock drawer.")
393 (defconst org-clock-drawer-end-re "^[ \t]*:END:[ \t]*$"
394 "Regular expression matching the last line of a clock drawer.")
396 (defconst org-property-drawer-re
397 (concat "\\(" org-property-start-re "\\)[^\000]*?\\("
398 org-property-end-re "\\)\n?")
399 "Matches an entire property drawer.")
401 (defconst org-clock-drawer-re
402 (concat "\\(" org-clock-drawer-start-re "\\)[^\000]*?\\("
403 org-clock-drawer-end-re "\\)\n?")
404 "Matches an entire clock drawer.")
406 ;;;; Headline
408 (defconst org-heading-keyword-regexp-format
409 "^\\(\\*+\\)\\(?: +%s\\)\\(?: +\\(.*?\\)\\)?[ \t]*$"
410 "Printf format for a regexp matching a headline with some keyword.
411 This regexp will match the headline of any node which has the
412 exact keyword that is put into the format. The keyword isn't in
413 any group by default, but the stars and the body are.")
415 (defconst org-heading-keyword-maybe-regexp-format
416 "^\\(\\*+\\)\\(?: +%s\\)?\\(?: +\\(.*?\\)\\)?[ \t]*$"
417 "Printf format for a regexp matching a headline, possibly with some keyword.
418 This regexp can match any headline with the specified keyword, or
419 without a keyword. The keyword isn't in any group by default,
420 but the stars and the body are.")
422 (defconst org-archive-tag "ARCHIVE"
423 "The tag that marks a subtree as archived.
424 An archived subtree does not open during visibility cycling, and does
425 not contribute to the agenda listings.")
427 (defconst org-comment-string "COMMENT"
428 "Entries starting with this keyword will never be exported.
429 An entry can be toggled between COMMENT and normal with
430 \\[org-toggle-comment].")
432 (defconst org-quote-string "QUOTE"
433 "Entries starting with this keyword will be exported in fixed-width font.
434 Quoting applies only to the text in the entry following the headline, and does
435 not extend beyond the next headline, even if that is lower level.
436 An entry can be toggled between QUOTE and normal with
437 \\[org-toggle-fixed-width-section].")
439 ;;;; LaTeX Environments and Fragments
441 (defconst org-latex-regexps
442 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
443 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
444 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
445 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
446 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
447 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
448 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
449 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
450 "Regular expressions for matching embedded LaTeX.")
452 ;;;; Node Property
454 (defconst org-effort-property "Effort"
455 "The property that is being used to keep track of effort estimates.
456 Effort estimates given in this property need to have the format H:MM.")
458 ;;;; Table
460 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
461 "Detect an org-type or table-type table.")
463 (defconst org-table-line-regexp "^[ \t]*|"
464 "Detect an org-type table line.")
466 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
467 "Detect an org-type table line.")
469 (defconst org-table-hline-regexp "^[ \t]*|-"
470 "Detect an org-type table hline.")
472 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
473 "Detect a table-type table hline.")
475 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
476 "Detect the first line outside a table when searching from within it.
477 This works for both table types.")
479 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
480 "Detect a #+TBLFM line.")
482 ;;;; Timestamp
484 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
485 "Regular expression for fast time stamp matching.")
487 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
488 "Regular expression for fast time stamp matching.")
490 (defconst org-ts-regexp0
491 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
492 "Regular expression matching time strings for analysis.
493 This one does not require the space after the date, so it can be used
494 on a string that terminates immediately after the date.")
496 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
497 "Regular expression matching time strings for analysis.")
499 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
500 "Regular expression matching time stamps, with groups.")
502 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
503 "Regular expression matching time stamps (also [..]), with groups.")
505 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
506 "Regular expression matching a time stamp range.")
508 (defconst org-tr-regexp-both
509 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
510 "Regular expression matching a time stamp range.")
512 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
513 org-ts-regexp "\\)?")
514 "Regular expression matching a time stamp or time stamp range.")
516 (defconst org-tsr-regexp-both
517 (concat org-ts-regexp-both "\\(--?-?"
518 org-ts-regexp-both "\\)?")
519 "Regular expression matching a time stamp or time stamp range.
520 The time stamps may be either active or inactive.")
522 (defconst org-repeat-re
523 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
524 "Regular expression for specifying repeated events.
525 After a match, group 1 contains the repeat expression.")
527 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
528 "Formats for `format-time-string' which are used for time stamps.")
531 ;;; The custom variables
533 (defgroup org nil
534 "Outline-based notes management and organizer."
535 :tag "Org"
536 :group 'outlines
537 :group 'calendar)
539 (defcustom org-mode-hook nil
540 "Mode hook for Org-mode, run after the mode was turned on."
541 :group 'org
542 :type 'hook)
544 (defcustom org-load-hook nil
545 "Hook that is run after org.el has been loaded."
546 :group 'org
547 :type 'hook)
549 (defcustom org-log-buffer-setup-hook nil
550 "Hook that is run after an Org log buffer is created."
551 :group 'org
552 :version "24.1"
553 :type 'hook)
555 (defvar org-modules) ; defined below
556 (defvar org-modules-loaded nil
557 "Have the modules been loaded already?")
559 (defun org-load-modules-maybe (&optional force)
560 "Load all extensions listed in `org-modules'."
561 (when (or force (not org-modules-loaded))
562 (mapc (lambda (ext)
563 (condition-case nil (require ext)
564 (error (message "Problems while trying to load feature `%s'" ext))))
565 org-modules)
566 (setq org-modules-loaded t)))
568 (defun org-set-modules (var value)
569 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
570 (set var value)
571 (when (featurep 'org)
572 (org-load-modules-maybe 'force)
573 (org-element-cache-reset 'all)))
575 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
576 "Modules that should always be loaded together with org.el.
578 If a description starts with <C>, the file is not part of Emacs
579 and loading it will require that you have downloaded and properly
580 installed the Org mode distribution.
582 You can also use this system to load external packages (i.e. neither Org
583 core modules, nor modules from the CONTRIB directory). Just add symbols
584 to the end of the list. If the package is called org-xyz.el, then you need
585 to add the symbol `xyz', and the package must have a call to:
587 \(provide 'org-xyz)
589 For export specific modules, see also `org-export-backends'."
590 :group 'org
591 :set 'org-set-modules
592 :version "24.4"
593 :package-version '(Org . "8.0")
594 :type
595 '(set :greedy t
596 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
597 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
598 (const :tag " crypt: Encryption of subtrees" org-crypt)
599 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
600 (const :tag " docview: Links to doc-view buffers" org-docview)
601 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
602 (const :tag " habit: Track your consistency with habits" org-habit)
603 (const :tag " id: Global IDs for identifying entries" org-id)
604 (const :tag " info: Links to Info nodes" org-info)
605 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
606 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
607 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
608 (const :tag " mouse: Additional mouse support" org-mouse)
609 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
610 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
611 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
613 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
614 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
615 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
616 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
617 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
618 (const :tag "C collector: Collect properties into tables" org-collector)
619 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
620 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
621 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
622 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
623 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
624 (const :tag "C eval: Include command output as text" org-eval)
625 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
626 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
627 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
628 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
629 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
630 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
631 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
632 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
633 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
634 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
635 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
636 (const :tag "C mew: Links to Mew folders/messages" org-mew)
637 (const :tag "C mtags: Support for muse-like tags" org-mtags)
638 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
639 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
640 (const :tag "C registry: A registry for Org-mode links" org-registry)
641 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
642 (const :tag "C secretary: Team management with org-mode" org-secretary)
643 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
644 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
645 (const :tag "C track: Keep up with Org-mode development" org-track)
646 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
647 (const :tag "C vm: Links to VM folders/messages" org-vm)
648 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
649 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
650 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
652 (defvar org-export--registered-backends) ; From ox.el.
653 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
654 (declare-function org-export-backend-name "ox" (backend))
655 (defcustom org-export-backends '(ascii html icalendar latex)
656 "List of export back-ends that should be always available.
658 If a description starts with <C>, the file is not part of Emacs
659 and loading it will require that you have downloaded and properly
660 installed the Org mode distribution.
662 Unlike to `org-modules', libraries in this list will not be
663 loaded along with Org, but only once the export framework is
664 needed.
666 This variable needs to be set before org.el is loaded. If you
667 need to make a change while Emacs is running, use the customize
668 interface or run the following code, where VAL stands for the new
669 value of the variable, after updating it:
671 \(progn
672 \(setq org-export--registered-backends
673 \(org-remove-if-not
674 \(lambda (backend)
675 \(let ((name (org-export-backend-name backend)))
676 \(or (memq name val)
677 \(catch 'parentp
678 \(dolist (b val)
679 \(and (org-export-derived-backend-p b name)
680 \(throw 'parentp t)))))))
681 org-export--registered-backends))
682 \(let ((new-list (mapcar 'org-export-backend-name
683 org-export--registered-backends)))
684 \(dolist (backend val)
685 \(cond
686 \((not (load (format \"ox-%s\" backend) t t))
687 \(message \"Problems while trying to load export back-end `%s'\"
688 backend))
689 \((not (memq backend new-list)) (push backend new-list))))
690 \(set-default 'org-export-backends new-list)))
692 Adding a back-end to this list will also pull the back-end it
693 depends on, if any."
694 :group 'org
695 :group 'org-export
696 :version "24.4"
697 :package-version '(Org . "8.0")
698 :initialize 'custom-initialize-set
699 :set (lambda (var val)
700 (if (not (featurep 'ox)) (set-default var val)
701 ;; Any back-end not required anymore (not present in VAL and not
702 ;; a parent of any back-end in the new value) is removed from the
703 ;; list of registered back-ends.
704 (setq org-export--registered-backends
705 (org-remove-if-not
706 (lambda (backend)
707 (let ((name (org-export-backend-name backend)))
708 (or (memq name val)
709 (catch 'parentp
710 (dolist (b val)
711 (and (org-export-derived-backend-p b name)
712 (throw 'parentp t)))))))
713 org-export--registered-backends))
714 ;; Now build NEW-LIST of both new back-ends and required
715 ;; parents.
716 (let ((new-list (mapcar 'org-export-backend-name
717 org-export--registered-backends)))
718 (dolist (backend val)
719 (cond
720 ((not (load (format "ox-%s" backend) t t))
721 (message "Problems while trying to load export back-end `%s'"
722 backend))
723 ((not (memq backend new-list)) (push backend new-list))))
724 ;; Set VAR to that list with fixed dependencies.
725 (set-default var new-list))))
726 :type '(set :greedy t
727 (const :tag " ascii Export buffer to ASCII format" ascii)
728 (const :tag " beamer Export buffer to Beamer presentation" beamer)
729 (const :tag " html Export buffer to HTML format" html)
730 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
731 (const :tag " latex Export buffer to LaTeX format" latex)
732 (const :tag " man Export buffer to MAN format" man)
733 (const :tag " md Export buffer to Markdown format" md)
734 (const :tag " odt Export buffer to ODT format" odt)
735 (const :tag " org Export buffer to Org format" org)
736 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
737 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
738 (const :tag "C deck Export buffer to deck.js presentations" deck)
739 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
740 (const :tag "C groff Export buffer to Groff format" groff)
741 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
742 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
743 (const :tag "C s5 Export buffer to s5 presentations" s5)
744 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
746 (eval-after-load 'ox
747 '(mapc
748 (lambda (backend)
749 (condition-case nil (require (intern (format "ox-%s" backend)))
750 (error (message "Problems while trying to load export back-end `%s'"
751 backend))))
752 org-export-backends))
754 (defcustom org-support-shift-select nil
755 "Non-nil means make shift-cursor commands select text when possible.
757 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
758 start selecting a region, or enlarge regions started in this way.
759 In Org-mode, in special contexts, these same keys are used for
760 other purposes, important enough to compete with shift selection.
761 Org tries to balance these needs by supporting `shift-select-mode'
762 outside these special contexts, under control of this variable.
764 The default of this variable is nil, to avoid confusing behavior. Shifted
765 cursor keys will then execute Org commands in the following contexts:
766 - on a headline, changing TODO state (left/right) and priority (up/down)
767 - on a time stamp, changing the time
768 - in a plain list item, changing the bullet type
769 - in a property definition line, switching between allowed values
770 - in the BEGIN line of a clock table (changing the time block).
771 Outside these contexts, the commands will throw an error.
773 When this variable is t and the cursor is not in a special
774 context, Org-mode will support shift-selection for making and
775 enlarging regions. To make this more effective, the bullet
776 cycling will no longer happen anywhere in an item line, but only
777 if the cursor is exactly on the bullet.
779 If you set this variable to the symbol `always', then the keys
780 will not be special in headlines, property lines, and item lines,
781 to make shift selection work there as well. If this is what you
782 want, you can use the following alternative commands: `C-c C-t'
783 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
784 can be used to switch TODO sets, `C-c -' to cycle item bullet
785 types, and properties can be edited by hand or in column view.
787 However, when the cursor is on a timestamp, shift-cursor commands
788 will still edit the time stamp - this is just too good to give up.
790 XEmacs user should have this variable set to nil, because
791 `shift-select-mode' is in Emacs 23 or later only."
792 :group 'org
793 :type '(choice
794 (const :tag "Never" nil)
795 (const :tag "When outside special context" t)
796 (const :tag "Everywhere except timestamps" always)))
798 (defcustom org-loop-over-headlines-in-active-region nil
799 "Shall some commands act upon headlines in the active region?
801 When set to `t', some commands will be performed in all headlines
802 within the active region.
804 When set to `start-level', some commands will be performed in all
805 headlines within the active region, provided that these headlines
806 are of the same level than the first one.
808 When set to a string, those commands will be performed on the
809 matching headlines within the active region. Such string must be
810 a tags/property/todo match as it is used in the agenda tags view.
812 The list of commands is: `org-schedule', `org-deadline',
813 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
814 `org-archive-to-archive-sibling'. The archiving commands skip
815 already archived entries."
816 :type '(choice (const :tag "Don't loop" nil)
817 (const :tag "All headlines in active region" t)
818 (const :tag "In active region, headlines at the same level than the first one" start-level)
819 (string :tag "Tags/Property/Todo matcher"))
820 :version "24.1"
821 :group 'org-todo
822 :group 'org-archive)
824 (defgroup org-startup nil
825 "Options concerning startup of Org-mode."
826 :tag "Org Startup"
827 :group 'org)
829 (defcustom org-startup-folded t
830 "Non-nil means entering Org-mode will switch to OVERVIEW.
831 This can also be configured on a per-file basis by adding one of
832 the following lines anywhere in the buffer:
834 #+STARTUP: fold (or `overview', this is equivalent)
835 #+STARTUP: nofold (or `showall', this is equivalent)
836 #+STARTUP: content
837 #+STARTUP: showeverything
839 By default, this option is ignored when Org opens agenda files
840 for the first time. If you want the agenda to honor the startup
841 option, set `org-agenda-inhibit-startup' to nil."
842 :group 'org-startup
843 :type '(choice
844 (const :tag "nofold: show all" nil)
845 (const :tag "fold: overview" t)
846 (const :tag "content: all headlines" content)
847 (const :tag "show everything, even drawers" showeverything)))
849 (defcustom org-startup-truncated t
850 "Non-nil means entering Org-mode will set `truncate-lines'.
851 This is useful since some lines containing links can be very long and
852 uninteresting. Also tables look terrible when wrapped."
853 :group 'org-startup
854 :type 'boolean)
856 (defcustom org-startup-indented nil
857 "Non-nil means turn on `org-indent-mode' on startup.
858 This can also be configured on a per-file basis by adding one of
859 the following lines anywhere in the buffer:
861 #+STARTUP: indent
862 #+STARTUP: noindent"
863 :group 'org-structure
864 :type '(choice
865 (const :tag "Not" nil)
866 (const :tag "Globally (slow on startup in large files)" t)))
868 (defcustom org-use-sub-superscripts t
869 "Non-nil means interpret \"_\" and \"^\" for display.
871 If you want to control how Org exports those characters, see
872 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
873 used to be an alias for `org-export-with-sub-superscripts' in
874 Org <8.0, it is not anymore.
876 When this option is turned on, you can use TeX-like syntax for
877 sub- and superscripts within the buffer. Several characters after
878 \"_\" or \"^\" will be considered as a single item - so grouping
879 with {} is normally not needed. For example, the following things
880 will be parsed as single sub- or superscripts:
882 10^24 or 10^tau several digits will be considered 1 item.
883 10^-12 or 10^-tau a leading sign with digits or a word
884 x^2-y^3 will be read as x^2 - y^3, because items are
885 terminated by almost any nonword/nondigit char.
886 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
888 Still, ambiguity is possible. So when in doubt, use {} to enclose
889 the sub/superscript. If you set this variable to the symbol `{}',
890 the braces are *required* in order to trigger interpretations as
891 sub/superscript. This can be helpful in documents that need \"_\"
892 frequently in plain text."
893 :group 'org-startup
894 :version "24.4"
895 :package-version '(Org . "8.0")
896 :type '(choice
897 (const :tag "Always interpret" t)
898 (const :tag "Only with braces" {})
899 (const :tag "Never interpret" nil)))
901 (defcustom org-startup-with-beamer-mode nil
902 "Non-nil means turn on `org-beamer-mode' on startup.
903 This can also be configured on a per-file basis by adding one of
904 the following lines anywhere in the buffer:
906 #+STARTUP: beamer"
907 :group 'org-startup
908 :version "24.1"
909 :type 'boolean)
911 (defcustom org-startup-align-all-tables nil
912 "Non-nil means align all tables when visiting a file.
913 This is useful when the column width in tables is forced with <N> cookies
914 in table fields. Such tables will look correct only after the first re-align.
915 This can also be configured on a per-file basis by adding one of
916 the following lines anywhere in the buffer:
917 #+STARTUP: align
918 #+STARTUP: noalign"
919 :group 'org-startup
920 :type 'boolean)
922 (defcustom org-startup-with-inline-images nil
923 "Non-nil means show inline images when loading a new Org file.
924 This can also be configured on a per-file basis by adding one of
925 the following lines anywhere in the buffer:
926 #+STARTUP: inlineimages
927 #+STARTUP: noinlineimages"
928 :group 'org-startup
929 :version "24.1"
930 :type 'boolean)
932 (defcustom org-startup-with-latex-preview nil
933 "Non-nil means preview LaTeX fragments when loading a new Org file.
935 This can also be configured on a per-file basis by adding one of
936 the following lines anywhere in the buffer:
937 #+STARTUP: latexpreview
938 #+STARTUP: nolatexpreview"
939 :group 'org-startup
940 :version "24.4"
941 :package-version '(Org . "8.0")
942 :type 'boolean)
944 (defcustom org-insert-mode-line-in-empty-file nil
945 "Non-nil means insert the first line setting Org-mode in empty files.
946 When the function `org-mode' is called interactively in an empty file, this
947 normally means that the file name does not automatically trigger Org-mode.
948 To ensure that the file will always be in Org-mode in the future, a
949 line enforcing Org-mode will be inserted into the buffer, if this option
950 has been set."
951 :group 'org-startup
952 :type 'boolean)
954 (defcustom org-replace-disputed-keys nil
955 "Non-nil means use alternative key bindings for some keys.
956 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
957 These keys are also used by other packages like shift-selection-mode'
958 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
959 If you want to use Org-mode together with one of these other modes,
960 or more generally if you would like to move some Org-mode commands to
961 other keys, set this variable and configure the keys with the variable
962 `org-disputed-keys'.
964 This option is only relevant at load-time of Org-mode, and must be set
965 *before* org.el is loaded. Changing it requires a restart of Emacs to
966 become effective."
967 :group 'org-startup
968 :type 'boolean)
970 (defcustom org-use-extra-keys nil
971 "Non-nil means use extra key sequence definitions for certain commands.
972 This happens automatically if you run XEmacs or if `window-system'
973 is nil. This variable lets you do the same manually. You must
974 set it before loading org.
976 Example: on Carbon Emacs 22 running graphically, with an external
977 keyboard on a Powerbook, the default way of setting M-left might
978 not work for either Alt or ESC. Setting this variable will make
979 it work for ESC."
980 :group 'org-startup
981 :type 'boolean)
983 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
985 (defcustom org-disputed-keys
986 '(([(shift up)] . [(meta p)])
987 ([(shift down)] . [(meta n)])
988 ([(shift left)] . [(meta -)])
989 ([(shift right)] . [(meta +)])
990 ([(control shift right)] . [(meta shift +)])
991 ([(control shift left)] . [(meta shift -)]))
992 "Keys for which Org-mode and other modes compete.
993 This is an alist, cars are the default keys, second element specifies
994 the alternative to use when `org-replace-disputed-keys' is t.
996 Keys can be specified in any syntax supported by `define-key'.
997 The value of this option takes effect only at Org-mode's startup,
998 therefore you'll have to restart Emacs to apply it after changing."
999 :group 'org-startup
1000 :type 'alist)
1002 (defun org-key (key)
1003 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
1004 Or return the original if not disputed.
1005 Also apply the translations defined in `org-xemacs-key-equivalents'."
1006 (when org-replace-disputed-keys
1007 (let* ((nkey (key-description key))
1008 (x (org-find-if (lambda (x)
1009 (equal (key-description (car x)) nkey))
1010 org-disputed-keys)))
1011 (setq key (if x (cdr x) key))))
1012 (when (featurep 'xemacs)
1013 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1014 key)
1016 (defun org-find-if (predicate seq)
1017 (catch 'exit
1018 (while seq
1019 (if (funcall predicate (car seq))
1020 (throw 'exit (car seq))
1021 (pop seq)))))
1023 (defun org-defkey (keymap key def)
1024 "Define a key, possibly translated, as returned by `org-key'."
1025 (define-key keymap (org-key key) def))
1027 (defcustom org-ellipsis nil
1028 "The ellipsis to use in the Org-mode outline.
1029 When nil, just use the standard three dots.
1030 When a string, use that string instead.
1031 When a face, use the standard 3 dots, but with the specified face.
1032 The change affects only Org-mode (which will then use its own display table).
1033 Changing this requires executing `M-x org-mode RET' in a buffer to become
1034 effective."
1035 :group 'org-startup
1036 :type '(choice (const :tag "Default" nil)
1037 (face :tag "Face" :value org-warning)
1038 (string :tag "String" :value "...#")))
1040 (defvar org-display-table nil
1041 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1043 (defgroup org-keywords nil
1044 "Keywords in Org-mode."
1045 :tag "Org Keywords"
1046 :group 'org)
1048 (defcustom org-closed-keep-when-no-todo nil
1049 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1050 :group 'org-todo
1051 :group 'org-keywords
1052 :version "24.4"
1053 :package-version '(Org . "8.0")
1054 :type 'boolean)
1056 (defgroup org-structure nil
1057 "Options concerning the general structure of Org-mode files."
1058 :tag "Org Structure"
1059 :group 'org)
1061 (defgroup org-reveal-location nil
1062 "Options about how to make context of a location visible."
1063 :tag "Org Reveal Location"
1064 :group 'org-structure)
1066 (defconst org-context-choice
1067 '(choice
1068 (const :tag "Always" t)
1069 (const :tag "Never" nil)
1070 (repeat :greedy t :tag "Individual contexts"
1071 (cons
1072 (choice :tag "Context"
1073 (const agenda)
1074 (const org-goto)
1075 (const occur-tree)
1076 (const tags-tree)
1077 (const link-search)
1078 (const mark-goto)
1079 (const bookmark-jump)
1080 (const isearch)
1081 (const default))
1082 (boolean))))
1083 "Contexts for the reveal options.")
1085 (defcustom org-show-hierarchy-above '((default . t))
1086 "Non-nil means show full hierarchy when revealing a location.
1087 Org-mode often shows locations in an org-mode file which might have
1088 been invisible before. When this is set, the hierarchy of headings
1089 above the exposed location is shown.
1090 Turning this off for example for sparse trees makes them very compact.
1091 Instead of t, this can also be an alist specifying this option for different
1092 contexts. Valid contexts are
1093 agenda when exposing an entry from the agenda
1094 org-goto when using the command `org-goto' on key C-c C-j
1095 occur-tree when using the command `org-occur' on key C-c /
1096 tags-tree when constructing a sparse tree based on tags matches
1097 link-search when exposing search matches associated with a link
1098 mark-goto when exposing the jump goal of a mark
1099 bookmark-jump when exposing a bookmark location
1100 isearch when exiting from an incremental search
1101 default default for all contexts not set explicitly"
1102 :group 'org-reveal-location
1103 :type org-context-choice)
1105 (defcustom org-show-following-heading '((default . nil))
1106 "Non-nil means show following heading when revealing a location.
1107 Org-mode often shows locations in an org-mode file which might have
1108 been invisible before. When this is set, the heading following the
1109 match is shown.
1110 Turning this off for example for sparse trees makes them very compact,
1111 but makes it harder to edit the location of the match. In such a case,
1112 use the command \\[org-reveal] to show more context.
1113 Instead of t, this can also be an alist specifying this option for different
1114 contexts. See `org-show-hierarchy-above' for valid contexts."
1115 :group 'org-reveal-location
1116 :type org-context-choice)
1118 (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
1119 "Non-nil means show all sibling heading when revealing a location.
1120 Org-mode often shows locations in an org-mode file which might have
1121 been invisible before. When this is set, the sibling of the current entry
1122 heading are all made visible. If `org-show-hierarchy-above' is t,
1123 the same happens on each level of the hierarchy above the current entry.
1125 By default this is on for the isearch context, off for all other contexts.
1126 Turning this off for example for sparse trees makes them very compact,
1127 but makes it harder to edit the location of the match. In such a case,
1128 use the command \\[org-reveal] to show more context.
1129 Instead of t, this can also be an alist specifying this option for different
1130 contexts. See `org-show-hierarchy-above' for valid contexts."
1131 :group 'org-reveal-location
1132 :type org-context-choice
1133 :version "24.4"
1134 :package-version '(Org . "8.0"))
1136 (defcustom org-show-entry-below '((default . nil))
1137 "Non-nil means show the entry below a headline 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 text below the headline that is
1140 exposed is also shown.
1142 By default this is off for all contexts.
1143 Instead of t, this can also be an alist specifying this option for different
1144 contexts. See `org-show-hierarchy-above' for valid contexts."
1145 :group 'org-reveal-location
1146 :type org-context-choice)
1148 (defcustom org-indirect-buffer-display 'other-window
1149 "How should indirect tree buffers be displayed?
1150 This applies to indirect buffers created with the commands
1151 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1152 Valid values are:
1153 current-window Display in the current window
1154 other-window Just display in another window.
1155 dedicated-frame Create one new frame, and re-use it each time.
1156 new-frame Make a new frame each time. Note that in this case
1157 previously-made indirect buffers are kept, and you need to
1158 kill these buffers yourself."
1159 :group 'org-structure
1160 :group 'org-agenda-windows
1161 :type '(choice
1162 (const :tag "In current window" current-window)
1163 (const :tag "In current frame, other window" other-window)
1164 (const :tag "Each time a new frame" new-frame)
1165 (const :tag "One dedicated frame" dedicated-frame)))
1167 (defcustom org-use-speed-commands nil
1168 "Non-nil means activate single letter commands at beginning of a headline.
1169 This may also be a function to test for appropriate locations where speed
1170 commands should be active.
1172 For example, to activate speed commands when the point is on any
1173 star at the beginning of the headline, you can do this:
1175 (setq org-use-speed-commands
1176 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1177 :group 'org-structure
1178 :type '(choice
1179 (const :tag "Never" nil)
1180 (const :tag "At beginning of headline stars" t)
1181 (function)))
1183 (defcustom org-speed-commands-user nil
1184 "Alist of additional speed commands.
1185 This list will be checked before `org-speed-commands-default'
1186 when the variable `org-use-speed-commands' is non-nil
1187 and when the cursor is at the beginning of a headline.
1188 The car if each entry is a string with a single letter, which must
1189 be assigned to `self-insert-command' in the global map.
1190 The cdr is either a command to be called interactively, a function
1191 to be called, or a form to be evaluated.
1192 An entry that is just a list with a single string will be interpreted
1193 as a descriptive headline that will be added when listing the speed
1194 commands in the Help buffer using the `?' speed command."
1195 :group 'org-structure
1196 :type '(repeat :value ("k" . ignore)
1197 (choice :value ("k" . ignore)
1198 (list :tag "Descriptive Headline" (string :tag "Headline"))
1199 (cons :tag "Letter and Command"
1200 (string :tag "Command letter")
1201 (choice
1202 (function)
1203 (sexp))))))
1205 (defcustom org-bookmark-names-plist
1206 '(:last-capture "org-capture-last-stored"
1207 :last-refile "org-refile-last-stored"
1208 :last-capture-marker "org-capture-last-stored-marker")
1209 "Names for bookmarks automatically set by some Org commands.
1210 This can provide strings as names for a number of bookmarks Org sets
1211 automatically. The following keys are currently implemented:
1212 :last-capture
1213 :last-capture-marker
1214 :last-refile
1215 When a key does not show up in the property list, the corresponding bookmark
1216 is not set."
1217 :group 'org-structure
1218 :type 'plist)
1220 (defgroup org-cycle nil
1221 "Options concerning visibility cycling in Org-mode."
1222 :tag "Org Cycle"
1223 :group 'org-structure)
1225 (defcustom org-cycle-skip-children-state-if-no-children t
1226 "Non-nil means skip CHILDREN state in entries that don't have any."
1227 :group 'org-cycle
1228 :type 'boolean)
1230 (defcustom org-cycle-max-level nil
1231 "Maximum level which should still be subject to visibility cycling.
1232 Levels higher than this will, for cycling, be treated as text, not a headline.
1233 When `org-odd-levels-only' is set, a value of N in this variable actually
1234 means 2N-1 stars as the limiting headline.
1235 When nil, cycle all levels.
1236 Note that the limiting level of cycling is also influenced by
1237 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1238 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1239 than its value."
1240 :group 'org-cycle
1241 :type '(choice
1242 (const :tag "No limit" nil)
1243 (integer :tag "Maximum level")))
1245 (defcustom org-hide-block-startup nil
1246 "Non-nil means entering Org-mode will fold all blocks.
1247 This can also be set in on a per-file basis with
1249 #+STARTUP: hideblocks
1250 #+STARTUP: showblocks"
1251 :group 'org-startup
1252 :group 'org-cycle
1253 :type 'boolean)
1255 (defcustom org-cycle-global-at-bob nil
1256 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1257 This makes it possible to do global cycling without having to use S-TAB or
1258 \\[universal-argument] TAB. For this special case to work, the first line
1259 of the buffer must not be a headline -- it may be empty or some other text.
1260 When used in this way, `org-cycle-hook' is disabled temporarily to make
1261 sure the cursor stays at the beginning of the buffer. When this option is
1262 nil, don't do anything special at the beginning of the buffer."
1263 :group 'org-cycle
1264 :type 'boolean)
1266 (defcustom org-cycle-level-after-item/entry-creation t
1267 "Non-nil means cycle entry level or item indentation in new empty entries.
1269 When the cursor is at the end of an empty headline, i.e., with only stars
1270 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1271 and then all possible ancestor states, before returning to the original state.
1272 This makes data entry extremely fast: M-RET to create a new headline,
1273 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1275 When the cursor is at the end of an empty plain list item, one TAB will
1276 make it a subitem, two or more tabs will back up to make this an item
1277 higher up in the item hierarchy."
1278 :group 'org-cycle
1279 :type 'boolean)
1281 (defcustom org-cycle-emulate-tab t
1282 "Where should `org-cycle' emulate TAB.
1283 nil Never
1284 white Only in completely white lines
1285 whitestart Only at the beginning of lines, before the first non-white char
1286 t Everywhere except in headlines
1287 exc-hl-bol Everywhere except at the start of a headline
1288 If TAB is used in a place where it does not emulate TAB, the current subtree
1289 visibility is cycled."
1290 :group 'org-cycle
1291 :type '(choice (const :tag "Never" nil)
1292 (const :tag "Only in completely white lines" white)
1293 (const :tag "Before first char in a line" whitestart)
1294 (const :tag "Everywhere except in headlines" t)
1295 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1297 (defcustom org-cycle-separator-lines 2
1298 "Number of empty lines needed to keep an empty line between collapsed trees.
1299 If you leave an empty line between the end of a subtree and the following
1300 headline, this empty line is hidden when the subtree is folded.
1301 Org-mode will leave (exactly) one empty line visible if the number of
1302 empty lines is equal or larger to the number given in this variable.
1303 So the default 2 means at least 2 empty lines after the end of a subtree
1304 are needed to produce free space between a collapsed subtree and the
1305 following headline.
1307 If the number is negative, and the number of empty lines is at least -N,
1308 all empty lines are shown.
1310 Special case: when 0, never leave empty lines in collapsed view."
1311 :group 'org-cycle
1312 :type 'integer)
1313 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1315 (defcustom org-pre-cycle-hook nil
1316 "Hook that is run before visibility cycling is happening.
1317 The function(s) in this hook must accept a single argument which indicates
1318 the new state that will be set right after running this hook. The
1319 argument is a symbol. Before a global state change, it can have the values
1320 `overview', `content', or `all'. Before a local state change, it can have
1321 the values `folded', `children', or `subtree'."
1322 :group 'org-cycle
1323 :type 'hook)
1325 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1326 org-cycle-hide-drawers
1327 org-cycle-hide-inline-tasks
1328 org-cycle-show-empty-lines
1329 org-optimize-window-after-visibility-change)
1330 "Hook that is run after `org-cycle' has changed the buffer visibility.
1331 The function(s) in this hook must accept a single argument which indicates
1332 the new state that was set by the most recent `org-cycle' command. The
1333 argument is a symbol. After a global state change, it can have the values
1334 `overview', `contents', or `all'. After a local state change, it can have
1335 the values `folded', `children', or `subtree'."
1336 :group 'org-cycle
1337 :type 'hook)
1339 (defgroup org-edit-structure nil
1340 "Options concerning structure editing in Org-mode."
1341 :tag "Org Edit Structure"
1342 :group 'org-structure)
1344 (defcustom org-odd-levels-only nil
1345 "Non-nil means skip even levels and only use odd levels for the outline.
1346 This has the effect that two stars are being added/taken away in
1347 promotion/demotion commands. It also influences how levels are
1348 handled by the exporters.
1349 Changing it requires restart of `font-lock-mode' to become effective
1350 for fontification also in regions already fontified.
1351 You may also set this on a per-file basis by adding one of the following
1352 lines to the buffer:
1354 #+STARTUP: odd
1355 #+STARTUP: oddeven"
1356 :group 'org-edit-structure
1357 :group 'org-appearance
1358 :type 'boolean)
1360 (defcustom org-adapt-indentation t
1361 "Non-nil means adapt indentation to outline node level.
1363 When this variable is set, Org assumes that you write outlines by
1364 indenting text in each node to align with the headline (after the stars).
1365 The following issues are influenced by this variable:
1367 - When this is set and the *entire* text in an entry is indented, the
1368 indentation is increased by one space in a demotion command, and
1369 decreased by one in a promotion command. If any line in the entry
1370 body starts with text at column 0, indentation is not changed at all.
1372 - Property drawers and planning information is inserted indented when
1373 this variable s set. When nil, they will not be indented.
1375 - TAB indents a line relative to context. The lines below a headline
1376 will be indented when this variable is set.
1378 Note that this is all about true indentation, by adding and removing
1379 space characters. See also `org-indent.el' which does level-dependent
1380 indentation in a virtual way, i.e. at display time in Emacs."
1381 :group 'org-edit-structure
1382 :type 'boolean)
1384 (defcustom org-special-ctrl-a/e nil
1385 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1387 When t, `C-a' will bring back the cursor to the beginning of the
1388 headline text, i.e. after the stars and after a possible TODO
1389 keyword. In an item, this will be the position after bullet and
1390 check-box, if any. When the cursor is already at that position,
1391 another `C-a' will bring it to the beginning of the line.
1393 `C-e' will jump to the end of the headline, ignoring the presence
1394 of tags in the headline. A second `C-e' will then jump to the
1395 true end of the line, after any tags. This also means that, when
1396 this variable is non-nil, `C-e' also will never jump beyond the
1397 end of the heading of a folded section, i.e. not after the
1398 ellipses.
1400 When set to the symbol `reversed', the first `C-a' or `C-e' works
1401 normally, going to the true line boundary first. Only a directly
1402 following, identical keypress will bring the cursor to the
1403 special positions.
1405 This may also be a cons cell where the behavior for `C-a' and
1406 `C-e' is set separately."
1407 :group 'org-edit-structure
1408 :type '(choice
1409 (const :tag "off" nil)
1410 (const :tag "on: after stars/bullet and before tags first" t)
1411 (const :tag "reversed: true line boundary first" reversed)
1412 (cons :tag "Set C-a and C-e separately"
1413 (choice :tag "Special C-a"
1414 (const :tag "off" nil)
1415 (const :tag "on: after stars/bullet first" t)
1416 (const :tag "reversed: before stars/bullet first" reversed))
1417 (choice :tag "Special C-e"
1418 (const :tag "off" nil)
1419 (const :tag "on: before tags first" t)
1420 (const :tag "reversed: after tags first" reversed)))))
1421 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1423 (defcustom org-special-ctrl-k nil
1424 "Non-nil means `C-k' will behave specially in headlines.
1425 When nil, `C-k' will call the default `kill-line' command.
1426 When t, the following will happen while the cursor is in the headline:
1428 - When the cursor is at the beginning of a headline, kill the entire
1429 line and possible the folded subtree below the line.
1430 - When in the middle of the headline text, kill the headline up to the tags.
1431 - When after the headline text, kill the tags."
1432 :group 'org-edit-structure
1433 :type 'boolean)
1435 (defcustom org-ctrl-k-protect-subtree nil
1436 "Non-nil means, do not delete a hidden subtree with C-k.
1437 When set to the symbol `error', simply throw an error when C-k is
1438 used to kill (part-of) a headline that has hidden text behind it.
1439 Any other non-nil value will result in a query to the user, if it is
1440 OK to kill that hidden subtree. When nil, kill without remorse."
1441 :group 'org-edit-structure
1442 :version "24.1"
1443 :type '(choice
1444 (const :tag "Do not protect hidden subtrees" nil)
1445 (const :tag "Protect hidden subtrees with a security query" t)
1446 (const :tag "Never kill a hidden subtree with C-k" error)))
1448 (defcustom org-special-ctrl-o t
1449 "Non-nil means, make `C-o' insert a row in tables."
1450 :group 'org-edit-structure
1451 :type 'boolean)
1453 (defcustom org-catch-invisible-edits nil
1454 "Check if in invisible region before inserting or deleting a character.
1455 Valid values are:
1457 nil Do not check, so just do invisible edits.
1458 error Throw an error and do nothing.
1459 show Make point visible, and do the requested edit.
1460 show-and-error Make point visible, then throw an error and abort the edit.
1461 smart Make point visible, and do insertion/deletion if it is
1462 adjacent to visible text and the change feels predictable.
1463 Never delete a previously invisible character or add in the
1464 middle or right after an invisible region. Basically, this
1465 allows insertion and backward-delete right before ellipses.
1466 FIXME: maybe in this case we should not even show?"
1467 :group 'org-edit-structure
1468 :version "24.1"
1469 :type '(choice
1470 (const :tag "Do not check" nil)
1471 (const :tag "Throw error when trying to edit" error)
1472 (const :tag "Unhide, but do not do the edit" show-and-error)
1473 (const :tag "Show invisible part and do the edit" show)
1474 (const :tag "Be smart and do the right thing" smart)))
1476 (defcustom org-yank-folded-subtrees t
1477 "Non-nil means when yanking subtrees, fold them.
1478 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1479 it starts with a heading and all other headings in it are either children
1480 or siblings, then fold all the subtrees. However, do this only if no
1481 text after the yank would be swallowed into a folded tree by this action."
1482 :group 'org-edit-structure
1483 :type 'boolean)
1485 (defcustom org-yank-adjusted-subtrees nil
1486 "Non-nil means when yanking subtrees, adjust the level.
1487 With this setting, `org-paste-subtree' is used to insert the subtree, see
1488 this function for details."
1489 :group 'org-edit-structure
1490 :type 'boolean)
1492 (defcustom org-M-RET-may-split-line '((default . t))
1493 "Non-nil means M-RET will split the line at the cursor position.
1494 When nil, it will go to the end of the line before making a
1495 new line.
1496 You may also set this option in a different way for different
1497 contexts. Valid contexts are:
1499 headline when creating a new headline
1500 item when creating a new item
1501 table in a table field
1502 default the value to be used for all contexts not explicitly
1503 customized"
1504 :group 'org-structure
1505 :group 'org-table
1506 :type '(choice
1507 (const :tag "Always" t)
1508 (const :tag "Never" nil)
1509 (repeat :greedy t :tag "Individual contexts"
1510 (cons
1511 (choice :tag "Context"
1512 (const headline)
1513 (const item)
1514 (const table)
1515 (const default))
1516 (boolean)))))
1519 (defcustom org-insert-heading-respect-content nil
1520 "Non-nil means insert new headings after the current subtree.
1521 When nil, the new heading is created directly after the current line.
1522 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1523 this variable on for the duration of the command."
1524 :group 'org-structure
1525 :type 'boolean)
1527 (defcustom org-blank-before-new-entry '((heading . auto)
1528 (plain-list-item . auto))
1529 "Should `org-insert-heading' leave a blank line before new heading/item?
1530 The value is an alist, with `heading' and `plain-list-item' as CAR,
1531 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1532 which case Org will look at the surrounding headings/items and try to
1533 make an intelligent decision whether to insert a blank line or not.
1535 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1536 the setting here is ignored and no empty line is inserted to avoid breaking
1537 the list structure."
1538 :group 'org-edit-structure
1539 :type '(list
1540 (cons (const heading)
1541 (choice (const :tag "Never" nil)
1542 (const :tag "Always" t)
1543 (const :tag "Auto" auto)))
1544 (cons (const plain-list-item)
1545 (choice (const :tag "Never" nil)
1546 (const :tag "Always" t)
1547 (const :tag "Auto" auto)))))
1549 (defcustom org-insert-heading-hook nil
1550 "Hook being run after inserting a new heading."
1551 :group 'org-edit-structure
1552 :type 'hook)
1554 (defcustom org-enable-fixed-width-editor t
1555 "Non-nil means lines starting with \":\" are treated as fixed-width.
1556 This currently only means they are never auto-wrapped.
1557 When nil, such lines will be treated like ordinary lines.
1558 See also the QUOTE keyword."
1559 :group 'org-edit-structure
1560 :type 'boolean)
1562 (defcustom org-goto-auto-isearch t
1563 "Non-nil means typing characters in `org-goto' starts incremental search.
1564 When nil, you can use these keybindings to navigate the buffer:
1566 q Quit the org-goto interface
1567 n Go to the next visible heading
1568 p Go to the previous visible heading
1569 f Go one heading forward on same level
1570 b Go one heading backward on same level
1571 u Go one heading up"
1572 :group 'org-edit-structure
1573 :type 'boolean)
1575 (defgroup org-sparse-trees nil
1576 "Options concerning sparse trees in Org-mode."
1577 :tag "Org Sparse Trees"
1578 :group 'org-structure)
1580 (defcustom org-highlight-sparse-tree-matches t
1581 "Non-nil means highlight all matches that define a sparse tree.
1582 The highlights will automatically disappear the next time the buffer is
1583 changed by an edit command."
1584 :group 'org-sparse-trees
1585 :type 'boolean)
1587 (defcustom org-remove-highlights-with-change t
1588 "Non-nil means any change to the buffer will remove temporary highlights.
1589 Such highlights are created by `org-occur' and `org-clock-display'.
1590 When nil, `C-c C-c needs to be used to get rid of the highlights.
1591 The highlights created by `org-preview-latex-fragment' always need
1592 `C-c C-c' to be removed."
1593 :group 'org-sparse-trees
1594 :group 'org-time
1595 :type 'boolean)
1598 (defcustom org-occur-hook '(org-first-headline-recenter)
1599 "Hook that is run after `org-occur' has constructed a sparse tree.
1600 This can be used to recenter the window to show as much of the structure
1601 as possible."
1602 :group 'org-sparse-trees
1603 :type 'hook)
1605 (defgroup org-imenu-and-speedbar nil
1606 "Options concerning imenu and speedbar in Org-mode."
1607 :tag "Org Imenu and Speedbar"
1608 :group 'org-structure)
1610 (defcustom org-imenu-depth 2
1611 "The maximum level for Imenu access to Org-mode headlines.
1612 This also applied for speedbar access."
1613 :group 'org-imenu-and-speedbar
1614 :type 'integer)
1616 (defgroup org-table nil
1617 "Options concerning tables in Org-mode."
1618 :tag "Org Table"
1619 :group 'org)
1621 (defcustom org-enable-table-editor 'optimized
1622 "Non-nil means lines starting with \"|\" are handled by the table editor.
1623 When nil, such lines will be treated like ordinary lines.
1625 When equal to the symbol `optimized', the table editor will be optimized to
1626 do the following:
1627 - Automatic overwrite mode in front of whitespace in table fields.
1628 This makes the structure of the table stay in tact as long as the edited
1629 field does not exceed the column width.
1630 - Minimize the number of realigns. Normally, the table is aligned each time
1631 TAB or RET are pressed to move to another field. With optimization this
1632 happens only if changes to a field might have changed the column width.
1633 Optimization requires replacing the functions `self-insert-command',
1634 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1635 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1636 very good at guessing when a re-align will be necessary, but you can always
1637 force one with \\[org-ctrl-c-ctrl-c].
1639 If you would like to use the optimized version in Org-mode, but the
1640 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1642 This variable can be used to turn on and off the table editor during a session,
1643 but in order to toggle optimization, a restart is required.
1645 See also the variable `org-table-auto-blank-field'."
1646 :group 'org-table
1647 :type '(choice
1648 (const :tag "off" nil)
1649 (const :tag "on" t)
1650 (const :tag "on, optimized" optimized)))
1652 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1653 (version<= emacs-version "24.1"))
1654 "Non-nil means cluster self-insert commands for undo when possible.
1655 If this is set, then, like in the Emacs command loop, 20 consecutive
1656 characters will be undone together.
1657 This is configurable, because there is some impact on typing performance."
1658 :group 'org-table
1659 :type 'boolean)
1661 (defcustom org-table-tab-recognizes-table.el t
1662 "Non-nil means TAB will automatically notice a table.el table.
1663 When it sees such a table, it moves point into it and - if necessary -
1664 calls `table-recognize-table'."
1665 :group 'org-table-editing
1666 :type 'boolean)
1668 (defgroup org-link nil
1669 "Options concerning links in Org-mode."
1670 :tag "Org Link"
1671 :group 'org)
1673 (defvar org-link-abbrev-alist-local nil
1674 "Buffer-local version of `org-link-abbrev-alist', which see.
1675 The value of this is taken from the #+LINK lines.")
1676 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1678 (defcustom org-link-abbrev-alist nil
1679 "Alist of link abbreviations.
1680 The car of each element is a string, to be replaced at the start of a link.
1681 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1682 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1684 [[linkkey:tag][description]]
1686 The 'linkkey' must be a word word, starting with a letter, followed
1687 by letters, numbers, '-' or '_'.
1689 If REPLACE is a string, the tag will simply be appended to create the link.
1690 If the string contains \"%s\", the tag will be inserted there. If the string
1691 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1692 at that point (see the function `url-hexify-string'). If the string contains
1693 the specifier \"%(my-function)\", then the custom function `my-function' will
1694 be invoked: this function takes the tag as its only argument and must return
1695 a string.
1697 REPLACE may also be a function that will be called with the tag as the
1698 only argument to create the link, which should be returned as a string.
1700 See the manual for examples."
1701 :group 'org-link
1702 :type '(repeat
1703 (cons
1704 (string :tag "Protocol")
1705 (choice
1706 (string :tag "Format")
1707 (function)))))
1709 (defcustom org-descriptive-links t
1710 "Non-nil means Org will display descriptive links.
1711 E.g. [[http://orgmode.org][Org website]] will be displayed as
1712 \"Org Website\", hiding the link itself and just displaying its
1713 description. When set to `nil', Org will display the full links
1714 literally.
1716 You can interactively set the value of this variable by calling
1717 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1718 :group 'org-link
1719 :type 'boolean)
1721 (defcustom org-link-file-path-type 'adaptive
1722 "How the path name in file links should be stored.
1723 Valid values are:
1725 relative Relative to the current directory, i.e. the directory of the file
1726 into which the link is being inserted.
1727 absolute Absolute path, if possible with ~ for home directory.
1728 noabbrev Absolute path, no abbreviation of home directory.
1729 adaptive Use relative path for files in the current directory and sub-
1730 directories of it. For other files, use an absolute path."
1731 :group 'org-link
1732 :type '(choice
1733 (const relative)
1734 (const absolute)
1735 (const noabbrev)
1736 (const adaptive)))
1738 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1739 "Types of links that should be activated in Org-mode files.
1740 This is a list of symbols, each leading to the activation of a certain link
1741 type. In principle, it does not hurt to turn on most link types - there may
1742 be a small gain when turning off unused link types. The types are:
1744 bracket The recommended [[link][description]] or [[link]] links with hiding.
1745 angle Links in angular brackets that may contain whitespace like
1746 <bbdb:Carsten Dominik>.
1747 plain Plain links in normal text, no whitespace, like http://google.com.
1748 radio Text that is matched by a radio target, see manual for details.
1749 tag Tag settings in a headline (link to tag search).
1750 date Time stamps (link to calendar).
1751 footnote Footnote labels.
1753 Changing this variable requires a restart of Emacs to become effective."
1754 :group 'org-link
1755 :type '(set :greedy t
1756 (const :tag "Double bracket links" bracket)
1757 (const :tag "Angular bracket links" angle)
1758 (const :tag "Plain text links" plain)
1759 (const :tag "Radio target matches" radio)
1760 (const :tag "Tags" tag)
1761 (const :tag "Timestamps" date)
1762 (const :tag "Footnotes" footnote)))
1764 (defcustom org-make-link-description-function nil
1765 "Function to use for generating link descriptions from links.
1766 When nil, the link location will be used. This function must take
1767 two parameters: the first one is the link, the second one is the
1768 description generated by `org-insert-link'. The function should
1769 return the description to use."
1770 :group 'org-link
1771 :type '(choice (const nil) (function)))
1773 (defgroup org-link-store nil
1774 "Options concerning storing links in Org-mode."
1775 :tag "Org Store Link"
1776 :group 'org-link)
1778 (defcustom org-url-hexify-p t
1779 "When non-nil, hexify URL when creating a link."
1780 :type 'boolean
1781 :version "24.3"
1782 :group 'org-link-store)
1784 (defcustom org-email-link-description-format "Email %c: %.30s"
1785 "Format of the description part of a link to an email or usenet message.
1786 The following %-escapes will be replaced by corresponding information:
1788 %F full \"From\" field
1789 %f name, taken from \"From\" field, address if no name
1790 %T full \"To\" field
1791 %t first name in \"To\" field, address if no name
1792 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1793 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1794 %s subject
1795 %d date
1796 %m message-id.
1798 You may use normal field width specification between the % and the letter.
1799 This is for example useful to limit the length of the subject.
1801 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1802 :group 'org-link-store
1803 :type 'string)
1805 (defcustom org-from-is-user-regexp
1806 (let (r1 r2)
1807 (when (and user-mail-address (not (string= user-mail-address "")))
1808 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1809 (when (and user-full-name (not (string= user-full-name "")))
1810 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1811 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1812 "Regexp matched against the \"From:\" header of an email or usenet message.
1813 It should match if the message is from the user him/herself."
1814 :group 'org-link-store
1815 :type 'regexp)
1817 (defcustom org-context-in-file-links t
1818 "Non-nil means file links from `org-store-link' contain context.
1819 A search string will be added to the file name with :: as separator and
1820 used to find the context when the link is activated by the command
1821 `org-open-at-point'. When this option is t, the entire active region
1822 will be placed in the search string of the file link. If set to a
1823 positive integer, only the first n lines of context will be stored.
1825 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1826 negates this setting for the duration of the command."
1827 :group 'org-link-store
1828 :type '(choice boolean integer))
1830 (defcustom org-keep-stored-link-after-insertion nil
1831 "Non-nil means keep link in list for entire session.
1833 The command `org-store-link' adds a link pointing to the current
1834 location to an internal list. These links accumulate during a session.
1835 The command `org-insert-link' can be used to insert links into any
1836 Org-mode file (offering completion for all stored links). When this
1837 option is nil, every link which has been inserted once using \\[org-insert-link]
1838 will be removed from the list, to make completing the unused links
1839 more efficient."
1840 :group 'org-link-store
1841 :type 'boolean)
1843 (defgroup org-link-follow nil
1844 "Options concerning following links in Org-mode."
1845 :tag "Org Follow Link"
1846 :group 'org-link)
1848 (defcustom org-link-translation-function nil
1849 "Function to translate links with different syntax to Org syntax.
1850 This can be used to translate links created for example by the Planner
1851 or emacs-wiki packages to Org syntax.
1852 The function must accept two parameters, a TYPE containing the link
1853 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1854 which is everything after the link protocol. It should return a cons
1855 with possibly modified values of type and path.
1856 Org contains a function for this, so if you set this variable to
1857 `org-translate-link-from-planner', you should be able follow many
1858 links created by planner."
1859 :group 'org-link-follow
1860 :type '(choice (const nil) (function)))
1862 (defcustom org-follow-link-hook nil
1863 "Hook that is run after a link has been followed."
1864 :group 'org-link-follow
1865 :type 'hook)
1867 (defcustom org-tab-follows-link nil
1868 "Non-nil means on links TAB will follow the link.
1869 Needs to be set before org.el is loaded.
1870 This really should not be used, it does not make sense, and the
1871 implementation is bad."
1872 :group 'org-link-follow
1873 :type 'boolean)
1875 (defcustom org-return-follows-link nil
1876 "Non-nil means on links RET will follow the link.
1877 In tables, the special behavior of RET has precedence."
1878 :group 'org-link-follow
1879 :type 'boolean)
1881 (defcustom org-mouse-1-follows-link
1882 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1883 "Non-nil means mouse-1 on a link will follow the link.
1884 A longer mouse click will still set point. Does not work on XEmacs.
1885 Needs to be set before org.el is loaded."
1886 :group 'org-link-follow
1887 :version "24.4"
1888 :package-version '(Org . "8.3")
1889 :type '(choice
1890 (const :tag "A double click follows the link" double)
1891 (const :tag "Unconditionally follow the link with mouse-1" t)
1892 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1894 (defcustom org-mark-ring-length 4
1895 "Number of different positions to be recorded in the ring.
1896 Changing this requires a restart of Emacs to work correctly."
1897 :group 'org-link-follow
1898 :type 'integer)
1900 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1901 "Non-nil means internal links in Org files must exactly match a headline.
1902 When nil, the link search tries to match a phrase with all words
1903 in the search text."
1904 :group 'org-link-follow
1905 :version "24.1"
1906 :type '(choice
1907 (const :tag "Use fuzzy text search" nil)
1908 (const :tag "Match only exact headline" t)
1909 (const :tag "Match exact headline or query to create it"
1910 query-to-create)))
1912 (defcustom org-link-frame-setup
1913 '((vm . vm-visit-folder-other-frame)
1914 (vm-imap . vm-visit-imap-folder-other-frame)
1915 (gnus . org-gnus-no-new-news)
1916 (file . find-file-other-window)
1917 (wl . wl-other-frame))
1918 "Setup the frame configuration for following links.
1919 When following a link with Emacs, it may often be useful to display
1920 this link in another window or frame. This variable can be used to
1921 set this up for the different types of links.
1922 For VM, use any of
1923 `vm-visit-folder'
1924 `vm-visit-folder-other-window'
1925 `vm-visit-folder-other-frame'
1926 For Gnus, use any of
1927 `gnus'
1928 `gnus-other-frame'
1929 `org-gnus-no-new-news'
1930 For FILE, use any of
1931 `find-file'
1932 `find-file-other-window'
1933 `find-file-other-frame'
1934 For Wanderlust use any of
1935 `wl'
1936 `wl-other-frame'
1937 For the calendar, use the variable `calendar-setup'.
1938 For BBDB, it is currently only possible to display the matches in
1939 another window."
1940 :group 'org-link-follow
1941 :type '(list
1942 (cons (const vm)
1943 (choice
1944 (const vm-visit-folder)
1945 (const vm-visit-folder-other-window)
1946 (const vm-visit-folder-other-frame)))
1947 (cons (const vm-imap)
1948 (choice
1949 (const vm-visit-imap-folder)
1950 (const vm-visit-imap-folder-other-window)
1951 (const vm-visit-imap-folder-other-frame)))
1952 (cons (const gnus)
1953 (choice
1954 (const gnus)
1955 (const gnus-other-frame)
1956 (const org-gnus-no-new-news)))
1957 (cons (const file)
1958 (choice
1959 (const find-file)
1960 (const find-file-other-window)
1961 (const find-file-other-frame)))
1962 (cons (const wl)
1963 (choice
1964 (const wl)
1965 (const wl-other-frame)))))
1967 (defcustom org-display-internal-link-with-indirect-buffer nil
1968 "Non-nil means use indirect buffer to display infile links.
1969 Activating internal links (from one location in a file to another location
1970 in the same file) normally just jumps to the location. When the link is
1971 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1972 is displayed in
1973 another window. When this option is set, the other window actually displays
1974 an indirect buffer clone of the current buffer, to avoid any visibility
1975 changes to the current buffer."
1976 :group 'org-link-follow
1977 :type 'boolean)
1979 (defcustom org-open-non-existing-files nil
1980 "Non-nil means `org-open-file' will open non-existing files.
1981 When nil, an error will be generated.
1982 This variable applies only to external applications because they
1983 might choke on non-existing files. If the link is to a file that
1984 will be opened in Emacs, the variable is ignored."
1985 :group 'org-link-follow
1986 :type 'boolean)
1988 (defcustom org-open-directory-means-index-dot-org nil
1989 "Non-nil means a link to a directory really means to index.org.
1990 When nil, following a directory link will run dired or open a finder/explorer
1991 window on that directory."
1992 :group 'org-link-follow
1993 :type 'boolean)
1995 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1996 "Function and arguments to call for following mailto links.
1997 This is a list with the first element being a Lisp function, and the
1998 remaining elements being arguments to the function. In string arguments,
1999 %a will be replaced by the address, and %s will be replaced by the subject
2000 if one was given like in <mailto:arthur@galaxy.org::this subject>."
2001 :group 'org-link-follow
2002 :type '(choice
2003 (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
2004 (const :tag "compose-mail" (compose-mail "%a" "%s"))
2005 (const :tag "message-mail" (message-mail "%a" "%s"))
2006 (cons :tag "other" (function) (repeat :tag "argument" sexp))))
2008 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2009 "Non-nil means ask for confirmation before executing shell links.
2010 Shell links can be dangerous: just think about a link
2012 [[shell:rm -rf ~/*][Google Search]]
2014 This link would show up in your Org-mode document as \"Google Search\",
2015 but really it would remove your entire home directory.
2016 Therefore we advise against setting this variable to nil.
2017 Just change it to `y-or-n-p' if you want to confirm with a
2018 single keystroke rather than having to type \"yes\"."
2019 :group 'org-link-follow
2020 :type '(choice
2021 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2022 (const :tag "with y-or-n (faster)" y-or-n-p)
2023 (const :tag "no confirmation (dangerous)" nil)))
2024 (put 'org-confirm-shell-link-function
2025 'safe-local-variable
2026 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2028 (defcustom org-confirm-shell-link-not-regexp ""
2029 "A regexp to skip confirmation for shell links."
2030 :group 'org-link-follow
2031 :version "24.1"
2032 :type 'regexp)
2034 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2035 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2036 Elisp links can be dangerous: just think about a link
2038 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2040 This link would show up in your Org-mode document as \"Google Search\",
2041 but really it would remove your entire home directory.
2042 Therefore we advise against setting this variable to nil.
2043 Just change it to `y-or-n-p' if you want to confirm with a
2044 single keystroke rather than having to type \"yes\"."
2045 :group 'org-link-follow
2046 :type '(choice
2047 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2048 (const :tag "with y-or-n (faster)" y-or-n-p)
2049 (const :tag "no confirmation (dangerous)" nil)))
2050 (put 'org-confirm-shell-link-function
2051 'safe-local-variable
2052 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2054 (defcustom org-confirm-elisp-link-not-regexp ""
2055 "A regexp to skip confirmation for Elisp links."
2056 :group 'org-link-follow
2057 :version "24.1"
2058 :type 'regexp)
2060 (defconst org-file-apps-defaults-gnu
2061 '((remote . emacs)
2062 (system . mailcap)
2063 (t . mailcap))
2064 "Default file applications on a UNIX or GNU/Linux system.
2065 See `org-file-apps'.")
2067 (defconst org-file-apps-defaults-macosx
2068 '((remote . emacs)
2069 (t . "open %s")
2070 (system . "open %s")
2071 ("ps.gz" . "gv %s")
2072 ("eps.gz" . "gv %s")
2073 ("dvi" . "xdvi %s")
2074 ("fig" . "xfig %s"))
2075 "Default file applications on a MacOS X system.
2076 The system \"open\" is known as a default, but we use X11 applications
2077 for some files for which the OS does not have a good default.
2078 See `org-file-apps'.")
2080 (defconst org-file-apps-defaults-windowsnt
2081 (list
2082 '(remote . emacs)
2083 (cons t
2084 (list (if (featurep 'xemacs)
2085 'mswindows-shell-execute
2086 'w32-shell-execute)
2087 "open" 'file))
2088 (cons 'system
2089 (list (if (featurep 'xemacs)
2090 'mswindows-shell-execute
2091 'w32-shell-execute)
2092 "open" 'file)))
2093 "Default file applications on a Windows NT system.
2094 The system \"open\" is used for most files.
2095 See `org-file-apps'.")
2097 (defcustom org-file-apps
2098 '((auto-mode . emacs)
2099 ("\\.mm\\'" . default)
2100 ("\\.x?html?\\'" . default)
2101 ("\\.pdf\\'" . default))
2102 "External applications for opening `file:path' items in a document.
2103 Org-mode uses system defaults for different file types, but
2104 you can use this variable to set the application for a given file
2105 extension. The entries in this list are cons cells where the car identifies
2106 files and the cdr the corresponding command. Possible values for the
2107 file identifier are
2108 \"string\" A string as a file identifier can be interpreted in different
2109 ways, depending on its contents:
2111 - Alphanumeric characters only:
2112 Match links with this file extension.
2113 Example: (\"pdf\" . \"evince %s\")
2114 to open PDFs with evince.
2116 - Regular expression: Match links where the
2117 filename matches the regexp. If you want to
2118 use groups here, use shy groups.
2120 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2121 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2122 to open *.html and *.xhtml with firefox.
2124 - Regular expression which contains (non-shy) groups:
2125 Match links where the whole link, including \"::\", and
2126 anything after that, matches the regexp.
2127 In a custom command string, %1, %2, etc. are replaced with
2128 the parts of the link that were matched by the groups.
2129 For backwards compatibility, if a command string is given
2130 that does not use any of the group matches, this case is
2131 handled identically to the second one (i.e. match against
2132 file name only).
2133 In a custom lisp form, you can access the group matches with
2134 (match-string n link).
2136 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2137 to open [[file:document.pdf::5]] with evince at page 5.
2139 `directory' Matches a directory
2140 `remote' Matches a remote file, accessible through tramp or efs.
2141 Remote files most likely should be visited through Emacs
2142 because external applications cannot handle such paths.
2143 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2144 so all files Emacs knows how to handle. Using this with
2145 command `emacs' will open most files in Emacs. Beware that this
2146 will also open html files inside Emacs, unless you add
2147 (\"html\" . default) to the list as well.
2148 t Default for files not matched by any of the other options.
2149 `system' The system command to open files, like `open' on Windows
2150 and Mac OS X, and mailcap under GNU/Linux. This is the command
2151 that will be selected if you call `C-c C-o' with a double
2152 \\[universal-argument] \\[universal-argument] prefix.
2154 Possible values for the command are:
2155 `emacs' The file will be visited by the current Emacs process.
2156 `default' Use the default application for this file type, which is the
2157 association for t in the list, most likely in the system-specific
2158 part.
2159 This can be used to overrule an unwanted setting in the
2160 system-specific variable.
2161 `system' Use the system command for opening files, like \"open\".
2162 This command is specified by the entry whose car is `system'.
2163 Most likely, the system-specific version of this variable
2164 does define this command, but you can overrule/replace it
2165 here.
2166 string A command to be executed by a shell; %s will be replaced
2167 by the path to the file.
2168 sexp A Lisp form which will be evaluated. The file path will
2169 be available in the Lisp variable `file'.
2170 For more examples, see the system specific constants
2171 `org-file-apps-defaults-macosx'
2172 `org-file-apps-defaults-windowsnt'
2173 `org-file-apps-defaults-gnu'."
2174 :group 'org-link-follow
2175 :type '(repeat
2176 (cons (choice :value ""
2177 (string :tag "Extension")
2178 (const :tag "System command to open files" system)
2179 (const :tag "Default for unrecognized files" t)
2180 (const :tag "Remote file" remote)
2181 (const :tag "Links to a directory" directory)
2182 (const :tag "Any files that have Emacs modes"
2183 auto-mode))
2184 (choice :value ""
2185 (const :tag "Visit with Emacs" emacs)
2186 (const :tag "Use default" default)
2187 (const :tag "Use the system command" system)
2188 (string :tag "Command")
2189 (sexp :tag "Lisp form")))))
2191 (defcustom org-doi-server-url "http://dx.doi.org/"
2192 "The URL of the DOI server."
2193 :type 'string
2194 :version "24.3"
2195 :group 'org-link-follow)
2197 (defgroup org-refile nil
2198 "Options concerning refiling entries in Org-mode."
2199 :tag "Org Refile"
2200 :group 'org)
2202 (defcustom org-directory "~/org"
2203 "Directory with org files.
2204 This is just a default location to look for Org files. There is no need
2205 at all to put your files into this directory. It is only used in the
2206 following situations:
2208 1. When a capture template specifies a target file that is not an
2209 absolute path. The path will then be interpreted relative to
2210 `org-directory'
2211 2. When a capture note is filed away in an interactive way (when exiting the
2212 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2213 with `org-directory' as the default path."
2214 :group 'org-refile
2215 :group 'org-capture
2216 :type 'directory)
2218 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2219 "Default target for storing notes.
2220 Used as a fall back file for org-capture.el, for templates that
2221 do not specify a target file."
2222 :group 'org-refile
2223 :group 'org-capture
2224 :type '(choice
2225 (const :tag "Default from remember-data-file" nil)
2226 file))
2228 (defcustom org-goto-interface 'outline
2229 "The default interface to be used for `org-goto'.
2230 Allowed values are:
2231 outline The interface shows an outline of the relevant file
2232 and the correct heading is found by moving through
2233 the outline or by searching with incremental search.
2234 outline-path-completion Headlines in the current buffer are offered via
2235 completion. This is the interface also used by
2236 the refile command."
2237 :group 'org-refile
2238 :type '(choice
2239 (const :tag "Outline" outline)
2240 (const :tag "Outline-path-completion" outline-path-completion)))
2242 (defcustom org-goto-max-level 5
2243 "Maximum target level when running `org-goto' with refile interface."
2244 :group 'org-refile
2245 :type 'integer)
2247 (defcustom org-reverse-note-order nil
2248 "Non-nil means store new notes at the beginning of a file or entry.
2249 When nil, new notes will be filed to the end of a file or entry.
2250 This can also be a list with cons cells of regular expressions that
2251 are matched against file names, and values."
2252 :group 'org-capture
2253 :group 'org-refile
2254 :type '(choice
2255 (const :tag "Reverse always" t)
2256 (const :tag "Reverse never" nil)
2257 (repeat :tag "By file name regexp"
2258 (cons regexp boolean))))
2260 (defcustom org-log-refile nil
2261 "Information to record when a task is refiled.
2263 Possible values are:
2265 nil Don't add anything
2266 time Add a time stamp to the task
2267 note Prompt for a note and add it with template `org-log-note-headings'
2269 This option can also be set with on a per-file-basis with
2271 #+STARTUP: nologrefile
2272 #+STARTUP: logrefile
2273 #+STARTUP: lognoterefile
2275 You can have local logging settings for a subtree by setting the LOGGING
2276 property to one or more of these keywords.
2278 When bulk-refiling from the agenda, the value `note' is forbidden and
2279 will temporarily be changed to `time'."
2280 :group 'org-refile
2281 :group 'org-progress
2282 :version "24.1"
2283 :type '(choice
2284 (const :tag "No logging" nil)
2285 (const :tag "Record timestamp" time)
2286 (const :tag "Record timestamp with note." note)))
2288 (defcustom org-refile-targets nil
2289 "Targets for refiling entries with \\[org-refile].
2290 This is a list of cons cells. Each cell contains:
2291 - a specification of the files to be considered, either a list of files,
2292 or a symbol whose function or variable value will be used to retrieve
2293 a file name or a list of file names. If you use `org-agenda-files' for
2294 that, all agenda files will be scanned for targets. Nil means consider
2295 headings in the current buffer.
2296 - A specification of how to find candidate refile targets. This may be
2297 any of:
2298 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2299 This tag has to be present in all target headlines, inheritance will
2300 not be considered.
2301 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2302 todo keyword.
2303 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2304 headlines that are refiling targets.
2305 - a cons cell (:level . N). Any headline of level N is considered a target.
2306 Note that, when `org-odd-levels-only' is set, level corresponds to
2307 order in hierarchy, not to the number of stars.
2308 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2309 Note that, when `org-odd-levels-only' is set, level corresponds to
2310 order in hierarchy, not to the number of stars.
2312 Each element of this list generates a set of possible targets.
2313 The union of these sets is presented (with completion) to
2314 the user by `org-refile'.
2316 You can set the variable `org-refile-target-verify-function' to a function
2317 to verify each headline found by the simple criteria above.
2319 When this variable is nil, all top-level headlines in the current buffer
2320 are used, equivalent to the value `((nil . (:level . 1))'."
2321 :group 'org-refile
2322 :type '(repeat
2323 (cons
2324 (choice :value org-agenda-files
2325 (const :tag "All agenda files" org-agenda-files)
2326 (const :tag "Current buffer" nil)
2327 (function) (variable) (file))
2328 (choice :tag "Identify target headline by"
2329 (cons :tag "Specific tag" (const :value :tag) (string))
2330 (cons :tag "TODO keyword" (const :value :todo) (string))
2331 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2332 (cons :tag "Level number" (const :value :level) (integer))
2333 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2335 (defcustom org-refile-target-verify-function nil
2336 "Function to verify if the headline at point should be a refile target.
2337 The function will be called without arguments, with point at the
2338 beginning of the headline. It should return t and leave point
2339 where it is if the headline is a valid target for refiling.
2341 If the target should not be selected, the function must return nil.
2342 In addition to this, it may move point to a place from where the search
2343 should be continued. For example, the function may decide that the entire
2344 subtree of the current entry should be excluded and move point to the end
2345 of the subtree."
2346 :group 'org-refile
2347 :type '(choice
2348 (const nil)
2349 (function)))
2351 (defcustom org-refile-use-cache nil
2352 "Non-nil means cache refile targets to speed up the process.
2353 The cache for a particular file will be updated automatically when
2354 the buffer has been killed, or when any of the marker used for flagging
2355 refile targets no longer points at a live buffer.
2356 If you have added new entries to a buffer that might themselves be targets,
2357 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2358 find that easier, `C-u C-u C-u C-c C-w'."
2359 :group 'org-refile
2360 :version "24.1"
2361 :type 'boolean)
2363 (defcustom org-refile-use-outline-path nil
2364 "Non-nil means provide refile targets as paths.
2365 So a level 3 headline will be available as level1/level2/level3.
2367 When the value is `file', also include the file name (without directory)
2368 into the path. In this case, you can also stop the completion after
2369 the file name, to get entries inserted as top level in the file.
2371 When `full-file-path', include the full file path."
2372 :group 'org-refile
2373 :type '(choice
2374 (const :tag "Not" nil)
2375 (const :tag "Yes" t)
2376 (const :tag "Start with file name" file)
2377 (const :tag "Start with full file path" full-file-path)))
2379 (defcustom org-outline-path-complete-in-steps t
2380 "Non-nil means complete the outline path in hierarchical steps.
2381 When Org-mode uses the refile interface to select an outline path
2382 \(see variable `org-refile-use-outline-path'), the completion of
2383 the path can be done is a single go, or if can be done in steps down
2384 the headline hierarchy. Going in steps is probably the best if you
2385 do not use a special completion package like `ido' or `icicles'.
2386 However, when using these packages, going in one step can be very
2387 fast, while still showing the whole path to the entry."
2388 :group 'org-refile
2389 :type 'boolean)
2391 (defcustom org-refile-allow-creating-parent-nodes nil
2392 "Non-nil means allow to create new nodes as refile targets.
2393 New nodes are then created by adding \"/new node name\" to the completion
2394 of an existing node. When the value of this variable is `confirm',
2395 new node creation must be confirmed by the user (recommended).
2396 When nil, the completion must match an existing entry.
2398 Note that, if the new heading is not seen by the criteria
2399 listed in `org-refile-targets', multiple instances of the same
2400 heading would be created by trying again to file under the new
2401 heading."
2402 :group 'org-refile
2403 :type '(choice
2404 (const :tag "Never" nil)
2405 (const :tag "Always" t)
2406 (const :tag "Prompt for confirmation" confirm)))
2408 (defcustom org-refile-active-region-within-subtree nil
2409 "Non-nil means also refile active region within a subtree.
2411 By default `org-refile' doesn't allow refiling regions if they
2412 don't contain a set of subtrees, but it might be convenient to
2413 do so sometimes: in that case, the first line of the region is
2414 converted to a headline before refiling."
2415 :group 'org-refile
2416 :version "24.1"
2417 :type 'boolean)
2419 (defgroup org-todo nil
2420 "Options concerning TODO items in Org-mode."
2421 :tag "Org TODO"
2422 :group 'org)
2424 (defgroup org-progress nil
2425 "Options concerning Progress logging in Org-mode."
2426 :tag "Org Progress"
2427 :group 'org-time)
2429 (defvar org-todo-interpretation-widgets
2430 '((:tag "Sequence (cycling hits every state)" sequence)
2431 (:tag "Type (cycling directly to DONE)" type))
2432 "The available interpretation symbols for customizing `org-todo-keywords'.
2433 Interested libraries should add to this list.")
2435 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2436 "List of TODO entry keyword sequences and their interpretation.
2437 \\<org-mode-map>This is a list of sequences.
2439 Each sequence starts with a symbol, either `sequence' or `type',
2440 indicating if the keywords should be interpreted as a sequence of
2441 action steps, or as different types of TODO items. The first
2442 keywords are states requiring action - these states will select a headline
2443 for inclusion into the global TODO list Org-mode produces. If one of
2444 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2445 signify that no further action is necessary. If \"|\" is not found,
2446 the last keyword is treated as the only DONE state of the sequence.
2448 The command \\[org-todo] cycles an entry through these states, and one
2449 additional state where no keyword is present. For details about this
2450 cycling, see the manual.
2452 TODO keywords and interpretation can also be set on a per-file basis with
2453 the special #+SEQ_TODO and #+TYP_TODO lines.
2455 Each keyword can optionally specify a character for fast state selection
2456 \(in combination with the variable `org-use-fast-todo-selection')
2457 and specifiers for state change logging, using the same syntax that
2458 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2459 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2460 indicates to record a time stamp each time this state is selected.
2462 Each keyword may also specify if a timestamp or a note should be
2463 recorded when entering or leaving the state, by adding additional
2464 characters in the parenthesis after the keyword. This looks like this:
2465 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2466 record only the time of the state change. With X and Y being either
2467 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2468 Y when leaving the state if and only if the *target* state does not
2469 define X. You may omit any of the fast-selection key or X or /Y,
2470 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2472 For backward compatibility, this variable may also be just a list
2473 of keywords. In this case the interpretation (sequence or type) will be
2474 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2475 :group 'org-todo
2476 :group 'org-keywords
2477 :type '(choice
2478 (repeat :tag "Old syntax, just keywords"
2479 (string :tag "Keyword"))
2480 (repeat :tag "New syntax"
2481 (cons
2482 (choice
2483 :tag "Interpretation"
2484 ;;Quick and dirty way to see
2485 ;;`org-todo-interpretations'. This takes the
2486 ;;place of item arguments
2487 :convert-widget
2488 (lambda (widget)
2489 (widget-put widget
2490 :args (mapcar
2491 #'(lambda (x)
2492 (widget-convert
2493 (cons 'const x)))
2494 org-todo-interpretation-widgets))
2495 widget))
2496 (repeat
2497 (string :tag "Keyword"))))))
2499 (defvar org-todo-keywords-1 nil
2500 "All TODO and DONE keywords active in a buffer.")
2501 (make-variable-buffer-local 'org-todo-keywords-1)
2502 (defvar org-todo-keywords-for-agenda nil)
2503 (defvar org-done-keywords-for-agenda nil)
2504 (defvar org-todo-keyword-alist-for-agenda nil)
2505 (defvar org-tag-alist-for-agenda nil
2506 "Alist of all tags from all agenda files.")
2507 (defvar org-tag-groups-alist-for-agenda nil
2508 "Alist of all groups tags from all current agenda files.")
2509 (defvar org-tag-groups-alist nil)
2510 (make-variable-buffer-local 'org-tag-groups-alist)
2511 (defvar org-agenda-contributing-files nil)
2512 (defvar org-not-done-keywords nil)
2513 (make-variable-buffer-local 'org-not-done-keywords)
2514 (defvar org-done-keywords nil)
2515 (make-variable-buffer-local 'org-done-keywords)
2516 (defvar org-todo-heads nil)
2517 (make-variable-buffer-local 'org-todo-heads)
2518 (defvar org-todo-sets nil)
2519 (make-variable-buffer-local 'org-todo-sets)
2520 (defvar org-todo-log-states nil)
2521 (make-variable-buffer-local 'org-todo-log-states)
2522 (defvar org-todo-kwd-alist nil)
2523 (make-variable-buffer-local 'org-todo-kwd-alist)
2524 (defvar org-todo-key-alist nil)
2525 (make-variable-buffer-local 'org-todo-key-alist)
2526 (defvar org-todo-key-trigger nil)
2527 (make-variable-buffer-local 'org-todo-key-trigger)
2529 (defcustom org-todo-interpretation 'sequence
2530 "Controls how TODO keywords are interpreted.
2531 This variable is in principle obsolete and is only used for
2532 backward compatibility, if the interpretation of todo keywords is
2533 not given already in `org-todo-keywords'. See that variable for
2534 more information."
2535 :group 'org-todo
2536 :group 'org-keywords
2537 :type '(choice (const sequence)
2538 (const type)))
2540 (defcustom org-use-fast-todo-selection t
2541 "Non-nil means use the fast todo selection scheme with C-c C-t.
2542 This variable describes if and under what circumstances the cycling
2543 mechanism for TODO keywords will be replaced by a single-key, direct
2544 selection scheme.
2546 When nil, fast selection is never used.
2548 When the symbol `prefix', it will be used when `org-todo' is called
2549 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2550 `C-u t' in an agenda buffer.
2552 When t, fast selection is used by default. In this case, the prefix
2553 argument forces cycling instead.
2555 In all cases, the special interface is only used if access keys have
2556 actually been assigned by the user, i.e. if keywords in the configuration
2557 are followed by a letter in parenthesis, like TODO(t)."
2558 :group 'org-todo
2559 :type '(choice
2560 (const :tag "Never" nil)
2561 (const :tag "By default" t)
2562 (const :tag "Only with C-u C-c C-t" prefix)))
2564 (defcustom org-provide-todo-statistics t
2565 "Non-nil means update todo statistics after insert and toggle.
2566 ALL-HEADLINES means update todo statistics by including headlines
2567 with no TODO keyword as well, counting them as not done.
2568 A list of TODO keywords means the same, but skip keywords that are
2569 not in this list.
2571 When this is set, todo statistics is updated in the parent of the
2572 current entry each time a todo state is changed."
2573 :group 'org-todo
2574 :type '(choice
2575 (const :tag "Yes, only for TODO entries" t)
2576 (const :tag "Yes, including all entries" all-headlines)
2577 (repeat :tag "Yes, for TODOs in this list"
2578 (string :tag "TODO keyword"))
2579 (other :tag "No TODO statistics" nil)))
2581 (defcustom org-hierarchical-todo-statistics t
2582 "Non-nil means TODO statistics covers just direct children.
2583 When nil, all entries in the subtree are considered.
2584 This has only an effect if `org-provide-todo-statistics' is set.
2585 To set this to nil for only a single subtree, use a COOKIE_DATA
2586 property and include the word \"recursive\" into the value."
2587 :group 'org-todo
2588 :type 'boolean)
2590 (defcustom org-after-todo-state-change-hook nil
2591 "Hook which is run after the state of a TODO item was changed.
2592 The new state (a string with a TODO keyword, or nil) is available in the
2593 Lisp variable `org-state'."
2594 :group 'org-todo
2595 :type 'hook)
2597 (defvar org-blocker-hook nil
2598 "Hook for functions that are allowed to block a state change.
2600 Functions in this hook should not modify the buffer.
2601 Each function gets as its single argument a property list,
2602 see `org-trigger-hook' for more information about this list.
2604 If any of the functions in this hook returns nil, the state change
2605 is blocked.")
2607 (defvar org-trigger-hook nil
2608 "Hook for functions that are triggered by a state change.
2610 Each function gets as its single argument a property list with at
2611 least the following elements:
2613 (:type type-of-change :position pos-at-entry-start
2614 :from old-state :to new-state)
2616 Depending on the type, more properties may be present.
2618 This mechanism is currently implemented for:
2620 TODO state changes
2621 ------------------
2622 :type todo-state-change
2623 :from previous state (keyword as a string), or nil, or a symbol
2624 'todo' or 'done', to indicate the general type of state.
2625 :to new state, like in :from")
2627 (defcustom org-enforce-todo-dependencies nil
2628 "Non-nil means undone TODO entries will block switching the parent to DONE.
2629 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2630 be blocked if any prior sibling is not yet done.
2631 Finally, if the parent is blocked because of ordered siblings of its own,
2632 the child will also be blocked."
2633 :set (lambda (var val)
2634 (set var val)
2635 (if val
2636 (add-hook 'org-blocker-hook
2637 'org-block-todo-from-children-or-siblings-or-parent)
2638 (remove-hook 'org-blocker-hook
2639 'org-block-todo-from-children-or-siblings-or-parent)))
2640 :group 'org-todo
2641 :type 'boolean)
2643 (defcustom org-enforce-todo-checkbox-dependencies nil
2644 "Non-nil means unchecked boxes will block switching the parent to DONE.
2645 When this is nil, checkboxes have no influence on switching TODO states.
2646 When non-nil, you first need to check off all check boxes before the TODO
2647 entry can be switched to DONE.
2648 This variable needs to be set before org.el is loaded, and you need to
2649 restart Emacs after a change to make the change effective. The only way
2650 to change is while Emacs is running is through the customize interface."
2651 :set (lambda (var val)
2652 (set var val)
2653 (if val
2654 (add-hook 'org-blocker-hook
2655 'org-block-todo-from-checkboxes)
2656 (remove-hook 'org-blocker-hook
2657 'org-block-todo-from-checkboxes)))
2658 :group 'org-todo
2659 :type 'boolean)
2661 (defcustom org-treat-insert-todo-heading-as-state-change nil
2662 "Non-nil means inserting a TODO heading is treated as state change.
2663 So when the command \\[org-insert-todo-heading] is used, state change
2664 logging will apply if appropriate. When nil, the new TODO item will
2665 be inserted directly, and no logging will take place."
2666 :group 'org-todo
2667 :type 'boolean)
2669 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2670 "Non-nil means switching TODO states with S-cursor counts as state change.
2671 This is the default behavior. However, setting this to nil allows a
2672 convenient way to select a TODO state and bypass any logging associated
2673 with that."
2674 :group 'org-todo
2675 :type 'boolean)
2677 (defcustom org-todo-state-tags-triggers nil
2678 "Tag changes that should be triggered by TODO state changes.
2679 This is a list. Each entry is
2681 (state-change (tag . flag) .......)
2683 State-change can be a string with a state, and empty string to indicate the
2684 state that has no TODO keyword, or it can be one of the symbols `todo'
2685 or `done', meaning any not-done or done state, respectively."
2686 :group 'org-todo
2687 :group 'org-tags
2688 :type '(repeat
2689 (cons (choice :tag "When changing to"
2690 (const :tag "Not-done state" todo)
2691 (const :tag "Done state" done)
2692 (string :tag "State"))
2693 (repeat
2694 (cons :tag "Tag action"
2695 (string :tag "Tag")
2696 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2698 (defcustom org-log-done nil
2699 "Information to record when a task moves to the DONE state.
2701 Possible values are:
2703 nil Don't add anything, just change the keyword
2704 time Add a time stamp to the task
2705 note Prompt for a note and add it with template `org-log-note-headings'
2707 This option can also be set with on a per-file-basis with
2709 #+STARTUP: nologdone
2710 #+STARTUP: logdone
2711 #+STARTUP: lognotedone
2713 You can have local logging settings for a subtree by setting the LOGGING
2714 property to one or more of these keywords."
2715 :group 'org-todo
2716 :group 'org-progress
2717 :type '(choice
2718 (const :tag "No logging" nil)
2719 (const :tag "Record CLOSED timestamp" time)
2720 (const :tag "Record CLOSED timestamp with note." note)))
2722 ;; Normalize old uses of org-log-done.
2723 (cond
2724 ((eq org-log-done t) (setq org-log-done 'time))
2725 ((and (listp org-log-done) (memq 'done org-log-done))
2726 (setq org-log-done 'note)))
2728 (defcustom org-log-reschedule nil
2729 "Information to record when the scheduling date of a tasks is modified.
2731 Possible values are:
2733 nil Don't add anything, just change the date
2734 time Add a time stamp to the task
2735 note Prompt for a note and add it with template `org-log-note-headings'
2737 This option can also be set with on a per-file-basis with
2739 #+STARTUP: nologreschedule
2740 #+STARTUP: logreschedule
2741 #+STARTUP: lognotereschedule"
2742 :group 'org-todo
2743 :group 'org-progress
2744 :type '(choice
2745 (const :tag "No logging" nil)
2746 (const :tag "Record timestamp" time)
2747 (const :tag "Record timestamp with note." note)))
2749 (defcustom org-log-redeadline nil
2750 "Information to record when the deadline date of a tasks is modified.
2752 Possible values are:
2754 nil Don't add anything, just change the date
2755 time Add a time stamp to the task
2756 note Prompt for a note and add it with template `org-log-note-headings'
2758 This option can also be set with on a per-file-basis with
2760 #+STARTUP: nologredeadline
2761 #+STARTUP: logredeadline
2762 #+STARTUP: lognoteredeadline
2764 You can have local logging settings for a subtree by setting the LOGGING
2765 property to one or more of these keywords."
2766 :group 'org-todo
2767 :group 'org-progress
2768 :type '(choice
2769 (const :tag "No logging" nil)
2770 (const :tag "Record timestamp" time)
2771 (const :tag "Record timestamp with note." note)))
2773 (defcustom org-log-note-clock-out nil
2774 "Non-nil means record a note when clocking out of an item.
2775 This can also be configured on a per-file basis by adding one of
2776 the following lines anywhere in the buffer:
2778 #+STARTUP: lognoteclock-out
2779 #+STARTUP: nolognoteclock-out"
2780 :group 'org-todo
2781 :group 'org-progress
2782 :type 'boolean)
2784 (defcustom org-log-done-with-time t
2785 "Non-nil means the CLOSED time stamp will contain date and time.
2786 When nil, only the date will be recorded."
2787 :group 'org-progress
2788 :type 'boolean)
2790 (defcustom org-log-note-headings
2791 '((done . "CLOSING NOTE %t")
2792 (state . "State %-12s from %-12S %t")
2793 (note . "Note taken on %t")
2794 (reschedule . "Rescheduled from %S on %t")
2795 (delschedule . "Not scheduled, was %S on %t")
2796 (redeadline . "New deadline from %S on %t")
2797 (deldeadline . "Removed deadline, was %S on %t")
2798 (refile . "Refiled on %t")
2799 (clock-out . ""))
2800 "Headings for notes added to entries.
2801 The value is an alist, with the car being a symbol indicating the note
2802 context, and the cdr is the heading to be used. The heading may also be the
2803 empty string.
2804 %t in the heading will be replaced by a time stamp.
2805 %T will be an active time stamp instead the default inactive one
2806 %d will be replaced by a short-format time stamp.
2807 %D will be replaced by an active short-format time stamp.
2808 %s will be replaced by the new TODO state, in double quotes.
2809 %S will be replaced by the old TODO state, in double quotes.
2810 %u will be replaced by the user name.
2811 %U will be replaced by the full user name.
2813 In fact, it is not a good idea to change the `state' entry, because
2814 agenda log mode depends on the format of these entries."
2815 :group 'org-todo
2816 :group 'org-progress
2817 :type '(list :greedy t
2818 (cons (const :tag "Heading when closing an item" done) string)
2819 (cons (const :tag
2820 "Heading when changing todo state (todo sequence only)"
2821 state) string)
2822 (cons (const :tag "Heading when just taking a note" note) string)
2823 (cons (const :tag "Heading when rescheduling" reschedule) string)
2824 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2825 (cons (const :tag "Heading when changing deadline" redeadline) string)
2826 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2827 (cons (const :tag "Heading when refiling" refile) string)
2828 (cons (const :tag "Heading when clocking out" clock-out) string)))
2830 (unless (assq 'note org-log-note-headings)
2831 (push '(note . "%t") org-log-note-headings))
2833 (defcustom org-log-into-drawer nil
2834 "Non-nil means insert state change notes and time stamps into a drawer.
2835 When nil, state changes notes will be inserted after the headline and
2836 any scheduling and clock lines, but not inside a drawer.
2838 The value of this variable should be the name of the drawer to use.
2839 LOGBOOK is proposed as the default drawer for this purpose, you can
2840 also set this to a string to define the drawer of your choice.
2842 A value of t is also allowed, representing \"LOGBOOK\".
2844 A value of t or nil can also be set with on a per-file-basis with
2846 #+STARTUP: logdrawer
2847 #+STARTUP: nologdrawer
2849 If this variable is set, `org-log-state-notes-insert-after-drawers'
2850 will be ignored.
2852 You can set the property LOG_INTO_DRAWER to overrule this setting for
2853 a subtree."
2854 :group 'org-todo
2855 :group 'org-progress
2856 :type '(choice
2857 (const :tag "Not into a drawer" nil)
2858 (const :tag "LOGBOOK" t)
2859 (string :tag "Other")))
2861 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2863 (defun org-log-into-drawer ()
2864 "Return the value of `org-log-into-drawer', but let properties overrule.
2865 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2866 used instead of the default value."
2867 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2868 (cond
2869 ((not p) org-log-into-drawer)
2870 ((equal p "nil") nil)
2871 ((equal p "t") "LOGBOOK")
2872 (t p))))
2874 (defcustom org-log-state-notes-insert-after-drawers nil
2875 "Non-nil means insert state change notes after any drawers in entry.
2876 Only the drawers that *immediately* follow the headline and the
2877 deadline/scheduled line are skipped.
2878 When nil, insert notes right after the heading and perhaps the line
2879 with deadline/scheduling if present.
2881 This variable will have no effect if `org-log-into-drawer' is
2882 set."
2883 :group 'org-todo
2884 :group 'org-progress
2885 :type 'boolean)
2887 (defcustom org-log-states-order-reversed t
2888 "Non-nil means the latest state note will be directly after heading.
2889 When nil, the state change notes will be ordered according to time.
2891 This option can also be set with on a per-file-basis with
2893 #+STARTUP: logstatesreversed
2894 #+STARTUP: nologstatesreversed"
2895 :group 'org-todo
2896 :group 'org-progress
2897 :type 'boolean)
2899 (defcustom org-todo-repeat-to-state nil
2900 "The TODO state to which a repeater should return the repeating task.
2901 By default this is the first task in a TODO sequence, or the previous state
2902 in a TODO_TYP set. But you can specify another task here.
2903 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2904 :group 'org-todo
2905 :version "24.1"
2906 :type '(choice (const :tag "Head of sequence" nil)
2907 (string :tag "Specific state")))
2909 (defcustom org-log-repeat 'time
2910 "Non-nil means record moving through the DONE state when triggering repeat.
2911 An auto-repeating task is immediately switched back to TODO when
2912 marked DONE. If you are not logging state changes (by adding \"@\"
2913 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2914 record a closing note, there will be no record of the task moving
2915 through DONE. This variable forces taking a note anyway.
2917 nil Don't force a record
2918 time Record a time stamp
2919 note Prompt for a note and add it with template `org-log-note-headings'
2921 This option can also be set with on a per-file-basis with
2923 #+STARTUP: nologrepeat
2924 #+STARTUP: logrepeat
2925 #+STARTUP: lognoterepeat
2927 You can have local logging settings for a subtree by setting the LOGGING
2928 property to one or more of these keywords."
2929 :group 'org-todo
2930 :group 'org-progress
2931 :type '(choice
2932 (const :tag "Don't force a record" nil)
2933 (const :tag "Force recording the DONE state" time)
2934 (const :tag "Force recording a note with the DONE state" note)))
2937 (defgroup org-priorities nil
2938 "Priorities in Org-mode."
2939 :tag "Org Priorities"
2940 :group 'org-todo)
2942 (defcustom org-enable-priority-commands t
2943 "Non-nil means priority commands are active.
2944 When nil, these commands will be disabled, so that you never accidentally
2945 set a priority."
2946 :group 'org-priorities
2947 :type 'boolean)
2949 (defcustom org-highest-priority ?A
2950 "The highest priority of TODO items. A character like ?A, ?B etc.
2951 Must have a smaller ASCII number than `org-lowest-priority'."
2952 :group 'org-priorities
2953 :type 'character)
2955 (defcustom org-lowest-priority ?C
2956 "The lowest priority of TODO items. A character like ?A, ?B etc.
2957 Must have a larger ASCII number than `org-highest-priority'."
2958 :group 'org-priorities
2959 :type 'character)
2961 (defcustom org-default-priority ?B
2962 "The default priority of TODO items.
2963 This is the priority an item gets if no explicit priority is given.
2964 When starting to cycle on an empty priority the first step in the cycle
2965 depends on `org-priority-start-cycle-with-default'. The resulting first
2966 step priority must not exceed the range from `org-highest-priority' to
2967 `org-lowest-priority' which means that `org-default-priority' has to be
2968 in this range exclusive or inclusive the range boundaries. Else the
2969 first step refuses to set the default and the second will fall back
2970 to (depending on the command used) the highest or lowest priority."
2971 :group 'org-priorities
2972 :type 'character)
2974 (defcustom org-priority-start-cycle-with-default t
2975 "Non-nil means start with default priority when starting to cycle.
2976 When this is nil, the first step in the cycle will be (depending on the
2977 command used) one higher or lower than the default priority.
2978 See also `org-default-priority'."
2979 :group 'org-priorities
2980 :type 'boolean)
2982 (defcustom org-get-priority-function nil
2983 "Function to extract the priority from a string.
2984 The string is normally the headline. If this is nil Org computes the
2985 priority from the priority cookie like [#A] in the headline. It returns
2986 an integer, increasing by 1000 for each priority level.
2987 The user can set a different function here, which should take a string
2988 as an argument and return the numeric priority."
2989 :group 'org-priorities
2990 :version "24.1"
2991 :type '(choice
2992 (const nil)
2993 (function)))
2995 (defgroup org-time nil
2996 "Options concerning time stamps and deadlines in Org-mode."
2997 :tag "Org Time"
2998 :group 'org)
3000 (defcustom org-insert-labeled-timestamps-at-point nil
3001 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
3002 When nil, these labeled time stamps are forces into the second line of an
3003 entry, just after the headline. When scheduling from the global TODO list,
3004 the time stamp will always be forced into the second line."
3005 :group 'org-time
3006 :type 'boolean)
3008 (defcustom org-time-stamp-rounding-minutes '(0 5)
3009 "Number of minutes to round time stamps to.
3010 These are two values, the first applies when first creating a time stamp.
3011 The second applies when changing it with the commands `S-up' and `S-down'.
3012 When changing the time stamp, this means that it will change in steps
3013 of N minutes, as given by the second value.
3015 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3016 numbers should be factors of 60, so for example 5, 10, 15.
3018 When this is larger than 1, you can still force an exact time stamp by using
3019 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3020 and by using a prefix arg to `S-up/down' to specify the exact number
3021 of minutes to shift."
3022 :group 'org-time
3023 :get #'(lambda (var) ; Make sure both elements are there
3024 (if (integerp (default-value var))
3025 (list (default-value var) 5)
3026 (default-value var)))
3027 :type '(list
3028 (integer :tag "when inserting times")
3029 (integer :tag "when modifying times")))
3031 ;; Normalize old customizations of this variable.
3032 (when (integerp org-time-stamp-rounding-minutes)
3033 (setq org-time-stamp-rounding-minutes
3034 (list org-time-stamp-rounding-minutes
3035 org-time-stamp-rounding-minutes)))
3037 (defcustom org-display-custom-times nil
3038 "Non-nil means overlay custom formats over all time stamps.
3039 The formats are defined through the variable `org-time-stamp-custom-formats'.
3040 To turn this on on a per-file basis, insert anywhere in the file:
3041 #+STARTUP: customtime"
3042 :group 'org-time
3043 :set 'set-default
3044 :type 'sexp)
3045 (make-variable-buffer-local 'org-display-custom-times)
3047 (defcustom org-time-stamp-custom-formats
3048 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3049 "Custom formats for time stamps. See `format-time-string' for the syntax.
3050 These are overlaid over the default ISO format if the variable
3051 `org-display-custom-times' is set. Time like %H:%M should be at the
3052 end of the second format. The custom formats are also honored by export
3053 commands, if custom time display is turned on at the time of export."
3054 :group 'org-time
3055 :type 'sexp)
3057 (defun org-time-stamp-format (&optional long inactive)
3058 "Get the right format for a time string."
3059 (let ((f (if long (cdr org-time-stamp-formats)
3060 (car org-time-stamp-formats))))
3061 (if inactive
3062 (concat "[" (substring f 1 -1) "]")
3063 f)))
3065 (defcustom org-time-clocksum-format
3066 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3067 "The format string used when creating CLOCKSUM lines.
3068 This is also used when Org mode generates a time duration.
3070 The value can be a single format string containing two
3071 %-sequences, which will be filled with the number of hours and
3072 minutes in that order.
3074 Alternatively, the value can be a plist associating any of the
3075 keys :years, :months, :weeks, :days, :hours or :minutes with
3076 format strings. The time duration is formatted using only the
3077 time components that are needed and concatenating the results.
3078 If a time unit in absent, it falls back to the next smallest
3079 unit.
3081 The keys :require-years, :require-months, :require-days,
3082 :require-weeks, :require-hours, :require-minutes are also
3083 meaningful. A non-nil value for these keys indicates that the
3084 corresponding time component should always be included, even if
3085 its value is 0.
3088 For example,
3090 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3091 :require-minutes t)
3093 means durations longer than a day will be expressed in days,
3094 hours and minutes, and durations less than a day will always be
3095 expressed in hours and minutes (even for durations less than an
3096 hour).
3098 The value
3100 \(:days \"%dd\" :minutes \"%dm\")
3102 means durations longer than a day will be expressed in days and
3103 minutes, and durations less than a day will be expressed entirely
3104 in minutes (even for durations longer than an hour)."
3105 :group 'org-time
3106 :group 'org-clock
3107 :version "24.4"
3108 :package-version '(Org . "8.0")
3109 :type '(choice (string :tag "Format string")
3110 (set :tag "Plist"
3111 (group :inline t (const :tag "Years" :years)
3112 (string :tag "Format string"))
3113 (group :inline t
3114 (const :tag "Always show years" :require-years)
3115 (const t))
3116 (group :inline t (const :tag "Months" :months)
3117 (string :tag "Format string"))
3118 (group :inline t
3119 (const :tag "Always show months" :require-months)
3120 (const t))
3121 (group :inline t (const :tag "Weeks" :weeks)
3122 (string :tag "Format string"))
3123 (group :inline t
3124 (const :tag "Always show weeks" :require-weeks)
3125 (const t))
3126 (group :inline t (const :tag "Days" :days)
3127 (string :tag "Format string"))
3128 (group :inline t
3129 (const :tag "Always show days" :require-days)
3130 (const t))
3131 (group :inline t (const :tag "Hours" :hours)
3132 (string :tag "Format string"))
3133 (group :inline t
3134 (const :tag "Always show hours" :require-hours)
3135 (const t))
3136 (group :inline t (const :tag "Minutes" :minutes)
3137 (string :tag "Format string"))
3138 (group :inline t
3139 (const :tag "Always show minutes" :require-minutes)
3140 (const t)))))
3142 (defcustom org-time-clocksum-use-fractional nil
3143 "When non-nil, \\[org-clock-display] uses fractional times.
3144 See `org-time-clocksum-format' for more on time clock formats."
3145 :group 'org-time
3146 :group 'org-clock
3147 :version "24.3"
3148 :type 'boolean)
3150 (defcustom org-time-clocksum-use-effort-durations nil
3151 "When non-nil, \\[org-clock-display] uses effort durations.
3152 E.g. by default, one day is considered to be a 8 hours effort,
3153 so a task that has been clocked for 16 hours will be displayed
3154 as during 2 days in the clock display or in the clocktable.
3156 See `org-effort-durations' on how to set effort durations
3157 and `org-time-clocksum-format' for more on time clock formats."
3158 :group 'org-time
3159 :group 'org-clock
3160 :version "24.4"
3161 :package-version '(Org . "8.0")
3162 :type 'boolean)
3164 (defcustom org-time-clocksum-fractional-format "%.2f"
3165 "The format string used when creating CLOCKSUM lines,
3166 or when Org mode generates a time duration, if
3167 `org-time-clocksum-use-fractional' is enabled.
3169 The value can be a single format string containing one
3170 %-sequence, which will be filled with the number of hours as
3171 a float.
3173 Alternatively, the value can be a plist associating any of the
3174 keys :years, :months, :weeks, :days, :hours or :minutes with
3175 a format string. The time duration is formatted using the
3176 largest time unit which gives a non-zero integer part. If all
3177 specified formats have zero integer part, the smallest time unit
3178 is used."
3179 :group 'org-time
3180 :type '(choice (string :tag "Format string")
3181 (set (group :inline t (const :tag "Years" :years)
3182 (string :tag "Format string"))
3183 (group :inline t (const :tag "Months" :months)
3184 (string :tag "Format string"))
3185 (group :inline t (const :tag "Weeks" :weeks)
3186 (string :tag "Format string"))
3187 (group :inline t (const :tag "Days" :days)
3188 (string :tag "Format string"))
3189 (group :inline t (const :tag "Hours" :hours)
3190 (string :tag "Format string"))
3191 (group :inline t (const :tag "Minutes" :minutes)
3192 (string :tag "Format string")))))
3194 (defcustom org-deadline-warning-days 14
3195 "Number of days before expiration during which a deadline becomes active.
3196 This variable governs the display in sparse trees and in the agenda.
3197 When 0 or negative, it means use this number (the absolute value of it)
3198 even if a deadline has a different individual lead time specified.
3200 Custom commands can set this variable in the options section."
3201 :group 'org-time
3202 :group 'org-agenda-daily/weekly
3203 :type 'integer)
3205 (defcustom org-scheduled-delay-days 0
3206 "Number of days before a scheduled item becomes active.
3207 This variable governs the display in sparse trees and in the agenda.
3208 The default value (i.e. 0) means: don't delay scheduled item.
3209 When negative, it means use this number (the absolute value of it)
3210 even if a scheduled item has a different individual delay time
3211 specified.
3213 Custom commands can set this variable in the options section."
3214 :group 'org-time
3215 :group 'org-agenda-daily/weekly
3216 :version "24.4"
3217 :package-version '(Org . "8.0")
3218 :type 'integer)
3220 (defcustom org-read-date-prefer-future t
3221 "Non-nil means assume future for incomplete date input from user.
3222 This affects the following situations:
3223 1. The user gives a month but not a year.
3224 For example, if it is April and you enter \"feb 2\", this will be read
3225 as Feb 2, *next* year. \"May 5\", however, will be this year.
3226 2. The user gives a day, but no month.
3227 For example, if today is the 15th, and you enter \"3\", Org-mode will
3228 read this as the third of *next* month. However, if you enter \"17\",
3229 it will be considered as *this* month.
3231 If you set this variable to the symbol `time', then also the following
3232 will work:
3234 3. If the user gives a time.
3235 If the time is before now, it will be interpreted as tomorrow.
3237 Currently none of this works for ISO week specifications.
3239 When this option is nil, the current day, month and year will always be
3240 used as defaults.
3242 See also `org-agenda-jump-prefer-future'."
3243 :group 'org-time
3244 :type '(choice
3245 (const :tag "Never" nil)
3246 (const :tag "Check month and day" t)
3247 (const :tag "Check month, day, and time" time)))
3249 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3250 "Should the agenda jump command prefer the future for incomplete dates?
3251 The default is to do the same as configured in `org-read-date-prefer-future'.
3252 But you can also set a deviating value here.
3253 This may t or nil, or the symbol `org-read-date-prefer-future'."
3254 :group 'org-agenda
3255 :group 'org-time
3256 :version "24.1"
3257 :type '(choice
3258 (const :tag "Use org-read-date-prefer-future"
3259 org-read-date-prefer-future)
3260 (const :tag "Never" nil)
3261 (const :tag "Always" t)))
3263 (defcustom org-read-date-force-compatible-dates t
3264 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3266 Depending on the system Emacs is running on, certain dates cannot
3267 be represented with the type used internally to represent time.
3268 Dates between 1970-1-1 and 2038-1-1 can always be represented
3269 correctly. Some systems allow for earlier dates, some for later,
3270 some for both. One way to find out it to insert any date into an
3271 Org buffer, putting the cursor on the year and hitting S-up and
3272 S-down to test the range.
3274 When this variable is set to t, the date/time prompt will not let
3275 you specify dates outside the 1970-2037 range, so it is certain that
3276 these dates will work in whatever version of Emacs you are
3277 running, and also that you can move a file from one Emacs implementation
3278 to another. WHenever Org is forcing the year for you, it will display
3279 a message and beep.
3281 When this variable is nil, Org will check if the date is
3282 representable in the specific Emacs implementation you are using.
3283 If not, it will force a year, usually the current year, and beep
3284 to remind you. Currently this setting is not recommended because
3285 the likelihood that you will open your Org files in an Emacs that
3286 has limited date range is not negligible.
3288 A workaround for this problem is to use diary sexp dates for time
3289 stamps outside of this range."
3290 :group 'org-time
3291 :version "24.1"
3292 :type 'boolean)
3294 (defcustom org-read-date-display-live t
3295 "Non-nil means display current interpretation of date prompt live.
3296 This display will be in an overlay, in the minibuffer."
3297 :group 'org-time
3298 :type 'boolean)
3300 (defcustom org-read-date-popup-calendar t
3301 "Non-nil means pop up a calendar when prompting for a date.
3302 In the calendar, the date can be selected with mouse-1. However, the
3303 minibuffer will also be active, and you can simply enter the date as well.
3304 When nil, only the minibuffer will be available."
3305 :group 'org-time
3306 :type 'boolean)
3307 (org-defvaralias 'org-popup-calendar-for-date-prompt
3308 'org-read-date-popup-calendar)
3310 (make-obsolete-variable
3311 'org-read-date-minibuffer-setup-hook
3312 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3313 (defcustom org-read-date-minibuffer-setup-hook nil
3314 "Hook to be used to set up keys for the date/time interface.
3315 Add key definitions to `minibuffer-local-map', which will be a
3316 temporary copy.
3318 WARNING: This option is obsolete, you should use
3319 `org-read-date-minibuffer-local-map' to set up keys."
3320 :group 'org-time
3321 :type 'hook)
3323 (defcustom org-extend-today-until 0
3324 "The hour when your day really ends. Must be an integer.
3325 This has influence for the following applications:
3326 - When switching the agenda to \"today\". It it is still earlier than
3327 the time given here, the day recognized as TODAY is actually yesterday.
3328 - When a date is read from the user and it is still before the time given
3329 here, the current date and time will be assumed to be yesterday, 23:59.
3330 Also, timestamps inserted in capture templates follow this rule.
3332 IMPORTANT: This is a feature whose implementation is and likely will
3333 remain incomplete. Really, it is only here because past midnight seems to
3334 be the favorite working time of John Wiegley :-)"
3335 :group 'org-time
3336 :type 'integer)
3338 (defcustom org-use-effective-time nil
3339 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3340 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3341 \"effective time\" of any timestamps between midnight and 8am will be
3342 23:59 of the previous day."
3343 :group 'org-time
3344 :version "24.1"
3345 :type 'boolean)
3347 (defcustom org-use-last-clock-out-time-as-effective-time nil
3348 "When non-nil, use the last clock out time for `org-todo'.
3349 Note that this option has precedence over the combined use of
3350 `org-use-effective-time' and `org-extend-today-until'."
3351 :group 'org-time
3352 :version "24.4"
3353 :package-version '(Org . "8.0")
3354 :type 'boolean)
3356 (defcustom org-edit-timestamp-down-means-later nil
3357 "Non-nil means S-down will increase the time in a time stamp.
3358 When nil, S-up will increase."
3359 :group 'org-time
3360 :type 'boolean)
3362 (defcustom org-calendar-follow-timestamp-change t
3363 "Non-nil means make the calendar window follow timestamp changes.
3364 When a timestamp is modified and the calendar window is visible, it will be
3365 moved to the new date."
3366 :group 'org-time
3367 :type 'boolean)
3369 (defgroup org-tags nil
3370 "Options concerning tags in Org-mode."
3371 :tag "Org Tags"
3372 :group 'org)
3374 (defcustom org-tag-alist nil
3375 "List of tags allowed in Org-mode files.
3376 When this list is nil, Org-mode will base TAG input on what is already in the
3377 buffer.
3378 The value of this variable is an alist, the car of each entry must be a
3379 keyword as a string, the cdr may be a character that is used to select
3380 that tag through the fast-tag-selection interface.
3381 See the manual for details."
3382 :group 'org-tags
3383 :type '(repeat
3384 (choice
3385 (cons (string :tag "Tag name")
3386 (character :tag "Access char"))
3387 (list :tag "Start radio group"
3388 (const :startgroup)
3389 (option (string :tag "Group description")))
3390 (list :tag "Group tags delimiter"
3391 (const :grouptags))
3392 (list :tag "End radio group"
3393 (const :endgroup)
3394 (option (string :tag "Group description")))
3395 (const :tag "New line" (:newline)))))
3397 (defcustom org-tag-persistent-alist nil
3398 "List of tags that will always appear in all Org-mode files.
3399 This is in addition to any in buffer settings or customizations
3400 of `org-tag-alist'.
3401 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3402 The value of this variable is an alist, the car of each entry must be a
3403 keyword as a string, the cdr may be a character that is used to select
3404 that tag through the fast-tag-selection interface.
3405 See the manual for details.
3406 To disable these tags on a per-file basis, insert anywhere in the file:
3407 #+STARTUP: noptag"
3408 :group 'org-tags
3409 :type '(repeat
3410 (choice
3411 (cons (string :tag "Tag name")
3412 (character :tag "Access char"))
3413 (const :tag "Start radio group" (:startgroup))
3414 (const :tag "Group tags delimiter" (:grouptags))
3415 (const :tag "End radio group" (:endgroup))
3416 (const :tag "New line" (:newline)))))
3418 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3419 "If non-nil, always offer completion for all tags of all agenda files.
3420 Instead of customizing this variable directly, you might want to
3421 set it locally for capture buffers, because there no list of
3422 tags in that file can be created dynamically (there are none).
3424 (add-hook 'org-capture-mode-hook
3425 (lambda ()
3426 (set (make-local-variable
3427 'org-complete-tags-always-offer-all-agenda-tags)
3428 t)))"
3429 :group 'org-tags
3430 :version "24.1"
3431 :type 'boolean)
3433 (defvar org-file-tags nil
3434 "List of tags that can be inherited by all entries in the file.
3435 The tags will be inherited if the variable `org-use-tag-inheritance'
3436 says they should be.
3437 This variable is populated from #+FILETAGS lines.")
3439 (defcustom org-use-fast-tag-selection 'auto
3440 "Non-nil means use fast tag selection scheme.
3441 This is a special interface to select and deselect tags with single keys.
3442 When nil, fast selection is never used.
3443 When the symbol `auto', fast selection is used if and only if selection
3444 characters for tags have been configured, either through the variable
3445 `org-tag-alist' or through a #+TAGS line in the buffer.
3446 When t, fast selection is always used and selection keys are assigned
3447 automatically if necessary."
3448 :group 'org-tags
3449 :type '(choice
3450 (const :tag "Always" t)
3451 (const :tag "Never" nil)
3452 (const :tag "When selection characters are configured" auto)))
3454 (defcustom org-fast-tag-selection-single-key nil
3455 "Non-nil means fast tag selection exits after first change.
3456 When nil, you have to press RET to exit it.
3457 During fast tag selection, you can toggle this flag with `C-c'.
3458 This variable can also have the value `expert'. In this case, the window
3459 displaying the tags menu is not even shown, until you press C-c again."
3460 :group 'org-tags
3461 :type '(choice
3462 (const :tag "No" nil)
3463 (const :tag "Yes" t)
3464 (const :tag "Expert" expert)))
3466 (defvar org-fast-tag-selection-include-todo nil
3467 "Non-nil means fast tags selection interface will also offer TODO states.
3468 This is an undocumented feature, you should not rely on it.")
3470 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3471 "The column to which tags should be indented in a headline.
3472 If this number is positive, it specifies the column. If it is negative,
3473 it means that the tags should be flushright to that column. For example,
3474 -80 works well for a normal 80 character screen.
3475 When 0, place tags directly after headline text, with only one space in
3476 between."
3477 :group 'org-tags
3478 :type 'integer)
3480 (defcustom org-auto-align-tags t
3481 "Non-nil keeps tags aligned when modifying headlines.
3482 Some operations (i.e. demoting) change the length of a headline and
3483 therefore shift the tags around. With this option turned on, after
3484 each such operation the tags are again aligned to `org-tags-column'."
3485 :group 'org-tags
3486 :type 'boolean)
3488 (defcustom org-use-tag-inheritance t
3489 "Non-nil means tags in levels apply also for sublevels.
3490 When nil, only the tags directly given in a specific line apply there.
3491 This may also be a list of tags that should be inherited, or a regexp that
3492 matches tags that should be inherited. Additional control is possible
3493 with the variable `org-tags-exclude-from-inheritance' which gives an
3494 explicit list of tags to be excluded from inheritance, even if the value of
3495 `org-use-tag-inheritance' would select it for inheritance.
3497 If this option is t, a match early-on in a tree can lead to a large
3498 number of matches in the subtree when constructing the agenda or creating
3499 a sparse tree. If you only want to see the first match in a tree during
3500 a search, check out the variable `org-tags-match-list-sublevels'."
3501 :group 'org-tags
3502 :type '(choice
3503 (const :tag "Not" nil)
3504 (const :tag "Always" t)
3505 (repeat :tag "Specific tags" (string :tag "Tag"))
3506 (regexp :tag "Tags matched by regexp")))
3508 (defcustom org-tags-exclude-from-inheritance nil
3509 "List of tags that should never be inherited.
3510 This is a way to exclude a few tags from inheritance. For way to do
3511 the opposite, to actively allow inheritance for selected tags,
3512 see the variable `org-use-tag-inheritance'."
3513 :group 'org-tags
3514 :type '(repeat (string :tag "Tag")))
3516 (defun org-tag-inherit-p (tag)
3517 "Check if TAG is one that should be inherited."
3518 (cond
3519 ((member tag org-tags-exclude-from-inheritance) nil)
3520 ((eq org-use-tag-inheritance t) t)
3521 ((not org-use-tag-inheritance) nil)
3522 ((stringp org-use-tag-inheritance)
3523 (string-match org-use-tag-inheritance tag))
3524 ((listp org-use-tag-inheritance)
3525 (member tag org-use-tag-inheritance))
3526 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3528 (defcustom org-tags-match-list-sublevels t
3529 "Non-nil means list also sublevels of headlines matching a search.
3530 This variable applies to tags/property searches, and also to stuck
3531 projects because this search is based on a tags match as well.
3533 When set to the symbol `indented', sublevels are indented with
3534 leading dots.
3536 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3537 the sublevels of a headline matching a tag search often also match
3538 the same search. Listing all of them can create very long lists.
3539 Setting this variable to nil causes subtrees of a match to be skipped.
3541 This variable is semi-obsolete and probably should always be true. It
3542 is better to limit inheritance to certain tags using the variables
3543 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3544 :group 'org-tags
3545 :type '(choice
3546 (const :tag "No, don't list them" nil)
3547 (const :tag "Yes, do list them" t)
3548 (const :tag "List them, indented with leading dots" indented)))
3550 (defcustom org-tags-sort-function nil
3551 "When set, tags are sorted using this function as a comparator."
3552 :group 'org-tags
3553 :type '(choice
3554 (const :tag "No sorting" nil)
3555 (const :tag "Alphabetical" string<)
3556 (const :tag "Reverse alphabetical" string>)
3557 (function :tag "Custom function" nil)))
3559 (defvar org-tags-history nil
3560 "History of minibuffer reads for tags.")
3561 (defvar org-last-tags-completion-table nil
3562 "The last used completion table for tags.")
3563 (defvar org-after-tags-change-hook nil
3564 "Hook that is run after the tags in a line have changed.")
3566 (defgroup org-properties nil
3567 "Options concerning properties in Org-mode."
3568 :tag "Org Properties"
3569 :group 'org)
3571 (defcustom org-property-format "%-10s %s"
3572 "How property key/value pairs should be formatted by `indent-line'.
3573 When `indent-line' hits a property definition, it will format the line
3574 according to this format, mainly to make sure that the values are
3575 lined-up with respect to each other."
3576 :group 'org-properties
3577 :type 'string)
3579 (defcustom org-properties-postprocess-alist nil
3580 "Alist of properties and functions to adjust inserted values.
3581 Elements of this alist must be of the form
3583 ([string] [function])
3585 where [string] must be a property name and [function] must be a
3586 lambda expression: this lambda expression must take one argument,
3587 the value to adjust, and return the new value as a string.
3589 For example, this element will allow the property \"Remaining\"
3590 to be updated wrt the relation between the \"Effort\" property
3591 and the clock summary:
3593 ((\"Remaining\" (lambda(value)
3594 (let ((clocksum (org-clock-sum-current-item))
3595 (effort (org-duration-string-to-minutes
3596 (org-entry-get (point) \"Effort\"))))
3597 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3598 :group 'org-properties
3599 :version "24.1"
3600 :type '(alist :key-type (string :tag "Property")
3601 :value-type (function :tag "Function")))
3603 (defcustom org-use-property-inheritance nil
3604 "Non-nil means properties apply also for sublevels.
3606 This setting is chiefly used during property searches. Turning it on can
3607 cause significant overhead when doing a search, which is why it is not
3608 on by default.
3610 When nil, only the properties directly given in the current entry count.
3611 When t, every property is inherited. The value may also be a list of
3612 properties that should have inheritance, or a regular expression matching
3613 properties that should be inherited.
3615 However, note that some special properties use inheritance under special
3616 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3617 and the properties ending in \"_ALL\" when they are used as descriptor
3618 for valid values of a property.
3620 Note for programmers:
3621 When querying an entry with `org-entry-get', you can control if inheritance
3622 should be used. By default, `org-entry-get' looks only at the local
3623 properties. You can request inheritance by setting the inherit argument
3624 to t (to force inheritance) or to `selective' (to respect the setting
3625 in this variable)."
3626 :group 'org-properties
3627 :type '(choice
3628 (const :tag "Not" nil)
3629 (const :tag "Always" t)
3630 (repeat :tag "Specific properties" (string :tag "Property"))
3631 (regexp :tag "Properties matched by regexp")))
3633 (defun org-property-inherit-p (property)
3634 "Check if PROPERTY is one that should be inherited."
3635 (cond
3636 ((eq org-use-property-inheritance t) t)
3637 ((not org-use-property-inheritance) nil)
3638 ((stringp org-use-property-inheritance)
3639 (string-match org-use-property-inheritance property))
3640 ((listp org-use-property-inheritance)
3641 (member property org-use-property-inheritance))
3642 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3644 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3645 "The default column format, if no other format has been defined.
3646 This variable can be set on the per-file basis by inserting a line
3648 #+COLUMNS: %25ITEM ....."
3649 :group 'org-properties
3650 :type 'string)
3652 (defcustom org-columns-ellipses ".."
3653 "The ellipses to be used when a field in column view is truncated.
3654 When this is the empty string, as many characters as possible are shown,
3655 but then there will be no visual indication that the field has been truncated.
3656 When this is a string of length N, the last N characters of a truncated
3657 field are replaced by this string. If the column is narrower than the
3658 ellipses string, only part of the ellipses string will be shown."
3659 :group 'org-properties
3660 :type 'string)
3662 (defcustom org-columns-modify-value-for-display-function nil
3663 "Function that modifies values for display in column view.
3664 For example, it can be used to cut out a certain part from a time stamp.
3665 The function must take 2 arguments:
3667 column-title The title of the column (*not* the property name)
3668 value The value that should be modified.
3670 The function should return the value that should be displayed,
3671 or nil if the normal value should be used."
3672 :group 'org-properties
3673 :type '(choice (const nil) (function)))
3675 (defconst org-global-properties-fixed
3676 '(("VISIBILITY_ALL" . "folded children content all")
3677 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3678 "List of property/value pairs that can be inherited by any entry.
3680 These are fixed values, for the preset properties. The user variable
3681 that can be used to add to this list is `org-global-properties'.
3683 The entries in this list are cons cells where the car is a property
3684 name and cdr is a string with the value. If the value represents
3685 multiple items like an \"_ALL\" property, separate the items by
3686 spaces.")
3688 (defcustom org-global-properties nil
3689 "List of property/value pairs that can be inherited by any entry.
3691 This list will be combined with the constant `org-global-properties-fixed'.
3693 The entries in this list are cons cells where the car is a property
3694 name and cdr is a string with the value.
3696 You can set buffer-local values for the same purpose in the variable
3697 `org-file-properties' this by adding lines like
3699 #+PROPERTY: NAME VALUE"
3700 :group 'org-properties
3701 :type '(repeat
3702 (cons (string :tag "Property")
3703 (string :tag "Value"))))
3705 (defvar org-file-properties nil
3706 "List of property/value pairs that can be inherited by any entry.
3707 Valid for the current buffer.
3708 This variable is populated from #+PROPERTY lines.")
3709 (make-variable-buffer-local 'org-file-properties)
3711 (defgroup org-agenda nil
3712 "Options concerning agenda views in Org-mode."
3713 :tag "Org Agenda"
3714 :group 'org)
3716 (defvar org-category nil
3717 "Variable used by org files to set a category for agenda display.
3718 Such files should use a file variable to set it, for example
3720 # -*- mode: org; org-category: \"ELisp\"
3722 or contain a special line
3724 #+CATEGORY: ELisp
3726 If the file does not specify a category, then file's base name
3727 is used instead.")
3728 (make-variable-buffer-local 'org-category)
3729 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3731 (defcustom org-agenda-files nil
3732 "The files to be used for agenda display.
3733 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3734 \\[org-remove-file]. You can also use customize to edit the list.
3736 If an entry is a directory, all files in that directory that are matched by
3737 `org-agenda-file-regexp' will be part of the file list.
3739 If the value of the variable is not a list but a single file name, then
3740 the list of agenda files is actually stored and maintained in that file, one
3741 agenda file per line. In this file paths can be given relative to
3742 `org-directory'. Tilde expansion and environment variable substitution
3743 are also made."
3744 :group 'org-agenda
3745 :type '(choice
3746 (repeat :tag "List of files and directories" file)
3747 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3749 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3750 "Regular expression to match files for `org-agenda-files'.
3751 If any element in the list in that variable contains a directory instead
3752 of a normal file, all files in that directory that are matched by this
3753 regular expression will be included."
3754 :group 'org-agenda
3755 :type 'regexp)
3757 (defcustom org-agenda-text-search-extra-files nil
3758 "List of extra files to be searched by text search commands.
3759 These files will be searched in addition to the agenda files by the
3760 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3761 Note that these files will only be searched for text search commands,
3762 not for the other agenda views like todo lists, tag searches or the weekly
3763 agenda. This variable is intended to list notes and possibly archive files
3764 that should also be searched by these two commands.
3765 In fact, if the first element in the list is the symbol `agenda-archives',
3766 then all archive files of all agenda files will be added to the search
3767 scope."
3768 :group 'org-agenda
3769 :type '(set :greedy t
3770 (const :tag "Agenda Archives" agenda-archives)
3771 (repeat :inline t (file))))
3773 (org-defvaralias 'org-agenda-multi-occur-extra-files
3774 'org-agenda-text-search-extra-files)
3776 (defcustom org-agenda-skip-unavailable-files nil
3777 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3778 A nil value means to remove them, after a query, from the list."
3779 :group 'org-agenda
3780 :type 'boolean)
3782 (defcustom org-calendar-to-agenda-key [?c]
3783 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3784 The command `org-calendar-goto-agenda' will be bound to this key. The
3785 default is the character `c' because then `c' can be used to switch back and
3786 forth between agenda and calendar."
3787 :group 'org-agenda
3788 :type 'sexp)
3790 (defcustom org-calendar-insert-diary-entry-key [?i]
3791 "The key to be installed in `calendar-mode-map' for adding diary entries.
3792 This option is irrelevant until `org-agenda-diary-file' has been configured
3793 to point to an Org-mode file. When that is the case, the command
3794 `org-agenda-diary-entry' will be bound to the key given here, by default
3795 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3796 if you want to continue doing this, you need to change this to a different
3797 key."
3798 :group 'org-agenda
3799 :type 'sexp)
3801 (defcustom org-agenda-diary-file 'diary-file
3802 "File to which to add new entries with the `i' key in agenda and calendar.
3803 When this is the symbol `diary-file', the functionality in the Emacs
3804 calendar will be used to add entries to the `diary-file'. But when this
3805 points to a file, `org-agenda-diary-entry' will be used instead."
3806 :group 'org-agenda
3807 :type '(choice
3808 (const :tag "The standard Emacs diary file" diary-file)
3809 (file :tag "Special Org file diary entries")))
3811 (eval-after-load "calendar"
3812 '(progn
3813 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3814 'org-calendar-goto-agenda)
3815 (add-hook 'calendar-mode-hook
3816 (lambda ()
3817 (unless (eq org-agenda-diary-file 'diary-file)
3818 (define-key calendar-mode-map
3819 org-calendar-insert-diary-entry-key
3820 'org-agenda-diary-entry))))))
3822 (defgroup org-latex nil
3823 "Options for embedding LaTeX code into Org-mode."
3824 :tag "Org LaTeX"
3825 :group 'org)
3827 (defcustom org-format-latex-options
3828 '(:foreground default :background default :scale 1.0
3829 :html-foreground "Black" :html-background "Transparent"
3830 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3831 "Options for creating images from LaTeX fragments.
3832 This is a property list with the following properties:
3833 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3834 `default' means use the foreground of the default face.
3835 `auto' means use the foreground from the text face.
3836 :background the background color, or \"Transparent\".
3837 `default' means use the background of the default face.
3838 `auto' means use the background from the text face.
3839 :scale a scaling factor for the size of the images, to get more pixels
3840 :html-foreground, :html-background, :html-scale
3841 the same numbers for HTML export.
3842 :matchers a list indicating which matchers should be used to
3843 find LaTeX fragments. Valid members of this list are:
3844 \"begin\" find environments
3845 \"$1\" find single characters surrounded by $.$
3846 \"$\" find math expressions surrounded by $...$
3847 \"$$\" find math expressions surrounded by $$....$$
3848 \"\\(\" find math expressions surrounded by \\(...\\)
3849 \"\\ [\" find math expressions surrounded by \\ [...\\]"
3850 :group 'org-latex
3851 :type 'plist)
3853 (defcustom org-format-latex-signal-error t
3854 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3855 When nil, just push out a message."
3856 :group 'org-latex
3857 :version "24.1"
3858 :type 'boolean)
3860 (defcustom org-latex-to-mathml-jar-file nil
3861 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3862 Use this to specify additional executable file say a jar file.
3864 When using MathToWeb as the converter, specify the full-path to
3865 your mathtoweb.jar file."
3866 :group 'org-latex
3867 :version "24.1"
3868 :type '(choice
3869 (const :tag "None" nil)
3870 (file :tag "JAR file" :must-match t)))
3872 (defcustom org-latex-to-mathml-convert-command nil
3873 "Command to convert LaTeX fragments to MathML.
3874 Replace format-specifiers in the command as noted below and use
3875 `shell-command' to convert LaTeX to MathML.
3876 %j: Executable file in fully expanded form as specified by
3877 `org-latex-to-mathml-jar-file'.
3878 %I: Input LaTeX file in fully expanded form
3879 %o: Output MathML file
3880 This command is used by `org-create-math-formula'.
3882 When using MathToWeb as the converter, set this to
3883 \"java -jar %j -unicode -force -df %o %I\"."
3884 :group 'org-latex
3885 :version "24.1"
3886 :type '(choice
3887 (const :tag "None" nil)
3888 (string :tag "\nShell command")))
3890 (defcustom org-latex-create-formula-image-program 'dvipng
3891 "Program to convert LaTeX fragments with.
3893 dvipng Process the LaTeX fragments to dvi file, then convert
3894 dvi files to png files using dvipng.
3895 This will also include processing of non-math environments.
3896 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3897 to convert pdf files to png files"
3898 :group 'org-latex
3899 :version "24.1"
3900 :type '(choice
3901 (const :tag "dvipng" dvipng)
3902 (const :tag "imagemagick" imagemagick)))
3904 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
3905 "Path to store latex preview images.
3906 A relative path here creates many directories relative to the
3907 processed org files paths. An absolute path puts all preview
3908 images at the same place."
3909 :group 'org-latex
3910 :version "24.3"
3911 :type 'string)
3913 (defun org-format-latex-mathml-available-p ()
3914 "Return t if `org-latex-to-mathml-convert-command' is usable."
3915 (save-match-data
3916 (when (and (boundp 'org-latex-to-mathml-convert-command)
3917 org-latex-to-mathml-convert-command)
3918 (let ((executable (car (split-string
3919 org-latex-to-mathml-convert-command))))
3920 (when (executable-find executable)
3921 (if (string-match
3922 "%j" org-latex-to-mathml-convert-command)
3923 (file-readable-p org-latex-to-mathml-jar-file)
3924 t))))))
3926 (defcustom org-format-latex-header "\\documentclass{article}
3927 \\usepackage[usenames]{color}
3928 \[PACKAGES]
3929 \[DEFAULT-PACKAGES]
3930 \\pagestyle{empty} % do not remove
3931 % The settings below are copied from fullpage.sty
3932 \\setlength{\\textwidth}{\\paperwidth}
3933 \\addtolength{\\textwidth}{-3cm}
3934 \\setlength{\\oddsidemargin}{1.5cm}
3935 \\addtolength{\\oddsidemargin}{-2.54cm}
3936 \\setlength{\\evensidemargin}{\\oddsidemargin}
3937 \\setlength{\\textheight}{\\paperheight}
3938 \\addtolength{\\textheight}{-\\headheight}
3939 \\addtolength{\\textheight}{-\\headsep}
3940 \\addtolength{\\textheight}{-\\footskip}
3941 \\addtolength{\\textheight}{-3cm}
3942 \\setlength{\\topmargin}{1.5cm}
3943 \\addtolength{\\topmargin}{-2.54cm}"
3944 "The document header used for processing LaTeX fragments.
3945 It is imperative that this header make sure that no page number
3946 appears on the page. The package defined in the variables
3947 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3948 will either replace the placeholder \"[PACKAGES]\" in this
3949 header, or they will be appended."
3950 :group 'org-latex
3951 :type 'string)
3953 (defun org-set-packages-alist (var val)
3954 "Set the packages alist and make sure it has 3 elements per entry."
3955 (set var (mapcar (lambda (x)
3956 (if (and (consp x) (= (length x) 2))
3957 (list (car x) (nth 1 x) t)
3959 val)))
3961 (defun org-get-packages-alist (var)
3962 "Get the packages alist and make sure it has 3 elements per entry."
3963 (mapcar (lambda (x)
3964 (if (and (consp x) (= (length x) 2))
3965 (list (car x) (nth 1 x) t)
3967 (default-value var)))
3969 (defcustom org-latex-default-packages-alist
3970 '(("AUTO" "inputenc" t)
3971 ("T1" "fontenc" t)
3972 ("" "fixltx2e" nil)
3973 ("" "graphicx" t)
3974 ("" "longtable" nil)
3975 ("" "float" nil)
3976 ("" "wrapfig" nil)
3977 ("" "rotating" nil)
3978 ("normalem" "ulem" t)
3979 ("" "amsmath" t)
3980 ("" "textcomp" t)
3981 ("" "marvosym" t)
3982 ("" "wasysym" t)
3983 ("" "amssymb" t)
3984 ("" "hyperref" nil)
3985 "\\tolerance=1000")
3986 "Alist of default packages to be inserted in the header.
3988 Change this only if one of the packages here causes an
3989 incompatibility with another package you are using.
3991 The packages in this list are needed by one part or another of
3992 Org mode to function properly:
3994 - inputenc, fontenc: for basic font and character selection
3995 - fixltx2e: Important patches of LaTeX itself
3996 - graphicx: for including images
3997 - longtable: For multipage tables
3998 - float, wrapfig: for figure placement
3999 - rotating: for sideways figures and tables
4000 - ulem: for underline and strike-through
4001 - amsmath: for subscript and superscript and math environments
4002 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4003 for interpreting the entities in `org-entities'. You can skip
4004 some of these packages if you don't use any of their symbols.
4005 - hyperref: for cross references
4007 Therefore you should not modify this variable unless you know
4008 what you are doing. The one reason to change it anyway is that
4009 you might be loading some other package that conflicts with one
4010 of the default packages. Each cell is of the format
4011 \( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
4012 the package also needs to be included when compiling LaTeX
4013 snippets into images for inclusion into non-LaTeX output."
4014 :group 'org-latex
4015 :group 'org-export-latex
4016 :set 'org-set-packages-alist
4017 :get 'org-get-packages-alist
4018 :version "24.1"
4019 :type '(repeat
4020 (choice
4021 (list :tag "options/package pair"
4022 (string :tag "options")
4023 (string :tag "package")
4024 (boolean :tag "Snippet"))
4025 (string :tag "A line of LaTeX"))))
4027 (defcustom org-latex-packages-alist nil
4028 "Alist of packages to be inserted in every LaTeX header.
4030 These will be inserted after `org-latex-default-packages-alist'.
4031 Each cell is of the format:
4033 \(\"options\" \"package\" snippet-flag)
4035 SNIPPET-FLAG, when t, indicates that this package is also needed
4036 when turning LaTeX snippets into images for inclusion into
4037 non-LaTeX output.
4039 Make sure that you only list packages here which:
4041 - you want in every file
4042 - do not conflict with the setup in `org-format-latex-header'.
4043 - do not conflict with the default packages in
4044 `org-latex-default-packages-alist'."
4045 :group 'org-latex
4046 :group 'org-export-latex
4047 :set 'org-set-packages-alist
4048 :get 'org-get-packages-alist
4049 :type '(repeat
4050 (choice
4051 (list :tag "options/package pair"
4052 (string :tag "options")
4053 (string :tag "package")
4054 (boolean :tag "Snippet"))
4055 (string :tag "A line of LaTeX"))))
4057 (defgroup org-appearance nil
4058 "Settings for Org-mode appearance."
4059 :tag "Org Appearance"
4060 :group 'org)
4062 (defcustom org-level-color-stars-only nil
4063 "Non-nil means fontify only the stars in each headline.
4064 When nil, the entire headline is fontified.
4065 Changing it requires restart of `font-lock-mode' to become effective
4066 also in regions already fontified."
4067 :group 'org-appearance
4068 :type 'boolean)
4070 (defcustom org-hide-leading-stars nil
4071 "Non-nil means hide the first N-1 stars in a headline.
4072 This works by using the face `org-hide' for these stars. This
4073 face is white for a light background, and black for a dark
4074 background. You may have to customize the face `org-hide' to
4075 make this work.
4076 Changing it requires restart of `font-lock-mode' to become effective
4077 also in regions already fontified.
4078 You may also set this on a per-file basis by adding one of the following
4079 lines to the buffer:
4081 #+STARTUP: hidestars
4082 #+STARTUP: showstars"
4083 :group 'org-appearance
4084 :type 'boolean)
4086 (defcustom org-hidden-keywords nil
4087 "List of symbols corresponding to keywords to be hidden the org buffer.
4088 For example, a value '(title) for this list will make the document's title
4089 appear in the buffer without the initial #+TITLE: keyword."
4090 :group 'org-appearance
4091 :version "24.1"
4092 :type '(set (const :tag "#+AUTHOR" author)
4093 (const :tag "#+DATE" date)
4094 (const :tag "#+EMAIL" email)
4095 (const :tag "#+TITLE" title)))
4097 (defcustom org-custom-properties nil
4098 "List of properties (as strings) with a special meaning.
4099 The default use of these custom properties is to let the user
4100 hide them with `org-toggle-custom-properties-visibility'."
4101 :group 'org-properties
4102 :group 'org-appearance
4103 :version "24.3"
4104 :type '(repeat (string :tag "Property Name")))
4106 (defcustom org-fontify-done-headline nil
4107 "Non-nil means change the face of a headline if it is marked DONE.
4108 Normally, only the TODO/DONE keyword indicates the state of a headline.
4109 When this is non-nil, the headline after the keyword is set to the
4110 `org-headline-done' as an additional indication."
4111 :group 'org-appearance
4112 :type 'boolean)
4114 (defcustom org-fontify-emphasized-text t
4115 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4116 Changing this variable requires a restart of Emacs to take effect."
4117 :group 'org-appearance
4118 :type 'boolean)
4120 (defcustom org-fontify-whole-heading-line nil
4121 "Non-nil means fontify the whole line for headings.
4122 This is useful when setting a background color for the
4123 org-level-* faces."
4124 :group 'org-appearance
4125 :type 'boolean)
4127 (defcustom org-highlight-latex-and-related nil
4128 "Non-nil means highlight LaTeX related syntax in the buffer.
4129 When non nil, the value should be a list containing any of the
4130 following symbols:
4131 `latex' Highlight LaTeX snippets and environments.
4132 `script' Highlight subscript and superscript.
4133 `entities' Highlight entities."
4134 :group 'org-appearance
4135 :version "24.4"
4136 :package-version '(Org . "8.0")
4137 :type '(choice
4138 (const :tag "No highlighting" nil)
4139 (set :greedy t :tag "Highlight"
4140 (const :tag "LaTeX snippets and environments" latex)
4141 (const :tag "Subscript and superscript" script)
4142 (const :tag "Entities" entities))))
4144 (defcustom org-hide-emphasis-markers nil
4145 "Non-nil mean font-lock should hide the emphasis marker characters."
4146 :group 'org-appearance
4147 :type 'boolean)
4149 (defcustom org-pretty-entities nil
4150 "Non-nil means show entities as UTF8 characters.
4151 When nil, the \\name form remains in the buffer."
4152 :group 'org-appearance
4153 :version "24.1"
4154 :type 'boolean)
4156 (defcustom org-pretty-entities-include-sub-superscripts t
4157 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4158 :group 'org-appearance
4159 :version "24.1"
4160 :type 'boolean)
4162 (defvar org-emph-re nil
4163 "Regular expression for matching emphasis.
4164 After a match, the match groups contain these elements:
4165 0 The match of the full regular expression, including the characters
4166 before and after the proper match
4167 1 The character before the proper match, or empty at beginning of line
4168 2 The proper match, including the leading and trailing markers
4169 3 The leading marker like * or /, indicating the type of highlighting
4170 4 The text between the emphasis markers, not including the markers
4171 5 The character after the match, empty at the end of a line")
4172 (defvar org-verbatim-re nil
4173 "Regular expression for matching verbatim text.")
4174 (defvar org-emphasis-regexp-components) ; defined just below
4175 (defvar org-emphasis-alist) ; defined just below
4176 (defun org-set-emph-re (var val)
4177 "Set variable and compute the emphasis regular expression."
4178 (set var val)
4179 (when (and (boundp 'org-emphasis-alist)
4180 (boundp 'org-emphasis-regexp-components)
4181 org-emphasis-alist org-emphasis-regexp-components)
4182 (let* ((e org-emphasis-regexp-components)
4183 (pre (car e))
4184 (post (nth 1 e))
4185 (border (nth 2 e))
4186 (body (nth 3 e))
4187 (nl (nth 4 e))
4188 (body1 (concat body "*?"))
4189 (markers (mapconcat 'car org-emphasis-alist ""))
4190 (vmarkers (mapconcat
4191 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4192 org-emphasis-alist "")))
4193 ;; make sure special characters appear at the right position in the class
4194 (if (string-match "\\^" markers)
4195 (setq markers (concat (replace-match "" t t markers) "^")))
4196 (if (string-match "-" markers)
4197 (setq markers (concat (replace-match "" t t markers) "-")))
4198 (if (string-match "\\^" vmarkers)
4199 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4200 (if (string-match "-" vmarkers)
4201 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4202 (if (> nl 0)
4203 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4204 (int-to-string nl) "\\}")))
4205 ;; Make the regexp
4206 (setq org-emph-re
4207 (concat "\\([" pre "]\\|^\\)"
4208 "\\("
4209 "\\([" markers "]\\)"
4210 "\\("
4211 "[^" border "]\\|"
4212 "[^" border "]"
4213 body1
4214 "[^" border "]"
4215 "\\)"
4216 "\\3\\)"
4217 "\\([" post "]\\|$\\)"))
4218 (setq org-verbatim-re
4219 (concat "\\([" pre "]\\|^\\)"
4220 "\\("
4221 "\\([" vmarkers "]\\)"
4222 "\\("
4223 "[^" border "]\\|"
4224 "[^" border "]"
4225 body1
4226 "[^" border "]"
4227 "\\)"
4228 "\\3\\)"
4229 "\\([" post "]\\|$\\)")))))
4231 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4232 ;; set this option proved cumbersome. See this message/thread:
4233 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4234 (defvar org-emphasis-regexp-components
4235 '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
4236 "Components used to build the regular expression for emphasis.
4237 This is a list with five entries. Terminology: In an emphasis string
4238 like \" *strong word* \", we call the initial space PREMATCH, the final
4239 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4240 and \"trong wor\" is the body. The different components in this variable
4241 specify what is allowed/forbidden in each part:
4243 pre Chars allowed as prematch. Beginning of line will be allowed too.
4244 post Chars allowed as postmatch. End of line will be allowed too.
4245 border The chars *forbidden* as border characters.
4246 body-regexp A regexp like \".\" to match a body character. Don't use
4247 non-shy groups here, and don't allow newline here.
4248 newline The maximum number of newlines allowed in an emphasis exp.
4250 You need to reload Org or to restart Emacs after customizing this.")
4252 (defcustom org-emphasis-alist
4253 `(("*" bold)
4254 ("/" italic)
4255 ("_" underline)
4256 ("=" org-code verbatim)
4257 ("~" org-verbatim verbatim)
4258 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4259 "Alist of characters and faces to emphasize text.
4260 Text starting and ending with a special character will be emphasized,
4261 for example *bold*, _underlined_ and /italic/. This variable sets the
4262 marker characters and the face to be used by font-lock for highlighting
4263 in Org-mode Emacs buffers.
4265 You need to reload Org or to restart Emacs after customizing this."
4266 :group 'org-appearance
4267 :set 'org-set-emph-re
4268 :version "24.4"
4269 :package-version '(Org . "8.0")
4270 :type '(repeat
4271 (list
4272 (string :tag "Marker character")
4273 (choice
4274 (face :tag "Font-lock-face")
4275 (plist :tag "Face property list"))
4276 (option (const verbatim)))))
4278 (defvar org-protecting-blocks
4279 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4280 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4281 This is needed for font-lock setup.")
4283 ;;; Miscellaneous options
4285 (defgroup org-completion nil
4286 "Completion in Org-mode."
4287 :tag "Org Completion"
4288 :group 'org)
4290 (defcustom org-completion-use-ido nil
4291 "Non-nil means use ido completion wherever possible.
4292 Note that `ido-mode' must be active for this variable to be relevant.
4293 If you decide to turn this variable on, you might well want to turn off
4294 `org-outline-path-complete-in-steps'.
4295 See also `org-completion-use-iswitchb'."
4296 :group 'org-completion
4297 :type 'boolean)
4299 (defcustom org-completion-use-iswitchb nil
4300 "Non-nil means use iswitchb completion wherever possible.
4301 Note that `iswitchb-mode' must be active for this variable to be relevant.
4302 If you decide to turn this variable on, you might well want to turn off
4303 `org-outline-path-complete-in-steps'.
4304 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4305 :group 'org-completion
4306 :type 'boolean)
4308 (defcustom org-completion-fallback-command 'hippie-expand
4309 "The expansion command called by \\[pcomplete] in normal context.
4310 Normal means, no org-mode-specific context."
4311 :group 'org-completion
4312 :type 'function)
4314 ;;; Functions and variables from their packages
4315 ;; Declared here to avoid compiler warnings
4317 ;; XEmacs only
4318 (defvar outline-mode-menu-heading)
4319 (defvar outline-mode-menu-show)
4320 (defvar outline-mode-menu-hide)
4321 (defvar zmacs-regions) ; XEmacs regions
4323 ;; Emacs only
4324 (defvar mark-active)
4326 ;; Various packages
4327 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4328 (declare-function calendar-forward-day "cal-move" (arg))
4329 (declare-function calendar-goto-date "cal-move" (date))
4330 (declare-function calendar-goto-today "cal-move" ())
4331 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4332 (defvar calc-embedded-close-formula)
4333 (defvar calc-embedded-open-formula)
4334 (declare-function cdlatex-tab "ext:cdlatex" ())
4335 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4336 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4337 (defvar font-lock-unfontify-region-function)
4338 (declare-function iswitchb-read-buffer "iswitchb"
4339 (prompt &optional default require-match start matches-set))
4340 (defvar iswitchb-temp-buflist)
4341 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4342 (defvar org-agenda-tags-todo-honor-ignore-options)
4343 (declare-function org-agenda-skip "org-agenda" ())
4344 (declare-function
4345 org-agenda-format-item "org-agenda"
4346 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4347 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4348 (declare-function org-agenda-change-all-lines "org-agenda"
4349 (newhead hdmarker &optional fixface just-this))
4350 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4351 (declare-function org-agenda-maybe-redo "org-agenda" ())
4352 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4353 (beg end))
4354 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4355 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4356 "org-agenda" (&optional end))
4357 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4358 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4359 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4360 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4361 (declare-function org-indent-mode "org-indent" (&optional arg))
4362 (declare-function parse-time-string "parse-time" (string))
4363 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4364 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4365 (defvar remember-data-file)
4366 (defvar texmathp-why)
4367 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4368 (declare-function table--at-cell-p "table" (position &optional object at-column))
4370 ;;;###autoload
4371 (defun turn-on-orgtbl ()
4372 "Unconditionally turn on `orgtbl-mode'."
4373 (require 'org-table)
4374 (orgtbl-mode 1))
4376 (defun org-at-table-p (&optional table-type)
4377 "Return t if the cursor is inside an org-type table.
4378 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4379 (if org-enable-table-editor
4380 (save-excursion
4381 (beginning-of-line 1)
4382 (looking-at (if table-type org-table-any-line-regexp
4383 org-table-line-regexp)))
4384 nil))
4385 (defsubst org-table-p () (org-at-table-p))
4387 (defun org-at-table.el-p ()
4388 "Return t if and only if we are at a table.el table."
4389 (and (org-at-table-p 'any)
4390 (save-excursion
4391 (goto-char (org-table-begin 'any))
4392 (looking-at org-table1-hline-regexp))))
4394 (defun org-table-recognize-table.el ()
4395 "If there is a table.el table nearby, recognize it and move into it."
4396 (if org-table-tab-recognizes-table.el
4397 (if (org-at-table.el-p)
4398 (progn
4399 (beginning-of-line 1)
4400 (if (looking-at org-table-dataline-regexp)
4402 (if (looking-at org-table1-hline-regexp)
4403 (progn
4404 (beginning-of-line 2)
4405 (if (looking-at org-table-any-border-regexp)
4406 (beginning-of-line -1)))))
4407 (if (re-search-forward "|" (org-table-end t) t)
4408 (progn
4409 (require 'table)
4410 (if (table--at-cell-p (point))
4412 (message "recognizing table.el table...")
4413 (table-recognize-table)
4414 (message "recognizing table.el table...done")))
4415 (error "This should not happen"))
4417 nil)
4418 nil))
4420 (defun org-at-table-hline-p ()
4421 "Return t if the cursor is inside a hline in a table."
4422 (if org-enable-table-editor
4423 (save-excursion
4424 (beginning-of-line 1)
4425 (looking-at org-table-hline-regexp))
4426 nil))
4428 (defun org-table-map-tables (function &optional quietly)
4429 "Apply FUNCTION to the start of all tables in the buffer."
4430 (save-excursion
4431 (save-restriction
4432 (widen)
4433 (goto-char (point-min))
4434 (while (re-search-forward org-table-any-line-regexp nil t)
4435 (unless quietly
4436 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4437 (beginning-of-line 1)
4438 (when (and (looking-at org-table-line-regexp)
4439 ;; Exclude tables in src/example/verbatim/clocktable blocks
4440 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4441 (save-excursion (funcall function))
4442 (or (looking-at org-table-line-regexp)
4443 (forward-char 1)))
4444 (re-search-forward org-table-any-border-regexp nil 1))))
4445 (unless quietly (message "Mapping tables: done")))
4447 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4448 (declare-function org-clock-update-mode-line "org-clock" ())
4449 (declare-function org-resolve-clocks "org-clock"
4450 (&optional also-non-dangling-p prompt last-valid))
4452 (defun org-at-TBLFM-p (&optional pos)
4453 "Return t when point (or POS) is in #+TBLFM line."
4454 (save-excursion
4455 (let ((pos pos)))
4456 (goto-char (or pos (point)))
4457 (beginning-of-line 1)
4458 (looking-at org-TBLFM-regexp)))
4460 (defvar org-clock-start-time)
4461 (defvar org-clock-marker (make-marker)
4462 "Marker recording the last clock-in.")
4463 (defvar org-clock-hd-marker (make-marker)
4464 "Marker recording the last clock-in, but the headline position.")
4465 (defvar org-clock-heading ""
4466 "The heading of the current clock entry.")
4467 (defun org-clock-is-active ()
4468 "Return the buffer where the clock is currently running.
4469 Return nil if no clock is running."
4470 (marker-buffer org-clock-marker))
4472 (defun org-check-running-clock ()
4473 "Check if the current buffer contains the running clock.
4474 If yes, offer to stop it and to save the buffer with the changes."
4475 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4476 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4477 (buffer-name))))
4478 (org-clock-out)
4479 (when (y-or-n-p "Save changed buffer?")
4480 (save-buffer))))
4482 (defun org-clocktable-try-shift (dir n)
4483 "Check if this line starts a clock table, if yes, shift the time block."
4484 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4485 (org-clocktable-shift dir n)))
4487 ;;;###autoload
4488 (defun org-clock-persistence-insinuate ()
4489 "Set up hooks for clock persistence."
4490 (require 'org-clock)
4491 (add-hook 'org-mode-hook 'org-clock-load)
4492 (add-hook 'kill-emacs-hook 'org-clock-save))
4494 ;; Define the variable already here, to make sure we have it.
4495 (defvar org-indent-mode nil
4496 "Non-nil if Org-Indent mode is enabled.
4497 Use the command `org-indent-mode' to change this variable.")
4499 ;; Autoload archiving code
4500 ;; The stuff that is needed for cycling and tags has to be defined here.
4502 (defgroup org-archive nil
4503 "Options concerning archiving in Org-mode."
4504 :tag "Org Archive"
4505 :group 'org-structure)
4507 (defcustom org-archive-location "%s_archive::"
4508 "The location where subtrees should be archived.
4510 The value of this variable is a string, consisting of two parts,
4511 separated by a double-colon. The first part is a filename and
4512 the second part is a headline.
4514 When the filename is omitted, archiving happens in the same file.
4515 %s in the filename will be replaced by the current file
4516 name (without the directory part). Archiving to a different file
4517 is useful to keep archived entries from contributing to the
4518 Org-mode Agenda.
4520 The archived entries will be filed as subtrees of the specified
4521 headline. When the headline is omitted, the subtrees are simply
4522 filed away at the end of the file, as top-level entries. Also in
4523 the heading you can use %s to represent the file name, this can be
4524 useful when using the same archive for a number of different files.
4526 Here are a few examples:
4527 \"%s_archive::\"
4528 If the current file is Projects.org, archive in file
4529 Projects.org_archive, as top-level trees. This is the default.
4531 \"::* Archived Tasks\"
4532 Archive in the current file, under the top-level headline
4533 \"* Archived Tasks\".
4535 \"~/org/archive.org::\"
4536 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4538 \"~/org/archive.org::* From %s\"
4539 Archive in file ~/org/archive.org (absolute path), under headlines
4540 \"From FILENAME\" where file name is the current file name.
4542 \"~/org/datetree.org::datetree/* Finished Tasks\"
4543 The \"datetree/\" string is special, signifying to archive
4544 items to the datetree. Items are placed in either the CLOSED
4545 date of the item, or the current date if there is no CLOSED date.
4546 The heading will be a subentry to the current date. There doesn't
4547 need to be a heading, but there always needs to be a slash after
4548 datetree. For example, to store archived items directly in the
4549 datetree, use \"~/org/datetree.org::datetree/\".
4551 \"basement::** Finished Tasks\"
4552 Archive in file ./basement (relative path), as level 3 trees
4553 below the level 2 heading \"** Finished Tasks\".
4555 You may set this option on a per-file basis by adding to the buffer a
4556 line like
4558 #+ARCHIVE: basement::** Finished Tasks
4560 You may also define it locally for a subtree by setting an ARCHIVE property
4561 in the entry. If such a property is found in an entry, or anywhere up
4562 the hierarchy, it will be used."
4563 :group 'org-archive
4564 :type 'string)
4566 (defcustom org-agenda-skip-archived-trees t
4567 "Non-nil means the agenda will skip any items located in archived trees.
4568 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4569 variable is no longer recommended, you should leave it at the value t.
4570 Instead, use the key `v' to cycle the archives-mode in the agenda."
4571 :group 'org-archive
4572 :group 'org-agenda-skip
4573 :type 'boolean)
4575 (defcustom org-columns-skip-archived-trees t
4576 "Non-nil means ignore archived trees when creating column view."
4577 :group 'org-archive
4578 :group 'org-properties
4579 :type 'boolean)
4581 (defcustom org-cycle-open-archived-trees nil
4582 "Non-nil means `org-cycle' will open archived trees.
4583 An archived tree is a tree marked with the tag ARCHIVE.
4584 When nil, archived trees will stay folded. You can still open them with
4585 normal outline commands like `show-all', but not with the cycling commands."
4586 :group 'org-archive
4587 :group 'org-cycle
4588 :type 'boolean)
4590 (defcustom org-sparse-tree-open-archived-trees nil
4591 "Non-nil means sparse tree construction shows matches in archived trees.
4592 When nil, matches in these trees are highlighted, but the trees are kept in
4593 collapsed state."
4594 :group 'org-archive
4595 :group 'org-sparse-trees
4596 :type 'boolean)
4598 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4599 "The default date type when building a sparse tree.
4600 When this is nil, a date is a scheduled or a deadline timestamp.
4601 Otherwise, these types are allowed:
4603 all: all timestamps
4604 active: only active timestamps (<...>)
4605 inactive: only inactive timestamps (<...)
4606 scheduled: only scheduled timestamps
4607 deadline: only deadline timestamps"
4608 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4609 (const :tag "All timestamps" all)
4610 (const :tag "Only active timestamps" active)
4611 (const :tag "Only inactive timestamps" inactive)
4612 (const :tag "Only scheduled timestamps" scheduled)
4613 (const :tag "Only deadline timestamps" deadline)
4614 (const :tag "Only closed timestamps" closed))
4615 :version "24.3"
4616 :group 'org-sparse-trees)
4618 (defun org-cycle-hide-archived-subtrees (state)
4619 "Re-hide all archived subtrees after a visibility state change."
4620 (when (and (not org-cycle-open-archived-trees)
4621 (not (memq state '(overview folded))))
4622 (save-excursion
4623 (let* ((globalp (memq state '(contents all)))
4624 (beg (if globalp (point-min) (point)))
4625 (end (if globalp (point-max) (org-end-of-subtree t))))
4626 (org-hide-archived-subtrees beg end)
4627 (goto-char beg)
4628 (if (looking-at (concat ".*:" org-archive-tag ":"))
4629 (message "%s" (substitute-command-keys
4630 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4632 (defun org-force-cycle-archived ()
4633 "Cycle subtree even if it is archived."
4634 (interactive)
4635 (setq this-command 'org-cycle)
4636 (let ((org-cycle-open-archived-trees t))
4637 (call-interactively 'org-cycle)))
4639 (defun org-hide-archived-subtrees (beg end)
4640 "Re-hide all archived subtrees after a visibility state change."
4641 (save-excursion
4642 (let* ((re (concat ":" org-archive-tag ":")))
4643 (goto-char beg)
4644 (while (re-search-forward re end t)
4645 (when (org-at-heading-p)
4646 (org-flag-subtree t)
4647 (org-end-of-subtree t))))))
4649 (declare-function outline-end-of-heading "outline" ())
4650 (declare-function outline-flag-region "outline" (from to flag))
4651 (defun org-flag-subtree (flag)
4652 (save-excursion
4653 (org-back-to-heading t)
4654 (outline-end-of-heading)
4655 (outline-flag-region (point)
4656 (progn (org-end-of-subtree t) (point))
4657 flag)))
4659 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4661 ;; Declare Column View Code
4663 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4664 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4665 (declare-function org-columns-compute "org-colview" (property))
4667 ;; Declare ID code
4669 (declare-function org-id-store-link "org-id")
4670 (declare-function org-id-locations-load "org-id")
4671 (declare-function org-id-locations-save "org-id")
4672 (defvar org-id-track-globally)
4674 ;;; Variables for pre-computed regular expressions, all buffer local
4676 (defvar org-todo-regexp nil
4677 "Matches any of the TODO state keywords.")
4678 (make-variable-buffer-local 'org-todo-regexp)
4679 (defvar org-not-done-regexp nil
4680 "Matches any of the TODO state keywords except the last one.")
4681 (make-variable-buffer-local 'org-not-done-regexp)
4682 (defvar org-not-done-heading-regexp nil
4683 "Matches a TODO headline that is not done.")
4684 (make-variable-buffer-local 'org-not-done-regexp)
4685 (defvar org-todo-line-regexp nil
4686 "Matches a headline and puts TODO state into group 2 if present.")
4687 (make-variable-buffer-local 'org-todo-line-regexp)
4688 (defvar org-complex-heading-regexp nil
4689 "Matches a headline and puts everything into groups:
4690 group 1: the stars
4691 group 2: The todo keyword, maybe
4692 group 3: Priority cookie
4693 group 4: True headline
4694 group 5: Tags")
4695 (make-variable-buffer-local 'org-complex-heading-regexp)
4696 (defvar org-complex-heading-regexp-format nil
4697 "Printf format to make regexp to match an exact headline.
4698 This regexp will match the headline of any node which has the
4699 exact headline text that is put into the format, but may have any
4700 TODO state, priority and tags.")
4701 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4702 (defvar org-todo-line-tags-regexp nil
4703 "Matches a headline and puts TODO state into group 2 if present.
4704 Also put tags into group 4 if tags are present.")
4705 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4706 (defvar org-ds-keyword-length 12
4707 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4708 (make-variable-buffer-local 'org-ds-keyword-length)
4709 (defvar org-deadline-regexp nil
4710 "Matches the DEADLINE keyword.")
4711 (make-variable-buffer-local 'org-deadline-regexp)
4712 (defvar org-deadline-time-regexp nil
4713 "Matches the DEADLINE keyword together with a time stamp.")
4714 (make-variable-buffer-local 'org-deadline-time-regexp)
4715 (defvar org-deadline-time-hour-regexp nil
4716 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4717 (make-variable-buffer-local 'org-deadline-time-hour-regexp)
4718 (defvar org-deadline-line-regexp nil
4719 "Matches the DEADLINE keyword and the rest of the line.")
4720 (make-variable-buffer-local 'org-deadline-line-regexp)
4721 (defvar org-scheduled-regexp nil
4722 "Matches the SCHEDULED keyword.")
4723 (make-variable-buffer-local 'org-scheduled-regexp)
4724 (defvar org-scheduled-time-regexp nil
4725 "Matches the SCHEDULED keyword together with a time stamp.")
4726 (make-variable-buffer-local 'org-scheduled-time-regexp)
4727 (defvar org-scheduled-time-hour-regexp nil
4728 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4729 (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
4730 (defvar org-closed-time-regexp nil
4731 "Matches the CLOSED keyword together with a time stamp.")
4732 (make-variable-buffer-local 'org-closed-time-regexp)
4734 (defvar org-keyword-time-regexp nil
4735 "Matches any of the 4 keywords, together with the time stamp.")
4736 (make-variable-buffer-local 'org-keyword-time-regexp)
4737 (defvar org-keyword-time-not-clock-regexp nil
4738 "Matches any of the 3 keywords, together with the time stamp.")
4739 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
4740 (defvar org-maybe-keyword-time-regexp nil
4741 "Matches a timestamp, possibly preceded by a keyword.")
4742 (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
4743 (defvar org-all-time-keywords nil
4744 "List of time keywords.")
4745 (make-variable-buffer-local 'org-all-time-keywords)
4747 (defconst org-plain-time-of-day-regexp
4748 (concat
4749 "\\(\\<[012]?[0-9]"
4750 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4751 "\\(--?"
4752 "\\(\\<[012]?[0-9]"
4753 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4754 "\\)?")
4755 "Regular expression to match a plain time or time range.
4756 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4757 groups carry important information:
4758 0 the full match
4759 1 the first time, range or not
4760 8 the second time, if it is a range.")
4762 (defconst org-plain-time-extension-regexp
4763 (concat
4764 "\\(\\<[012]?[0-9]"
4765 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4766 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4767 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4768 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4769 groups carry important information:
4770 0 the full match
4771 7 hours of duration
4772 9 minutes of duration")
4774 (defconst org-stamp-time-of-day-regexp
4775 (concat
4776 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4777 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4778 "\\(--?"
4779 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4780 "Regular expression to match a timestamp time or time range.
4781 After a match, the following groups carry important information:
4782 0 the full match
4783 1 date plus weekday, for back referencing to make sure both times are on the same day
4784 2 the first time, range or not
4785 4 the second time, if it is a range.")
4787 (defconst org-startup-options
4788 '(("fold" org-startup-folded t)
4789 ("overview" org-startup-folded t)
4790 ("nofold" org-startup-folded nil)
4791 ("showall" org-startup-folded nil)
4792 ("showeverything" org-startup-folded showeverything)
4793 ("content" org-startup-folded content)
4794 ("indent" org-startup-indented t)
4795 ("noindent" org-startup-indented nil)
4796 ("hidestars" org-hide-leading-stars t)
4797 ("showstars" org-hide-leading-stars nil)
4798 ("odd" org-odd-levels-only t)
4799 ("oddeven" org-odd-levels-only nil)
4800 ("align" org-startup-align-all-tables t)
4801 ("noalign" org-startup-align-all-tables nil)
4802 ("inlineimages" org-startup-with-inline-images t)
4803 ("noinlineimages" org-startup-with-inline-images nil)
4804 ("latexpreview" org-startup-with-latex-preview t)
4805 ("nolatexpreview" org-startup-with-latex-preview nil)
4806 ("customtime" org-display-custom-times t)
4807 ("logdone" org-log-done time)
4808 ("lognotedone" org-log-done note)
4809 ("nologdone" org-log-done nil)
4810 ("lognoteclock-out" org-log-note-clock-out t)
4811 ("nolognoteclock-out" org-log-note-clock-out nil)
4812 ("logrepeat" org-log-repeat state)
4813 ("lognoterepeat" org-log-repeat note)
4814 ("logdrawer" org-log-into-drawer t)
4815 ("nologdrawer" org-log-into-drawer nil)
4816 ("logstatesreversed" org-log-states-order-reversed t)
4817 ("nologstatesreversed" org-log-states-order-reversed nil)
4818 ("nologrepeat" org-log-repeat nil)
4819 ("logreschedule" org-log-reschedule time)
4820 ("lognotereschedule" org-log-reschedule note)
4821 ("nologreschedule" org-log-reschedule nil)
4822 ("logredeadline" org-log-redeadline time)
4823 ("lognoteredeadline" org-log-redeadline note)
4824 ("nologredeadline" org-log-redeadline nil)
4825 ("logrefile" org-log-refile time)
4826 ("lognoterefile" org-log-refile note)
4827 ("nologrefile" org-log-refile nil)
4828 ("fninline" org-footnote-define-inline t)
4829 ("nofninline" org-footnote-define-inline nil)
4830 ("fnlocal" org-footnote-section nil)
4831 ("fnauto" org-footnote-auto-label t)
4832 ("fnprompt" org-footnote-auto-label nil)
4833 ("fnconfirm" org-footnote-auto-label confirm)
4834 ("fnplain" org-footnote-auto-label plain)
4835 ("fnadjust" org-footnote-auto-adjust t)
4836 ("nofnadjust" org-footnote-auto-adjust nil)
4837 ("constcgs" constants-unit-system cgs)
4838 ("constSI" constants-unit-system SI)
4839 ("noptag" org-tag-persistent-alist nil)
4840 ("hideblocks" org-hide-block-startup t)
4841 ("nohideblocks" org-hide-block-startup nil)
4842 ("beamer" org-startup-with-beamer-mode t)
4843 ("entitiespretty" org-pretty-entities t)
4844 ("entitiesplain" org-pretty-entities nil))
4845 "Variable associated with STARTUP options for org-mode.
4846 Each element is a list of three items: the startup options (as written
4847 in the #+STARTUP line), the corresponding variable, and the value to set
4848 this variable to if the option is found. An optional forth element PUSH
4849 means to push this value onto the list in the variable.")
4851 (defun org-update-property-plist (key val props)
4852 "Update PROPS with KEY and VAL."
4853 (let* ((appending (string= "+" (substring key (- (length key) 1))))
4854 (key (if appending (substring key 0 (- (length key) 1)) key))
4855 (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
4856 (previous (cdr (assoc key props))))
4857 (if appending
4858 (cons (cons key (if previous (concat previous " " val) val)) remainder)
4859 (cons (cons key val) remainder))))
4861 (defcustom org-group-tags t
4862 "When non-nil (the default), use group tags.
4863 This can be turned on/off through `org-toggle-tags-groups'."
4864 :group 'org-tags
4865 :group 'org-startup
4866 :type 'boolean)
4868 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4870 (defun org-toggle-tags-groups ()
4871 "Toggle support for group tags.
4872 Support for group tags is controlled by the option
4873 `org-group-tags', which is non-nil by default."
4874 (interactive)
4875 (setq org-group-tags (not org-group-tags))
4876 (cond ((and (derived-mode-p 'org-agenda-mode)
4877 org-group-tags)
4878 (org-agenda-redo))
4879 ((derived-mode-p 'org-mode)
4880 (let ((org-inhibit-startup t)) (org-mode))))
4881 (message "Groups tags support has been turned %s"
4882 (if org-group-tags "on" "off")))
4884 (defun org-set-regexps-and-options-for-tags ()
4885 "Precompute variables used for tags."
4886 (when (derived-mode-p 'org-mode)
4887 (org-set-local 'org-file-tags nil)
4888 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4889 (splitre "[ \t]+")
4890 (start 0)
4891 tags ftags key value)
4892 (save-excursion
4893 (save-restriction
4894 (widen)
4895 (goto-char (point-min))
4896 (while (re-search-forward re nil t)
4897 (setq key (upcase (org-match-string-no-properties 1))
4898 value (org-match-string-no-properties 2))
4899 (if (stringp value) (setq value (org-trim value)))
4900 (cond
4901 ((equal key "TAGS")
4902 (setq tags (append tags (if tags '("\\n") nil)
4903 (org-split-string value splitre))))
4904 ((equal key "FILETAGS")
4905 (when (string-match "\\S-" value)
4906 (setq ftags
4907 (append
4908 ftags
4909 (apply 'append
4910 (mapcar (lambda (x) (org-split-string x ":"))
4911 (org-split-string value)))))))))))
4912 ;; Process the file tags.
4913 (and ftags (org-set-local 'org-file-tags
4914 (mapcar 'org-add-prop-inherited ftags)))
4915 (org-set-local 'org-tag-groups-alist nil)
4916 ;; Process the tags.
4917 (when (and (not tags) org-tag-alist)
4918 (setq tags
4919 (mapcar
4920 (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
4921 ((eq (car tg) :endgroup) "}")
4922 ((eq (car tg) :grouptags) ":")
4923 ((eq (car tg) :newline) "\n")
4924 (t (concat (car tg)
4925 (if (characterp (cdr tg))
4926 (format "(%s)" (char-to-string (cdr tg))) "")))))
4927 org-tag-alist)))
4928 (let (e tgs g)
4929 (while (setq e (pop tags))
4930 (cond
4931 ((equal e "{")
4932 (progn (push '(:startgroup) tgs)
4933 (when (equal (nth 1 tags) ":")
4934 (push (list (replace-regexp-in-string
4935 "(.+)$" "" (nth 0 tags)))
4936 org-tag-groups-alist)
4937 (setq g 0))))
4938 ((equal e ":") (push '(:grouptags) tgs))
4939 ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
4940 ((equal e "\\n") (push '(:newline) tgs))
4941 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
4942 (push (cons (match-string 1 e)
4943 (string-to-char (match-string 2 e))) tgs)
4944 (if (and g (> g 0))
4945 (setcar org-tag-groups-alist
4946 (append (car org-tag-groups-alist)
4947 (list (match-string 1 e)))))
4948 (if g (setq g (1+ g))))
4949 (t (push (list e) tgs)
4950 (if (and g (> g 0))
4951 (setcar org-tag-groups-alist
4952 (append (car org-tag-groups-alist) (list e))))
4953 (if g (setq g (1+ g))))))
4954 (org-set-local 'org-tag-alist nil)
4955 (while (setq e (pop tgs))
4956 (or (and (stringp (car e))
4957 (assoc (car e) org-tag-alist))
4958 (push e org-tag-alist)))
4959 ;; Return a list with tag variables
4960 (list org-file-tags org-tag-alist org-tag-groups-alist)))))
4962 (defvar org-ota nil)
4963 (defun org-set-regexps-and-options ()
4964 "Precompute regular expressions used in the current buffer."
4965 (when (derived-mode-p 'org-mode)
4966 (org-set-local 'org-todo-kwd-alist nil)
4967 (org-set-local 'org-todo-key-alist nil)
4968 (org-set-local 'org-todo-key-trigger nil)
4969 (org-set-local 'org-todo-keywords-1 nil)
4970 (org-set-local 'org-done-keywords nil)
4971 (org-set-local 'org-todo-heads nil)
4972 (org-set-local 'org-todo-sets nil)
4973 (org-set-local 'org-todo-log-states nil)
4974 (org-set-local 'org-file-properties nil)
4975 (let ((re (org-make-options-regexp
4976 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
4977 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
4978 "SETUPFILE" "OPTIONS")
4979 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4980 (splitre "[ \t]+")
4981 (scripts org-use-sub-superscripts)
4982 kwds kws0 kwsa key log value cat arch const links hw dws
4983 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4984 (start 0))
4985 (save-excursion
4986 (save-restriction
4987 (widen)
4988 (goto-char (point-min))
4989 (while
4990 (or (and
4991 ext-setup-or-nil
4992 (not org-ota)
4993 (let (ret)
4994 (with-temp-buffer
4995 (insert ext-setup-or-nil)
4996 (let ((major-mode 'org-mode) org-ota)
4997 (setq ret (save-match-data
4998 (org-set-regexps-and-options-for-tags)))))
4999 ;; Append setupfile tags to existing tags
5000 (setq org-ota t)
5001 (setq org-file-tags
5002 (delq nil (append org-file-tags (nth 0 ret)))
5003 org-tag-alist
5004 (delq nil (append org-tag-alist (nth 1 ret)))
5005 org-tag-groups-alist
5006 (delq nil (append org-tag-groups-alist (nth 2 ret))))))
5007 (and ext-setup-or-nil
5008 (string-match re ext-setup-or-nil start)
5009 (setq start (match-end 0)))
5010 (and (setq ext-setup-or-nil nil start 0)
5011 (re-search-forward re nil t)))
5012 (setq key (upcase (match-string 1 ext-setup-or-nil))
5013 value (org-match-string-no-properties 2 ext-setup-or-nil))
5014 (if (stringp value) (setq value (org-trim value)))
5015 (cond
5016 ((equal key "CATEGORY")
5017 (setq cat value))
5018 ((member key '("SEQ_TODO" "TODO"))
5019 (push (cons 'sequence (org-split-string value splitre)) kwds))
5020 ((equal key "TYP_TODO")
5021 (push (cons 'type (org-split-string value splitre)) kwds))
5022 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
5023 ;; general TODO-like setup
5024 (push (cons (intern (downcase (match-string 1 key)))
5025 (org-split-string value splitre)) kwds))
5026 ((equal key "COLUMNS")
5027 (org-set-local 'org-columns-default-format value))
5028 ((equal key "LINK")
5029 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5030 (push (cons (match-string 1 value)
5031 (org-trim (match-string 2 value)))
5032 links)))
5033 ((equal key "PRIORITIES")
5034 (setq prio (org-split-string value " +")))
5035 ((equal key "PROPERTY")
5036 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5037 (setq props (org-update-property-plist (match-string 1 value)
5038 (match-string 2 value)
5039 props))))
5040 ((equal key "CONSTANTS")
5041 (org-table-set-constants))
5042 ((equal key "STARTUP")
5043 (let ((opts (org-split-string value splitre))
5044 l var val)
5045 (while (setq l (pop opts))
5046 (when (setq l (assoc l org-startup-options))
5047 (setq var (nth 1 l) val (nth 2 l))
5048 (if (not (nth 3 l))
5049 (set (make-local-variable var) val)
5050 (if (not (listp (symbol-value var)))
5051 (set (make-local-variable var) nil))
5052 (set (make-local-variable var) (symbol-value var))
5053 (add-to-list var val))))))
5054 ((equal key "ARCHIVE")
5055 (setq arch value)
5056 (remove-text-properties 0 (length arch)
5057 '(face t fontified t) arch))
5058 ((equal key "OPTIONS")
5059 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
5060 (setq scripts (read (match-string 2 value)))))
5061 ((and (equal key "SETUPFILE")
5062 ;; Prevent checking in Gnus messages
5063 (not buffer-read-only))
5064 (setq setup-contents (org-file-contents
5065 (expand-file-name
5066 (org-remove-double-quotes value))
5067 'noerror))
5068 (if (not ext-setup-or-nil)
5069 (setq ext-setup-or-nil setup-contents start 0)
5070 (setq ext-setup-or-nil
5071 (concat (substring ext-setup-or-nil 0 start)
5072 "\n" setup-contents "\n"
5073 (substring ext-setup-or-nil start)))))))
5074 ;; search for property blocks
5075 (goto-char (point-min))
5076 (while (re-search-forward org-block-regexp nil t)
5077 (when (equal "PROPERTY" (upcase (match-string 1)))
5078 (setq value (replace-regexp-in-string
5079 "[\n\r]" " " (match-string 4)))
5080 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5081 (setq props (org-update-property-plist (match-string 1 value)
5082 (match-string 2 value)
5083 props)))))))
5084 (org-set-local 'org-use-sub-superscripts scripts)
5085 (when cat
5086 (org-set-local 'org-category (intern cat))
5087 (push (cons "CATEGORY" cat) props))
5088 (when prio
5089 (if (< (length prio) 3) (setq prio '("A" "C" "B")))
5090 (setq prio (mapcar 'string-to-char prio))
5091 (org-set-local 'org-highest-priority (nth 0 prio))
5092 (org-set-local 'org-lowest-priority (nth 1 prio))
5093 (org-set-local 'org-default-priority (nth 2 prio)))
5094 (and props (org-set-local 'org-file-properties (nreverse props)))
5095 (and arch (org-set-local 'org-archive-location arch))
5096 (and links (setq org-link-abbrev-alist-local (nreverse links)))
5097 ;; Process the TODO keywords
5098 (unless kwds
5099 ;; Use the global values as if they had been given locally.
5100 (setq kwds (default-value 'org-todo-keywords))
5101 (if (stringp (car kwds))
5102 (setq kwds (list (cons org-todo-interpretation
5103 (default-value 'org-todo-keywords)))))
5104 (setq kwds (reverse kwds)))
5105 (setq kwds (nreverse kwds))
5106 (let (inter kws kw)
5107 (while (setq kws (pop kwds))
5108 (let ((kws (or
5109 (run-hook-with-args-until-success
5110 'org-todo-setup-filter-hook kws)
5111 kws)))
5112 (setq inter (pop kws) sep (member "|" kws)
5113 kws0 (delete "|" (copy-sequence kws))
5114 kwsa nil
5115 kws1 (mapcar
5116 (lambda (x)
5117 ;; 1 2
5118 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
5119 (progn
5120 (setq kw (match-string 1 x)
5121 key (and (match-end 2) (match-string 2 x))
5122 log (org-extract-log-state-settings x))
5123 (push (cons kw (and key (string-to-char key))) kwsa)
5124 (and log (push log org-todo-log-states))
5126 (error "Invalid TODO keyword %s" x)))
5127 kws0)
5128 kwsa (if kwsa (append '((:startgroup))
5129 (nreverse kwsa)
5130 '((:endgroup))))
5131 hw (car kws1)
5132 dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
5133 tail (list inter hw (car dws) (org-last dws))))
5134 (add-to-list 'org-todo-heads hw 'append)
5135 (push kws1 org-todo-sets)
5136 (setq org-done-keywords (append org-done-keywords dws nil))
5137 (setq org-todo-key-alist (append org-todo-key-alist kwsa))
5138 (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
5139 (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
5140 (setq org-todo-sets (nreverse org-todo-sets)
5141 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5142 org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
5143 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
5144 ;; Compute the regular expressions and other local variables.
5145 ;; Using `org-outline-regexp-bol' would complicate them much,
5146 ;; because of the fixed white space at the end of that string.
5147 (if (not org-done-keywords)
5148 (setq org-done-keywords (and org-todo-keywords-1
5149 (list (org-last org-todo-keywords-1)))))
5150 (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
5151 (length org-scheduled-string)
5152 (length org-clock-string)
5153 (length org-closed-string)))
5154 org-not-done-keywords
5155 (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
5156 org-todo-regexp
5157 (concat "\\("
5158 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
5159 "\\)")
5160 org-not-done-regexp
5161 (concat "\\("
5162 (mapconcat 'regexp-quote org-not-done-keywords "\\|")
5163 "\\)")
5164 org-not-done-heading-regexp
5165 (format org-heading-keyword-regexp-format org-not-done-regexp)
5166 org-todo-line-regexp
5167 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5168 org-complex-heading-regexp
5169 (concat "^\\(\\*+\\)"
5170 "\\(?: +" org-todo-regexp "\\)?"
5171 "\\(?: +\\(\\[#.\\]\\)\\)?"
5172 "\\(?: +\\(.*?\\)\\)??"
5173 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5174 "[ \t]*$")
5175 org-complex-heading-regexp-format
5176 (concat "^\\(\\*+\\)"
5177 "\\(?: +" org-todo-regexp "\\)?"
5178 "\\(?: +\\(\\[#.\\]\\)\\)?"
5179 "\\(?: +"
5180 ;; Stats cookies can be stuck to body.
5181 "\\(?:\\[[0-9%%/]+\\] *\\)?"
5182 "\\(%s\\)"
5183 "\\(?: *\\[[0-9%%/]+\\]\\)?"
5184 "\\)"
5185 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5186 "[ \t]*$")
5187 org-todo-line-tags-regexp
5188 (concat "^\\(\\*+\\)"
5189 "\\(?: +" org-todo-regexp "\\)?"
5190 "\\(?: +\\(.*?\\)\\)??"
5191 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5192 "[ \t]*$")
5193 org-deadline-regexp (concat "\\<" org-deadline-string)
5194 org-deadline-time-regexp
5195 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
5196 org-deadline-time-hour-regexp
5197 (concat "\\<" org-deadline-string
5198 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5199 org-deadline-line-regexp
5200 (concat "\\<\\(" org-deadline-string "\\).*")
5201 org-scheduled-regexp
5202 (concat "\\<" org-scheduled-string)
5203 org-scheduled-time-regexp
5204 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
5205 org-scheduled-time-hour-regexp
5206 (concat "\\<" org-scheduled-string
5207 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5208 org-closed-time-regexp
5209 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
5210 org-keyword-time-regexp
5211 (concat "\\<\\(" org-scheduled-string
5212 "\\|" org-deadline-string
5213 "\\|" org-closed-string
5214 "\\|" org-clock-string "\\)"
5215 " *[[<]\\([^]>]+\\)[]>]")
5216 org-keyword-time-not-clock-regexp
5217 (concat "\\<\\(" org-scheduled-string
5218 "\\|" org-deadline-string
5219 "\\|" org-closed-string
5220 "\\)"
5221 " *[[<]\\([^]>]+\\)[]>]")
5222 org-maybe-keyword-time-regexp
5223 (concat "\\(\\<\\(" org-scheduled-string
5224 "\\|" org-deadline-string
5225 "\\|" org-closed-string
5226 "\\|" org-clock-string "\\)\\)?"
5227 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5228 org-all-time-keywords
5229 (mapcar (lambda (w) (substring w 0 -1))
5230 (list org-scheduled-string org-deadline-string
5231 org-clock-string org-closed-string)))
5232 (setq org-ota nil)
5233 (org-compute-latex-and-related-regexp))))
5235 (defun org-file-contents (file &optional noerror)
5236 "Return the contents of FILE, as a string."
5237 (if (or (not file)
5238 (not (file-readable-p file)))
5239 (if noerror
5240 (message "Cannot read file \"%s\"" file)
5241 (error "Cannot read file \"%s\"" file))
5242 (with-temp-buffer
5243 (insert-file-contents file)
5244 (buffer-string))))
5246 (defun org-extract-log-state-settings (x)
5247 "Extract the log state setting from a TODO keyword string.
5248 This will extract info from a string like \"WAIT(w@/!)\"."
5249 (let (kw key log1 log2)
5250 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5251 (setq kw (match-string 1 x)
5252 key (and (match-end 2) (match-string 2 x))
5253 log1 (and (match-end 3) (match-string 3 x))
5254 log2 (and (match-end 4) (match-string 4 x)))
5255 (and (or log1 log2)
5256 (list kw
5257 (and log1 (if (equal log1 "!") 'time 'note))
5258 (and log2 (if (equal log2 "!") 'time 'note)))))))
5260 (defun org-remove-keyword-keys (list)
5261 "Remove a pair of parenthesis at the end of each string in LIST."
5262 (mapcar (lambda (x)
5263 (if (string-match "(.*)$" x)
5264 (substring x 0 (match-beginning 0))
5266 list))
5268 (defun org-assign-fast-keys (alist)
5269 "Assign fast keys to a keyword-key alist.
5270 Respect keys that are already there."
5271 (let (new e (alt ?0))
5272 (while (setq e (pop alist))
5273 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5274 (cdr e)) ;; Key already assigned.
5275 (push e new)
5276 (let ((clist (string-to-list (downcase (car e))))
5277 (used (append new alist)))
5278 (when (= (car clist) ?@)
5279 (pop clist))
5280 (while (and clist (rassoc (car clist) used))
5281 (pop clist))
5282 (unless clist
5283 (while (rassoc alt used)
5284 (incf alt)))
5285 (push (cons (car e) (or (car clist) alt)) new))))
5286 (nreverse new)))
5288 ;;; Some variables used in various places
5290 (defvar org-window-configuration nil
5291 "Used in various places to store a window configuration.")
5292 (defvar org-selected-window nil
5293 "Used in various places to store a window configuration.")
5294 (defvar org-finish-function nil
5295 "Function to be called when `C-c C-c' is used.
5296 This is for getting out of special buffers like capture.")
5299 ;; FIXME: Occasionally check by commenting these, to make sure
5300 ;; no other functions uses these, forgetting to let-bind them.
5301 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5302 (defvar org-last-state)
5303 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5305 ;; Defined somewhere in this file, but used before definition.
5306 (defvar org-entities) ;; defined in org-entities.el
5307 (defvar org-struct-menu)
5308 (defvar org-org-menu)
5309 (defvar org-tbl-menu)
5311 ;;;; Define the Org-mode
5313 ;; We use a before-change function to check if a table might need
5314 ;; an update.
5315 (defvar org-table-may-need-update t
5316 "Indicates that a table might need an update.
5317 This variable is set by `org-before-change-function'.
5318 `org-table-align' sets it back to nil.")
5319 (defun org-before-change-function (beg end)
5320 "Every change indicates that a table might need an update."
5321 (setq org-table-may-need-update t))
5322 (defvar org-mode-map)
5323 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5324 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5325 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5326 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5327 (defvar org-table-buffer-is-an nil)
5329 (defvar bidi-paragraph-direction)
5330 (defvar buffer-face-mode-face)
5332 (require 'outline)
5333 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5334 (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"))
5335 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5337 ;; Other stuff we need.
5338 (require 'time-date)
5339 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5340 (require 'easymenu)
5341 (require 'overlay)
5343 ;; (require 'org-macs) moved higher up in the file before it is first used
5344 (require 'org-entities)
5345 ;; (require 'org-compat) moved higher up in the file before it is first used
5346 (require 'org-faces)
5347 (require 'org-list)
5348 (require 'org-pcomplete)
5349 (require 'org-src)
5350 (require 'org-footnote)
5351 (require 'org-macro)
5353 ;; babel
5354 (require 'ob)
5356 ;;;###autoload
5357 (define-derived-mode org-mode outline-mode "Org"
5358 "Outline-based notes management and organizer, alias
5359 \"Carsten's outline-mode for keeping track of everything.\"
5361 Org-mode develops organizational tasks around a NOTES file which
5362 contains information about projects as plain text. Org-mode is
5363 implemented on top of outline-mode, which is ideal to keep the content
5364 of large files well structured. It supports ToDo items, deadlines and
5365 time stamps, which magically appear in the diary listing of the Emacs
5366 calendar. Tables are easily created with a built-in table editor.
5367 Plain text URL-like links connect to websites, emails (VM), Usenet
5368 messages (Gnus), BBDB entries, and any files related to the project.
5369 For printing and sharing of notes, an Org-mode file (or a part of it)
5370 can be exported as a structured ASCII or HTML file.
5372 The following commands are available:
5374 \\{org-mode-map}"
5376 ;; Get rid of Outline menus, they are not needed
5377 ;; Need to do this here because define-derived-mode sets up
5378 ;; the keymap so late. Still, it is a waste to call this each time
5379 ;; we switch another buffer into org-mode.
5380 (if (featurep 'xemacs)
5381 (when (boundp 'outline-mode-menu-heading)
5382 ;; Assume this is Greg's port, it uses easymenu
5383 (easy-menu-remove outline-mode-menu-heading)
5384 (easy-menu-remove outline-mode-menu-show)
5385 (easy-menu-remove outline-mode-menu-hide))
5386 (define-key org-mode-map [menu-bar headings] 'undefined)
5387 (define-key org-mode-map [menu-bar hide] 'undefined)
5388 (define-key org-mode-map [menu-bar show] 'undefined))
5390 (org-load-modules-maybe)
5391 (easy-menu-add org-org-menu)
5392 (easy-menu-add org-tbl-menu)
5393 (org-install-agenda-files-menu)
5394 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5395 (add-to-invisibility-spec '(org-cwidth))
5396 (add-to-invisibility-spec '(org-hide-block . t))
5397 (when (featurep 'xemacs)
5398 (org-set-local 'line-move-ignore-invisible t))
5399 (org-set-local 'outline-regexp org-outline-regexp)
5400 (org-set-local 'outline-level 'org-outline-level)
5401 (setq bidi-paragraph-direction 'left-to-right)
5402 (when (and org-ellipsis
5403 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5404 (fboundp 'make-glyph-code))
5405 (unless org-display-table
5406 (setq org-display-table (make-display-table)))
5407 (set-display-table-slot
5408 org-display-table 4
5409 (vconcat (mapcar
5410 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5411 org-ellipsis)))
5412 (if (stringp org-ellipsis) org-ellipsis "..."))))
5413 (setq buffer-display-table org-display-table))
5414 (org-set-regexps-and-options-for-tags)
5415 (org-set-regexps-and-options)
5416 (org-set-font-lock-defaults)
5417 (when (and org-tag-faces (not org-tags-special-faces-re))
5418 ;; tag faces set outside customize.... force initialization.
5419 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5420 ;; Calc embedded
5421 (org-set-local 'calc-embedded-open-mode "# ")
5422 ;; Modify a few syntax entries
5423 (modify-syntax-entry ?@ "w")
5424 (modify-syntax-entry ?\" "\"")
5425 (if org-startup-truncated (setq truncate-lines t))
5426 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5427 (org-set-local 'font-lock-unfontify-region-function
5428 'org-unfontify-region)
5429 ;; Activate before-change-function
5430 (org-set-local 'org-table-may-need-update t)
5431 (org-add-hook 'before-change-functions 'org-before-change-function nil
5432 'local)
5433 ;; Check for running clock before killing a buffer
5434 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5435 ;; Initialize macros templates.
5436 (org-macro-initialize-templates)
5437 ;; Initialize radio targets.
5438 (org-update-radio-target-regexp)
5439 ;; Indentation.
5440 (org-set-local 'indent-line-function 'org-indent-line)
5441 (org-set-local 'indent-region-function 'org-indent-region)
5442 ;; Filling and auto-filling.
5443 (org-setup-filling)
5444 ;; Comments.
5445 (org-setup-comments-handling)
5446 ;; Initialize cache.
5447 (org-element-cache-reset)
5448 ;; Beginning/end of defun
5449 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5450 (org-set-local 'end-of-defun-function 'org-forward-element)
5451 ;; Next error for sparse trees
5452 (org-set-local 'next-error-function 'org-occur-next-match)
5453 ;; Make sure dependence stuff works reliably, even for users who set it
5454 ;; too late :-(
5455 (if org-enforce-todo-dependencies
5456 (add-hook 'org-blocker-hook
5457 'org-block-todo-from-children-or-siblings-or-parent)
5458 (remove-hook 'org-blocker-hook
5459 'org-block-todo-from-children-or-siblings-or-parent))
5460 (if org-enforce-todo-checkbox-dependencies
5461 (add-hook 'org-blocker-hook
5462 'org-block-todo-from-checkboxes)
5463 (remove-hook 'org-blocker-hook
5464 'org-block-todo-from-checkboxes))
5466 ;; Align options lines
5467 (org-set-local
5468 'align-mode-rules-list
5469 '((org-in-buffer-settings
5470 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5471 (modes . '(org-mode)))))
5473 ;; Imenu
5474 (org-set-local 'imenu-create-index-function
5475 'org-imenu-get-tree)
5477 ;; Make isearch reveal context
5478 (if (or (featurep 'xemacs)
5479 (not (boundp 'outline-isearch-open-invisible-function)))
5480 ;; Emacs 21 and XEmacs make use of the hook
5481 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5482 ;; Emacs 22 deals with this through a special variable
5483 (org-set-local 'outline-isearch-open-invisible-function
5484 (lambda (&rest ignore) (org-show-context 'isearch)))
5485 (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
5487 ;; Setup the pcomplete hooks
5488 (set (make-local-variable 'pcomplete-command-completion-function)
5489 'org-pcomplete-initial)
5490 (set (make-local-variable 'pcomplete-command-name-function)
5491 'org-command-at-point)
5492 (set (make-local-variable 'pcomplete-default-completion-function)
5493 'ignore)
5494 (set (make-local-variable 'pcomplete-parse-arguments-function)
5495 'org-parse-arguments)
5496 (set (make-local-variable 'pcomplete-termination-string) "")
5497 (when (>= emacs-major-version 23)
5498 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5500 ;; If empty file that did not turn on org-mode automatically, make it to.
5501 (if (and org-insert-mode-line-in-empty-file
5502 (org-called-interactively-p 'any)
5503 (= (point-min) (point-max)))
5504 (insert "# -*- mode: org -*-\n\n"))
5505 (unless org-inhibit-startup
5506 (org-unmodified
5507 (and org-startup-with-beamer-mode (org-beamer-mode))
5508 (when org-startup-align-all-tables
5509 (org-table-map-tables 'org-table-align 'quietly))
5510 (when org-startup-with-inline-images
5511 (org-display-inline-images))
5512 (when org-startup-with-latex-preview
5513 (org-preview-latex-fragment))
5514 (unless org-inhibit-startup-visibility-stuff
5515 (org-set-startup-visibility))))
5516 ;; Try to set org-hide correctly
5517 (set-face-foreground 'org-hide (org-find-invisible-foreground)))
5519 ;; Update `customize-package-emacs-version-alist'
5520 (add-to-list 'customize-package-emacs-version-alist
5521 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5522 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5523 ("8.0" . "24.4")))
5525 (defvar org-mode-transpose-word-syntax-table
5526 (let ((st (make-syntax-table)))
5527 (mapc (lambda(c) (modify-syntax-entry
5528 (string-to-char (car c)) "w p" st))
5529 org-emphasis-alist)
5530 st))
5532 (when (fboundp 'abbrev-table-put)
5533 (abbrev-table-put org-mode-abbrev-table
5534 :parents (list text-mode-abbrev-table)))
5536 (defsubst org-fix-ellipsis-at-bol ()
5537 (save-excursion (goto-char (window-start)) (recenter 0)))
5539 (defun org-find-invisible-foreground ()
5540 (let ((candidates (remove
5541 "unspecified-bg"
5542 (nconc
5543 (list (face-background 'default)
5544 (face-background 'org-default))
5545 (mapcar
5546 (lambda (alist)
5547 (when (boundp alist)
5548 (cdr (assoc 'background-color (symbol-value alist)))))
5549 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5550 (list (face-foreground 'org-hide))))))
5551 (car (remove nil candidates))))
5553 (defun org-current-time (&optional rounding-minutes past)
5554 "Current time, possibly rounded to ROUNDING-MINUTES.
5555 When ROUNDING-MINUTES is not an integer, fall back on the car of
5556 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5557 the rounding returns a past time."
5558 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5559 (car org-time-stamp-rounding-minutes)))
5560 (time (decode-time)) res)
5561 (if (< r 1)
5562 (current-time)
5563 (setq res
5564 (apply 'encode-time
5565 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5566 (nthcdr 2 time))))
5567 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5568 (seconds-to-time (- (org-float-time res) (* r 60)))
5569 res))))
5571 (defun org-today ()
5572 "Return today date, considering `org-extend-today-until'."
5573 (time-to-days
5574 (time-subtract (current-time)
5575 (list 0 (* 3600 org-extend-today-until) 0))))
5577 ;;;; Font-Lock stuff, including the activators
5579 (defvar org-mouse-map (make-sparse-keymap))
5580 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5581 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5582 (when org-mouse-1-follows-link
5583 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5584 (when org-tab-follows-link
5585 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5586 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5588 (require 'font-lock)
5590 (defconst org-non-link-chars "]\t\n\r<>")
5591 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5592 "shell" "elisp" "doi" "message"))
5593 (defvar org-link-types-re nil
5594 "Matches a link that has a url-like prefix like \"http:\"")
5595 (defvar org-link-re-with-space nil
5596 "Matches a link with spaces, optional angular brackets around it.")
5597 (defvar org-link-re-with-space2 nil
5598 "Matches a link with spaces, optional angular brackets around it.")
5599 (defvar org-link-re-with-space3 nil
5600 "Matches a link with spaces, only for internal part in bracket links.")
5601 (defvar org-angle-link-re nil
5602 "Matches link with angular brackets, spaces are allowed.")
5603 (defvar org-plain-link-re nil
5604 "Matches plain link, without spaces.")
5605 (defvar org-bracket-link-regexp nil
5606 "Matches a link in double brackets.")
5607 (defvar org-bracket-link-analytic-regexp nil
5608 "Regular expression used to analyze links.
5609 Here is what the match groups contain after a match:
5610 1: http:
5611 2: http
5612 3: path
5613 4: [desc]
5614 5: desc")
5615 (defvar org-bracket-link-analytic-regexp++ nil
5616 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5617 (defvar org-any-link-re nil
5618 "Regular expression matching any link.")
5620 (defconst org-match-sexp-depth 3
5621 "Number of stacked braces for sub/superscript matching.")
5623 (defun org-create-multibrace-regexp (left right n)
5624 "Create a regular expression which will match a balanced sexp.
5625 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5626 as single character strings.
5627 The regexp returned will match the entire expression including the
5628 delimiters. It will also define a single group which contains the
5629 match except for the outermost delimiters. The maximum depth of
5630 stacked delimiters is N. Escaping delimiters is not possible."
5631 (let* ((nothing (concat "[^" left right "]*?"))
5632 (or "\\|")
5633 (re nothing)
5634 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5635 (while (> n 1)
5636 (setq n (1- n)
5637 re (concat re or next)
5638 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5639 (concat left "\\(" re "\\)" right)))
5641 (defconst org-match-substring-regexp
5642 (concat
5643 "\\(\\S-\\)\\([_^]\\)\\("
5644 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5645 "\\|"
5646 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5647 "\\|"
5648 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5649 "The regular expression matching a sub- or superscript.")
5651 (defconst org-match-substring-with-braces-regexp
5652 (concat
5653 "\\(\\S-\\)\\([_^]\\)"
5654 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5655 "The regular expression matching a sub- or superscript, forcing braces.")
5657 (defun org-make-link-regexps ()
5658 "Update the link regular expressions.
5659 This should be called after the variable `org-link-types' has changed."
5660 (setq org-link-types-re
5661 (concat
5662 "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
5663 org-link-re-with-space
5664 (concat
5665 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5666 "\\([^" org-non-link-chars " ]"
5667 "[^" org-non-link-chars "]*"
5668 "[^" org-non-link-chars " ]\\)>?")
5669 org-link-re-with-space2
5670 (concat
5671 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5672 "\\([^" org-non-link-chars " ]"
5673 "[^\t\n\r]*"
5674 "[^" org-non-link-chars " ]\\)>?")
5675 org-link-re-with-space3
5676 (concat
5677 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5678 "\\([^" org-non-link-chars " ]"
5679 "[^\t\n\r]*\\)")
5680 org-angle-link-re
5681 (concat
5682 "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5683 "\\([^" org-non-link-chars " ]"
5684 "[^" org-non-link-chars "]*"
5685 "\\)>")
5686 org-plain-link-re
5687 (concat
5688 "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5689 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5690 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5691 org-bracket-link-regexp
5692 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5693 org-bracket-link-analytic-regexp
5694 (concat
5695 "\\[\\["
5696 "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
5697 "\\([^]]+\\)"
5698 "\\]"
5699 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5700 "\\]")
5701 org-bracket-link-analytic-regexp++
5702 (concat
5703 "\\[\\["
5704 "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
5705 "\\([^]]+\\)"
5706 "\\]"
5707 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5708 "\\]")
5709 org-any-link-re
5710 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5711 org-angle-link-re "\\)\\|\\("
5712 org-plain-link-re "\\)")))
5714 (org-make-link-regexps)
5716 (defvar org-emph-face nil)
5718 (defun org-do-emphasis-faces (limit)
5719 "Run through the buffer and add overlays to emphasized strings."
5720 (let (rtn a)
5721 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5722 (if (not (= (char-after (match-beginning 3))
5723 (char-after (match-beginning 4))))
5724 (progn
5725 (setq rtn t)
5726 (setq a (assoc (match-string 3) org-emphasis-alist))
5727 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5728 'face
5729 (nth 1 a))
5730 (and (nth 2 a)
5731 (org-remove-flyspell-overlays-in
5732 (match-beginning 0) (match-end 0)))
5733 (add-text-properties (match-beginning 2) (match-end 2)
5734 '(font-lock-multiline t org-emphasis t))
5735 (when org-hide-emphasis-markers
5736 (add-text-properties (match-end 4) (match-beginning 5)
5737 '(invisible org-link))
5738 (add-text-properties (match-beginning 3) (match-end 3)
5739 '(invisible org-link)))))
5740 (goto-char (1+ (match-beginning 0))))
5741 rtn))
5743 (defun org-emphasize (&optional char)
5744 "Insert or change an emphasis, i.e. a font like bold or italic.
5745 If there is an active region, change that region to a new emphasis.
5746 If there is no region, just insert the marker characters and position
5747 the cursor between them.
5748 CHAR should be the marker character. If it is a space, it means to
5749 remove the emphasis of the selected region.
5750 If CHAR is not given (for example in an interactive call) it will be
5751 prompted for."
5752 (interactive)
5753 (let ((erc org-emphasis-regexp-components)
5754 (prompt "")
5755 (string "") beg end move c s)
5756 (if (org-region-active-p)
5757 (setq beg (region-beginning) end (region-end)
5758 string (buffer-substring beg end))
5759 (setq move t))
5761 (unless char
5762 (message "Emphasis marker or tag: [%s]"
5763 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5764 (setq char (read-char-exclusive)))
5765 (if (equal char ?\ )
5766 (setq s "" move nil)
5767 (unless (assoc (char-to-string char) org-emphasis-alist)
5768 (user-error "No such emphasis marker: \"%c\"" char))
5769 (setq s (char-to-string char)))
5770 (while (and (> (length string) 1)
5771 (equal (substring string 0 1) (substring string -1))
5772 (assoc (substring string 0 1) org-emphasis-alist))
5773 (setq string (substring string 1 -1)))
5774 (setq string (concat s string s))
5775 (if beg (delete-region beg end))
5776 (unless (or (bolp)
5777 (string-match (concat "[" (nth 0 erc) "\n]")
5778 (char-to-string (char-before (point)))))
5779 (insert " "))
5780 (unless (or (eobp)
5781 (string-match (concat "[" (nth 1 erc) "\n]")
5782 (char-to-string (char-after (point)))))
5783 (insert " ") (backward-char 1))
5784 (insert string)
5785 (and move (backward-char 1))))
5787 (defconst org-nonsticky-props
5788 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5790 (defsubst org-rear-nonsticky-at (pos)
5791 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5793 (defun org-activate-plain-links (limit)
5794 "Run through the buffer and add overlays to links."
5795 (let (f hl)
5796 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5797 (not (org-in-src-block-p)))
5798 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5799 (setq f (get-text-property (match-beginning 0) 'face))
5800 (setq hl (org-match-string-no-properties 0))
5801 (if (or (eq f 'org-tag)
5802 (and (listp f) (memq 'org-tag f)))
5804 (add-text-properties (match-beginning 0) (match-end 0)
5805 (list 'mouse-face 'highlight
5806 'face 'org-link
5807 'htmlize-link `(:uri ,hl)
5808 'keymap org-mouse-map))
5809 (org-rear-nonsticky-at (match-end 0)))
5810 t)))
5812 (defun org-activate-code (limit)
5813 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5814 (progn
5815 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5816 (remove-text-properties (match-beginning 0) (match-end 0)
5817 '(display t invisible t intangible t))
5818 t)))
5820 (defcustom org-src-fontify-natively nil
5821 "When non-nil, fontify code in code blocks."
5822 :type 'boolean
5823 :version "24.1"
5824 :group 'org-appearance
5825 :group 'org-babel)
5827 (defcustom org-allow-promoting-top-level-subtree nil
5828 "When non-nil, allow promoting a top level subtree.
5829 The leading star of the top level headline will be replaced
5830 by a #."
5831 :type 'boolean
5832 :version "24.1"
5833 :group 'org-appearance)
5835 (defun org-fontify-meta-lines-and-blocks (limit)
5836 (condition-case nil
5837 (org-fontify-meta-lines-and-blocks-1 limit)
5838 (error (message "org-mode fontification error"))))
5840 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5841 "Fontify #+ lines and blocks."
5842 (let ((case-fold-search t))
5843 (if (re-search-forward
5844 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5845 limit t)
5846 (let ((beg (match-beginning 0))
5847 (block-start (match-end 0))
5848 (block-end nil)
5849 (lang (match-string 7))
5850 (beg1 (line-beginning-position 2))
5851 (dc1 (downcase (match-string 2)))
5852 (dc3 (downcase (match-string 3)))
5853 end end1 quoting block-type ovl)
5854 (cond
5855 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5856 ;; a single line of backend-specific content
5857 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5858 (remove-text-properties (match-beginning 0) (match-end 0)
5859 '(display t invisible t intangible t))
5860 (add-text-properties (match-beginning 1) (match-end 3)
5861 '(font-lock-fontified t face org-meta-line))
5862 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5863 '(font-lock-fontified t face org-block))
5864 ; for backend-specific code
5866 ((and (match-end 4) (equal dc3 "+begin"))
5867 ;; Truly a block
5868 (setq block-type (downcase (match-string 5))
5869 quoting (member block-type org-protecting-blocks))
5870 (when (re-search-forward
5871 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5872 nil t) ;; on purpose, we look further than LIMIT
5873 (setq end (min (point-max) (match-end 0))
5874 end1 (min (point-max) (1- (match-beginning 0))))
5875 (setq block-end (match-beginning 0))
5876 (when quoting
5877 (org-remove-flyspell-overlays-in beg1 end1)
5878 (remove-text-properties beg end
5879 '(display t invisible t intangible t)))
5880 (add-text-properties
5881 beg end '(font-lock-fontified t font-lock-multiline t))
5882 (add-text-properties beg beg1 '(face org-meta-line))
5883 (org-remove-flyspell-overlays-in beg beg1)
5884 (add-text-properties ; For end_src
5885 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5886 (org-remove-flyspell-overlays-in end1 end)
5887 (cond
5888 ((and lang (not (string= lang "")) org-src-fontify-natively)
5889 (org-src-font-lock-fontify-block lang block-start block-end)
5890 ;; remove old background overlays
5891 (mapc (lambda (ov)
5892 (if (eq (overlay-get ov 'face) 'org-block-background)
5893 (delete-overlay ov)))
5894 (overlays-at (/ (+ beg1 block-end) 2)))
5895 ;; add a background overlay
5896 (setq ovl (make-overlay beg1 block-end))
5897 (overlay-put ovl 'face 'org-block-background)
5898 (overlay-put ovl 'evaporate t)) ; make it go away when empty
5899 (quoting
5900 (add-text-properties beg1 (min (point-max) (1+ end1))
5901 '(face org-block))) ; end of source block
5902 ((not org-fontify-quote-and-verse-blocks))
5903 ((string= block-type "quote")
5904 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5905 ((string= block-type "verse")
5906 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5907 (add-text-properties beg beg1 '(face org-block-begin-line))
5908 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5909 '(face org-block-end-line))
5911 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5912 (org-remove-flyspell-overlays-in
5913 (match-beginning 0)
5914 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5915 (add-text-properties
5916 beg (match-end 3)
5917 (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
5918 '(font-lock-fontified t invisible t)
5919 '(font-lock-fontified t face org-document-info-keyword)))
5920 (add-text-properties
5921 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5922 (if (string-equal dc1 "+title:")
5923 '(font-lock-fontified t face org-document-title)
5924 '(font-lock-fontified t face org-document-info))))
5925 ((or (equal dc1 "+results")
5926 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5927 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5928 "+call:" "+header:" "+headers:" "+name:"))
5929 (and (match-end 4) (equal dc3 "+attr")))
5930 (org-remove-flyspell-overlays-in
5931 (match-beginning 0)
5932 (if (equal "+caption:" dc1) (match-end 2) (match-end 0)))
5933 (add-text-properties
5934 beg (match-end 0)
5935 '(font-lock-fontified t face org-meta-line))
5937 ((member dc3 '(" " ""))
5938 (org-remove-flyspell-overlays-in beg (match-end 0))
5939 (add-text-properties
5940 beg (match-end 0)
5941 '(font-lock-fontified t face font-lock-comment-face)))
5942 ((not (member (char-after beg) '(?\ ?\t)))
5943 ;; just any other in-buffer setting, but not indented
5944 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5945 (add-text-properties
5946 beg (match-end 0)
5947 '(font-lock-fontified t face org-meta-line))
5949 (t nil))))))
5951 (defun org-fontify-drawers (limit)
5952 "Fontify drawers."
5953 (when (re-search-forward org-drawer-regexp limit t)
5954 (add-text-properties
5955 (match-beginning 0) (match-end 0)
5956 '(font-lock-fontified t face org-special-keyword))
5957 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5960 (defun org-activate-angle-links (limit)
5961 "Run through the buffer and add overlays to links."
5962 (if (and (re-search-forward org-angle-link-re limit t)
5963 (not (org-in-src-block-p)))
5964 (progn
5965 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5966 (add-text-properties (match-beginning 0) (match-end 0)
5967 (list 'mouse-face 'highlight
5968 'keymap org-mouse-map))
5969 (org-rear-nonsticky-at (match-end 0))
5970 t)))
5972 (defun org-activate-footnote-links (limit)
5973 "Run through the buffer and add overlays to footnotes."
5974 (let ((fn (org-footnote-next-reference-or-definition limit)))
5975 (when fn
5976 (let* ((beg (nth 1 fn))
5977 (end (nth 2 fn))
5978 (label (car fn))
5979 (referencep (/= (line-beginning-position) beg)))
5980 (when (and referencep (nth 3 fn))
5981 (save-excursion
5982 (goto-char beg)
5983 (search-forward (or label "fn:"))
5984 (org-remove-flyspell-overlays-in beg (match-end 0))))
5985 (add-text-properties beg end
5986 (list 'mouse-face 'highlight
5987 'keymap org-mouse-map
5988 'help-echo
5989 (if referencep "Footnote reference"
5990 "Footnote definition")
5991 'font-lock-fontified t
5992 'font-lock-multiline t
5993 'face 'org-footnote))))))
5995 (defun org-activate-bracket-links (limit)
5996 "Run through the buffer and add overlays to bracketed links."
5997 (if (and (re-search-forward org-bracket-link-regexp limit t)
5998 (not (org-in-src-block-p)))
5999 (let* ((hl (org-match-string-no-properties 1))
6000 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6001 (ip (org-maybe-intangible
6002 (list 'invisible 'org-link
6003 'keymap org-mouse-map 'mouse-face 'highlight
6004 'font-lock-multiline t 'help-echo help
6005 'htmlize-link `(:uri ,hl))))
6006 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6007 'font-lock-multiline t 'help-echo help
6008 'htmlize-link `(:uri ,hl))))
6009 ;; We need to remove the invisible property here. Table narrowing
6010 ;; may have made some of this invisible.
6011 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6012 (remove-text-properties (match-beginning 0) (match-end 0)
6013 '(invisible nil))
6014 (if (match-end 3)
6015 (progn
6016 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6017 (org-rear-nonsticky-at (match-beginning 3))
6018 (add-text-properties (match-beginning 3) (match-end 3) vp)
6019 (org-rear-nonsticky-at (match-end 3))
6020 (add-text-properties (match-end 3) (match-end 0) ip)
6021 (org-rear-nonsticky-at (match-end 0)))
6022 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6023 (org-rear-nonsticky-at (match-beginning 1))
6024 (add-text-properties (match-beginning 1) (match-end 1) vp)
6025 (org-rear-nonsticky-at (match-end 1))
6026 (add-text-properties (match-end 1) (match-end 0) ip)
6027 (org-rear-nonsticky-at (match-end 0)))
6028 t)))
6030 (defun org-activate-dates (limit)
6031 "Run through the buffer and add overlays to dates."
6032 (if (and (re-search-forward org-tsr-regexp-both limit t)
6033 (not (equal (char-before (match-beginning 0)) 91)))
6034 (progn
6035 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6036 (add-text-properties (match-beginning 0) (match-end 0)
6037 (list 'mouse-face 'highlight
6038 'keymap org-mouse-map))
6039 (org-rear-nonsticky-at (match-end 0))
6040 (when org-display-custom-times
6041 (if (match-end 3)
6042 (org-display-custom-time (match-beginning 3) (match-end 3)))
6043 (org-display-custom-time (match-beginning 1) (match-end 1)))
6044 t)))
6046 (defvar org-target-link-regexp nil
6047 "Regular expression matching radio targets in plain text.")
6048 (make-variable-buffer-local 'org-target-link-regexp)
6049 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
6050 "Regular expression matching a link target.")
6051 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
6052 "Regular expression matching a radio target.")
6053 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
6054 "Regular expression matching any target.")
6056 (defun org-activate-target-links (limit)
6057 "Run through the buffer and add overlays to target matches."
6058 (when org-target-link-regexp
6059 (let ((case-fold-search t))
6060 (if (re-search-forward org-target-link-regexp limit t)
6061 (progn
6062 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6063 (add-text-properties (match-beginning 0) (match-end 0)
6064 (list 'mouse-face 'highlight
6065 'keymap org-mouse-map
6066 'help-echo "Radio target link"
6067 'org-linked-text t))
6068 (org-rear-nonsticky-at (match-end 0))
6069 t)))))
6071 (defun org-update-radio-target-regexp ()
6072 "Find all radio targets in this file and update the regular expression."
6073 (interactive)
6074 (when (memq 'radio org-activate-links)
6075 (setq org-target-link-regexp
6076 (org-make-target-link-regexp (org-all-targets 'radio)))
6077 (org-restart-font-lock)))
6079 (defun org-hide-wide-columns (limit)
6080 (let (s e)
6081 (setq s (text-property-any (point) (or limit (point-max))
6082 'org-cwidth t))
6083 (when s
6084 (setq e (next-single-property-change s 'org-cwidth))
6085 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6086 (goto-char e)
6087 t)))
6089 (defvar org-latex-and-related-regexp nil
6090 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6092 (defun org-compute-latex-and-related-regexp ()
6093 "Compute regular expression for LaTeX, entities and sub/superscript.
6094 Result depends on variable `org-highlight-latex-and-related'."
6095 (org-set-local
6096 'org-latex-and-related-regexp
6097 (let* ((re-sub
6098 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6099 ((eq org-use-sub-superscripts '{})
6100 (list org-match-substring-with-braces-regexp))
6101 (org-use-sub-superscripts (list org-match-substring-regexp))))
6102 (re-latex
6103 (when (memq 'latex org-highlight-latex-and-related)
6104 (let ((matchers (plist-get org-format-latex-options :matchers)))
6105 (delq nil
6106 (mapcar (lambda (x)
6107 (and (member (car x) matchers) (nth 1 x)))
6108 org-latex-regexps)))))
6109 (re-entities
6110 (when (memq 'entities org-highlight-latex-and-related)
6111 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6112 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6114 (defun org-do-latex-and-related (limit)
6115 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6116 LIMIT bounds the search for syntax to highlight. Stop at first
6117 highlighted object, if any. Return t if some highlighting was
6118 done, nil otherwise."
6119 (when (org-string-nw-p org-latex-and-related-regexp)
6120 (catch 'found
6121 (while (re-search-forward org-latex-and-related-regexp limit t)
6122 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6123 'face))
6124 '(org-code org-verbatim underline))
6125 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6126 '(?_ ?^))
6128 0)))
6129 (font-lock-prepend-text-property
6130 (+ offset (match-beginning 0)) (match-end 0)
6131 'face 'org-latex-and-related)
6132 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6133 '(font-lock-multiline t)))
6134 (throw 'found t)))
6135 nil)))
6137 (defun org-restart-font-lock ()
6138 "Restart `font-lock-mode', to force refontification."
6139 (when (and (boundp 'font-lock-mode) font-lock-mode)
6140 (font-lock-mode -1)
6141 (font-lock-mode 1)))
6143 (defun org-all-targets (&optional radio)
6144 "Return a list of all targets in this file.
6145 When optional argument RADIO is non-nil, only find radio
6146 targets."
6147 (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
6148 (save-excursion
6149 (goto-char (point-min))
6150 (while (re-search-forward re nil t)
6151 ;; Make sure point is really within the object.
6152 (backward-char)
6153 (let ((obj (org-element-context)))
6154 (when (memq (org-element-type obj) '(radio-target target))
6155 (add-to-list 'rtn (downcase (org-element-property :value obj))))))
6156 rtn)))
6158 (defun org-make-target-link-regexp (targets)
6159 "Make regular expression matching all strings in TARGETS.
6160 The regular expression finds the targets also if there is a line break
6161 between words."
6162 (and targets
6163 (concat
6164 "\\<\\("
6165 (mapconcat
6166 (lambda (x)
6167 (setq x (regexp-quote x))
6168 (while (string-match " +" x)
6169 (setq x (replace-match "\\s-+" t t x)))
6171 targets
6172 "\\|")
6173 "\\)\\>")))
6175 (defun org-activate-tags (limit)
6176 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6177 (progn
6178 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6179 (add-text-properties (match-beginning 1) (match-end 1)
6180 (list 'mouse-face 'highlight
6181 'keymap org-mouse-map))
6182 (org-rear-nonsticky-at (match-end 1))
6183 t)))
6185 (defun org-outline-level ()
6186 "Compute the outline level of the heading at point.
6187 If this is called at a normal headline, the level is the number of stars.
6188 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6189 (save-excursion
6190 (if (not (condition-case nil
6191 (org-back-to-heading t)
6192 (error nil)))
6194 (looking-at org-outline-regexp)
6195 (1- (- (match-end 0) (match-beginning 0))))))
6197 (defvar org-font-lock-keywords nil)
6199 (defsubst org-re-property (property &optional literal)
6200 "Return a regexp matching a PROPERTY line.
6201 Match group 3 will be set to the value if it exists."
6202 (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
6203 (if literal property (regexp-quote property))
6204 "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
6206 (defconst org-property-re
6207 (org-re-property ".*?" 'literal)
6208 "Regular expression matching a property line.
6209 There are four matching groups:
6210 1: :PROPKEY: including the leading and trailing colon,
6211 2: PROPKEY without the leading and trailing colon,
6212 3: PROPVAL without leading or trailing spaces,
6213 4: the indentation of the current line,
6214 5: trailing whitespace.")
6216 (defvar org-font-lock-hook nil
6217 "Functions to be called for special font lock stuff.")
6219 (defvar org-font-lock-set-keywords-hook nil
6220 "Functions that can manipulate `org-font-lock-extra-keywords'.
6221 This is called after `org-font-lock-extra-keywords' is defined, but before
6222 it is installed to be used by font lock. This can be useful if something
6223 needs to be inserted at a specific position in the font-lock sequence.")
6225 (defun org-font-lock-hook (limit)
6226 "Run `org-font-lock-hook' within LIMIT."
6227 (run-hook-with-args 'org-font-lock-hook limit))
6229 (defun org-set-font-lock-defaults ()
6230 "Set font lock defaults for the current buffer."
6231 (let* ((em org-fontify-emphasized-text)
6232 (lk org-activate-links)
6233 (org-font-lock-extra-keywords
6234 (list
6235 ;; Call the hook
6236 '(org-font-lock-hook)
6237 ;; Headlines
6238 `(,(if org-fontify-whole-heading-line
6239 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6240 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6241 (1 (org-get-level-face 1))
6242 (2 (org-get-level-face 2))
6243 (3 (org-get-level-face 3)))
6244 ;; Table lines
6245 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6246 (1 'org-table t))
6247 ;; Table internals
6248 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6249 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6250 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6251 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6252 ;; Drawers
6253 '(org-fontify-drawers)
6254 ;; Properties
6255 (list org-property-re
6256 '(1 'org-special-keyword t)
6257 '(3 'org-property-value t))
6258 ;; Links
6259 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6260 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6261 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6262 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6263 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6264 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6265 (if (memq 'footnote lk) '(org-activate-footnote-links))
6266 ;; Targets.
6267 (list org-any-target-regexp '(0 'org-target t))
6268 ;; Diary sexps.
6269 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6270 ;; Macro
6271 '("{{{.+?}}}" (0 'org-macro t))
6272 '(org-hide-wide-columns (0 nil append))
6273 ;; TODO keyword
6274 (list (format org-heading-keyword-regexp-format
6275 org-todo-regexp)
6276 '(2 (org-get-todo-face 2) t))
6277 ;; DONE
6278 (if org-fontify-done-headline
6279 (list (format org-heading-keyword-regexp-format
6280 (concat
6281 "\\(?:"
6282 (mapconcat 'regexp-quote org-done-keywords "\\|")
6283 "\\)"))
6284 '(2 'org-headline-done t))
6285 nil)
6286 ;; Priorities
6287 '(org-font-lock-add-priority-faces)
6288 ;; Tags
6289 '(org-font-lock-add-tag-faces)
6290 ;; Tags groups
6291 (if (and org-group-tags org-tag-groups-alist)
6292 (list (concat org-outline-regexp-bol ".+\\(:"
6293 (regexp-opt (mapcar 'car org-tag-groups-alist))
6294 ":\\).*$")
6295 '(1 'org-tag-group prepend)))
6296 ;; Special keywords
6297 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6298 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6299 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6300 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6301 ;; Emphasis
6302 (if em
6303 (if (featurep 'xemacs)
6304 '(org-do-emphasis-faces (0 nil append))
6305 '(org-do-emphasis-faces)))
6306 ;; Checkboxes
6307 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6308 1 'org-checkbox prepend)
6309 (if (cdr (assq 'checkbox org-list-automatic-rules))
6310 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6311 (0 (org-get-checkbox-statistics-face) t)))
6312 ;; Description list items
6313 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6314 1 'org-list-dt prepend)
6315 ;; ARCHIVEd headings
6316 (list (concat
6317 org-outline-regexp-bol
6318 "\\(.*:" org-archive-tag ":.*\\)")
6319 '(1 'org-archived prepend))
6320 ;; Specials
6321 '(org-do-latex-and-related)
6322 '(org-fontify-entities)
6323 '(org-raise-scripts)
6324 ;; Code
6325 '(org-activate-code (1 'org-code t))
6326 ;; COMMENT
6327 (list (format org-heading-keyword-regexp-format
6328 (concat "\\("
6329 org-comment-string "\\|" org-quote-string
6330 "\\)"))
6331 '(2 'org-special-keyword t))
6332 ;; Blocks and meta lines
6333 '(org-fontify-meta-lines-and-blocks))))
6334 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6335 (run-hooks 'org-font-lock-set-keywords-hook)
6336 ;; Now set the full font-lock-keywords
6337 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6338 (org-set-local 'font-lock-defaults
6339 '(org-font-lock-keywords t nil nil backward-paragraph))
6340 (kill-local-variable 'font-lock-keywords) nil))
6342 (defun org-toggle-pretty-entities ()
6343 "Toggle the composition display of entities as UTF8 characters."
6344 (interactive)
6345 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6346 (org-restart-font-lock)
6347 (if org-pretty-entities
6348 (message "Entities are now displayed as UTF8 characters")
6349 (save-restriction
6350 (widen)
6351 (org-decompose-region (point-min) (point-max))
6352 (message "Entities are now displayed as plain text"))))
6354 (defvar org-custom-properties-overlays nil
6355 "List of overlays used for custom properties.")
6356 (make-variable-buffer-local 'org-custom-properties-overlays)
6358 (defun org-toggle-custom-properties-visibility ()
6359 "Display or hide properties in `org-custom-properties'."
6360 (interactive)
6361 (if org-custom-properties-overlays
6362 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6363 (setq org-custom-properties-overlays nil))
6364 (unless (not org-custom-properties)
6365 (save-excursion
6366 (save-restriction
6367 (widen)
6368 (goto-char (point-min))
6369 (while (re-search-forward org-property-re nil t)
6370 (mapc (lambda(p)
6371 (when (equal p (substring (match-string 1) 1 -1))
6372 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6373 (overlay-put o 'invisible t)
6374 (overlay-put o 'org-custom-property t)
6375 (push o org-custom-properties-overlays))))
6376 org-custom-properties)))))))
6378 (defun org-fontify-entities (limit)
6379 "Find an entity to fontify."
6380 (let (ee)
6381 (when org-pretty-entities
6382 (catch 'match
6383 (while (re-search-forward
6384 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6385 limit t)
6386 (if (and (not (org-in-indented-comment-line))
6387 (setq ee (org-entity-get (match-string 1)))
6388 (= (length (nth 6 ee)) 1))
6389 (let*
6390 ((end (if (equal (match-string 2) "{}")
6391 (match-end 2)
6392 (match-end 1))))
6393 (add-text-properties
6394 (match-beginning 0) end
6395 (list 'font-lock-fontified t))
6396 (compose-region (match-beginning 0) end
6397 (nth 6 ee) nil)
6398 (backward-char 1)
6399 (throw 'match t))))
6400 nil))))
6402 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6403 "Fontify string S like in Org-mode."
6404 (with-temp-buffer
6405 (insert s)
6406 (let ((org-odd-levels-only odd-levels))
6407 (org-mode)
6408 (font-lock-fontify-buffer)
6409 (buffer-string))))
6411 (defvar org-m nil)
6412 (defvar org-l nil)
6413 (defvar org-f nil)
6414 (defun org-get-level-face (n)
6415 "Get the right face for match N in font-lock matching of headlines."
6416 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6417 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6418 (if org-cycle-level-faces
6419 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6420 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6421 (cond
6422 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6423 ((eq n 2) org-f)
6424 (t (if org-level-color-stars-only nil org-f))))
6427 (defun org-get-todo-face (kwd)
6428 "Get the right face for a TODO keyword KWD.
6429 If KWD is a number, get the corresponding match group."
6430 (if (numberp kwd) (setq kwd (match-string kwd)))
6431 (or (org-face-from-face-or-color
6432 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6433 (and (member kwd org-done-keywords) 'org-done)
6434 'org-todo))
6436 (defun org-face-from-face-or-color (context inherit face-or-color)
6437 "Create a face list that inherits INHERIT, but sets the foreground color.
6438 When FACE-OR-COLOR is not a string, just return it."
6439 (if (stringp face-or-color)
6440 (list :inherit inherit
6441 (cdr (assoc context org-faces-easy-properties))
6442 face-or-color)
6443 face-or-color))
6445 (defun org-font-lock-add-tag-faces (limit)
6446 "Add the special tag faces."
6447 (when (and org-tag-faces org-tags-special-faces-re)
6448 (while (re-search-forward org-tags-special-faces-re limit t)
6449 (add-text-properties (match-beginning 1) (match-end 1)
6450 (list 'face (org-get-tag-face 1)
6451 'font-lock-fontified t))
6452 (backward-char 1))))
6454 (defun org-font-lock-add-priority-faces (limit)
6455 "Add the special priority faces."
6456 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6457 (when (save-match-data (org-at-heading-p))
6458 (add-text-properties
6459 (match-beginning 0) (match-end 0)
6460 (list 'face (or (org-face-from-face-or-color
6461 'priority 'org-priority
6462 (cdr (assoc (char-after (match-beginning 1))
6463 org-priority-faces)))
6464 'org-priority)
6465 'font-lock-fontified t)))))
6467 (defun org-get-tag-face (kwd)
6468 "Get the right face for a TODO keyword KWD.
6469 If KWD is a number, get the corresponding match group."
6470 (if (numberp kwd) (setq kwd (match-string kwd)))
6471 (or (org-face-from-face-or-color
6472 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6473 'org-tag))
6475 (defun org-unfontify-region (beg end &optional maybe_loudly)
6476 "Remove fontification and activation overlays from links."
6477 (font-lock-default-unfontify-region beg end)
6478 (let* ((buffer-undo-list t)
6479 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6480 (inhibit-modification-hooks t)
6481 deactivate-mark buffer-file-name buffer-file-truename)
6482 (org-decompose-region beg end)
6483 (remove-text-properties beg end
6484 '(mouse-face t keymap t org-linked-text t
6485 invisible t intangible t
6486 org-emphasis t))
6487 (org-remove-font-lock-display-properties beg end)))
6489 (defconst org-script-display '(((raise -0.3) (height 0.7))
6490 ((raise 0.3) (height 0.7))
6491 ((raise -0.5))
6492 ((raise 0.5)))
6493 "Display properties for showing superscripts and subscripts.")
6495 (defun org-remove-font-lock-display-properties (beg end)
6496 "Remove specific display properties that have been added by font lock.
6497 The will remove the raise properties that are used to show superscripts
6498 and subscripts."
6499 (let (next prop)
6500 (while (< beg end)
6501 (setq next (next-single-property-change beg 'display nil end)
6502 prop (get-text-property beg 'display))
6503 (if (member prop org-script-display)
6504 (put-text-property beg next 'display nil))
6505 (setq beg next))))
6507 (defun org-raise-scripts (limit)
6508 "Add raise properties to sub/superscripts."
6509 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6510 (if (re-search-forward
6511 (if (eq org-use-sub-superscripts t)
6512 org-match-substring-regexp
6513 org-match-substring-with-braces-regexp)
6514 limit t)
6515 (let* ((pos (point)) table-p comment-p
6516 (mpos (match-beginning 3))
6517 (emph-p (get-text-property mpos 'org-emphasis))
6518 (link-p (get-text-property mpos 'mouse-face))
6519 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6520 (goto-char (point-at-bol))
6521 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6522 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6523 (goto-char pos)
6524 ;; Handle a_b^c
6525 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6526 (if (or comment-p emph-p link-p keyw-p)
6528 (put-text-property (match-beginning 3) (match-end 0)
6529 'display
6530 (if (equal (char-after (match-beginning 2)) ?^)
6531 (nth (if table-p 3 1) org-script-display)
6532 (nth (if table-p 2 0) org-script-display)))
6533 (add-text-properties (match-beginning 2) (match-end 2)
6534 (list 'invisible t
6535 'org-dwidth t 'org-dwidth-n 1))
6536 (if (and (eq (char-after (match-beginning 3)) ?{)
6537 (eq (char-before (match-end 3)) ?}))
6538 (progn
6539 (add-text-properties
6540 (match-beginning 3) (1+ (match-beginning 3))
6541 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6542 (add-text-properties
6543 (1- (match-end 3)) (match-end 3)
6544 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6545 t)))))
6547 ;;;; Visibility cycling, including org-goto and indirect buffer
6549 ;;; Cycling
6551 (defvar org-cycle-global-status nil)
6552 (make-variable-buffer-local 'org-cycle-global-status)
6553 (put 'org-cycle-global-status 'org-state t)
6554 (defvar org-cycle-subtree-status nil)
6555 (make-variable-buffer-local 'org-cycle-subtree-status)
6556 (put 'org-cycle-subtree-status 'org-state t)
6558 (defvar org-inlinetask-min-level)
6560 (defun org-unlogged-message (&rest args)
6561 "Display a message, but avoid logging it in the *Messages* buffer."
6562 (let ((message-log-max nil))
6563 (apply 'message args)))
6565 ;;;###autoload
6566 (defun org-cycle (&optional arg)
6567 "TAB-action and visibility cycling for Org-mode.
6569 This is the command invoked in Org-mode by the TAB key. Its main purpose
6570 is outline visibility cycling, but it also invokes other actions
6571 in special contexts.
6573 - When this function is called with a prefix argument, rotate the entire
6574 buffer through 3 states (global cycling)
6575 1. OVERVIEW: Show only top-level headlines.
6576 2. CONTENTS: Show all headlines of all levels, but no body text.
6577 3. SHOW ALL: Show everything.
6578 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6579 determined by the variable `org-startup-folded', and by any VISIBILITY
6580 properties in the buffer.
6581 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6582 including any drawers.
6584 - When inside a table, re-align the table and move to the next field.
6586 - When point is at the beginning of a headline, rotate the subtree started
6587 by this line through 3 different states (local cycling)
6588 1. FOLDED: Only the main headline is shown.
6589 2. CHILDREN: The main headline and the direct children are shown.
6590 From this state, you can move to one of the children
6591 and zoom in further.
6592 3. SUBTREE: Show the entire subtree, including body text.
6593 If there is no subtree, switch directly from CHILDREN to FOLDED.
6595 - When point is at the beginning of an empty headline and the variable
6596 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6597 of the headline by demoting and promoting it to likely levels. This
6598 speeds up creation document structure by pressing TAB once or several
6599 times right after creating a new headline.
6601 - When there is a numeric prefix, go up to a heading with level ARG, do
6602 a `show-subtree' and return to the previous cursor position. If ARG
6603 is negative, go up that many levels.
6605 - When point is not at the beginning of a headline, execute the global
6606 binding for TAB, which is re-indenting the line. See the option
6607 `org-cycle-emulate-tab' for details.
6609 - Special case: if point is at the beginning of the buffer and there is
6610 no headline in line 1, this function will act as if called with prefix arg
6611 (C-u TAB, same as S-TAB) also when called without prefix arg.
6612 But only if also the variable `org-cycle-global-at-bob' is t."
6613 (interactive "P")
6614 (org-load-modules-maybe)
6615 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6616 (and org-cycle-level-after-item/entry-creation
6617 (or (org-cycle-level)
6618 (org-cycle-item-indentation))))
6619 (let* ((limit-level
6620 (or org-cycle-max-level
6621 (and (boundp 'org-inlinetask-min-level)
6622 org-inlinetask-min-level
6623 (1- org-inlinetask-min-level))))
6624 (nstars (and limit-level
6625 (if org-odd-levels-only
6626 (and limit-level (1- (* limit-level 2)))
6627 limit-level)))
6628 (org-outline-regexp
6629 (if (not (derived-mode-p 'org-mode))
6630 outline-regexp
6631 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6632 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6633 (not (looking-at org-outline-regexp))))
6634 (org-cycle-hook
6635 (if bob-special
6636 (delq 'org-optimize-window-after-visibility-change
6637 (copy-sequence org-cycle-hook))
6638 org-cycle-hook))
6639 (pos (point)))
6641 (if (or bob-special (equal arg '(4)))
6642 ;; special case: use global cycling
6643 (setq arg t))
6645 (cond
6647 ((equal arg '(16))
6648 (setq last-command 'dummy)
6649 (org-set-startup-visibility)
6650 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6652 ((equal arg '(64))
6653 (show-all)
6654 (org-unlogged-message "Entire buffer visible, including drawers"))
6656 ;; Table: enter it or move to the next field.
6657 ((org-at-table-p 'any)
6658 (if (org-at-table.el-p)
6659 (message "Use C-c ' to edit table.el tables")
6660 (if arg (org-table-edit-field t)
6661 (org-table-justify-field-maybe)
6662 (call-interactively 'org-table-next-field))))
6664 ((run-hook-with-args-until-success
6665 'org-tab-after-check-for-table-hook))
6667 ;; Global cycling: delegate to `org-cycle-internal-global'.
6668 ((eq arg t) (org-cycle-internal-global))
6670 ;; Drawers: delegate to `org-flag-drawer'.
6671 ((save-excursion
6672 (beginning-of-line 1)
6673 (looking-at org-drawer-regexp))
6674 (org-flag-drawer ; toggle block visibility
6675 (not (get-char-property (match-end 0) 'invisible))))
6677 ;; Show-subtree, ARG levels up from here.
6678 ((integerp arg)
6679 (save-excursion
6680 (org-back-to-heading)
6681 (outline-up-heading (if (< arg 0) (- arg)
6682 (- (funcall outline-level) arg)))
6683 (org-show-subtree)))
6685 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6686 ((and (featurep 'org-inlinetask)
6687 (org-inlinetask-at-task-p)
6688 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6689 (org-inlinetask-toggle-visibility))
6691 ((org-try-cdlatex-tab))
6693 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6694 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6695 (save-excursion (beginning-of-line 1)
6696 (looking-at org-outline-regexp)))
6697 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6698 (org-cycle-internal-local))
6700 ;; From there: TAB emulation and template completion.
6701 (buffer-read-only (org-back-to-heading))
6703 ((run-hook-with-args-until-success
6704 'org-tab-after-check-for-cycling-hook))
6706 ((org-try-structure-completion))
6708 ((run-hook-with-args-until-success
6709 'org-tab-before-tab-emulation-hook))
6711 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6712 (or (not (bolp))
6713 (not (looking-at org-outline-regexp))))
6714 (call-interactively (global-key-binding "\t")))
6716 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6717 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6718 (or (and (eq org-cycle-emulate-tab 'white)
6719 (= (match-end 0) (point-at-eol)))
6720 (and (eq org-cycle-emulate-tab 'whitestart)
6721 (>= (match-end 0) pos))))
6723 (eq org-cycle-emulate-tab t))
6724 (call-interactively (global-key-binding "\t")))
6726 (t (save-excursion
6727 (org-back-to-heading)
6728 (org-cycle)))))))
6730 (defun org-cycle-internal-global ()
6731 "Do the global cycling action."
6732 ;; Hack to avoid display of messages for .org attachments in Gnus
6733 (let ((ga (string-match "\\*fontification" (buffer-name))))
6734 (cond
6735 ((and (eq last-command this-command)
6736 (eq org-cycle-global-status 'overview))
6737 ;; We just created the overview - now do table of contents
6738 ;; This can be slow in very large buffers, so indicate action
6739 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6740 (unless ga (org-unlogged-message "CONTENTS..."))
6741 (org-content)
6742 (unless ga (org-unlogged-message "CONTENTS...done"))
6743 (setq org-cycle-global-status 'contents)
6744 (run-hook-with-args 'org-cycle-hook 'contents))
6746 ((and (eq last-command this-command)
6747 (eq org-cycle-global-status 'contents))
6748 ;; We just showed the table of contents - now show everything
6749 (run-hook-with-args 'org-pre-cycle-hook 'all)
6750 (show-all)
6751 (unless ga (org-unlogged-message "SHOW ALL"))
6752 (setq org-cycle-global-status 'all)
6753 (run-hook-with-args 'org-cycle-hook 'all))
6756 ;; Default action: go to overview
6757 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6758 (org-overview)
6759 (unless ga (org-unlogged-message "OVERVIEW"))
6760 (setq org-cycle-global-status 'overview)
6761 (run-hook-with-args 'org-cycle-hook 'overview)))))
6763 (defvar org-called-with-limited-levels);Dyn-bound in ̀org-with-limited-levels'.
6765 (defun org-cycle-internal-local ()
6766 "Do the local cycling action."
6767 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6768 ;; First, determine end of headline (EOH), end of subtree or item
6769 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6770 (save-excursion
6771 (if (org-at-item-p)
6772 (progn
6773 (beginning-of-line)
6774 (setq struct (org-list-struct))
6775 (setq eoh (point-at-eol))
6776 (setq eos (org-list-get-item-end-before-blank (point) struct))
6777 (setq has-children (org-list-has-child-p (point) struct)))
6778 (org-back-to-heading)
6779 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6780 (setq eos (save-excursion (1- (org-end-of-subtree t t))))
6781 (setq has-children
6782 (or (save-excursion
6783 (let ((level (funcall outline-level)))
6784 (outline-next-heading)
6785 (and (org-at-heading-p t)
6786 (> (funcall outline-level) level))))
6787 (save-excursion
6788 (org-list-search-forward (org-item-beginning-re) eos t)))))
6789 ;; Determine end invisible part of buffer (EOL)
6790 (beginning-of-line 2)
6791 ;; XEmacs doesn't have `next-single-char-property-change'
6792 (if (featurep 'xemacs)
6793 (while (and (not (eobp)) ;; this is like `next-line'
6794 (get-char-property (1- (point)) 'invisible))
6795 (beginning-of-line 2))
6796 (while (and (not (eobp)) ;; this is like `next-line'
6797 (get-char-property (1- (point)) 'invisible))
6798 (goto-char (next-single-char-property-change (point) 'invisible))
6799 (and (eolp) (beginning-of-line 2))))
6800 (setq eol (point)))
6801 ;; Find out what to do next and set `this-command'
6802 (cond
6803 ((= eos eoh)
6804 ;; Nothing is hidden behind this heading
6805 (unless (org-before-first-heading-p)
6806 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6807 (org-unlogged-message "EMPTY ENTRY")
6808 (setq org-cycle-subtree-status nil)
6809 (save-excursion
6810 (goto-char eos)
6811 (outline-next-heading)
6812 (if (outline-invisible-p) (org-flag-heading nil))))
6813 ((and (or (>= eol eos)
6814 (not (string-match "\\S-" (buffer-substring eol eos))))
6815 (or has-children
6816 (not (setq children-skipped
6817 org-cycle-skip-children-state-if-no-children))))
6818 ;; Entire subtree is hidden in one line: children view
6819 (unless (org-before-first-heading-p)
6820 (run-hook-with-args 'org-pre-cycle-hook 'children))
6821 (if (org-at-item-p)
6822 (org-list-set-item-visibility (point-at-bol) struct 'children)
6823 (org-show-entry)
6824 (org-with-limited-levels (show-children))
6825 ;; FIXME: This slows down the func way too much.
6826 ;; How keep drawers hidden in subtree anyway?
6827 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6828 ;; (org-cycle-hide-drawers 'subtree))
6830 ;; Fold every list in subtree to top-level items.
6831 (when (eq org-cycle-include-plain-lists 'integrate)
6832 (save-excursion
6833 (org-back-to-heading)
6834 (while (org-list-search-forward (org-item-beginning-re) eos t)
6835 (beginning-of-line 1)
6836 (let* ((struct (org-list-struct))
6837 (prevs (org-list-prevs-alist struct))
6838 (end (org-list-get-bottom-point struct)))
6839 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6840 (org-list-get-all-items (point) struct prevs))
6841 (goto-char (if (< end eos) end eos)))))))
6842 (org-unlogged-message "CHILDREN")
6843 (save-excursion
6844 (goto-char eos)
6845 (outline-next-heading)
6846 (if (outline-invisible-p) (org-flag-heading nil)))
6847 (setq org-cycle-subtree-status 'children)
6848 (unless (org-before-first-heading-p)
6849 (run-hook-with-args 'org-cycle-hook 'children)))
6850 ((or children-skipped
6851 (and (eq last-command this-command)
6852 (eq org-cycle-subtree-status 'children)))
6853 ;; We just showed the children, or no children are there,
6854 ;; now show everything.
6855 (unless (org-before-first-heading-p)
6856 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6857 (outline-flag-region eoh eos nil)
6858 (org-unlogged-message
6859 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6860 (setq org-cycle-subtree-status 'subtree)
6861 (unless (org-before-first-heading-p)
6862 (run-hook-with-args 'org-cycle-hook 'subtree)))
6864 ;; Default action: hide the subtree.
6865 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6866 (outline-flag-region eoh eos t)
6867 (org-unlogged-message "FOLDED")
6868 (setq org-cycle-subtree-status 'folded)
6869 (unless (org-before-first-heading-p)
6870 (run-hook-with-args 'org-cycle-hook 'folded))))))
6872 ;;;###autoload
6873 (defun org-global-cycle (&optional arg)
6874 "Cycle the global visibility. For details see `org-cycle'.
6875 With \\[universal-argument] prefix arg, switch to startup visibility.
6876 With a numeric prefix, show all headlines up to that level."
6877 (interactive "P")
6878 (let ((org-cycle-include-plain-lists
6879 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6880 (cond
6881 ((integerp arg)
6882 (show-all)
6883 (hide-sublevels arg)
6884 (setq org-cycle-global-status 'contents))
6885 ((equal arg '(4))
6886 (org-set-startup-visibility)
6887 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6889 (org-cycle '(4))))))
6891 (defun org-set-startup-visibility ()
6892 "Set the visibility required by startup options and properties."
6893 (cond
6894 ((eq org-startup-folded t)
6895 (org-overview))
6896 ((eq org-startup-folded 'content)
6897 (org-content))
6898 ((or (eq org-startup-folded 'showeverything)
6899 (eq org-startup-folded nil))
6900 (show-all)))
6901 (unless (eq org-startup-folded 'showeverything)
6902 (if org-hide-block-startup (org-hide-block-all))
6903 (org-set-visibility-according-to-property 'no-cleanup)
6904 (org-cycle-hide-archived-subtrees 'all)
6905 (org-cycle-hide-drawers 'all)
6906 (org-cycle-show-empty-lines t)))
6908 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6909 "Switch subtree visibilities according to :VISIBILITY: property."
6910 (interactive)
6911 (let (org-show-entry-below state)
6912 (save-excursion
6913 (goto-char (point-min))
6914 (while (re-search-forward
6915 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6916 nil t)
6917 (setq state (match-string 1))
6918 (save-excursion
6919 (org-back-to-heading t)
6920 (hide-subtree)
6921 (org-reveal)
6922 (cond
6923 ((equal state '("fold" "folded"))
6924 (hide-subtree))
6925 ((equal state "children")
6926 (org-show-hidden-entry)
6927 (show-children))
6928 ((equal state "content")
6929 (save-excursion
6930 (save-restriction
6931 (org-narrow-to-subtree)
6932 (org-content))))
6933 ((member state '("all" "showall"))
6934 (show-subtree)))))
6935 (unless no-cleanup
6936 (org-cycle-hide-archived-subtrees 'all)
6937 (org-cycle-hide-drawers 'all)
6938 (org-cycle-show-empty-lines 'all)))))
6940 ;; This function uses outline-regexp instead of the more fundamental
6941 ;; org-outline-regexp so that org-cycle-global works outside of Org
6942 ;; buffers, where outline-regexp is needed.
6943 (defun org-overview ()
6944 "Switch to overview mode, showing only top-level headlines.
6945 Really, this shows all headlines with level equal or greater than the level
6946 of the first headline in the buffer. This is important, because if the
6947 first headline is not level one, then (hide-sublevels 1) gives confusing
6948 results."
6949 (interactive)
6950 (let ((pos (point))
6951 (level (save-excursion
6952 (goto-char (point-min))
6953 (if (re-search-forward (concat "^" outline-regexp) nil t)
6954 (progn
6955 (goto-char (match-beginning 0))
6956 (funcall outline-level))))))
6957 (and level (hide-sublevels level))
6958 (recenter '(4))
6959 (goto-char pos)))
6961 (defun org-content (&optional arg)
6962 "Show all headlines in the buffer, like a table of contents.
6963 With numerical argument N, show content up to level N."
6964 (interactive "P")
6965 (save-excursion
6966 ;; Visit all headings and show their offspring
6967 (and (integerp arg) (org-overview))
6968 (goto-char (point-max))
6969 (catch 'exit
6970 (while (and (progn (condition-case nil
6971 (outline-previous-visible-heading 1)
6972 (error (goto-char (point-min))))
6974 (looking-at org-outline-regexp))
6975 (if (integerp arg)
6976 (show-children (1- arg))
6977 (show-branches))
6978 (if (bobp) (throw 'exit nil))))))
6980 (defun org-optimize-window-after-visibility-change (state)
6981 "Adjust the window after a change in outline visibility.
6982 This function is the default value of the hook `org-cycle-hook'."
6983 (when (get-buffer-window (current-buffer))
6984 (cond
6985 ((eq state 'content) nil)
6986 ((eq state 'all) nil)
6987 ((eq state 'folded) nil)
6988 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6989 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6991 (defun org-remove-empty-overlays-at (pos)
6992 "Remove outline overlays that do not contain non-white stuff."
6993 (mapc
6994 (lambda (o)
6995 (and (eq 'outline (overlay-get o 'invisible))
6996 (not (string-match "\\S-" (buffer-substring (overlay-start o)
6997 (overlay-end o))))
6998 (delete-overlay o)))
6999 (overlays-at pos)))
7001 (defun org-clean-visibility-after-subtree-move ()
7002 "Fix visibility issues after moving a subtree."
7003 ;; First, find a reasonable region to look at:
7004 ;; Start two siblings above, end three below
7005 (let* ((beg (save-excursion
7006 (and (org-get-last-sibling)
7007 (org-get-last-sibling))
7008 (point)))
7009 (end (save-excursion
7010 (and (org-get-next-sibling)
7011 (org-get-next-sibling)
7012 (org-get-next-sibling))
7013 (if (org-at-heading-p)
7014 (point-at-eol)
7015 (point))))
7016 (level (looking-at "\\*+"))
7017 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7018 (save-excursion
7019 (save-restriction
7020 (narrow-to-region beg end)
7021 (when re
7022 ;; Properly fold already folded siblings
7023 (goto-char (point-min))
7024 (while (re-search-forward re nil t)
7025 (if (and (not (outline-invisible-p))
7026 (save-excursion
7027 (goto-char (point-at-eol)) (outline-invisible-p)))
7028 (hide-entry))))
7029 (org-cycle-show-empty-lines 'overview)
7030 (org-cycle-hide-drawers 'overview)))))
7032 (defun org-cycle-show-empty-lines (state)
7033 "Show empty lines above all visible headlines.
7034 The region to be covered depends on STATE when called through
7035 `org-cycle-hook'. Lisp program can use t for STATE to get the
7036 entire buffer covered. Note that an empty line is only shown if there
7037 are at least `org-cycle-separator-lines' empty lines before the headline."
7038 (when (not (= org-cycle-separator-lines 0))
7039 (save-excursion
7040 (let* ((n (abs org-cycle-separator-lines))
7041 (re (cond
7042 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7043 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7044 (t (let ((ns (number-to-string (- n 2))))
7045 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7046 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7047 beg end b e)
7048 (cond
7049 ((memq state '(overview contents t))
7050 (setq beg (point-min) end (point-max)))
7051 ((memq state '(children folded))
7052 (setq beg (point) end (progn (org-end-of-subtree t t)
7053 (beginning-of-line 2)
7054 (point)))))
7055 (when beg
7056 (goto-char beg)
7057 (while (re-search-forward re end t)
7058 (unless (get-char-property (match-end 1) 'invisible)
7059 (setq e (match-end 1))
7060 (if (< org-cycle-separator-lines 0)
7061 (setq b (save-excursion
7062 (goto-char (match-beginning 0))
7063 (org-back-over-empty-lines)
7064 (if (save-excursion
7065 (goto-char (max (point-min) (1- (point))))
7066 (org-at-heading-p))
7067 (1- (point))
7068 (point))))
7069 (setq b (match-beginning 1)))
7070 (outline-flag-region b e nil)))))))
7071 ;; Never hide empty lines at the end of the file.
7072 (save-excursion
7073 (goto-char (point-max))
7074 (outline-previous-heading)
7075 (outline-end-of-heading)
7076 (if (and (looking-at "[ \t\n]+")
7077 (= (match-end 0) (point-max)))
7078 (outline-flag-region (point) (match-end 0) nil))))
7080 (defun org-show-empty-lines-in-parent ()
7081 "Move to the parent and re-show empty lines before visible headlines."
7082 (save-excursion
7083 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7084 (org-cycle-show-empty-lines context))))
7086 (defun org-files-list ()
7087 "Return `org-agenda-files' list, plus all open org-mode files.
7088 This is useful for operations that need to scan all of a user's
7089 open and agenda-wise Org files."
7090 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7091 (dolist (buf (buffer-list))
7092 (with-current-buffer buf
7093 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7094 (let ((file (expand-file-name (buffer-file-name))))
7095 (unless (member file files)
7096 (push file files))))))
7097 files))
7099 (defsubst org-entry-beginning-position ()
7100 "Return the beginning position of the current entry."
7101 (save-excursion (outline-back-to-heading t) (point)))
7103 (defsubst org-entry-end-position ()
7104 "Return the end position of the current entry."
7105 (save-excursion (outline-next-heading) (point)))
7107 (defun org-cycle-hide-drawers (state &optional exceptions)
7108 "Re-hide all drawers after a visibility state change.
7109 When non-nil, optional argument EXCEPTIONS is a list of strings
7110 specifying which drawers should not be hidden."
7111 (when (and (derived-mode-p 'org-mode)
7112 (not (memq state '(overview folded contents))))
7113 (save-excursion
7114 (let* ((globalp (memq state '(contents all)))
7115 (beg (if globalp (point-min) (point)))
7116 (end (if globalp (point-max)
7117 (if (eq state 'children)
7118 (save-excursion (outline-next-heading) (point))
7119 (org-end-of-subtree t)))))
7120 (goto-char beg)
7121 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7122 (unless (member-ignore-case (match-string 1) exceptions)
7123 (let ((drawer (org-element-at-point)))
7124 (when (memq (org-element-type drawer) '(drawer property-drawer))
7125 (org-flag-drawer t drawer)
7126 ;; Make sure to skip drawer entirely or we might flag
7127 ;; it another time when matching its ending line with
7128 ;; `org-drawer-regexp'.
7129 (goto-char (org-element-property :end drawer))))))))))
7131 (defun org-cycle-hide-inline-tasks (state)
7132 "Re-hide inline tasks when switching to 'contents or 'children
7133 visibility state."
7134 (case state
7135 (contents
7136 (when (org-bound-and-true-p org-inlinetask-min-level)
7137 (hide-sublevels (1- org-inlinetask-min-level))))
7138 (children
7139 (when (featurep 'org-inlinetask)
7140 (save-excursion
7141 (while (and (outline-next-heading)
7142 (org-inlinetask-at-task-p))
7143 (org-inlinetask-toggle-visibility)
7144 (org-inlinetask-goto-end)))))))
7146 (defun org-flag-drawer (flag &optional element)
7147 "When FLAG is non-nil, hide the drawer we are at.
7148 Otherwise make it visible. When optional argument ELEMENT is
7149 a parsed drawer, as returned by `org-element-at-point', hide or
7150 show that drawer instead."
7151 (let ((drawer (or element (org-element-at-point))))
7152 (when (memq (org-element-type drawer) '(drawer property-drawer))
7153 (save-excursion
7154 (goto-char (org-element-property :post-affiliated drawer))
7155 (outline-flag-region
7156 (line-end-position)
7157 (progn (goto-char (org-element-property :end drawer))
7158 (skip-chars-backward " \r\t\n")
7159 (line-end-position))
7160 flag)))))
7162 (defun org-subtree-end-visible-p ()
7163 "Is the end of the current subtree visible?"
7164 (pos-visible-in-window-p
7165 (save-excursion (org-end-of-subtree t) (point))))
7167 (defun org-first-headline-recenter (&optional N)
7168 "Move cursor to the first headline and recenter the headline.
7169 Optional argument N means put the headline into the Nth line of the window."
7170 (goto-char (point-min))
7171 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7172 (beginning-of-line)
7173 (recenter (prefix-numeric-value N))))
7175 ;;; Saving and restoring visibility
7177 (defun org-outline-overlay-data (&optional use-markers)
7178 "Return a list of the locations of all outline overlays.
7179 These are overlays with the `invisible' property value `outline'.
7180 The return value is a list of cons cells, with start and stop
7181 positions for each overlay.
7182 If USE-MARKERS is set, return the positions as markers."
7183 (let (beg end)
7184 (save-excursion
7185 (save-restriction
7186 (widen)
7187 (delq nil
7188 (mapcar (lambda (o)
7189 (when (eq (overlay-get o 'invisible) 'outline)
7190 (setq beg (overlay-start o)
7191 end (overlay-end o))
7192 (and beg end (> end beg)
7193 (if use-markers
7194 (cons (move-marker (make-marker) beg)
7195 (move-marker (make-marker) end))
7196 (cons beg end)))))
7197 (overlays-in (point-min) (point-max))))))))
7199 (defun org-set-outline-overlay-data (data)
7200 "Create visibility overlays for all positions in DATA.
7201 DATA should have been made by `org-outline-overlay-data'."
7202 (let (o)
7203 (save-excursion
7204 (save-restriction
7205 (widen)
7206 (show-all)
7207 (mapc (lambda (c)
7208 (outline-flag-region (car c) (cdr c) t))
7209 data)))))
7211 ;;; Folding of blocks
7213 (defvar org-hide-block-overlays nil
7214 "Overlays hiding blocks.")
7215 (make-variable-buffer-local 'org-hide-block-overlays)
7217 (defun org-block-map (function &optional start end)
7218 "Call FUNCTION at the head of all source blocks in the current buffer.
7219 Optional arguments START and END can be used to limit the range."
7220 (let ((start (or start (point-min)))
7221 (end (or end (point-max))))
7222 (save-excursion
7223 (goto-char start)
7224 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7225 (save-excursion
7226 (save-match-data
7227 (goto-char (match-beginning 0))
7228 (funcall function)))))))
7230 (defun org-hide-block-toggle-all ()
7231 "Toggle the visibility of all blocks in the current buffer."
7232 (org-block-map #'org-hide-block-toggle))
7234 (defun org-hide-block-all ()
7235 "Fold all blocks in the current buffer."
7236 (interactive)
7237 (org-show-block-all)
7238 (org-block-map #'org-hide-block-toggle-maybe))
7240 (defun org-show-block-all ()
7241 "Unfold all blocks in the current buffer."
7242 (interactive)
7243 (mapc 'delete-overlay org-hide-block-overlays)
7244 (setq org-hide-block-overlays nil))
7246 (defun org-hide-block-toggle-maybe ()
7247 "Toggle visibility of block at point."
7248 (interactive)
7249 (let ((case-fold-search t))
7250 (if (save-excursion
7251 (beginning-of-line 1)
7252 (looking-at org-block-regexp))
7253 (progn (org-hide-block-toggle)
7254 t) ;; to signal that we took action
7255 nil))) ;; to signal that we did not
7257 (defun org-hide-block-toggle (&optional force)
7258 "Toggle the visibility of the current block."
7259 (interactive)
7260 (save-excursion
7261 (beginning-of-line)
7262 (if (re-search-forward org-block-regexp nil t)
7263 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7264 (end (match-end 0)) ;; end of entire body
7266 (if (memq t (mapcar (lambda (overlay)
7267 (eq (overlay-get overlay 'invisible)
7268 'org-hide-block))
7269 (overlays-at start)))
7270 (if (or (not force) (eq force 'off))
7271 (mapc (lambda (ov)
7272 (when (member ov org-hide-block-overlays)
7273 (setq org-hide-block-overlays
7274 (delq ov org-hide-block-overlays)))
7275 (when (eq (overlay-get ov 'invisible)
7276 'org-hide-block)
7277 (delete-overlay ov)))
7278 (overlays-at start)))
7279 (setq ov (make-overlay start end))
7280 (overlay-put ov 'invisible 'org-hide-block)
7281 ;; make the block accessible to isearch
7282 (overlay-put
7283 ov 'isearch-open-invisible
7284 (lambda (ov)
7285 (when (member ov org-hide-block-overlays)
7286 (setq org-hide-block-overlays
7287 (delq ov org-hide-block-overlays)))
7288 (when (eq (overlay-get ov 'invisible)
7289 'org-hide-block)
7290 (delete-overlay ov))))
7291 (push ov org-hide-block-overlays)))
7292 (user-error "Not looking at a source block"))))
7294 ;; org-tab-after-check-for-cycling-hook
7295 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7296 ;; Remove overlays when changing major mode
7297 (add-hook 'org-mode-hook
7298 (lambda () (org-add-hook 'change-major-mode-hook
7299 'org-show-block-all 'append 'local)))
7301 ;;; Org-goto
7303 (defvar org-goto-window-configuration nil)
7304 (defvar org-goto-marker nil)
7305 (defvar org-goto-map)
7306 (defun org-goto-map ()
7307 "Set the keymap `org-goto'."
7308 (setq org-goto-map
7309 (let ((map (make-sparse-keymap)))
7310 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7311 mouse-drag-region universal-argument org-occur))
7312 cmd)
7313 (while (setq cmd (pop cmds))
7314 (substitute-key-definition cmd cmd map global-map)))
7315 (suppress-keymap map)
7316 (org-defkey map "\C-m" 'org-goto-ret)
7317 (org-defkey map [(return)] 'org-goto-ret)
7318 (org-defkey map [(left)] 'org-goto-left)
7319 (org-defkey map [(right)] 'org-goto-right)
7320 (org-defkey map [(control ?g)] 'org-goto-quit)
7321 (org-defkey map "\C-i" 'org-cycle)
7322 (org-defkey map [(tab)] 'org-cycle)
7323 (org-defkey map [(down)] 'outline-next-visible-heading)
7324 (org-defkey map [(up)] 'outline-previous-visible-heading)
7325 (if org-goto-auto-isearch
7326 (if (fboundp 'define-key-after)
7327 (define-key-after map [t] 'org-goto-local-auto-isearch)
7328 nil)
7329 (org-defkey map "q" 'org-goto-quit)
7330 (org-defkey map "n" 'outline-next-visible-heading)
7331 (org-defkey map "p" 'outline-previous-visible-heading)
7332 (org-defkey map "f" 'outline-forward-same-level)
7333 (org-defkey map "b" 'outline-backward-same-level)
7334 (org-defkey map "u" 'outline-up-heading))
7335 (org-defkey map "/" 'org-occur)
7336 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7337 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7338 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7339 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7340 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7341 map)))
7343 (defconst org-goto-help
7344 "Browse buffer copy, to find location or copy text.%s
7345 RET=jump to location C-g=quit and return to previous location
7346 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7348 (defvar org-goto-start-pos) ; dynamically scoped parameter
7350 (defun org-goto (&optional alternative-interface)
7351 "Look up a different location in the current file, keeping current visibility.
7353 When you want look-up or go to a different location in a
7354 document, the fastest way is often to fold the entire buffer and
7355 then dive into the tree. This method has the disadvantage, that
7356 the previous location will be folded, which may not be what you
7357 want.
7359 This command works around this by showing a copy of the current
7360 buffer in an indirect buffer, in overview mode. You can dive
7361 into the tree in that copy, use org-occur and incremental search
7362 to find a location. When pressing RET or `Q', the command
7363 returns to the original buffer in which the visibility is still
7364 unchanged. After RET it will also jump to the location selected
7365 in the indirect buffer and expose the headline hierarchy above.
7367 With a prefix argument, use the alternative interface: e.g. if
7368 `org-goto-interface' is 'outline use 'outline-path-completion."
7369 (interactive "P")
7370 (org-goto-map)
7371 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7372 (org-refile-use-outline-path t)
7373 (org-refile-target-verify-function nil)
7374 (interface
7375 (if (not alternative-interface)
7376 org-goto-interface
7377 (if (eq org-goto-interface 'outline)
7378 'outline-path-completion
7379 'outline)))
7380 (org-goto-start-pos (point))
7381 (selected-point
7382 (if (eq interface 'outline)
7383 (car (org-get-location (current-buffer) org-goto-help))
7384 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7385 (org-refile-check-position pa)
7386 (nth 3 pa)))))
7387 (if selected-point
7388 (progn
7389 (org-mark-ring-push org-goto-start-pos)
7390 (goto-char selected-point)
7391 (if (or (outline-invisible-p) (org-invisible-p2))
7392 (org-show-context 'org-goto)))
7393 (message "Quit"))))
7395 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7396 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7397 (defvar org-goto-local-auto-isearch-map) ; defined below
7399 (defun org-get-location (buf help)
7400 "Let the user select a location in the Org-mode buffer BUF.
7401 This function uses a recursive edit. It returns the selected position
7402 or nil."
7403 (org-no-popups
7404 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7405 (isearch-hide-immediately nil)
7406 (isearch-search-fun-function
7407 (lambda () 'org-goto-local-search-headings))
7408 (org-goto-selected-point org-goto-exit-command))
7409 (save-excursion
7410 (save-window-excursion
7411 (delete-other-windows)
7412 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7413 (org-pop-to-buffer-same-window
7414 (condition-case nil
7415 (make-indirect-buffer (current-buffer) "*org-goto*")
7416 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7417 (with-output-to-temp-buffer "*Org Help*"
7418 (princ (format help (if org-goto-auto-isearch
7419 " Just type for auto-isearch."
7420 " n/p/f/b/u to navigate, q to quit."))))
7421 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7422 (setq buffer-read-only nil)
7423 (let ((org-startup-truncated t)
7424 (org-startup-folded nil)
7425 (org-startup-align-all-tables nil))
7426 (org-mode)
7427 (org-overview))
7428 (setq buffer-read-only t)
7429 (if (and (boundp 'org-goto-start-pos)
7430 (integer-or-marker-p org-goto-start-pos))
7431 (let ((org-show-hierarchy-above t)
7432 (org-show-siblings t)
7433 (org-show-following-heading t))
7434 (goto-char org-goto-start-pos)
7435 (and (outline-invisible-p) (org-show-context)))
7436 (goto-char (point-min)))
7437 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7438 (message "Select location and press RET")
7439 (use-local-map org-goto-map)
7440 (recursive-edit)))
7441 (kill-buffer "*org-goto*")
7442 (cons org-goto-selected-point org-goto-exit-command))))
7444 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7445 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7446 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7447 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7449 (defun org-goto-local-search-headings (string bound noerror)
7450 "Search and make sure that any matches are in headlines."
7451 (catch 'return
7452 (while (if isearch-forward
7453 (search-forward string bound noerror)
7454 (search-backward string bound noerror))
7455 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7456 (and (member :headline context)
7457 (not (member :tags context))))
7458 (throw 'return (point))))))
7460 (defun org-goto-local-auto-isearch ()
7461 "Start isearch."
7462 (interactive)
7463 (goto-char (point-min))
7464 (let ((keys (this-command-keys)))
7465 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7466 (isearch-mode t)
7467 (isearch-process-search-char (string-to-char keys)))))
7469 (defun org-goto-ret (&optional arg)
7470 "Finish `org-goto' by going to the new location."
7471 (interactive "P")
7472 (setq org-goto-selected-point (point)
7473 org-goto-exit-command 'return)
7474 (throw 'exit nil))
7476 (defun org-goto-left ()
7477 "Finish `org-goto' by going to the new location."
7478 (interactive)
7479 (if (org-at-heading-p)
7480 (progn
7481 (beginning-of-line 1)
7482 (setq org-goto-selected-point (point)
7483 org-goto-exit-command 'left)
7484 (throw 'exit nil))
7485 (user-error "Not on a heading")))
7487 (defun org-goto-right ()
7488 "Finish `org-goto' by going to the new location."
7489 (interactive)
7490 (if (org-at-heading-p)
7491 (progn
7492 (setq org-goto-selected-point (point)
7493 org-goto-exit-command 'right)
7494 (throw 'exit nil))
7495 (user-error "Not on a heading")))
7497 (defun org-goto-quit ()
7498 "Finish `org-goto' without cursor motion."
7499 (interactive)
7500 (setq org-goto-selected-point nil)
7501 (setq org-goto-exit-command 'quit)
7502 (throw 'exit nil))
7504 ;;; Indirect buffer display of subtrees
7506 (defvar org-indirect-dedicated-frame nil
7507 "This is the frame being used for indirect tree display.")
7508 (defvar org-last-indirect-buffer nil)
7510 (defun org-tree-to-indirect-buffer (&optional arg)
7511 "Create indirect buffer and narrow it to current subtree.
7512 With a numerical prefix ARG, go up to this level and then take that tree.
7513 If ARG is negative, go up that many levels.
7515 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7516 indirect buffer previously made with this command, to avoid proliferation of
7517 indirect buffers. However, when you call the command with a \
7518 \\[universal-argument] prefix, or
7519 when `org-indirect-buffer-display' is `new-frame', the last buffer
7520 is kept so that you can work with several indirect buffers at the same time.
7521 If `org-indirect-buffer-display' is `dedicated-frame', the \
7522 \\[universal-argument] prefix also
7523 requests that a new frame be made for the new buffer, so that the dedicated
7524 frame is not changed."
7525 (interactive "P")
7526 (let ((cbuf (current-buffer))
7527 (cwin (selected-window))
7528 (pos (point))
7529 beg end level heading ibuf)
7530 (save-excursion
7531 (org-back-to-heading t)
7532 (when (numberp arg)
7533 (setq level (org-outline-level))
7534 (if (< arg 0) (setq arg (+ level arg)))
7535 (while (> (setq level (org-outline-level)) arg)
7536 (org-up-heading-safe)))
7537 (setq beg (point)
7538 heading (org-get-heading))
7539 (org-end-of-subtree t t)
7540 (if (org-at-heading-p) (backward-char 1))
7541 (setq end (point)))
7542 (if (and (buffer-live-p org-last-indirect-buffer)
7543 (not (eq org-indirect-buffer-display 'new-frame))
7544 (not arg))
7545 (kill-buffer org-last-indirect-buffer))
7546 (setq ibuf (org-get-indirect-buffer cbuf heading)
7547 org-last-indirect-buffer ibuf)
7548 (cond
7549 ((or (eq org-indirect-buffer-display 'new-frame)
7550 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7551 (select-frame (make-frame))
7552 (delete-other-windows)
7553 (org-pop-to-buffer-same-window ibuf)
7554 (org-set-frame-title heading))
7555 ((eq org-indirect-buffer-display 'dedicated-frame)
7556 (raise-frame
7557 (select-frame (or (and org-indirect-dedicated-frame
7558 (frame-live-p org-indirect-dedicated-frame)
7559 org-indirect-dedicated-frame)
7560 (setq org-indirect-dedicated-frame (make-frame)))))
7561 (delete-other-windows)
7562 (org-pop-to-buffer-same-window ibuf)
7563 (org-set-frame-title (concat "Indirect: " heading)))
7564 ((eq org-indirect-buffer-display 'current-window)
7565 (org-pop-to-buffer-same-window ibuf))
7566 ((eq org-indirect-buffer-display 'other-window)
7567 (pop-to-buffer ibuf))
7568 (t (error "Invalid value")))
7569 (if (featurep 'xemacs)
7570 (save-excursion (org-mode) (turn-on-font-lock)))
7571 (narrow-to-region beg end)
7572 (show-all)
7573 (goto-char pos)
7574 (run-hook-with-args 'org-cycle-hook 'all)
7575 (and (window-live-p cwin) (select-window cwin))))
7577 (defun org-get-indirect-buffer (&optional buffer heading)
7578 (setq buffer (or buffer (current-buffer)))
7579 (let ((n 1) (base (buffer-name buffer)) bname)
7580 (while (buffer-live-p
7581 (get-buffer
7582 (setq bname
7583 (concat base "-"
7584 (if heading (concat heading "-" (number-to-string n))
7585 (number-to-string n))))))
7586 (setq n (1+ n)))
7587 (condition-case nil
7588 (make-indirect-buffer buffer bname 'clone)
7589 (error (make-indirect-buffer buffer bname)))))
7591 (defun org-set-frame-title (title)
7592 "Set the title of the current frame to the string TITLE."
7593 ;; FIXME: how to name a single frame in XEmacs???
7594 (unless (featurep 'xemacs)
7595 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7597 ;;;; Structure editing
7599 ;;; Inserting headlines
7601 (defun org-previous-line-empty-p (&optional next)
7602 "Is the previous line a blank line?
7603 When NEXT is non-nil, check the next line instead."
7604 (save-excursion
7605 (and (not (bobp))
7606 (or (beginning-of-line (if next 2 0)) t)
7607 (save-match-data
7608 (looking-at "[ \t]*$")))))
7610 (defun org-insert-heading (&optional arg invisible-ok)
7611 "Insert a new heading or item with same depth at point.
7612 If point is in a plain list and ARG is nil, create a new list item.
7613 With one universal prefix argument, insert a heading even in lists.
7614 With two universal prefix arguments, insert the heading at the end
7615 of the parent subtree.
7617 If point is at the beginning of a headline, insert a sibling before
7618 the current headline. If point is not at the beginning, split the line
7619 and create a new headline with the text in the current line after point
7620 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7622 If point is at the beginning of a normal line, turn this line into
7623 a heading.
7625 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7626 This is important for non-interactive uses of the command."
7627 (interactive "P")
7628 (if (org-called-interactively-p 'any) (org-reveal))
7629 (let ((itemp (org-in-item-p))
7630 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7631 (respect-content (or org-insert-heading-respect-content
7632 (equal arg '(16))))
7633 (initial-content "")
7634 (adjust-empty-lines t))
7636 (cond
7638 ((or (= (buffer-size) 0)
7639 (and (not (save-excursion
7640 (and (ignore-errors (org-back-to-heading invisible-ok))
7641 (org-at-heading-p))))
7642 (or arg (not itemp))))
7643 ;; At beginning of buffer or so high up that only a heading
7644 ;; makes sense.
7645 (insert
7646 (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
7647 (if (org-in-src-block-p) ",* " "* "))
7648 (run-hooks 'org-insert-heading-hook))
7650 ((and itemp (not (equal arg '(4))))
7651 ;; Insert an item
7652 (org-insert-item))
7655 ;; Insert a heading
7656 (save-restriction
7657 (widen)
7658 (let* ((level nil)
7659 (on-heading (org-at-heading-p))
7660 (empty-line-p (if on-heading
7661 (org-previous-line-empty-p)
7662 ;; We will decide later
7663 nil))
7664 ;; Get a level string to fall back on
7665 (fix-level
7666 (save-excursion
7667 (org-back-to-heading t)
7668 (if (org-previous-line-empty-p) (setq empty-line-p t))
7669 (looking-at org-outline-regexp)
7670 (make-string (1- (length (match-string 0))) ?*)))
7671 (stars
7672 (save-excursion
7673 (condition-case nil
7674 (progn
7675 (org-back-to-heading invisible-ok)
7676 (when (and (not on-heading)
7677 (featurep 'org-inlinetask)
7678 (integerp org-inlinetask-min-level)
7679 (>= (length (match-string 0))
7680 org-inlinetask-min-level))
7681 ;; Find a heading level before the inline task
7682 (while (and (setq level (org-up-heading-safe))
7683 (>= level org-inlinetask-min-level)))
7684 (if (org-at-heading-p)
7685 (org-back-to-heading invisible-ok)
7686 (error "This should not happen")))
7687 (unless (and (save-excursion
7688 (save-match-data
7689 (org-backward-heading-same-level
7690 1 invisible-ok))
7691 (= (point) (match-beginning 0)))
7692 (not (org-previous-line-empty-p t)))
7693 (setq empty-line-p (or empty-line-p
7694 (org-previous-line-empty-p))))
7695 (match-string 0))
7696 (error (or fix-level "* ")))))
7697 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7698 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7699 pos hide-previous previous-pos)
7701 ;; If we insert after content, move there and clean up whitespace
7702 (when respect-content
7703 (org-end-of-subtree nil t)
7704 (skip-chars-backward " \r\n")
7705 (and (looking-at "[ \t]+") (replace-match ""))
7706 (unless (eobp) (forward-char 1))
7707 (when (looking-at "^\\*")
7708 (unless (bobp) (backward-char 1))
7709 (insert "\n")))
7711 ;; If we are splitting, grab the text that should be moved to the new headline
7712 (when may-split
7713 (if (org-on-heading-p)
7714 ;; This is a heading, we split intelligently (keeping tags)
7715 (let ((pos (point)))
7716 (goto-char (point-at-bol))
7717 (unless (looking-at org-complex-heading-regexp)
7718 (error "This should not happen"))
7719 (when (and (match-beginning 4)
7720 (> pos (match-beginning 4))
7721 (< pos (match-end 4)))
7722 (setq initial-content (buffer-substring pos (match-end 4)))
7723 (goto-char pos)
7724 (delete-region (point) (match-end 4))
7725 (if (looking-at "[ \t]*$")
7726 (replace-match "")
7727 (insert (make-string (length initial-content) ?\ )))
7728 (setq initial-content (org-trim initial-content)))
7729 (goto-char pos))
7730 ;; a normal line
7731 (unless (bolp)
7732 (setq initial-content (buffer-substring (point) (point-at-eol)))
7733 (delete-region (point) (point-at-eol))
7734 (setq initial-content (org-trim initial-content)))))
7736 ;; If we are at the beginning of the line, insert before it. Else after
7737 (cond
7738 ((and (bolp) (looking-at "[ \t]*$")))
7739 ((and (bolp) (not (looking-at "[ \t]*$")))
7740 (open-line 1))
7742 (goto-char (point-at-eol))
7743 (insert "\n")))
7745 ;; Insert the new heading
7746 (insert stars)
7747 (just-one-space)
7748 (insert initial-content)
7749 (when adjust-empty-lines
7750 (if (or (not blank)
7751 (and blank (not (org-previous-line-empty-p))))
7752 (org-N-empty-lines-before-current (if blank 1 0))))
7753 (run-hooks 'org-insert-heading-hook)))))))
7755 (defun org-N-empty-lines-before-current (N)
7756 "Make the number of empty lines before current exactly N.
7757 So this will delete or add empty lines."
7758 (save-excursion
7759 (goto-char (point-at-bol))
7760 (if (looking-back "\\s-+" nil 'greedy)
7761 (replace-match ""))
7762 (or (bobp) (insert "\n"))
7763 (while (> N 0)
7764 (insert "\n")
7765 (setq N (1- N)))))
7767 (defun org-get-heading (&optional no-tags no-todo)
7768 "Return the heading of the current entry, without the stars.
7769 When NO-TAGS is non-nil, don't include tags.
7770 When NO-TODO is non-nil, don't include TODO keywords."
7771 (save-excursion
7772 (org-back-to-heading t)
7773 (cond
7774 ((and no-tags no-todo)
7775 (looking-at org-complex-heading-regexp)
7776 (match-string 4))
7777 (no-tags
7778 (looking-at (concat org-outline-regexp
7779 "\\(.*?\\)"
7780 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7781 (match-string 1))
7782 (no-todo
7783 (looking-at org-todo-line-regexp)
7784 (match-string 3))
7785 (t (looking-at org-heading-regexp)
7786 (match-string 2)))))
7788 (defvar orgstruct-mode) ; defined below
7790 (defun org-heading-components ()
7791 "Return the components of the current heading.
7792 This is a list with the following elements:
7793 - the level as an integer
7794 - the reduced level, different if `org-odd-levels-only' is set.
7795 - the TODO keyword, or nil
7796 - the priority character, like ?A, or nil if no priority is given
7797 - the headline text itself, or the tags string if no headline text
7798 - the tags string, or nil."
7799 (save-excursion
7800 (org-back-to-heading t)
7801 (if (let (case-fold-search)
7802 (looking-at
7803 (if orgstruct-mode
7804 org-heading-regexp
7805 org-complex-heading-regexp)))
7806 (if orgstruct-mode
7807 (list (length (match-string 1))
7808 (org-reduced-level (length (match-string 1)))
7811 (match-string 2)
7812 nil)
7813 (list (length (match-string 1))
7814 (org-reduced-level (length (match-string 1)))
7815 (org-match-string-no-properties 2)
7816 (and (match-end 3) (aref (match-string 3) 2))
7817 (org-match-string-no-properties 4)
7818 (org-match-string-no-properties 5))))))
7820 (defun org-get-entry ()
7821 "Get the entry text, after heading, entire subtree."
7822 (save-excursion
7823 (org-back-to-heading t)
7824 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7826 (defun org-insert-heading-after-current ()
7827 "Insert a new heading with same level as current, after current subtree."
7828 (interactive)
7829 (org-back-to-heading)
7830 (org-insert-heading)
7831 (org-move-subtree-down)
7832 (end-of-line 1))
7834 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7835 "Insert heading with `org-insert-heading-respect-content' set to t."
7836 (interactive "P")
7837 (let ((org-insert-heading-respect-content t))
7838 (org-insert-heading '(4) invisible-ok)))
7840 (defun org-insert-todo-heading-respect-content (&optional force-state)
7841 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7842 (interactive "P")
7843 (let ((org-insert-heading-respect-content t))
7844 (org-insert-todo-heading force-state '(4))))
7846 (defun org-insert-todo-heading (arg &optional force-heading)
7847 "Insert a new heading with the same level and TODO state as current heading.
7848 If the heading has no TODO state, or if the state is DONE, use the first
7849 state (TODO by default). Also one prefix arg, force first state. With two
7850 prefix args, force inserting at the end of the parent subtree."
7851 (interactive "P")
7852 (when (or force-heading (not (org-insert-item 'checkbox)))
7853 (org-insert-heading (or (and (equal arg '(16)) '(16))
7854 force-heading))
7855 (save-excursion
7856 (org-back-to-heading)
7857 (outline-previous-heading)
7858 (looking-at org-todo-line-regexp))
7859 (let*
7860 ((new-mark-x
7861 (if (or arg
7862 (not (match-beginning 2))
7863 (member (match-string 2) org-done-keywords))
7864 (car org-todo-keywords-1)
7865 (match-string 2)))
7866 (new-mark
7868 (run-hook-with-args-until-success
7869 'org-todo-get-default-hook new-mark-x nil)
7870 new-mark-x)))
7871 (beginning-of-line 1)
7872 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7873 (if org-treat-insert-todo-heading-as-state-change
7874 (org-todo new-mark)
7875 (insert new-mark " "))))
7876 (when org-provide-todo-statistics
7877 (org-update-parent-todo-statistics))))
7879 (defun org-insert-subheading (arg)
7880 "Insert a new subheading and demote it.
7881 Works for outline headings and for plain lists alike."
7882 (interactive "P")
7883 (org-insert-heading arg)
7884 (cond
7885 ((org-at-heading-p) (org-do-demote))
7886 ((org-at-item-p) (org-indent-item))))
7888 (defun org-insert-todo-subheading (arg)
7889 "Insert a new subheading with TODO keyword or checkbox and demote it.
7890 Works for outline headings and for plain lists alike."
7891 (interactive "P")
7892 (org-insert-todo-heading arg)
7893 (cond
7894 ((org-at-heading-p) (org-do-demote))
7895 ((org-at-item-p) (org-indent-item))))
7897 ;;; Promotion and Demotion
7899 (defvar org-after-demote-entry-hook nil
7900 "Hook run after an entry has been demoted.
7901 The cursor will be at the beginning of the entry.
7902 When a subtree is being demoted, the hook will be called for each node.")
7904 (defvar org-after-promote-entry-hook nil
7905 "Hook run after an entry has been promoted.
7906 The cursor will be at the beginning of the entry.
7907 When a subtree is being promoted, the hook will be called for each node.")
7909 (defun org-promote-subtree ()
7910 "Promote the entire subtree.
7911 See also `org-promote'."
7912 (interactive)
7913 (save-excursion
7914 (org-with-limited-levels (org-map-tree 'org-promote)))
7915 (org-fix-position-after-promote))
7917 (defun org-demote-subtree ()
7918 "Demote the entire subtree. See `org-demote'.
7919 See also `org-promote'."
7920 (interactive)
7921 (save-excursion
7922 (org-with-limited-levels (org-map-tree 'org-demote)))
7923 (org-fix-position-after-promote))
7926 (defun org-do-promote ()
7927 "Promote the current heading higher up the tree.
7928 If the region is active in `transient-mark-mode', promote all headings
7929 in the region."
7930 (interactive)
7931 (save-excursion
7932 (if (org-region-active-p)
7933 (org-map-region 'org-promote (region-beginning) (region-end))
7934 (org-promote)))
7935 (org-fix-position-after-promote))
7937 (defun org-do-demote ()
7938 "Demote the current heading lower down the tree.
7939 If the region is active in `transient-mark-mode', demote all headings
7940 in the region."
7941 (interactive)
7942 (save-excursion
7943 (if (org-region-active-p)
7944 (org-map-region 'org-demote (region-beginning) (region-end))
7945 (org-demote)))
7946 (org-fix-position-after-promote))
7948 (defun org-fix-position-after-promote ()
7949 "Make sure that after pro/demotion cursor position is right."
7950 (let ((pos (point)))
7951 (when (save-excursion
7952 (beginning-of-line 1)
7953 (looking-at org-todo-line-regexp)
7954 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7955 (cond ((eobp) (insert " "))
7956 ((eolp) (insert " "))
7957 ((equal (char-after) ?\ ) (forward-char 1))))))
7959 (defun org-current-level ()
7960 "Return the level of the current entry, or nil if before the first headline.
7961 The level is the number of stars at the beginning of the headline."
7962 (save-excursion
7963 (org-with-limited-levels
7964 (if (ignore-errors (org-back-to-heading t))
7965 (funcall outline-level)))))
7967 (defun org-get-previous-line-level ()
7968 "Return the outline depth of the last headline before the current line.
7969 Returns 0 for the first headline in the buffer, and nil if before the
7970 first headline."
7971 (and (org-current-level)
7972 (or (and (/= (line-beginning-position) (point-min))
7973 (save-excursion (beginning-of-line 0) (org-current-level)))
7974 0)))
7976 (defun org-reduced-level (l)
7977 "Compute the effective level of a heading.
7978 This takes into account the setting of `org-odd-levels-only'."
7979 (cond
7980 ((zerop l) 0)
7981 (org-odd-levels-only (1+ (floor (/ l 2))))
7982 (t l)))
7984 (defun org-level-increment ()
7985 "Return the number of stars that will be added or removed at a
7986 time to headlines when structure editing, based on the value of
7987 `org-odd-levels-only'."
7988 (if org-odd-levels-only 2 1))
7990 (defun org-get-valid-level (level &optional change)
7991 "Rectify a level change under the influence of `org-odd-levels-only'
7992 LEVEL is a current level, CHANGE is by how much the level should be
7993 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7994 even level numbers will become the next higher odd number."
7995 (if org-odd-levels-only
7996 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7997 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7998 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7999 (max 1 (+ level (or change 0)))))
8001 (if (boundp 'define-obsolete-function-alias)
8002 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8003 (define-obsolete-function-alias 'org-get-legal-level
8004 'org-get-valid-level)
8005 (define-obsolete-function-alias 'org-get-legal-level
8006 'org-get-valid-level "23.1")))
8008 (defun org-promote ()
8009 "Promote the current heading higher up the tree.
8010 If the region is active in `transient-mark-mode', promote all headings
8011 in the region."
8012 (org-back-to-heading t)
8013 (let* ((level (save-match-data (funcall outline-level)))
8014 (after-change-functions (remove 'flyspell-after-change-function
8015 after-change-functions))
8016 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8017 (diff (abs (- level (length up-head) -1))))
8018 (cond ((and (= level 1) org-called-with-limited-levels
8019 org-allow-promoting-top-level-subtree)
8020 (replace-match "# " nil t))
8021 ((= level 1)
8022 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8023 (t (replace-match up-head nil t)))
8024 ;; Fixup tag positioning
8025 (unless (= level 1)
8026 (and org-auto-align-tags (org-set-tags nil t))
8027 (if org-adapt-indentation (org-fixup-indentation (- diff))))
8028 (run-hooks 'org-after-promote-entry-hook)))
8030 (defun org-demote ()
8031 "Demote the current heading lower down the tree.
8032 If the region is active in `transient-mark-mode', demote all headings
8033 in the region."
8034 (org-back-to-heading t)
8035 (let* ((level (save-match-data (funcall outline-level)))
8036 (after-change-functions (remove 'flyspell-after-change-function
8037 after-change-functions))
8038 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8039 (diff (abs (- level (length down-head) -1))))
8040 (replace-match down-head nil t)
8041 ;; Fixup tag positioning
8042 (and org-auto-align-tags (org-set-tags nil t))
8043 (if org-adapt-indentation (org-fixup-indentation diff))
8044 (run-hooks 'org-after-demote-entry-hook)))
8046 (defun org-cycle-level ()
8047 "Cycle the level of an empty headline through possible states.
8048 This goes first to child, then to parent, level, then up the hierarchy.
8049 After top level, it switches back to sibling level."
8050 (interactive)
8051 (let ((org-adapt-indentation nil))
8052 (when (org-point-at-end-of-empty-headline)
8053 (setq this-command 'org-cycle-level) ; Only needed for caching
8054 (let ((cur-level (org-current-level))
8055 (prev-level (org-get-previous-line-level)))
8056 (cond
8057 ;; If first headline in file, promote to top-level.
8058 ((= prev-level 0)
8059 (loop repeat (/ (- cur-level 1) (org-level-increment))
8060 do (org-do-promote)))
8061 ;; If same level as prev, demote one.
8062 ((= prev-level cur-level)
8063 (org-do-demote))
8064 ;; If parent is top-level, promote to top level if not already.
8065 ((= prev-level 1)
8066 (loop repeat (/ (- cur-level 1) (org-level-increment))
8067 do (org-do-promote)))
8068 ;; If top-level, return to prev-level.
8069 ((= cur-level 1)
8070 (loop repeat (/ (- prev-level 1) (org-level-increment))
8071 do (org-do-demote)))
8072 ;; If less than prev-level, promote one.
8073 ((< cur-level prev-level)
8074 (org-do-promote))
8075 ;; If deeper than prev-level, promote until higher than
8076 ;; prev-level.
8077 ((> cur-level prev-level)
8078 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8079 do (org-do-promote))))
8080 t))))
8082 (defun org-map-tree (fun)
8083 "Call FUN for every heading underneath the current one."
8084 (org-back-to-heading)
8085 (let ((level (funcall outline-level)))
8086 (save-excursion
8087 (funcall fun)
8088 (while (and (progn
8089 (outline-next-heading)
8090 (> (funcall outline-level) level))
8091 (not (eobp)))
8092 (funcall fun)))))
8094 (defun org-map-region (fun beg end)
8095 "Call FUN for every heading between BEG and END."
8096 (let ((org-ignore-region t))
8097 (save-excursion
8098 (setq end (copy-marker end))
8099 (goto-char beg)
8100 (if (and (re-search-forward org-outline-regexp-bol nil t)
8101 (< (point) end))
8102 (funcall fun))
8103 (while (and (progn
8104 (outline-next-heading)
8105 (< (point) end))
8106 (not (eobp)))
8107 (funcall fun)))))
8109 (defvar org-property-end-re) ; silence byte-compiler
8110 (defun org-fixup-indentation (diff)
8111 "Change the indentation in the current entry by DIFF.
8112 However, if any line in the current entry has no indentation, or if it
8113 would end up with no indentation after the change, nothing at all is done."
8114 (save-excursion
8115 (let ((end (save-excursion (outline-next-heading)
8116 (point-marker)))
8117 (prohibit (if (> diff 0)
8118 "^\\S-"
8119 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8120 col)
8121 (unless (save-excursion (end-of-line 1)
8122 (re-search-forward prohibit end t))
8123 (while (and (< (point) end)
8124 (re-search-forward "^[ \t]+" end t))
8125 (goto-char (match-end 0))
8126 (setq col (current-column))
8127 (if (< diff 0) (replace-match ""))
8128 (org-indent-to-column (+ diff col))))
8129 (move-marker end nil))))
8131 (defun org-convert-to-odd-levels ()
8132 "Convert an org-mode file with all levels allowed to one with odd levels.
8133 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8134 level 5 etc."
8135 (interactive)
8136 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8137 (let ((outline-level 'org-outline-level)
8138 (org-odd-levels-only nil) n)
8139 (save-excursion
8140 (goto-char (point-min))
8141 (while (re-search-forward "^\\*\\*+ " nil t)
8142 (setq n (- (length (match-string 0)) 2))
8143 (while (>= (setq n (1- n)) 0)
8144 (org-demote))
8145 (end-of-line 1))))))
8147 (defun org-convert-to-oddeven-levels ()
8148 "Convert an org-mode file with only odd levels to one with odd/even levels.
8149 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8150 file contains a section with an even level, conversion would
8151 destroy the structure of the file. An error is signaled in this
8152 case."
8153 (interactive)
8154 (goto-char (point-min))
8155 ;; First check if there are no even levels
8156 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8157 (org-show-context t)
8158 (error "Not all levels are odd in this file. Conversion not possible"))
8159 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8160 (let ((outline-regexp org-outline-regexp)
8161 (outline-level 'org-outline-level)
8162 (org-odd-levels-only nil) n)
8163 (save-excursion
8164 (goto-char (point-min))
8165 (while (re-search-forward "^\\*\\*+ " nil t)
8166 (setq n (/ (1- (length (match-string 0))) 2))
8167 (while (>= (setq n (1- n)) 0)
8168 (org-promote))
8169 (end-of-line 1))))))
8171 (defun org-tr-level (n)
8172 "Make N odd if required."
8173 (if org-odd-levels-only (1+ (/ n 2)) n))
8175 ;;; Vertical tree motion, cutting and pasting of subtrees
8177 (defun org-move-subtree-up (&optional arg)
8178 "Move the current subtree up past ARG headlines of the same level."
8179 (interactive "p")
8180 (org-move-subtree-down (- (prefix-numeric-value arg))))
8182 (defun org-move-subtree-down (&optional arg)
8183 "Move the current subtree down past ARG headlines of the same level."
8184 (interactive "p")
8185 (setq arg (prefix-numeric-value arg))
8186 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8187 'org-get-last-sibling))
8188 (ins-point (make-marker))
8189 (cnt (abs arg))
8190 (col (current-column))
8191 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8192 ;; Select the tree
8193 (org-back-to-heading)
8194 (setq beg0 (point))
8195 (save-excursion
8196 (setq ne-beg (org-back-over-empty-lines))
8197 (setq beg (point)))
8198 (save-match-data
8199 (save-excursion (outline-end-of-heading)
8200 (setq folded (outline-invisible-p)))
8201 (outline-end-of-subtree))
8202 (outline-next-heading)
8203 (setq ne-end (org-back-over-empty-lines))
8204 (setq end (point))
8205 (goto-char beg0)
8206 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8207 ;; include less whitespace
8208 (save-excursion
8209 (goto-char beg)
8210 (forward-line (- ne-beg ne-end))
8211 (setq beg (point))))
8212 ;; Find insertion point, with error handling
8213 (while (> cnt 0)
8214 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8215 (progn (goto-char beg0)
8216 (user-error "Cannot move past superior level or buffer limit")))
8217 (setq cnt (1- cnt)))
8218 (if (> arg 0)
8219 ;; Moving forward - still need to move over subtree
8220 (progn (org-end-of-subtree t t)
8221 (save-excursion
8222 (org-back-over-empty-lines)
8223 (or (bolp) (newline)))))
8224 (setq ne-ins (org-back-over-empty-lines))
8225 (move-marker ins-point (point))
8226 (setq txt (buffer-substring beg end))
8227 (org-save-markers-in-region beg end)
8228 (delete-region beg end)
8229 (org-remove-empty-overlays-at beg)
8230 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8231 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8232 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8233 (let ((bbb (point)))
8234 (insert-before-markers txt)
8235 (org-reinstall-markers-in-region bbb)
8236 (move-marker ins-point bbb))
8237 (or (bolp) (insert "\n"))
8238 (setq ins-end (point))
8239 (goto-char ins-point)
8240 (org-skip-whitespace)
8241 (when (and (< arg 0)
8242 (org-first-sibling-p)
8243 (> ne-ins ne-beg))
8244 ;; Move whitespace back to beginning
8245 (save-excursion
8246 (goto-char ins-end)
8247 (let ((kill-whole-line t))
8248 (kill-line (- ne-ins ne-beg)) (point)))
8249 (insert (make-string (- ne-ins ne-beg) ?\n)))
8250 (move-marker ins-point nil)
8251 (if folded
8252 (hide-subtree)
8253 (org-show-entry)
8254 (show-children)
8255 (org-cycle-hide-drawers 'children))
8256 (org-clean-visibility-after-subtree-move)
8257 ;; move back to the initial column we were at
8258 (move-to-column col)))
8260 (defvar org-subtree-clip ""
8261 "Clipboard for cut and paste of subtrees.
8262 This is actually only a copy of the kill, because we use the normal kill
8263 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8265 (defvar org-subtree-clip-folded nil
8266 "Was the last copied subtree folded?
8267 This is used to fold the tree back after pasting.")
8269 (defun org-cut-subtree (&optional n)
8270 "Cut the current subtree into the clipboard.
8271 With prefix arg N, cut this many sequential subtrees.
8272 This is a short-hand for marking the subtree and then cutting it."
8273 (interactive "p")
8274 (org-copy-subtree n 'cut))
8276 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8277 "Copy the current subtree it in the clipboard.
8278 With prefix arg N, copy this many sequential subtrees.
8279 This is a short-hand for marking the subtree and then copying it.
8280 If CUT is non-nil, actually cut the subtree.
8281 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8282 of some markers in the region, even if CUT is non-nil. This is
8283 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8284 (interactive "p")
8285 (let (beg end folded (beg0 (point)))
8286 (if (org-called-interactively-p 'any)
8287 (org-back-to-heading nil) ; take what looks like a subtree
8288 (org-back-to-heading t)) ; take what is really there
8289 (setq beg (point))
8290 (skip-chars-forward " \t\r\n")
8291 (save-match-data
8292 (if nosubtrees
8293 (outline-next-heading)
8294 (save-excursion (outline-end-of-heading)
8295 (setq folded (outline-invisible-p)))
8296 (condition-case nil
8297 (org-forward-heading-same-level (1- n) t)
8298 (error nil))
8299 (org-end-of-subtree t t)))
8300 (setq end (point))
8301 (goto-char beg0)
8302 (when (> end beg)
8303 (setq org-subtree-clip-folded folded)
8304 (when (or cut force-store-markers)
8305 (org-save-markers-in-region beg end))
8306 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8307 (setq org-subtree-clip (current-kill 0))
8308 (message "%s: Subtree(s) with %d characters"
8309 (if cut "Cut" "Copied")
8310 (length org-subtree-clip)))))
8312 (defun org-paste-subtree (&optional level tree for-yank)
8313 "Paste the clipboard as a subtree, with modification of headline level.
8314 The entire subtree is promoted or demoted in order to match a new headline
8315 level.
8317 If the cursor is at the beginning of a headline, the same level as
8318 that headline is used to paste the tree.
8320 If not, the new level is derived from the *visible* headings
8321 before and after the insertion point, and taken to be the inferior headline
8322 level of the two. So if the previous visible heading is level 3 and the
8323 next is level 4 (or vice versa), level 4 will be used for insertion.
8324 This makes sure that the subtree remains an independent subtree and does
8325 not swallow low level entries.
8327 You can also force a different level, either by using a numeric prefix
8328 argument, or by inserting the heading marker by hand. For example, if the
8329 cursor is after \"*****\", then the tree will be shifted to level 5.
8331 If optional TREE is given, use this text instead of the kill ring.
8333 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8334 move back over whitespace before inserting, and move point to the end of
8335 the inserted text when done."
8336 (interactive "P")
8337 (setq tree (or tree (and kill-ring (current-kill 0))))
8338 (unless (org-kill-is-subtree-p tree)
8339 (user-error "%s"
8340 (substitute-command-keys
8341 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8342 (org-with-limited-levels
8343 (let* ((visp (not (outline-invisible-p)))
8344 (txt tree)
8345 (^re_ "\\(\\*+\\)[ \t]*")
8346 (old-level (if (string-match org-outline-regexp-bol txt)
8347 (- (match-end 0) (match-beginning 0) 1)
8348 -1))
8349 (force-level (cond (level (prefix-numeric-value level))
8350 ((and (looking-at "[ \t]*$")
8351 (string-match
8352 "^\\*+$" (buffer-substring
8353 (point-at-bol) (point))))
8354 (- (match-end 1) (match-beginning 1)))
8355 ((and (bolp)
8356 (looking-at org-outline-regexp))
8357 (- (match-end 0) (point) 1))))
8358 (previous-level (save-excursion
8359 (condition-case nil
8360 (progn
8361 (outline-previous-visible-heading 1)
8362 (if (looking-at ^re_)
8363 (- (match-end 0) (match-beginning 0) 1)
8365 (error 1))))
8366 (next-level (save-excursion
8367 (condition-case nil
8368 (progn
8369 (or (looking-at org-outline-regexp)
8370 (outline-next-visible-heading 1))
8371 (if (looking-at ^re_)
8372 (- (match-end 0) (match-beginning 0) 1)
8374 (error 1))))
8375 (new-level (or force-level (max previous-level next-level)))
8376 (shift (if (or (= old-level -1)
8377 (= new-level -1)
8378 (= old-level new-level))
8380 (- new-level old-level)))
8381 (delta (if (> shift 0) -1 1))
8382 (func (if (> shift 0) 'org-demote 'org-promote))
8383 (org-odd-levels-only nil)
8384 beg end newend)
8385 ;; Remove the forced level indicator
8386 (if force-level
8387 (delete-region (point-at-bol) (point)))
8388 ;; Paste
8389 (beginning-of-line (if (bolp) 1 2))
8390 (setq beg (point))
8391 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8392 (insert-before-markers txt)
8393 (unless (string-match "\n\\'" txt) (insert "\n"))
8394 (setq newend (point))
8395 (org-reinstall-markers-in-region beg)
8396 (setq end (point))
8397 (goto-char beg)
8398 (skip-chars-forward " \t\n\r")
8399 (setq beg (point))
8400 (if (and (outline-invisible-p) visp)
8401 (save-excursion (outline-show-heading)))
8402 ;; Shift if necessary
8403 (unless (= shift 0)
8404 (save-restriction
8405 (narrow-to-region beg end)
8406 (while (not (= shift 0))
8407 (org-map-region func (point-min) (point-max))
8408 (setq shift (+ delta shift)))
8409 (goto-char (point-min))
8410 (setq newend (point-max))))
8411 (when (or (org-called-interactively-p 'interactive) for-yank)
8412 (message "Clipboard pasted as level %d subtree" new-level))
8413 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8414 kill-ring
8415 (eq org-subtree-clip (current-kill 0))
8416 org-subtree-clip-folded)
8417 ;; The tree was folded before it was killed/copied
8418 (hide-subtree))
8419 (and for-yank (goto-char newend)))))
8421 (defun org-kill-is-subtree-p (&optional txt)
8422 "Check if the current kill is an outline subtree, or a set of trees.
8423 Returns nil if kill does not start with a headline, or if the first
8424 headline level is not the largest headline level in the tree.
8425 So this will actually accept several entries of equal levels as well,
8426 which is OK for `org-paste-subtree'.
8427 If optional TXT is given, check this string instead of the current kill."
8428 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8429 (re (org-get-limited-outline-regexp))
8430 (^re (concat "^" re))
8431 (start-level (and kill
8432 (string-match
8433 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8434 kill)
8435 (- (match-end 2) (match-beginning 2) 1)))
8436 (start (1+ (or (match-beginning 2) -1))))
8437 (if (not start-level)
8438 (progn
8439 nil) ;; does not even start with a heading
8440 (catch 'exit
8441 (while (setq start (string-match ^re kill (1+ start)))
8442 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8443 (throw 'exit nil)))
8444 t))))
8446 (defvar org-markers-to-move nil
8447 "Markers that should be moved with a cut-and-paste operation.
8448 Those markers are stored together with their positions relative to
8449 the start of the region.")
8451 (defun org-save-markers-in-region (beg end)
8452 "Check markers in region.
8453 If these markers are between BEG and END, record their position relative
8454 to BEG, so that after moving the block of text, we can put the markers back
8455 into place.
8456 This function gets called just before an entry or tree gets cut from the
8457 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8458 called immediately, to move the markers with the entries."
8459 (setq org-markers-to-move nil)
8460 (when (featurep 'org-clock)
8461 (org-clock-save-markers-for-cut-and-paste beg end))
8462 (when (featurep 'org-agenda)
8463 (org-agenda-save-markers-for-cut-and-paste beg end)))
8465 (defun org-check-and-save-marker (marker beg end)
8466 "Check if MARKER is between BEG and END.
8467 If yes, remember the marker and the distance to BEG."
8468 (when (and (marker-buffer marker)
8469 (equal (marker-buffer marker) (current-buffer)))
8470 (if (and (>= marker beg) (< marker end))
8471 (push (cons marker (- marker beg)) org-markers-to-move))))
8473 (defun org-reinstall-markers-in-region (beg)
8474 "Move all remembered markers to their position relative to BEG."
8475 (mapc (lambda (x)
8476 (move-marker (car x) (+ beg (cdr x))))
8477 org-markers-to-move)
8478 (setq org-markers-to-move nil))
8480 (defun org-narrow-to-subtree ()
8481 "Narrow buffer to the current subtree."
8482 (interactive)
8483 (save-excursion
8484 (save-match-data
8485 (org-with-limited-levels
8486 (narrow-to-region
8487 (progn (org-back-to-heading t) (point))
8488 (progn (org-end-of-subtree t t)
8489 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8490 (point)))))))
8492 (defun org-narrow-to-block ()
8493 "Narrow buffer to the current block."
8494 (interactive)
8495 (let* ((case-fold-search t)
8496 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8497 "^[ \t]*#\\+end_.*")))
8498 (if blockp
8499 (narrow-to-region (car blockp) (cdr blockp))
8500 (user-error "Not in a block"))))
8502 (eval-when-compile
8503 (defvar org-property-drawer-re))
8505 (defvar org-property-start-re) ;; defined below
8506 (defun org-clone-subtree-with-time-shift (n &optional shift)
8507 "Clone the task (subtree) at point N times.
8508 The clones will be inserted as siblings.
8510 In interactive use, the user will be prompted for the number of
8511 clones to be produced. If the entry has a timestamp, the user
8512 will also be prompted for a time shift, which may be a repeater
8513 as used in time stamps, for example `+3d'. To disable this,
8514 you can call the function with a universal prefix argument.
8516 When a valid repeater is given and the entry contains any time
8517 stamps, the clones will become a sequence in time, with time
8518 stamps in the subtree shifted for each clone produced. If SHIFT
8519 is nil or the empty string, time stamps will be left alone. The
8520 ID property of the original subtree is removed.
8522 If the original subtree did contain time stamps with a repeater,
8523 the following will happen:
8524 - the repeater will be removed in each clone
8525 - an additional clone will be produced, with the current, unshifted
8526 date(s) in the entry.
8527 - the original entry will be placed *after* all the clones, with
8528 repeater intact.
8529 - the start days in the repeater in the original entry will be shifted
8530 to past the last clone.
8531 In this way you can spell out a number of instances of a repeating task,
8532 and still retain the repeater to cover future instances of the task."
8533 (interactive "nNumber of clones to produce: ")
8534 (let ((shift
8535 (or shift
8536 (if (and (not (equal current-prefix-arg '(4)))
8537 (save-excursion
8538 (re-search-forward org-ts-regexp-both
8539 (save-excursion
8540 (org-end-of-subtree t)
8541 (point)) t)))
8542 (read-from-minibuffer
8543 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8544 ""))) ;; No time shift
8545 (n-no-remove -1)
8546 (drawer-re org-drawer-regexp)
8547 beg end template task idprop
8548 shift-n shift-what doshift nmin nmax)
8549 (if (not (and (integerp n) (> n 0)))
8550 (error "Invalid number of replications %s" n))
8551 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8552 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8553 shift)))
8554 (error "Invalid shift specification %s" shift))
8555 (when doshift
8556 (setq shift-n (string-to-number (match-string 1 shift))
8557 shift-what (cdr (assoc (match-string 2 shift)
8558 '(("d" . day) ("w" . week)
8559 ("m" . month) ("y" . year))))))
8560 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8561 (setq nmin 1 nmax n)
8562 (org-back-to-heading t)
8563 (setq beg (point))
8564 (setq idprop (org-entry-get nil "ID"))
8565 (org-end-of-subtree t t)
8566 (or (bolp) (insert "\n"))
8567 (setq end (point))
8568 (setq template (buffer-substring beg end))
8569 (when (and doshift
8570 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8571 (delete-region beg end)
8572 (setq end beg)
8573 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8574 (goto-char end)
8575 (loop for n from nmin to nmax do
8576 ;; prepare clone
8577 (with-temp-buffer
8578 (insert template)
8579 (org-mode)
8580 (goto-char (point-min))
8581 (org-show-subtree)
8582 (and idprop (if org-clone-delete-id
8583 (org-entry-delete nil "ID")
8584 (org-id-get-create t)))
8585 (unless (= n 0)
8586 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8587 (kill-whole-line))
8588 (goto-char (point-min))
8589 (while (re-search-forward drawer-re nil t)
8590 (org-remove-empty-drawer-at (point))))
8591 (goto-char (point-min))
8592 (when doshift
8593 (while (re-search-forward org-ts-regexp-both nil t)
8594 (org-timestamp-change (* n shift-n) shift-what))
8595 (unless (= n n-no-remove)
8596 (goto-char (point-min))
8597 (while (re-search-forward org-ts-regexp nil t)
8598 (save-excursion
8599 (goto-char (match-beginning 0))
8600 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8601 (delete-region (match-beginning 1) (match-end 1)))))))
8602 (setq task (buffer-string)))
8603 (insert task))
8604 (goto-char beg)))
8606 ;;; Outline Sorting
8608 (defun org-sort (with-case)
8609 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8610 Optional argument WITH-CASE means sort case-sensitively."
8611 (interactive "P")
8612 (cond
8613 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8614 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8616 (org-call-with-arg 'org-sort-entries with-case))))
8618 (defun org-sort-remove-invisible (s)
8619 "Remove invisible links from string S."
8620 (remove-text-properties 0 (length s) org-rm-props s)
8621 (while (string-match org-bracket-link-regexp s)
8622 (setq s (replace-match (if (match-end 2)
8623 (match-string 3 s)
8624 (match-string 1 s)) t t s)))
8625 (let ((st (format " %s " s)))
8626 (while (string-match org-emph-re st)
8627 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8628 (setq s (substring st 1 -1)))
8631 (defvar org-priority-regexp) ; defined later in the file
8633 (defvar org-after-sorting-entries-or-items-hook nil
8634 "Hook that is run after a bunch of entries or items have been sorted.
8635 When children are sorted, the cursor is in the parent line when this
8636 hook gets called. When a region or a plain list is sorted, the cursor
8637 will be in the first entry of the sorted region/list.")
8639 (defun org-sort-entries
8640 (&optional with-case sorting-type getkey-func compare-func property)
8641 "Sort entries on a certain level of an outline tree.
8642 If there is an active region, the entries in the region are sorted.
8643 Else, if the cursor is before the first entry, sort the top-level items.
8644 Else, the children of the entry at point are sorted.
8646 Sorting can be alphabetically, numerically, by date/time as given by
8647 a time stamp, by a property, by priority order, or by a custom function.
8649 The command prompts for the sorting type unless it has been given to the
8650 function through the SORTING-TYPE argument, which needs to be a character,
8651 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8652 precise meaning of each character:
8654 n Numerically, by converting the beginning of the entry/item to a number.
8655 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8656 o By order of TODO keywords.
8657 t By date/time, either the first active time stamp in the entry, or, if
8658 none exist, by the first inactive one.
8659 s By the scheduled date/time.
8660 d By deadline date/time.
8661 c By creation time, which is assumed to be the first inactive time stamp
8662 at the beginning of a line.
8663 p By priority according to the cookie.
8664 r By the value of a property.
8666 Capital letters will reverse the sort order.
8668 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8669 called with point at the beginning of the record. It must return either
8670 a string or a number that should serve as the sorting key for that record.
8672 Comparing entries ignores case by default. However, with an optional argument
8673 WITH-CASE, the sorting considers case as well.
8675 Sorting is done against the visible part of the headlines, it ignores hidden
8676 links.
8678 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8679 (interactive "P")
8680 (let ((case-func (if with-case 'identity 'downcase))
8681 (cmstr
8682 ;; The clock marker is lost when using `sort-subr', let's
8683 ;; store the clocking string.
8684 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8685 (save-excursion
8686 (goto-char org-clock-marker)
8687 (looking-back "^.*") (match-string-no-properties 0))))
8688 start beg end stars re re2
8689 txt what tmp)
8690 ;; Find beginning and end of region to sort
8691 (cond
8692 ((org-region-active-p)
8693 ;; we will sort the region
8694 (setq end (region-end)
8695 what "region")
8696 (goto-char (region-beginning))
8697 (if (not (org-at-heading-p)) (outline-next-heading))
8698 (setq start (point)))
8699 ((or (org-at-heading-p)
8700 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8701 ;; we will sort the children of the current headline
8702 (org-back-to-heading)
8703 (setq start (point)
8704 end (progn (org-end-of-subtree t t)
8705 (or (bolp) (insert "\n"))
8706 (org-back-over-empty-lines)
8707 (point))
8708 what "children")
8709 (goto-char start)
8710 (show-subtree)
8711 (outline-next-heading))
8713 ;; we will sort the top-level entries in this file
8714 (goto-char (point-min))
8715 (or (org-at-heading-p) (outline-next-heading))
8716 (setq start (point))
8717 (goto-char (point-max))
8718 (beginning-of-line 1)
8719 (when (looking-at ".*?\\S-")
8720 ;; File ends in a non-white line
8721 (end-of-line 1)
8722 (insert "\n"))
8723 (setq end (point-max))
8724 (setq what "top-level")
8725 (goto-char start)
8726 (show-all)))
8728 (setq beg (point))
8729 (if (>= beg end) (user-error "Nothing to sort"))
8731 (looking-at "\\(\\*+\\)")
8732 (setq stars (match-string 1)
8733 re (concat "^" (regexp-quote stars) " +")
8734 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8735 txt (buffer-substring beg end))
8736 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8737 (if (and (not (equal stars "*")) (string-match re2 txt))
8738 (user-error "Region to sort contains a level above the first entry"))
8740 (unless sorting-type
8741 (message
8742 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8743 [t]ime [s]cheduled [d]eadline [c]reated
8744 A/N/P/R/O/F/T/S/D/C means reversed:"
8745 what)
8746 (setq sorting-type (read-char-exclusive))
8748 (unless getkey-func
8749 (and (= (downcase sorting-type) ?f)
8750 (setq getkey-func
8751 (org-icompleting-read "Sort using function: "
8752 obarray 'fboundp t nil nil))
8753 (setq getkey-func (intern getkey-func))))
8755 (and (= (downcase sorting-type) ?r)
8756 (not property)
8757 (setq property
8758 (org-icompleting-read "Property: "
8759 (mapcar 'list (org-buffer-property-keys t))
8760 nil t))))
8762 (message "Sorting entries...")
8764 (save-restriction
8765 (narrow-to-region start end)
8766 (let ((dcst (downcase sorting-type))
8767 (case-fold-search nil)
8768 (now (current-time)))
8769 (sort-subr
8770 (/= dcst sorting-type)
8771 ;; This function moves to the beginning character of the "record" to
8772 ;; be sorted.
8773 (lambda nil
8774 (if (re-search-forward re nil t)
8775 (goto-char (match-beginning 0))
8776 (goto-char (point-max))))
8777 ;; This function moves to the last character of the "record" being
8778 ;; sorted.
8779 (lambda nil
8780 (save-match-data
8781 (condition-case nil
8782 (outline-forward-same-level 1)
8783 (error
8784 (goto-char (point-max))))))
8785 ;; This function returns the value that gets sorted against.
8786 (lambda nil
8787 (cond
8788 ((= dcst ?n)
8789 (if (looking-at org-complex-heading-regexp)
8790 (string-to-number (org-sort-remove-invisible (match-string 4)))
8791 nil))
8792 ((= dcst ?a)
8793 (if (looking-at org-complex-heading-regexp)
8794 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8795 nil))
8796 ((= dcst ?t)
8797 (let ((end (save-excursion (outline-next-heading) (point))))
8798 (if (or (re-search-forward org-ts-regexp end t)
8799 (re-search-forward org-ts-regexp-both end t))
8800 (org-time-string-to-seconds (match-string 0))
8801 (org-float-time now))))
8802 ((= dcst ?c)
8803 (let ((end (save-excursion (outline-next-heading) (point))))
8804 (if (re-search-forward
8805 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8806 end t)
8807 (org-time-string-to-seconds (match-string 0))
8808 (org-float-time now))))
8809 ((= dcst ?s)
8810 (let ((end (save-excursion (outline-next-heading) (point))))
8811 (if (re-search-forward org-scheduled-time-regexp end t)
8812 (org-time-string-to-seconds (match-string 1))
8813 (org-float-time now))))
8814 ((= dcst ?d)
8815 (let ((end (save-excursion (outline-next-heading) (point))))
8816 (if (re-search-forward org-deadline-time-regexp end t)
8817 (org-time-string-to-seconds (match-string 1))
8818 (org-float-time now))))
8819 ((= dcst ?p)
8820 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8821 (string-to-char (match-string 2))
8822 org-default-priority))
8823 ((= dcst ?r)
8824 (or (org-entry-get nil property) ""))
8825 ((= dcst ?o)
8826 (if (looking-at org-complex-heading-regexp)
8827 (- 9999 (length (member (match-string 2)
8828 org-todo-keywords-1)))))
8829 ((= dcst ?f)
8830 (if getkey-func
8831 (progn
8832 (setq tmp (funcall getkey-func))
8833 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8834 tmp)
8835 (error "Invalid key function `%s'" getkey-func)))
8836 (t (error "Invalid sorting type `%c'" sorting-type))))
8838 (cond
8839 ((= dcst ?a) 'string<)
8840 ((= dcst ?f) compare-func)
8841 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8842 (run-hooks 'org-after-sorting-entries-or-items-hook)
8843 ;; Reset the clock marker if needed
8844 (when cmstr
8845 (save-excursion
8846 (goto-char start)
8847 (search-forward cmstr nil t)
8848 (move-marker org-clock-marker (point))))
8849 (message "Sorting entries...done")))
8851 (defun org-do-sort (table what &optional with-case sorting-type)
8852 "Sort TABLE of WHAT according to SORTING-TYPE.
8853 The user will be prompted for the SORTING-TYPE if the call to this
8854 function does not specify it. WHAT is only for the prompt, to indicate
8855 what is being sorted. The sorting key will be extracted from
8856 the car of the elements of the table.
8857 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8858 (unless sorting-type
8859 (message
8860 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8861 what)
8862 (setq sorting-type (read-char-exclusive)))
8863 (let ((dcst (downcase sorting-type))
8864 extractfun comparefun)
8865 ;; Define the appropriate functions
8866 (cond
8867 ((= dcst ?n)
8868 (setq extractfun 'string-to-number
8869 comparefun (if (= dcst sorting-type) '< '>)))
8870 ((= dcst ?a)
8871 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8872 (lambda(x) (downcase (org-sort-remove-invisible x))))
8873 comparefun (if (= dcst sorting-type)
8874 'string<
8875 (lambda (a b) (and (not (string< a b))
8876 (not (string= a b)))))))
8877 ((= dcst ?t)
8878 (setq extractfun
8879 (lambda (x)
8880 (if (or (string-match org-ts-regexp x)
8881 (string-match org-ts-regexp-both x))
8882 (org-float-time
8883 (org-time-string-to-time (match-string 0 x)))
8885 comparefun (if (= dcst sorting-type) '< '>)))
8886 (t (error "Invalid sorting type `%c'" sorting-type)))
8888 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8889 table)
8890 (lambda (a b) (funcall comparefun (car a) (car b))))))
8893 ;;; The orgstruct minor mode
8895 ;; Define a minor mode which can be used in other modes in order to
8896 ;; integrate the org-mode structure editing commands.
8898 ;; This is really a hack, because the org-mode structure commands use
8899 ;; keys which normally belong to the major mode. Here is how it
8900 ;; works: The minor mode defines all the keys necessary to operate the
8901 ;; structure commands, but wraps the commands into a function which
8902 ;; tests if the cursor is currently at a headline or a plain list
8903 ;; item. If that is the case, the structure command is used,
8904 ;; temporarily setting many Org-mode variables like regular
8905 ;; expressions for filling etc. However, when any of those keys is
8906 ;; used at a different location, function uses `key-binding' to look
8907 ;; up if the key has an associated command in another currently active
8908 ;; keymap (minor modes, major mode, global), and executes that
8909 ;; command. There might be problems if any of the keys is otherwise
8910 ;; used as a prefix key.
8912 (defcustom orgstruct-heading-prefix-regexp ""
8913 "Regexp that matches the custom prefix of Org headlines in
8914 orgstruct(++)-mode."
8915 :group 'org
8916 :version "24.4"
8917 :package-version '(Org . "8.3")
8918 :type 'regexp)
8919 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8921 (defcustom orgstruct-setup-hook nil
8922 "Hook run after orgstruct-mode-map is filled."
8923 :group 'org
8924 :version "24.4"
8925 :package-version '(Org . "8.0")
8926 :type 'hook)
8928 (defvar orgstruct-initialized nil)
8930 (defvar org-local-vars nil
8931 "List of local variables, for use by `orgstruct-mode'.")
8933 ;;;###autoload
8934 (define-minor-mode orgstruct-mode
8935 "Toggle the minor mode `orgstruct-mode'.
8936 This mode is for using Org-mode structure commands in other
8937 modes. The following keys behave as if Org-mode were active, if
8938 the cursor is on a headline, or on a plain list item (both as
8939 defined by Org-mode)."
8940 nil " OrgStruct" (make-sparse-keymap)
8941 (funcall (if orgstruct-mode
8942 'add-to-invisibility-spec
8943 'remove-from-invisibility-spec)
8944 '(outline . t))
8945 (when orgstruct-mode
8946 (org-load-modules-maybe)
8947 (unless orgstruct-initialized
8948 (orgstruct-setup)
8949 (setq orgstruct-initialized t))))
8951 ;;;###autoload
8952 (defun turn-on-orgstruct ()
8953 "Unconditionally turn on `orgstruct-mode'."
8954 (orgstruct-mode 1))
8956 (defvar org-fb-vars nil)
8957 (make-variable-buffer-local 'org-fb-vars)
8958 (defun orgstruct++-mode (&optional arg)
8959 "Toggle `orgstruct-mode', the enhanced version of it.
8960 In addition to setting orgstruct-mode, this also exports all
8961 indentation and autofilling variables from org-mode into the
8962 buffer. It will also recognize item context in multiline items."
8963 (interactive "P")
8964 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8965 (if (< arg 1)
8966 (progn (orgstruct-mode -1)
8967 (mapc (lambda(v)
8968 (org-set-local (car v)
8969 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8970 org-fb-vars))
8971 (orgstruct-mode 1)
8972 (setq org-fb-vars nil)
8973 (unless org-local-vars
8974 (setq org-local-vars (org-get-local-variables)))
8975 (let (var val)
8976 (mapc
8977 (lambda (x)
8978 (when (string-match
8979 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8980 (symbol-name (car x)))
8981 (setq var (car x) val (nth 1 x))
8982 (push (list var `(quote ,(eval var))) org-fb-vars)
8983 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8984 org-local-vars)
8985 (org-set-local 'orgstruct-is-++ t))))
8987 (defvar orgstruct-is-++ nil
8988 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8989 (make-variable-buffer-local 'orgstruct-is-++)
8991 ;;;###autoload
8992 (defun turn-on-orgstruct++ ()
8993 "Unconditionally turn on `orgstruct++-mode'."
8994 (orgstruct++-mode 1))
8996 (defun orgstruct-error ()
8997 "Error when there is no default binding for a structure key."
8998 (interactive)
8999 (funcall (if (fboundp 'user-error)
9000 'user-error
9001 'error)
9002 "This key has no function outside structure elements"))
9004 (defun orgstruct-setup ()
9005 "Setup orgstruct keymap."
9006 (dolist (cell '((org-demote . t)
9007 (org-metaleft . t)
9008 (org-metaright . t)
9009 (org-promote . t)
9010 (org-shiftmetaleft . t)
9011 (org-shiftmetaright . t)
9012 org-backward-element
9013 org-backward-heading-same-level
9014 org-ctrl-c-ret
9015 org-ctrl-c-minus
9016 org-ctrl-c-star
9017 org-cycle
9018 org-forward-heading-same-level
9019 org-insert-heading
9020 org-insert-heading-respect-content
9021 org-kill-note-or-show-branches
9022 org-mark-subtree
9023 org-meta-return
9024 org-metadown
9025 org-metaup
9026 org-narrow-to-subtree
9027 org-promote-subtree
9028 org-reveal
9029 org-shiftdown
9030 org-shiftleft
9031 org-shiftmetadown
9032 org-shiftmetaup
9033 org-shiftright
9034 org-shifttab
9035 org-shifttab
9036 org-shiftup
9037 org-show-subtree
9038 org-sort
9039 org-up-element
9040 outline-demote
9041 outline-next-visible-heading
9042 outline-previous-visible-heading
9043 outline-promote
9044 outline-up-heading
9045 show-children))
9046 (let ((f (or (car-safe cell) cell))
9047 (disable-when-heading-prefix (cdr-safe cell)))
9048 (when (fboundp f)
9049 (let ((new-bindings))
9050 (dolist (binding (nconc (where-is-internal f org-mode-map)
9051 (where-is-internal f outline-mode-map)))
9052 (push binding new-bindings)
9053 ;; TODO use local-function-key-map
9054 (dolist (rep '(("<tab>" . "TAB")
9055 ("<return>" . "RET")
9056 ("<escape>" . "ESC")
9057 ("<delete>" . "DEL")))
9058 (setq binding (read-kbd-macro
9059 (let ((case-fold-search))
9060 (replace-regexp-in-string
9061 (regexp-quote (cdr rep))
9062 (car rep)
9063 (key-description binding)))))
9064 (pushnew binding new-bindings :test 'equal)))
9065 (dolist (binding new-bindings)
9066 (let ((key (lookup-key orgstruct-mode-map binding)))
9067 (when (or (not key) (numberp key))
9068 (condition-case nil
9069 (org-defkey orgstruct-mode-map
9070 binding
9071 (orgstruct-make-binding f binding disable-when-heading-prefix))
9072 (error nil)))))))))
9073 (run-hooks 'orgstruct-setup-hook))
9075 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9076 "Create a function for binding in the structure minor mode.
9077 FUN is the command to call inside a table. KEY is the key that
9078 should be checked in for a command to execute outside of tables.
9079 Non-nil `disable-when-heading-prefix' means to disable the command
9080 if `orgstruct-heading-prefix-regexp' is not empty."
9081 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9082 (let ((nname name)
9083 (i 0))
9084 (while (fboundp (intern nname))
9085 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9086 (setq name (intern nname)))
9087 (eval
9088 (let ((bindings '((org-heading-regexp
9089 (concat "^"
9090 orgstruct-heading-prefix-regexp
9091 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9092 (org-outline-regexp
9093 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9094 (org-outline-regexp-bol
9095 (concat "^" org-outline-regexp))
9096 (outline-regexp org-outline-regexp)
9097 (outline-heading-end-regexp "\n")
9098 (outline-level 'org-outline-level)
9099 (outline-heading-alist))))
9100 `(defun ,name (arg)
9101 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9102 "Outside of structure, run the binding of `"
9103 (key-description key) "'."
9104 (when disable-when-heading-prefix
9105 (concat
9106 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9107 "back to the default binding due to limitations of Org's implementation of\n"
9108 "`" (symbol-name fun) "'.")))
9109 (interactive "p")
9110 (let* ((disable
9111 ,(and disable-when-heading-prefix
9112 '(not (string= orgstruct-heading-prefix-regexp ""))))
9113 (fallback
9114 (or disable
9115 (not
9116 (let* ,bindings
9117 (org-context-p 'headline 'item
9118 ,(when (memq fun
9119 '(org-insert-heading
9120 org-insert-heading-respect-content
9121 org-meta-return))
9122 '(when orgstruct-is-++
9123 'item-body))))))))
9124 (if fallback
9125 (let* ((orgstruct-mode)
9126 (binding
9127 (loop with key = ,key
9128 for rep in
9129 '(nil
9130 ("<\\([^>]*\\)tab>" . "\\1TAB")
9131 ("<\\([^>]*\\)return>" . "\\1RET")
9132 ("<\\([^>]*\\)escape>" . "\\1ESC")
9133 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9135 (when rep
9136 (setq key (read-kbd-macro
9137 (let ((case-fold-search))
9138 (replace-regexp-in-string
9139 (car rep)
9140 (cdr rep)
9141 (key-description key))))))
9142 thereis (key-binding key))))
9143 (if (keymapp binding)
9144 (set-transient-map binding)
9145 (let ((func (or binding
9146 (unless disable
9147 'orgstruct-error))))
9148 (when func
9149 (call-interactively func)))))
9150 (org-run-like-in-org-mode
9151 (lambda ()
9152 (interactive)
9153 (let* ,bindings
9154 (call-interactively ',fun)))))))))
9155 name))
9157 (defun org-contextualize-keys (alist contexts)
9158 "Return valid elements in ALIST depending on CONTEXTS.
9160 `org-agenda-custom-commands' or `org-capture-templates' are the
9161 values used for ALIST, and `org-agenda-custom-commands-contexts'
9162 or `org-capture-templates-contexts' are the associated contexts
9163 definitions."
9164 (let ((contexts
9165 ;; normalize contexts
9166 (mapcar
9167 (lambda(c) (cond ((listp (cadr c))
9168 (list (car c) (car c) (cadr c)))
9169 ((string= "" (cadr c))
9170 (list (car c) (car c) (caddr c)))
9171 (t c))) contexts))
9172 (a alist) c r s)
9173 ;; loop over all commands or templates
9174 (while (setq c (pop a))
9175 (let (vrules repl)
9176 (cond
9177 ((not (assoc (car c) contexts))
9178 (push c r))
9179 ((and (assoc (car c) contexts)
9180 (setq vrules (org-contextualize-validate-key
9181 (car c) contexts)))
9182 (mapc (lambda (vr)
9183 (when (not (equal (car vr) (cadr vr)))
9184 (setq repl vr))) vrules)
9185 (if (not repl) (push c r)
9186 (push (cadr repl) s)
9187 (push
9188 (cons (car c)
9189 (cdr (or (assoc (cadr repl) alist)
9190 (error "Undefined key `%s' as contextual replacement for `%s'"
9191 (cadr repl) (car c)))))
9192 r))))))
9193 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9194 (delq
9196 (delete-dups
9197 (mapcar (lambda (x)
9198 (let ((tpl (car x)))
9199 (when (not (delq
9201 (mapcar (lambda(y)
9202 (equal y tpl)) s))) x)))
9203 (reverse r))))))
9205 (defun org-contextualize-validate-key (key contexts)
9206 "Check CONTEXTS for agenda or capture KEY."
9207 (let (r rr res)
9208 (while (setq r (pop contexts))
9209 (mapc
9210 (lambda (rr)
9211 (when
9212 (and (equal key (car r))
9213 (if (functionp rr) (funcall rr)
9214 (or (and (eq (car rr) 'in-file)
9215 (buffer-file-name)
9216 (string-match (cdr rr) (buffer-file-name)))
9217 (and (eq (car rr) 'in-mode)
9218 (string-match (cdr rr) (symbol-name major-mode)))
9219 (and (eq (car rr) 'in-buffer)
9220 (string-match (cdr rr) (buffer-name)))
9221 (when (and (eq (car rr) 'not-in-file)
9222 (buffer-file-name))
9223 (not (string-match (cdr rr) (buffer-file-name))))
9224 (when (eq (car rr) 'not-in-mode)
9225 (not (string-match (cdr rr) (symbol-name major-mode))))
9226 (when (eq (car rr) 'not-in-buffer)
9227 (not (string-match (cdr rr) (buffer-name)))))))
9228 (push r res)))
9229 (car (last r))))
9230 (delete-dups (delq nil res))))
9232 (defun org-context-p (&rest contexts)
9233 "Check if local context is any of CONTEXTS.
9234 Possible values in the list of contexts are `table', `headline', and `item'."
9235 (let ((pos (point)))
9236 (goto-char (point-at-bol))
9237 (prog1 (or (and (memq 'table contexts)
9238 (looking-at "[ \t]*|"))
9239 (and (memq 'headline contexts)
9240 (looking-at org-outline-regexp))
9241 (and (memq 'item contexts)
9242 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9243 (and (memq 'item-body contexts)
9244 (org-in-item-p)))
9245 (goto-char pos))))
9247 (defun org-get-local-variables ()
9248 "Return a list of all local variables in an Org mode buffer."
9249 (let (varlist)
9250 (with-current-buffer (get-buffer-create "*Org tmp*")
9251 (erase-buffer)
9252 (org-mode)
9253 (setq varlist (buffer-local-variables)))
9254 (kill-buffer "*Org tmp*")
9255 (delq nil
9256 (mapcar
9257 (lambda (x)
9258 (setq x
9259 (if (symbolp x)
9260 (list x)
9261 (list (car x) (cdr x))))
9262 (if (and (not (get (car x) 'org-state))
9263 (string-match
9264 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9265 (symbol-name (car x))))
9266 x nil))
9267 varlist))))
9269 (defun org-clone-local-variables (from-buffer &optional regexp)
9270 "Clone local variables from FROM-BUFFER.
9271 Optional argument REGEXP selects variables to clone."
9272 (mapc
9273 (lambda (pair)
9274 (and (symbolp (car pair))
9275 (or (null regexp)
9276 (string-match regexp (symbol-name (car pair))))
9277 (set (make-local-variable (car pair))
9278 (cdr pair))))
9279 (buffer-local-variables from-buffer)))
9281 ;;;###autoload
9282 (defun org-run-like-in-org-mode (cmd)
9283 "Run a command, pretending that the current buffer is in Org-mode.
9284 This will temporarily bind local variables that are typically bound in
9285 Org-mode to the values they have in Org-mode, and then interactively
9286 call CMD."
9287 (org-load-modules-maybe)
9288 (unless org-local-vars
9289 (setq org-local-vars (org-get-local-variables)))
9290 (let (binds)
9291 (dolist (var org-local-vars)
9292 (when (or (not (boundp (car var)))
9293 (eq (symbol-value (car var))
9294 (default-value (car var))))
9295 (push (list (car var) `(quote ,(cadr var))) binds)))
9296 (eval `(let ,binds
9297 (call-interactively (quote ,cmd))))))
9299 ;;;; Archiving
9301 (defun org-get-category (&optional pos force-refresh)
9302 "Get the category applying to position POS."
9303 (save-match-data
9304 (if force-refresh (org-refresh-category-properties))
9305 (let ((pos (or pos (point))))
9306 (or (get-text-property pos 'org-category)
9307 (progn (org-refresh-category-properties)
9308 (get-text-property pos 'org-category))))))
9310 (defun org-refresh-category-properties ()
9311 "Refresh category text properties in the buffer."
9312 (let ((case-fold-search t)
9313 (inhibit-read-only t)
9314 (def-cat (cond
9315 ((null org-category)
9316 (if buffer-file-name
9317 (file-name-sans-extension
9318 (file-name-nondirectory buffer-file-name))
9319 "???"))
9320 ((symbolp org-category) (symbol-name org-category))
9321 (t org-category)))
9322 beg end cat pos optionp)
9323 (org-with-silent-modifications
9324 (save-excursion
9325 (save-restriction
9326 (widen)
9327 (goto-char (point-min))
9328 (put-text-property (point) (point-max) 'org-category def-cat)
9329 (while (re-search-forward
9330 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9331 (setq pos (match-end 0)
9332 optionp (equal (char-after (match-beginning 0)) ?#)
9333 cat (org-trim (match-string 2)))
9334 (if optionp
9335 (setq beg (point-at-bol) end (point-max))
9336 (org-back-to-heading t)
9337 (setq beg (point) end (org-end-of-subtree t t)))
9338 (put-text-property beg end 'org-category cat)
9339 (put-text-property beg end 'org-category-position beg)
9340 (goto-char pos)))))))
9342 (defun org-refresh-properties (dprop tprop)
9343 "Refresh buffer text properties.
9344 DPROP is the drawer property and TPROP is the corresponding text
9345 property to set."
9346 (let ((case-fold-search t)
9347 (inhibit-read-only t) p)
9348 (org-with-silent-modifications
9349 (save-excursion
9350 (save-restriction
9351 (widen)
9352 (goto-char (point-min))
9353 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9354 (setq p (org-match-string-no-properties 1))
9355 (save-excursion
9356 (org-back-to-heading t)
9357 (put-text-property
9358 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9361 ;;;; Link Stuff
9363 ;;; Link abbreviations
9365 (defun org-link-expand-abbrev (link)
9366 "Apply replacements as defined in `org-link-abbrev-alist'."
9367 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9368 (let* ((key (match-string 1 link))
9369 (as (or (assoc key org-link-abbrev-alist-local)
9370 (assoc key org-link-abbrev-alist)))
9371 (tag (and (match-end 2) (match-string 3 link)))
9372 rpl)
9373 (if (not as)
9374 link
9375 (setq rpl (cdr as))
9376 (cond
9377 ((symbolp rpl) (funcall rpl tag))
9378 ((string-match "%(\\([^)]+\\))" rpl)
9379 (replace-match
9380 (save-match-data
9381 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9382 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9383 ((string-match "%h" rpl)
9384 (replace-match (url-hexify-string (or tag "")) t t rpl))
9385 (t (concat rpl tag)))))
9386 link))
9388 ;;; Storing and inserting links
9390 (defvar org-insert-link-history nil
9391 "Minibuffer history for links inserted with `org-insert-link'.")
9393 (defvar org-stored-links nil
9394 "Contains the links stored with `org-store-link'.")
9396 (defvar org-store-link-plist nil
9397 "Plist with info about the most recently link created with `org-store-link'.")
9399 (defvar org-link-protocols nil
9400 "Link protocols added to Org-mode using `org-add-link-type'.")
9402 (defvar org-store-link-functions nil
9403 "List of functions that are called to create and store a link.
9404 Each function will be called in turn until one returns a non-nil
9405 value. Each function should check if it is responsible for creating
9406 this link (for example by looking at the major mode).
9407 If not, it must exit and return nil.
9408 If yes, it should return a non-nil value after a calling
9409 `org-store-link-props' with a list of properties and values.
9410 Special properties are:
9412 :type The link prefix, like \"http\". This must be given.
9413 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9414 This is obligatory as well.
9415 :description Optional default description for the second pair
9416 of brackets in an Org-mode link. The user can still change
9417 this when inserting this link into an Org-mode buffer.
9419 In addition to these, any additional properties can be specified
9420 and then used in capture templates.")
9422 (defun org-add-link-type (type &optional follow export)
9423 "Add TYPE to the list of `org-link-types'.
9424 Re-compute all regular expressions depending on `org-link-types'
9426 FOLLOW and EXPORT are two functions.
9428 FOLLOW should take the link path as the single argument and do whatever
9429 is necessary to follow the link, for example find a file or display
9430 a mail message.
9432 EXPORT should format the link path for export to one of the export formats.
9433 It should be a function accepting three arguments:
9435 path the path of the link, the text after the prefix (like \"http:\")
9436 desc the description of the link, if any, or a description added by
9437 org-export-normalize-links if there is none
9438 format the export format, a symbol like `html' or `latex' or `ascii'..
9440 The function may use the FORMAT information to return different values
9441 depending on the format. The return value will be put literally into
9442 the exported file. If the return value is nil, this means Org should
9443 do what it normally does with links which do not have EXPORT defined.
9445 Org-mode has a built-in default for exporting links. If you are happy with
9446 this default, there is no need to define an export function for the link
9447 type. For a simple example of an export function, see `org-bbdb.el'."
9448 (add-to-list 'org-link-types type t)
9449 (org-make-link-regexps)
9450 (if (assoc type org-link-protocols)
9451 (setcdr (assoc type org-link-protocols) (list follow export))
9452 (push (list type follow export) org-link-protocols)))
9454 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9455 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9457 ;;;###autoload
9458 (defun org-store-link (arg)
9459 "\\<org-mode-map>Store an org-link to the current location.
9460 This link is added to `org-stored-links' and can later be inserted
9461 into an org-buffer with \\[org-insert-link].
9463 For some link types, a prefix arg is interpreted.
9464 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9465 For file links, arg negates `org-context-in-file-links'.
9467 A double prefix arg force skipping storing functions that are not
9468 part of Org's core.
9470 A triple prefix arg force storing a link for each line in the
9471 active region."
9472 (interactive "P")
9473 (org-load-modules-maybe)
9474 (if (and (equal arg '(64)) (org-region-active-p))
9475 (save-excursion
9476 (let ((end (region-end)))
9477 (goto-char (region-beginning))
9478 (set-mark (point))
9479 (while (< (point-at-eol) end)
9480 (move-end-of-line 1) (activate-mark)
9481 (let (current-prefix-arg)
9482 (call-interactively 'org-store-link))
9483 (move-beginning-of-line 2)
9484 (set-mark (point)))))
9485 (org-with-limited-levels
9486 (setq org-store-link-plist nil)
9487 (let (link cpltxt desc description search
9488 txt custom-id agenda-link sfuns sfunsn)
9489 (cond
9491 ;; Store a link using an external link type
9492 ((and (not (equal arg '(16)))
9493 (setq sfuns
9494 (delq
9495 nil (mapcar (lambda (f)
9496 (let (fs) (if (funcall f) (push f fs))))
9497 org-store-link-functions))
9498 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9499 (or (and (cdr sfuns)
9500 (funcall (intern
9501 (completing-read
9502 "Which function for creating the link? "
9503 sfunsn t (car sfunsn)))))
9504 (funcall (caar sfuns)))
9505 (setq link (plist-get org-store-link-plist :link)
9506 desc (or (plist-get org-store-link-plist
9507 :description) link))))
9509 ;; Store a link from a source code buffer
9510 ((org-src-edit-buffer-p)
9511 (let (label gc)
9512 (while (or (not label)
9513 (save-excursion
9514 (save-restriction
9515 (widen)
9516 (goto-char (point-min))
9517 (re-search-forward
9518 (regexp-quote (format org-coderef-label-format label))
9519 nil t))))
9520 (when label (message "Label exists already") (sit-for 2))
9521 (setq label (read-string "Code line label: " label)))
9522 (end-of-line 1)
9523 (setq link (format org-coderef-label-format label))
9524 (setq gc (- 79 (length link)))
9525 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9526 (insert link)
9527 (setq link (concat "(" label ")") desc nil)))
9529 ;; We are in the agenda, link to referenced location
9530 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9531 (let ((m (or (get-text-property (point) 'org-hd-marker)
9532 (get-text-property (point) 'org-marker))))
9533 (when m
9534 (org-with-point-at m
9535 (setq agenda-link
9536 (if (org-called-interactively-p 'any)
9537 (call-interactively 'org-store-link)
9538 (org-store-link nil)))))))
9540 ((eq major-mode 'calendar-mode)
9541 (let ((cd (calendar-cursor-to-date)))
9542 (setq link
9543 (format-time-string
9544 (car org-time-stamp-formats)
9545 (apply 'encode-time
9546 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9547 nil nil nil))))
9548 (org-store-link-props :type "calendar" :date cd)))
9550 ((eq major-mode 'help-mode)
9551 (setq link (concat "help:" (save-excursion
9552 (goto-char (point-min))
9553 (looking-at "^[^ ]+")
9554 (match-string 0))))
9555 (org-store-link-props :type "help"))
9557 ((eq major-mode 'w3-mode)
9558 (setq cpltxt (if (and (buffer-name)
9559 (not (string-match "Untitled" (buffer-name))))
9560 (buffer-name)
9561 (url-view-url t))
9562 link (url-view-url t))
9563 (org-store-link-props :type "w3" :url (url-view-url t)))
9565 ((eq major-mode 'image-mode)
9566 (setq cpltxt (concat "file:"
9567 (abbreviate-file-name buffer-file-name))
9568 link cpltxt)
9569 (org-store-link-props :type "image" :file buffer-file-name))
9571 ;; In dired, store a link to the file of the current line
9572 ((eq major-mode 'dired-mode)
9573 (let ((file (dired-get-filename nil t)))
9574 (setq file (if file
9575 (abbreviate-file-name
9576 (expand-file-name (dired-get-filename nil t)))
9577 ;; otherwise, no file so use current directory.
9578 default-directory))
9579 (setq cpltxt (concat "file:" file)
9580 link cpltxt)))
9582 ((setq search (run-hook-with-args-until-success
9583 'org-create-file-search-functions))
9584 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9585 "::" search))
9586 (setq cpltxt (or description link)))
9588 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9589 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9590 (cond
9591 ;; Store a link using the target at point
9592 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9593 (setq cpltxt
9594 (concat "file:"
9595 (abbreviate-file-name
9596 (buffer-file-name (buffer-base-buffer)))
9597 "::" (match-string 1))
9598 link cpltxt))
9599 ((and (featurep 'org-id)
9600 (or (eq org-id-link-to-org-use-id t)
9601 (and (org-called-interactively-p 'any)
9602 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9603 (and (eq org-id-link-to-org-use-id
9604 'create-if-interactive-and-no-custom-id)
9605 (not custom-id))))
9606 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9607 ;; Store a link using the ID at point
9608 (setq link (condition-case nil
9609 (prog1 (org-id-store-link)
9610 (setq desc (plist-get org-store-link-plist
9611 :description)))
9612 (error
9613 ;; Probably before first headline, link only to file
9614 (concat "file:"
9615 (abbreviate-file-name
9616 (buffer-file-name (buffer-base-buffer))))))))
9618 ;; Just link to current headline
9619 (setq cpltxt (concat "file:"
9620 (abbreviate-file-name
9621 (buffer-file-name (buffer-base-buffer)))))
9622 ;; Add a context search string
9623 (when (org-xor org-context-in-file-links arg)
9624 (let* ((ee (org-element-at-point))
9625 (et (org-element-type ee))
9626 (ev (plist-get (cadr ee) :value))
9627 (ek (plist-get (cadr ee) :key))
9628 (eok (and (stringp ek) (string-match "name" ek))))
9629 (setq txt (cond
9630 ((org-at-heading-p) nil)
9631 ((and (eq et 'keyword) eok) ev)
9632 ((org-region-active-p)
9633 (buffer-substring (region-beginning) (region-end)))))
9634 (when (or (null txt) (string-match "\\S-" txt))
9635 (setq cpltxt
9636 (concat cpltxt "::"
9637 (condition-case nil
9638 (org-make-org-heading-search-string txt)
9639 (error "")))
9640 desc (or (and (eq et 'keyword) eok ev)
9641 (nth 4 (ignore-errors (org-heading-components)))
9642 "NONE")))))
9643 (if (string-match "::\\'" cpltxt)
9644 (setq cpltxt (substring cpltxt 0 -2)))
9645 (setq link cpltxt))))
9647 ((buffer-file-name (buffer-base-buffer))
9648 ;; Just link to this file here.
9649 (setq cpltxt (concat "file:"
9650 (abbreviate-file-name
9651 (buffer-file-name (buffer-base-buffer)))))
9652 ;; Add a context string.
9653 (when (org-xor org-context-in-file-links arg)
9654 (setq txt (if (org-region-active-p)
9655 (buffer-substring (region-beginning) (region-end))
9656 (buffer-substring (point-at-bol) (point-at-eol))))
9657 ;; Only use search option if there is some text.
9658 (when (string-match "\\S-" txt)
9659 (setq cpltxt
9660 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9661 desc "NONE")))
9662 (setq link cpltxt))
9664 ((org-called-interactively-p 'interactive)
9665 (user-error "No method for storing a link from this buffer"))
9667 (t (setq link nil)))
9669 ;; We're done setting link and desc, clean up
9670 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9671 (setq link (or link cpltxt)
9672 desc (or desc cpltxt))
9673 (cond ((equal desc "NONE") (setq desc nil))
9674 ((string-match org-bracket-link-analytic-regexp desc)
9675 (let ((d0 (match-string 3 desc))
9676 (p0 (match-string 5 desc)))
9677 (setq desc
9678 (replace-regexp-in-string
9679 org-bracket-link-regexp
9680 (concat (or p0 d0)
9681 (if (equal (length (match-string 0 desc))
9682 (length desc)) "*" "")) desc)))))
9684 ;; Return the link
9685 (if (not (and (or (org-called-interactively-p 'any)
9686 executing-kbd-macro) link))
9687 (or agenda-link (and link (org-make-link-string link desc)))
9688 (push (list link desc) org-stored-links)
9689 (message "Stored: %s" (or desc link))
9690 (when custom-id
9691 (setq link (concat "file:" (abbreviate-file-name
9692 (buffer-file-name)) "::#" custom-id)))
9693 (push (list link desc) org-stored-links))))))
9695 (defun org-store-link-props (&rest plist)
9696 "Store link properties, extract names and addresses."
9697 (let (x adr)
9698 (when (setq x (plist-get plist :from))
9699 (setq adr (mail-extract-address-components x))
9700 (setq plist (plist-put plist :fromname (car adr)))
9701 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9702 (when (setq x (plist-get plist :to))
9703 (setq adr (mail-extract-address-components x))
9704 (setq plist (plist-put plist :toname (car adr)))
9705 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9706 (let ((from (plist-get plist :from))
9707 (to (plist-get plist :to)))
9708 (when (and from to org-from-is-user-regexp)
9709 (setq plist
9710 (plist-put plist :fromto
9711 (if (string-match org-from-is-user-regexp from)
9712 (concat "to %t")
9713 (concat "from %f"))))))
9714 (setq org-store-link-plist plist))
9716 (defun org-add-link-props (&rest plist)
9717 "Add these properties to the link property list."
9718 (let (key value)
9719 (while plist
9720 (setq key (pop plist) value (pop plist))
9721 (setq org-store-link-plist
9722 (plist-put org-store-link-plist key value)))))
9724 (defun org-email-link-description (&optional fmt)
9725 "Return the description part of an email link.
9726 This takes information from `org-store-link-plist' and formats it
9727 according to FMT (default from `org-email-link-description-format')."
9728 (setq fmt (or fmt org-email-link-description-format))
9729 (let* ((p org-store-link-plist)
9730 (to (plist-get p :toaddress))
9731 (from (plist-get p :fromaddress))
9732 (table
9733 (list
9734 (cons "%c" (plist-get p :fromto))
9735 (cons "%F" (plist-get p :from))
9736 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9737 (cons "%T" (plist-get p :to))
9738 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9739 (cons "%s" (plist-get p :subject))
9740 (cons "%d" (plist-get p :date))
9741 (cons "%m" (plist-get p :message-id)))))
9742 (when (string-match "%c" fmt)
9743 ;; Check if the user wrote this message
9744 (if (and org-from-is-user-regexp from to
9745 (save-match-data (string-match org-from-is-user-regexp from)))
9746 (setq fmt (replace-match "to %t" t t fmt))
9747 (setq fmt (replace-match "from %f" t t fmt))))
9748 (org-replace-escapes fmt table)))
9750 (defun org-make-org-heading-search-string (&optional string)
9751 "Make search string for the current headline or STRING."
9752 (let ((s (or string
9753 (and (derived-mode-p 'org-mode)
9754 (save-excursion
9755 (org-back-to-heading t)
9756 (org-element-property :raw-value (org-element-at-point))))))
9757 (lines org-context-in-file-links))
9758 (or string (setq s (concat "*" s))) ; Add * for headlines
9759 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9760 (when (and string (integerp lines) (> lines 0))
9761 (let ((slines (org-split-string s "\n")))
9762 (when (< lines (length slines))
9763 (setq s (mapconcat
9764 'identity
9765 (reverse (nthcdr (- (length slines) lines)
9766 (reverse slines))) "\n")))))
9767 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9769 (defun org-make-link-string (link &optional description)
9770 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9771 (unless (string-match "\\S-" link)
9772 (error "Empty link"))
9773 (when (and description
9774 (stringp description)
9775 (not (string-match "\\S-" description)))
9776 (setq description nil))
9777 (when (stringp description)
9778 ;; Remove brackets from the description, they are fatal.
9779 (while (string-match "\\[" description)
9780 (setq description (replace-match "{" t t description)))
9781 (while (string-match "\\]" description)
9782 (setq description (replace-match "}" t t description))))
9783 (when (equal link description)
9784 ;; No description needed, it is identical
9785 (setq description nil))
9786 (when (and (not description)
9787 (not (string-match (org-image-file-name-regexp) link))
9788 (not (equal link (org-link-escape link))))
9789 (setq description (org-extract-attributes link)))
9790 (setq link
9791 (cond ((string-match (org-image-file-name-regexp) link) link)
9792 ((string-match org-link-types-re link)
9793 (concat (match-string 1 link)
9794 (org-link-escape (substring link (match-end 1)))))
9795 (t (org-link-escape link))))
9796 (concat "[[" link "]"
9797 (if description (concat "[" description "]") "")
9798 "]"))
9800 (defconst org-link-escape-chars
9801 ;;%20 %2B %3B %3D %5B %5D
9802 '(?\ ?\+ ?\; ?\= ?\[ ?\])
9803 "List of characters that should be escaped in link.
9804 This is the list that is used for internal purposes.")
9806 (defconst org-link-escape-chars-browser
9807 ;;%20 %22
9808 '(?\ ?\")
9809 "List of escapes for characters that are problematic in links.
9810 This is the list that is used before handing over to the browser.")
9812 (defun org-link-escape (text &optional table merge)
9813 "Return percent escaped representation of TEXT.
9814 TEXT is a string with the text to escape.
9815 Optional argument TABLE is a list with characters that should be
9816 escaped. When nil, `org-link-escape-chars' is used.
9817 If optional argument MERGE is set, merge TABLE into
9818 `org-link-escape-chars'."
9819 (cond
9820 ((and table merge)
9821 (mapc (lambda (defchr)
9822 (unless (member defchr table)
9823 (setq table (cons defchr table)))) org-link-escape-chars))
9824 ((null table)
9825 (setq table org-link-escape-chars)))
9826 (mapconcat
9827 (lambda (char)
9828 (if (or (member char table)
9829 (and (or (< char 32) (= char ?\%) (> char 126))
9830 org-url-hexify-p))
9831 (mapconcat (lambda (sequence-element)
9832 (format "%%%.2X" sequence-element))
9833 (or (encode-coding-char char 'utf-8)
9834 (error "Unable to percent escape character: %s"
9835 (char-to-string char))) "")
9836 (char-to-string char))) text ""))
9838 (defun org-link-escape-browser (text)
9839 (if (org-string-match-p
9840 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
9841 text)
9842 (org-link-escape text org-link-escape-chars-browser)
9843 text))
9845 (defun org-link-unescape (str)
9846 "Unhex hexified Unicode strings as returned from the JavaScript function
9847 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9848 (unless (and (null str) (string= "" str))
9849 (let ((pos 0) (case-fold-search t) unhexed)
9850 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
9851 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9852 (setq str (replace-match unhexed t t str))
9853 (setq pos (+ pos (length unhexed))))))
9854 str)
9856 (defun org-link-unescape-compound (hex)
9857 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9858 Note: this function also decodes single byte encodings like
9859 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9860 (save-match-data
9861 (let* ((bytes (cdr (split-string hex "%")))
9862 (ret "")
9863 (eat 0)
9864 (sum 0))
9865 (while bytes
9866 (let* ((val (string-to-number (pop bytes) 16))
9867 (shift-xor
9868 (if (= 0 eat)
9869 (cond
9870 ((>= val 252) (cons 6 252))
9871 ((>= val 248) (cons 5 248))
9872 ((>= val 240) (cons 4 240))
9873 ((>= val 224) (cons 3 224))
9874 ((>= val 192) (cons 2 192))
9875 (t (cons 0 0)))
9876 (cons 6 128))))
9877 (if (>= val 192) (setq eat (car shift-xor)))
9878 (setq val (logxor val (cdr shift-xor)))
9879 (setq sum (+ (lsh sum (car shift-xor)) val))
9880 (if (> eat 0) (setq eat (- eat 1)))
9881 (cond
9882 ((= 0 eat) ;multi byte
9883 (setq ret (concat ret (org-char-to-string sum)))
9884 (setq sum 0))
9885 ((not bytes) ; single byte(s)
9886 (setq ret (org-link-unescape-single-byte-sequence hex))))
9887 )) ;; end (while bytes
9888 ret )))
9890 (defun org-link-unescape-single-byte-sequence (hex)
9891 "Unhexify hex-encoded single byte character sequences."
9892 (mapconcat (lambda (byte)
9893 (char-to-string (string-to-number byte 16)))
9894 (cdr (split-string hex "%")) ""))
9896 (defun org-xor (a b)
9897 "Exclusive or."
9898 (if a (not b) b))
9900 (defun org-fixup-message-id-for-http (s)
9901 "Replace special characters in a message id, so it can be used in an http query."
9902 (when (string-match "%" s)
9903 (setq s (mapconcat (lambda (c)
9904 (if (eq c ?%)
9905 "%25"
9906 (char-to-string c)))
9907 s "")))
9908 (while (string-match "<" s)
9909 (setq s (replace-match "%3C" t t s)))
9910 (while (string-match ">" s)
9911 (setq s (replace-match "%3E" t t s)))
9912 (while (string-match "@" s)
9913 (setq s (replace-match "%40" t t s)))
9916 (defun org-link-prettify (link)
9917 "Return a human-readable representation of LINK.
9918 The car of LINK must be a raw link the cdr of LINK must be either
9919 a link description or nil."
9920 (let ((desc (or (cadr link) "<no description>")))
9921 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9922 "<" (car link) ">")))
9924 ;;;###autoload
9925 (defun org-insert-link-global ()
9926 "Insert a link like Org-mode does.
9927 This command can be called in any mode to insert a link in Org-mode syntax."
9928 (interactive)
9929 (org-load-modules-maybe)
9930 (org-run-like-in-org-mode 'org-insert-link))
9932 (defun org-insert-all-links (&optional keep)
9933 "Insert all links in `org-stored-links'."
9934 (interactive "P")
9935 (let ((links (copy-sequence org-stored-links)) l)
9936 (while (setq l (if keep (pop links) (pop org-stored-links)))
9937 (insert "- ")
9938 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9939 (insert "\n"))))
9941 (defun org-link-fontify-links-to-this-file ()
9942 "Fontify links to the current file in `org-stored-links'."
9943 (let ((f (buffer-file-name)) a b)
9944 (setq a (mapcar (lambda(l)
9945 (let ((ll (car l)))
9946 (when (and (string-match "^file:\\(.+\\)::" ll)
9947 (equal f (expand-file-name (match-string 1 ll))))
9948 ll)))
9949 org-stored-links))
9950 (when (featurep 'org-id)
9951 (setq b (mapcar (lambda(l)
9952 (let ((ll (car l)))
9953 (when (and (string-match "^id:\\(.+\\)$" ll)
9954 (equal f (expand-file-name
9955 (or (org-id-find-id-file
9956 (match-string 1 ll)) ""))))
9957 ll)))
9958 org-stored-links)))
9959 (mapcar (lambda(l)
9960 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9961 (delq nil (append a b)))))
9963 (defvar org-link-links-in-this-file nil)
9964 (defun org-insert-link (&optional complete-file link-location default-description)
9965 "Insert a link. At the prompt, enter the link.
9967 Completion can be used to insert any of the link protocol prefixes like
9968 http or ftp in use.
9970 The history can be used to select a link previously stored with
9971 `org-store-link'. When the empty string is entered (i.e. if you just
9972 press RET at the prompt), the link defaults to the most recently
9973 stored link. As SPC triggers completion in the minibuffer, you need to
9974 use M-SPC or C-q SPC to force the insertion of a space character.
9976 You will also be prompted for a description, and if one is given, it will
9977 be displayed in the buffer instead of the link.
9979 If there is already a link at point, this command will allow you to edit link
9980 and description parts.
9982 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
9983 be selected using completion. The path to the file will be relative to the
9984 current directory if the file is in the current directory or a subdirectory.
9985 Otherwise, the link will be the absolute path as completed in the minibuffer
9986 \(i.e. normally ~/path/to/file). You can configure this behavior using the
9987 option `org-link-file-path-type'.
9989 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
9990 the current directory or below.
9992 With three \\[universal-argument] prefixes, negate the meaning of
9993 `org-keep-stored-link-after-insertion'.
9995 If `org-make-link-description-function' is non-nil, this function will be
9996 called with the link target, and the result will be the default
9997 link description.
9999 If the LINK-LOCATION parameter is non-nil, this value will be
10000 used as the link location instead of reading one interactively.
10002 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10003 be used as the default description."
10004 (interactive "P")
10005 (let* ((wcf (current-window-configuration))
10006 (origbuf (current-buffer))
10007 (region (if (org-region-active-p)
10008 (buffer-substring (region-beginning) (region-end))))
10009 (remove (and region (list (region-beginning) (region-end))))
10010 (desc region)
10011 tmphist ; byte-compile incorrectly complains about this
10012 (link link-location)
10013 (abbrevs org-link-abbrev-alist-local)
10014 entry file all-prefixes auto-desc)
10015 (cond
10016 (link-location) ; specified by arg, just use it.
10017 ((org-in-regexp org-bracket-link-regexp 1)
10018 ;; We do have a link at point, and we are going to edit it.
10019 (setq remove (list (match-beginning 0) (match-end 0)))
10020 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10021 (setq link (read-string "Link: "
10022 (org-link-unescape
10023 (org-match-string-no-properties 1)))))
10024 ((or (org-in-regexp org-angle-link-re)
10025 (org-in-regexp org-plain-link-re))
10026 ;; Convert to bracket link
10027 (setq remove (list (match-beginning 0) (match-end 0))
10028 link (read-string "Link: "
10029 (org-remove-angle-brackets (match-string 0)))))
10030 ((member complete-file '((4) (16)))
10031 ;; Completing read for file names.
10032 (setq link (org-file-complete-link complete-file)))
10034 ;; Read link, with completion for stored links.
10035 (org-link-fontify-links-to-this-file)
10036 (org-switch-to-buffer-other-window "*Org Links*")
10037 (with-current-buffer "*Org Links*"
10038 (erase-buffer)
10039 (insert "Insert a link.
10040 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10041 (when org-stored-links
10042 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10043 (insert (mapconcat 'org-link-prettify
10044 (reverse org-stored-links) "\n")))
10045 (goto-char (point-min)))
10046 (let ((cw (selected-window)))
10047 (select-window (get-buffer-window "*Org Links*" 'visible))
10048 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10049 (unless (pos-visible-in-window-p (point-max))
10050 (org-fit-window-to-buffer))
10051 (and (window-live-p cw) (select-window cw)))
10052 ;; Fake a link history, containing the stored links.
10053 (setq tmphist (append (mapcar 'car org-stored-links)
10054 org-insert-link-history))
10055 (setq all-prefixes (append (mapcar 'car abbrevs)
10056 (mapcar 'car org-link-abbrev-alist)
10057 org-link-types))
10058 (unwind-protect
10059 (progn
10060 (setq link
10061 (org-completing-read
10062 "Link: "
10063 (append
10064 (mapcar (lambda (x) (concat x ":"))
10065 all-prefixes)
10066 (mapcar 'car org-stored-links))
10067 nil nil nil
10068 'tmphist
10069 (caar org-stored-links)))
10070 (if (not (string-match "\\S-" link))
10071 (user-error "No link selected"))
10072 (mapc (lambda(l)
10073 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10074 org-stored-links)
10075 (if (or (member link all-prefixes)
10076 (and (equal ":" (substring link -1))
10077 (member (substring link 0 -1) all-prefixes)
10078 (setq link (substring link 0 -1))))
10079 (setq link (with-current-buffer origbuf
10080 (org-link-try-special-completion link)))))
10081 (set-window-configuration wcf)
10082 (kill-buffer "*Org Links*"))
10083 (setq entry (assoc link org-stored-links))
10084 (or entry (push link org-insert-link-history))
10085 (setq desc (or desc (nth 1 entry)))))
10087 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10088 (not org-keep-stored-link-after-insertion))
10089 (setq org-stored-links (delq (assoc link org-stored-links)
10090 org-stored-links)))
10092 (if (and (string-match org-plain-link-re link)
10093 (not (string-match org-ts-regexp link)))
10094 ;; URL-like link, normalize the use of angular brackets.
10095 (setq link (org-remove-angle-brackets link)))
10097 ;; Check if we are linking to the current file with a search
10098 ;; option If yes, simplify the link by using only the search
10099 ;; option.
10100 (when (and buffer-file-name
10101 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10102 (let* ((path (match-string 1 link))
10103 (case-fold-search nil)
10104 (search (match-string 2 link)))
10105 (save-match-data
10106 (if (equal (file-truename buffer-file-name) (file-truename path))
10107 ;; We are linking to this same file, with a search option
10108 (setq link search)))))
10110 ;; Check if we can/should use a relative path. If yes, simplify the link
10111 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10112 (let* ((type (match-string 1 link))
10113 (path (match-string 2 link))
10114 (origpath path)
10115 (case-fold-search nil))
10116 (cond
10117 ((or (eq org-link-file-path-type 'absolute)
10118 (equal complete-file '(16)))
10119 (setq path (abbreviate-file-name (expand-file-name path))))
10120 ((eq org-link-file-path-type 'noabbrev)
10121 (setq path (expand-file-name path)))
10122 ((eq org-link-file-path-type 'relative)
10123 (setq path (file-relative-name path)))
10125 (save-match-data
10126 (if (string-match (concat "^" (regexp-quote
10127 (expand-file-name
10128 (file-name-as-directory
10129 default-directory))))
10130 (expand-file-name path))
10131 ;; We are linking a file with relative path name.
10132 (setq path (substring (expand-file-name path)
10133 (match-end 0)))
10134 (setq path (abbreviate-file-name (expand-file-name path)))))))
10135 (setq link (concat type path))
10136 (if (equal desc origpath)
10137 (setq desc path))))
10139 (if org-make-link-description-function
10140 (setq desc
10141 (or (condition-case nil
10142 (funcall org-make-link-description-function link desc)
10143 (error (progn (message "Can't get link description from `%s'"
10144 (symbol-name org-make-link-description-function))
10145 (sit-for 2) nil)))
10146 (read-string "Description: " default-description)))
10147 (if default-description (setq desc default-description)
10148 (setq desc (or (and auto-desc desc)
10149 (read-string "Description: " desc)))))
10151 (unless (string-match "\\S-" desc) (setq desc nil))
10152 (if remove (apply 'delete-region remove))
10153 (insert (org-make-link-string link desc))))
10155 (defun org-link-try-special-completion (type)
10156 "If there is completion support for link type TYPE, offer it."
10157 (let ((fun (intern (concat "org-" type "-complete-link"))))
10158 (if (functionp fun)
10159 (funcall fun)
10160 (read-string "Link (no completion support): " (concat type ":")))))
10162 (defun org-file-complete-link (&optional arg)
10163 "Create a file link using completion."
10164 (let (file link)
10165 (setq file (org-iread-file-name "File: "))
10166 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10167 (pwd1 (file-name-as-directory (abbreviate-file-name
10168 (expand-file-name ".")))))
10169 (cond
10170 ((equal arg '(16))
10171 (setq link (concat
10172 "file:"
10173 (abbreviate-file-name (expand-file-name file)))))
10174 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10175 (setq link (concat "file:" (match-string 1 file))))
10176 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10177 (expand-file-name file))
10178 (setq link (concat
10179 "file:" (match-string 1 (expand-file-name file)))))
10180 (t (setq link (concat "file:" file)))))
10181 link))
10183 (defun org-iread-file-name (&rest args)
10184 "Read-file-name using `ido-mode' speedup if available.
10185 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10186 See `read-file-name' for a description of parameters."
10187 (org-without-partial-completion
10188 (if (and org-completion-use-ido
10189 (fboundp 'ido-read-file-name)
10190 (boundp 'ido-mode) ido-mode
10191 (listp (second args)))
10192 (let ((ido-enter-matching-directory nil))
10193 (apply 'ido-read-file-name args))
10194 (apply 'read-file-name args))))
10196 (defun org-completing-read (&rest args)
10197 "Completing-read with SPACE being a normal character."
10198 (let ((enable-recursive-minibuffers t)
10199 (minibuffer-local-completion-map
10200 (copy-keymap minibuffer-local-completion-map)))
10201 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10202 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10203 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10204 (apply 'org-icompleting-read args)))
10206 (defun org-completing-read-no-i (&rest args)
10207 (let (org-completion-use-ido org-completion-use-iswitchb)
10208 (apply 'org-completing-read args)))
10210 (defun org-iswitchb-completing-read (prompt choices &rest args)
10211 "Use iswitch as a completing-read replacement to choose from choices.
10212 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10213 from."
10214 (let* ((iswitchb-use-virtual-buffers nil)
10215 (iswitchb-make-buflist-hook
10216 (lambda ()
10217 (setq iswitchb-temp-buflist choices))))
10218 (iswitchb-read-buffer prompt)))
10220 (defun org-icompleting-read (&rest args)
10221 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10222 (org-without-partial-completion
10223 (if (and org-completion-use-ido
10224 (fboundp 'ido-completing-read)
10225 (boundp 'ido-mode) ido-mode
10226 (listp (second args)))
10227 (let ((ido-enter-matching-directory nil))
10228 (apply 'ido-completing-read (concat (car args))
10229 (if (consp (car (nth 1 args)))
10230 (mapcar 'car (nth 1 args))
10231 (nth 1 args))
10232 (cddr args)))
10233 (if (and org-completion-use-iswitchb
10234 (boundp 'iswitchb-mode) iswitchb-mode
10235 (listp (second args)))
10236 (apply 'org-iswitchb-completing-read (concat (car args))
10237 (if (consp (car (nth 1 args)))
10238 (mapcar 'car (nth 1 args))
10239 (nth 1 args))
10240 (cddr args))
10241 (apply 'completing-read args)))))
10243 (defun org-extract-attributes (s)
10244 "Extract the attributes cookie from a string and set as text property."
10245 (let (a attr (start 0) key value)
10246 (save-match-data
10247 (when (string-match "{{\\([^}]+\\)}}$" s)
10248 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10249 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10250 (setq key (match-string 1 a) value (match-string 2 a)
10251 start (match-end 0)
10252 attr (plist-put attr (intern key) value))))
10253 (org-add-props s nil 'org-attr attr))
10256 ;;; Opening/following a link
10258 (defvar org-link-search-failed nil)
10260 (defvar org-open-link-functions nil
10261 "Hook for functions finding a plain text link.
10262 These functions must take a single argument, the link content.
10263 They will be called for links that look like [[link text][description]]
10264 when LINK TEXT does not have a protocol like \"http:\" and does not look
10265 like a filename (e.g. \"./blue.png\").
10267 These functions will be called *before* Org attempts to resolve the
10268 link by doing text searches in the current buffer - so if you want a
10269 link \"[[target]]\" to still find \"<<target>>\", your function should
10270 handle this as a special case.
10272 When the function does handle the link, it must return a non-nil value.
10273 If it decides that it is not responsible for this link, it must return
10274 nil to indicate that that Org-mode can continue with other options
10275 like exact and fuzzy text search.")
10277 (defun org-next-link (&optional search-backward)
10278 "Move forward to the next link.
10279 If the link is in hidden text, expose it."
10280 (interactive "P")
10281 (when (and org-link-search-failed (eq this-command last-command))
10282 (goto-char (point-min))
10283 (message "Link search wrapped back to beginning of buffer"))
10284 (setq org-link-search-failed nil)
10285 (let* ((pos (point))
10286 (ct (org-context))
10287 (a (assoc :link ct))
10288 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10289 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10290 ((looking-at org-any-link-re)
10291 ;; Don't stay stuck at link without an org-link face
10292 (forward-char (if search-backward -1 1))))
10293 (if (funcall srch-fun org-any-link-re nil t)
10294 (progn
10295 (goto-char (match-beginning 0))
10296 (if (outline-invisible-p) (org-show-context)))
10297 (goto-char pos)
10298 (setq org-link-search-failed t)
10299 (message "No further link found"))))
10301 (defun org-previous-link ()
10302 "Move backward to the previous link.
10303 If the link is in hidden text, expose it."
10304 (interactive)
10305 (funcall 'org-next-link t))
10307 (defun org-translate-link (s)
10308 "Translate a link string if a translation function has been defined."
10309 (if (and org-link-translation-function
10310 (fboundp org-link-translation-function)
10311 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10312 (progn
10313 (setq s (funcall org-link-translation-function
10314 (match-string 1 s) (match-string 2 s)))
10315 (concat (car s) ":" (cdr s)))
10318 (defun org-translate-link-from-planner (type path)
10319 "Translate a link from Emacs Planner syntax so that Org can follow it.
10320 This is still an experimental function, your mileage may vary."
10321 (cond
10322 ((member type '("http" "https" "news" "ftp"))
10323 ;; standard Internet links are the same.
10324 nil)
10325 ((and (equal type "irc") (string-match "^//" path))
10326 ;; Planner has two / at the beginning of an irc link, we have 1.
10327 ;; We should have zero, actually....
10328 (setq path (substring path 1)))
10329 ((and (equal type "lisp") (string-match "^/" path))
10330 ;; Planner has a slash, we do not.
10331 (setq type "elisp" path (substring path 1)))
10332 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10333 ;; A typical message link. Planner has the id after the final slash,
10334 ;; we separate it with a hash mark
10335 (setq path (concat (match-string 1 path) "#"
10336 (org-remove-angle-brackets (match-string 2 path))))))
10337 (cons type path))
10339 (defun org-find-file-at-mouse (ev)
10340 "Open file link or URL at mouse."
10341 (interactive "e")
10342 (mouse-set-point ev)
10343 (org-open-at-point 'in-emacs))
10345 (defun org-open-at-mouse (ev)
10346 "Open file link or URL at mouse.
10347 See the docstring of `org-open-file' for details."
10348 (interactive "e")
10349 (mouse-set-point ev)
10350 (if (eq major-mode 'org-agenda-mode)
10351 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10352 (org-open-at-point))
10354 (defvar org-window-config-before-follow-link nil
10355 "The window configuration before following a link.
10356 This is saved in case the need arises to restore it.")
10358 (defvar org-open-link-marker (make-marker)
10359 "Marker pointing to the location where `org-open-at-point; was called.")
10361 ;;;###autoload
10362 (defun org-open-at-point-global ()
10363 "Follow a link like Org-mode does.
10364 This command can be called in any mode to follow a link that has
10365 Org-mode syntax."
10366 (interactive)
10367 (org-run-like-in-org-mode 'org-open-at-point))
10369 ;;;###autoload
10370 (defun org-open-link-from-string (s &optional arg reference-buffer)
10371 "Open a link in the string S, as if it was in Org-mode."
10372 (interactive "sLink: \nP")
10373 (let ((reference-buffer (or reference-buffer (current-buffer))))
10374 (with-temp-buffer
10375 (let ((org-inhibit-startup (not reference-buffer)))
10376 (org-mode)
10377 (insert s)
10378 (goto-char (point-min))
10379 (when reference-buffer
10380 (setq org-link-abbrev-alist-local
10381 (with-current-buffer reference-buffer
10382 org-link-abbrev-alist-local)))
10383 (org-open-at-point arg reference-buffer)))))
10385 (defvar org-open-at-point-functions nil
10386 "Hook that is run when following a link at point.
10388 Functions in this hook must return t if they identify and follow
10389 a link at point. If they don't find anything interesting at point,
10390 they must return nil.")
10392 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10393 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10394 (defun org-open-at-point (&optional arg reference-buffer)
10395 "Open link at or after point.
10396 If there is no link at point, this function will search forward up to
10397 the end of the current line.
10398 Normally, files will be opened by an appropriate application. If the
10399 optional prefix argument ARG is non-nil, Emacs will visit the file.
10400 With a double prefix argument, try to open outside of Emacs, in the
10401 application the system uses for this file type."
10402 (interactive "P")
10403 ;; if in a code block, then open the block's results
10404 (unless (call-interactively #'org-babel-open-src-block-result)
10405 (org-load-modules-maybe)
10406 (move-marker org-open-link-marker (point))
10407 (setq org-window-config-before-follow-link (current-window-configuration))
10408 (org-remove-occur-highlights nil nil t)
10409 (cond
10410 ((and (org-at-heading-p)
10411 (not (org-at-timestamp-p t))
10412 (not (org-in-regexp
10413 (concat org-plain-link-re "\\|"
10414 org-bracket-link-regexp "\\|"
10415 org-angle-link-re "\\|"
10416 "[ \t]:[^ \t\n]+:[ \t]*$")))
10417 (not (get-text-property (point) 'org-linked-text)))
10418 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10419 (lk0 (car lkall))
10420 (lk (if (stringp lk0) (list lk0) lk0))
10421 (lkend (cdr lkall)))
10422 (mapcar (lambda(l)
10423 (search-forward l nil lkend)
10424 (goto-char (match-beginning 0))
10425 (org-open-at-point))
10426 lk))
10427 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10428 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10429 ((and (org-at-timestamp-p t)
10430 (not (org-in-regexp org-bracket-link-regexp)))
10431 (org-follow-timestamp-link))
10432 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10433 (not (org-in-regexp org-any-link-re)))
10434 (org-footnote-action))
10436 (let (type path link line search (pos (point)))
10437 (catch 'match
10438 (save-excursion
10439 (skip-chars-forward "^]\n\r")
10440 (when (org-in-regexp org-bracket-link-regexp 1)
10441 (setq link (org-extract-attributes
10442 (org-link-unescape (org-match-string-no-properties 1))))
10443 (while (string-match " *\n *" link)
10444 (setq link (replace-match " " t t link)))
10445 (setq link (org-link-expand-abbrev link))
10446 (cond
10447 ((or (file-name-absolute-p link)
10448 (string-match "^\\.\\.?/" link))
10449 (setq type "file" path link))
10450 ((string-match org-link-re-with-space3 link)
10451 (setq type (match-string 1 link) path (match-string 2 link)))
10452 ((string-match "^help:+\\(.+\\)" link)
10453 (setq type "help" path (match-string 1 link)))
10454 (t (setq type "thisfile" path link)))
10455 (throw 'match t)))
10457 (when (get-text-property (point) 'org-linked-text)
10458 (setq type "thisfile"
10459 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10460 (1+ (point)) (point))
10461 path (buffer-substring
10462 (or (previous-single-property-change pos 'org-linked-text)
10463 (point-min))
10464 (or (next-single-property-change pos 'org-linked-text)
10465 (point-max)))
10466 ;; Ensure we will search for a <<<radio>>> link, not
10467 ;; a simple reference like <<ref>>
10468 path (concat "<" path))
10469 (throw 'match t))
10471 (save-excursion
10472 (when (or (org-in-regexp org-angle-link-re)
10473 (let ((match (org-in-regexp org-plain-link-re)))
10474 ;; Check a plain link is not within a bracket link
10475 (and match
10476 (save-excursion
10477 (progn
10478 (goto-char (car match))
10479 (not (org-in-regexp org-bracket-link-regexp))))))
10480 (let ((line_ending (save-excursion (end-of-line) (point))))
10481 ;; We are in a line before a plain or bracket link
10482 (or (re-search-forward org-plain-link-re line_ending t)
10483 (re-search-forward org-bracket-link-regexp line_ending t))))
10484 (setq type (match-string 1)
10485 path (org-link-unescape (match-string 2)))
10486 (throw 'match t)))
10487 (save-excursion
10488 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
10489 (setq type "tags"
10490 path (match-string 1))
10491 (while (string-match ":" path)
10492 (setq path (replace-match "+" t t path)))
10493 (throw 'match t)))
10494 (when (org-in-regexp "<\\([^><\n]+\\)>")
10495 (setq type "tree-match"
10496 path (match-string 1))
10497 (throw 'match t)))
10498 (unless path
10499 (user-error "No link found"))
10501 ;; switch back to reference buffer
10502 ;; needed when if called in a temporary buffer through
10503 ;; org-open-link-from-string
10504 (with-current-buffer (or reference-buffer (current-buffer))
10506 ;; Remove any trailing spaces in path
10507 (if (string-match " +\\'" path)
10508 (setq path (replace-match "" t t path)))
10509 (if (and org-link-translation-function
10510 (fboundp org-link-translation-function))
10511 ;; Check if we need to translate the link
10512 (let ((tmp (funcall org-link-translation-function type path)))
10513 (setq type (car tmp) path (cdr tmp))))
10515 (cond
10517 ((assoc type org-link-protocols)
10518 (funcall (nth 1 (assoc type org-link-protocols)) path))
10520 ((equal type "help")
10521 (let ((f-or-v (intern path)))
10522 (cond ((fboundp f-or-v)
10523 (describe-function f-or-v))
10524 ((boundp f-or-v)
10525 (describe-variable f-or-v))
10526 (t (error "Not a known function or variable")))))
10528 ((equal type "mailto")
10529 (let ((cmd (car org-link-mailto-program))
10530 (args (cdr org-link-mailto-program)) args1
10531 (address path) (subject "") a)
10532 (if (string-match "\\(.*\\)::\\(.*\\)" path)
10533 (setq address (match-string 1 path)
10534 subject (org-link-escape (match-string 2 path))))
10535 (while args
10536 (cond
10537 ((not (stringp (car args))) (push (pop args) args1))
10538 (t (setq a (pop args))
10539 (if (string-match "%a" a)
10540 (setq a (replace-match address t t a)))
10541 (if (string-match "%s" a)
10542 (setq a (replace-match subject t t a)))
10543 (push a args1))))
10544 (apply cmd (nreverse args1))))
10546 ((member type '("http" "https" "ftp" "news"))
10547 ;; In the example of the http Org link
10548 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10549 ;; to open a browser with +subject:"Release 8.2" in the
10550 ;; query field the variable `path' contains
10551 ;; [...]=%2Bsubject:"Release+8.2", `url-encode-url'
10552 ;; converts correct to [...]=%2Bsubject:%22Release+8.2%22
10553 ;; and `org-link-escape-browser' converts wrong to
10554 ;; [...]=%252Bsubject:%22Release+8.2%22.
10556 ;; `url-encode-url' is available since Emacs 24.3.1 and
10557 ;; `org-link-escape-browser' can be removed altogether
10558 ;; once Org drops support for Emacs 24.1 and 24.2.
10559 (browse-url (funcall (if (fboundp 'url-encode-url)
10560 #'url-encode-url
10561 #'org-link-escape-browser)
10562 (concat type ":" path))))
10564 ((string= type "doi")
10565 ;; See comments for type http above
10566 (browse-url (funcall (if (fboundp 'url-encode-url)
10567 #'url-encode-url
10568 #'org-link-escape-browser)
10569 (concat org-doi-server-url path))))
10571 ((member type '("message"))
10572 (browse-url (concat type ":" path)))
10574 ((string= type "tags")
10575 (org-tags-view arg path))
10577 ((string= type "tree-match")
10578 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
10580 ((string= type "file")
10581 (if (string-match "::\\([0-9]+\\)\\'" path)
10582 (setq line (string-to-number (match-string 1 path))
10583 path (substring path 0 (match-beginning 0)))
10584 (if (string-match "::\\(.+\\)\\'" path)
10585 (setq search (match-string 1 path)
10586 path (substring path 0 (match-beginning 0)))))
10587 (if (string-match "[*?{]" (file-name-nondirectory path))
10588 (dired path)
10589 (org-open-file path arg line search)))
10591 ((string= type "shell")
10592 (let ((buf (generate-new-buffer "*Org Shell Output"))
10593 (cmd path))
10594 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10595 (string-match org-confirm-shell-link-not-regexp cmd))
10596 (not org-confirm-shell-link-function)
10597 (funcall org-confirm-shell-link-function
10598 (format "Execute \"%s\" in shell? "
10599 (org-add-props cmd nil
10600 'face 'org-warning))))
10601 (progn
10602 (message "Executing %s" cmd)
10603 (shell-command cmd buf)
10604 (if (featurep 'midnight)
10605 (setq clean-buffer-list-kill-buffer-names
10606 (cons buf clean-buffer-list-kill-buffer-names))))
10607 (error "Abort"))))
10609 ((string= type "elisp")
10610 (let ((cmd path))
10611 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10612 (string-match org-confirm-elisp-link-not-regexp cmd))
10613 (not org-confirm-elisp-link-function)
10614 (funcall org-confirm-elisp-link-function
10615 (format "Execute \"%s\" as elisp? "
10616 (org-add-props cmd nil
10617 'face 'org-warning))))
10618 (message "%s => %s" cmd
10619 (if (equal (string-to-char cmd) ?\()
10620 (eval (read cmd))
10621 (call-interactively (read cmd))))
10622 (error "Abort"))))
10624 ((and (string= type "thisfile")
10625 (or (run-hook-with-args-until-success
10626 'org-open-link-functions path)
10627 (and link
10628 (string-match "^id:" link)
10629 (or (featurep 'org-id) (require 'org-id))
10630 (progn
10631 (funcall (nth 1 (assoc "id" org-link-protocols))
10632 (substring path 3))
10633 t)))))
10635 ((string= type "thisfile")
10636 (if arg
10637 (switch-to-buffer-other-window
10638 (org-get-buffer-for-internal-link (current-buffer)))
10639 (org-mark-ring-push))
10640 (let ((cmd `(org-link-search
10641 ,path
10642 ,(cond ((equal arg '(4)) ''occur)
10643 ((equal arg '(16)) ''org-occur))
10644 ,pos)))
10645 (condition-case nil (let ((org-link-search-inhibit-query t))
10646 (eval cmd))
10647 (error (progn (widen) (eval cmd))))))
10649 (t (browse-url-at-point)))))))
10650 (move-marker org-open-link-marker nil)
10651 (run-hook-with-args 'org-follow-link-hook)))
10653 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10654 "Offer links in the current entry and return the selected link.
10655 If there is only one link, return it.
10656 If NTH is an integer, return the NTH link found.
10657 If ZERO is a string, check also this string for a link, and if
10658 there is one, return it."
10659 (with-current-buffer buffer
10660 (save-excursion
10661 (save-restriction
10662 (widen)
10663 (goto-char marker)
10664 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10665 "\\(" org-angle-link-re "\\)\\|"
10666 "\\(" org-plain-link-re "\\)"))
10667 (cnt ?0)
10668 (in-emacs (if (integerp nth) nil nth))
10669 have-zero end links link c)
10670 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10671 (push (match-string 0 zero) links)
10672 (setq cnt (1- cnt) have-zero t))
10673 (save-excursion
10674 (org-back-to-heading t)
10675 (setq end (save-excursion (outline-next-heading) (point)))
10676 (while (re-search-forward re end t)
10677 (push (match-string 0) links))
10678 (setq links (org-uniquify (reverse links))))
10679 (cond
10680 ((null links)
10681 (message "No links"))
10682 ((equal (length links) 1)
10683 (setq link (car links)))
10684 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10685 (setq link (nth (if have-zero nth (1- nth)) links)))
10686 (t ; we have to select a link
10687 (save-excursion
10688 (save-window-excursion
10689 (delete-other-windows)
10690 (with-output-to-temp-buffer "*Select Link*"
10691 (mapc (lambda (l)
10692 (if (not (string-match org-bracket-link-regexp l))
10693 (princ (format "[%c] %s\n" (incf cnt)
10694 (org-remove-angle-brackets l)))
10695 (if (match-end 3)
10696 (princ (format "[%c] %s (%s)\n" (incf cnt)
10697 (match-string 3 l) (match-string 1 l)))
10698 (princ (format "[%c] %s\n" (incf cnt)
10699 (match-string 1 l))))))
10700 links))
10701 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10702 (message "Select link to open, RET to open all:")
10703 (setq c (read-char-exclusive))
10704 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10705 (when (equal c ?q) (error "Abort"))
10706 (if (equal c ?\C-m)
10707 (setq link links)
10708 (setq nth (- c ?0))
10709 (if have-zero (setq nth (1+ nth)))
10710 (unless (and (integerp nth) (>= (length links) nth))
10711 (user-error "Invalid link selection"))
10712 (setq link (nth (1- nth) links)))))
10713 (cons link end))))))
10715 ;; Add special file links that specify the way of opening
10717 (org-add-link-type "file+sys" 'org-open-file-with-system)
10718 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10719 (defun org-open-file-with-system (path)
10720 "Open file at PATH using the system way of opening it."
10721 (org-open-file path 'system))
10722 (defun org-open-file-with-emacs (path)
10723 "Open file at PATH in Emacs."
10724 (org-open-file path 'emacs))
10727 ;;; File search
10729 (defvar org-create-file-search-functions nil
10730 "List of functions to construct the right search string for a file link.
10731 These functions are called in turn with point at the location to
10732 which the link should point.
10734 A function in the hook should first test if it would like to
10735 handle this file type, for example by checking the `major-mode'
10736 or the file extension. If it decides not to handle this file, it
10737 should just return nil to give other functions a chance. If it
10738 does handle the file, it must return the search string to be used
10739 when following the link. The search string will be part of the
10740 file link, given after a double colon, and `org-open-at-point'
10741 will automatically search for it. If special measures must be
10742 taken to make the search successful, another function should be
10743 added to the companion hook `org-execute-file-search-functions',
10744 which see.
10746 A function in this hook may also use `setq' to set the variable
10747 `description' to provide a suggestion for the descriptive text to
10748 be used for this link when it gets inserted into an Org-mode
10749 buffer with \\[org-insert-link].")
10751 (defvar org-execute-file-search-functions nil
10752 "List of functions to execute a file search triggered by a link.
10754 Functions added to this hook must accept a single argument, the
10755 search string that was part of the file link, the part after the
10756 double colon. The function must first check if it would like to
10757 handle this search, for example by checking the `major-mode' or
10758 the file extension. If it decides not to handle this search, it
10759 should just return nil to give other functions a chance. If it
10760 does handle the search, it must return a non-nil value to keep
10761 other functions from trying.
10763 Each function can access the current prefix argument through the
10764 variable `current-prefix-arg'. Note that a single prefix is used
10765 to force opening a link in Emacs, so it may be good to only use a
10766 numeric or double prefix to guide the search function.
10768 In case this is needed, a function in this hook can also restore
10769 the window configuration before `org-open-at-point' was called using:
10771 (set-window-configuration org-window-config-before-follow-link)")
10773 (defun org-link-search (s &optional type avoid-pos stealth)
10774 "Search for a link search option.
10775 If S is surrounded by forward slashes, it is interpreted as a
10776 regular expression. In org-mode files, this will create an `org-occur'
10777 sparse tree. In ordinary files, `occur' will be used to list matches.
10778 If the current buffer is in `dired-mode', grep will be used to search
10779 in all files. If AVOID-POS is given, ignore matches near that position.
10781 When optional argument STEALTH is non-nil, do not modify
10782 visibility around point, thus ignoring
10783 `org-show-hierarchy-above', `org-show-following-heading' and
10784 `org-show-siblings' variables."
10785 (let ((case-fold-search t)
10786 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10787 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10788 (append '(("") (" ") ("\t") ("\n"))
10789 org-emphasis-alist)
10790 "\\|") "\\)"))
10791 (pos (point))
10792 (pre nil) (post nil)
10793 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10794 (cond
10795 ;; First check if there are any special search functions
10796 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10797 ;; Now try the builtin stuff
10798 ((and (equal (string-to-char s0) ?#)
10799 (> (length s0) 1)
10800 (save-excursion
10801 (goto-char (point-min))
10802 (and
10803 (re-search-forward
10804 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10805 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10806 (setq type 'dedicated
10807 pos (match-beginning 0))))
10808 ;; There is an exact target for this
10809 (goto-char pos)
10810 (org-back-to-heading t)))
10811 ((save-excursion
10812 (goto-char (point-min))
10813 (and
10814 (re-search-forward
10815 (concat "<<" (regexp-quote s0) ">>") nil t)
10816 (setq type 'dedicated
10817 pos (match-beginning 0))))
10818 ;; There is an exact target for this
10819 (goto-char pos))
10820 ((save-excursion
10821 (goto-char (point-min))
10822 (and
10823 (re-search-forward
10824 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10825 (setq type 'dedicated pos (match-beginning 0))))
10826 ;; Found an element with a matching #+name affiliated keyword.
10827 (goto-char pos))
10828 ((and (string-match "^(\\(.*\\))$" s0)
10829 (save-excursion
10830 (goto-char (point-min))
10831 (and
10832 (re-search-forward
10833 (concat "[^[]" (regexp-quote
10834 (format org-coderef-label-format
10835 (match-string 1 s0))))
10836 nil t)
10837 (setq type 'dedicated
10838 pos (1+ (match-beginning 0))))))
10839 ;; There is a coderef target for this
10840 (goto-char pos))
10841 ((string-match "^/\\(.*\\)/$" s)
10842 ;; A regular expression
10843 (cond
10844 ((derived-mode-p 'org-mode)
10845 (org-occur (match-string 1 s)))
10846 (t (org-do-occur (match-string 1 s)))))
10847 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10848 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10849 (goto-char (point-min))
10850 (cond
10851 ((let (case-fold-search)
10852 (re-search-forward (format org-complex-heading-regexp-format
10853 (regexp-quote s))
10854 nil t))
10855 ;; OK, found a match
10856 (setq type 'dedicated)
10857 (goto-char (match-beginning 0)))
10858 ((and (not org-link-search-inhibit-query)
10859 (eq org-link-search-must-match-exact-headline 'query-to-create)
10860 (y-or-n-p "No match - create this as a new heading? "))
10861 (goto-char (point-max))
10862 (or (bolp) (newline))
10863 (insert "* " s "\n")
10864 (beginning-of-line 0))
10866 (goto-char pos)
10867 (error "No match"))))
10869 ;; A normal search string
10870 (when (equal (string-to-char s) ?*)
10871 ;; Anchor on headlines, post may include tags.
10872 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10873 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10874 s (substring s 1)))
10875 (remove-text-properties
10876 0 (length s)
10877 '(face nil mouse-face nil keymap nil fontified nil) s)
10878 ;; Make a series of regular expressions to find a match
10879 (setq words (org-split-string s "[ \n\r\t]+")
10881 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10882 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10883 "\\)" markers)
10884 re2a_ (concat "\\(" (mapconcat 'downcase words
10885 "[ \t\r\n]+") "\\)[ \t\r\n]")
10886 re2a (concat "[ \t\r\n]" re2a_)
10887 re4_ (concat "\\(" (mapconcat 'downcase words
10888 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10889 re4 (concat "[^a-zA-Z_]" re4_)
10891 re1 (concat pre re2 post)
10892 re3 (concat pre (if pre re4_ re4) post)
10893 re5 (concat pre ".*" re4)
10894 re2 (concat pre re2)
10895 re2a (concat pre (if pre re2a_ re2a))
10896 re4 (concat pre (if pre re4_ re4))
10897 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10898 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10899 re5 "\\)"))
10900 (cond
10901 ((eq type 'org-occur) (org-occur reall))
10902 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10903 (t (goto-char (point-min))
10904 (setq type 'fuzzy)
10905 (if (or (and (org-search-not-self 1 re0 nil t)
10906 (setq type 'dedicated))
10907 (org-search-not-self 1 re1 nil t)
10908 (org-search-not-self 1 re2 nil t)
10909 (org-search-not-self 1 re2a nil t)
10910 (org-search-not-self 1 re3 nil t)
10911 (org-search-not-self 1 re4 nil t)
10912 (org-search-not-self 1 re5 nil t))
10913 (goto-char (match-beginning 1))
10914 (goto-char pos)
10915 (error "No match"))))))
10916 (and (derived-mode-p 'org-mode)
10917 (not stealth)
10918 (org-show-context 'link-search))
10919 type))
10921 (defun org-search-not-self (group &rest args)
10922 "Execute `re-search-forward', but only accept matches that do not
10923 enclose the position of `org-open-link-marker'."
10924 (let ((m org-open-link-marker))
10925 (catch 'exit
10926 (while (apply 're-search-forward args)
10927 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10928 (goto-char (match-end group))
10929 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10930 (> (match-beginning 0) (marker-position m))
10931 (< (match-end 0) (marker-position m)))
10932 (save-match-data
10933 (or (not (org-in-regexp
10934 org-bracket-link-analytic-regexp 1))
10935 (not (match-end 4)) ; no description
10936 (and (<= (match-beginning 4) (point))
10937 (>= (match-end 4) (point))))))
10938 (throw 'exit (point))))))))
10940 (defun org-get-buffer-for-internal-link (buffer)
10941 "Return a buffer to be used for displaying the link target of internal links."
10942 (cond
10943 ((not org-display-internal-link-with-indirect-buffer)
10944 buffer)
10945 ((string-match "(Clone)$" (buffer-name buffer))
10946 (message "Buffer is already a clone, not making another one")
10947 ;; we also do not modify visibility in this case
10948 buffer)
10949 (t ; make a new indirect buffer for displaying the link
10950 (let* ((bn (buffer-name buffer))
10951 (ibn (concat bn "(Clone)"))
10952 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10953 (with-current-buffer ib (org-overview))
10954 ib))))
10956 (defun org-do-occur (regexp &optional cleanup)
10957 "Call the Emacs command `occur'.
10958 If CLEANUP is non-nil, remove the printout of the regular expression
10959 in the *Occur* buffer. This is useful if the regex is long and not useful
10960 to read."
10961 (occur regexp)
10962 (when cleanup
10963 (let ((cwin (selected-window)) win beg end)
10964 (when (setq win (get-buffer-window "*Occur*"))
10965 (select-window win))
10966 (goto-char (point-min))
10967 (when (re-search-forward "match[a-z]+" nil t)
10968 (setq beg (match-end 0))
10969 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10970 (setq end (1- (match-beginning 0)))))
10971 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10972 (goto-char (point-min))
10973 (select-window cwin))))
10975 ;;; The mark ring for links jumps
10977 (defvar org-mark-ring nil
10978 "Mark ring for positions before jumps in Org-mode.")
10979 (defvar org-mark-ring-last-goto nil
10980 "Last position in the mark ring used to go back.")
10981 ;; Fill and close the ring
10982 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10983 (loop for i from 1 to org-mark-ring-length do
10984 (push (make-marker) org-mark-ring))
10985 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10986 org-mark-ring)
10988 (defun org-mark-ring-push (&optional pos buffer)
10989 "Put the current position or POS into the mark ring and rotate it."
10990 (interactive)
10991 (setq pos (or pos (point)))
10992 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10993 (move-marker (car org-mark-ring)
10994 (or pos (point))
10995 (or buffer (current-buffer)))
10996 (message "%s"
10997 (substitute-command-keys
10998 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11000 (defun org-mark-ring-goto (&optional n)
11001 "Jump to the previous position in the mark ring.
11002 With prefix arg N, jump back that many stored positions. When
11003 called several times in succession, walk through the entire ring.
11004 Org-mode commands jumping to a different position in the current file,
11005 or to another Org-mode file, automatically push the old position
11006 onto the ring."
11007 (interactive "p")
11008 (let (p m)
11009 (if (eq last-command this-command)
11010 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11011 (setq p org-mark-ring))
11012 (setq org-mark-ring-last-goto p)
11013 (setq m (car p))
11014 (org-pop-to-buffer-same-window (marker-buffer m))
11015 (goto-char m)
11016 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11018 (defun org-remove-angle-brackets (s)
11019 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11020 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11022 (defun org-add-angle-brackets (s)
11023 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11024 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11026 (defun org-remove-double-quotes (s)
11027 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11028 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11031 ;;; Following specific links
11033 (defun org-follow-timestamp-link ()
11034 "Open an agenda view for the time-stamp date/range at point."
11035 (cond
11036 ((org-at-date-range-p t)
11037 (let ((org-agenda-start-on-weekday)
11038 (t1 (match-string 1))
11039 (t2 (match-string 2)) tt1 tt2)
11040 (setq tt1 (time-to-days (org-time-string-to-time t1))
11041 tt2 (time-to-days (org-time-string-to-time t2)))
11042 (let ((org-agenda-buffer-tmp-name
11043 (format "*Org Agenda(a:%s)"
11044 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11045 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11046 ((org-at-timestamp-p t)
11047 (let ((org-agenda-buffer-tmp-name
11048 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11049 (org-agenda-list nil (time-to-days (org-time-string-to-time
11050 (substring (match-string 1) 0 10)))
11051 1)))
11052 (t (error "This should not happen"))))
11055 ;;; Following file links
11056 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11057 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11058 (declare-function mailcap-mime-info
11059 "mailcap" (string &optional request no-decode))
11060 (defvar org-wait nil)
11061 (defun org-open-file (path &optional in-emacs line search)
11062 "Open the file at PATH.
11063 First, this expands any special file name abbreviations. Then the
11064 configuration variable `org-file-apps' is checked if it contains an
11065 entry for this file type, and if yes, the corresponding command is launched.
11067 If no application is found, Emacs simply visits the file.
11069 With optional prefix argument IN-EMACS, Emacs will visit the file.
11070 With a double \\[universal-argument] \\[universal-argument] \
11071 prefix arg, Org tries to avoid opening in Emacs
11072 and to use an external application to visit the file.
11074 Optional LINE specifies a line to go to, optional SEARCH a string
11075 to search for. If LINE or SEARCH is given, the file will be
11076 opened in Emacs, unless an entry from org-file-apps that makes
11077 use of groups in a regexp matches.
11079 If you want to change the way frames are used when following a
11080 link, please customize `org-link-frame-setup'.
11082 If the file does not exist, an error is thrown."
11083 (let* ((file (if (equal path "")
11084 buffer-file-name
11085 (substitute-in-file-name (expand-file-name path))))
11086 (file-apps (append org-file-apps (org-default-apps)))
11087 (apps (org-remove-if
11088 'org-file-apps-entry-match-against-dlink-p file-apps))
11089 (apps-dlink (org-remove-if-not
11090 'org-file-apps-entry-match-against-dlink-p file-apps))
11091 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11092 (dirp (if remp nil (file-directory-p file)))
11093 (file (if (and dirp org-open-directory-means-index-dot-org)
11094 (concat (file-name-as-directory file) "index.org")
11095 file))
11096 (a-m-a-p (assq 'auto-mode apps))
11097 (dfile (downcase file))
11098 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11099 (link (cond ((and (eq line nil)
11100 (eq search nil))
11101 file)
11102 (line
11103 (concat file "::" (number-to-string line)))
11104 (search
11105 (concat file "::" search))))
11106 (dlink (downcase link))
11107 (old-buffer (current-buffer))
11108 (old-pos (point))
11109 (old-mode major-mode)
11110 ext cmd link-match-data)
11111 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11112 (setq ext (match-string 1 dfile))
11113 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11114 (setq ext (match-string 1 dfile))))
11115 (cond
11116 ((member in-emacs '((16) system))
11117 (setq cmd (cdr (assoc 'system apps))))
11118 (in-emacs (setq cmd 'emacs))
11120 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11121 (and dirp (cdr (assoc 'directory apps)))
11122 ; first, try matching against apps-dlink
11123 ; if we get a match here, store the match data for later
11124 (let ((match (assoc-default dlink apps-dlink
11125 'string-match)))
11126 (if match
11127 (progn (setq link-match-data (match-data))
11128 match)
11129 (progn (setq in-emacs (or in-emacs line search))
11130 nil))) ; if we have no match in apps-dlink,
11131 ; always open the file in emacs if line or search
11132 ; is given (for backwards compatibility)
11133 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11134 'string-match)
11135 (cdr (assoc ext apps))
11136 (cdr (assoc t apps))))))
11137 (when (eq cmd 'system)
11138 (setq cmd (cdr (assoc 'system apps))))
11139 (when (eq cmd 'default)
11140 (setq cmd (cdr (assoc t apps))))
11141 (when (eq cmd 'mailcap)
11142 (require 'mailcap)
11143 (mailcap-parse-mailcaps)
11144 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11145 (command (mailcap-mime-info mime-type)))
11146 (if (stringp command)
11147 (setq cmd command)
11148 (setq cmd 'emacs))))
11149 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11150 (not (file-exists-p file))
11151 (not org-open-non-existing-files))
11152 (user-error "No such file: %s" file))
11153 (cond
11154 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11155 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11156 (while (string-match "['\"]%s['\"]" cmd)
11157 (setq cmd (replace-match "%s" t t cmd)))
11158 (while (string-match "%s" cmd)
11159 (setq cmd (replace-match
11160 (save-match-data
11161 (shell-quote-argument
11162 (convert-standard-filename file)))
11163 t t cmd)))
11165 ;; Replace "%1", "%2" etc. in command with group matches from regex
11166 (save-match-data
11167 (let ((match-index 1)
11168 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11169 (set-match-data link-match-data)
11170 (while (<= match-index number-of-groups)
11171 (let ((regex (concat "%" (number-to-string match-index)))
11172 (replace-with (match-string match-index dlink)))
11173 (while (string-match regex cmd)
11174 (setq cmd (replace-match replace-with t t cmd))))
11175 (setq match-index (+ match-index 1)))))
11177 (save-window-excursion
11178 (message "Running %s...done" cmd)
11179 (start-process-shell-command cmd nil cmd)
11180 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11181 ((or (stringp cmd)
11182 (eq cmd 'emacs))
11183 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11184 (widen)
11185 (if line (progn (org-goto-line line)
11186 (if (derived-mode-p 'org-mode)
11187 (org-reveal)))
11188 (if search (org-link-search search))))
11189 ((consp cmd)
11190 (let ((file (convert-standard-filename file)))
11191 (save-match-data
11192 (set-match-data link-match-data)
11193 (eval cmd))))
11194 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11195 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11196 (or (not (equal old-buffer (current-buffer)))
11197 (not (equal old-pos (point))))
11198 (org-mark-ring-push old-pos old-buffer))))
11200 (defun org-file-apps-entry-match-against-dlink-p (entry)
11201 "This function returns non-nil if `entry' uses a regular
11202 expression which should be matched against the whole link by
11203 org-open-file.
11205 It assumes that is the case when the entry uses a regular
11206 expression which has at least one grouping construct and the
11207 action is either a lisp form or a command string containing
11208 '%1', i.e. using at least one subexpression match as a
11209 parameter."
11210 (let ((selector (car entry))
11211 (action (cdr entry)))
11212 (if (stringp selector)
11213 (and (> (regexp-opt-depth selector) 0)
11214 (or (and (stringp action)
11215 (string-match "%[0-9]" action))
11216 (consp action)))
11217 nil)))
11219 (defun org-default-apps ()
11220 "Return the default applications for this operating system."
11221 (cond
11222 ((eq system-type 'darwin)
11223 org-file-apps-defaults-macosx)
11224 ((eq system-type 'windows-nt)
11225 org-file-apps-defaults-windowsnt)
11226 (t org-file-apps-defaults-gnu)))
11228 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11229 "Convert extensions to regular expressions in the cars of LIST.
11230 Also, weed out any non-string entries, because the return value is used
11231 only for regexp matching.
11232 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11233 point to the symbol `emacs', indicating that the file should
11234 be opened in Emacs."
11235 (append
11236 (delq nil
11237 (mapcar (lambda (x)
11238 (if (not (stringp (car x)))
11240 (if (string-match "\\W" (car x))
11242 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11243 list))
11244 (if add-auto-mode
11245 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11247 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11248 (defun org-file-remote-p (file)
11249 "Test whether FILE specifies a location on a remote system.
11250 Return non-nil if the location is indeed remote.
11252 For example, the filename \"/user@host:/foo\" specifies a location
11253 on the system \"/user@host:\"."
11254 (cond ((fboundp 'file-remote-p)
11255 (file-remote-p file))
11256 ((fboundp 'tramp-handle-file-remote-p)
11257 (tramp-handle-file-remote-p file))
11258 ((and (boundp 'ange-ftp-name-format)
11259 (string-match (car ange-ftp-name-format) file))
11260 t)))
11263 ;;;; Refiling
11265 (defun org-get-org-file ()
11266 "Read a filename, with default directory `org-directory'."
11267 (let ((default (or org-default-notes-file remember-data-file)))
11268 (read-file-name (format "File name [%s]: " default)
11269 (file-name-as-directory org-directory)
11270 default)))
11272 (defun org-notes-order-reversed-p ()
11273 "Check if the current file should receive notes in reversed order."
11274 (cond
11275 ((not org-reverse-note-order) nil)
11276 ((eq t org-reverse-note-order) t)
11277 ((not (listp org-reverse-note-order)) nil)
11278 (t (catch 'exit
11279 (let ((all org-reverse-note-order)
11280 entry)
11281 (while (setq entry (pop all))
11282 (if (string-match (car entry) buffer-file-name)
11283 (throw 'exit (cdr entry))))
11284 nil)))))
11286 (defvar org-refile-target-table nil
11287 "The list of refile targets, created by `org-refile'.")
11289 (defvar org-agenda-new-buffers nil
11290 "Buffers created to visit agenda files.")
11292 (defvar org-refile-cache nil
11293 "Cache for refile targets.")
11295 (defvar org-refile-markers nil
11296 "All the markers used for caching refile locations.")
11298 (defun org-refile-marker (pos)
11299 "Get a new refile marker, but only if caching is in use."
11300 (if (not org-refile-use-cache)
11302 (let ((m (make-marker)))
11303 (move-marker m pos)
11304 (push m org-refile-markers)
11305 m)))
11307 (defun org-refile-cache-clear ()
11308 "Clear the refile cache and disable all the markers."
11309 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11310 (setq org-refile-markers nil)
11311 (setq org-refile-cache nil)
11312 (message "Refile cache has been cleared"))
11314 (defun org-refile-cache-check-set (set)
11315 "Check if all the markers in the cache still have live buffers."
11316 (let (marker)
11317 (catch 'exit
11318 (while (and set (setq marker (nth 3 (pop set))))
11319 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11320 (when (and marker (null (marker-buffer marker)))
11321 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11322 (sit-for 3)
11323 (throw 'exit nil)))
11324 t)))
11326 (defun org-refile-cache-put (set &rest identifiers)
11327 "Push the refile targets SET into the cache, under IDENTIFIERS."
11328 (let* ((key (sha1 (prin1-to-string identifiers)))
11329 (entry (assoc key org-refile-cache)))
11330 (if entry
11331 (setcdr entry set)
11332 (push (cons key set) org-refile-cache))))
11334 (defun org-refile-cache-get (&rest identifiers)
11335 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11336 (cond
11337 ((not org-refile-cache) nil)
11338 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11340 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11341 org-refile-cache))))
11342 (and set (org-refile-cache-check-set set) set)))))
11344 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11345 "Produce a table with refile targets."
11346 (let ((case-fold-search nil)
11347 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11348 (entries (or org-refile-targets '((nil . (:level . 1)))))
11349 targets tgs txt re files f desc descre fast-path-p level pos0)
11350 (message "Getting targets...")
11351 (with-current-buffer (or default-buffer (current-buffer))
11352 (while (setq entry (pop entries))
11353 (setq files (car entry) desc (cdr entry))
11354 (setq fast-path-p nil)
11355 (cond
11356 ((null files) (setq files (list (current-buffer))))
11357 ((eq files 'org-agenda-files)
11358 (setq files (org-agenda-files 'unrestricted)))
11359 ((and (symbolp files) (fboundp files))
11360 (setq files (funcall files)))
11361 ((and (symbolp files) (boundp files))
11362 (setq files (symbol-value files))))
11363 (if (stringp files) (setq files (list files)))
11364 (cond
11365 ((eq (car desc) :tag)
11366 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11367 ((eq (car desc) :todo)
11368 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11369 ((eq (car desc) :regexp)
11370 (setq descre (cdr desc)))
11371 ((eq (car desc) :level)
11372 (setq descre (concat "^\\*\\{" (number-to-string
11373 (if org-odd-levels-only
11374 (1- (* 2 (cdr desc)))
11375 (cdr desc)))
11376 "\\}[ \t]")))
11377 ((eq (car desc) :maxlevel)
11378 (setq fast-path-p t)
11379 (setq descre (concat "^\\*\\{1," (number-to-string
11380 (if org-odd-levels-only
11381 (1- (* 2 (cdr desc)))
11382 (cdr desc)))
11383 "\\}[ \t]")))
11384 (t (error "Bad refiling target description %s" desc)))
11385 (while (setq f (pop files))
11386 (with-current-buffer
11387 (if (bufferp f) f (org-get-agenda-file-buffer f))
11389 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11390 (progn
11391 (if (bufferp f) (setq f (buffer-file-name
11392 (buffer-base-buffer f))))
11393 (setq f (and f (expand-file-name f)))
11394 (if (eq org-refile-use-outline-path 'file)
11395 (push (list (file-name-nondirectory f) f nil nil) tgs))
11396 (save-excursion
11397 (save-restriction
11398 (widen)
11399 (goto-char (point-min))
11400 (while (re-search-forward descre nil t)
11401 (goto-char (setq pos0 (point-at-bol)))
11402 (catch 'next
11403 (when org-refile-target-verify-function
11404 (save-match-data
11405 (or (funcall org-refile-target-verify-function)
11406 (throw 'next t))))
11407 (when (and (looking-at org-complex-heading-regexp)
11408 (not (member (match-string 4) excluded-entries))
11409 (match-string 4))
11410 (setq level (org-reduced-level
11411 (- (match-end 1) (match-beginning 1)))
11412 txt (org-link-display-format (match-string 4))
11413 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11414 re (format org-complex-heading-regexp-format
11415 (regexp-quote (match-string 4))))
11416 (when org-refile-use-outline-path
11417 (setq txt (mapconcat
11418 'org-protect-slash
11419 (append
11420 (if (eq org-refile-use-outline-path
11421 'file)
11422 (list (file-name-nondirectory
11423 (buffer-file-name
11424 (buffer-base-buffer))))
11425 (if (eq org-refile-use-outline-path
11426 'full-file-path)
11427 (list (buffer-file-name
11428 (buffer-base-buffer)))))
11429 (org-get-outline-path fast-path-p
11430 level txt)
11431 (list txt))
11432 "/")))
11433 (push (list txt f re (org-refile-marker (point)))
11434 tgs)))
11435 (when (= (point) pos0)
11436 ;; verification function has not moved point
11437 (goto-char (point-at-eol))))))))
11438 (when org-refile-use-cache
11439 (org-refile-cache-put tgs (buffer-file-name) descre))
11440 (setq targets (append tgs targets))))))
11441 (message "Getting targets...done")
11442 (nreverse targets)))
11444 (defun org-protect-slash (s)
11445 (while (string-match "/" s)
11446 (setq s (replace-match "\\" t t s)))
11449 (defvar org-olpa (make-vector 20 nil))
11451 (defun org-get-outline-path (&optional fastp level heading)
11452 "Return the outline path to the current entry, as a list.
11454 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11455 routine which makes outline path derivations for an entire file,
11456 avoiding backtracing. Refile target collection makes use of that."
11457 (if fastp
11458 (progn
11459 (if (> level 19)
11460 (error "Outline path failure, more than 19 levels"))
11461 (loop for i from level upto 19 do
11462 (aset org-olpa i nil))
11463 (prog1
11464 (delq nil (append org-olpa nil))
11465 (aset org-olpa level heading)))
11466 (let (rtn case-fold-search)
11467 (save-excursion
11468 (save-restriction
11469 (widen)
11470 (while (org-up-heading-safe)
11471 (when (looking-at org-complex-heading-regexp)
11472 (push (org-trim
11473 (replace-regexp-in-string
11474 ;; Remove statistical/checkboxes cookies
11475 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11476 (org-match-string-no-properties 4)))
11477 rtn)))
11478 rtn)))))
11480 (defun org-format-outline-path (path &optional width prefix separator)
11481 "Format the outline path PATH for display.
11482 WIDTH is the maximum number of characters that is available.
11483 PREFIX is a prefix to be included in the returned string,
11484 such as the file name.
11485 SEPARATOR is inserted between the different parts of the path,
11486 the default is \"/\"."
11487 (setq width (or width 79))
11488 (if prefix (setq width (- width (length prefix))))
11489 (if (not path)
11490 (or prefix "")
11491 (let* ((nsteps (length path))
11492 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11493 (maxwidth (if (<= total-width width)
11494 10000 ;; everything fits
11495 ;; we need to shorten the level headings
11496 (/ (- width nsteps) nsteps)))
11497 (org-odd-levels-only nil)
11498 (n 0)
11499 (total (1+ (length prefix))))
11500 (setq maxwidth (max maxwidth 10))
11501 (concat prefix
11502 (if prefix (or separator "/"))
11503 (mapconcat
11504 (lambda (h)
11505 (setq n (1+ n))
11506 (if (and (= n nsteps) (< maxwidth 10000))
11507 (setq maxwidth (- total-width total)))
11508 (if (< (length h) maxwidth)
11509 (progn (setq total (+ total (length h) 1)) h)
11510 (setq h (substring h 0 (- maxwidth 2))
11511 total (+ total maxwidth 1))
11512 (if (string-match "[ \t]+\\'" h)
11513 (setq h (substring h 0 (match-beginning 0))))
11514 (setq h (concat h "..")))
11515 (org-add-props h nil 'face
11516 (nth (% (1- n) org-n-level-faces)
11517 org-level-faces))
11519 path (or separator "/"))))))
11521 (defun org-display-outline-path (&optional file current separator just-return-string)
11522 "Display the current outline path in the echo area.
11524 If FILE is non-nil, prepend the output with the file name.
11525 If CURRENT is non-nil, append the current heading to the output.
11526 SEPARATOR is passed through to `org-format-outline-path'. It separates
11527 the different parts of the path and defaults to \"/\".
11528 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11529 (interactive "P")
11530 (let* (case-fold-search
11531 (bfn (buffer-file-name (buffer-base-buffer)))
11532 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11533 res)
11534 (if current (setq path (append path
11535 (save-excursion
11536 (org-back-to-heading t)
11537 (if (looking-at org-complex-heading-regexp)
11538 (list (match-string 4)))))))
11539 (setq res
11540 (org-format-outline-path
11541 path
11542 (1- (frame-width))
11543 (and file bfn (concat (file-name-nondirectory bfn) separator))
11544 separator))
11545 (if just-return-string
11546 (org-no-properties res)
11547 (org-unlogged-message "%s" res))))
11549 (defvar org-refile-history nil
11550 "History for refiling operations.")
11552 (defvar org-after-refile-insert-hook nil
11553 "Hook run after `org-refile' has inserted its stuff at the new location.
11554 Note that this is still *before* the stuff will be removed from
11555 the *old* location.")
11557 (defvar org-capture-last-stored-marker)
11558 (defvar org-refile-keep nil
11559 "Non-nil means `org-refile' will copy instead of refile.")
11561 (defun org-copy ()
11562 "Like `org-refile', but copy."
11563 (interactive)
11564 (let ((org-refile-keep t))
11565 (funcall 'org-refile nil nil nil "Copy")))
11567 (defun org-refile (&optional goto default-buffer rfloc msg)
11568 "Move the entry or entries at point to another heading.
11569 The list of target headings is compiled using the information in
11570 `org-refile-targets', which see.
11572 At the target location, the entry is filed as a subitem of the target
11573 heading. Depending on `org-reverse-note-order', the new subitem will
11574 either be the first or the last subitem.
11576 If there is an active region, all entries in that region will be moved.
11577 However, the region must fulfill the requirement that the first heading
11578 is the first one sets the top-level of the moved text - at most siblings
11579 below it are allowed.
11581 With prefix arg GOTO, the command will only visit the target location
11582 and not actually move anything.
11584 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11585 go to the location where the last refiling operation has put the subtree.
11587 With a numeric prefix argument of `2', refile to the running clock.
11589 With a numeric prefix argument of `3', emulate `org-refile-keep'
11590 being set to `t' and copy to the target location, don't move it.
11591 Beware that keeping refiled entries may result in duplicated ID
11592 properties.
11594 RFLOC can be a refile location obtained in a different way.
11596 MSG is a string to replace \"Refile\" in the default prompt with
11597 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11599 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11601 If you are using target caching (see `org-refile-use-cache'),
11602 you have to clear the target cache in order to find new targets.
11603 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11604 prefix argument (`C-u C-u C-u C-c C-w')."
11606 (interactive "P")
11607 (if (member goto '(0 (64)))
11608 (org-refile-cache-clear)
11609 (let* ((actionmsg (or msg "Refile"))
11610 (cbuf (current-buffer))
11611 (regionp (org-region-active-p))
11612 (region-start (and regionp (region-beginning)))
11613 (region-end (and regionp (region-end)))
11614 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11615 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11616 pos it nbuf file re level reversed)
11617 (setq last-command nil)
11618 (when regionp
11619 (goto-char region-start)
11620 (or (bolp) (goto-char (point-at-bol)))
11621 (setq region-start (point))
11622 (unless (or (org-kill-is-subtree-p
11623 (buffer-substring region-start region-end))
11624 (prog1 org-refile-active-region-within-subtree
11625 (let ((s (point-at-eol)))
11626 (org-toggle-heading)
11627 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11628 (user-error "The region is not a (sequence of) subtree(s)")))
11629 (if (equal goto '(16))
11630 (org-refile-goto-last-stored)
11631 (when (or
11632 (and (equal goto 2)
11633 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11634 (prog1
11635 (setq it (list (or org-clock-heading "running clock")
11636 (buffer-file-name
11637 (marker-buffer org-clock-hd-marker))
11639 (marker-position org-clock-hd-marker)))
11640 (setq goto nil)))
11641 (setq it (or rfloc
11642 (let (heading-text)
11643 (save-excursion
11644 (unless goto
11645 (org-back-to-heading t)
11646 (setq heading-text
11647 (nth 4 (org-heading-components))))
11649 (org-refile-get-location
11650 (cond (goto "Goto")
11651 (regionp (concat actionmsg " region to"))
11652 (t (concat actionmsg " subtree \""
11653 heading-text "\" to")))
11654 default-buffer
11655 (and (not (equal '(4) goto))
11656 org-refile-allow-creating-parent-nodes)
11657 goto))))))
11658 (setq file (nth 1 it)
11659 re (nth 2 it)
11660 pos (nth 3 it))
11661 (if (and (not goto)
11663 (equal (buffer-file-name) file)
11664 (if regionp
11665 (and (>= pos region-start)
11666 (<= pos region-end))
11667 (and (>= pos (point))
11668 (< pos (save-excursion
11669 (org-end-of-subtree t t))))))
11670 (error "Cannot refile to position inside the tree or region"))
11672 (setq nbuf (or (find-buffer-visiting file)
11673 (find-file-noselect file)))
11674 (if (and goto (not (equal goto 3)))
11675 (progn
11676 (org-pop-to-buffer-same-window nbuf)
11677 (goto-char pos)
11678 (org-show-context 'org-goto))
11679 (if regionp
11680 (progn
11681 (org-kill-new (buffer-substring region-start region-end))
11682 (org-save-markers-in-region region-start region-end))
11683 (org-copy-subtree 1 nil t))
11684 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11685 (find-file-noselect file)))
11686 (setq reversed (org-notes-order-reversed-p))
11687 (save-excursion
11688 (save-restriction
11689 (widen)
11690 (if pos
11691 (progn
11692 (goto-char pos)
11693 (looking-at org-outline-regexp)
11694 (setq level (org-get-valid-level (funcall outline-level) 1))
11695 (goto-char
11696 (if reversed
11697 (or (outline-next-heading) (point-max))
11698 (or (save-excursion (org-get-next-sibling))
11699 (org-end-of-subtree t t)
11700 (point-max)))))
11701 (setq level 1)
11702 (if (not reversed)
11703 (goto-char (point-max))
11704 (goto-char (point-min))
11705 (or (outline-next-heading) (goto-char (point-max)))))
11706 (if (not (bolp)) (newline))
11707 (org-paste-subtree level)
11708 (when org-log-refile
11709 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11710 (unless (eq org-log-refile 'note)
11711 (save-excursion (org-add-log-note))))
11712 (and org-auto-align-tags
11713 (let ((org-loop-over-headlines-in-active-region nil))
11714 (org-set-tags nil t)))
11715 (let ((bookmark-name (plist-get org-bookmark-names-plist
11716 :last-refile)))
11717 (when bookmark-name
11718 (with-demoted-errors
11719 (bookmark-set bookmark-name))))
11720 ;; If we are refiling for capture, make sure that the
11721 ;; last-capture pointers point here
11722 (when (org-bound-and-true-p org-refile-for-capture)
11723 (let ((bookmark-name (plist-get org-bookmark-names-plist
11724 :last-capture-marker)))
11725 (when bookmark-name
11726 (with-demoted-errors
11727 (bookmark-set bookmark-name))))
11728 (move-marker org-capture-last-stored-marker (point)))
11729 (if (fboundp 'deactivate-mark) (deactivate-mark))
11730 (run-hooks 'org-after-refile-insert-hook))))
11731 (unless org-refile-keep
11732 (if regionp
11733 (delete-region (point) (+ (point) (- region-end region-start)))
11734 (delete-region
11735 (and (org-back-to-heading t) (point))
11736 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11737 (when (featurep 'org-inlinetask)
11738 (org-inlinetask-remove-END-maybe))
11739 (setq org-markers-to-move nil)
11740 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11742 (defun org-refile-goto-last-stored ()
11743 "Go to the location where the last refile was stored."
11744 (interactive)
11745 (bookmark-jump "org-refile-last-stored")
11746 (message "This is the location of the last refile"))
11748 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11749 no-exclude)
11750 "Prompt the user for a refile location, using PROMPT.
11751 PROMPT should not be suffixed with a colon and a space, because
11752 this function appends the default value from
11753 `org-refile-history' automatically, if that is not empty.
11754 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11755 this is used for the GOTO interface."
11756 (let ((org-refile-targets org-refile-targets)
11757 (org-refile-use-outline-path org-refile-use-outline-path)
11758 excluded-entries)
11759 (when (and (derived-mode-p 'org-mode)
11760 (not org-refile-use-cache)
11761 (not no-exclude))
11762 (org-map-tree
11763 (lambda()
11764 (setq excluded-entries
11765 (append excluded-entries (list (org-get-heading t t)))))))
11766 (setq org-refile-target-table
11767 (org-refile-get-targets default-buffer excluded-entries)))
11768 (unless org-refile-target-table
11769 (user-error "No refile targets"))
11770 (let* ((cbuf (current-buffer))
11771 (partial-completion-mode nil)
11772 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11773 (cfunc (if (and org-refile-use-outline-path
11774 org-outline-path-complete-in-steps)
11775 'org-olpath-completing-read
11776 'org-icompleting-read))
11777 (extra (if org-refile-use-outline-path "/" ""))
11778 (cbnex (concat (buffer-name) extra))
11779 (filename (and cfn (expand-file-name cfn)))
11780 (tbl (mapcar
11781 (lambda (x)
11782 (if (and (not (member org-refile-use-outline-path
11783 '(file full-file-path)))
11784 (not (equal filename (nth 1 x))))
11785 (cons (concat (car x) extra " ("
11786 (file-name-nondirectory (nth 1 x)) ")")
11787 (cdr x))
11788 (cons (concat (car x) extra) (cdr x))))
11789 org-refile-target-table))
11790 (completion-ignore-case t)
11791 cdef
11792 (prompt (concat prompt
11793 (or (and (car org-refile-history)
11794 (concat " (default " (car org-refile-history) ")"))
11795 (and (assoc cbnex tbl) (setq cdef cbnex)
11796 (concat " (default " cbnex ")"))) ": "))
11797 pa answ parent-target child parent old-hist)
11798 (setq old-hist org-refile-history)
11799 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11800 nil 'org-refile-history (or cdef (car org-refile-history))))
11801 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11802 (if pa
11803 (progn
11804 (org-refile-check-position pa)
11805 (when (or (not org-refile-history)
11806 (not (eq old-hist org-refile-history))
11807 (not (equal (car pa) (car org-refile-history))))
11808 (setq org-refile-history
11809 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11810 org-refile-history
11811 (cdr org-refile-history))))
11812 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11813 (pop org-refile-history)))
11815 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11816 (progn
11817 (setq parent (match-string 1 answ)
11818 child (match-string 2 answ))
11819 (setq parent-target (or (assoc parent tbl)
11820 (assoc (concat parent "/") tbl)))
11821 (when (and parent-target
11822 (or (eq new-nodes t)
11823 (and (eq new-nodes 'confirm)
11824 (y-or-n-p (format "Create new node \"%s\"? "
11825 child)))))
11826 (org-refile-new-child parent-target child)))
11827 (user-error "Invalid target location")))))
11829 (declare-function org-string-nw-p "org-macs" (s))
11830 (defun org-refile-check-position (refile-pointer)
11831 "Check if the refile pointer matches the headline to which it points."
11832 (let* ((file (nth 1 refile-pointer))
11833 (re (nth 2 refile-pointer))
11834 (pos (nth 3 refile-pointer))
11835 buffer)
11836 (if (and (not (markerp pos)) (not file))
11837 (if file
11838 (user-error "Please save the buffer to a file before refiling")
11839 (user-error "Please indicate a target file in the refile path"))
11840 (when (org-string-nw-p re)
11841 (setq buffer (if (markerp pos)
11842 (marker-buffer pos)
11843 (or (find-buffer-visiting file)
11844 (find-file-noselect file))))
11845 (with-current-buffer buffer
11846 (save-excursion
11847 (save-restriction
11848 (widen)
11849 (goto-char pos)
11850 (beginning-of-line 1)
11851 (unless (org-looking-at-p re)
11852 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11854 (defun org-refile-new-child (parent-target child)
11855 "Use refile target PARENT-TARGET to add new CHILD below it."
11856 (unless parent-target
11857 (error "Cannot find parent for new node"))
11858 (let ((file (nth 1 parent-target))
11859 (pos (nth 3 parent-target))
11860 level)
11861 (with-current-buffer (or (find-buffer-visiting file)
11862 (find-file-noselect file))
11863 (save-excursion
11864 (save-restriction
11865 (widen)
11866 (if pos
11867 (goto-char pos)
11868 (goto-char (point-max))
11869 (if (not (bolp)) (newline)))
11870 (when (looking-at org-outline-regexp)
11871 (setq level (funcall outline-level))
11872 (org-end-of-subtree t t))
11873 (org-back-over-empty-lines)
11874 (insert "\n" (make-string
11875 (if pos (org-get-valid-level level 1) 1) ?*)
11876 " " child "\n")
11877 (beginning-of-line 0)
11878 (list (concat (car parent-target) "/" child) file "" (point)))))))
11880 (defun org-olpath-completing-read (prompt collection &rest args)
11881 "Read an outline path like a file name."
11882 (let ((thetable collection)
11883 (org-completion-use-ido nil) ; does not work with ido.
11884 (org-completion-use-iswitchb nil)) ; or iswitchb
11885 (apply
11886 'org-icompleting-read prompt
11887 (lambda (string predicate &optional flag)
11888 (let (rtn r f (l (length string)))
11889 (cond
11890 ((eq flag nil)
11891 ;; try completion
11892 (try-completion string thetable))
11893 ((eq flag t)
11894 ;; all-completions
11895 (setq rtn (all-completions string thetable predicate))
11896 (mapcar
11897 (lambda (x)
11898 (setq r (substring x l))
11899 (if (string-match " ([^)]*)$" x)
11900 (setq f (match-string 0 x))
11901 (setq f ""))
11902 (if (string-match "/" r)
11903 (concat string (substring r 0 (match-end 0)) f)
11905 rtn))
11906 ((eq flag 'lambda)
11907 ;; exact match?
11908 (assoc string thetable)))))
11909 args)))
11911 ;;;; Dynamic blocks
11913 (defun org-find-dblock (name)
11914 "Find the first dynamic block with name NAME in the buffer.
11915 If not found, stay at current position and return nil."
11916 (let ((case-fold-search t) pos)
11917 (save-excursion
11918 (goto-char (point-min))
11919 (setq pos (and (re-search-forward
11920 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11921 (match-beginning 0))))
11922 (if pos (goto-char pos))
11923 pos))
11925 (defun org-create-dblock (plist)
11926 "Create a dynamic block section, with parameters taken from PLIST.
11927 PLIST must contain a :name entry which is used as name of the block."
11928 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11929 (end-of-line 1)
11930 (newline))
11931 (let ((col (current-column))
11932 (name (plist-get plist :name)))
11933 (insert "#+BEGIN: " name)
11934 (while plist
11935 (if (eq (car plist) :name)
11936 (setq plist (cddr plist))
11937 (insert " " (prin1-to-string (pop plist)))))
11938 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11939 (beginning-of-line -2)))
11941 (defun org-prepare-dblock ()
11942 "Prepare dynamic block for refresh.
11943 This empties the block, puts the cursor at the insert position and returns
11944 the property list including an extra property :name with the block name."
11945 (unless (looking-at org-dblock-start-re)
11946 (user-error "Not at a dynamic block"))
11947 (let* ((begdel (1+ (match-end 0)))
11948 (name (org-no-properties (match-string 1)))
11949 (params (append (list :name name)
11950 (read (concat "(" (match-string 3) ")")))))
11951 (save-excursion
11952 (beginning-of-line 1)
11953 (skip-chars-forward " \t")
11954 (setq params (plist-put params :indentation-column (current-column))))
11955 (unless (re-search-forward org-dblock-end-re nil t)
11956 (error "Dynamic block not terminated"))
11957 (setq params
11958 (append params
11959 (list :content (buffer-substring
11960 begdel (match-beginning 0)))))
11961 (delete-region begdel (match-beginning 0))
11962 (goto-char begdel)
11963 (open-line 1)
11964 params))
11966 (defun org-map-dblocks (&optional command)
11967 "Apply COMMAND to all dynamic blocks in the current buffer.
11968 If COMMAND is not given, use `org-update-dblock'."
11969 (let ((cmd (or command 'org-update-dblock)))
11970 (save-excursion
11971 (goto-char (point-min))
11972 (while (re-search-forward org-dblock-start-re nil t)
11973 (goto-char (match-beginning 0))
11974 (save-excursion
11975 (condition-case nil
11976 (funcall cmd)
11977 (error (message "Error during update of dynamic block"))))
11978 (unless (re-search-forward org-dblock-end-re nil t)
11979 (error "Dynamic block not terminated"))))))
11981 (defun org-dblock-update (&optional arg)
11982 "User command for updating dynamic blocks.
11983 Update the dynamic block at point. With prefix ARG, update all dynamic
11984 blocks in the buffer."
11985 (interactive "P")
11986 (if arg
11987 (org-update-all-dblocks)
11988 (or (looking-at org-dblock-start-re)
11989 (org-beginning-of-dblock))
11990 (org-update-dblock)))
11992 (defun org-update-dblock ()
11993 "Update the dynamic block at point.
11994 This means to empty the block, parse for parameters and then call
11995 the correct writing function."
11996 (interactive)
11997 (save-window-excursion
11998 (let* ((pos (point))
11999 (line (org-current-line))
12000 (params (org-prepare-dblock))
12001 (name (plist-get params :name))
12002 (indent (plist-get params :indentation-column))
12003 (cmd (intern (concat "org-dblock-write:" name))))
12004 (message "Updating dynamic block `%s' at line %d..." name line)
12005 (funcall cmd params)
12006 (message "Updating dynamic block `%s' at line %d...done" name line)
12007 (goto-char pos)
12008 (when (and indent (> indent 0))
12009 (setq indent (make-string indent ?\ ))
12010 (save-excursion
12011 (org-beginning-of-dblock)
12012 (forward-line 1)
12013 (while (not (looking-at org-dblock-end-re))
12014 (insert indent)
12015 (beginning-of-line 2))
12016 (when (looking-at org-dblock-end-re)
12017 (and (looking-at "[ \t]+")
12018 (replace-match ""))
12019 (insert indent)))))))
12021 (defun org-beginning-of-dblock ()
12022 "Find the beginning of the dynamic block at point.
12023 Error if there is no such block at point."
12024 (let ((pos (point))
12025 beg)
12026 (end-of-line 1)
12027 (if (and (re-search-backward org-dblock-start-re nil t)
12028 (setq beg (match-beginning 0))
12029 (re-search-forward org-dblock-end-re nil t)
12030 (> (match-end 0) pos))
12031 (goto-char beg)
12032 (goto-char pos)
12033 (error "Not in a dynamic block"))))
12035 (defun org-update-all-dblocks ()
12036 "Update all dynamic blocks in the buffer.
12037 This function can be used in a hook."
12038 (interactive)
12039 (when (derived-mode-p 'org-mode)
12040 (org-map-dblocks 'org-update-dblock)))
12043 ;;;; Completion
12045 (declare-function org-export-backend-name "org-export" (cl-x))
12046 (declare-function org-export-backend-options "org-export" (cl-x))
12047 (defun org-get-export-keywords ()
12048 "Return a list of all currently understood export keywords.
12049 Export keywords include options, block names, attributes and
12050 keywords relative to each registered export back-end."
12051 (let (keywords)
12052 (dolist (backend
12053 (org-bound-and-true-p org-export--registered-backends)
12054 (delq nil keywords))
12055 ;; Back-end name (for keywords, like #+LATEX:)
12056 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12057 (dolist (option-entry (org-export-backend-options backend))
12058 ;; Back-end options.
12059 (push (nth 1 option-entry) keywords)))))
12061 (defconst org-options-keywords
12062 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12063 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12064 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12065 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12066 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12068 (defcustom org-structure-template-alist
12069 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
12070 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
12071 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
12072 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
12073 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
12074 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
12075 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
12076 "<literal style=\"latex\">\n?\n</literal>")
12077 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
12078 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
12079 "<literal style=\"html\">\n?\n</literal>")
12080 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
12081 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
12082 ("A" "#+ASCII: " "")
12083 ("i" "#+INDEX: ?" "#+INDEX: ?")
12084 ("I" "#+INCLUDE: %file ?"
12085 "<include file=%file markup=\"?\">"))
12086 "Structure completion elements.
12087 This is a list of abbreviation keys and values. The value gets inserted
12088 if you type `<' followed by the key and then press the completion key,
12089 usually `M-TAB'. %file will be replaced by a file name after prompting
12090 for the file using completion. The cursor will be placed at the position
12091 of the `?` in the template.
12092 There are two templates for each key, the first uses the original Org syntax,
12093 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12094 the default when the /org-mtags.el/ module has been loaded. See also the
12095 variable `org-mtags-prefer-muse-templates'."
12096 :group 'org-completion
12097 :type '(repeat
12098 (list
12099 (string :tag "Key")
12100 (string :tag "Template")
12101 (string :tag "Muse Template"))))
12103 (defun org-try-structure-completion ()
12104 "Try to complete a structure template before point.
12105 This looks for strings like \"<e\" on an otherwise empty line and
12106 expands them."
12107 (let ((l (buffer-substring (point-at-bol) (point)))
12109 (when (and (looking-at "[ \t]*$")
12110 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12111 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12112 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12113 (match-beginning 1)) a)
12114 t)))
12116 (defun org-complete-expand-structure-template (start cell)
12117 "Expand a structure template."
12118 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12119 (rpl (nth (if musep 2 1) cell))
12120 (ind ""))
12121 (delete-region start (point))
12122 (when (string-match "\\`#\\+" rpl)
12123 (cond
12124 ((bolp))
12125 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12126 (setq ind (buffer-substring (point-at-bol) (point))))
12127 (t (newline))))
12128 (setq start (point))
12129 (if (string-match "%file" rpl)
12130 (setq rpl (replace-match
12131 (concat
12132 "\""
12133 (save-match-data
12134 (abbreviate-file-name (read-file-name "Include file: ")))
12135 "\"")
12136 t t rpl)))
12137 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12138 (concat "\n" ind)))
12139 (insert rpl)
12140 (if (re-search-backward "\\?" start t) (delete-char 1))))
12142 ;;;; TODO, DEADLINE, Comments
12144 (defun org-toggle-comment ()
12145 "Change the COMMENT state of an entry."
12146 (interactive)
12147 (save-excursion
12148 (org-back-to-heading)
12149 (let (case-fold-search)
12150 (cond
12151 ((looking-at (format org-heading-keyword-regexp-format
12152 org-comment-string))
12153 (goto-char (match-end 1))
12154 (looking-at (concat " +" org-comment-string))
12155 (replace-match "" t t)
12156 (when (eolp) (insert " ")))
12157 ((looking-at org-outline-regexp)
12158 (goto-char (match-end 0))
12159 (insert org-comment-string " "))))))
12161 (defvar org-last-todo-state-is-todo nil
12162 "This is non-nil when the last TODO state change led to a TODO state.
12163 If the last change removed the TODO tag or switched to DONE, then
12164 this is nil.")
12166 (defvar org-setting-tags nil) ; dynamically skipped
12168 (defvar org-todo-setup-filter-hook nil
12169 "Hook for functions that pre-filter todo specs.
12170 Each function takes a todo spec and returns either nil or the spec
12171 transformed into canonical form." )
12173 (defvar org-todo-get-default-hook nil
12174 "Hook for functions that get a default item for todo.
12175 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12176 nil or a string to be used for the todo mark." )
12178 (defvar org-agenda-headline-snapshot-before-repeat)
12180 (defun org-current-effective-time ()
12181 "Return current time adjusted for `org-extend-today-until' variable."
12182 (let* ((ct (org-current-time))
12183 (dct (decode-time ct))
12184 (ct1
12185 (cond
12186 (org-use-last-clock-out-time-as-effective-time
12187 (or (org-clock-get-last-clock-out-time) ct))
12188 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12189 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12190 (t ct))))
12191 ct1))
12193 (defun org-todo-yesterday (&optional arg)
12194 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12195 (interactive "P")
12196 (if (eq major-mode 'org-agenda-mode)
12197 (apply 'org-agenda-todo-yesterday arg)
12198 (let* ((hour (third (decode-time
12199 (org-current-time))))
12200 (org-extend-today-until (1+ hour)))
12201 (org-todo arg))))
12203 (defvar org-block-entry-blocking ""
12204 "First entry preventing the TODO state change.")
12206 (defun org-cancel-repeater ()
12207 "Cancel a repeater by setting its numeric value to zero."
12208 (interactive)
12209 (save-excursion
12210 (org-back-to-heading t)
12211 (let ((bound1 (point))
12212 (bound0 (save-excursion (outline-next-heading) (point))))
12213 (when (re-search-forward
12214 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12215 org-deadline-time-regexp "\\)\\|\\("
12216 org-ts-regexp "\\)")
12217 bound0 t)
12218 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12219 (replace-match "0" t nil nil 1))))))
12221 (defun org-todo (&optional arg)
12222 "Change the TODO state of an item.
12223 The state of an item is given by a keyword at the start of the heading,
12224 like
12225 *** TODO Write paper
12226 *** DONE Call mom
12228 The different keywords are specified in the variable `org-todo-keywords'.
12229 By default the available states are \"TODO\" and \"DONE\".
12230 So for this example: when the item starts with TODO, it is changed to DONE.
12231 When it starts with DONE, the DONE is removed. And when neither TODO nor
12232 DONE are present, add TODO at the beginning of the heading.
12234 With \\[universal-argument] prefix arg, use completion to determine the new \
12235 state.
12236 With numeric prefix arg, switch to that state.
12237 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12238 keywords (nextset).
12239 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12240 With a numeric prefix arg of 0, inhibit note taking for the change.
12241 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12243 When called through ELisp, arg is also interpreted in the following way:
12244 'none -> empty state
12245 \"\"(empty string) -> switch to empty state
12246 'done -> switch to DONE
12247 'nextset -> switch to the next set of keywords
12248 'previousset -> switch to the previous set of keywords
12249 \"WAITING\" -> switch to the specified keyword, but only if it
12250 really is a member of `org-todo-keywords'."
12251 (interactive "P")
12252 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12253 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12254 'region-start-level 'region))
12255 org-loop-over-headlines-in-active-region)
12256 (org-map-entries
12257 `(org-todo ,arg)
12258 org-loop-over-headlines-in-active-region
12259 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12260 (if (equal arg '(16)) (setq arg 'nextset))
12261 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12262 (let ((org-blocker-hook org-blocker-hook)
12263 commentp
12264 case-fold-search)
12265 (when (equal arg '(64))
12266 (setq arg nil org-blocker-hook nil))
12267 (when (and org-blocker-hook
12268 (or org-inhibit-blocking
12269 (org-entry-get nil "NOBLOCKING")))
12270 (setq org-blocker-hook nil))
12271 (save-excursion
12272 (catch 'exit
12273 (org-back-to-heading t)
12274 (when (looking-at (concat "^\\*+ " org-comment-string))
12275 (org-toggle-comment)
12276 (setq commentp t))
12277 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12278 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12279 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12280 (let* ((match-data (match-data))
12281 (startpos (point-at-bol))
12282 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12283 (org-log-done org-log-done)
12284 (org-log-repeat org-log-repeat)
12285 (org-todo-log-states org-todo-log-states)
12286 (org-inhibit-logging
12287 (if (equal arg 0)
12288 (progn (setq arg nil) 'note) org-inhibit-logging))
12289 (this (match-string 1))
12290 (hl-pos (match-beginning 0))
12291 (head (org-get-todo-sequence-head this))
12292 (ass (assoc head org-todo-kwd-alist))
12293 (interpret (nth 1 ass))
12294 (done-word (nth 3 ass))
12295 (final-done-word (nth 4 ass))
12296 (org-last-state (or this ""))
12297 (completion-ignore-case t)
12298 (member (member this org-todo-keywords-1))
12299 (tail (cdr member))
12300 (org-state (cond
12301 ((and org-todo-key-trigger
12302 (or (and (equal arg '(4))
12303 (eq org-use-fast-todo-selection 'prefix))
12304 (and (not arg) org-use-fast-todo-selection
12305 (not (eq org-use-fast-todo-selection
12306 'prefix)))))
12307 ;; Use fast selection
12308 (org-fast-todo-selection))
12309 ((and (equal arg '(4))
12310 (or (not org-use-fast-todo-selection)
12311 (not org-todo-key-trigger)))
12312 ;; Read a state with completion
12313 (org-icompleting-read
12314 "State: " (mapcar 'list org-todo-keywords-1)
12315 nil t))
12316 ((eq arg 'right)
12317 (if this
12318 (if tail (car tail) nil)
12319 (car org-todo-keywords-1)))
12320 ((eq arg 'left)
12321 (if (equal member org-todo-keywords-1)
12323 (if this
12324 (nth (- (length org-todo-keywords-1)
12325 (length tail) 2)
12326 org-todo-keywords-1)
12327 (org-last org-todo-keywords-1))))
12328 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12329 (setq arg nil))) ; hack to fall back to cycling
12330 (arg
12331 ;; user or caller requests a specific state
12332 (cond
12333 ((equal arg "") nil)
12334 ((eq arg 'none) nil)
12335 ((eq arg 'done) (or done-word (car org-done-keywords)))
12336 ((eq arg 'nextset)
12337 (or (car (cdr (member head org-todo-heads)))
12338 (car org-todo-heads)))
12339 ((eq arg 'previousset)
12340 (let ((org-todo-heads (reverse org-todo-heads)))
12341 (or (car (cdr (member head org-todo-heads)))
12342 (car org-todo-heads))))
12343 ((car (member arg org-todo-keywords-1)))
12344 ((stringp arg)
12345 (user-error "State `%s' not valid in this file" arg))
12346 ((nth (1- (prefix-numeric-value arg))
12347 org-todo-keywords-1))))
12348 ((null member) (or head (car org-todo-keywords-1)))
12349 ((equal this final-done-word) nil) ;; -> make empty
12350 ((null tail) nil) ;; -> first entry
12351 ((memq interpret '(type priority))
12352 (if (eq this-command last-command)
12353 (car tail)
12354 (if (> (length tail) 0)
12355 (or done-word (car org-done-keywords))
12356 nil)))
12358 (car tail))))
12359 (org-state (or
12360 (run-hook-with-args-until-success
12361 'org-todo-get-default-hook org-state org-last-state)
12362 org-state))
12363 (next (if org-state (concat " " org-state " ") " "))
12364 (change-plist (list :type 'todo-state-change :from this :to org-state
12365 :position startpos))
12366 dolog now-done-p)
12367 (when org-blocker-hook
12368 (setq org-last-todo-state-is-todo
12369 (not (member this org-done-keywords)))
12370 (unless (save-excursion
12371 (save-match-data
12372 (org-with-wide-buffer
12373 (run-hook-with-args-until-failure
12374 'org-blocker-hook change-plist))))
12375 (if (org-called-interactively-p 'interactive)
12376 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12377 this org-state org-block-entry-blocking)
12378 ;; fail silently
12379 (message "TODO state change from %s to %s blocked (by \"%s\")"
12380 this org-state org-block-entry-blocking)
12381 (throw 'exit nil))))
12382 (store-match-data match-data)
12383 (replace-match next t t)
12384 (unless (pos-visible-in-window-p hl-pos)
12385 (message "TODO state changed to %s" (org-trim next)))
12386 (unless head
12387 (setq head (org-get-todo-sequence-head org-state)
12388 ass (assoc head org-todo-kwd-alist)
12389 interpret (nth 1 ass)
12390 done-word (nth 3 ass)
12391 final-done-word (nth 4 ass)))
12392 (when (memq arg '(nextset previousset))
12393 (message "Keyword-Set %d/%d: %s"
12394 (- (length org-todo-sets) -1
12395 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12396 (length org-todo-sets)
12397 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12398 (setq org-last-todo-state-is-todo
12399 (not (member org-state org-done-keywords)))
12400 (setq now-done-p (and (member org-state org-done-keywords)
12401 (not (member this org-done-keywords))))
12402 (and logging (org-local-logging logging))
12403 (when (and (or org-todo-log-states org-log-done)
12404 (not (eq org-inhibit-logging t))
12405 (not (memq arg '(nextset previousset))))
12406 ;; we need to look at recording a time and note
12407 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12408 (nth 2 (assoc this org-todo-log-states))))
12409 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12410 (setq dolog 'time))
12411 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12412 (and org-state
12413 (member org-state org-not-done-keywords)
12414 (not (member this org-not-done-keywords))))
12415 ;; This is now a todo state and was not one before
12416 ;; If there was a CLOSED time stamp, get rid of it.
12417 (org-add-planning-info nil nil 'closed))
12418 (when (and now-done-p org-log-done)
12419 ;; It is now done, and it was not done before
12420 (org-add-planning-info 'closed (org-current-effective-time))
12421 (if (and (not dolog) (eq 'note org-log-done))
12422 (org-add-log-setup 'done org-state this 'findpos 'note)))
12423 (when (and org-state dolog)
12424 ;; This is a non-nil state, and we need to log it
12425 (org-add-log-setup 'state org-state this 'findpos dolog)))
12426 ;; Fixup tag positioning
12427 (org-todo-trigger-tag-changes org-state)
12428 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12429 (when org-provide-todo-statistics
12430 (org-update-parent-todo-statistics))
12431 (run-hooks 'org-after-todo-state-change-hook)
12432 (if (and arg (not (member org-state org-done-keywords)))
12433 (setq head (org-get-todo-sequence-head org-state)))
12434 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12435 ;; Do we need to trigger a repeat?
12436 (when now-done-p
12437 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12438 ;; This is for the agenda, take a snapshot of the headline.
12439 (save-match-data
12440 (setq org-agenda-headline-snapshot-before-repeat
12441 (org-get-heading))))
12442 (org-auto-repeat-maybe org-state))
12443 ;; Fixup cursor location if close to the keyword
12444 (if (and (outline-on-heading-p)
12445 (not (bolp))
12446 (save-excursion (beginning-of-line 1)
12447 (looking-at org-todo-line-regexp))
12448 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12449 (progn
12450 (goto-char (or (match-end 2) (match-end 1)))
12451 (and (looking-at " ") (just-one-space))))
12452 (when org-trigger-hook
12453 (save-excursion
12454 (run-hook-with-args 'org-trigger-hook change-plist)))
12455 (when commentp (org-toggle-comment))))))))
12457 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12458 "Block turning an entry into a TODO, using the hierarchy.
12459 This checks whether the current task should be blocked from state
12460 changes. Such blocking occurs when:
12462 1. The task has children which are not all in a completed state.
12464 2. A task has a parent with the property :ORDERED:, and there
12465 are siblings prior to the current task with incomplete
12466 status.
12468 3. The parent of the task is blocked because it has siblings that should
12469 be done first, or is child of a block grandparent TODO entry."
12471 (if (not org-enforce-todo-dependencies)
12472 t ; if locally turned off don't block
12473 (catch 'dont-block
12474 ;; If this is not a todo state change, or if this entry is already DONE,
12475 ;; do not block
12476 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12477 (member (plist-get change-plist :from)
12478 (cons 'done org-done-keywords))
12479 (member (plist-get change-plist :to)
12480 (cons 'todo org-not-done-keywords))
12481 (not (plist-get change-plist :to)))
12482 (throw 'dont-block t))
12483 ;; If this task has children, and any are undone, it's blocked
12484 (save-excursion
12485 (org-back-to-heading t)
12486 (let ((this-level (funcall outline-level)))
12487 (outline-next-heading)
12488 (let ((child-level (funcall outline-level)))
12489 (while (and (not (eobp))
12490 (> child-level this-level))
12491 ;; this todo has children, check whether they are all
12492 ;; completed
12493 (if (and (not (org-entry-is-done-p))
12494 (org-entry-is-todo-p))
12495 (progn (setq org-block-entry-blocking (org-get-heading))
12496 (throw 'dont-block nil)))
12497 (outline-next-heading)
12498 (setq child-level (funcall outline-level))))))
12499 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12500 ;; any previous siblings are undone, it's blocked
12501 (save-excursion
12502 (org-back-to-heading t)
12503 (let* ((pos (point))
12504 (parent-pos (and (org-up-heading-safe) (point))))
12505 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12506 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12507 (forward-line 1)
12508 (re-search-forward org-not-done-heading-regexp pos t))
12509 (setq org-block-entry-blocking (match-string 0))
12510 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12511 ;; Search further up the hierarchy, to see if an ancestor is blocked
12512 (while t
12513 (goto-char parent-pos)
12514 (if (not (looking-at org-not-done-heading-regexp))
12515 (throw 'dont-block t)) ; do not block, parent is not a TODO
12516 (setq pos (point))
12517 (setq parent-pos (and (org-up-heading-safe) (point)))
12518 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12519 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12520 (forward-line 1)
12521 (re-search-forward org-not-done-heading-regexp pos t)
12522 (setq org-block-entry-blocking (org-get-heading)))
12523 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12525 (defcustom org-track-ordered-property-with-tag nil
12526 "Should the ORDERED property also be shown as a tag?
12527 The ORDERED property decides if an entry should require subtasks to be
12528 completed in sequence. Since a property is not very visible, setting
12529 this option means that toggling the ORDERED property with the command
12530 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12531 not relevant for the behavior, but it makes things more visible.
12533 Note that toggling the tag with tags commands will not change the property
12534 and therefore not influence behavior!
12536 This can be t, meaning the tag ORDERED should be used, It can also be a
12537 string to select a different tag for this task."
12538 :group 'org-todo
12539 :type '(choice
12540 (const :tag "No tracking" nil)
12541 (const :tag "Track with ORDERED tag" t)
12542 (string :tag "Use other tag")))
12544 (defun org-toggle-ordered-property ()
12545 "Toggle the ORDERED property of the current entry.
12546 For better visibility, you can track the value of this property with a tag.
12547 See variable `org-track-ordered-property-with-tag'."
12548 (interactive)
12549 (let* ((t1 org-track-ordered-property-with-tag)
12550 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12551 (save-excursion
12552 (org-back-to-heading)
12553 (if (org-entry-get nil "ORDERED")
12554 (progn
12555 (org-delete-property "ORDERED")
12556 (and tag (org-toggle-tag tag 'off))
12557 (message "Subtasks can be completed in arbitrary order"))
12558 (org-entry-put nil "ORDERED" "t")
12559 (and tag (org-toggle-tag tag 'on))
12560 (message "Subtasks must be completed in sequence")))))
12562 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12563 (defun org-block-todo-from-checkboxes (change-plist)
12564 "Block turning an entry into a TODO, using checkboxes.
12565 This checks whether the current task should be blocked from state
12566 changes because there are unchecked boxes in this entry."
12567 (if (not org-enforce-todo-checkbox-dependencies)
12568 t ; if locally turned off don't block
12569 (catch 'dont-block
12570 ;; If this is not a todo state change, or if this entry is already DONE,
12571 ;; do not block
12572 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12573 (member (plist-get change-plist :from)
12574 (cons 'done org-done-keywords))
12575 (member (plist-get change-plist :to)
12576 (cons 'todo org-not-done-keywords))
12577 (not (plist-get change-plist :to)))
12578 (throw 'dont-block t))
12579 ;; If this task has checkboxes that are not checked, it's blocked
12580 (save-excursion
12581 (org-back-to-heading t)
12582 (let ((beg (point)) end)
12583 (outline-next-heading)
12584 (setq end (point))
12585 (goto-char beg)
12586 (if (org-list-search-forward
12587 (concat (org-item-beginning-re)
12588 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12589 "\\[[- ]\\]")
12590 end t)
12591 (progn
12592 (if (boundp 'org-blocked-by-checkboxes)
12593 (setq org-blocked-by-checkboxes t))
12594 (throw 'dont-block nil)))))
12595 t))) ; do not block
12597 (defun org-entry-blocked-p ()
12598 "Is the current entry blocked?"
12599 (org-with-silent-modifications
12600 (if (org-entry-get nil "NOBLOCKING")
12601 nil ;; Never block this entry
12602 (not (run-hook-with-args-until-failure
12603 'org-blocker-hook
12604 (list :type 'todo-state-change
12605 :position (point)
12606 :from 'todo
12607 :to 'done))))))
12609 (defun org-update-statistics-cookies (all)
12610 "Update the statistics cookie, either from TODO or from checkboxes.
12611 This should be called with the cursor in a line with a statistics cookie."
12612 (interactive "P")
12613 (if all
12614 (progn
12615 (org-update-checkbox-count 'all)
12616 (org-map-entries 'org-update-parent-todo-statistics))
12617 (if (not (org-at-heading-p))
12618 (org-update-checkbox-count)
12619 (let ((pos (point-marker))
12620 end l1 l2)
12621 (ignore-errors (org-back-to-heading t))
12622 (if (not (org-at-heading-p))
12623 (org-update-checkbox-count)
12624 (setq l1 (org-outline-level))
12625 (setq end (save-excursion
12626 (outline-next-heading)
12627 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12628 (point)))
12629 (if (and (save-excursion
12630 (re-search-forward
12631 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12632 (not (save-excursion (re-search-forward
12633 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12634 (org-update-checkbox-count)
12635 (if (and l2 (> l2 l1))
12636 (progn
12637 (goto-char end)
12638 (org-update-parent-todo-statistics))
12639 (goto-char pos)
12640 (beginning-of-line 1)
12641 (while (re-search-forward
12642 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12643 (point-at-eol) t)
12644 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12645 (goto-char pos)
12646 (move-marker pos nil)))))
12648 (defvar org-entry-property-inherited-from) ;; defined below
12649 (defun org-update-parent-todo-statistics ()
12650 "Update any statistics cookie in the parent of the current headline.
12651 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12652 the entire subtree and this will travel up the hierarchy and update
12653 statistics everywhere."
12654 (let* ((prop (save-excursion (org-up-heading-safe)
12655 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12656 (recursive (or (not org-hierarchical-todo-statistics)
12657 (and prop (string-match "\\<recursive\\>" prop))))
12658 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12660 (first t)
12661 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12662 level ltoggle l1 new ndel
12663 (cnt-all 0) (cnt-done 0) is-percent kwd
12664 checkbox-beg ov ovs ove cookie-present)
12665 (catch 'exit
12666 (save-excursion
12667 (beginning-of-line 1)
12668 (setq ltoggle (funcall outline-level))
12669 ;; Three situations are to consider:
12671 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12672 ;; to the top-level ancestor on the headline;
12674 ;; 2. If parent has "recursive" property, repeat up to the
12675 ;; headline setting that property, taking inheritance into
12676 ;; account;
12678 ;; 3. Else, move up to direct parent and proceed only once.
12679 (while (and (setq level (org-up-heading-safe))
12680 (or recursive first)
12681 (>= (point) lim))
12682 (setq first nil cookie-present nil)
12683 (unless (and level
12684 (not (string-match
12685 "\\<checkbox\\>"
12686 (downcase (or (org-entry-get nil "COOKIE_DATA")
12687 "")))))
12688 (throw 'exit nil))
12689 (while (re-search-forward box-re (point-at-eol) t)
12690 (setq cnt-all 0 cnt-done 0 cookie-present t)
12691 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12692 (save-match-data
12693 (unless (outline-next-heading) (throw 'exit nil))
12694 (while (and (looking-at org-complex-heading-regexp)
12695 (> (setq l1 (length (match-string 1))) level))
12696 (setq kwd (and (or recursive (= l1 ltoggle))
12697 (match-string 2)))
12698 (if (or (eq org-provide-todo-statistics 'all-headlines)
12699 (and (listp org-provide-todo-statistics)
12700 (or (member kwd org-provide-todo-statistics)
12701 (member kwd org-done-keywords))))
12702 (setq cnt-all (1+ cnt-all))
12703 (if (eq org-provide-todo-statistics t)
12704 (and kwd (setq cnt-all (1+ cnt-all)))))
12705 (and (member kwd org-done-keywords)
12706 (setq cnt-done (1+ cnt-done)))
12707 (outline-next-heading)))
12708 (setq new
12709 (if is-percent
12710 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12711 (format "[%d/%d]" cnt-done cnt-all))
12712 ndel (- (match-end 0) checkbox-beg))
12713 ;; handle overlays when updating cookie from column view
12714 (when (setq ov (car (overlays-at checkbox-beg)))
12715 (setq ovs (overlay-start ov) ove (overlay-end ov))
12716 (delete-overlay ov))
12717 (goto-char checkbox-beg)
12718 (insert new)
12719 (delete-region (point) (+ (point) ndel))
12720 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12721 (when ov (move-overlay ov ovs ove)))
12722 (when cookie-present
12723 (run-hook-with-args 'org-after-todo-statistics-hook
12724 cnt-done (- cnt-all cnt-done))))))
12725 (run-hooks 'org-todo-statistics-hook)))
12727 (defvar org-after-todo-statistics-hook nil
12728 "Hook that is called after a TODO statistics cookie has been updated.
12729 Each function is called with two arguments: the number of not-done entries
12730 and the number of done entries.
12732 For example, the following function, when added to this hook, will switch
12733 an entry to DONE when all children are done, and back to TODO when new
12734 entries are set to a TODO status. Note that this hook is only called
12735 when there is a statistics cookie in the headline!
12737 (defun org-summary-todo (n-done n-not-done)
12738 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12739 (let (org-log-done org-log-states) ; turn off logging
12740 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12743 (defvar org-todo-statistics-hook nil
12744 "Hook that is run whenever Org thinks TODO statistics should be updated.
12745 This hook runs even if there is no statistics cookie present, in which case
12746 `org-after-todo-statistics-hook' would not run.")
12748 (defun org-todo-trigger-tag-changes (state)
12749 "Apply the changes defined in `org-todo-state-tags-triggers'."
12750 (let ((l org-todo-state-tags-triggers)
12751 changes)
12752 (when (or (not state) (equal state ""))
12753 (setq changes (append changes (cdr (assoc "" l)))))
12754 (when (and (stringp state) (> (length state) 0))
12755 (setq changes (append changes (cdr (assoc state l)))))
12756 (when (member state org-not-done-keywords)
12757 (setq changes (append changes (cdr (assoc 'todo l)))))
12758 (when (member state org-done-keywords)
12759 (setq changes (append changes (cdr (assoc 'done l)))))
12760 (dolist (c changes)
12761 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12763 (defun org-local-logging (value)
12764 "Get logging settings from a property VALUE."
12765 (let* (words w a)
12766 ;; directly set the variables, they are already local.
12767 (setq org-log-done nil
12768 org-log-repeat nil
12769 org-todo-log-states nil)
12770 (setq words (org-split-string value))
12771 (while (setq w (pop words))
12772 (cond
12773 ((setq a (assoc w org-startup-options))
12774 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12775 (set (nth 1 a) (nth 2 a))))
12776 ((setq a (org-extract-log-state-settings w))
12777 (and (member (car a) org-todo-keywords-1)
12778 (push a org-todo-log-states)))))))
12780 (defun org-get-todo-sequence-head (kwd)
12781 "Return the head of the TODO sequence to which KWD belongs.
12782 If KWD is not set, check if there is a text property remembering the
12783 right sequence."
12784 (let (p)
12785 (cond
12786 ((not kwd)
12787 (or (get-text-property (point-at-bol) 'org-todo-head)
12788 (progn
12789 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12790 nil (point-at-eol)))
12791 (get-text-property p 'org-todo-head))))
12792 ((not (member kwd org-todo-keywords-1))
12793 (car org-todo-keywords-1))
12794 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12796 (defun org-fast-todo-selection ()
12797 "Fast TODO keyword selection with single keys.
12798 Returns the new TODO keyword, or nil if no state change should occur."
12799 (let* ((fulltable org-todo-key-alist)
12800 (done-keywords org-done-keywords) ;; needed for the faces.
12801 (maxlen (apply 'max (mapcar
12802 (lambda (x)
12803 (if (stringp (car x)) (string-width (car x)) 0))
12804 fulltable)))
12805 (expert nil)
12806 (fwidth (+ maxlen 3 1 3))
12807 (ncol (/ (- (window-width) 4) fwidth))
12808 tg cnt e c tbl
12809 groups ingroup)
12810 (save-excursion
12811 (save-window-excursion
12812 (if expert
12813 (set-buffer (get-buffer-create " *Org todo*"))
12814 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12815 (erase-buffer)
12816 (org-set-local 'org-done-keywords done-keywords)
12817 (setq tbl fulltable cnt 0)
12818 (while (setq e (pop tbl))
12819 (cond
12820 ((equal e '(:startgroup))
12821 (push '() groups) (setq ingroup t)
12822 (when (not (= cnt 0))
12823 (setq cnt 0)
12824 (insert "\n"))
12825 (insert "{ "))
12826 ((equal e '(:endgroup))
12827 (setq ingroup nil cnt 0)
12828 (insert "}\n"))
12829 ((equal e '(:newline))
12830 (when (not (= cnt 0))
12831 (setq cnt 0)
12832 (insert "\n")
12833 (setq e (car tbl))
12834 (while (equal (car tbl) '(:newline))
12835 (insert "\n")
12836 (setq tbl (cdr tbl)))))
12838 (setq tg (car e) c (cdr e))
12839 (if ingroup (push tg (car groups)))
12840 (setq tg (org-add-props tg nil 'face
12841 (org-get-todo-face tg)))
12842 (if (and (= cnt 0) (not ingroup)) (insert " "))
12843 (insert "[" c "] " tg (make-string
12844 (- fwidth 4 (length tg)) ?\ ))
12845 (when (= (setq cnt (1+ cnt)) ncol)
12846 (insert "\n")
12847 (if ingroup (insert " "))
12848 (setq cnt 0)))))
12849 (insert "\n")
12850 (goto-char (point-min))
12851 (if (not expert) (org-fit-window-to-buffer))
12852 (message "[a-z..]:Set [SPC]:clear")
12853 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12854 (cond
12855 ((or (= c ?\C-g)
12856 (and (= c ?q) (not (rassoc c fulltable))))
12857 (setq quit-flag t))
12858 ((= c ?\ ) nil)
12859 ((setq e (rassoc c fulltable) tg (car e))
12861 (t (setq quit-flag t)))))))
12863 (defun org-entry-is-todo-p ()
12864 (member (org-get-todo-state) org-not-done-keywords))
12866 (defun org-entry-is-done-p ()
12867 (member (org-get-todo-state) org-done-keywords))
12869 (defun org-get-todo-state ()
12870 "Return the TODO keyword of the current subtree."
12871 (save-excursion
12872 (org-back-to-heading t)
12873 (and (looking-at org-todo-line-regexp)
12874 (match-end 2)
12875 (match-string 2))))
12877 (defun org-at-date-range-p (&optional inactive-ok)
12878 "Is the cursor inside a date range?"
12879 (interactive)
12880 (save-excursion
12881 (catch 'exit
12882 (let ((pos (point)))
12883 (skip-chars-backward "^[<\r\n")
12884 (skip-chars-backward "<[")
12885 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12886 (>= (match-end 0) pos)
12887 (throw 'exit t))
12888 (skip-chars-backward "^<[\r\n")
12889 (skip-chars-backward "<[")
12890 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12891 (>= (match-end 0) pos)
12892 (throw 'exit t)))
12893 nil)))
12895 (defun org-get-repeat (&optional tagline)
12896 "Check if there is a deadline/schedule with repeater in this entry."
12897 (save-match-data
12898 (save-excursion
12899 (org-back-to-heading t)
12900 (and (re-search-forward (if tagline
12901 (concat tagline "\\s-*" org-repeat-re)
12902 org-repeat-re)
12903 (org-entry-end-position) t)
12904 (match-string-no-properties 1)))))
12906 (defvar org-last-changed-timestamp)
12907 (defvar org-last-inserted-timestamp)
12908 (defvar org-log-post-message)
12909 (defvar org-log-note-purpose)
12910 (defvar org-log-note-how)
12911 (defvar org-log-note-extra)
12912 (defun org-auto-repeat-maybe (done-word)
12913 "Check if the current headline contains a repeated deadline/schedule.
12914 If yes, set TODO state back to what it was and change the base date
12915 of repeating deadline/scheduled time stamps to new date.
12916 This function is run automatically after each state change to a DONE state."
12917 ;; last-state is dynamically scoped into this function
12918 (let* ((repeat (org-get-repeat))
12919 (aa (assoc org-last-state org-todo-kwd-alist))
12920 (interpret (nth 1 aa))
12921 (head (nth 2 aa))
12922 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12923 (msg "Entry repeats: ")
12924 (org-log-done nil)
12925 (org-todo-log-states nil)
12926 re type n what ts time to-state)
12927 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
12928 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12929 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12930 org-todo-repeat-to-state))
12931 (unless (and to-state (member to-state org-todo-keywords-1))
12932 (setq to-state (if (eq interpret 'type) org-last-state head)))
12933 (org-todo to-state)
12934 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12935 (org-entry-put nil "LAST_REPEAT" (format-time-string
12936 (org-time-stamp-format t t))))
12937 (when org-log-repeat
12938 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12939 (memq 'org-add-log-note post-command-hook))
12940 ;; OK, we are already setup for some record
12941 (if (eq org-log-repeat 'note)
12942 ;; make sure we take a note, not only a time stamp
12943 (setq org-log-note-how 'note))
12944 ;; Set up for taking a record
12945 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12946 org-last-state
12947 'findpos org-log-repeat)))
12948 (org-back-to-heading t)
12949 (org-add-planning-info nil nil 'closed)
12950 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12951 org-deadline-time-regexp "\\)\\|\\("
12952 org-ts-regexp "\\)"))
12953 (while (re-search-forward
12954 re (save-excursion (outline-next-heading) (point)) t)
12955 (setq type (if (match-end 1) org-scheduled-string
12956 (if (match-end 3) org-deadline-string "Plain:"))
12957 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12958 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12959 (setq n (string-to-number (match-string 2 ts))
12960 what (match-string 3 ts))
12961 (if (equal what "w") (setq n (* n 7) what "d"))
12962 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12963 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12964 ;; Preparation, see if we need to modify the start date for the change
12965 (when (match-end 1)
12966 (setq time (save-match-data (org-time-string-to-time ts)))
12967 (cond
12968 ((equal (match-string 1 ts) ".")
12969 ;; Shift starting date to today
12970 (org-timestamp-change
12971 (- (org-today) (time-to-days time))
12972 'day))
12973 ((equal (match-string 1 ts) "+")
12974 (let ((nshiftmax 10) (nshift 0))
12975 (while (or (= nshift 0)
12976 (<= (time-to-days time)
12977 (time-to-days (current-time))))
12978 (when (= (incf nshift) nshiftmax)
12979 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12980 (error "Abort")))
12981 (org-timestamp-change n (cdr (assoc what whata)))
12982 (org-at-timestamp-p t)
12983 (setq ts (match-string 1))
12984 (setq time (save-match-data (org-time-string-to-time ts)))))
12985 (org-timestamp-change (- n) (cdr (assoc what whata)))
12986 ;; rematch, so that we have everything in place for the real shift
12987 (org-at-timestamp-p t)
12988 (setq ts (match-string 1))
12989 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
12990 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
12991 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
12992 (setq org-log-post-message msg)
12993 (message "%s" msg))))
12995 (defun org-show-todo-tree (arg)
12996 "Make a compact tree which shows all headlines marked with TODO.
12997 The tree will show the lines where the regexp matches, and all higher
12998 headlines above the match.
12999 With a \\[universal-argument] prefix, prompt for a regexp to match.
13000 With a numeric prefix N, construct a sparse tree for the Nth element
13001 of `org-todo-keywords-1'."
13002 (interactive "P")
13003 (let ((case-fold-search nil)
13004 (kwd-re
13005 (cond ((null arg) org-not-done-regexp)
13006 ((equal arg '(4))
13007 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13008 (mapcar 'list org-todo-keywords-1))))
13009 (concat "\\("
13010 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13011 "\\)\\>")))
13012 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13013 (regexp-quote (nth (1- (prefix-numeric-value arg))
13014 org-todo-keywords-1)))
13015 (t (user-error "Invalid prefix argument: %s" arg)))))
13016 (message "%d TODO entries found"
13017 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13019 (defun org-deadline (arg &optional time)
13020 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13021 With one universal prefix argument, remove any deadline from the item.
13022 With two universal prefix arguments, prompt for a warning delay.
13023 With argument TIME, set the deadline at the corresponding date. TIME
13024 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13025 (interactive "P")
13026 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13027 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13028 'region-start-level 'region))
13029 org-loop-over-headlines-in-active-region)
13030 (org-map-entries
13031 `(org-deadline ',arg ,time)
13032 org-loop-over-headlines-in-active-region
13033 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13034 (let* ((old-date (org-entry-get nil "DEADLINE"))
13035 (old-date-time (if old-date (org-time-string-to-time old-date)))
13036 (repeater (and old-date
13037 (string-match
13038 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13039 old-date)
13040 (match-string 1 old-date))))
13041 (cond
13042 ((equal arg '(4))
13043 (when (and old-date org-log-redeadline)
13044 (org-add-log-setup 'deldeadline nil old-date 'findpos
13045 org-log-redeadline))
13046 (org-remove-timestamp-with-keyword org-deadline-string)
13047 (message "Item no longer has a deadline."))
13048 ((equal arg '(16))
13049 (save-excursion
13050 (org-back-to-heading t)
13051 (if (re-search-forward
13052 org-deadline-time-regexp
13053 (save-excursion (outline-next-heading) (point)) t)
13054 (let* ((rpl0 (match-string 1))
13055 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13056 (replace-match
13057 (concat org-deadline-string
13058 " <" rpl
13059 (format " -%dd"
13060 (abs
13061 (- (time-to-days
13062 (save-match-data
13063 (org-read-date nil t nil "Warn starting from" old-date-time)))
13064 (time-to-days old-date-time))))
13065 ">") t t))
13066 (user-error "No deadline information to update"))))
13068 (org-add-planning-info 'deadline time 'closed)
13069 (when (and old-date org-log-redeadline
13070 (not (equal old-date
13071 (substring org-last-inserted-timestamp 1 -1))))
13072 (org-add-log-setup 'redeadline nil old-date 'findpos
13073 org-log-redeadline))
13074 (when repeater
13075 (save-excursion
13076 (org-back-to-heading t)
13077 (when (re-search-forward (concat org-deadline-string " "
13078 org-last-inserted-timestamp)
13079 (save-excursion
13080 (outline-next-heading) (point)) t)
13081 (goto-char (1- (match-end 0)))
13082 (insert " " repeater)
13083 (setq org-last-inserted-timestamp
13084 (concat (substring org-last-inserted-timestamp 0 -1)
13085 " " repeater
13086 (substring org-last-inserted-timestamp -1))))))
13087 (message "Deadline on %s" org-last-inserted-timestamp))))))
13089 (defun org-schedule (arg &optional time)
13090 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13091 With one universal prefix argument, remove any scheduling date from the item.
13092 With two universal prefix arguments, prompt for a delay cookie.
13093 With argument TIME, scheduled at the corresponding date. TIME can
13094 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13095 (interactive "P")
13096 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13097 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13098 'region-start-level 'region))
13099 org-loop-over-headlines-in-active-region)
13100 (org-map-entries
13101 `(org-schedule ',arg ,time)
13102 org-loop-over-headlines-in-active-region
13103 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13104 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13105 (old-date-time (if old-date (org-time-string-to-time old-date)))
13106 (repeater (and old-date
13107 (string-match
13108 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13109 old-date)
13110 (match-string 1 old-date))))
13111 (cond
13112 ((equal arg '(4))
13113 (progn
13114 (when (and old-date org-log-reschedule)
13115 (org-add-log-setup 'delschedule nil old-date 'findpos
13116 org-log-reschedule))
13117 (org-remove-timestamp-with-keyword org-scheduled-string)
13118 (message "Item is no longer scheduled.")))
13119 ((equal arg '(16))
13120 (save-excursion
13121 (org-back-to-heading t)
13122 (if (re-search-forward
13123 org-scheduled-time-regexp
13124 (save-excursion (outline-next-heading) (point)) t)
13125 (let* ((rpl0 (match-string 1))
13126 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13127 (replace-match
13128 (concat org-scheduled-string
13129 " <" rpl
13130 (format " -%dd"
13131 (abs
13132 (- (time-to-days
13133 (save-match-data
13134 (org-read-date nil t nil "Delay until" old-date-time)))
13135 (time-to-days old-date-time))))
13136 ">") t t))
13137 (user-error "No scheduled information to update"))))
13139 (org-add-planning-info 'scheduled time 'closed)
13140 (when (and old-date org-log-reschedule
13141 (not (equal old-date
13142 (substring org-last-inserted-timestamp 1 -1))))
13143 (org-add-log-setup 'reschedule nil old-date 'findpos
13144 org-log-reschedule))
13145 (when repeater
13146 (save-excursion
13147 (org-back-to-heading t)
13148 (when (re-search-forward (concat org-scheduled-string " "
13149 org-last-inserted-timestamp)
13150 (save-excursion
13151 (outline-next-heading) (point)) t)
13152 (goto-char (1- (match-end 0)))
13153 (insert " " repeater)
13154 (setq org-last-inserted-timestamp
13155 (concat (substring org-last-inserted-timestamp 0 -1)
13156 " " repeater
13157 (substring org-last-inserted-timestamp -1))))))
13158 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13160 (defun org-get-scheduled-time (pom &optional inherit)
13161 "Get the scheduled time as a time tuple, of a format suitable
13162 for calling org-schedule with, or if there is no scheduling,
13163 returns nil."
13164 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13165 (when time
13166 (apply 'encode-time (org-parse-time-string time)))))
13168 (defun org-get-deadline-time (pom &optional inherit)
13169 "Get the deadline as a time tuple, of a format suitable for
13170 calling org-deadline with, or if there is no scheduling, returns
13171 nil."
13172 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13173 (when time
13174 (apply 'encode-time (org-parse-time-string time)))))
13176 (defun org-remove-timestamp-with-keyword (keyword)
13177 "Remove all time stamps with KEYWORD in the current entry."
13178 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13179 beg)
13180 (save-excursion
13181 (org-back-to-heading t)
13182 (setq beg (point))
13183 (outline-next-heading)
13184 (while (re-search-backward re beg t)
13185 (replace-match "")
13186 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13187 (equal (char-before) ?\ ))
13188 (backward-delete-char 1)
13189 (if (string-match "^[ \t]*$" (buffer-substring
13190 (point-at-bol) (point-at-eol)))
13191 (delete-region (point-at-bol)
13192 (min (point-max) (1+ (point-at-eol))))))))))
13194 (defvar org-time-was-given) ; dynamically scoped parameter
13195 (defvar org-end-time-was-given) ; dynamically scoped parameter
13197 (defun org-add-planning-info (what &optional time &rest remove)
13198 "Insert new timestamp with keyword in the line directly after the headline.
13199 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13200 If non is given, the user is prompted for a date.
13201 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13202 be removed."
13203 (interactive)
13204 (let (org-time-was-given org-end-time-was-given ts
13205 end default-time default-input)
13207 (catch 'exit
13208 (when (and (memq what '(scheduled deadline))
13209 (or (not time)
13210 (and (stringp time)
13211 (string-match "^[-+]+[0-9]" time))))
13212 ;; Try to get a default date/time from existing timestamp
13213 (save-excursion
13214 (org-back-to-heading t)
13215 (setq end (save-excursion (outline-next-heading) (point)))
13216 (when (re-search-forward (if (eq what 'scheduled)
13217 org-scheduled-time-regexp
13218 org-deadline-time-regexp)
13219 end t)
13220 (setq ts (match-string 1)
13221 default-time
13222 (apply 'encode-time (org-parse-time-string ts))
13223 default-input (and ts (org-get-compact-tod ts))))))
13224 (when what
13225 (setq time
13226 (if (stringp time)
13227 ;; This is a string (relative or absolute), set proper date
13228 (apply 'encode-time
13229 (org-read-date-analyze
13230 time default-time (decode-time default-time)))
13231 ;; If necessary, get the time from the user
13232 (or time (org-read-date nil 'to-time nil nil
13233 default-time default-input)))))
13235 (when (and org-insert-labeled-timestamps-at-point
13236 (member what '(scheduled deadline)))
13237 (insert
13238 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13239 (org-insert-time-stamp time org-time-was-given
13240 nil nil nil (list org-end-time-was-given))
13241 (setq what nil))
13242 (save-excursion
13243 (save-restriction
13244 (let (col list elt ts buffer-invisibility-spec)
13245 (org-back-to-heading t)
13246 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13247 (goto-char (match-end 1))
13248 (setq col (current-column))
13249 (goto-char (match-end 0))
13250 (if (eobp) (insert "\n") (forward-char 1))
13251 (when (and (not what)
13252 (not (looking-at
13253 (concat "[ \t]*"
13254 org-keyword-time-not-clock-regexp))))
13255 ;; Nothing to add, nothing to remove...... :-)
13256 (throw 'exit nil))
13257 (if (and (not (looking-at org-outline-regexp))
13258 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13259 "[^\r\n]*"))
13260 (not (equal (match-string 1) org-clock-string)))
13261 (narrow-to-region (match-beginning 0) (match-end 0))
13262 (insert-before-markers "\n")
13263 (backward-char 1)
13264 (narrow-to-region (point) (point))
13265 (and org-adapt-indentation (org-indent-to-column col)))
13266 ;; Check if we have to remove something.
13267 (setq list (cons what remove))
13268 (while list
13269 (setq elt (pop list))
13270 (when (or (and (eq elt 'scheduled)
13271 (re-search-forward org-scheduled-time-regexp nil t))
13272 (and (eq elt 'deadline)
13273 (re-search-forward org-deadline-time-regexp nil t))
13274 (and (eq elt 'closed)
13275 (re-search-forward org-closed-time-regexp nil t)))
13276 (replace-match "")
13277 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13278 (and (looking-at "[ \t]+") (replace-match ""))
13279 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13280 (when what
13281 (insert
13282 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13283 (cond ((eq what 'scheduled) org-scheduled-string)
13284 ((eq what 'deadline) org-deadline-string)
13285 ((eq what 'closed) org-closed-string))
13286 " ")
13287 (setq ts (org-insert-time-stamp
13288 time
13289 (or org-time-was-given
13290 (and (eq what 'closed) org-log-done-with-time))
13291 (eq what 'closed)
13292 nil nil (list org-end-time-was-given)))
13293 (insert
13294 (if (not (or (bolp) (eq (char-before) ?\ )
13295 (memq (char-after) '(32 10))
13296 (eobp))) " " ""))
13297 (end-of-line 1))
13298 (goto-char (point-min))
13299 (widen)
13300 (if (and (looking-at "[ \t]*\n")
13301 (equal (char-before) ?\n))
13302 (delete-region (1- (point)) (point-at-eol)))
13303 ts))))))
13305 (defvar org-log-note-marker (make-marker))
13306 (defvar org-log-note-purpose nil)
13307 (defvar org-log-note-state nil)
13308 (defvar org-log-note-previous-state nil)
13309 (defvar org-log-note-how nil)
13310 (defvar org-log-note-extra nil)
13311 (defvar org-log-note-window-configuration nil)
13312 (defvar org-log-note-return-to (make-marker))
13313 (defvar org-log-note-effective-time nil
13314 "Remembered current time so that dynamically scoped
13315 `org-extend-today-until' affects tha timestamps in state change
13316 log")
13318 (defvar org-log-post-message nil
13319 "Message to be displayed after a log note has been stored.
13320 The auto-repeater uses this.")
13322 (defun org-add-note ()
13323 "Add a note to the current entry.
13324 This is done in the same way as adding a state change note."
13325 (interactive)
13326 (org-add-log-setup 'note nil nil 'findpos nil))
13328 (defvar org-property-end-re)
13329 (defun org-add-log-setup (&optional purpose state prev-state
13330 findpos how extra)
13331 "Set up the post command hook to take a note.
13332 If this is about to TODO state change, the new state is expected in STATE.
13333 When FINDPOS is non-nil, find the correct position for the note in
13334 the current entry. If not, assume that it can be inserted at point.
13335 HOW is an indicator what kind of note should be created.
13336 EXTRA is additional text that will be inserted into the notes buffer."
13337 (let* ((org-log-into-drawer (org-log-into-drawer))
13338 (drawer (cond ((stringp org-log-into-drawer)
13339 org-log-into-drawer)
13340 (org-log-into-drawer "LOGBOOK"))))
13341 (save-restriction
13342 (save-excursion
13343 (when findpos
13344 (org-back-to-heading t)
13345 (narrow-to-region (point) (save-excursion
13346 (outline-next-heading) (point)))
13347 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13348 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13349 "[^\r\n]*\\)?"))
13350 (goto-char (match-end 0))
13351 (cond
13352 (drawer
13353 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13354 nil t)
13355 (progn
13356 (goto-char (match-end 0))
13357 (or org-log-states-order-reversed
13358 (and (re-search-forward org-property-end-re nil t)
13359 (goto-char (1- (match-beginning 0))))))
13360 (insert "\n:" drawer ":\n:END:")
13361 (beginning-of-line 0)
13362 (org-indent-line)
13363 (beginning-of-line 2)
13364 (org-indent-line)
13365 (end-of-line 0)))
13366 ((and org-log-state-notes-insert-after-drawers
13367 (save-excursion
13368 (forward-line) (looking-at org-drawer-regexp)))
13369 (forward-line)
13370 (while (looking-at org-drawer-regexp)
13371 (goto-char (match-end 0))
13372 (re-search-forward org-property-end-re (point-max) t)
13373 (forward-line))
13374 (forward-line -1)))
13375 (unless org-log-states-order-reversed
13376 (and (= (char-after) ?\n) (forward-char 1))
13377 (org-skip-over-state-notes)
13378 (skip-chars-backward " \t\n\r")))
13379 (move-marker org-log-note-marker (point))
13380 (setq org-log-note-purpose purpose
13381 org-log-note-state state
13382 org-log-note-previous-state prev-state
13383 org-log-note-how how
13384 org-log-note-extra extra
13385 org-log-note-effective-time (org-current-effective-time))
13386 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13388 (defun org-skip-over-state-notes ()
13389 "Skip past the list of State notes in an entry."
13390 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13391 (when (ignore-errors (goto-char (org-in-item-p)))
13392 (let* ((struct (org-list-struct))
13393 (prevs (org-list-prevs-alist struct)))
13394 (while (looking-at "[ \t]*- State")
13395 (goto-char (or (org-list-get-next-item (point) struct prevs)
13396 (org-list-get-item-end (point) struct)))))))
13398 (defun org-add-log-note (&optional purpose)
13399 "Pop up a window for taking a note, and add this note later at point."
13400 (remove-hook 'post-command-hook 'org-add-log-note)
13401 (setq org-log-note-window-configuration (current-window-configuration))
13402 (delete-other-windows)
13403 (move-marker org-log-note-return-to (point))
13404 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13405 (goto-char org-log-note-marker)
13406 (org-switch-to-buffer-other-window "*Org Note*")
13407 (erase-buffer)
13408 (if (memq org-log-note-how '(time state))
13409 (let (current-prefix-arg) (org-store-log-note))
13410 (let ((org-inhibit-startup t)) (org-mode))
13411 (insert (format "# Insert note for %s.
13412 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13413 (cond
13414 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13415 ((eq org-log-note-purpose 'done) "closed todo item")
13416 ((eq org-log-note-purpose 'state)
13417 (format "state change from \"%s\" to \"%s\""
13418 (or org-log-note-previous-state "")
13419 (or org-log-note-state "")))
13420 ((eq org-log-note-purpose 'reschedule)
13421 "rescheduling")
13422 ((eq org-log-note-purpose 'delschedule)
13423 "no longer scheduled")
13424 ((eq org-log-note-purpose 'redeadline)
13425 "changing deadline")
13426 ((eq org-log-note-purpose 'deldeadline)
13427 "removing deadline")
13428 ((eq org-log-note-purpose 'refile)
13429 "refiling")
13430 ((eq org-log-note-purpose 'note)
13431 "this entry")
13432 (t (error "This should not happen")))))
13433 (if org-log-note-extra (insert org-log-note-extra))
13434 (org-set-local 'org-finish-function 'org-store-log-note)
13435 (run-hooks 'org-log-buffer-setup-hook)))
13437 (defvar org-note-abort nil) ; dynamically scoped
13438 (defun org-store-log-note ()
13439 "Finish taking a log note, and insert it to where it belongs."
13440 (let ((txt (buffer-string)))
13441 (kill-buffer (current-buffer))
13442 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13443 lines ind bul)
13444 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13445 (setq txt (replace-match "" t t txt)))
13446 (if (string-match "\\s-+\\'" txt)
13447 (setq txt (replace-match "" t t txt)))
13448 (setq lines (org-split-string txt "\n"))
13449 (when (and note (string-match "\\S-" note))
13450 (setq note
13451 (org-replace-escapes
13452 note
13453 (list (cons "%u" (user-login-name))
13454 (cons "%U" user-full-name)
13455 (cons "%t" (format-time-string
13456 (org-time-stamp-format 'long 'inactive)
13457 org-log-note-effective-time))
13458 (cons "%T" (format-time-string
13459 (org-time-stamp-format 'long nil)
13460 org-log-note-effective-time))
13461 (cons "%d" (format-time-string
13462 (org-time-stamp-format nil 'inactive)
13463 org-log-note-effective-time))
13464 (cons "%D" (format-time-string
13465 (org-time-stamp-format nil nil)
13466 org-log-note-effective-time))
13467 (cons "%s" (if org-log-note-state
13468 (concat "\"" org-log-note-state "\"")
13469 ""))
13470 (cons "%S" (if org-log-note-previous-state
13471 (concat "\"" org-log-note-previous-state "\"")
13472 "\"\"")))))
13473 (if lines (setq note (concat note " \\\\")))
13474 (push note lines))
13475 (when (or current-prefix-arg org-note-abort)
13476 (when org-log-into-drawer
13477 (org-remove-empty-drawer-at org-log-note-marker))
13478 (setq lines nil))
13479 (when lines
13480 (with-current-buffer (marker-buffer org-log-note-marker)
13481 (save-excursion
13482 (goto-char org-log-note-marker)
13483 (move-marker org-log-note-marker nil)
13484 (end-of-line 1)
13485 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13486 (setq ind (save-excursion
13487 (if (ignore-errors (goto-char (org-in-item-p)))
13488 (let ((struct (org-list-struct)))
13489 (org-list-get-ind
13490 (org-list-get-top-point struct) struct))
13491 (skip-chars-backward " \r\t\n")
13492 (cond
13493 ((and (org-at-heading-p)
13494 org-adapt-indentation)
13495 (1+ (org-current-level)))
13496 ((org-at-heading-p) 0)
13497 (t (org-get-indentation))))))
13498 (setq bul (org-list-bullet-string "-"))
13499 (org-indent-line-to ind)
13500 (insert bul (pop lines))
13501 (let ((ind-body (+ (length bul) ind)))
13502 (while lines
13503 (insert "\n")
13504 (org-indent-line-to ind-body)
13505 (insert (pop lines))))
13506 (message "Note stored")
13507 (org-back-to-heading t)
13508 (org-cycle-hide-drawers 'children))
13509 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13510 ;; from within `org-add-log-note' because `buffer-undo-list'
13511 ;; is then modified outside of `org-with-remote-undo'.
13512 (when (eq this-command 'org-agenda-todo)
13513 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13514 ;; Don't add undo information when called from `org-agenda-todo'
13515 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13516 (set-window-configuration org-log-note-window-configuration)
13517 (with-current-buffer (marker-buffer org-log-note-return-to)
13518 (goto-char org-log-note-return-to))
13519 (move-marker org-log-note-return-to nil)
13520 (and org-log-post-message (message "%s" org-log-post-message))))
13522 (defun org-remove-empty-drawer-at (pos)
13523 "Remove an empty drawer at position POS.
13524 POS may also be a marker."
13525 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13526 (org-with-wide-buffer
13527 (goto-char pos)
13528 (let ((drawer (org-element-at-point)))
13529 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13530 (not (org-element-property :contents-begin drawer)))
13531 (delete-region (org-element-property :begin drawer)
13532 (progn (goto-char (org-element-property :end drawer))
13533 (skip-chars-backward " \r\t\n")
13534 (forward-line)
13535 (point))))))))
13537 (defvar org-ts-type nil)
13538 (defun org-sparse-tree (&optional arg type)
13539 "Create a sparse tree, prompt for the details.
13540 This command can create sparse trees. You first need to select the type
13541 of match used to create the tree:
13543 t Show all TODO entries.
13544 T Show entries with a specific TODO keyword.
13545 m Show entries selected by a tags/property match.
13546 p Enter a property name and its value (both with completion on existing
13547 names/values) and show entries with that property.
13548 r Show entries matching a regular expression (`/' can be used as well).
13549 b Show deadlines and scheduled items before a date.
13550 a Show deadlines and scheduled items after a date.
13551 d Show deadlines due within `org-deadline-warning-days'.
13552 D Show deadlines and scheduled items between a date range."
13553 (interactive "P")
13554 (let (ans kwd value ts-type)
13555 (setq type (or type org-sparse-tree-default-date-type))
13556 (setq org-ts-type type)
13557 (message "Sparse tree: [/]regexp [t]odo [T]odo-kwd [m]atch [p]roperty\n [d]eadlines [b]efore-date [a]fter-date [D]ates range\n [c]ycle through date types: %s"
13558 (cond ((eq type 'all) "all timestamps")
13559 ((eq type 'scheduled) "only scheduled")
13560 ((eq type 'deadline) "only deadline")
13561 ((eq type 'active) "only active timestamps")
13562 ((eq type 'inactive) "only inactive timestamps")
13563 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13564 ((eq type 'closed) "with a closed time-stamp")
13565 (t "scheduled/deadline")))
13566 (setq ans (read-char-exclusive))
13567 (cond
13568 ((equal ans ?c)
13569 (org-sparse-tree
13570 arg (cadr (member type '(scheduled-or-deadline
13571 all scheduled deadline active inactive closed)))))
13572 ((equal ans ?d)
13573 (call-interactively 'org-check-deadlines))
13574 ((equal ans ?b)
13575 (call-interactively 'org-check-before-date))
13576 ((equal ans ?a)
13577 (call-interactively 'org-check-after-date))
13578 ((equal ans ?D)
13579 (call-interactively 'org-check-dates-range))
13580 ((equal ans ?t)
13581 (call-interactively 'org-show-todo-tree))
13582 ((equal ans ?T)
13583 (org-show-todo-tree '(4)))
13584 ((member ans '(?T ?m))
13585 (call-interactively 'org-match-sparse-tree))
13586 ((member ans '(?p ?P))
13587 (setq kwd (org-icompleting-read "Property: "
13588 (mapcar 'list (org-buffer-property-keys))))
13589 (setq value (org-icompleting-read "Value: "
13590 (mapcar 'list (org-property-values kwd))))
13591 (unless (string-match "\\`{.*}\\'" value)
13592 (setq value (concat "\"" value "\"")))
13593 (org-match-sparse-tree arg (concat kwd "=" value)))
13594 ((member ans '(?r ?R ?/))
13595 (call-interactively 'org-occur))
13596 (t (user-error "No such sparse tree command \"%c\"" ans)))))
13598 (defvar org-occur-highlights nil
13599 "List of overlays used for occur matches.")
13600 (make-variable-buffer-local 'org-occur-highlights)
13601 (defvar org-occur-parameters nil
13602 "Parameters of the active org-occur calls.
13603 This is a list, each call to org-occur pushes as cons cell,
13604 containing the regular expression and the callback, onto the list.
13605 The list can contain several entries if `org-occur' has been called
13606 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13607 will only contain one set of parameters. When the highlights are
13608 removed (for example with `C-c C-c', or with the next edit (depending
13609 on `org-remove-highlights-with-change'), this variable is emptied
13610 as well.")
13611 (make-variable-buffer-local 'org-occur-parameters)
13613 (defun org-occur (regexp &optional keep-previous callback)
13614 "Make a compact tree which shows all matches of REGEXP.
13615 The tree will show the lines where the regexp matches, and all higher
13616 headlines above the match. It will also show the heading after the match,
13617 to make sure editing the matching entry is easy.
13618 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13619 call to `org-occur' will be kept, to allow stacking of calls to this
13620 command.
13621 If CALLBACK is non-nil, it is a function which is called to confirm
13622 that the match should indeed be shown."
13623 (interactive "sRegexp: \nP")
13624 (when (equal regexp "")
13625 (user-error "Regexp cannot be empty"))
13626 (unless keep-previous
13627 (org-remove-occur-highlights nil nil t))
13628 (push (cons regexp callback) org-occur-parameters)
13629 (let ((cnt 0))
13630 (save-excursion
13631 (goto-char (point-min))
13632 (if (or (not keep-previous) ; do not want to keep
13633 (not org-occur-highlights)) ; no previous matches
13634 ;; hide everything
13635 (org-overview))
13636 (while (re-search-forward regexp nil t)
13637 (when (or (not callback)
13638 (save-match-data (funcall callback)))
13639 (setq cnt (1+ cnt))
13640 (when org-highlight-sparse-tree-matches
13641 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13642 (org-show-context 'occur-tree))))
13643 (when org-remove-highlights-with-change
13644 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13645 nil 'local))
13646 (unless org-sparse-tree-open-archived-trees
13647 (org-hide-archived-subtrees (point-min) (point-max)))
13648 (run-hooks 'org-occur-hook)
13649 (if (org-called-interactively-p 'interactive)
13650 (message "%d match(es) for regexp %s" cnt regexp))
13651 cnt))
13653 (defun org-occur-next-match (&optional n reset)
13654 "Function for `next-error-function' to find sparse tree matches.
13655 N is the number of matches to move, when negative move backwards.
13656 RESET is entirely ignored - this function always goes back to the
13657 starting point when no match is found."
13658 (let* ((limit (if (< n 0) (point-min) (point-max)))
13659 (search-func (if (< n 0)
13660 'previous-single-char-property-change
13661 'next-single-char-property-change))
13662 (n (abs n))
13663 (pos (point))
13665 (catch 'exit
13666 (while (setq p1 (funcall search-func (point) 'org-type))
13667 (when (equal p1 limit)
13668 (goto-char pos)
13669 (error "No more matches"))
13670 (when (equal (get-char-property p1 'org-type) 'org-occur)
13671 (setq n (1- n))
13672 (when (= n 0)
13673 (goto-char p1)
13674 (throw 'exit (point))))
13675 (goto-char p1))
13676 (goto-char p1)
13677 (error "No more matches"))))
13679 (defun org-show-context (&optional key)
13680 "Make sure point and context are visible.
13681 How much context is shown depends upon the variables
13682 `org-show-hierarchy-above', `org-show-following-heading',
13683 `org-show-entry-below' and `org-show-siblings'."
13684 (let ((heading-p (org-at-heading-p t))
13685 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13686 (following-p (org-get-alist-option org-show-following-heading key))
13687 (entry-p (org-get-alist-option org-show-entry-below key))
13688 (siblings-p (org-get-alist-option org-show-siblings key)))
13689 ;; Show heading or entry text
13690 (if (and heading-p (not entry-p))
13691 (org-flag-heading nil) ; only show the heading
13692 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13693 (org-show-hidden-entry))) ; show entire entry
13694 (when following-p
13695 ;; Show next sibling, or heading below text
13696 (save-excursion
13697 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13698 (org-flag-heading nil))))
13699 (when siblings-p (org-show-siblings))
13700 (when hierarchy-p
13701 ;; show all higher headings, possibly with siblings
13702 (save-excursion
13703 (while (and (condition-case nil
13704 (progn (org-up-heading-all 1) t)
13705 (error nil))
13706 (not (bobp)))
13707 (org-flag-heading nil)
13708 (when siblings-p (org-show-siblings)))))
13709 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13711 (defvar org-reveal-start-hook nil
13712 "Hook run before revealing a location.")
13714 (defun org-reveal (&optional siblings)
13715 "Show current entry, hierarchy above it, and the following headline.
13716 This can be used to show a consistent set of context around locations
13717 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13718 not t for the search context.
13720 With optional argument SIBLINGS, on each level of the hierarchy all
13721 siblings are shown. This repairs the tree structure to what it would
13722 look like when opened with hierarchical calls to `org-cycle'.
13723 With double optional argument \\[universal-argument] \\[universal-argument], \
13724 go to the parent and show the
13725 entire tree."
13726 (interactive "P")
13727 (run-hooks 'org-reveal-start-hook)
13728 (let ((org-show-hierarchy-above t)
13729 (org-show-following-heading t)
13730 (org-show-siblings (if siblings t org-show-siblings)))
13731 (org-show-context nil))
13732 (when (equal siblings '(16))
13733 (save-excursion
13734 (when (org-up-heading-safe)
13735 (org-show-subtree)
13736 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13738 (defun org-highlight-new-match (beg end)
13739 "Highlight from BEG to END and mark the highlight is an occur headline."
13740 (let ((ov (make-overlay beg end)))
13741 (overlay-put ov 'face 'secondary-selection)
13742 (overlay-put ov 'org-type 'org-occur)
13743 (push ov org-occur-highlights)))
13745 (defun org-remove-occur-highlights (&optional beg end noremove)
13746 "Remove the occur highlights from the buffer.
13747 BEG and END are ignored. If NOREMOVE is nil, remove this function
13748 from the `before-change-functions' in the current buffer."
13749 (interactive)
13750 (unless org-inhibit-highlight-removal
13751 (mapc 'delete-overlay org-occur-highlights)
13752 (setq org-occur-highlights nil)
13753 (setq org-occur-parameters nil)
13754 (unless noremove
13755 (remove-hook 'before-change-functions
13756 'org-remove-occur-highlights 'local))))
13758 ;;;; Priorities
13760 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13761 "Regular expression matching the priority indicator.")
13763 (defvar org-remove-priority-next-time nil)
13765 (defun org-priority-up ()
13766 "Increase the priority of the current item."
13767 (interactive)
13768 (org-priority 'up))
13770 (defun org-priority-down ()
13771 "Decrease the priority of the current item."
13772 (interactive)
13773 (org-priority 'down))
13775 (defun org-priority (&optional action show)
13776 "Change the priority of an item.
13777 ACTION can be `set', `up', `down', or a character."
13778 (interactive "P")
13779 (if (equal action '(4))
13780 (org-show-priority)
13781 (unless org-enable-priority-commands
13782 (user-error "Priority commands are disabled"))
13783 (setq action (or action 'set))
13784 (let (current new news have remove)
13785 (save-excursion
13786 (org-back-to-heading t)
13787 (if (looking-at org-priority-regexp)
13788 (setq current (string-to-char (match-string 2))
13789 have t))
13790 (cond
13791 ((eq action 'remove)
13792 (setq remove t new ?\ ))
13793 ((or (eq action 'set)
13794 (if (featurep 'xemacs) (characterp action) (integerp action)))
13795 (if (not (eq action 'set))
13796 (setq new action)
13797 (message "Priority %c-%c, SPC to remove: "
13798 org-highest-priority org-lowest-priority)
13799 (save-match-data
13800 (setq new (read-char-exclusive))))
13801 (if (and (= (upcase org-highest-priority) org-highest-priority)
13802 (= (upcase org-lowest-priority) org-lowest-priority))
13803 (setq new (upcase new)))
13804 (cond ((equal new ?\ ) (setq remove t))
13805 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13806 (user-error "Priority must be between `%c' and `%c'"
13807 org-highest-priority org-lowest-priority))))
13808 ((eq action 'up)
13809 (setq new (if have
13810 (1- current) ; normal cycling
13811 ;; last priority was empty
13812 (if (eq last-command this-command)
13813 org-lowest-priority ; wrap around empty to lowest
13814 ;; default
13815 (if org-priority-start-cycle-with-default
13816 org-default-priority
13817 (1- org-default-priority))))))
13818 ((eq action 'down)
13819 (setq new (if have
13820 (1+ current) ; normal cycling
13821 ;; last priority was empty
13822 (if (eq last-command this-command)
13823 org-highest-priority ; wrap around empty to highest
13824 ;; default
13825 (if org-priority-start-cycle-with-default
13826 org-default-priority
13827 (1+ org-default-priority))))))
13828 (t (user-error "Invalid action")))
13829 (if (or (< (upcase new) org-highest-priority)
13830 (> (upcase new) org-lowest-priority))
13831 (if (and (memq action '(up down))
13832 (not have) (not (eq last-command this-command)))
13833 ;; `new' is from default priority
13834 (error
13835 "The default can not be set, see `org-default-priority' why")
13836 ;; normal cycling: `new' is beyond highest/lowest priority
13837 ;; and is wrapped around to the empty priority
13838 (setq remove t)))
13839 (setq news (format "%c" new))
13840 (if have
13841 (if remove
13842 (replace-match "" t t nil 1)
13843 (replace-match news t t nil 2))
13844 (if remove
13845 (user-error "No priority cookie found in line")
13846 (let ((case-fold-search nil))
13847 (looking-at org-todo-line-regexp))
13848 (if (match-end 2)
13849 (progn
13850 (goto-char (match-end 2))
13851 (insert " [#" news "]"))
13852 (goto-char (match-beginning 3))
13853 (insert "[#" news "] "))))
13854 (org-preserve-lc (org-set-tags nil 'align)))
13855 (if remove
13856 (message "Priority removed")
13857 (message "Priority of current item set to %s" news)))))
13859 (defun org-show-priority ()
13860 "Show the priority of the current item.
13861 This priority is composed of the main priority given with the [#A] cookies,
13862 and by additional input from the age of a schedules or deadline entry."
13863 (interactive)
13864 (let ((pri (if (eq major-mode 'org-agenda-mode)
13865 (org-get-at-bol 'priority)
13866 (save-excursion
13867 (save-match-data
13868 (beginning-of-line)
13869 (and (looking-at org-heading-regexp)
13870 (org-get-priority (match-string 0))))))))
13871 (message "Priority is %d" (if pri pri -1000))))
13873 (defun org-get-priority (s)
13874 "Find priority cookie and return priority."
13875 (save-match-data
13876 (if (functionp org-get-priority-function)
13877 (funcall org-get-priority-function)
13878 (if (not (string-match org-priority-regexp s))
13879 (* 1000 (- org-lowest-priority org-default-priority))
13880 (* 1000 (- org-lowest-priority
13881 (string-to-char (match-string 2 s))))))))
13883 ;;;; Tags
13885 (defvar org-agenda-archives-mode)
13886 (defvar org-map-continue-from nil
13887 "Position from where mapping should continue.
13888 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13890 (defvar org-scanner-tags nil
13891 "The current tag list while the tags scanner is running.")
13892 (defvar org-trust-scanner-tags nil
13893 "Should `org-get-tags-at' use the tags for the scanner.
13894 This is for internal dynamical scoping only.
13895 When this is non-nil, the function `org-get-tags-at' will return the value
13896 of `org-scanner-tags' instead of building the list by itself. This
13897 can lead to large speed-ups when the tags scanner is used in a file with
13898 many entries, and when the list of tags is retrieved, for example to
13899 obtain a list of properties. Building the tags list for each entry in such
13900 a file becomes an N^2 operation - but with this variable set, it scales
13901 as N.")
13903 (defun org-scan-tags (action matcher todo-only &optional start-level)
13904 "Sca headline tags with inheritance and produce output ACTION.
13906 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13907 or `agenda' to produce an entry list for an agenda view. It can also be
13908 a Lisp form or a function that should be called at each matched headline, in
13909 this case the return value is a list of all return values from these calls.
13911 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13912 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13913 only lines with a not-done TODO keyword are included in the output.
13914 This should be the same variable that was scoped into
13915 and set by `org-make-tags-matcher' when it constructed MATCHER.
13917 START-LEVEL can be a string with asterisks, reducing the scope to
13918 headlines matching this string."
13919 (require 'org-agenda)
13920 (let* ((re (concat "^"
13921 (if start-level
13922 ;; Get the correct level to match
13923 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13924 org-outline-regexp)
13925 " *\\(\\<\\("
13926 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13927 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13928 (props (list 'face 'default
13929 'done-face 'org-agenda-done
13930 'undone-face 'default
13931 'mouse-face 'highlight
13932 'org-not-done-regexp org-not-done-regexp
13933 'org-todo-regexp org-todo-regexp
13934 'org-complex-heading-regexp org-complex-heading-regexp
13935 'help-echo
13936 (format "mouse-2 or RET jump to org file %s"
13937 (abbreviate-file-name
13938 (or (buffer-file-name (buffer-base-buffer))
13939 (buffer-name (buffer-base-buffer)))))))
13940 (org-map-continue-from nil)
13941 lspos tags tags-list
13942 (tags-alist (list (cons 0 org-file-tags)))
13943 (llast 0) rtn rtn1 level category i txt
13944 todo marker entry priority)
13945 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13946 (setq action (list 'lambda nil action)))
13947 (save-excursion
13948 (goto-char (point-min))
13949 (when (eq action 'sparse-tree)
13950 (org-overview)
13951 (org-remove-occur-highlights))
13952 (while (let (case-fold-search)
13953 (re-search-forward re nil t))
13954 (setq org-map-continue-from nil)
13955 (catch :skip
13956 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13957 tags (if (match-end 4) (org-match-string-no-properties 4)))
13958 (goto-char (setq lspos (match-beginning 0)))
13959 (setq level (org-reduced-level (org-outline-level))
13960 category (org-get-category))
13961 (setq i llast llast level)
13962 ;; remove tag lists from same and sublevels
13963 (while (>= i level)
13964 (when (setq entry (assoc i tags-alist))
13965 (setq tags-alist (delete entry tags-alist)))
13966 (setq i (1- i)))
13967 ;; add the next tags
13968 (when tags
13969 (setq tags (org-split-string tags ":")
13970 tags-alist
13971 (cons (cons level tags) tags-alist)))
13972 ;; compile tags for current headline
13973 (setq tags-list
13974 (if org-use-tag-inheritance
13975 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13976 tags)
13977 org-scanner-tags tags-list)
13978 (when org-use-tag-inheritance
13979 (setcdr (car tags-alist)
13980 (mapcar (lambda (x)
13981 (setq x (copy-sequence x))
13982 (org-add-prop-inherited x))
13983 (cdar tags-alist))))
13984 (when (and tags org-use-tag-inheritance
13985 (or (not (eq t org-use-tag-inheritance))
13986 org-tags-exclude-from-inheritance))
13987 ;; selective inheritance, remove uninherited ones
13988 (setcdr (car tags-alist)
13989 (org-remove-uninherited-tags (cdar tags-alist))))
13990 (when (and
13992 ;; eval matcher only when the todo condition is OK
13993 (and (or (not todo-only) (member todo org-not-done-keywords))
13994 (let ((case-fold-search t) (org-trust-scanner-tags t))
13995 (eval matcher)))
13997 ;; Call the skipper, but return t if it does not skip,
13998 ;; so that the `and' form continues evaluating
13999 (progn
14000 (unless (eq action 'sparse-tree) (org-agenda-skip))
14003 ;; Check if timestamps are deselecting this entry
14004 (or (not todo-only)
14005 (and (member todo org-not-done-keywords)
14006 (or (not org-agenda-tags-todo-honor-ignore-options)
14007 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14009 ;; select this headline
14010 (cond
14011 ((eq action 'sparse-tree)
14012 (and org-highlight-sparse-tree-matches
14013 (org-get-heading) (match-end 0)
14014 (org-highlight-new-match
14015 (match-beginning 1) (match-end 1)))
14016 (org-show-context 'tags-tree))
14017 ((eq action 'agenda)
14018 (setq txt (org-agenda-format-item
14020 (concat
14021 (if (eq org-tags-match-list-sublevels 'indented)
14022 (make-string (1- level) ?.) "")
14023 (org-get-heading))
14024 level category
14025 tags-list)
14026 priority (org-get-priority txt))
14027 (goto-char lspos)
14028 (setq marker (org-agenda-new-marker))
14029 (org-add-props txt props
14030 'org-marker marker 'org-hd-marker marker 'org-category category
14031 'todo-state todo
14032 'priority priority 'type "tagsmatch")
14033 (push txt rtn))
14034 ((functionp action)
14035 (setq org-map-continue-from nil)
14036 (save-excursion
14037 (setq rtn1 (funcall action))
14038 (push rtn1 rtn)))
14039 (t (user-error "Invalid action")))
14041 ;; if we are to skip sublevels, jump to end of subtree
14042 (unless org-tags-match-list-sublevels
14043 (org-end-of-subtree t)
14044 (backward-char 1))))
14045 ;; Get the correct position from where to continue
14046 (if org-map-continue-from
14047 (goto-char org-map-continue-from)
14048 (and (= (point) lspos) (end-of-line 1)))))
14049 (when (and (eq action 'sparse-tree)
14050 (not org-sparse-tree-open-archived-trees))
14051 (org-hide-archived-subtrees (point-min) (point-max)))
14052 (nreverse rtn)))
14054 (defun org-remove-uninherited-tags (tags)
14055 "Remove all tags that are not inherited from the list TAGS."
14056 (cond
14057 ((eq org-use-tag-inheritance t)
14058 (if org-tags-exclude-from-inheritance
14059 (org-delete-all org-tags-exclude-from-inheritance tags)
14060 tags))
14061 ((not org-use-tag-inheritance) nil)
14062 ((stringp org-use-tag-inheritance)
14063 (delq nil (mapcar
14064 (lambda (x)
14065 (if (and (string-match org-use-tag-inheritance x)
14066 (not (member x org-tags-exclude-from-inheritance)))
14067 x nil))
14068 tags)))
14069 ((listp org-use-tag-inheritance)
14070 (delq nil (mapcar
14071 (lambda (x)
14072 (if (member x org-use-tag-inheritance) x nil))
14073 tags)))))
14075 (defun org-match-sparse-tree (&optional todo-only match)
14076 "Create a sparse tree according to tags string MATCH.
14077 MATCH can contain positive and negative selection of tags, like
14078 \"+WORK+URGENT-WITHBOSS\".
14079 If optional argument TODO-ONLY is non-nil, only select lines that are
14080 also TODO lines."
14081 (interactive "P")
14082 (org-agenda-prepare-buffers (list (current-buffer)))
14083 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14085 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14087 (defvar org-cached-props nil)
14088 (defun org-cached-entry-get (pom property)
14089 (if (or (eq t org-use-property-inheritance)
14090 (and (stringp org-use-property-inheritance)
14091 (string-match org-use-property-inheritance property))
14092 (and (listp org-use-property-inheritance)
14093 (member property org-use-property-inheritance)))
14094 ;; Caching is not possible, check it directly
14095 (org-entry-get pom property 'inherit)
14096 ;; Get all properties, so that we can do complicated checks easily
14097 (cdr (assoc property (or org-cached-props
14098 (setq org-cached-props
14099 (org-entry-properties pom)))))))
14101 (defun org-global-tags-completion-table (&optional files)
14102 "Return the list of all tags in all agenda buffer/files.
14103 Optional FILES argument is a list of files which can be used
14104 instead of the agenda files."
14105 (save-excursion
14106 (org-uniquify
14107 (delq nil
14108 (apply 'append
14109 (mapcar
14110 (lambda (file)
14111 (set-buffer (find-file-noselect file))
14112 (append (org-get-buffer-tags)
14113 (mapcar (lambda (x) (if (stringp (car-safe x))
14114 (list (car-safe x)) nil))
14115 org-tag-alist)))
14116 (if (and files (car files))
14117 files
14118 (org-agenda-files))))))))
14120 (defun org-make-tags-matcher (match)
14121 "Create the TAGS/TODO matcher form for the selection string MATCH.
14123 The variable `todo-only' is scoped dynamically into this function.
14124 It will be set to t if the matcher restricts matching to TODO entries,
14125 otherwise will not be touched.
14127 Returns a cons of the selection string MATCH and the constructed
14128 lisp form implementing the matcher. The matcher is to be evaluated
14129 at an Org entry, with point on the headline, and returns t if the
14130 entry matches the selection string MATCH. The returned lisp form
14131 references two variables with information about the entry, which
14132 must be bound around the form's evaluation: todo, the TODO keyword
14133 at the entry (or nil of none); and tags-list, the list of all tags
14134 at the entry including inherited ones. Additionally, the category
14135 of the entry (if any) must be specified as the text property
14136 'org-category on the headline.
14138 See also `org-scan-tags'.
14140 (declare (special todo-only))
14141 (unless (boundp 'todo-only)
14142 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14143 (unless match
14144 ;; Get a new match request, with completion against the global
14145 ;; tags table and the local tags in current buffer
14146 (let ((org-last-tags-completion-table
14147 (org-uniquify
14148 (delq nil (append (org-get-buffer-tags)
14149 (org-global-tags-completion-table))))))
14150 (setq match (org-completing-read-no-i
14151 "Match: " 'org-tags-completion-function nil nil nil
14152 'org-tags-history))))
14154 ;; Parse the string and create a lisp form
14155 (let ((match0 match)
14156 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14157 minus tag mm
14158 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14159 orterms term orlist re-p str-p level-p level-op time-p
14160 prop-p pn pv po gv rest (start 0) (ss 0))
14161 ;; Expand group tags
14162 (setq match (org-tags-expand match))
14164 ;; Check if there is a TODO part of this match, which would be the
14165 ;; part after a "/". TO make sure that this slash is not part of
14166 ;; a property value to be matched against, we also check that there
14167 ;; is no " after that slash.
14168 ;; First, find the last slash
14169 (while (string-match "/+" match ss)
14170 (setq start (match-beginning 0) ss (match-end 0)))
14171 (if (and (string-match "/+" match start)
14172 (not (save-match-data (string-match "\"" match start))))
14173 ;; match contains also a todo-matching request
14174 (progn
14175 (setq tagsmatch (substring match 0 (match-beginning 0))
14176 todomatch (substring match (match-end 0)))
14177 (if (string-match "^!" todomatch)
14178 (setq todo-only t todomatch (substring todomatch 1)))
14179 (if (string-match "^\\s-*$" todomatch)
14180 (setq todomatch nil)))
14181 ;; only matching tags
14182 (setq tagsmatch match todomatch nil))
14184 ;; Make the tags matcher
14185 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14186 (setq tagsmatcher t)
14187 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14188 (while (setq term (pop orterms))
14189 (while (and (equal (substring term -1) "\\") orterms)
14190 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14191 (while (string-match re term)
14192 (setq rest (substring term (match-end 0))
14193 minus (and (match-end 1)
14194 (equal (match-string 1 term) "-"))
14195 tag (save-match-data (replace-regexp-in-string
14196 "\\\\-" "-"
14197 (match-string 2 term)))
14198 re-p (equal (string-to-char tag) ?{)
14199 level-p (match-end 4)
14200 prop-p (match-end 5)
14201 mm (cond
14202 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14203 (level-p
14204 (setq level-op (org-op-to-function (match-string 3 term)))
14205 `(,level-op level ,(string-to-number
14206 (match-string 4 term))))
14207 (prop-p
14208 (setq pn (match-string 5 term)
14209 po (match-string 6 term)
14210 pv (match-string 7 term)
14211 re-p (equal (string-to-char pv) ?{)
14212 str-p (equal (string-to-char pv) ?\")
14213 time-p (save-match-data
14214 (string-match "^\"[[<].*[]>]\"$" pv))
14215 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14216 (if time-p (setq pv (org-matcher-time pv)))
14217 (setq po (org-op-to-function po (if time-p 'time str-p)))
14218 (cond
14219 ((equal pn "CATEGORY")
14220 (setq gv '(get-text-property (point) 'org-category)))
14221 ((equal pn "TODO")
14222 (setq gv 'todo))
14224 (setq gv `(org-cached-entry-get nil ,pn))))
14225 (if re-p
14226 (if (eq po 'org<>)
14227 `(not (string-match ,pv (or ,gv "")))
14228 `(string-match ,pv (or ,gv "")))
14229 (if str-p
14230 `(,po (or ,gv "") ,pv)
14231 `(,po (string-to-number (or ,gv ""))
14232 ,(string-to-number pv) ))))
14233 (t `(member ,tag tags-list)))
14234 mm (if minus (list 'not mm) mm)
14235 term rest)
14236 (push mm tagsmatcher))
14237 (push (if (> (length tagsmatcher) 1)
14238 (cons 'and tagsmatcher)
14239 (car tagsmatcher))
14240 orlist)
14241 (setq tagsmatcher nil))
14242 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14243 (setq tagsmatcher
14244 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14245 ;; Make the todo matcher
14246 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14247 (setq todomatcher t)
14248 (setq orterms (org-split-string todomatch "|") orlist nil)
14249 (while (setq term (pop orterms))
14250 (while (string-match re term)
14251 (setq minus (and (match-end 1)
14252 (equal (match-string 1 term) "-"))
14253 kwd (match-string 2 term)
14254 re-p (equal (string-to-char kwd) ?{)
14255 term (substring term (match-end 0))
14256 mm (if re-p
14257 `(string-match ,(substring kwd 1 -1) todo)
14258 (list 'equal 'todo kwd))
14259 mm (if minus (list 'not mm) mm))
14260 (push mm todomatcher))
14261 (push (if (> (length todomatcher) 1)
14262 (cons 'and todomatcher)
14263 (car todomatcher))
14264 orlist)
14265 (setq todomatcher nil))
14266 (setq todomatcher (if (> (length orlist) 1)
14267 (cons 'or orlist) (car orlist))))
14269 ;; Return the string and lisp forms of the matcher
14270 (setq matcher (if todomatcher
14271 (list 'and tagsmatcher todomatcher)
14272 tagsmatcher))
14273 (when todo-only
14274 (setq matcher (list 'and '(member todo org-not-done-keywords)
14275 matcher)))
14276 (cons match0 matcher)))
14278 (defun org-tags-expand (match &optional single-as-list downcased)
14279 "Expand group tags in MATCH.
14281 This replaces every group tag in MATCH with a regexp tag search.
14282 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14283 will be replaced like this:
14285 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14286 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14287 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14289 Replacing by a regexp preserves the structure of the match.
14290 E.g., this expansion
14292 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14294 will match anything tagged with \"Lab\" and \"Home\", or tagged
14295 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14297 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14298 assumed to be a single group tag, and the function will return
14299 the list of tags in this group.
14301 When DOWNCASE is non-nil, expand downcased TAGS."
14302 (if org-group-tags
14303 (let* ((case-fold-search t)
14304 (stable org-mode-syntax-table)
14305 (tal (or org-tag-groups-alist-for-agenda
14306 org-tag-groups-alist))
14307 (tal (if downcased
14308 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14309 (tml (mapcar 'car tal))
14310 (rtnmatch match) rpl)
14311 ;; @ and _ are allowed as word-components in tags
14312 (modify-syntax-entry ?@ "w" stable)
14313 (modify-syntax-entry ?_ "w" stable)
14314 (while (and tml
14315 (with-syntax-table stable
14316 (string-match
14317 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14318 (regexp-opt tml) "\\>\\)") rtnmatch)))
14319 (let* ((dir (match-string 1 rtnmatch))
14320 (tag (match-string 2 rtnmatch))
14321 (tag (if downcased (downcase tag) tag)))
14322 (setq tml (delete tag tml))
14323 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14324 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14325 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14326 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14327 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14328 (if single-as-list
14329 (or (reverse rpl) (list rtnmatch))
14330 rtnmatch))
14331 (if single-as-list (list (if downcased (downcase match) match))
14332 match)))
14334 (defun org-op-to-function (op &optional stringp)
14335 "Turn an operator into the appropriate function."
14336 (setq op
14337 (cond
14338 ((equal op "<" ) '(< string< org-time<))
14339 ((equal op ">" ) '(> org-string> org-time>))
14340 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14341 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14342 ((member op '("=" "==")) '(= string= org-time=))
14343 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14344 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14346 (defun org<> (a b) (not (= a b)))
14347 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14348 (defun org-string>= (a b) (not (string< a b)))
14349 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14350 (defun org-string<> (a b) (not (string= a b)))
14351 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14352 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14353 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14354 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14355 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14356 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14357 (defun org-2ft (s)
14358 "Convert S to a floating point time.
14359 If S is already a number, just return it. If it is a string, parse
14360 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14361 (cond
14362 ((numberp s) s)
14363 ((stringp s)
14364 (condition-case nil
14365 (float-time (apply 'encode-time (org-parse-time-string s)))
14366 (error 0.)))
14367 (t 0.)))
14369 (defun org-time-today ()
14370 "Time in seconds today at 0:00.
14371 Returns the float number of seconds since the beginning of the
14372 epoch to the beginning of today (00:00)."
14373 (float-time (apply 'encode-time
14374 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14376 (defun org-matcher-time (s)
14377 "Interpret a time comparison value."
14378 (save-match-data
14379 (cond
14380 ((string= s "<now>") (float-time))
14381 ((string= s "<today>") (org-time-today))
14382 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14383 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14384 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14385 (+ (org-time-today)
14386 (* (string-to-number (match-string 1 s))
14387 (cdr (assoc (match-string 2 s)
14388 '(("d" . 86400.0) ("w" . 604800.0)
14389 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14390 (t (org-2ft s)))))
14392 (defun org-match-any-p (re list)
14393 "Does re match any element of list?"
14394 (setq list (mapcar (lambda (x) (string-match re x)) list))
14395 (delq nil list))
14397 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14398 (defvar org-tags-overlay (make-overlay 1 1))
14399 (org-detach-overlay org-tags-overlay)
14401 (defun org-get-local-tags-at (&optional pos)
14402 "Get a list of tags defined in the current headline."
14403 (org-get-tags-at pos 'local))
14405 (defun org-get-local-tags ()
14406 "Get a list of tags defined in the current headline."
14407 (org-get-tags-at nil 'local))
14409 (defun org-get-tags-at (&optional pos local)
14410 "Get a list of all headline tags applicable at POS.
14411 POS defaults to point. If tags are inherited, the list contains
14412 the targets in the same sequence as the headlines appear, i.e.
14413 the tags of the current headline come last.
14414 When LOCAL is non-nil, only return tags from the current headline,
14415 ignore inherited ones."
14416 (interactive)
14417 (if (and org-trust-scanner-tags
14418 (or (not pos) (equal pos (point)))
14419 (not local))
14420 org-scanner-tags
14421 (let (tags ltags lastpos parent)
14422 (save-excursion
14423 (save-restriction
14424 (widen)
14425 (goto-char (or pos (point)))
14426 (save-match-data
14427 (catch 'done
14428 (condition-case nil
14429 (progn
14430 (org-back-to-heading t)
14431 (while (not (equal lastpos (point)))
14432 (setq lastpos (point))
14433 (when (looking-at
14434 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14435 (setq ltags (org-split-string
14436 (org-match-string-no-properties 1) ":"))
14437 (when parent
14438 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14439 (setq tags (append
14440 (if parent
14441 (org-remove-uninherited-tags ltags)
14442 ltags)
14443 tags)))
14444 (or org-use-tag-inheritance (throw 'done t))
14445 (if local (throw 'done t))
14446 (or (org-up-heading-safe) (error nil))
14447 (setq parent t)))
14448 (error nil)))))
14449 (if local
14450 tags
14451 (reverse (delete-dups
14452 (reverse (append
14453 (org-remove-uninherited-tags
14454 org-file-tags) tags)))))))))
14456 (defun org-add-prop-inherited (s)
14457 (add-text-properties 0 (length s) '(inherited t) s)
14460 (defun org-toggle-tag (tag &optional onoff)
14461 "Toggle the tag TAG for the current line.
14462 If ONOFF is `on' or `off', don't toggle but set to this state."
14463 (let (res current)
14464 (save-excursion
14465 (org-back-to-heading t)
14466 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14467 (point-at-eol) t)
14468 (progn
14469 (setq current (match-string 1))
14470 (replace-match ""))
14471 (setq current ""))
14472 (setq current (nreverse (org-split-string current ":")))
14473 (cond
14474 ((eq onoff 'on)
14475 (setq res t)
14476 (or (member tag current) (push tag current)))
14477 ((eq onoff 'off)
14478 (or (not (member tag current)) (setq current (delete tag current))))
14479 (t (if (member tag current)
14480 (setq current (delete tag current))
14481 (setq res t)
14482 (push tag current))))
14483 (end-of-line 1)
14484 (if current
14485 (progn
14486 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14487 (org-set-tags nil t))
14488 (delete-horizontal-space))
14489 (run-hooks 'org-after-tags-change-hook))
14490 res))
14492 (defun org-align-tags-here (to-col)
14493 ;; Assumes that this is a headline
14494 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14495 (beginning-of-line 1)
14496 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14497 (< pos (match-beginning 2)))
14498 (progn
14499 (setq tags-l (- (match-end 2) (match-beginning 2)))
14500 (goto-char (match-beginning 1))
14501 (insert " ")
14502 (delete-region (point) (1+ (match-beginning 2)))
14503 (setq ncol (max (current-column)
14504 (1+ col)
14505 (if (> to-col 0)
14506 to-col
14507 (- (abs to-col) tags-l))))
14508 (setq p (point))
14509 (insert (make-string (- ncol (current-column)) ?\ ))
14510 (setq ncol (current-column))
14511 (when indent-tabs-mode (tabify p (point-at-eol)))
14512 (org-move-to-column (min ncol col) t nil t))
14513 (goto-char pos))))
14515 (defun org-set-tags-command (&optional arg just-align)
14516 "Call the set-tags command for the current entry."
14517 (interactive "P")
14518 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14519 (org-set-tags arg just-align)
14520 (save-excursion
14521 (unless (and (org-region-active-p)
14522 org-loop-over-headlines-in-active-region)
14523 (org-back-to-heading t))
14524 (org-set-tags arg just-align))))
14526 (defun org-set-tags-to (data)
14527 "Set the tags of the current entry to DATA, replacing the current tags.
14528 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14529 If DATA is nil or the empty string, any tags will be removed."
14530 (interactive "sTags: ")
14531 (setq data
14532 (cond
14533 ((eq data nil) "")
14534 ((equal data "") "")
14535 ((stringp data)
14536 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14537 ":"))
14538 ((listp data)
14539 (concat ":" (mapconcat 'identity data ":") ":"))))
14540 (when data
14541 (save-excursion
14542 (org-back-to-heading t)
14543 (when (looking-at org-complex-heading-regexp)
14544 (if (match-end 5)
14545 (progn
14546 (goto-char (match-beginning 5))
14547 (insert data)
14548 (delete-region (point) (point-at-eol))
14549 (org-set-tags nil 'align))
14550 (goto-char (point-at-eol))
14551 (insert " " data)
14552 (org-set-tags nil 'align)))
14553 (beginning-of-line 1)
14554 (if (looking-at ".*?\\([ \t]+\\)$")
14555 (delete-region (match-beginning 1) (match-end 1))))))
14557 (defun org-align-all-tags ()
14558 "Align the tags i all headings."
14559 (interactive)
14560 (save-excursion
14561 (or (ignore-errors (org-back-to-heading t))
14562 (outline-next-heading))
14563 (if (org-at-heading-p)
14564 (org-set-tags t)
14565 (message "No headings"))))
14567 (defvar org-indent-indentation-per-level)
14568 (defun org-set-tags (&optional arg just-align)
14569 "Set the tags for the current headline.
14570 With prefix ARG, realign all tags in headings in the current buffer."
14571 (interactive "P")
14572 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14573 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14574 'region-start-level 'region))
14575 org-loop-over-headlines-in-active-region)
14576 (org-map-entries
14577 ;; We don't use ARG and JUST-ALIGN here these args are not
14578 ;; useful when looping over headlines
14579 `(org-set-tags)
14580 org-loop-over-headlines-in-active-region
14581 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14582 (let* ((re org-outline-regexp-bol)
14583 (current (unless arg (org-get-tags-string)))
14584 (col (current-column))
14585 (org-setting-tags t)
14586 table current-tags inherited-tags ; computed below when needed
14587 tags p0 c0 c1 rpl di tc level)
14588 (if arg
14589 (save-excursion
14590 (goto-char (point-min))
14591 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14592 (while (re-search-forward re nil t)
14593 (org-set-tags nil t)
14594 (end-of-line 1)))
14595 (message "All tags realigned to column %d" org-tags-column))
14596 (if just-align
14597 (setq tags current)
14598 ;; Get a new set of tags from the user
14599 (save-excursion
14600 (setq table (append org-tag-persistent-alist
14601 (or org-tag-alist (org-get-buffer-tags))
14602 (and
14603 org-complete-tags-always-offer-all-agenda-tags
14604 (org-global-tags-completion-table
14605 (org-agenda-files))))
14606 org-last-tags-completion-table table
14607 current-tags (org-split-string current ":")
14608 inherited-tags (nreverse
14609 (nthcdr (length current-tags)
14610 (nreverse (org-get-tags-at))))
14611 tags
14612 (if (or (eq t org-use-fast-tag-selection)
14613 (and org-use-fast-tag-selection
14614 (delq nil (mapcar 'cdr table))))
14615 (org-fast-tag-selection
14616 current-tags inherited-tags table
14617 (if org-fast-tag-selection-include-todo
14618 org-todo-key-alist))
14619 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14620 (org-trim
14621 (org-icompleting-read "Tags: "
14622 'org-tags-completion-function
14623 nil nil current 'org-tags-history))))))
14624 (while (string-match "[-+&]+" tags)
14625 ;; No boolean logic, just a list
14626 (setq tags (replace-match ":" t t tags))))
14628 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14630 (if org-tags-sort-function
14631 (setq tags (mapconcat 'identity
14632 (sort (org-split-string
14633 tags (org-re "[^[:alnum:]_@#%]+"))
14634 org-tags-sort-function) ":")))
14636 (if (string-match "\\`[\t ]*\\'" tags)
14637 (setq tags "")
14638 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14639 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14641 ;; Insert new tags at the correct column
14642 (beginning-of-line 1)
14643 (setq level (or (and (looking-at org-outline-regexp)
14644 (- (match-end 0) (point) 1))
14646 (cond
14647 ((and (equal current "") (equal tags "")))
14648 ((re-search-forward
14649 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14650 (point-at-eol) t)
14651 (if (equal tags "")
14652 (setq rpl "")
14653 (goto-char (match-beginning 0))
14654 (setq c0 (current-column)
14655 ;; compute offset for the case of org-indent-mode active
14656 di (if org-indent-mode
14657 (* (1- org-indent-indentation-per-level) (1- level))
14659 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14660 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14661 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14662 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14663 (replace-match rpl t t)
14664 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14665 tags)
14666 (t (error "Tags alignment failed")))
14667 (org-move-to-column col nil nil t)
14668 (unless just-align
14669 (run-hooks 'org-after-tags-change-hook))))))
14671 (defun org-change-tag-in-region (beg end tag off)
14672 "Add or remove TAG for each entry in the region.
14673 This works in the agenda, and also in an org-mode buffer."
14674 (interactive
14675 (list (region-beginning) (region-end)
14676 (let ((org-last-tags-completion-table
14677 (if (derived-mode-p 'org-mode)
14678 (org-uniquify
14679 (delq nil (append (org-get-buffer-tags)
14680 (org-global-tags-completion-table))))
14681 (org-global-tags-completion-table))))
14682 (org-icompleting-read
14683 "Tag: " 'org-tags-completion-function nil nil nil
14684 'org-tags-history))
14685 (progn
14686 (message "[s]et or [r]emove? ")
14687 (equal (read-char-exclusive) ?r))))
14688 (if (fboundp 'deactivate-mark) (deactivate-mark))
14689 (let ((agendap (equal major-mode 'org-agenda-mode))
14690 l1 l2 m buf pos newhead (cnt 0))
14691 (goto-char end)
14692 (setq l2 (1- (org-current-line)))
14693 (goto-char beg)
14694 (setq l1 (org-current-line))
14695 (loop for l from l1 to l2 do
14696 (org-goto-line l)
14697 (setq m (get-text-property (point) 'org-hd-marker))
14698 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14699 (and agendap m))
14700 (setq buf (if agendap (marker-buffer m) (current-buffer))
14701 pos (if agendap m (point)))
14702 (with-current-buffer buf
14703 (save-excursion
14704 (save-restriction
14705 (goto-char pos)
14706 (setq cnt (1+ cnt))
14707 (org-toggle-tag tag (if off 'off 'on))
14708 (setq newhead (org-get-heading)))))
14709 (and agendap (org-agenda-change-all-lines newhead m))))
14710 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14712 (defun org-tags-completion-function (string predicate &optional flag)
14713 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14714 (confirm (lambda (x) (stringp (car x)))))
14715 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14716 (setq s1 (match-string 1 string)
14717 s2 (match-string 2 string))
14718 (setq s1 "" s2 string))
14719 (cond
14720 ((eq flag nil)
14721 ;; try completion
14722 (setq rtn (try-completion s2 ctable confirm))
14723 (if (stringp rtn)
14724 (setq rtn
14725 (concat s1 s2 (substring rtn (length s2))
14726 (if (and org-add-colon-after-tag-completion
14727 (assoc rtn ctable))
14728 ":" ""))))
14729 rtn)
14730 ((eq flag t)
14731 ;; all-completions
14732 (all-completions s2 ctable confirm))
14733 ((eq flag 'lambda)
14734 ;; exact match?
14735 (assoc s2 ctable)))))
14737 (defun org-fast-tag-insert (kwd tags face &optional end)
14738 "Insert KDW, and the TAGS, the latter with face FACE.
14739 Also insert END."
14740 (insert (format "%-12s" (concat kwd ":"))
14741 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14742 (or end "")))
14744 (defun org-fast-tag-show-exit (flag)
14745 (save-excursion
14746 (org-goto-line 3)
14747 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14748 (replace-match ""))
14749 (when flag
14750 (end-of-line 1)
14751 (org-move-to-column (- (window-width) 19) t)
14752 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14754 (defun org-set-current-tags-overlay (current prefix)
14755 "Add an overlay to CURRENT tag with PREFIX."
14756 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14757 (if (featurep 'xemacs)
14758 (org-overlay-display org-tags-overlay (concat prefix s)
14759 'secondary-selection)
14760 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14761 (org-overlay-display org-tags-overlay (concat prefix s)))))
14763 (defvar org-last-tag-selection-key nil)
14764 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14765 "Fast tag selection with single keys.
14766 CURRENT is the current list of tags in the headline, INHERITED is the
14767 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14768 possibly with grouping information. TODO-TABLE is a similar table with
14769 TODO keywords, should these have keys assigned to them.
14770 If the keys are nil, a-z are automatically assigned.
14771 Returns the new tags string, or nil to not change the current settings."
14772 (let* ((fulltable (append table todo-table))
14773 (maxlen (apply 'max (mapcar
14774 (lambda (x)
14775 (if (stringp (car x)) (string-width (car x)) 0))
14776 fulltable)))
14777 (buf (current-buffer))
14778 (expert (eq org-fast-tag-selection-single-key 'expert))
14779 (buffer-tags nil)
14780 (fwidth (+ maxlen 3 1 3))
14781 (ncol (/ (- (window-width) 4) fwidth))
14782 (i-face 'org-done)
14783 (c-face 'org-todo)
14784 tg cnt e c char c1 c2 ntable tbl rtn
14785 ov-start ov-end ov-prefix
14786 (exit-after-next org-fast-tag-selection-single-key)
14787 (done-keywords org-done-keywords)
14788 groups ingroup)
14789 (save-excursion
14790 (beginning-of-line 1)
14791 (if (looking-at
14792 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14793 (setq ov-start (match-beginning 1)
14794 ov-end (match-end 1)
14795 ov-prefix "")
14796 (setq ov-start (1- (point-at-eol))
14797 ov-end (1+ ov-start))
14798 (skip-chars-forward "^\n\r")
14799 (setq ov-prefix
14800 (concat
14801 (buffer-substring (1- (point)) (point))
14802 (if (> (current-column) org-tags-column)
14804 (make-string (- org-tags-column (current-column)) ?\ ))))))
14805 (move-overlay org-tags-overlay ov-start ov-end)
14806 (save-window-excursion
14807 (if expert
14808 (set-buffer (get-buffer-create " *Org tags*"))
14809 (delete-other-windows)
14810 (split-window-vertically)
14811 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14812 (erase-buffer)
14813 (org-set-local 'org-done-keywords done-keywords)
14814 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14815 (org-fast-tag-insert "Current" current c-face "\n\n")
14816 (org-fast-tag-show-exit exit-after-next)
14817 (org-set-current-tags-overlay current ov-prefix)
14818 (setq tbl fulltable char ?a cnt 0)
14819 (while (setq e (pop tbl))
14820 (cond
14821 ((equal (car e) :startgroup)
14822 (push '() groups) (setq ingroup t)
14823 (when (not (= cnt 0))
14824 (setq cnt 0)
14825 (insert "\n"))
14826 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14827 ((equal (car e) :endgroup)
14828 (setq ingroup nil cnt 0)
14829 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14830 ((equal e '(:newline))
14831 (when (not (= cnt 0))
14832 (setq cnt 0)
14833 (insert "\n")
14834 (setq e (car tbl))
14835 (while (equal (car tbl) '(:newline))
14836 (insert "\n")
14837 (setq tbl (cdr tbl)))))
14838 ((equal e '(:grouptags)) nil)
14840 (setq tg (copy-sequence (car e)) c2 nil)
14841 (if (cdr e)
14842 (setq c (cdr e))
14843 ;; automatically assign a character.
14844 (setq c1 (string-to-char
14845 (downcase (substring
14846 tg (if (= (string-to-char tg) ?@) 1 0)))))
14847 (if (or (rassoc c1 ntable) (rassoc c1 table))
14848 (while (or (rassoc char ntable) (rassoc char table))
14849 (setq char (1+ char)))
14850 (setq c2 c1))
14851 (setq c (or c2 char)))
14852 (if ingroup (push tg (car groups)))
14853 (setq tg (org-add-props tg nil 'face
14854 (cond
14855 ((not (assoc tg table))
14856 (org-get-todo-face tg))
14857 ((member tg current) c-face)
14858 ((member tg inherited) i-face))))
14859 (if (equal (caar tbl) :grouptags)
14860 (org-add-props tg nil 'face 'org-tag-group))
14861 (if (and (= cnt 0) (not ingroup)) (insert " "))
14862 (insert "[" c "] " tg (make-string
14863 (- fwidth 4 (length tg)) ?\ ))
14864 (push (cons tg c) ntable)
14865 (when (= (setq cnt (1+ cnt)) ncol)
14866 (insert "\n")
14867 (if ingroup (insert " "))
14868 (setq cnt 0)))))
14869 (setq ntable (nreverse ntable))
14870 (insert "\n")
14871 (goto-char (point-min))
14872 (if (not expert) (org-fit-window-to-buffer))
14873 (setq rtn
14874 (catch 'exit
14875 (while t
14876 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14877 (if (not groups) "no " "")
14878 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14879 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14880 (setq org-last-tag-selection-key c)
14881 (cond
14882 ((= c ?\r) (throw 'exit t))
14883 ((= c ?!)
14884 (setq groups (not groups))
14885 (goto-char (point-min))
14886 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14887 ((= c ?\C-c)
14888 (if (not expert)
14889 (org-fast-tag-show-exit
14890 (setq exit-after-next (not exit-after-next)))
14891 (setq expert nil)
14892 (delete-other-windows)
14893 (set-window-buffer (split-window-vertically) " *Org tags*")
14894 (org-switch-to-buffer-other-window " *Org tags*")
14895 (org-fit-window-to-buffer)))
14896 ((or (= c ?\C-g)
14897 (and (= c ?q) (not (rassoc c ntable))))
14898 (org-detach-overlay org-tags-overlay)
14899 (setq quit-flag t))
14900 ((= c ?\ )
14901 (setq current nil)
14902 (if exit-after-next (setq exit-after-next 'now)))
14903 ((= c ?\t)
14904 (condition-case nil
14905 (setq tg (org-icompleting-read
14906 "Tag: "
14907 (or buffer-tags
14908 (with-current-buffer buf
14909 (org-get-buffer-tags)))))
14910 (quit (setq tg "")))
14911 (when (string-match "\\S-" tg)
14912 (add-to-list 'buffer-tags (list tg))
14913 (if (member tg current)
14914 (setq current (delete tg current))
14915 (push tg current)))
14916 (if exit-after-next (setq exit-after-next 'now)))
14917 ((setq e (rassoc c todo-table) tg (car e))
14918 (with-current-buffer buf
14919 (save-excursion (org-todo tg)))
14920 (if exit-after-next (setq exit-after-next 'now)))
14921 ((setq e (rassoc c ntable) tg (car e))
14922 (if (member tg current)
14923 (setq current (delete tg current))
14924 (loop for g in groups do
14925 (if (member tg g)
14926 (mapc (lambda (x)
14927 (setq current (delete x current)))
14928 g)))
14929 (push tg current))
14930 (if exit-after-next (setq exit-after-next 'now))))
14932 ;; Create a sorted list
14933 (setq current
14934 (sort current
14935 (lambda (a b)
14936 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14937 (if (eq exit-after-next 'now) (throw 'exit t))
14938 (goto-char (point-min))
14939 (beginning-of-line 2)
14940 (delete-region (point) (point-at-eol))
14941 (org-fast-tag-insert "Current" current c-face)
14942 (org-set-current-tags-overlay current ov-prefix)
14943 (while (re-search-forward
14944 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14945 (setq tg (match-string 1))
14946 (add-text-properties
14947 (match-beginning 1) (match-end 1)
14948 (list 'face
14949 (cond
14950 ((member tg current) c-face)
14951 ((member tg inherited) i-face)
14952 (t (get-text-property (match-beginning 1) 'face))))))
14953 (goto-char (point-min)))))
14954 (org-detach-overlay org-tags-overlay)
14955 (if rtn
14956 (mapconcat 'identity current ":")
14957 nil))))
14959 (defun org-get-tags-string ()
14960 "Get the TAGS string in the current headline."
14961 (unless (org-at-heading-p t)
14962 (user-error "Not on a heading"))
14963 (save-excursion
14964 (beginning-of-line 1)
14965 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14966 (org-match-string-no-properties 1)
14967 "")))
14969 (defun org-get-tags ()
14970 "Get the list of tags specified in the current headline."
14971 (org-split-string (org-get-tags-string) ":"))
14973 (defun org-get-buffer-tags ()
14974 "Get a table of all tags used in the buffer, for completion."
14975 (let (tags)
14976 (save-excursion
14977 (goto-char (point-min))
14978 (while (re-search-forward
14979 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
14980 (when (equal (char-after (point-at-bol 0)) ?*)
14981 (mapc (lambda (x) (add-to-list 'tags x))
14982 (org-split-string (org-match-string-no-properties 1) ":")))))
14983 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
14984 (mapcar 'list tags)))
14986 ;;;; The mapping API
14988 (defun org-map-entries (func &optional match scope &rest skip)
14989 "Call FUNC at each headline selected by MATCH in SCOPE.
14991 FUNC is a function or a lisp form. The function will be called without
14992 arguments, with the cursor positioned at the beginning of the headline.
14993 The return values of all calls to the function will be collected and
14994 returned as a list.
14996 The call to FUNC will be wrapped into a save-excursion form, so FUNC
14997 does not need to preserve point. After evaluation, the cursor will be
14998 moved to the end of the line (presumably of the headline of the
14999 processed entry) and search continues from there. Under some
15000 circumstances, this may not produce the wanted results. For example,
15001 if you have removed (e.g. archived) the current (sub)tree it could
15002 mean that the next entry will be skipped entirely. In such cases, you
15003 can specify the position from where search should continue by making
15004 FUNC set the variable `org-map-continue-from' to the desired buffer
15005 position.
15007 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15008 Only headlines that are matched by this query will be considered during
15009 the iteration. When MATCH is nil or t, all headlines will be
15010 visited by the iteration.
15012 SCOPE determines the scope of this command. It can be any of:
15014 nil The current buffer, respecting the restriction if any
15015 tree The subtree started with the entry at point
15016 region The entries within the active region, if any
15017 region-start-level
15018 The entries within the active region, but only those at
15019 the same level than the first one.
15020 file The current buffer, without restriction
15021 file-with-archives
15022 The current buffer, and any archives associated with it
15023 agenda All agenda files
15024 agenda-with-archives
15025 All agenda files with any archive files associated with them
15026 \(file1 file2 ...)
15027 If this is a list, all files in the list will be scanned
15029 The remaining args are treated as settings for the skipping facilities of
15030 the scanner. The following items can be given here:
15032 archive skip trees with the archive tag
15033 comment skip trees with the COMMENT keyword
15034 function or Emacs Lisp form:
15035 will be used as value for `org-agenda-skip-function', so
15036 whenever the function returns a position, FUNC will not be
15037 called for that entry and search will continue from the
15038 position returned
15040 If your function needs to retrieve the tags including inherited tags
15041 at the *current* entry, you can use the value of the variable
15042 `org-scanner-tags' which will be much faster than getting the value
15043 with `org-get-tags-at'. If your function gets properties with
15044 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15045 to t around the call to `org-entry-properties' to get the same speedup.
15046 Note that if your function moves around to retrieve tags and properties at
15047 a *different* entry, you cannot use these techniques."
15048 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15049 (not (org-region-active-p)))
15050 (let* ((org-agenda-archives-mode nil) ; just to make sure
15051 (org-agenda-skip-archived-trees (memq 'archive skip))
15052 (org-agenda-skip-comment-trees (memq 'comment skip))
15053 (org-agenda-skip-function
15054 (car (org-delete-all '(comment archive) skip)))
15055 (org-tags-match-list-sublevels t)
15056 (start-level (eq scope 'region-start-level))
15057 matcher file res
15058 org-todo-keywords-for-agenda
15059 org-done-keywords-for-agenda
15060 org-todo-keyword-alist-for-agenda
15061 org-tag-alist-for-agenda
15062 todo-only)
15064 (cond
15065 ((eq match t) (setq matcher t))
15066 ((eq match nil) (setq matcher t))
15067 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15069 (save-window-excursion
15070 (save-restriction
15071 (cond ((eq scope 'tree)
15072 (org-back-to-heading t)
15073 (org-narrow-to-subtree)
15074 (setq scope nil))
15075 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15076 (org-region-active-p))
15077 ;; If needed, set start-level to a string like "2"
15078 (when start-level
15079 (save-excursion
15080 (goto-char (region-beginning))
15081 (unless (org-at-heading-p) (outline-next-heading))
15082 (setq start-level (org-current-level))))
15083 (narrow-to-region (region-beginning)
15084 (save-excursion
15085 (goto-char (region-end))
15086 (unless (and (bolp) (org-at-heading-p))
15087 (outline-next-heading))
15088 (point)))
15089 (setq scope nil)))
15091 (if (not scope)
15092 (progn
15093 (org-agenda-prepare-buffers
15094 (list (buffer-file-name (current-buffer))))
15095 (setq res (org-scan-tags func matcher todo-only start-level)))
15096 ;; Get the right scope
15097 (cond
15098 ((and scope (listp scope) (symbolp (car scope)))
15099 (setq scope (eval scope)))
15100 ((eq scope 'agenda)
15101 (setq scope (org-agenda-files t)))
15102 ((eq scope 'agenda-with-archives)
15103 (setq scope (org-agenda-files t))
15104 (setq scope (org-add-archive-files scope)))
15105 ((eq scope 'file)
15106 (setq scope (list (buffer-file-name))))
15107 ((eq scope 'file-with-archives)
15108 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15109 (org-agenda-prepare-buffers scope)
15110 (while (setq file (pop scope))
15111 (with-current-buffer (org-find-base-buffer-visiting file)
15112 (save-excursion
15113 (save-restriction
15114 (widen)
15115 (goto-char (point-min))
15116 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15117 res)))
15119 ;;;; Properties
15121 ;;; Setting and retrieving properties
15123 (defconst org-special-properties
15124 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15125 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15126 "The special properties valid in Org-mode.
15128 These are properties that are not defined in the property drawer,
15129 but in some other way.")
15131 (defconst org-default-properties
15132 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15133 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15134 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15135 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15136 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15137 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15138 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15139 "Some properties that are used by Org-mode for various purposes.
15140 Being in this list makes sure that they are offered for completion.")
15142 (defun org-property-action ()
15143 "Do an action on properties."
15144 (interactive)
15145 (let (c)
15146 (org-at-property-p)
15147 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15148 (setq c (read-char-exclusive))
15149 (cond
15150 ((equal c ?s)
15151 (call-interactively 'org-set-property))
15152 ((equal c ?d)
15153 (call-interactively 'org-delete-property))
15154 ((equal c ?D)
15155 (call-interactively 'org-delete-property-globally))
15156 ((equal c ?c)
15157 (call-interactively 'org-compute-property-at-point))
15158 (t (user-error "No such property action %c" c)))))
15160 (defun org-inc-effort ()
15161 "Increment the value of the effort property in the current entry."
15162 (interactive)
15163 (org-set-effort nil t))
15165 (defvar org-clock-effort) ;; Defined in org-clock.el
15166 (defvar org-clock-current-task) ;; Defined in org-clock.el
15167 (defun org-set-effort (&optional value increment)
15168 "Set the effort property of the current entry.
15169 With numerical prefix arg, use the nth allowed value, 0 stands for the
15170 10th allowed value.
15172 When INCREMENT is non-nil, set the property to the next allowed value."
15173 (interactive "P")
15174 (if (equal value 0) (setq value 10))
15175 (let* ((completion-ignore-case t)
15176 (prop org-effort-property)
15177 (cur (org-entry-get nil prop))
15178 (allowed (org-property-get-allowed-values nil prop 'table))
15179 (existing (mapcar 'list (org-property-values prop)))
15180 (heading (nth 4 (org-heading-components)))
15182 (val (cond
15183 ((stringp value) value)
15184 ((and allowed (integerp value))
15185 (or (car (nth (1- value) allowed))
15186 (car (org-last allowed))))
15187 ((and allowed increment)
15188 (or (caadr (member (list cur) allowed))
15189 (user-error "Allowed effort values are not set")))
15190 (allowed
15191 (message "Select 1-9,0, [RET%s]: %s"
15192 (if cur (concat "=" cur) "")
15193 (mapconcat 'car allowed " "))
15194 (setq rpl (read-char-exclusive))
15195 (if (equal rpl ?\r)
15197 (setq rpl (- rpl ?0))
15198 (if (equal rpl 0) (setq rpl 10))
15199 (if (and (> rpl 0) (<= rpl (length allowed)))
15200 (car (nth (1- rpl) allowed))
15201 (org-completing-read "Effort: " allowed nil))))
15203 (let (org-completion-use-ido org-completion-use-iswitchb)
15204 (org-completing-read
15205 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15206 (concat "[" cur "]") "")
15207 ": ")
15208 existing nil nil "" nil cur))))))
15209 (unless (equal (org-entry-get nil prop) val)
15210 (org-entry-put nil prop val))
15211 (save-excursion
15212 (org-back-to-heading t)
15213 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15214 (when (string= heading org-clock-current-task)
15215 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15216 (org-clock-update-mode-line))
15217 (message "%s is now %s" prop val)))
15219 (defun org-at-property-p ()
15220 "Is cursor inside a property drawer?"
15221 (save-excursion
15222 (when (equal 'node-property (car (org-element-at-point)))
15223 (beginning-of-line 1)
15224 (looking-at org-property-re))))
15226 (defun org-get-property-block (&optional beg end force)
15227 "Return the (beg . end) range of the body of the property drawer.
15228 BEG and END are the beginning and end of the current subtree, or of
15229 the part before the first headline. If they are not given, they will
15230 be found. If the drawer does not exist and FORCE is non-nil, create
15231 the drawer."
15232 (catch 'exit
15233 (save-excursion
15234 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15235 (progn (org-back-to-heading t) (point))))
15236 (end (or end (and (not (outline-next-heading)) (point-max))
15237 (point))))
15238 (goto-char beg)
15239 (if (re-search-forward org-property-start-re end t)
15240 (setq beg (1+ (match-end 0)))
15241 (if force
15242 (save-excursion
15243 (org-insert-property-drawer)
15244 (setq end (progn (outline-next-heading) (point))))
15245 (throw 'exit nil))
15246 (goto-char beg)
15247 (if (re-search-forward org-property-start-re end t)
15248 (setq beg (1+ (match-end 0)))))
15249 (if (re-search-forward org-property-end-re end t)
15250 (setq end (match-beginning 0))
15251 (or force (throw 'exit nil))
15252 (goto-char beg)
15253 (setq end beg)
15254 (org-indent-line)
15255 (insert ":END:\n"))
15256 (cons beg end)))))
15258 (defun org-entry-properties (&optional pom which specific)
15259 "Get all properties of the entry at point-or-marker POM.
15260 This includes the TODO keyword, the tags, time strings for deadline,
15261 scheduled, and clocking, and any additional properties defined in the
15262 entry. The return value is an alist, keys may occur multiple times
15263 if the property key was used several times.
15264 POM may also be nil, in which case the current entry is used.
15265 If WHICH is nil or `all', get all properties. If WHICH is
15266 `special' or `standard', only get that subclass. If WHICH
15267 is a string only get exactly this property. SPECIFIC can be a string, the
15268 specific property we are interested in. Specifying it can speed
15269 things up because then unnecessary parsing is avoided."
15270 (setq which (or which 'all))
15271 (org-with-wide-buffer
15272 (org-with-point-at pom
15273 (let ((clockstr (substring org-clock-string 0 -1))
15274 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15275 (case-fold-search nil)
15276 beg end range props sum-props key key1 value string clocksum clocksumt)
15277 (when (and (derived-mode-p 'org-mode)
15278 (ignore-errors (org-back-to-heading t)))
15279 (setq beg (point))
15280 (setq sum-props (get-text-property (point) 'org-summaries))
15281 (setq clocksum (get-text-property (point) :org-clock-minutes)
15282 clocksumt (get-text-property (point) :org-clock-minutes-today))
15283 (outline-next-heading)
15284 (setq end (point))
15285 (when (memq which '(all special))
15286 ;; Get the special properties, like TODO and tags
15287 (goto-char beg)
15288 (when (and (or (not specific) (string= specific "TODO"))
15289 (looking-at org-todo-line-regexp) (match-end 2))
15290 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15291 (when (and (or (not specific) (string= specific "PRIORITY"))
15292 (looking-at org-priority-regexp))
15293 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15294 (when (or (not specific) (string= specific "FILE"))
15295 (push (cons "FILE" buffer-file-name) props))
15296 (when (and (or (not specific) (string= specific "TAGS"))
15297 (setq value (org-get-tags-string))
15298 (string-match "\\S-" value))
15299 (push (cons "TAGS" value) props))
15300 (when (and (or (not specific) (string= specific "ALLTAGS"))
15301 (setq value (org-get-tags-at)))
15302 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15303 ":"))
15304 props))
15305 (when (or (not specific) (string= specific "BLOCKED"))
15306 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15307 (when (or (not specific)
15308 (member specific
15309 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15310 "TIMESTAMP" "TIMESTAMP_IA")))
15311 (catch 'match
15312 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15313 (setq key (if (match-end 1)
15314 (substring (org-match-string-no-properties 1)
15315 0 -1))
15316 string (if (equal key clockstr)
15317 (org-trim
15318 (buffer-substring-no-properties
15319 (match-beginning 3) (goto-char
15320 (point-at-eol))))
15321 (substring (org-match-string-no-properties 3)
15322 1 -1)))
15323 ;; Get the correct property name from the key. This is
15324 ;; necessary if the user has configured time keywords.
15325 (setq key1 (concat key ":"))
15326 (cond
15327 ((not key)
15328 (setq key
15329 (if (= (char-after (match-beginning 3)) ?\[)
15330 "TIMESTAMP_IA" "TIMESTAMP")))
15331 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15332 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15333 ((equal key1 org-closed-string) (setq key "CLOSED"))
15334 ((equal key1 org-clock-string) (setq key "CLOCK")))
15335 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15336 (progn
15337 (push (cons key string) props)
15338 ;; no need to search further if match is found
15339 (throw 'match t))
15340 (when (or (equal key "CLOCK") (not (assoc key props)))
15341 (push (cons key string) props)))))))
15343 (when (memq which '(all standard))
15344 ;; Get the standard properties, like :PROP: ...
15345 (setq range (org-get-property-block beg end))
15346 (when range
15347 (goto-char (car range))
15348 (while (re-search-forward org-property-re
15349 (cdr range) t)
15350 (setq key (org-match-string-no-properties 2)
15351 value (org-trim (or (org-match-string-no-properties 3) "")))
15352 (unless (member key excluded)
15353 (push (cons key (or value "")) props)))))
15354 (if clocksum
15355 (push (cons "CLOCKSUM"
15356 (org-columns-number-to-string (/ (float clocksum) 60.)
15357 'add_times))
15358 props))
15359 (if clocksumt
15360 (push (cons "CLOCKSUM_T"
15361 (org-columns-number-to-string (/ (float clocksumt) 60.)
15362 'add_times))
15363 props))
15364 (unless (assoc "CATEGORY" props)
15365 (push (cons "CATEGORY" (org-get-category)) props))
15366 (append sum-props (nreverse props)))))))
15368 (defun org-entry-get (pom property &optional inherit literal-nil)
15369 "Get value of PROPERTY for entry or content at point-or-marker POM.
15370 If INHERIT is non-nil and the entry does not have the property,
15371 then also check higher levels of the hierarchy.
15372 If INHERIT is the symbol `selective', use inheritance only if the setting
15373 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15374 If the property is present but empty, the return value is the empty string.
15375 If the property is not present at all, nil is returned.
15377 Return the value as a string.
15379 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15380 do not interpret it as the list atom nil. This is used for inheritance
15381 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15382 (org-with-point-at pom
15383 (if (and inherit (if (eq inherit 'selective)
15384 (org-property-inherit-p property)
15386 (org-entry-get-with-inheritance property literal-nil)
15387 (if (member property org-special-properties)
15388 ;; We need a special property. Use `org-entry-properties'
15389 ;; to retrieve it, but specify the wanted property
15390 (cdr (assoc property (org-entry-properties nil 'special property)))
15391 (org-with-wide-buffer
15392 (let ((range (org-get-property-block)))
15393 (when (and range (not (eq (car range) (cdr range))))
15394 (let* ((props
15395 (list (or (assoc property org-file-properties)
15396 (assoc property org-global-properties)
15397 (assoc property org-global-properties-fixed))))
15398 (ap (lambda (key)
15399 (when (re-search-forward
15400 (org-re-property key) (cdr range) t)
15401 (setq props
15402 (org-update-property-plist
15404 (if (match-end 3)
15405 (org-match-string-no-properties 3) "")
15406 props)))))
15407 val)
15408 (goto-char (car range))
15409 (funcall ap property)
15410 (goto-char (car range))
15411 (while (funcall ap (concat property "+")))
15412 (setq val (cdr (assoc property props)))
15413 (when val (if literal-nil val (org-not-nil val)))))))))))
15415 (defun org-property-or-variable-value (var &optional inherit)
15416 "Check if there is a property fixing the value of VAR.
15417 If yes, return this value. If not, return the current value of the variable."
15418 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15419 (if (and prop (stringp prop) (string-match "\\S-" prop))
15420 (read prop)
15421 (symbol-value var))))
15423 (defun org-entry-delete (pom property)
15424 "Delete the property PROPERTY from entry at point-or-marker POM."
15425 (unless (member property org-special-properties)
15426 (org-with-point-at pom
15427 (let ((range (org-get-property-block)))
15428 (if (and range
15429 (goto-char (car range))
15430 (re-search-forward
15431 (org-re-property property)
15432 (cdr range) t))
15433 (progn
15434 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15435 (org-remove-empty-drawer-at (car range))
15437 nil)))))
15439 ;; Multi-values properties are properties that contain multiple values
15440 ;; These values are assumed to be single words, separated by whitespace.
15441 (defun org-entry-add-to-multivalued-property (pom property value)
15442 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15443 (let* ((old (org-entry-get pom property))
15444 (values (and old (org-split-string old "[ \t]"))))
15445 (setq value (org-entry-protect-space value))
15446 (unless (member value values)
15447 (setq values (append values (list value)))
15448 (org-entry-put pom property
15449 (mapconcat 'identity values " ")))))
15451 (defun org-entry-remove-from-multivalued-property (pom property value)
15452 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15453 (let* ((old (org-entry-get pom property))
15454 (values (and old (org-split-string old "[ \t]"))))
15455 (setq value (org-entry-protect-space value))
15456 (when (member value values)
15457 (setq values (delete value values))
15458 (org-entry-put pom property
15459 (mapconcat 'identity values " ")))))
15461 (defun org-entry-member-in-multivalued-property (pom property value)
15462 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15463 (let* ((old (org-entry-get pom property))
15464 (values (and old (org-split-string old "[ \t]"))))
15465 (setq value (org-entry-protect-space value))
15466 (member value values)))
15468 (defun org-entry-get-multivalued-property (pom property)
15469 "Return a list of values in a multivalued property."
15470 (let* ((value (org-entry-get pom property))
15471 (values (and value (org-split-string value "[ \t]"))))
15472 (mapcar 'org-entry-restore-space values)))
15474 (defun org-entry-put-multivalued-property (pom property &rest values)
15475 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15476 VALUES should be a list of strings. Spaces will be protected."
15477 (org-entry-put pom property
15478 (mapconcat 'org-entry-protect-space values " "))
15479 (let* ((value (org-entry-get pom property))
15480 (values (and value (org-split-string value "[ \t]"))))
15481 (mapcar 'org-entry-restore-space values)))
15483 (defun org-entry-protect-space (s)
15484 "Protect spaces and newline in string S."
15485 (while (string-match " " s)
15486 (setq s (replace-match "%20" t t s)))
15487 (while (string-match "\n" s)
15488 (setq s (replace-match "%0A" t t s)))
15491 (defun org-entry-restore-space (s)
15492 "Restore spaces and newline in string S."
15493 (while (string-match "%20" s)
15494 (setq s (replace-match " " t t s)))
15495 (while (string-match "%0A" s)
15496 (setq s (replace-match "\n" t t s)))
15499 (defvar org-entry-property-inherited-from (make-marker)
15500 "Marker pointing to the entry from where a property was inherited.
15501 Each call to `org-entry-get-with-inheritance' will set this marker to the
15502 location of the entry where the inheritance search matched. If there was
15503 no match, the marker will point nowhere.
15504 Note that also `org-entry-get' calls this function, if the INHERIT flag
15505 is set.")
15507 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15508 "Get PROPERTY of entry or content at point, search higher levels if needed.
15509 The search will stop at the first ancestor which has the property defined.
15510 If the value found is \"nil\", return nil to show that the property
15511 should be considered as undefined (this is the meaning of nil here).
15512 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15513 (move-marker org-entry-property-inherited-from nil)
15514 (let (tmp)
15515 (save-excursion
15516 (save-restriction
15517 (widen)
15518 (catch 'ex
15519 (while t
15520 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15521 (or (ignore-errors (org-back-to-heading t))
15522 (goto-char (point-min)))
15523 (move-marker org-entry-property-inherited-from (point))
15524 (throw 'ex tmp))
15525 (or (ignore-errors (org-up-heading-safe))
15526 (throw 'ex nil))))))
15527 (setq tmp (or tmp
15528 (cdr (assoc property org-file-properties))
15529 (cdr (assoc property org-global-properties))
15530 (cdr (assoc property org-global-properties-fixed))))
15531 (if literal-nil tmp (org-not-nil tmp))))
15533 (defvar org-property-changed-functions nil
15534 "Hook called when the value of a property has changed.
15535 Each hook function should accept two arguments, the name of the property
15536 and the new value.")
15538 (defun org-entry-put (pom property value)
15539 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15540 If the value is `nil', it is converted to the empty string.
15541 If it is not a string, an error is raised."
15542 (cond ((null value) (setq value ""))
15543 ((not (stringp value))
15544 (error "Properties values should be strings.")))
15545 (org-with-point-at pom
15546 (org-back-to-heading t)
15547 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15548 range)
15549 (cond
15550 ((equal property "TODO")
15551 (when (and (string-match "\\S-" value)
15552 (not (member value org-todo-keywords-1)))
15553 (user-error "\"%s\" is not a valid TODO state" value))
15554 (if (or (not value)
15555 (not (string-match "\\S-" value)))
15556 (setq value 'none))
15557 (org-todo value)
15558 (org-set-tags nil 'align))
15559 ((equal property "PRIORITY")
15560 (org-priority (if (and value (string-match "\\S-" value))
15561 (string-to-char value) ?\ ))
15562 (org-set-tags nil 'align))
15563 ((equal property "CLOCKSUM")
15564 (if (not (re-search-forward
15565 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15566 (error "Cannot find a clock log")
15567 (goto-char (- (match-end 1) 2))
15568 (cond
15569 ((eq value 'earlier) (org-timestamp-down))
15570 ((eq value 'later) (org-timestamp-up)))
15571 (org-clock-sum-current-item)))
15572 ((equal property "SCHEDULED")
15573 (if (re-search-forward org-scheduled-time-regexp end t)
15574 (cond
15575 ((eq value 'earlier) (org-timestamp-change -1 'day))
15576 ((eq value 'later) (org-timestamp-change 1 'day))
15577 (t (call-interactively 'org-schedule)))
15578 (call-interactively 'org-schedule)))
15579 ((equal property "DEADLINE")
15580 (if (re-search-forward org-deadline-time-regexp end t)
15581 (cond
15582 ((eq value 'earlier) (org-timestamp-change -1 'day))
15583 ((eq value 'later) (org-timestamp-change 1 'day))
15584 (t (call-interactively 'org-deadline)))
15585 (call-interactively 'org-deadline)))
15586 ((member property org-special-properties)
15587 (error "The %s property can not yet be set with `org-entry-put'"
15588 property))
15589 (t ; a non-special property
15590 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15591 (setq range (org-get-property-block beg end 'force))
15592 (goto-char (car range))
15593 (if (re-search-forward
15594 (org-re-property property) (cdr range) t)
15595 (progn
15596 (delete-region (match-beginning 0) (match-end 0))
15597 (goto-char (match-beginning 0)))
15598 (goto-char (cdr range))
15599 (insert "\n")
15600 (backward-char 1)
15601 (org-indent-line))
15602 (insert ":" property ":")
15603 (and value (insert " " value))
15604 (org-indent-line)))))
15605 (run-hook-with-args 'org-property-changed-functions property value)))
15607 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15608 "Get all property keys in the current buffer.
15609 With INCLUDE-SPECIALS, also list the special properties that reflect things
15610 like tags and TODO state.
15611 With INCLUDE-DEFAULTS, also include properties that has special meaning
15612 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15613 and others.
15614 With INCLUDE-COLUMNS, also include property names given in COLUMN
15615 formats in the current buffer."
15616 (let (rtn range cfmt s p)
15617 (save-excursion
15618 (save-restriction
15619 (widen)
15620 (goto-char (point-min))
15621 (while (re-search-forward org-property-start-re nil t)
15622 (setq range (org-get-property-block))
15623 (goto-char (car range))
15624 (while (re-search-forward org-property-re
15625 (cdr range) t)
15626 (add-to-list 'rtn (org-match-string-no-properties 2)))
15627 (outline-next-heading))))
15629 (when include-specials
15630 (setq rtn (append org-special-properties rtn)))
15632 (when include-defaults
15633 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15634 (add-to-list 'rtn org-effort-property))
15636 (when include-columns
15637 (save-excursion
15638 (save-restriction
15639 (widen)
15640 (goto-char (point-min))
15641 (while (re-search-forward
15642 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15643 nil t)
15644 (setq cfmt (match-string 2) s 0)
15645 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15646 cfmt s)
15647 (setq s (match-end 0)
15648 p (match-string 1 cfmt))
15649 (unless (or (equal p "ITEM")
15650 (member p org-special-properties))
15651 (add-to-list 'rtn (match-string 1 cfmt))))))))
15653 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15655 (defun org-property-values (key)
15656 "Return a list of all values of property KEY in the current buffer."
15657 (save-excursion
15658 (save-restriction
15659 (widen)
15660 (goto-char (point-min))
15661 (let ((re (org-re-property key))
15662 values)
15663 (while (re-search-forward re nil t)
15664 (add-to-list 'values (org-trim (match-string 3))))
15665 (delete "" values)))))
15667 (defun org-insert-property-drawer ()
15668 "Insert a property drawer into the current entry."
15669 (org-back-to-heading t)
15670 (looking-at org-outline-regexp)
15671 (let ((indent (if org-adapt-indentation
15672 (- (match-end 0) (match-beginning 0))
15674 (beg (point))
15675 (re (concat "^[ \t]*" org-keyword-time-regexp))
15676 end hiddenp)
15677 (outline-next-heading)
15678 (setq end (point))
15679 (goto-char beg)
15680 (while (re-search-forward re end t))
15681 (setq hiddenp (outline-invisible-p))
15682 (end-of-line 1)
15683 (and (equal (char-after) ?\n) (forward-char 1))
15684 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15685 (if (member (match-string 1) '("CLOCK:" ":END:"))
15686 ;; just skip this line
15687 (beginning-of-line 2)
15688 ;; Drawer start, find the end
15689 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15690 (beginning-of-line 1)))
15691 (org-skip-over-state-notes)
15692 (skip-chars-backward " \t\n\r")
15693 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15694 (forward-char 1))
15695 (goto-char (point-at-eol))
15696 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15697 (beginning-of-line 0)
15698 (org-indent-to-column indent)
15699 (beginning-of-line 2)
15700 (org-indent-to-column indent)
15701 (beginning-of-line 0)
15702 (if hiddenp
15703 (save-excursion
15704 (org-back-to-heading t)
15705 (hide-entry))
15706 (org-flag-drawer t))))
15708 (defun org-insert-drawer (&optional arg drawer)
15709 "Insert a drawer at point.
15711 Optional argument DRAWER, when non-nil, is a string representing
15712 drawer's name. Otherwise, the user is prompted for a name.
15714 If a region is active, insert the drawer around that region
15715 instead.
15717 Point is left between drawer's boundaries."
15718 (interactive "P")
15719 (let* ((drawer (if arg "PROPERTIES"
15720 (or drawer (read-from-minibuffer "Drawer: ")))))
15721 (cond
15722 ;; With C-u, fall back on `org-insert-property-drawer'
15723 (arg (org-insert-property-drawer))
15725 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
15726 (user-error "Invalid drawer name"))
15727 ;; With an active region, insert a drawer at point.
15728 ((not (org-region-active-p))
15729 (progn
15730 (unless (bolp) (insert "\n"))
15731 (insert (format ":%s:\n\n:END:\n" drawer))
15732 (forward-line -2)))
15733 ;; Otherwise, insert the drawer at point
15735 (let ((rbeg (region-beginning))
15736 (rend (copy-marker (region-end))))
15737 (unwind-protect
15738 (progn
15739 (goto-char rbeg)
15740 (beginning-of-line)
15741 (when (save-excursion
15742 (re-search-forward org-outline-regexp-bol rend t))
15743 (user-error "Drawers cannot contain headlines"))
15744 ;; Position point at the beginning of the first
15745 ;; non-blank line in region. Insert drawer's opening
15746 ;; there, then indent it.
15747 (org-skip-whitespace)
15748 (beginning-of-line)
15749 (insert ":" drawer ":\n")
15750 (forward-line -1)
15751 (indent-for-tab-command)
15752 ;; Move point to the beginning of the first blank line
15753 ;; after the last non-blank line in region. Insert
15754 ;; drawer's closing, then indent it.
15755 (goto-char rend)
15756 (skip-chars-backward " \r\t\n")
15757 (insert "\n:END:")
15758 (deactivate-mark t)
15759 (indent-for-tab-command)
15760 (unless (eolp) (insert "\n")))
15761 ;; Clear marker, whatever the outcome of insertion is.
15762 (set-marker rend nil)))))))
15764 (defvar org-property-set-functions-alist nil
15765 "Property set function alist.
15766 Each entry should have the following format:
15768 (PROPERTY . READ-FUNCTION)
15770 The read function will be called with the same argument as
15771 `org-completing-read'.")
15773 (defun org-set-property-function (property)
15774 "Get the function that should be used to set PROPERTY.
15775 This is computed according to `org-property-set-functions-alist'."
15776 (or (cdr (assoc property org-property-set-functions-alist))
15777 'org-completing-read))
15779 (defun org-read-property-value (property)
15780 "Read PROPERTY value from user."
15781 (let* ((completion-ignore-case t)
15782 (allowed (org-property-get-allowed-values nil property 'table))
15783 (cur (org-entry-get nil property))
15784 (prompt (concat property " value"
15785 (if (and cur (string-match "\\S-" cur))
15786 (concat " [" cur "]") "") ": "))
15787 (set-function (org-set-property-function property))
15788 (val (if allowed
15789 (funcall set-function prompt allowed nil
15790 (not (get-text-property 0 'org-unrestricted
15791 (caar allowed))))
15792 (let (org-completion-use-ido org-completion-use-iswitchb)
15793 (funcall set-function prompt
15794 (mapcar 'list (org-property-values property))
15795 nil nil "" nil cur)))))
15796 (if (equal val "")
15798 val)))
15800 (defvar org-last-set-property nil)
15801 (defvar org-last-set-property-value nil)
15802 (defun org-read-property-name ()
15803 "Read a property name."
15804 (let* ((completion-ignore-case t)
15805 (keys (org-buffer-property-keys nil t t))
15806 (default-prop (or (save-excursion
15807 (save-match-data
15808 (beginning-of-line)
15809 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15810 (null (string= (match-string 1) "END"))
15811 (match-string 1))))
15812 org-last-set-property))
15813 (property (org-icompleting-read
15814 (concat "Property"
15815 (if default-prop (concat " [" default-prop "]") "")
15816 ": ")
15817 (mapcar 'list keys)
15818 nil nil nil nil
15819 default-prop)))
15820 (if (member property keys)
15821 property
15822 (or (cdr (assoc (downcase property)
15823 (mapcar (lambda (x) (cons (downcase x) x))
15824 keys)))
15825 property))))
15827 (defun org-set-property-and-value (use-last)
15828 "Allow to set [PROPERTY]: [value] direction from prompt.
15829 When use-default, don't even ask, just use the last
15830 \"[PROPERTY]: [value]\" string from the history."
15831 (interactive "P")
15832 (let* ((completion-ignore-case t)
15833 (pv (or (and use-last org-last-set-property-value)
15834 (org-completing-read
15835 "Enter a \"[Property]: [value]\" pair: "
15836 nil nil nil nil nil
15837 org-last-set-property-value)))
15838 prop val)
15839 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15840 (setq prop (match-string 1 pv)
15841 val (match-string 2 pv))
15842 (org-set-property prop val))))
15844 (defun org-set-property (property value)
15845 "In the current entry, set PROPERTY to VALUE.
15846 When called interactively, this will prompt for a property name, offering
15847 completion on existing and default properties. And then it will prompt
15848 for a value, offering completion either on allowed values (via an inherited
15849 xxx_ALL property) or on existing values in other instances of this property
15850 in the current file."
15851 (interactive (list nil nil))
15852 (let* ((property (or property (org-read-property-name)))
15853 (value (or value (org-read-property-value property)))
15854 (fn (cdr (assoc property org-properties-postprocess-alist))))
15855 (setq org-last-set-property property)
15856 (setq org-last-set-property-value (concat property ": " value))
15857 ;; Possibly postprocess the inserted value:
15858 (when fn (setq value (funcall fn value)))
15859 (unless (equal (org-entry-get nil property) value)
15860 (org-entry-put nil property value))))
15862 (defun org-delete-property (property)
15863 "In the current entry, delete PROPERTY."
15864 (interactive
15865 (let* ((completion-ignore-case t)
15866 (prop (org-icompleting-read "Property: "
15867 (org-entry-properties nil 'standard))))
15868 (list prop)))
15869 (message "Property %s %s" property
15870 (if (org-entry-delete nil property)
15871 "deleted"
15872 "was not present in the entry")))
15874 (defun org-delete-property-globally (property)
15875 "Remove PROPERTY globally, from all entries."
15876 (interactive
15877 (let* ((completion-ignore-case t)
15878 (prop (org-icompleting-read
15879 "Globally remove property: "
15880 (mapcar 'list (org-buffer-property-keys)))))
15881 (list prop)))
15882 (save-excursion
15883 (save-restriction
15884 (widen)
15885 (goto-char (point-min))
15886 (let ((cnt 0))
15887 (while (re-search-forward
15888 (org-re-property property)
15889 nil t)
15890 (setq cnt (1+ cnt))
15891 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15892 (message "Property \"%s\" removed from %d entries" property cnt)))))
15894 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15896 (defun org-compute-property-at-point ()
15897 "Compute the property at point.
15898 This looks for an enclosing column format, extracts the operator and
15899 then applies it to the property in the column format's scope."
15900 (interactive)
15901 (unless (org-at-property-p)
15902 (user-error "Not at a property"))
15903 (let ((prop (org-match-string-no-properties 2)))
15904 (org-columns-get-format-and-top-level)
15905 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15906 (user-error "No operator defined for property %s" prop))
15907 (org-columns-compute prop)))
15909 (defvar org-property-allowed-value-functions nil
15910 "Hook for functions supplying allowed values for a specific property.
15911 The functions must take a single argument, the name of the property, and
15912 return a flat list of allowed values. If \":ETC\" is one of
15913 the values, this means that these values are intended as defaults for
15914 completion, but that other values should be allowed too.
15915 The functions must return nil if they are not responsible for this
15916 property.")
15918 (defun org-property-get-allowed-values (pom property &optional table)
15919 "Get allowed values for the property PROPERTY.
15920 When TABLE is non-nil, return an alist that can directly be used for
15921 completion."
15922 (let (vals)
15923 (cond
15924 ((equal property "TODO")
15925 (setq vals (org-with-point-at pom
15926 (append org-todo-keywords-1 '("")))))
15927 ((equal property "PRIORITY")
15928 (let ((n org-lowest-priority))
15929 (while (>= n org-highest-priority)
15930 (push (char-to-string n) vals)
15931 (setq n (1- n)))))
15932 ((member property org-special-properties))
15933 ((setq vals (run-hook-with-args-until-success
15934 'org-property-allowed-value-functions property)))
15936 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15937 (when (and vals (string-match "\\S-" vals))
15938 (setq vals (car (read-from-string (concat "(" vals ")"))))
15939 (setq vals (mapcar (lambda (x)
15940 (cond ((stringp x) x)
15941 ((numberp x) (number-to-string x))
15942 ((symbolp x) (symbol-name x))
15943 (t "???")))
15944 vals)))))
15945 (when (member ":ETC" vals)
15946 (setq vals (remove ":ETC" vals))
15947 (org-add-props (car vals) '(org-unrestricted t)))
15948 (if table (mapcar 'list vals) vals)))
15950 (defun org-property-previous-allowed-value (&optional previous)
15951 "Switch to the next allowed value for this property."
15952 (interactive)
15953 (org-property-next-allowed-value t))
15955 (defun org-property-next-allowed-value (&optional previous)
15956 "Switch to the next allowed value for this property."
15957 (interactive)
15958 (unless (org-at-property-p)
15959 (user-error "Not at a property"))
15960 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15961 (key (match-string 2))
15962 (value (match-string 3))
15963 (allowed (or (org-property-get-allowed-values (point) key)
15964 (and (member value '("[ ]" "[-]" "[X]"))
15965 '("[ ]" "[X]"))))
15966 (heading (save-match-data (nth 4 (org-heading-components))))
15967 nval)
15968 (unless allowed
15969 (user-error "Allowed values for this property have not been defined"))
15970 (if previous (setq allowed (reverse allowed)))
15971 (if (member value allowed)
15972 (setq nval (car (cdr (member value allowed)))))
15973 (setq nval (or nval (car allowed)))
15974 (if (equal nval value)
15975 (user-error "Only one allowed value for this property"))
15976 (org-at-property-p)
15977 (replace-match (concat " :" key ": " nval) t t)
15978 (org-indent-line)
15979 (beginning-of-line 1)
15980 (skip-chars-forward " \t")
15981 (when (equal prop org-effort-property)
15982 (save-excursion
15983 (org-back-to-heading t)
15984 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
15985 (when (string= org-clock-current-task heading)
15986 (setq org-clock-effort nval)
15987 (org-clock-update-mode-line)))
15988 (run-hook-with-args 'org-property-changed-functions key nval)))
15990 (defun org-find-olp (path &optional this-buffer)
15991 "Return a marker pointing to the entry at outline path OLP.
15992 If anything goes wrong, throw an error.
15993 You can wrap this call to catch the error like this:
15995 (condition-case msg
15996 (org-mobile-locate-entry (match-string 4))
15997 (error (nth 1 msg)))
15999 The return value will then be either a string with the error message,
16000 or a marker if everything is OK.
16002 If THIS-BUFFER is set, the outline path does not contain a file,
16003 only headings."
16004 (let* ((file (if this-buffer buffer-file-name (pop path)))
16005 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16006 (level 1)
16007 (lmin 1)
16008 (lmax 1)
16009 limit re end found pos heading cnt flevel)
16010 (unless buffer (error "File not found :%s" file))
16011 (with-current-buffer buffer
16012 (save-excursion
16013 (save-restriction
16014 (widen)
16015 (setq limit (point-max))
16016 (goto-char (point-min))
16017 (while (setq heading (pop path))
16018 (setq re (format org-complex-heading-regexp-format
16019 (regexp-quote heading)))
16020 (setq cnt 0 pos (point))
16021 (while (re-search-forward re end t)
16022 (setq level (- (match-end 1) (match-beginning 1)))
16023 (if (and (>= level lmin) (<= level lmax))
16024 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16025 (when (= cnt 0) (error "Heading not found on level %d: %s"
16026 lmax heading))
16027 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16028 lmax heading))
16029 (goto-char found)
16030 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16031 (setq end (save-excursion (org-end-of-subtree t t))))
16032 (when (org-at-heading-p)
16033 (point-marker)))))))
16035 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16036 "Find node HEADING in BUFFER.
16037 Return a marker to the heading if it was found, or nil if not.
16038 If POS-ONLY is set, return just the position instead of a marker.
16040 The heading text must match exact, but it may have a TODO keyword,
16041 a priority cookie and tags in the standard locations."
16042 (with-current-buffer (or buffer (current-buffer))
16043 (save-excursion
16044 (save-restriction
16045 (widen)
16046 (goto-char (point-min))
16047 (let (case-fold-search)
16048 (if (re-search-forward
16049 (format org-complex-heading-regexp-format
16050 (regexp-quote heading)) nil t)
16051 (if pos-only
16052 (match-beginning 0)
16053 (move-marker (make-marker) (match-beginning 0)))))))))
16055 (defun org-find-exact-heading-in-directory (heading &optional dir)
16056 "Find Org node headline HEADING in all .org files in directory DIR.
16057 When the target headline is found, return a marker to this location."
16058 (let ((files (directory-files (or dir default-directory)
16059 nil "\\`[^.#].*\\.org\\'"))
16060 file visiting m buffer)
16061 (catch 'found
16062 (while (setq file (pop files))
16063 (message "trying %s" file)
16064 (setq visiting (org-find-base-buffer-visiting file))
16065 (setq buffer (or visiting (find-file-noselect file)))
16066 (setq m (org-find-exact-headline-in-buffer
16067 heading buffer))
16068 (when (and (not m) (not visiting)) (kill-buffer buffer))
16069 (and m (throw 'found m))))))
16071 (defun org-find-entry-with-id (ident)
16072 "Locate the entry that contains the ID property with exact value IDENT.
16073 IDENT can be a string, a symbol or a number, this function will search for
16074 the string representation of it.
16075 Return the position where this entry starts, or nil if there is no such entry."
16076 (interactive "sID: ")
16077 (let ((id (cond
16078 ((stringp ident) ident)
16079 ((symbol-name ident) (symbol-name ident))
16080 ((numberp ident) (number-to-string ident))
16081 (t (error "IDENT %s must be a string, symbol or number" ident))))
16082 (case-fold-search nil))
16083 (save-excursion
16084 (save-restriction
16085 (widen)
16086 (goto-char (point-min))
16087 (when (re-search-forward
16088 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16089 nil t)
16090 (org-back-to-heading t)
16091 (point))))))
16093 ;;;; Timestamps
16095 (defvar org-last-changed-timestamp nil)
16096 (defvar org-last-inserted-timestamp nil
16097 "The last time stamp inserted with `org-insert-time-stamp'.")
16098 (defvar org-ts-what) ; dynamically scoped parameter
16100 (defun org-time-stamp (arg &optional inactive)
16101 "Prompt for a date/time and insert a time stamp.
16102 If the user specifies a time like HH:MM or if this command is
16103 called with at least one prefix argument, the time stamp contains
16104 the date and the time. Otherwise, only the date is be included.
16106 All parts of a date not specified by the user is filled in from
16107 the current date/time. So if you just press return without
16108 typing anything, the time stamp will represent the current
16109 date/time.
16111 If there is already a timestamp at the cursor, it will be
16112 modified.
16114 With two universal prefix arguments, insert an active timestamp
16115 with the current time without prompting the user.
16117 When called from lisp, the timestamp is inactive if INACTIVE is
16118 non-nil."
16119 (interactive "P")
16120 (let* ((ts nil)
16121 (default-time
16122 ;; Default time is either today, or, when entering a range,
16123 ;; the range start.
16124 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16125 (save-excursion
16126 (re-search-backward
16127 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16128 (- (point) 20) t)))
16129 (apply 'encode-time (org-parse-time-string (match-string 1)))
16130 (current-time)))
16131 (default-input (and ts (org-get-compact-tod ts)))
16132 (repeater (save-excursion
16133 (save-match-data
16134 (beginning-of-line)
16135 (when (re-search-forward
16136 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16137 (save-excursion (progn (end-of-line) (point))) t)
16138 (match-string 0)))))
16139 org-time-was-given org-end-time-was-given time)
16140 (cond
16141 ((and (org-at-timestamp-p t)
16142 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16143 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16144 (insert "--")
16145 (setq time (let ((this-command this-command))
16146 (org-read-date arg 'totime nil nil
16147 default-time default-input inactive)))
16148 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16149 ((org-at-timestamp-p t)
16150 (setq time (let ((this-command this-command))
16151 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16152 (when (org-at-timestamp-p t) ; just to get the match data
16153 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16154 (replace-match "")
16155 (setq org-last-changed-timestamp
16156 (org-insert-time-stamp
16157 time (or org-time-was-given arg)
16158 inactive nil nil (list org-end-time-was-given)))
16159 (when repeater (goto-char (1- (point))) (insert " " repeater)
16160 (setq org-last-changed-timestamp
16161 (concat (substring org-last-inserted-timestamp 0 -1)
16162 " " repeater ">"))))
16163 (message "Timestamp updated"))
16164 ((equal arg '(16))
16165 (org-insert-time-stamp (current-time) t inactive))
16167 (setq time (let ((this-command this-command))
16168 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16169 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16170 nil nil (list org-end-time-was-given))))))
16172 ;; FIXME: can we use this for something else, like computing time differences?
16173 (defun org-get-compact-tod (s)
16174 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16175 (let* ((t1 (match-string 1 s))
16176 (h1 (string-to-number (match-string 2 s)))
16177 (m1 (string-to-number (match-string 3 s)))
16178 (t2 (and (match-end 4) (match-string 5 s)))
16179 (h2 (and t2 (string-to-number (match-string 6 s))))
16180 (m2 (and t2 (string-to-number (match-string 7 s))))
16181 dh dm)
16182 (if (not t2)
16184 (setq dh (- h2 h1) dm (- m2 m1))
16185 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16186 (concat t1 "+" (number-to-string dh)
16187 (and (/= 0 dm) (format ":%02d" dm)))))))
16189 (defun org-time-stamp-inactive (&optional arg)
16190 "Insert an inactive time stamp.
16191 An inactive time stamp is enclosed in square brackets instead of angle
16192 brackets. It is inactive in the sense that it does not trigger agenda entries,
16193 does not link to the calendar and cannot be changed with the S-cursor keys.
16194 So these are more for recording a certain time/date."
16195 (interactive "P")
16196 (org-time-stamp arg 'inactive))
16198 (defvar org-date-ovl (make-overlay 1 1))
16199 (overlay-put org-date-ovl 'face 'org-date-selected)
16200 (org-detach-overlay org-date-ovl)
16202 (defvar org-ans1) ; dynamically scoped parameter
16203 (defvar org-ans2) ; dynamically scoped parameter
16205 (defvar org-plain-time-of-day-regexp) ; defined below
16207 (defvar org-overriding-default-time nil) ; dynamically scoped
16208 (defvar org-read-date-overlay nil)
16209 (defvar org-dcst nil) ; dynamically scoped
16210 (defvar org-read-date-history nil)
16211 (defvar org-read-date-final-answer nil)
16212 (defvar org-read-date-analyze-futurep nil)
16213 (defvar org-read-date-analyze-forced-year nil)
16214 (defvar org-read-date-inactive)
16216 (defvar org-read-date-minibuffer-local-map
16217 (let* ((org-replace-disputed-keys nil)
16218 (map (make-sparse-keymap)))
16219 (set-keymap-parent map minibuffer-local-map)
16220 (org-defkey map (kbd ".")
16221 (lambda () (interactive)
16222 ;; Are we at the beginning of the prompt?
16223 (if (looking-back "^[^:]+: ")
16224 (org-eval-in-calendar '(calendar-goto-today))
16225 (insert "."))))
16226 (org-defkey map (kbd "C-.")
16227 (lambda () (interactive)
16228 (org-eval-in-calendar '(calendar-goto-today))))
16229 (org-defkey map [(meta shift left)]
16230 (lambda () (interactive)
16231 (org-eval-in-calendar '(calendar-backward-month 1))))
16232 (org-defkey map [(meta shift right)]
16233 (lambda () (interactive)
16234 (org-eval-in-calendar '(calendar-forward-month 1))))
16235 (org-defkey map [(meta shift up)]
16236 (lambda () (interactive)
16237 (org-eval-in-calendar '(calendar-backward-year 1))))
16238 (org-defkey map [(meta shift down)]
16239 (lambda () (interactive)
16240 (org-eval-in-calendar '(calendar-forward-year 1))))
16241 (org-defkey map [?\e (shift left)]
16242 (lambda () (interactive)
16243 (org-eval-in-calendar '(calendar-backward-month 1))))
16244 (org-defkey map [?\e (shift right)]
16245 (lambda () (interactive)
16246 (org-eval-in-calendar '(calendar-forward-month 1))))
16247 (org-defkey map [?\e (shift up)]
16248 (lambda () (interactive)
16249 (org-eval-in-calendar '(calendar-backward-year 1))))
16250 (org-defkey map [?\e (shift down)]
16251 (lambda () (interactive)
16252 (org-eval-in-calendar '(calendar-forward-year 1))))
16253 (org-defkey map [(shift up)]
16254 (lambda () (interactive)
16255 (org-eval-in-calendar '(calendar-backward-week 1))))
16256 (org-defkey map [(shift down)]
16257 (lambda () (interactive)
16258 (org-eval-in-calendar '(calendar-forward-week 1))))
16259 (org-defkey map [(shift left)]
16260 (lambda () (interactive)
16261 (org-eval-in-calendar '(calendar-backward-day 1))))
16262 (org-defkey map [(shift right)]
16263 (lambda () (interactive)
16264 (org-eval-in-calendar '(calendar-forward-day 1))))
16265 (org-defkey map "!"
16266 (lambda () (interactive)
16267 (org-eval-in-calendar '(diary-view-entries))
16268 (message "")))
16269 (org-defkey map ">"
16270 (lambda () (interactive)
16271 (org-eval-in-calendar '(scroll-calendar-left 1))))
16272 (org-defkey map "<"
16273 (lambda () (interactive)
16274 (org-eval-in-calendar '(scroll-calendar-right 1))))
16275 (org-defkey map "\C-v"
16276 (lambda () (interactive)
16277 (org-eval-in-calendar
16278 '(calendar-scroll-left-three-months 1))))
16279 (org-defkey map "\M-v"
16280 (lambda () (interactive)
16281 (org-eval-in-calendar
16282 '(calendar-scroll-right-three-months 1))))
16283 map)
16284 "Keymap for minibuffer commands when using `org-read-date'.")
16286 (defvar org-def)
16287 (defvar org-defdecode)
16288 (defvar org-with-time)
16290 (defun org-read-date (&optional org-with-time to-time from-string prompt
16291 default-time default-input inactive)
16292 "Read a date, possibly a time, and make things smooth for the user.
16293 The prompt will suggest to enter an ISO date, but you can also enter anything
16294 which will at least partially be understood by `parse-time-string'.
16295 Unrecognized parts of the date will default to the current day, month, year,
16296 hour and minute. If this command is called to replace a timestamp at point,
16297 or to enter the second timestamp of a range, the default time is taken
16298 from the existing stamp. Furthermore, the command prefers the future,
16299 so if you are giving a date where the year is not given, and the day-month
16300 combination is already past in the current year, it will assume you
16301 mean next year. For details, see the manual. A few examples:
16303 3-2-5 --> 2003-02-05
16304 feb 15 --> currentyear-02-15
16305 2/15 --> currentyear-02-15
16306 sep 12 9 --> 2009-09-12
16307 12:45 --> today 12:45
16308 22 sept 0:34 --> currentyear-09-22 0:34
16309 12 --> currentyear-currentmonth-12
16310 Fri --> nearest Friday after today
16311 -Tue --> last Tuesday
16312 etc.
16314 Furthermore you can specify a relative date by giving, as the *first* thing
16315 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16316 change in days weeks, months, years.
16317 With a single plus or minus, the date is relative to today. With a double
16318 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16319 +4d --> four days from today
16320 +4 --> same as above
16321 +2w --> two weeks from today
16322 ++5 --> five days from default date
16324 The function understands only English month and weekday abbreviations.
16326 While prompting, a calendar is popped up - you can also select the
16327 date with the mouse (button 1). The calendar shows a period of three
16328 months. To scroll it to other months, use the keys `>' and `<'.
16329 If you don't like the calendar, turn it off with
16330 \(setq org-read-date-popup-calendar nil)
16332 With optional argument TO-TIME, the date will immediately be converted
16333 to an internal time.
16334 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16335 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16336 still enter a time, and this function will inform the calling routine
16337 about this change. The calling routine may then choose to change the
16338 format used to insert the time stamp into the buffer to include the time.
16339 With optional argument FROM-STRING, read from this string instead from
16340 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16341 the time/date that is used for everything that is not specified by the
16342 user."
16343 (require 'parse-time)
16344 (let* ((org-time-stamp-rounding-minutes
16345 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16346 (org-dcst org-display-custom-times)
16347 (ct (org-current-time))
16348 (org-def (or org-overriding-default-time default-time ct))
16349 (org-defdecode (decode-time org-def))
16350 (dummy (progn
16351 (when (< (nth 2 org-defdecode) org-extend-today-until)
16352 (setcar (nthcdr 2 org-defdecode) -1)
16353 (setcar (nthcdr 1 org-defdecode) 59)
16354 (setq org-def (apply 'encode-time org-defdecode)
16355 org-defdecode (decode-time org-def)))))
16356 (mouse-autoselect-window nil) ; Don't let the mouse jump
16357 (calendar-frame-setup nil)
16358 (calendar-setup nil)
16359 (calendar-move-hook nil)
16360 (calendar-view-diary-initially-flag nil)
16361 (calendar-view-holidays-initially-flag nil)
16362 (timestr (format-time-string
16363 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16364 (prompt (concat (if prompt (concat prompt " ") "")
16365 (format "Date+time [%s]: " timestr)))
16366 ans (org-ans0 "") org-ans1 org-ans2 final)
16368 (cond
16369 (from-string (setq ans from-string))
16370 (org-read-date-popup-calendar
16371 (save-excursion
16372 (save-window-excursion
16373 (calendar)
16374 (org-eval-in-calendar '(setq cursor-type nil) t)
16375 (unwind-protect
16376 (progn
16377 (calendar-forward-day (- (time-to-days org-def)
16378 (calendar-absolute-from-gregorian
16379 (calendar-current-date))))
16380 (org-eval-in-calendar nil t)
16381 (let* ((old-map (current-local-map))
16382 (map (copy-keymap calendar-mode-map))
16383 (minibuffer-local-map
16384 (copy-keymap org-read-date-minibuffer-local-map)))
16385 (org-defkey map (kbd "RET") 'org-calendar-select)
16386 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16387 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16388 (unwind-protect
16389 (progn
16390 (use-local-map map)
16391 (setq org-read-date-inactive inactive)
16392 (add-hook 'post-command-hook 'org-read-date-display)
16393 (setq org-ans0 (read-string prompt default-input
16394 'org-read-date-history nil))
16395 ;; org-ans0: from prompt
16396 ;; org-ans1: from mouse click
16397 ;; org-ans2: from calendar motion
16398 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16399 (remove-hook 'post-command-hook 'org-read-date-display)
16400 (use-local-map old-map)
16401 (when org-read-date-overlay
16402 (delete-overlay org-read-date-overlay)
16403 (setq org-read-date-overlay nil)))))
16404 (bury-buffer "*Calendar*")))))
16406 (t ; Naked prompt only
16407 (unwind-protect
16408 (setq ans (read-string prompt default-input
16409 'org-read-date-history timestr))
16410 (when org-read-date-overlay
16411 (delete-overlay org-read-date-overlay)
16412 (setq org-read-date-overlay nil)))))
16414 (setq final (org-read-date-analyze ans org-def org-defdecode))
16416 (when org-read-date-analyze-forced-year
16417 (message "Year was forced into %s"
16418 (if org-read-date-force-compatible-dates
16419 "compatible range (1970-2037)"
16420 "range representable on this machine"))
16421 (ding))
16423 ;; One round trip to get rid of 34th of August and stuff like that....
16424 (setq final (decode-time (apply 'encode-time final)))
16426 (setq org-read-date-final-answer ans)
16428 (if to-time
16429 (apply 'encode-time final)
16430 (if (and (boundp 'org-time-was-given) org-time-was-given)
16431 (format "%04d-%02d-%02d %02d:%02d"
16432 (nth 5 final) (nth 4 final) (nth 3 final)
16433 (nth 2 final) (nth 1 final))
16434 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16436 (defun org-read-date-display ()
16437 "Display the current date prompt interpretation in the minibuffer."
16438 (when org-read-date-display-live
16439 (when org-read-date-overlay
16440 (delete-overlay org-read-date-overlay))
16441 (when (minibufferp (current-buffer))
16442 (save-excursion
16443 (end-of-line 1)
16444 (while (not (equal (buffer-substring
16445 (max (point-min) (- (point) 4)) (point))
16446 " "))
16447 (insert " ")))
16448 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16449 " " (or org-ans1 org-ans2)))
16450 (org-end-time-was-given nil)
16451 (f (org-read-date-analyze ans org-def org-defdecode))
16452 (fmts (if org-dcst
16453 org-time-stamp-custom-formats
16454 org-time-stamp-formats))
16455 (fmt (if (or org-with-time
16456 (and (boundp 'org-time-was-given) org-time-was-given))
16457 (cdr fmts)
16458 (car fmts)))
16459 (txt (format-time-string fmt (apply 'encode-time f)))
16460 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16461 (txt (concat "=> " txt)))
16462 (when (and org-end-time-was-given
16463 (string-match org-plain-time-of-day-regexp txt))
16464 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16465 org-end-time-was-given
16466 (substring txt (match-end 0)))))
16467 (when org-read-date-analyze-futurep
16468 (setq txt (concat txt " (=>F)")))
16469 (setq org-read-date-overlay
16470 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16471 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16473 (defun org-read-date-analyze (ans org-def org-defdecode)
16474 "Analyze the combined answer of the date prompt."
16475 ;; FIXME: cleanup and comment
16476 (let ((nowdecode (decode-time (current-time)))
16477 delta deltan deltaw deltadef year month day
16478 hour minute second wday pm h2 m2 tl wday1
16479 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16480 (setq org-read-date-analyze-futurep nil
16481 org-read-date-analyze-forced-year nil)
16482 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16483 (setq ans "+0"))
16485 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16486 (setq ans (replace-match "" t t ans)
16487 deltan (car delta)
16488 deltaw (nth 1 delta)
16489 deltadef (nth 2 delta)))
16491 ;; Check if there is an iso week date in there. If yes, store the
16492 ;; info and postpone interpreting it until the rest of the parsing
16493 ;; is done.
16494 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16495 (setq iso-year (if (match-end 1)
16496 (org-small-year-to-year
16497 (string-to-number (match-string 1 ans))))
16498 iso-weekday (if (match-end 3)
16499 (string-to-number (match-string 3 ans)))
16500 iso-week (string-to-number (match-string 2 ans)))
16501 (setq ans (replace-match "" t t ans)))
16503 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16504 (when (string-match
16505 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16506 (setq year (if (match-end 2)
16507 (string-to-number (match-string 2 ans))
16508 (progn (setq kill-year t)
16509 (string-to-number (format-time-string "%Y"))))
16510 month (string-to-number (match-string 3 ans))
16511 day (string-to-number (match-string 4 ans)))
16512 (if (< year 100) (setq year (+ 2000 year)))
16513 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16514 t nil ans)))
16516 ;; Help matching dotted european dates
16517 (when (string-match
16518 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16519 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16520 (setq kill-year t)
16521 (string-to-number (format-time-string "%Y")))
16522 day (string-to-number (match-string 1 ans))
16523 month (string-to-number (match-string 2 ans))
16524 ans (replace-match (format "%04d-%02d-%02d" year month day)
16525 t nil ans)))
16527 ;; Help matching american dates, like 5/30 or 5/30/7
16528 (when (string-match
16529 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16530 (setq year (if (match-end 4)
16531 (string-to-number (match-string 4 ans))
16532 (progn (setq kill-year t)
16533 (string-to-number (format-time-string "%Y"))))
16534 month (string-to-number (match-string 1 ans))
16535 day (string-to-number (match-string 2 ans)))
16536 (if (< year 100) (setq year (+ 2000 year)))
16537 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16538 t nil ans)))
16539 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16540 ;; If there is a time with am/pm, and *no* time without it, we convert
16541 ;; so that matching will be successful.
16542 (loop for i from 1 to 2 do ; twice, for end time as well
16543 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16544 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16545 (setq hour (string-to-number (match-string 1 ans))
16546 minute (if (match-end 3)
16547 (string-to-number (match-string 3 ans))
16549 pm (equal ?p
16550 (string-to-char (downcase (match-string 4 ans)))))
16551 (if (and (= hour 12) (not pm))
16552 (setq hour 0)
16553 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16554 (setq ans (replace-match (format "%02d:%02d" hour minute)
16555 t t ans))))
16557 ;; Check if a time range is given as a duration
16558 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16559 (setq hour (string-to-number (match-string 1 ans))
16560 h2 (+ hour (string-to-number (match-string 3 ans)))
16561 minute (string-to-number (match-string 2 ans))
16562 m2 (+ minute (if (match-end 5) (string-to-number
16563 (match-string 5 ans))0)))
16564 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16565 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16566 t t ans)))
16568 ;; Check if there is a time range
16569 (when (boundp 'org-end-time-was-given)
16570 (setq org-time-was-given nil)
16571 (when (and (string-match org-plain-time-of-day-regexp ans)
16572 (match-end 8))
16573 (setq org-end-time-was-given (match-string 8 ans))
16574 (setq ans (concat (substring ans 0 (match-beginning 7))
16575 (substring ans (match-end 7))))))
16577 (setq tl (parse-time-string ans)
16578 day (or (nth 3 tl) (nth 3 org-defdecode))
16579 month (or (nth 4 tl)
16580 (if (and org-read-date-prefer-future
16581 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16582 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16583 (nth 4 org-defdecode)))
16584 year (or (and (not kill-year) (nth 5 tl))
16585 (if (and org-read-date-prefer-future
16586 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16587 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16588 (nth 5 org-defdecode)))
16589 hour (or (nth 2 tl) (nth 2 org-defdecode))
16590 minute (or (nth 1 tl) (nth 1 org-defdecode))
16591 second (or (nth 0 tl) 0)
16592 wday (nth 6 tl))
16594 (when (and (eq org-read-date-prefer-future 'time)
16595 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16596 (equal day (nth 3 nowdecode))
16597 (equal month (nth 4 nowdecode))
16598 (equal year (nth 5 nowdecode))
16599 (nth 2 tl)
16600 (or (< (nth 2 tl) (nth 2 nowdecode))
16601 (and (= (nth 2 tl) (nth 2 nowdecode))
16602 (nth 1 tl)
16603 (< (nth 1 tl) (nth 1 nowdecode)))))
16604 (setq day (1+ day)
16605 futurep t))
16607 ;; Special date definitions below
16608 (cond
16609 (iso-week
16610 ;; There was an iso week
16611 (require 'cal-iso)
16612 (setq futurep nil)
16613 (setq year (or iso-year year)
16614 day (or iso-weekday wday 1)
16615 wday nil ; to make sure that the trigger below does not match
16616 iso-date (calendar-gregorian-from-absolute
16617 (calendar-absolute-from-iso
16618 (list iso-week day year))))
16619 ; FIXME: Should we also push ISO weeks into the future?
16620 ; (when (and org-read-date-prefer-future
16621 ; (not iso-year)
16622 ; (< (calendar-absolute-from-gregorian iso-date)
16623 ; (time-to-days (current-time))))
16624 ; (setq year (1+ year)
16625 ; iso-date (calendar-gregorian-from-absolute
16626 ; (calendar-absolute-from-iso
16627 ; (list iso-week day year)))))
16628 (setq month (car iso-date)
16629 year (nth 2 iso-date)
16630 day (nth 1 iso-date)))
16631 (deltan
16632 (setq futurep nil)
16633 (unless deltadef
16634 (let ((now (decode-time (current-time))))
16635 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16636 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16637 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16638 ((equal deltaw "m") (setq month (+ month deltan)))
16639 ((equal deltaw "y") (setq year (+ year deltan)))))
16640 ((and wday (not (nth 3 tl)))
16641 ;; Weekday was given, but no day, so pick that day in the week
16642 ;; on or after the derived date.
16643 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16644 (unless (equal wday wday1)
16645 (setq day (+ day (% (- wday wday1 -7) 7))))))
16646 (if (and (boundp 'org-time-was-given)
16647 (nth 2 tl))
16648 (setq org-time-was-given t))
16649 (if (< year 100) (setq year (+ 2000 year)))
16650 ;; Check of the date is representable
16651 (if org-read-date-force-compatible-dates
16652 (progn
16653 (if (< year 1970)
16654 (setq year 1970 org-read-date-analyze-forced-year t))
16655 (if (> year 2037)
16656 (setq year 2037 org-read-date-analyze-forced-year t)))
16657 (condition-case nil
16658 (ignore (encode-time second minute hour day month year))
16659 (error
16660 (setq year (nth 5 org-defdecode))
16661 (setq org-read-date-analyze-forced-year t))))
16662 (setq org-read-date-analyze-futurep futurep)
16663 (list second minute hour day month year)))
16665 (defvar parse-time-weekdays)
16666 (defun org-read-date-get-relative (s today default)
16667 "Check string S for special relative date string.
16668 TODAY and DEFAULT are internal times, for today and for a default.
16669 Return shift list (N what def-flag)
16670 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16671 N is the number of WHATs to shift.
16672 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16673 the DEFAULT date rather than TODAY."
16674 (require 'parse-time)
16675 (when (and
16676 (string-match
16677 (concat
16678 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16679 "\\([0-9]+\\)?"
16680 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16681 "\\([ \t]\\|$\\)") s)
16682 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16683 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16684 (string-to-char (substring (match-string 1 s) -1))
16685 ?+))
16686 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16687 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16688 (what (if (match-end 3) (match-string 3 s) "d"))
16689 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16690 (date (if rel default today))
16691 (wday (nth 6 (decode-time date)))
16692 delta)
16693 (if wday1
16694 (progn
16695 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16696 (if (= delta 0) (setq delta 7))
16697 (if (= dir ?-)
16698 (progn
16699 (setq delta (- delta 7))
16700 (if (= delta 0) (setq delta -7))))
16701 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16702 (list delta "d" rel))
16703 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16705 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16706 "Turn a user-specified date into the internal representation.
16707 The internal representation needed by the calendar is (month day year).
16708 This is a wrapper to handle the brain-dead convention in calendar that
16709 user function argument order change dependent on argument order."
16710 (if (boundp 'calendar-date-style)
16711 (cond
16712 ((eq calendar-date-style 'american)
16713 (list arg1 arg2 arg3))
16714 ((eq calendar-date-style 'european)
16715 (list arg2 arg1 arg3))
16716 ((eq calendar-date-style 'iso)
16717 (list arg2 arg3 arg1)))
16718 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16719 (if (org-bound-and-true-p european-calendar-style)
16720 (list arg2 arg1 arg3)
16721 (list arg1 arg2 arg3)))))
16723 (defun org-eval-in-calendar (form &optional keepdate)
16724 "Eval FORM in the calendar window and return to current window.
16725 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16726 otherwise stick to the current value of `org-ans2'."
16727 (let ((sf (selected-frame))
16728 (sw (selected-window)))
16729 (select-window (get-buffer-window "*Calendar*" t))
16730 (eval form)
16731 (when (and (not keepdate) (calendar-cursor-to-date))
16732 (let* ((date (calendar-cursor-to-date))
16733 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16734 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16735 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16736 (select-window sw)
16737 (org-select-frame-set-input-focus sf)))
16739 (defun org-calendar-select ()
16740 "Return to `org-read-date' with the date currently selected.
16741 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16742 (interactive)
16743 (when (calendar-cursor-to-date)
16744 (let* ((date (calendar-cursor-to-date))
16745 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16746 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16747 (if (active-minibuffer-window) (exit-minibuffer))))
16749 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16750 "Insert a date stamp for the date given by the internal TIME.
16751 WITH-HM means use the stamp format that includes the time of the day.
16752 INACTIVE means use square brackets instead of angular ones, so that the
16753 stamp will not contribute to the agenda.
16754 PRE and POST are optional strings to be inserted before and after the
16755 stamp.
16756 The command returns the inserted time stamp."
16757 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16758 stamp)
16759 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16760 (insert-before-markers (or pre ""))
16761 (when (listp extra)
16762 (setq extra (car extra))
16763 (if (and (stringp extra)
16764 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16765 (setq extra (format "-%02d:%02d"
16766 (string-to-number (match-string 1 extra))
16767 (string-to-number (match-string 2 extra))))
16768 (setq extra nil)))
16769 (when extra
16770 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16771 (insert-before-markers (setq stamp (format-time-string fmt time)))
16772 (insert-before-markers (or post ""))
16773 (setq org-last-inserted-timestamp stamp)))
16775 (defun org-toggle-time-stamp-overlays ()
16776 "Toggle the use of custom time stamp formats."
16777 (interactive)
16778 (setq org-display-custom-times (not org-display-custom-times))
16779 (unless org-display-custom-times
16780 (let ((p (point-min)) (bmp (buffer-modified-p)))
16781 (while (setq p (next-single-property-change p 'display))
16782 (if (and (get-text-property p 'display)
16783 (eq (get-text-property p 'face) 'org-date))
16784 (remove-text-properties
16785 p (setq p (next-single-property-change p 'display))
16786 '(display t))))
16787 (set-buffer-modified-p bmp)))
16788 (if (featurep 'xemacs)
16789 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16790 (org-restart-font-lock)
16791 (setq org-table-may-need-update t)
16792 (if org-display-custom-times
16793 (message "Time stamps are overlaid with custom format")
16794 (message "Time stamp overlays removed")))
16796 (defun org-display-custom-time (beg end)
16797 "Overlay modified time stamp format over timestamp between BEG and END."
16798 (let* ((ts (buffer-substring beg end))
16799 t1 w1 with-hm tf time str w2 (off 0))
16800 (save-match-data
16801 (setq t1 (org-parse-time-string ts t))
16802 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16803 (setq off (- (match-end 0) (match-beginning 0)))))
16804 (setq end (- end off))
16805 (setq w1 (- end beg)
16806 with-hm (and (nth 1 t1) (nth 2 t1))
16807 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16808 time (org-fix-decoded-time t1)
16809 str (org-add-props
16810 (format-time-string
16811 (substring tf 1 -1) (apply 'encode-time time))
16812 nil 'mouse-face 'highlight)
16813 w2 (length str))
16814 (if (not (= w2 w1))
16815 (add-text-properties (1+ beg) (+ 2 beg)
16816 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16817 (if (featurep 'xemacs)
16818 (progn
16819 (put-text-property beg end 'invisible t)
16820 (put-text-property beg end 'end-glyph (make-glyph str)))
16821 (put-text-property beg end 'display str))))
16823 (defun org-translate-time (string)
16824 "Translate all timestamps in STRING to custom format.
16825 But do this only if the variable `org-display-custom-times' is set."
16826 (when org-display-custom-times
16827 (save-match-data
16828 (let* ((start 0)
16829 (re org-ts-regexp-both)
16830 t1 with-hm inactive tf time str beg end)
16831 (while (setq start (string-match re string start))
16832 (setq beg (match-beginning 0)
16833 end (match-end 0)
16834 t1 (save-match-data
16835 (org-parse-time-string (substring string beg end) t))
16836 with-hm (and (nth 1 t1) (nth 2 t1))
16837 inactive (equal (substring string beg (1+ beg)) "[")
16838 tf (funcall (if with-hm 'cdr 'car)
16839 org-time-stamp-custom-formats)
16840 time (org-fix-decoded-time t1)
16841 str (format-time-string
16842 (concat
16843 (if inactive "[" "<") (substring tf 1 -1)
16844 (if inactive "]" ">"))
16845 (apply 'encode-time time))
16846 string (replace-match str t t string)
16847 start (+ start (length str)))))))
16848 string)
16850 (defun org-fix-decoded-time (time)
16851 "Set 0 instead of nil for the first 6 elements of time.
16852 Don't touch the rest."
16853 (let ((n 0))
16854 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16856 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16858 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16859 "Difference between TIMESTAMP-STRING and now in days.
16860 If SECONDS is non-nil, return the difference in seconds."
16861 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16862 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16863 (funcall fdiff (current-time)))))
16865 (defun org-deadline-close (timestamp-string &optional ndays)
16866 "Is the time in TIMESTAMP-STRING close to the current date?"
16867 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16868 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16869 (not (org-entry-is-done-p))))
16871 (defun org-get-wdays (ts &optional delay zero-delay)
16872 "Get the deadline lead time appropriate for timestring TS.
16873 When DELAY is non-nil, get the delay time for scheduled items
16874 instead of the deadline lead time. When ZERO-DELAY is non-nil
16875 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16876 don't try to find the delay cookie in the scheduled timestamp."
16877 (let ((tv (if delay org-scheduled-delay-days
16878 org-deadline-warning-days)))
16879 (cond
16880 ((or (and delay (< tv 0))
16881 (and delay zero-delay (<= tv 0))
16882 (and (not delay) (<= tv 0)))
16883 ;; Enforce this value no matter what
16884 (- tv))
16885 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16886 ;; lead time is specified.
16887 (floor (* (string-to-number (match-string 1 ts))
16888 (cdr (assoc (match-string 2 ts)
16889 '(("d" . 1) ("w" . 7)
16890 ("m" . 30.4) ("y" . 365.25)
16891 ("h" . 0.041667)))))))
16892 ;; go for the default.
16893 (t tv))))
16895 (defun org-calendar-select-mouse (ev)
16896 "Return to `org-read-date' with the date currently selected.
16897 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16898 (interactive "e")
16899 (mouse-set-point ev)
16900 (when (calendar-cursor-to-date)
16901 (let* ((date (calendar-cursor-to-date))
16902 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16903 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16904 (if (active-minibuffer-window) (exit-minibuffer))))
16906 (defun org-check-deadlines (ndays)
16907 "Check if there are any deadlines due or past due.
16908 A deadline is considered due if it happens within `org-deadline-warning-days'
16909 days from today's date. If the deadline appears in an entry marked DONE,
16910 it is not shown. The prefix arg NDAYS can be used to test that many
16911 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16912 (interactive "P")
16913 (let* ((org-warn-days
16914 (cond
16915 ((equal ndays '(4)) 100000)
16916 (ndays (prefix-numeric-value ndays))
16917 (t (abs org-deadline-warning-days))))
16918 (case-fold-search nil)
16919 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16920 (callback
16921 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16923 (message "%d deadlines past-due or due within %d days"
16924 (org-occur regexp nil callback)
16925 org-warn-days)))
16927 (defsubst org-re-timestamp (type)
16928 "Return a regexp for timestamp TYPE.
16929 Allowed values for TYPE are:
16931 all: all timestamps
16932 active: only active timestamps (<...>)
16933 inactive: only inactive timestamps ([...])
16934 scheduled: only scheduled timestamps
16935 deadline: only deadline timestamps
16936 closed: only closed time-stamps
16938 When TYPE is nil, fall back on returning a regexp that matches
16939 both scheduled and deadline timestamps."
16940 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16941 ((eq type 'active) org-ts-regexp)
16942 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16943 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16944 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16945 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16946 ((eq type 'scheduled-or-deadline)
16947 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16949 (defun org-check-before-date (date)
16950 "Check if there are deadlines or scheduled entries before DATE."
16951 (interactive (list (org-read-date)))
16952 (let ((case-fold-search nil)
16953 (regexp (org-re-timestamp org-ts-type))
16954 (callback
16955 (lambda () (time-less-p
16956 (org-time-string-to-time (match-string 1))
16957 (org-time-string-to-time date)))))
16958 (message "%d entries before %s"
16959 (org-occur regexp nil callback) date)))
16961 (defun org-check-after-date (date)
16962 "Check if there are deadlines or scheduled entries after DATE."
16963 (interactive (list (org-read-date)))
16964 (let ((case-fold-search nil)
16965 (regexp (org-re-timestamp org-ts-type))
16966 (callback
16967 (lambda () (not
16968 (time-less-p
16969 (org-time-string-to-time (match-string 1))
16970 (org-time-string-to-time date))))))
16971 (message "%d entries after %s"
16972 (org-occur regexp nil callback) date)))
16974 (defun org-check-dates-range (start-date end-date)
16975 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16976 (interactive (list (org-read-date nil nil nil "Range starts")
16977 (org-read-date nil nil nil "Range end")))
16978 (let ((case-fold-search nil)
16979 (regexp (org-re-timestamp org-ts-type))
16980 (callback
16981 (lambda ()
16982 (let ((match (match-string 1)))
16983 (and
16984 (not (time-less-p
16985 (org-time-string-to-time match)
16986 (org-time-string-to-time start-date)))
16987 (time-less-p
16988 (org-time-string-to-time match)
16989 (org-time-string-to-time end-date)))))))
16990 (message "%d entries between %s and %s"
16991 (org-occur regexp nil callback) start-date end-date)))
16993 (defun org-evaluate-time-range (&optional to-buffer)
16994 "Evaluate a time range by computing the difference between start and end.
16995 Normally the result is just printed in the echo area, but with prefix arg
16996 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
16997 If the time range is actually in a table, the result is inserted into the
16998 next column.
16999 For time difference computation, a year is assumed to be exactly 365
17000 days in order to avoid rounding problems."
17001 (interactive "P")
17003 (org-clock-update-time-maybe)
17004 (save-excursion
17005 (unless (org-at-date-range-p t)
17006 (goto-char (point-at-bol))
17007 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17008 (if (not (org-at-date-range-p t))
17009 (user-error "Not at a time-stamp range, and none found in current line")))
17010 (let* ((ts1 (match-string 1))
17011 (ts2 (match-string 2))
17012 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17013 (match-end (match-end 0))
17014 (time1 (org-time-string-to-time ts1))
17015 (time2 (org-time-string-to-time ts2))
17016 (t1 (org-float-time time1))
17017 (t2 (org-float-time time2))
17018 (diff (abs (- t2 t1)))
17019 (negative (< (- t2 t1) 0))
17020 ;; (ys (floor (* 365 24 60 60)))
17021 (ds (* 24 60 60))
17022 (hs (* 60 60))
17023 (fy "%dy %dd %02d:%02d")
17024 (fy1 "%dy %dd")
17025 (fd "%dd %02d:%02d")
17026 (fd1 "%dd")
17027 (fh "%02d:%02d")
17028 y d h m align)
17029 (if havetime
17030 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17032 d (floor (/ diff ds)) diff (mod diff ds)
17033 h (floor (/ diff hs)) diff (mod diff hs)
17034 m (floor (/ diff 60)))
17035 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17037 d (floor (+ (/ diff ds) 0.5))
17038 h 0 m 0))
17039 (if (not to-buffer)
17040 (message "%s" (org-make-tdiff-string y d h m))
17041 (if (org-at-table-p)
17042 (progn
17043 (goto-char match-end)
17044 (setq align t)
17045 (and (looking-at " *|") (goto-char (match-end 0))))
17046 (goto-char match-end))
17047 (if (looking-at
17048 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17049 (replace-match ""))
17050 (if negative (insert " -"))
17051 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17052 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17053 (insert " " (format fh h m))))
17054 (if align (org-table-align))
17055 (message "Time difference inserted")))))
17057 (defun org-make-tdiff-string (y d h m)
17058 (let ((fmt "")
17059 (l nil))
17060 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17061 l (push y l)))
17062 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17063 l (push d l)))
17064 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17065 l (push h l)))
17066 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17067 l (push m l)))
17068 (apply 'format fmt (nreverse l))))
17070 (defun org-time-string-to-time (s &optional buffer pos)
17071 "Convert a timestamp string into internal time."
17072 (condition-case errdata
17073 (apply 'encode-time (org-parse-time-string s))
17074 (error (error "Bad timestamp `%s'%s\nError was: %s"
17075 s (if (not (and buffer pos))
17077 (format " at %d in buffer `%s'" pos buffer))
17078 (cdr errdata)))))
17080 (defun org-time-string-to-seconds (s)
17081 "Convert a timestamp string to a number of seconds."
17082 (org-float-time (org-time-string-to-time s)))
17084 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17085 "Convert a time stamp to an absolute day number.
17086 If there is a specifier for a cyclic time stamp, get the closest
17087 date to DAYNR.
17088 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17089 The variable `date' is bound by the calendar when this is called."
17090 (cond
17091 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17092 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17093 daynr
17094 (+ daynr 1000)))
17095 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17096 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17097 (time-to-days (current-time))) (match-string 0 s)
17098 prefer show-all))
17099 (t (time-to-days
17100 (condition-case errdata
17101 (apply 'encode-time (org-parse-time-string s))
17102 (error (error "Bad timestamp `%s'%s\nError was: %s"
17103 s (if (not (and buffer pos))
17105 (format " at %d in buffer `%s'" pos buffer))
17106 (cdr errdata))))))))
17108 (defun org-days-to-iso-week (days)
17109 "Return the iso week number."
17110 (require 'cal-iso)
17111 (car (calendar-iso-from-absolute days)))
17113 (defun org-small-year-to-year (year)
17114 "Convert 2-digit years into 4-digit years.
17115 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17116 The year 2000 cannot be abbreviated. Any year larger than 99
17117 is returned unchanged."
17118 (if (< year 38)
17119 (setq year (+ 2000 year))
17120 (if (< year 100)
17121 (setq year (+ 1900 year))))
17122 year)
17124 (defun org-time-from-absolute (d)
17125 "Return the time corresponding to date D.
17126 D may be an absolute day number, or a calendar-type list (month day year)."
17127 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17128 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17130 (defun org-calendar-holiday ()
17131 "List of holidays, for Diary display in Org-mode."
17132 (require 'holidays)
17133 (let ((hl (funcall
17134 (if (fboundp 'calendar-check-holidays)
17135 'calendar-check-holidays 'check-calendar-holidays) date)))
17136 (if hl (mapconcat 'identity hl "; "))))
17138 (defun org-diary-sexp-entry (sexp entry date)
17139 "Process a SEXP diary ENTRY for DATE."
17140 (require 'diary-lib)
17141 (let ((result (if calendar-debug-sexp
17142 (let ((stack-trace-on-error t))
17143 (eval (car (read-from-string sexp))))
17144 (condition-case nil
17145 (eval (car (read-from-string sexp)))
17146 (error
17147 (beep)
17148 (message "Bad sexp at line %d in %s: %s"
17149 (org-current-line)
17150 (buffer-file-name) sexp)
17151 (sleep-for 2))))))
17152 (cond ((stringp result) (split-string result "; "))
17153 ((and (consp result)
17154 (not (consp (cdr result)))
17155 (stringp (cdr result))) (cdr result))
17156 ((and (consp result)
17157 (stringp (car result))) result)
17158 (result entry))))
17160 (defun org-diary-to-ical-string (frombuf)
17161 "Get iCalendar entries from diary entries in buffer FROMBUF.
17162 This uses the icalendar.el library."
17163 (let* ((tmpdir (if (featurep 'xemacs)
17164 (temp-directory)
17165 temporary-file-directory))
17166 (tmpfile (make-temp-name
17167 (expand-file-name "orgics" tmpdir)))
17168 buf rtn b e)
17169 (with-current-buffer frombuf
17170 (icalendar-export-region (point-min) (point-max) tmpfile)
17171 (setq buf (find-buffer-visiting tmpfile))
17172 (set-buffer buf)
17173 (goto-char (point-min))
17174 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17175 (setq b (match-beginning 0)))
17176 (goto-char (point-max))
17177 (if (re-search-backward "^END:VEVENT" nil t)
17178 (setq e (match-end 0)))
17179 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17180 (kill-buffer buf)
17181 (delete-file tmpfile)
17182 rtn))
17184 (defun org-closest-date (start current change prefer show-all)
17185 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17186 When PREFER is `past', return a date that is either CURRENT or past.
17187 When PREFER is `future', return a date that is either CURRENT or future.
17188 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17189 ;; Make the proper lists from the dates
17190 (catch 'exit
17191 (let ((a1 '(("h" . hour)
17192 ("d" . day)
17193 ("w" . week)
17194 ("m" . month)
17195 ("y" . year)))
17196 (shour (nth 2 (org-parse-time-string start)))
17197 dn dw sday cday n1 n2 n0
17198 d m y y1 y2 date1 date2 nmonths nm ny m2)
17200 (setq start (org-date-to-gregorian start)
17201 current (org-date-to-gregorian
17202 (if show-all
17203 current
17204 (time-to-days (current-time))))
17205 sday (calendar-absolute-from-gregorian start)
17206 cday (calendar-absolute-from-gregorian current))
17208 (if (<= cday sday) (throw 'exit sday))
17210 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17211 (setq dn (string-to-number (match-string 1 change))
17212 dw (cdr (assoc (match-string 2 change) a1)))
17213 (user-error "Invalid change specifier: %s" change))
17214 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17215 (cond
17216 ((eq dw 'hour)
17217 (let ((missing-hours
17218 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17219 dn)))
17220 (setq n1 (if (zerop missing-hours) cday
17221 (- cday (1+ (floor (/ missing-hours 24)))))
17222 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17223 ((eq dw 'day)
17224 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17225 n2 (+ n1 dn)))
17226 ((eq dw 'year)
17227 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17228 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17229 (setq date1 (list m d y1)
17230 n1 (calendar-absolute-from-gregorian date1)
17231 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17232 n2 (calendar-absolute-from-gregorian date2)))
17233 ((eq dw 'month)
17234 ;; approx number of month between the two dates
17235 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17236 ;; How often does dn fit in there?
17237 (setq d (nth 1 start) m (car start) y (nth 2 start)
17238 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17239 m (+ m nm)
17240 ny (floor (/ m 12))
17241 y (+ y ny)
17242 m (- m (* ny 12)))
17243 (while (> m 12) (setq m (- m 12) y (1+ y)))
17244 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17245 (setq m2 (+ m dn) y2 y)
17246 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17247 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17248 (while (<= n2 cday)
17249 (setq n1 n2 m m2 y y2)
17250 (setq m2 (+ m dn) y2 y)
17251 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17252 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17253 ;; Make sure n1 is the earlier date
17254 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17255 (if show-all
17256 (cond
17257 ((eq prefer 'past) (if (= cday n2) n2 n1))
17258 ((eq prefer 'future) (if (= cday n1) n1 n2))
17259 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17260 (cond
17261 ((eq prefer 'past) (if (= cday n2) n2 n1))
17262 ((eq prefer 'future) (if (= cday n1) n1 n2))
17263 (t (if (= cday n1) n1 n2)))))))
17265 (defun org-date-to-gregorian (date)
17266 "Turn any specification of DATE into a Gregorian date for the calendar."
17267 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17268 ((and (listp date) (= (length date) 3)) date)
17269 ((stringp date)
17270 (setq date (org-parse-time-string date))
17271 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17272 ((listp date)
17273 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17275 (defun org-parse-time-string (s &optional nodefault)
17276 "Parse the standard Org-mode time string.
17277 This should be a lot faster than the normal `parse-time-string'.
17278 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17279 hour and minute fields will be nil if not given."
17280 (cond ((string-match org-ts-regexp0 s)
17281 (list 0
17282 (if (or (match-beginning 8) (not nodefault))
17283 (string-to-number (or (match-string 8 s) "0")))
17284 (if (or (match-beginning 7) (not nodefault))
17285 (string-to-number (or (match-string 7 s) "0")))
17286 (string-to-number (match-string 4 s))
17287 (string-to-number (match-string 3 s))
17288 (string-to-number (match-string 2 s))
17289 nil nil nil))
17290 ((string-match "^<[^>]+>$" s)
17291 (decode-time (seconds-to-time (org-matcher-time s))))
17292 (t (error "Not a standard Org-mode time string: %s" s))))
17294 (defun org-timestamp-up (&optional arg)
17295 "Increase the date item at the cursor by one.
17296 If the cursor is on the year, change the year. If it is on the month,
17297 the day or the time, change that.
17298 With prefix ARG, change by that many units."
17299 (interactive "p")
17300 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17302 (defun org-timestamp-down (&optional arg)
17303 "Decrease the date item at the cursor by one.
17304 If the cursor is on the year, change the year. If it is on the month,
17305 the day or the time, change that.
17306 With prefix ARG, change by that many units."
17307 (interactive "p")
17308 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17310 (defun org-timestamp-up-day (&optional arg)
17311 "Increase the date in the time stamp by one day.
17312 With prefix ARG, change that many days."
17313 (interactive "p")
17314 (if (and (not (org-at-timestamp-p t))
17315 (org-at-heading-p))
17316 (org-todo 'up)
17317 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17319 (defun org-timestamp-down-day (&optional arg)
17320 "Decrease the date in the time stamp by one day.
17321 With prefix ARG, change that many days."
17322 (interactive "p")
17323 (if (and (not (org-at-timestamp-p t))
17324 (org-at-heading-p))
17325 (org-todo 'down)
17326 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17328 (defun org-at-timestamp-p (&optional inactive-ok)
17329 "Determine if the cursor is in or at a timestamp."
17330 (interactive)
17331 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17332 (pos (point))
17333 (ans (or (looking-at tsr)
17334 (save-excursion
17335 (skip-chars-backward "^[<\n\r\t")
17336 (if (> (point) (point-min)) (backward-char 1))
17337 (and (looking-at tsr)
17338 (> (- (match-end 0) pos) -1))))))
17339 (and ans
17340 (boundp 'org-ts-what)
17341 (setq org-ts-what
17342 (cond
17343 ((= pos (match-beginning 0)) 'bracket)
17344 ;; Point is considered to be "on the bracket" whether
17345 ;; it's really on it or right after it.
17346 ((= pos (1- (match-end 0))) 'bracket)
17347 ((= pos (match-end 0)) 'after)
17348 ((org-pos-in-match-range pos 2) 'year)
17349 ((org-pos-in-match-range pos 3) 'month)
17350 ((org-pos-in-match-range pos 7) 'hour)
17351 ((org-pos-in-match-range pos 8) 'minute)
17352 ((or (org-pos-in-match-range pos 4)
17353 (org-pos-in-match-range pos 5)) 'day)
17354 ((and (> pos (or (match-end 8) (match-end 5)))
17355 (< pos (match-end 0)))
17356 (- pos (or (match-end 8) (match-end 5))))
17357 (t 'day))))
17358 ans))
17360 (defun org-toggle-timestamp-type ()
17361 "Toggle the type (<active> or [inactive]) of a time stamp."
17362 (interactive)
17363 (when (org-at-timestamp-p t)
17364 (let ((beg (match-beginning 0)) (end (match-end 0))
17365 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17366 (save-excursion
17367 (goto-char beg)
17368 (while (re-search-forward "[][<>]" end t)
17369 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17370 t t)))
17371 (message "Timestamp is now %sactive"
17372 (if (equal (char-after beg) ?<) "" "in")))))
17374 (defun org-at-clock-log-p nil
17375 "Is the cursor on the clock log line?"
17376 (save-excursion
17377 (move-beginning-of-line 1)
17378 (looking-at "^[ \t]*CLOCK:")))
17380 (defvar org-clock-history) ; defined in org-clock.el
17381 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17382 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17383 "Change the date in the time stamp at point.
17384 The date will be changed by N times WHAT. WHAT can be `day', `month',
17385 `year', `minute', `second'. If WHAT is not given, the cursor position
17386 in the timestamp determines what will be changed.
17387 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17388 (let ((origin (point)) origin-cat
17389 with-hm inactive
17390 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17391 org-ts-what
17392 extra rem
17393 ts time time0 fixnext clrgx)
17394 (if (not (org-at-timestamp-p t))
17395 (user-error "Not at a timestamp"))
17396 (if (and (not what) (eq org-ts-what 'bracket))
17397 (org-toggle-timestamp-type)
17398 ;; Point isn't on brackets. Remember the part of the time-stamp
17399 ;; the point was in. Indeed, size of time-stamps may change,
17400 ;; but point must be kept in the same category nonetheless.
17401 (setq origin-cat org-ts-what)
17402 (if (and (not what) (not (eq org-ts-what 'day))
17403 org-display-custom-times
17404 (get-text-property (point) 'display)
17405 (not (get-text-property (1- (point)) 'display)))
17406 (setq org-ts-what 'day))
17407 (setq org-ts-what (or what org-ts-what)
17408 inactive (= (char-after (match-beginning 0)) ?\[)
17409 ts (match-string 0))
17410 (replace-match "")
17411 (when (string-match
17412 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17414 (setq extra (match-string 1 ts))
17415 (if suppress-tmp-delay
17416 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17417 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17418 (setq with-hm t))
17419 (setq time0 (org-parse-time-string ts))
17420 (when (and updown
17421 (eq org-ts-what 'minute)
17422 (not current-prefix-arg))
17423 ;; This looks like s-up and s-down. Change by one rounding step.
17424 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17425 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17426 (setcar (cdr time0) (+ (nth 1 time0)
17427 (if (> n 0) (- rem) (- dm rem))))))
17428 (setq time
17429 (encode-time (or (car time0) 0)
17430 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17431 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17432 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17433 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17434 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17435 (nthcdr 6 time0)))
17436 (when (and (member org-ts-what '(hour minute))
17437 extra
17438 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17439 (setq extra (org-modify-ts-extra
17440 extra
17441 (if (eq org-ts-what 'hour) 2 5)
17442 n dm)))
17443 (when (integerp org-ts-what)
17444 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17445 (if (eq what 'calendar)
17446 (let ((cal-date (org-get-date-from-calendar)))
17447 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17448 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17449 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17450 (setcar time0 (or (car time0) 0))
17451 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17452 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17453 (setq time (apply 'encode-time time0))))
17454 ;; Insert the new time-stamp, and ensure point stays in the same
17455 ;; category as before (i.e. not after the last position in that
17456 ;; category).
17457 (let ((pos (point)))
17458 ;; Stay before inserted string. `save-excursion' is of no use.
17459 (setq org-last-changed-timestamp
17460 (org-insert-time-stamp time with-hm inactive nil nil extra))
17461 (goto-char pos))
17462 (save-match-data
17463 (looking-at org-ts-regexp3)
17464 (goto-char (cond
17465 ;; `day' category ends before `hour' if any, or at
17466 ;; the end of the day name.
17467 ((eq origin-cat 'day)
17468 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17469 ((eq origin-cat 'hour) (min (match-end 7) origin))
17470 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17471 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17472 ;; `year' and `month' have both fixed size: point
17473 ;; couldn't have moved into another part.
17474 (t origin))))
17475 ;; Update clock if on a CLOCK line.
17476 (org-clock-update-time-maybe)
17477 ;; Maybe adjust the closest clock in `org-clock-history'
17478 (when org-clock-adjust-closest
17479 (if (not (and (org-at-clock-log-p)
17480 (< 1 (length (delq nil (mapcar 'marker-position
17481 org-clock-history))))))
17482 (message "No clock to adjust")
17483 (cond ((save-excursion ; fix previous clock?
17484 (re-search-backward org-ts-regexp0 nil t)
17485 (org-looking-back (concat org-clock-string " \\[")))
17486 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17487 ((save-excursion ; fix next clock?
17488 (re-search-backward org-ts-regexp0 nil t)
17489 (looking-at (concat org-ts-regexp0 "\\] =>")))
17490 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17491 (save-window-excursion
17492 ;; Find closest clock to point, adjust the previous/next one in history
17493 (let* ((p (save-excursion (org-back-to-heading t)))
17494 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17495 (clfixnth
17496 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17497 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17498 (if (not clfixpos)
17499 (message "No clock to adjust")
17500 (save-excursion
17501 (org-goto-marker-or-bmk clfixpos)
17502 (org-show-subtree)
17503 (when (re-search-forward clrgx nil t)
17504 (goto-char (match-beginning 1))
17505 (let (org-clock-adjust-closest)
17506 (org-timestamp-change n org-ts-what updown))
17507 (message "Clock adjusted in %s for heading: %s"
17508 (file-name-nondirectory (buffer-file-name))
17509 (org-get-heading t t)))))))))
17510 ;; Try to recenter the calendar window, if any.
17511 (if (and org-calendar-follow-timestamp-change
17512 (get-buffer-window "*Calendar*" t)
17513 (memq org-ts-what '(day month year)))
17514 (org-recenter-calendar (time-to-days time))))))
17516 (defun org-modify-ts-extra (s pos n dm)
17517 "Change the different parts of the lead-time and repeat fields in timestamp."
17518 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17519 ng h m new rem)
17520 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17521 (cond
17522 ((or (org-pos-in-match-range pos 2)
17523 (org-pos-in-match-range pos 3))
17524 (setq m (string-to-number (match-string 3 s))
17525 h (string-to-number (match-string 2 s)))
17526 (if (org-pos-in-match-range pos 2)
17527 (setq h (+ h n))
17528 (setq n (* dm (org-no-warnings (signum n))))
17529 (when (not (= 0 (setq rem (% m dm))))
17530 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17531 (setq m (+ m n)))
17532 (if (< m 0) (setq m (+ m 60) h (1- h)))
17533 (if (> m 59) (setq m (- m 60) h (1+ h)))
17534 (setq h (min 24 (max 0 h)))
17535 (setq ng 1 new (format "-%02d:%02d" h m)))
17536 ((org-pos-in-match-range pos 6)
17537 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17538 ((org-pos-in-match-range pos 5)
17539 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17541 ((org-pos-in-match-range pos 9)
17542 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17543 ((org-pos-in-match-range pos 8)
17544 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17546 (when ng
17547 (setq s (concat
17548 (substring s 0 (match-beginning ng))
17550 (substring s (match-end ng))))))
17553 (defun org-recenter-calendar (date)
17554 "If the calendar is visible, recenter it to DATE."
17555 (let ((cwin (get-buffer-window "*Calendar*" t)))
17556 (when cwin
17557 (let ((calendar-move-hook nil))
17558 (with-selected-window cwin
17559 (calendar-goto-date (if (listp date) date
17560 (calendar-gregorian-from-absolute date))))))))
17562 (defun org-goto-calendar (&optional arg)
17563 "Go to the Emacs calendar at the current date.
17564 If there is a time stamp in the current line, go to that date.
17565 A prefix ARG can be used to force the current date."
17566 (interactive "P")
17567 (let ((tsr org-ts-regexp) diff
17568 (calendar-move-hook nil)
17569 (calendar-view-holidays-initially-flag nil)
17570 (calendar-view-diary-initially-flag nil))
17571 (if (or (org-at-timestamp-p)
17572 (save-excursion
17573 (beginning-of-line 1)
17574 (looking-at (concat ".*" tsr))))
17575 (let ((d1 (time-to-days (current-time)))
17576 (d2 (time-to-days
17577 (org-time-string-to-time (match-string 1)))))
17578 (setq diff (- d2 d1))))
17579 (calendar)
17580 (calendar-goto-today)
17581 (if (and diff (not arg)) (calendar-forward-day diff))))
17583 (defun org-get-date-from-calendar ()
17584 "Return a list (month day year) of date at point in calendar."
17585 (with-current-buffer "*Calendar*"
17586 (save-match-data
17587 (calendar-cursor-to-date))))
17589 (defun org-date-from-calendar ()
17590 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17591 If there is already a time stamp at the cursor position, update it."
17592 (interactive)
17593 (if (org-at-timestamp-p t)
17594 (org-timestamp-change 0 'calendar)
17595 (let ((cal-date (org-get-date-from-calendar)))
17596 (org-insert-time-stamp
17597 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17599 (defcustom org-effort-durations
17600 `(("h" . 60)
17601 ("d" . ,(* 60 8))
17602 ("w" . ,(* 60 8 5))
17603 ("m" . ,(* 60 8 5 4))
17604 ("y" . ,(* 60 8 5 40)))
17605 "Conversion factor to minutes for an effort modifier.
17607 Each entry has the form (MODIFIER . MINUTES).
17609 In an effort string, a number followed by MODIFIER is multiplied
17610 by the specified number of MINUTES to obtain an effort in
17611 minutes.
17613 For example, if the value of this variable is ((\"hours\" . 60)), then an
17614 effort string \"2hours\" is equivalent to 120 minutes."
17615 :group 'org-agenda
17616 :version "24.1"
17617 :type '(alist :key-type (string :tag "Modifier")
17618 :value-type (number :tag "Minutes")))
17620 (defun org-minutes-to-clocksum-string (m)
17621 "Format number of minutes as a clocksum string.
17622 The format is determined by `org-time-clocksum-format',
17623 `org-time-clocksum-use-fractional' and
17624 `org-time-clocksum-fractional-format' and
17625 `org-time-clocksum-use-effort-durations'."
17626 (let ((clocksum "")
17627 (m (round m)) ; Don't allow fractions of minutes
17628 h d w mo y fmt n)
17629 (setq h (if org-time-clocksum-use-effort-durations
17630 (cdr (assoc "h" org-effort-durations)) 60)
17631 d (if org-time-clocksum-use-effort-durations
17632 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17633 w (if org-time-clocksum-use-effort-durations
17634 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17635 mo (if org-time-clocksum-use-effort-durations
17636 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17637 y (if org-time-clocksum-use-effort-durations
17638 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17639 ;; fractional format
17640 (if org-time-clocksum-use-fractional
17641 (cond
17642 ;; single format string
17643 ((stringp org-time-clocksum-fractional-format)
17644 (format org-time-clocksum-fractional-format (/ m (float h))))
17645 ;; choice of fractional formats for different time units
17646 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17647 (> (/ (truncate m) (* y d h)) 0))
17648 (format fmt (/ m (* y d (float h)))))
17649 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17650 (> (/ (truncate m) (* mo d h)) 0))
17651 (format fmt (/ m (* mo d (float h)))))
17652 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17653 (> (/ (truncate m) (* w d h)) 0))
17654 (format fmt (/ m (* w d (float h)))))
17655 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17656 (> (/ (truncate m) (* d h)) 0))
17657 (format fmt (/ m (* d (float h)))))
17658 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17659 (> (/ (truncate m) h) 0))
17660 (format fmt (/ m (float h))))
17661 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17662 (format fmt m))
17663 ;; fall back to smallest time unit with a format
17664 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17665 (format fmt (/ m (float h))))
17666 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17667 (format fmt (/ m (* d (float h)))))
17668 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17669 (format fmt (/ m (* w d (float h)))))
17670 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17671 (format fmt (/ m (* mo d (float h)))))
17672 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17673 (format fmt (/ m (* y d (float h))))))
17674 ;; standard (non-fractional) format, with single format string
17675 (if (stringp org-time-clocksum-format)
17676 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17677 ;; separate formats components
17678 (and (setq fmt (plist-get org-time-clocksum-format :years))
17679 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17680 (plist-get org-time-clocksum-format :require-years))
17681 (setq clocksum (concat clocksum (format fmt n))
17682 m (- m (* n y d h))))
17683 (and (setq fmt (plist-get org-time-clocksum-format :months))
17684 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17685 (plist-get org-time-clocksum-format :require-months))
17686 (setq clocksum (concat clocksum (format fmt n))
17687 m (- m (* n mo d h))))
17688 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17689 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17690 (plist-get org-time-clocksum-format :require-weeks))
17691 (setq clocksum (concat clocksum (format fmt n))
17692 m (- m (* n w d h))))
17693 (and (setq fmt (plist-get org-time-clocksum-format :days))
17694 (or (> (setq n (/ (truncate m) (* d h))) 0)
17695 (plist-get org-time-clocksum-format :require-days))
17696 (setq clocksum (concat clocksum (format fmt n))
17697 m (- m (* n d h))))
17698 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17699 (or (> (setq n (/ (truncate m) h)) 0)
17700 (plist-get org-time-clocksum-format :require-hours))
17701 (setq clocksum (concat clocksum (format fmt n))
17702 m (- m (* n h))))
17703 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17704 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17705 (setq clocksum (concat clocksum (format fmt m))))
17706 ;; return formatted time duration
17707 clocksum))))
17709 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17710 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17711 "Org mode version 8.0")
17713 (defun org-hours-to-clocksum-string (n)
17714 (org-minutes-to-clocksum-string (* n 60)))
17716 (defun org-hh:mm-string-to-minutes (s)
17717 "Convert a string H:MM to a number of minutes.
17718 If the string is just a number, interpret it as minutes.
17719 In fact, the first hh:mm or number in the string will be taken,
17720 there can be extra stuff in the string.
17721 If no number is found, the return value is 0."
17722 (cond
17723 ((integerp s) s)
17724 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17725 (+ (* (string-to-number (match-string 1 s)) 60)
17726 (string-to-number (match-string 2 s))))
17727 ((string-match "\\([0-9]+\\)" s)
17728 (string-to-number (match-string 1 s)))
17729 (t 0)))
17731 (defcustom org-image-actual-width t
17732 "Should we use the actual width of images when inlining them?
17734 When set to `t', always use the image width.
17736 When set to a number, use imagemagick (when available) to set
17737 the image's width to this value.
17739 When set to a number in a list, try to get the width from any
17740 #+ATTR.* keyword if it matches a width specification like
17742 #+ATTR_HTML: :width 300px
17744 and fall back on that number if none is found.
17746 When set to nil, try to get the width from an #+ATTR.* keyword
17747 and fall back on the original width if none is found.
17749 This requires Emacs >= 24.1, build with imagemagick support."
17750 :group 'org-appearance
17751 :version "24.4"
17752 :package-version '(Org . "8.0")
17753 :type '(choice
17754 (const :tag "Use the image width" t)
17755 (integer :tag "Use a number of pixels")
17756 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17757 (const :tag "Use #+ATTR* or don't resize" nil)))
17759 (defcustom org-agenda-inhibit-startup nil
17760 "Inhibit startup when preparing agenda buffers.
17761 When this variable is `t' (the default), the initialization of
17762 the Org agenda buffers is inhibited: e.g. the visibility state
17763 is not set, the tables are not re-aligned, etc."
17764 :type 'boolean
17765 :version "24.3"
17766 :group 'org-agenda)
17768 (defcustom org-agenda-ignore-drawer-properties nil
17769 "Avoid updating text properties when building the agenda.
17770 Properties are used to prepare buffers for effort estimates, appointments,
17771 and subtree-local categories.
17772 If you don't use these in the agenda, you can add them to this list and
17773 agenda building will be a bit faster.
17774 The value is a list, with zero or more of the symbols `effort', `appt',
17775 or `category'."
17776 :type '(set :greedy t
17777 (const effort)
17778 (const appt)
17779 (const category))
17780 :version "24.3"
17781 :group 'org-agenda)
17783 (defun org-duration-string-to-minutes (s &optional output-to-string)
17784 "Convert a duration string S to minutes.
17786 A bare number is interpreted as minutes, modifiers can be set by
17787 customizing `org-effort-durations' (which see).
17789 Entries containing a colon are interpreted as H:MM by
17790 `org-hh:mm-string-to-minutes'."
17791 (let ((result 0)
17792 (re (concat "\\([0-9.]+\\) *\\("
17793 (regexp-opt (mapcar 'car org-effort-durations))
17794 "\\)")))
17795 (while (string-match re s)
17796 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17797 (string-to-number (match-string 1 s))))
17798 (setq s (replace-match "" nil t s)))
17799 (setq result (floor result))
17800 (incf result (org-hh:mm-string-to-minutes s))
17801 (if output-to-string (number-to-string result) result)))
17803 ;;;; Files
17805 (defun org-save-all-org-buffers ()
17806 "Save all Org-mode buffers without user confirmation."
17807 (interactive)
17808 (message "Saving all Org-mode buffers...")
17809 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17810 (when (featurep 'org-id) (org-id-locations-save))
17811 (message "Saving all Org-mode buffers... done"))
17813 (defun org-revert-all-org-buffers ()
17814 "Revert all Org-mode buffers.
17815 Prompt for confirmation when there are unsaved changes.
17816 Be sure you know what you are doing before letting this function
17817 overwrite your changes.
17819 This function is useful in a setup where one tracks org files
17820 with a version control system, to revert on one machine after pulling
17821 changes from another. I believe the procedure must be like this:
17823 1. M-x org-save-all-org-buffers
17824 2. Pull changes from the other machine, resolve conflicts
17825 3. M-x org-revert-all-org-buffers"
17826 (interactive)
17827 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17828 (user-error "Abort"))
17829 (save-excursion
17830 (save-window-excursion
17831 (mapc
17832 (lambda (b)
17833 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17834 (with-current-buffer b buffer-file-name))
17835 (org-pop-to-buffer-same-window b)
17836 (revert-buffer t 'no-confirm)))
17837 (buffer-list))
17838 (when (and (featurep 'org-id) org-id-track-globally)
17839 (org-id-locations-load)))))
17841 ;;;; Agenda files
17843 ;;;###autoload
17844 (defun org-switchb (&optional arg)
17845 "Switch between Org buffers.
17846 With one prefix argument, restrict available buffers to files.
17847 With two prefix arguments, restrict available buffers to agenda files.
17849 Defaults to `iswitchb' for buffer name completion.
17850 Set `org-completion-use-ido' to make it use ido instead."
17851 (interactive "P")
17852 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17853 ((equal arg '(16)) (org-buffer-list 'agenda))
17854 (t (org-buffer-list))))
17855 (org-completion-use-iswitchb org-completion-use-iswitchb)
17856 (org-completion-use-ido org-completion-use-ido))
17857 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17858 (setq org-completion-use-iswitchb t))
17859 (org-pop-to-buffer-same-window
17860 (org-icompleting-read "Org buffer: "
17861 (mapcar 'list (mapcar 'buffer-name blist))
17862 nil t))))
17864 ;;; Define some older names previously used for this functionality
17865 ;;;###autoload
17866 (defalias 'org-ido-switchb 'org-switchb)
17867 ;;;###autoload
17868 (defalias 'org-iswitchb 'org-switchb)
17870 (defun org-buffer-list (&optional predicate exclude-tmp)
17871 "Return a list of Org buffers.
17872 PREDICATE can be `export', `files' or `agenda'.
17874 export restrict the list to Export buffers.
17875 files restrict the list to buffers visiting Org files.
17876 agenda restrict the list to buffers visiting agenda files.
17878 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17879 (let* ((bfn nil)
17880 (agenda-files (and (eq predicate 'agenda)
17881 (mapcar 'file-truename (org-agenda-files t))))
17882 (filter
17883 (cond
17884 ((eq predicate 'files)
17885 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17886 ((eq predicate 'export)
17887 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17888 ((eq predicate 'agenda)
17889 (lambda (b)
17890 (with-current-buffer b
17891 (and (derived-mode-p 'org-mode)
17892 (setq bfn (buffer-file-name b))
17893 (member (file-truename bfn) agenda-files)))))
17894 (t (lambda (b) (with-current-buffer b
17895 (or (derived-mode-p 'org-mode)
17896 (string-match "\*Org .*Export"
17897 (buffer-name b)))))))))
17898 (delq nil
17899 (mapcar
17900 (lambda(b)
17901 (if (and (funcall filter b)
17902 (or (not exclude-tmp)
17903 (not (string-match "tmp" (buffer-name b)))))
17905 nil))
17906 (buffer-list)))))
17908 (defun org-agenda-files (&optional unrestricted archives)
17909 "Get the list of agenda files.
17910 Optional UNRESTRICTED means return the full list even if a restriction
17911 is currently in place.
17912 When ARCHIVES is t, include all archive files that are really being
17913 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17914 `org-agenda-archives-mode' is t."
17915 (let ((files
17916 (cond
17917 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17918 ((stringp org-agenda-files) (org-read-agenda-file-list))
17919 ((listp org-agenda-files) org-agenda-files)
17920 (t (error "Invalid value of `org-agenda-files'")))))
17921 (setq files (apply 'append
17922 (mapcar (lambda (f)
17923 (if (file-directory-p f)
17924 (directory-files
17925 f t org-agenda-file-regexp)
17926 (list f)))
17927 files)))
17928 (when org-agenda-skip-unavailable-files
17929 (setq files (delq nil
17930 (mapcar (function
17931 (lambda (file)
17932 (and (file-readable-p file) file)))
17933 files))))
17934 (when (or (eq archives t)
17935 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17936 (setq files (org-add-archive-files files)))
17937 files))
17939 (defun org-agenda-file-p (&optional file)
17940 "Return non-nil, if FILE is an agenda file.
17941 If FILE is omitted, use the file associated with the current
17942 buffer."
17943 (member (or file (buffer-file-name))
17944 (org-agenda-files t)))
17946 (defun org-edit-agenda-file-list ()
17947 "Edit the list of agenda files.
17948 Depending on setup, this either uses customize to edit the variable
17949 `org-agenda-files', or it visits the file that is holding the list. In the
17950 latter case, the buffer is set up in a way that saving it automatically kills
17951 the buffer and restores the previous window configuration."
17952 (interactive)
17953 (if (stringp org-agenda-files)
17954 (let ((cw (current-window-configuration)))
17955 (find-file org-agenda-files)
17956 (org-set-local 'org-window-configuration cw)
17957 (org-add-hook 'after-save-hook
17958 (lambda ()
17959 (set-window-configuration
17960 (prog1 org-window-configuration
17961 (kill-buffer (current-buffer))))
17962 (org-install-agenda-files-menu)
17963 (message "New agenda file list installed"))
17964 nil 'local)
17965 (message "%s" (substitute-command-keys
17966 "Edit list and finish with \\[save-buffer]")))
17967 (customize-variable 'org-agenda-files)))
17969 (defun org-store-new-agenda-file-list (list)
17970 "Set new value for the agenda file list and save it correctly."
17971 (if (stringp org-agenda-files)
17972 (let ((fe (org-read-agenda-file-list t)) b u)
17973 (while (setq b (find-buffer-visiting org-agenda-files))
17974 (kill-buffer b))
17975 (with-temp-file org-agenda-files
17976 (insert
17977 (mapconcat
17978 (lambda (f) ;; Keep un-expanded entries.
17979 (if (setq u (assoc f fe))
17980 (cdr u)
17982 list "\n")
17983 "\n")))
17984 (let ((org-mode-hook nil) (org-inhibit-startup t)
17985 (org-insert-mode-line-in-empty-file nil))
17986 (setq org-agenda-files list)
17987 (customize-save-variable 'org-agenda-files org-agenda-files))))
17989 (defun org-read-agenda-file-list (&optional pair-with-expansion)
17990 "Read the list of agenda files from a file.
17991 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
17992 filenames, used by `org-store-new-agenda-file-list' to write back
17993 un-expanded file names."
17994 (when (file-directory-p org-agenda-files)
17995 (error "`org-agenda-files' cannot be a single directory"))
17996 (when (stringp org-agenda-files)
17997 (with-temp-buffer
17998 (insert-file-contents org-agenda-files)
17999 (mapcar
18000 (lambda (f)
18001 (let ((e (expand-file-name (substitute-in-file-name f)
18002 org-directory)))
18003 (if pair-with-expansion
18004 (cons e f)
18005 e)))
18006 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18008 ;;;###autoload
18009 (defun org-cycle-agenda-files ()
18010 "Cycle through the files in `org-agenda-files'.
18011 If the current buffer visits an agenda file, find the next one in the list.
18012 If the current buffer does not, find the first agenda file."
18013 (interactive)
18014 (let* ((fs (org-agenda-files t))
18015 (files (append fs (list (car fs))))
18016 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18017 file)
18018 (unless files (user-error "No agenda files"))
18019 (catch 'exit
18020 (while (setq file (pop files))
18021 (if (equal (file-truename file) tcf)
18022 (when (car files)
18023 (find-file (car files))
18024 (throw 'exit t))))
18025 (find-file (car fs)))
18026 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18028 (defun org-agenda-file-to-front (&optional to-end)
18029 "Move/add the current file to the top of the agenda file list.
18030 If the file is not present in the list, it is added to the front. If it is
18031 present, it is moved there. With optional argument TO-END, add/move to the
18032 end of the list."
18033 (interactive "P")
18034 (let ((org-agenda-skip-unavailable-files nil)
18035 (file-alist (mapcar (lambda (x)
18036 (cons (file-truename x) x))
18037 (org-agenda-files t)))
18038 (ctf (file-truename
18039 (or buffer-file-name
18040 (user-error "Please save the current buffer to a file"))))
18041 x had)
18042 (setq x (assoc ctf file-alist) had x)
18044 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18045 (if to-end
18046 (setq file-alist (append (delq x file-alist) (list x)))
18047 (setq file-alist (cons x (delq x file-alist))))
18048 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18049 (org-install-agenda-files-menu)
18050 (message "File %s to %s of agenda file list"
18051 (if had "moved" "added") (if to-end "end" "front"))))
18053 (defun org-remove-file (&optional file)
18054 "Remove current file from the list of files in variable `org-agenda-files'.
18055 These are the files which are being checked for agenda entries.
18056 Optional argument FILE means use this file instead of the current."
18057 (interactive)
18058 (let* ((org-agenda-skip-unavailable-files nil)
18059 (file (or file buffer-file-name
18060 (user-error "Current buffer does not visit a file")))
18061 (true-file (file-truename file))
18062 (afile (abbreviate-file-name file))
18063 (files (delq nil (mapcar
18064 (lambda (x)
18065 (if (equal true-file
18066 (file-truename x))
18067 nil x))
18068 (org-agenda-files t)))))
18069 (if (not (= (length files) (length (org-agenda-files t))))
18070 (progn
18071 (org-store-new-agenda-file-list files)
18072 (org-install-agenda-files-menu)
18073 (message "Removed file: %s" afile))
18074 (message "File was not in list: %s (not removed)" afile))))
18076 (defun org-file-menu-entry (file)
18077 (vector file (list 'find-file file) t))
18079 (defun org-check-agenda-file (file)
18080 "Make sure FILE exists. If not, ask user what to do."
18081 (when (not (file-exists-p file))
18082 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18083 (abbreviate-file-name file))
18084 (let ((r (downcase (read-char-exclusive))))
18085 (cond
18086 ((equal r ?r)
18087 (org-remove-file file)
18088 (throw 'nextfile t))
18089 (t (error "Abort"))))))
18091 (defun org-get-agenda-file-buffer (file)
18092 "Get a buffer visiting FILE. If the buffer needs to be created, add
18093 it to the list of buffers which might be released later."
18094 (let ((buf (org-find-base-buffer-visiting file)))
18095 (if buf
18096 buf ; just return it
18097 ;; Make a new buffer and remember it
18098 (setq buf (find-file-noselect file))
18099 (if buf (push buf org-agenda-new-buffers))
18100 buf)))
18102 (defun org-release-buffers (blist)
18103 "Release all buffers in list, asking the user for confirmation when needed.
18104 When a buffer is unmodified, it is just killed. When modified, it is saved
18105 \(if the user agrees) and then killed."
18106 (let (buf file)
18107 (while (setq buf (pop blist))
18108 (setq file (buffer-file-name buf))
18109 (when (and (buffer-modified-p buf)
18110 file
18111 (y-or-n-p (format "Save file %s? " file)))
18112 (with-current-buffer buf (save-buffer)))
18113 (kill-buffer buf))))
18115 (defun org-agenda-prepare-buffers (files)
18116 "Create buffers for all agenda files, protect archived trees and comments."
18117 (interactive)
18118 (let ((pa '(:org-archived t))
18119 (pc '(:org-comment t))
18120 (pall '(:org-archived t :org-comment t))
18121 (inhibit-read-only t)
18122 (org-inhibit-startup org-agenda-inhibit-startup)
18123 (rea (concat ":" org-archive-tag ":"))
18124 file re pos)
18125 (setq org-tag-alist-for-agenda nil
18126 org-tag-groups-alist-for-agenda nil)
18127 (save-window-excursion
18128 (save-restriction
18129 (while (setq file (pop files))
18130 (catch 'nextfile
18131 (if (bufferp file)
18132 (set-buffer file)
18133 (org-check-agenda-file file)
18134 (set-buffer (org-get-agenda-file-buffer file)))
18135 (widen)
18136 (org-set-regexps-and-options-for-tags)
18137 (setq pos (point))
18138 (goto-char (point-min))
18139 (let ((case-fold-search t))
18140 (when (search-forward "#+setupfile" nil t)
18141 ;; Don't set all regexps and options systematically as
18142 ;; this is only run for setting agenda tags from setup
18143 ;; file
18144 (org-set-regexps-and-options)))
18145 (or (memq 'category org-agenda-ignore-drawer-properties)
18146 (org-refresh-category-properties))
18147 (or (memq 'effort org-agenda-ignore-drawer-properties)
18148 (org-refresh-properties org-effort-property 'org-effort))
18149 (or (memq 'appt org-agenda-ignore-drawer-properties)
18150 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18151 (setq org-todo-keywords-for-agenda
18152 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18153 (setq org-done-keywords-for-agenda
18154 (append org-done-keywords-for-agenda org-done-keywords))
18155 (setq org-todo-keyword-alist-for-agenda
18156 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18157 (setq org-tag-alist-for-agenda
18158 (org-uniquify
18159 (append org-tag-alist-for-agenda
18160 org-tag-alist
18161 org-tag-persistent-alist)))
18162 (if org-group-tags
18163 (setq org-tag-groups-alist-for-agenda
18164 (org-uniquify-alist
18165 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18166 (org-with-silent-modifications
18167 (save-excursion
18168 (remove-text-properties (point-min) (point-max) pall)
18169 (when org-agenda-skip-archived-trees
18170 (goto-char (point-min))
18171 (while (re-search-forward rea nil t)
18172 (if (org-at-heading-p t)
18173 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18174 (goto-char (point-min))
18175 (setq re (format org-heading-keyword-regexp-format
18176 org-comment-string))
18177 (while (re-search-forward re nil t)
18178 (add-text-properties
18179 (match-beginning 0) (org-end-of-subtree t) pc))))
18180 (goto-char pos)))))
18181 (setq org-todo-keywords-for-agenda
18182 (org-uniquify org-todo-keywords-for-agenda))
18183 (setq org-todo-keyword-alist-for-agenda
18184 (org-uniquify org-todo-keyword-alist-for-agenda))))
18187 ;;;; CDLaTeX minor mode
18189 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18190 "Keymap for the minor `org-cdlatex-mode'.")
18192 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18193 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18194 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18195 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18196 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18198 (defvar org-cdlatex-texmathp-advice-is-done nil
18199 "Flag remembering if we have applied the advice to texmathp already.")
18201 (define-minor-mode org-cdlatex-mode
18202 "Toggle the minor `org-cdlatex-mode'.
18203 This mode supports entering LaTeX environment and math in LaTeX fragments
18204 in Org-mode.
18205 \\{org-cdlatex-mode-map}"
18206 nil " OCDL" nil
18207 (when org-cdlatex-mode
18208 (require 'cdlatex)
18209 (run-hooks 'cdlatex-mode-hook)
18210 (cdlatex-compute-tables))
18211 (unless org-cdlatex-texmathp-advice-is-done
18212 (setq org-cdlatex-texmathp-advice-is-done t)
18213 (defadvice texmathp (around org-math-always-on activate)
18214 "Always return t in org-mode buffers.
18215 This is because we want to insert math symbols without dollars even outside
18216 the LaTeX math segments. If Orgmode thinks that point is actually inside
18217 an embedded LaTeX fragment, let texmathp do its job.
18218 \\[org-cdlatex-mode-map]"
18219 (interactive)
18220 (let (p)
18221 (cond
18222 ((not (derived-mode-p 'org-mode)) ad-do-it)
18223 ((eq this-command 'cdlatex-math-symbol)
18224 (setq ad-return-value t
18225 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18227 (let ((p (org-inside-LaTeX-fragment-p)))
18228 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18229 (setq ad-return-value t
18230 texmathp-why '("Org-mode embedded math" . 0))
18231 (if p ad-do-it)))))))))
18233 (defun turn-on-org-cdlatex ()
18234 "Unconditionally turn on `org-cdlatex-mode'."
18235 (org-cdlatex-mode 1))
18237 (defun org-try-cdlatex-tab ()
18238 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18239 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18240 - inside a LaTeX fragment, or
18241 - after the first word in a line, where an abbreviation expansion could
18242 insert a LaTeX environment."
18243 (when org-cdlatex-mode
18244 (cond
18245 ;; Before any word on the line: No expansion possible.
18246 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18247 ;; Just after first word on the line: Expand it. Make sure it
18248 ;; cannot happen on headlines, though.
18249 ((save-excursion
18250 (skip-chars-backward "a-zA-Z0-9*")
18251 (skip-chars-backward " \t")
18252 (and (bolp) (not (org-at-heading-p))))
18253 (cdlatex-tab) t)
18254 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18256 (defun org-cdlatex-underscore-caret (&optional arg)
18257 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18258 Revert to the normal definition outside of these fragments."
18259 (interactive "P")
18260 (if (org-inside-LaTeX-fragment-p)
18261 (call-interactively 'cdlatex-sub-superscript)
18262 (let (org-cdlatex-mode)
18263 (call-interactively (key-binding (vector last-input-event))))))
18265 (defun org-cdlatex-math-modify (&optional arg)
18266 "Execute `cdlatex-math-modify' in LaTeX fragments.
18267 Revert to the normal definition outside of these fragments."
18268 (interactive "P")
18269 (if (org-inside-LaTeX-fragment-p)
18270 (call-interactively 'cdlatex-math-modify)
18271 (let (org-cdlatex-mode)
18272 (call-interactively (key-binding (vector last-input-event))))))
18276 ;;;; LaTeX fragments
18278 (defun org-inside-LaTeX-fragment-p ()
18279 "Test if point is inside a LaTeX fragment.
18280 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18281 sequence appearing also before point.
18282 Even though the matchers for math are configurable, this function assumes
18283 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18284 delimiters are skipped when they have been removed by customization.
18285 The return value is nil, or a cons cell with the delimiter and the
18286 position of this delimiter.
18288 This function does a reasonably good job, but can locally be fooled by
18289 for example currency specifications. For example it will assume being in
18290 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18291 fragments that are properly closed, but during editing, we have to live
18292 with the uncertainty caused by missing closing delimiters. This function
18293 looks only before point, not after."
18294 (catch 'exit
18295 (let ((pos (point))
18296 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18297 (lim (progn
18298 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18299 (point)))
18300 dd-on str (start 0) m re)
18301 (goto-char pos)
18302 (when dodollar
18303 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18304 re (nth 1 (assoc "$" org-latex-regexps)))
18305 (while (string-match re str start)
18306 (cond
18307 ((= (match-end 0) (length str))
18308 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18309 ((= (match-end 0) (- (length str) 5))
18310 (throw 'exit nil))
18311 (t (setq start (match-end 0))))))
18312 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18313 (goto-char pos)
18314 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18315 (and (match-beginning 2) (throw 'exit nil))
18316 ;; count $$
18317 (while (re-search-backward "\\$\\$" lim t)
18318 (setq dd-on (not dd-on)))
18319 (goto-char pos)
18320 (if dd-on (cons "$$" m))))))
18322 (defun org-inside-latex-macro-p ()
18323 "Is point inside a LaTeX macro or its arguments?"
18324 (save-match-data
18325 (org-in-regexp
18326 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18328 (defvar org-latex-fragment-image-overlays nil
18329 "List of overlays carrying the images of latex fragments.")
18330 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18332 (defun org-remove-latex-fragment-image-overlays ()
18333 "Remove all overlays with LaTeX fragment images in current buffer."
18334 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18335 (setq org-latex-fragment-image-overlays nil))
18337 (defun org-preview-latex-fragment (&optional subtree)
18338 "Preview the LaTeX fragment at point, or all locally or globally.
18339 If the cursor is in a LaTeX fragment, create the image and overlay
18340 it over the source code. If there is no fragment at point, display
18341 all fragments in the current text, from one headline to the next. With
18342 prefix SUBTREE, display all fragments in the current subtree. With a
18343 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18344 the cursor is before the first headline,
18345 display all fragments in the buffer.
18346 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18347 (interactive "P")
18348 (unless buffer-file-name
18349 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18350 (when (display-graphic-p)
18351 (org-remove-latex-fragment-image-overlays)
18352 (save-excursion
18353 (save-restriction
18354 (let (beg end at msg)
18355 (cond
18356 ((or (equal subtree '(16))
18357 (not (save-excursion
18358 (re-search-backward org-outline-regexp-bol nil t))))
18359 (setq beg (point-min) end (point-max)
18360 msg "Creating images for buffer...%s"))
18361 ((equal subtree '(4))
18362 (org-back-to-heading)
18363 (setq beg (point) end (org-end-of-subtree t)
18364 msg "Creating images for subtree...%s"))
18366 (if (setq at (org-inside-LaTeX-fragment-p))
18367 (goto-char (max (point-min) (- (cdr at) 2)))
18368 (org-back-to-heading))
18369 (setq beg (point) end (progn (outline-next-heading) (point))
18370 msg (if at "Creating image...%s"
18371 "Creating images for entry...%s"))))
18372 (message msg "")
18373 (narrow-to-region beg end)
18374 (goto-char beg)
18375 (org-format-latex
18376 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18377 (file-name-nondirectory
18378 buffer-file-name)))
18379 default-directory 'overlays msg at 'forbuffer
18380 org-latex-create-formula-image-program)
18381 (message msg "done. Use `C-c C-c' to remove images."))))))
18383 (defun org-format-latex (prefix &optional dir overlays msg at
18384 forbuffer processing-type)
18385 "Replace LaTeX fragments with links to an image, and produce images.
18386 Some of the options can be changed using the variable
18387 `org-format-latex-options'."
18388 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18389 (let* ((prefixnodir (file-name-nondirectory prefix))
18390 (absprefix (expand-file-name prefix dir))
18391 (todir (file-name-directory absprefix))
18392 (opt org-format-latex-options)
18393 (optnew org-format-latex-options)
18394 (matchers (plist-get opt :matchers))
18395 (re-list org-latex-regexps)
18396 (cnt 0) txt hash link beg end re e checkdir
18397 string
18398 m n block-type block linkfile movefile ov)
18399 ;; Check the different regular expressions
18400 (while (setq e (pop re-list))
18401 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18402 block (if block-type "\n\n" ""))
18403 (when (member m matchers)
18404 (goto-char (point-min))
18405 (while (re-search-forward re nil t)
18406 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18407 (or (not overlays)
18408 (not (eq (get-char-property (match-beginning n)
18409 'org-overlay-type)
18410 'org-latex-overlay))))
18411 (cond
18412 ((eq processing-type 'verbatim))
18413 ((eq processing-type 'mathjax)
18414 ;; Prepare for MathJax processing.
18415 (setq string (match-string n))
18416 (when (member m '("$" "$1"))
18417 (save-excursion
18418 (delete-region (match-beginning n) (match-end n))
18419 (goto-char (match-beginning n))
18420 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18421 ((or (eq processing-type 'dvipng)
18422 (eq processing-type 'imagemagick))
18423 ;; Process to an image.
18424 (setq txt (match-string n)
18425 beg (match-beginning n) end (match-end n)
18426 cnt (1+ cnt))
18427 (let ((face (face-at-point))
18428 (fg (plist-get opt :foreground))
18429 (bg (plist-get opt :background))
18430 ;; Ensure full list is printed.
18431 print-length print-level)
18432 (when forbuffer
18433 ;; Get the colors from the face at point.
18434 (goto-char beg)
18435 (when (eq fg 'auto)
18436 (setq fg (face-attribute face :foreground nil 'default)))
18437 (when (eq bg 'auto)
18438 (setq bg (face-attribute face :background nil 'default)))
18439 (setq optnew (copy-sequence opt))
18440 (plist-put optnew :foreground fg)
18441 (plist-put optnew :background bg))
18442 (setq hash (sha1 (prin1-to-string
18443 (list org-format-latex-header
18444 org-latex-default-packages-alist
18445 org-latex-packages-alist
18446 org-format-latex-options
18447 forbuffer txt fg bg)))
18448 linkfile (format "%s_%s.png" prefix hash)
18449 movefile (format "%s_%s.png" absprefix hash)))
18450 (setq link (concat block "[[file:" linkfile "]]" block))
18451 (if msg (message msg cnt))
18452 (goto-char beg)
18453 (unless checkdir ; Ensure the directory exists.
18454 (setq checkdir t)
18455 (or (file-directory-p todir) (make-directory todir t)))
18456 (unless (file-exists-p movefile)
18457 (org-create-formula-image
18458 txt movefile optnew forbuffer processing-type))
18459 (if overlays
18460 (progn
18461 (mapc (lambda (o)
18462 (if (eq (overlay-get o 'org-overlay-type)
18463 'org-latex-overlay)
18464 (delete-overlay o)))
18465 (overlays-in beg end))
18466 (setq ov (make-overlay beg end))
18467 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18468 (if (featurep 'xemacs)
18469 (progn
18470 (overlay-put ov 'invisible t)
18471 (overlay-put
18472 ov 'end-glyph
18473 (make-glyph (vector 'png :file movefile))))
18474 (overlay-put
18475 ov 'display
18476 (list 'image :type 'png :file movefile :ascent 'center)))
18477 (push ov org-latex-fragment-image-overlays)
18478 (goto-char end))
18479 (delete-region beg end)
18480 (insert (org-add-props link
18481 (list 'org-latex-src
18482 (replace-regexp-in-string
18483 "\"" "" txt)
18484 'org-latex-src-embed-type
18485 (if block-type 'paragraph 'character))))))
18486 ((eq processing-type 'mathml)
18487 ;; Process to MathML
18488 (unless (save-match-data (org-format-latex-mathml-available-p))
18489 (user-error "LaTeX to MathML converter not configured"))
18490 (setq txt (match-string n)
18491 beg (match-beginning n) end (match-end n)
18492 cnt (1+ cnt))
18493 (if msg (message msg cnt))
18494 (goto-char beg)
18495 (delete-region beg end)
18496 (insert (org-format-latex-as-mathml
18497 txt block-type prefix dir)))
18499 (error "Unknown conversion type %s for LaTeX fragments"
18500 processing-type)))))))))
18502 (defun org-create-math-formula (latex-frag &optional mathml-file)
18503 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18504 Use `org-latex-to-mathml-convert-command'. If the conversion is
18505 sucessful, return the portion between \"<math...> </math>\"
18506 elements otherwise return nil. When MATHML-FILE is specified,
18507 write the results in to that file. When invoked as an
18508 interactive command, prompt for LATEX-FRAG, with initial value
18509 set to the current active region and echo the results for user
18510 inspection."
18511 (interactive (list (let ((frag (when (org-region-active-p)
18512 (buffer-substring-no-properties
18513 (region-beginning) (region-end)))))
18514 (read-string "LaTeX Fragment: " frag nil frag))))
18515 (unless latex-frag (error "Invalid LaTeX fragment"))
18516 (let* ((tmp-in-file (file-relative-name
18517 (make-temp-name (expand-file-name "ltxmathml-in"))))
18518 (ignore (write-region latex-frag nil tmp-in-file))
18519 (tmp-out-file (file-relative-name
18520 (make-temp-name (expand-file-name "ltxmathml-out"))))
18521 (cmd (format-spec
18522 org-latex-to-mathml-convert-command
18523 `((?j . ,(shell-quote-argument
18524 (expand-file-name org-latex-to-mathml-jar-file)))
18525 (?I . ,(shell-quote-argument tmp-in-file))
18526 (?o . ,(shell-quote-argument tmp-out-file)))))
18527 mathml shell-command-output)
18528 (when (org-called-interactively-p 'any)
18529 (unless (org-format-latex-mathml-available-p)
18530 (user-error "LaTeX to MathML converter not configured")))
18531 (message "Running %s" cmd)
18532 (setq shell-command-output (shell-command-to-string cmd))
18533 (setq mathml
18534 (when (file-readable-p tmp-out-file)
18535 (with-current-buffer (find-file-noselect tmp-out-file t)
18536 (goto-char (point-min))
18537 (when (re-search-forward
18538 (concat
18539 (regexp-quote
18540 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18541 "\\(.\\|\n\\)*"
18542 (regexp-quote "</math>")) nil t)
18543 (prog1 (match-string 0) (kill-buffer))))))
18544 (cond
18545 (mathml
18546 (setq mathml
18547 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18548 (when mathml-file
18549 (write-region mathml nil mathml-file))
18550 (when (org-called-interactively-p 'any)
18551 (message mathml)))
18552 ((message "LaTeX to MathML conversion failed")
18553 (message shell-command-output)))
18554 (delete-file tmp-in-file)
18555 (when (file-exists-p tmp-out-file)
18556 (delete-file tmp-out-file))
18557 mathml))
18559 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18560 prefix &optional dir)
18561 "Use `org-create-math-formula' but check local cache first."
18562 (let* ((absprefix (expand-file-name prefix dir))
18563 (print-length nil) (print-level nil)
18564 (formula-id (concat
18565 "formula-"
18566 (sha1
18567 (prin1-to-string
18568 (list latex-frag
18569 org-latex-to-mathml-convert-command)))))
18570 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18571 (formula-cache-dir (file-name-directory formula-cache)))
18573 (unless (file-directory-p formula-cache-dir)
18574 (make-directory formula-cache-dir t))
18576 (unless (file-exists-p formula-cache)
18577 (org-create-math-formula latex-frag formula-cache))
18579 (if (file-exists-p formula-cache)
18580 ;; Successful conversion. Return the link to MathML file.
18581 (org-add-props
18582 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18583 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18584 'org-latex-src-embed-type (if latex-frag-type
18585 'paragraph 'character)))
18586 ;; Failed conversion. Return the LaTeX fragment verbatim
18587 latex-frag)))
18589 (defun org-create-formula-image (string tofile options buffer &optional type)
18590 "Create an image from LaTeX source using dvipng or convert.
18591 This function calls either `org-create-formula-image-with-dvipng'
18592 or `org-create-formula-image-with-imagemagick' depending on the
18593 value of `org-latex-create-formula-image-program' or on the value
18594 of the optional TYPE variable.
18596 Note: ultimately these two function should be combined as they
18597 share a good deal of logic."
18598 (org-check-external-command
18599 "latex" "needed to convert LaTeX fragments to images")
18600 (funcall
18601 (case (or type org-latex-create-formula-image-program)
18602 ('dvipng
18603 (org-check-external-command
18604 "dvipng" "needed to convert LaTeX fragments to images")
18605 #'org-create-formula-image-with-dvipng)
18606 ('imagemagick
18607 (org-check-external-command
18608 "convert" "you need to install imagemagick")
18609 #'org-create-formula-image-with-imagemagick)
18610 (t (error
18611 "Invalid value of `org-latex-create-formula-image-program'")))
18612 string tofile options buffer))
18614 (declare-function org-export-get-backend "ox" (name))
18615 (declare-function org-export--get-global-options "ox" (&optional backend))
18616 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18617 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18618 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18619 (defun org-create-formula--latex-header ()
18620 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18621 (let ((info (org-combine-plists (org-export--get-global-options
18622 (org-export-get-backend 'latex))
18623 (org-export--get-inbuffer-options
18624 (org-export-get-backend 'latex)))))
18625 (org-latex-guess-babel-language
18626 (org-latex-guess-inputenc
18627 (org-splice-latex-header
18628 org-format-latex-header
18629 org-latex-default-packages-alist
18630 org-latex-packages-alist t
18631 (plist-get info :latex-header)))
18632 info)))
18634 ;; This function borrows from Ganesh Swami's latex2png.el
18635 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18636 "This calls dvipng."
18637 (require 'ox-latex)
18638 (let* ((tmpdir (if (featurep 'xemacs)
18639 (temp-directory)
18640 temporary-file-directory))
18641 (texfilebase (make-temp-name
18642 (expand-file-name "orgtex" tmpdir)))
18643 (texfile (concat texfilebase ".tex"))
18644 (dvifile (concat texfilebase ".dvi"))
18645 (pngfile (concat texfilebase ".png"))
18646 (fnh (if (featurep 'xemacs)
18647 (font-height (face-font 'default))
18648 (face-attribute 'default :height nil)))
18649 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18650 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18651 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18652 "Black"))
18653 (bg (or (plist-get options (if buffer :background :html-background))
18654 "Transparent")))
18655 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18656 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18657 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18658 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18659 (let ((latex-header (org-create-formula--latex-header)))
18660 (with-temp-file texfile
18661 (insert latex-header)
18662 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18663 (let ((dir default-directory))
18664 (condition-case nil
18665 (progn
18666 (cd tmpdir)
18667 (call-process "latex" nil nil nil texfile))
18668 (error nil))
18669 (cd dir))
18670 (if (not (file-exists-p dvifile))
18671 (progn (message "Failed to create dvi file from %s" texfile) nil)
18672 (condition-case nil
18673 (if (featurep 'xemacs)
18674 (call-process "dvipng" nil nil nil
18675 "-fg" fg "-bg" bg
18676 "-T" "tight"
18677 "-o" pngfile
18678 dvifile)
18679 (call-process "dvipng" nil nil nil
18680 "-fg" fg "-bg" bg
18681 "-D" dpi
18682 ;;"-x" scale "-y" scale
18683 "-T" "tight"
18684 "-o" pngfile
18685 dvifile))
18686 (error nil))
18687 (if (not (file-exists-p pngfile))
18688 (if org-format-latex-signal-error
18689 (error "Failed to create png file from %s" texfile)
18690 (message "Failed to create png file from %s" texfile)
18691 nil)
18692 ;; Use the requested file name and clean up
18693 (copy-file pngfile tofile 'replace)
18694 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18695 (if (file-exists-p (concat texfilebase e))
18696 (delete-file (concat texfilebase e))))
18697 pngfile))))
18699 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18700 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18701 "This calls convert, which is included into imagemagick."
18702 (require 'ox-latex)
18703 (let* ((tmpdir (if (featurep 'xemacs)
18704 (temp-directory)
18705 temporary-file-directory))
18706 (texfilebase (make-temp-name
18707 (expand-file-name "orgtex" tmpdir)))
18708 (texfile (concat texfilebase ".tex"))
18709 (pdffile (concat texfilebase ".pdf"))
18710 (pngfile (concat texfilebase ".png"))
18711 (fnh (if (featurep 'xemacs)
18712 (font-height (face-font 'default))
18713 (face-attribute 'default :height nil)))
18714 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18715 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18716 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18717 "black"))
18718 (bg (or (plist-get options (if buffer :background :html-background))
18719 "white")))
18720 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18721 (setq fg (org-latex-color-format fg)))
18722 (if (eq bg 'default) (setq bg (org-latex-color :background))
18723 (setq bg (org-latex-color-format
18724 (if (string= bg "Transparent") "white" bg))))
18725 (let ((latex-header (org-create-formula--latex-header)))
18726 (with-temp-file texfile
18727 (insert latex-header)
18728 (insert "\n\\begin{document}\n"
18729 "\\definecolor{fg}{rgb}{" fg "}\n"
18730 "\\definecolor{bg}{rgb}{" bg "}\n"
18731 "\n\\pagecolor{bg}\n"
18732 "\n{\\color{fg}\n"
18733 string
18734 "\n}\n"
18735 "\n\\end{document}\n")))
18736 (org-latex-compile texfile t)
18737 (if (not (file-exists-p pdffile))
18738 (progn (message "Failed to create pdf file from %s" texfile) nil)
18739 (condition-case nil
18740 (if (featurep 'xemacs)
18741 (call-process "convert" nil nil nil
18742 "-density" "96"
18743 "-trim"
18744 "-antialias"
18745 pdffile
18746 "-quality" "100"
18747 ;; "-sharpen" "0x1.0"
18748 pngfile)
18749 (call-process "convert" nil nil nil
18750 "-density" dpi
18751 "-trim"
18752 "-antialias"
18753 pdffile
18754 "-quality" "100"
18755 ;; "-sharpen" "0x1.0"
18756 pngfile))
18757 (error nil))
18758 (if (not (file-exists-p pngfile))
18759 (if org-format-latex-signal-error
18760 (error "Failed to create png file from %s" texfile)
18761 (message "Failed to create png file from %s" texfile)
18762 nil)
18763 ;; Use the requested file name and clean up
18764 (copy-file pngfile tofile 'replace)
18765 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18766 (if (file-exists-p (concat texfilebase e))
18767 (delete-file (concat texfilebase e))))
18768 pngfile))))
18770 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18771 "Fill a LaTeX header template TPL.
18772 In the template, the following place holders will be recognized:
18774 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18775 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18776 [PACKAGES] \\usepackage statements for PKG
18777 [NO-PACKAGES] do not include PKG
18778 [EXTRA] the string EXTRA
18779 [NO-EXTRA] do not include EXTRA
18781 For backward compatibility, if both the positive and the negative place
18782 holder is missing, the positive one (without the \"NO-\") will be
18783 assumed to be present at the end of the template.
18784 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18785 EXTRA is a string.
18786 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18787 (let (rpl (end ""))
18788 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18789 (setq rpl (if (or (match-end 1) (not def-pkg))
18790 "" (org-latex-packages-to-string def-pkg snippets-p t))
18791 tpl (replace-match rpl t t tpl))
18792 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18794 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18795 (setq rpl (if (or (match-end 1) (not pkg))
18796 "" (org-latex-packages-to-string pkg snippets-p t))
18797 tpl (replace-match rpl t t tpl))
18798 (if pkg (setq end
18799 (concat end "\n"
18800 (org-latex-packages-to-string pkg snippets-p)))))
18802 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18803 (setq rpl (if (or (match-end 1) (not extra))
18804 "" (concat extra "\n"))
18805 tpl (replace-match rpl t t tpl))
18806 (if (and extra (string-match "\\S-" extra))
18807 (setq end (concat end "\n" extra))))
18809 (if (string-match "\\S-" end)
18810 (concat tpl "\n" end)
18811 tpl)))
18813 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18814 "Turn an alist of packages into a string with the \\usepackage macros."
18815 (setq pkg (mapconcat (lambda(p)
18816 (cond
18817 ((stringp p) p)
18818 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18819 (format "%% Package %s omitted" (cadr p)))
18820 ((equal "" (car p))
18821 (format "\\usepackage{%s}" (cadr p)))
18823 (format "\\usepackage[%s]{%s}"
18824 (car p) (cadr p)))))
18826 "\n"))
18827 (if newline (concat pkg "\n") pkg))
18829 (defun org-dvipng-color (attr)
18830 "Return a RGB color specification for dvipng."
18831 (apply 'format "rgb %s %s %s"
18832 (mapcar 'org-normalize-color
18833 (if (featurep 'xemacs)
18834 (color-rgb-components
18835 (face-property 'default
18836 (cond ((eq attr :foreground) 'foreground)
18837 ((eq attr :background) 'background))))
18838 (color-values (face-attribute 'default attr nil))))))
18840 (defun org-dvipng-color-format (color-name)
18841 "Convert COLOR-NAME to a RGB color value for dvipng."
18842 (apply 'format "rgb %s %s %s"
18843 (mapcar 'org-normalize-color
18844 (color-values color-name))))
18846 (defun org-latex-color (attr)
18847 "Return a RGB color for the LaTeX color package."
18848 (apply 'format "%s,%s,%s"
18849 (mapcar 'org-normalize-color
18850 (if (featurep 'xemacs)
18851 (color-rgb-components
18852 (face-property 'default
18853 (cond ((eq attr :foreground) 'foreground)
18854 ((eq attr :background) 'background))))
18855 (color-values (face-attribute 'default attr nil))))))
18857 (defun org-latex-color-format (color-name)
18858 "Convert COLOR-NAME to a RGB color value."
18859 (apply 'format "%s,%s,%s"
18860 (mapcar 'org-normalize-color
18861 (color-values color-name))))
18863 (defun org-normalize-color (value)
18864 "Return string to be used as color value for an RGB component."
18865 (format "%g" (/ value 65535.0)))
18869 ;; Image display
18871 (defvar org-inline-image-overlays nil)
18872 (make-variable-buffer-local 'org-inline-image-overlays)
18874 (defun org-toggle-inline-images (&optional include-linked)
18875 "Toggle the display of inline images.
18876 INCLUDE-LINKED is passed to `org-display-inline-images'."
18877 (interactive "P")
18878 (if org-inline-image-overlays
18879 (progn
18880 (org-remove-inline-images)
18881 (message "Inline image display turned off"))
18882 (org-display-inline-images include-linked)
18883 (if (and (org-called-interactively-p)
18884 org-inline-image-overlays)
18885 (message "%d images displayed inline"
18886 (length org-inline-image-overlays))
18887 (message "No images to display inline"))))
18889 (defun org-redisplay-inline-images ()
18890 "Refresh the display of inline images."
18891 (interactive)
18892 (if (not org-inline-image-overlays)
18893 (org-toggle-inline-images)
18894 (org-toggle-inline-images)
18895 (org-toggle-inline-images)))
18897 (defun org-display-inline-images (&optional include-linked refresh beg end)
18898 "Display inline images.
18900 An inline image is a link which follows either of these
18901 conventions:
18903 1. Its path is a file with an extension matching return value
18904 from `image-file-name-regexp' and it has no contents.
18906 2. Its description consists in a single link of the previous
18907 type.
18909 When optional argument INCLUDE-LINKED is non-nil, also links with
18910 a text description part will be inlined. This can be nice for
18911 a quick look at those images, but it does not reflect what
18912 exported files will look like.
18914 When optional argument REFRESH is non-nil, refresh existing
18915 images between BEG and END. This will create new image displays
18916 only if necessary. BEG and END default to the buffer
18917 boundaries."
18918 (interactive "P")
18919 (when (display-graphic-p)
18920 (unless refresh
18921 (org-remove-inline-images)
18922 (when (fboundp 'clear-image-cache) (clear-image-cache)))
18923 (org-with-wide-buffer
18924 (goto-char (or beg (point-min)))
18925 (let ((case-fold-search t)
18926 (file-extension-re (org-image-file-name-regexp)))
18927 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
18928 (let ((link (save-match-data (org-element-context))))
18929 ;; Check if we're at an inline image.
18930 (when (and (equal (org-element-property :type link) "file")
18931 (or include-linked
18932 (not (org-element-property :contents-begin link)))
18933 (let ((parent (org-element-property :parent link)))
18934 (or (not (eq (org-element-type parent) 'link))
18935 (not (cdr (org-element-contents parent)))))
18936 (org-string-match-p file-extension-re
18937 (org-element-property :path link)))
18938 (let ((file (expand-file-name (org-element-property :path link))))
18939 (when (file-exists-p file)
18940 (let ((width
18941 ;; Apply `org-image-actual-width' specifications.
18942 (cond
18943 ((not (image-type-available-p 'imagemagick)) nil)
18944 ((eq org-image-actual-width t) nil)
18945 ((listp org-image-actual-width)
18947 ;; First try to find a width among
18948 ;; attributes associated to the paragraph
18949 ;; containing link.
18950 (let ((paragraph
18951 (let ((e link))
18952 (while (and (setq e (org-element-property
18953 :parent e))
18954 (not (eq (org-element-type e)
18955 'paragraph))))
18956 e)))
18957 (when paragraph
18958 (save-excursion
18959 (goto-char (org-element-property :begin paragraph))
18960 (when (save-match-data
18961 (re-search-forward
18962 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
18963 (org-element-property
18964 :post-affiliated paragraph)
18966 (string-to-number (match-string 1))))))
18967 ;; Otherwise, fall-back to provided number.
18968 (car org-image-actual-width)))
18969 ((numberp org-image-actual-width)
18970 org-image-actual-width)))
18971 (old (get-char-property-and-overlay
18972 (org-element-property :begin link)
18973 'org-image-overlay)))
18974 (if (and (car-safe old) refresh)
18975 (image-refresh (overlay-get (cdr old) 'display))
18976 (let ((image (save-match-data
18977 (create-image file
18978 (and width 'imagemagick)
18980 :width width))))
18981 (when image
18982 (let* ((link
18983 ;; If inline image is the description
18984 ;; of another link, be sure to
18985 ;; consider the latter as the one to
18986 ;; apply the overlay on.
18987 (let ((parent
18988 (org-element-property :parent link)))
18989 (if (eq (org-element-type parent) 'link)
18990 parent
18991 link)))
18992 (ov (make-overlay
18993 (org-element-property :begin link)
18994 (progn
18995 (goto-char
18996 (org-element-property :end link))
18997 (skip-chars-backward " \t")
18998 (point)))))
18999 (overlay-put ov 'display image)
19000 (overlay-put ov 'face 'default)
19001 (overlay-put ov 'org-image-overlay t)
19002 (overlay-put
19003 ov 'modification-hooks
19004 (list 'org-display-inline-remove-overlay))
19005 (push ov org-inline-image-overlays)))))))))))))))
19007 (define-obsolete-function-alias
19008 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19010 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19011 "Remove inline-display overlay if a corresponding region is modified."
19012 (let ((inhibit-modification-hooks t))
19013 (when (and ov after)
19014 (delete ov org-inline-image-overlays)
19015 (delete-overlay ov))))
19017 (defun org-remove-inline-images ()
19018 "Remove inline display of images."
19019 (interactive)
19020 (mapc 'delete-overlay org-inline-image-overlays)
19021 (setq org-inline-image-overlays nil))
19023 ;;;; Key bindings
19025 ;; Outline functions from `outline-mode-prefix-map'
19026 ;; that can be remapped in Org:
19027 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19028 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19029 (define-key org-mode-map [remap outline-forward-same-level]
19030 'org-forward-heading-same-level)
19031 (define-key org-mode-map [remap outline-backward-same-level]
19032 'org-backward-heading-same-level)
19033 (define-key org-mode-map [remap show-branches]
19034 'org-kill-note-or-show-branches)
19035 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19036 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19037 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19039 ;; Outline functions from `outline-mode-prefix-map' that can not
19040 ;; be remapped in Org:
19042 ;; - the column "key binding" shows whether the Outline function is still
19043 ;; available in Org mode on the same key that it has been bound to in
19044 ;; Outline mode:
19045 ;; - "overridden": key used for a different functionality in Org mode
19046 ;; - else: key still bound to the same Outline function in Org mode
19048 ;; | Outline function | key binding | Org replacement |
19049 ;; |------------------------------------+-------------+-----------------------|
19050 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19051 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19052 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19053 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19054 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19055 ;; | `show-entry' | overridden | no replacement |
19056 ;; | `show-children' | `C-c C-i' | visibility cycling |
19057 ;; | `show-branches' | `C-c C-k' | still same function |
19058 ;; | `show-subtree' | overridden | visibility cycling |
19059 ;; | `show-all' | overridden | no replacement |
19060 ;; | `hide-subtree' | overridden | visibility cycling |
19061 ;; | `hide-body' | overridden | no replacement |
19062 ;; | `hide-entry' | overridden | visibility cycling |
19063 ;; | `hide-leaves' | overridden | no replacement |
19064 ;; | `hide-sublevels' | overridden | no replacement |
19065 ;; | `hide-other' | overridden | no replacement |
19067 ;; Make `C-c C-x' a prefix key
19068 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19070 ;; TAB key with modifiers
19071 (org-defkey org-mode-map "\C-i" 'org-cycle)
19072 (org-defkey org-mode-map [(tab)] 'org-cycle)
19073 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19074 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19075 ;; The following line is necessary under Suse GNU/Linux
19076 (unless (featurep 'xemacs)
19077 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19078 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19079 (define-key org-mode-map [backtab] 'org-shifttab)
19081 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19082 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19083 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19085 ;; Cursor keys with modifiers
19086 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19087 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19088 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19089 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19091 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19092 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19093 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19094 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19096 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19097 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19098 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19099 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19101 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19102 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19103 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19104 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19106 ;; Babel keys
19107 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19108 (mapc (lambda (pair)
19109 (define-key org-babel-map (car pair) (cdr pair)))
19110 org-babel-key-bindings)
19112 ;;; Extra keys for tty access.
19113 ;; We only set them when really needed because otherwise the
19114 ;; menus don't show the simple keys
19116 (when (or org-use-extra-keys
19117 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19118 (not window-system))
19119 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19120 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19121 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19122 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19123 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19124 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19125 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19126 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19127 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19128 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19129 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19130 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19131 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19132 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19133 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19134 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19135 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19136 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19137 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19138 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19139 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19140 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19141 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19142 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19143 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19144 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19145 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19146 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19148 ;; All the other keys
19150 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19151 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19152 (if (boundp 'narrow-map)
19153 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19154 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19155 (if (boundp 'narrow-map)
19156 (org-defkey narrow-map "b" 'org-narrow-to-block)
19157 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19158 (if (boundp 'narrow-map)
19159 (org-defkey narrow-map "e" 'org-narrow-to-element)
19160 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19161 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19162 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19163 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19164 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19165 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19166 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19167 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19168 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19169 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19170 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19171 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19172 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19173 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19174 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19175 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19176 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19177 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19178 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19179 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19180 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19181 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19182 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19183 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19184 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19185 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19186 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19187 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19188 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19189 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19190 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19191 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19192 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19193 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19194 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19195 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19196 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19197 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19198 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19199 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19200 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19201 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19202 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19203 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19204 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19205 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19206 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19207 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19208 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19209 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19210 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19211 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19212 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19213 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19214 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19215 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19216 (org-defkey org-mode-map "\C-c^" 'org-sort)
19217 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19218 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19219 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19220 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19221 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19222 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19223 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19224 (org-defkey org-mode-map "\C-m" 'org-return)
19225 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19226 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19227 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19228 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19229 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19230 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19231 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19232 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19233 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19234 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19235 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19236 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19237 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19238 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19239 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19240 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19241 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19242 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19243 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19244 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19245 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19246 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19247 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19249 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19250 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19251 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19253 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19254 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19255 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19256 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19257 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19258 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19259 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19260 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19261 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19262 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19263 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19264 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19265 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19266 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19267 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19268 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19269 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19270 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19271 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19272 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19273 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19274 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19275 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19277 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19278 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19279 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19280 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19281 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19283 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19285 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19287 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19288 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19290 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19293 (when (featurep 'xemacs)
19294 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19297 (defconst org-speed-commands-default
19299 ("Outline Navigation")
19300 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19301 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19302 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19303 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19304 ("F" . org-next-block)
19305 ("B" . org-previous-block)
19306 ("u" . (org-speed-move-safe 'outline-up-heading))
19307 ("j" . org-goto)
19308 ("g" . (org-refile t))
19309 ("Outline Visibility")
19310 ("c" . org-cycle)
19311 ("C" . org-shifttab)
19312 (" " . org-display-outline-path)
19313 ("s" . org-narrow-to-subtree)
19314 ("=" . org-columns)
19315 ("Outline Structure Editing")
19316 ("U" . org-shiftmetaup)
19317 ("D" . org-shiftmetadown)
19318 ("r" . org-metaright)
19319 ("l" . org-metaleft)
19320 ("R" . org-shiftmetaright)
19321 ("L" . org-shiftmetaleft)
19322 ("i" . (progn (forward-char 1) (call-interactively
19323 'org-insert-heading-respect-content)))
19324 ("^" . org-sort)
19325 ("w" . org-refile)
19326 ("a" . org-archive-subtree-default-with-confirmation)
19327 ("@" . org-mark-subtree)
19328 ("#" . org-toggle-comment)
19329 ("Clock Commands")
19330 ("I" . org-clock-in)
19331 ("O" . org-clock-out)
19332 ("Meta Data Editing")
19333 ("t" . org-todo)
19334 ("," . (org-priority))
19335 ("0" . (org-priority ?\ ))
19336 ("1" . (org-priority ?A))
19337 ("2" . (org-priority ?B))
19338 ("3" . (org-priority ?C))
19339 (":" . org-set-tags-command)
19340 ("e" . org-set-effort)
19341 ("E" . org-inc-effort)
19342 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19343 (org-entry-put (point) "APPT_WARNTIME" m)))
19344 ("Agenda Views etc")
19345 ("v" . org-agenda)
19346 ("/" . org-sparse-tree)
19347 ("Misc")
19348 ("o" . org-open-at-point)
19349 ("?" . org-speed-command-help)
19350 ("<" . (org-agenda-set-restriction-lock 'subtree))
19351 (">" . (org-agenda-remove-restriction-lock))
19353 "The default speed commands.")
19355 (defun org-print-speed-command (e)
19356 (if (> (length (car e)) 1)
19357 (progn
19358 (princ "\n")
19359 (princ (car e))
19360 (princ "\n")
19361 (princ (make-string (length (car e)) ?-))
19362 (princ "\n"))
19363 (princ (car e))
19364 (princ " ")
19365 (if (symbolp (cdr e))
19366 (princ (symbol-name (cdr e)))
19367 (prin1 (cdr e)))
19368 (princ "\n")))
19370 (defun org-speed-command-help ()
19371 "Show the available speed commands."
19372 (interactive)
19373 (if (not org-use-speed-commands)
19374 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19375 (with-output-to-temp-buffer "*Help*"
19376 (princ "User-defined Speed commands\n===========================\n")
19377 (mapc 'org-print-speed-command org-speed-commands-user)
19378 (princ "\n")
19379 (princ "Built-in Speed commands\n=======================\n")
19380 (mapc 'org-print-speed-command org-speed-commands-default))
19381 (with-current-buffer "*Help*"
19382 (setq truncate-lines t))))
19384 (defun org-speed-move-safe (cmd)
19385 "Execute CMD, but make sure that the cursor always ends up in a headline.
19386 If not, return to the original position and throw an error."
19387 (interactive)
19388 (let ((pos (point)))
19389 (call-interactively cmd)
19390 (unless (and (bolp) (org-at-heading-p))
19391 (goto-char pos)
19392 (error "Boundary reached while executing %s" cmd))))
19394 (defvar org-self-insert-command-undo-counter 0)
19396 (defvar org-table-auto-blank-field) ; defined in org-table.el
19397 (defvar org-speed-command nil)
19399 (define-obsolete-function-alias
19400 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19402 (defun org-speed-command-activate (keys)
19403 "Hook for activating single-letter speed commands.
19404 `org-speed-commands-default' specifies a minimal command set.
19405 Use `org-speed-commands-user' for further customization."
19406 (when (or (and (bolp) (looking-at org-outline-regexp))
19407 (and (functionp org-use-speed-commands)
19408 (funcall org-use-speed-commands)))
19409 (cdr (assoc keys (append org-speed-commands-user
19410 org-speed-commands-default)))))
19412 (define-obsolete-function-alias
19413 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19415 (defun org-babel-speed-command-activate (keys)
19416 "Hook for activating single-letter code block commands."
19417 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19418 (cdr (assoc keys org-babel-key-bindings))))
19420 (defcustom org-speed-command-hook
19421 '(org-speed-command-default-hook org-babel-speed-command-hook)
19422 "Hook for activating speed commands at strategic locations.
19423 Hook functions are called in sequence until a valid handler is
19424 found.
19426 Each hook takes a single argument, a user-pressed command key
19427 which is also a `self-insert-command' from the global map.
19429 Within the hook, examine the cursor position and the command key
19430 and return nil or a valid handler as appropriate. Handler could
19431 be one of an interactive command, a function, or a form.
19433 Set `org-use-speed-commands' to non-nil value to enable this
19434 hook. The default setting is `org-speed-command-activate'."
19435 :group 'org-structure
19436 :version "24.1"
19437 :type 'hook)
19439 (defun org-self-insert-command (N)
19440 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19441 If the cursor is in a table looking at whitespace, the whitespace is
19442 overwritten, and the table is not marked as requiring realignment."
19443 (interactive "p")
19444 (org-check-before-invisible-edit 'insert)
19445 (cond
19446 ((and org-use-speed-commands
19447 (setq org-speed-command
19448 (run-hook-with-args-until-success
19449 'org-speed-command-hook (this-command-keys))))
19450 (cond
19451 ((commandp org-speed-command)
19452 (setq this-command org-speed-command)
19453 (call-interactively org-speed-command))
19454 ((functionp org-speed-command)
19455 (funcall org-speed-command))
19456 ((and org-speed-command (listp org-speed-command))
19457 (eval org-speed-command))
19458 (t (let (org-use-speed-commands)
19459 (call-interactively 'org-self-insert-command)))))
19460 ((and
19461 (org-table-p)
19462 (progn
19463 ;; check if we blank the field, and if that triggers align
19464 (and (featurep 'org-table) org-table-auto-blank-field
19465 (member last-command
19466 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19467 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19468 ;; got extra space, this field does not determine column width
19469 (let (org-table-may-need-update) (org-table-blank-field))
19470 ;; no extra space, this field may determine column width
19471 (org-table-blank-field)))
19473 (eq N 1)
19474 (looking-at "[^|\n]* |"))
19475 (let (org-table-may-need-update)
19476 (goto-char (1- (match-end 0)))
19477 (backward-delete-char 1)
19478 (goto-char (match-beginning 0))
19479 (self-insert-command N)))
19481 (setq org-table-may-need-update t)
19482 (self-insert-command N)
19483 (org-fix-tags-on-the-fly)
19484 (if org-self-insert-cluster-for-undo
19485 (if (not (eq last-command 'org-self-insert-command))
19486 (setq org-self-insert-command-undo-counter 1)
19487 (if (>= org-self-insert-command-undo-counter 20)
19488 (setq org-self-insert-command-undo-counter 1)
19489 (and (> org-self-insert-command-undo-counter 0)
19490 buffer-undo-list (listp buffer-undo-list)
19491 (not (cadr buffer-undo-list)) ; remove nil entry
19492 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19493 (setq org-self-insert-command-undo-counter
19494 (1+ org-self-insert-command-undo-counter))))))))
19496 (defun org-check-before-invisible-edit (kind)
19497 "Check is editing if kind KIND would be dangerous with invisible text around.
19498 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19499 ;; First, try to get out of here as quickly as possible, to reduce overhead
19500 (if (and org-catch-invisible-edits
19501 (or (not (boundp 'visible-mode)) (not visible-mode))
19502 (or (get-char-property (point) 'invisible)
19503 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19504 ;; OK, we need to take a closer look
19505 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19506 (invisible-before-point (if (bobp) nil (get-char-property
19507 (1- (point)) 'invisible)))
19508 (border-and-ok-direction
19510 ;; Check if we are acting predictably before invisible text
19511 (and invisible-at-point (not invisible-before-point)
19512 (memq kind '(insert delete-backward)))
19513 ;; Check if we are acting predictably after invisible text
19514 ;; This works not well, and I have turned it off. It seems
19515 ;; better to always show and stop after invisible text.
19516 ;; (and (not invisible-at-point) invisible-before-point
19517 ;; (memq kind '(insert delete)))
19519 (when (or (memq invisible-at-point '(outline org-hide-block t))
19520 (memq invisible-before-point '(outline org-hide-block t)))
19521 (if (eq org-catch-invisible-edits 'error)
19522 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19523 (if (and org-custom-properties-overlays
19524 (y-or-n-p "Display invisible properties in this buffer? "))
19525 (org-toggle-custom-properties-visibility)
19526 ;; Make the area visible
19527 (save-excursion
19528 (if invisible-before-point
19529 (goto-char (previous-single-char-property-change
19530 (point) 'invisible)))
19531 (org-cycle))
19532 (cond
19533 ((eq org-catch-invisible-edits 'show)
19534 ;; That's it, we do the edit after showing
19535 (message
19536 "Unfolding invisible region around point before editing")
19537 (sit-for 1))
19538 ((and (eq org-catch-invisible-edits 'smart)
19539 border-and-ok-direction)
19540 (message "Unfolding invisible region around point before editing"))
19542 ;; Don't do the edit, make the user repeat it in full visibility
19543 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19545 (defun org-fix-tags-on-the-fly ()
19546 (when (and (equal (char-after (point-at-bol)) ?*)
19547 (org-at-heading-p))
19548 (org-align-tags-here org-tags-column)))
19550 (defun org-delete-backward-char (N)
19551 "Like `delete-backward-char', insert whitespace at field end in tables.
19552 When deleting backwards, in tables this function will insert whitespace in
19553 front of the next \"|\" separator, to keep the table aligned. The table will
19554 still be marked for re-alignment if the field did fill the entire column,
19555 because, in this case the deletion might narrow the column."
19556 (interactive "p")
19557 (save-match-data
19558 (org-check-before-invisible-edit 'delete-backward)
19559 (if (and (org-table-p)
19560 (eq N 1)
19561 (string-match "|" (buffer-substring (point-at-bol) (point)))
19562 (looking-at ".*?|"))
19563 (let ((pos (point))
19564 (noalign (looking-at "[^|\n\r]* |"))
19565 (c org-table-may-need-update))
19566 (backward-delete-char N)
19567 (if (not overwrite-mode)
19568 (progn
19569 (skip-chars-forward "^|")
19570 (insert " ")
19571 (goto-char (1- pos))))
19572 ;; noalign: if there were two spaces at the end, this field
19573 ;; does not determine the width of the column.
19574 (if noalign (setq org-table-may-need-update c)))
19575 (backward-delete-char N)
19576 (org-fix-tags-on-the-fly))))
19578 (defun org-delete-char (N)
19579 "Like `delete-char', but insert whitespace at field end in tables.
19580 When deleting characters, in tables this function will insert whitespace in
19581 front of the next \"|\" separator, to keep the table aligned. The table will
19582 still be marked for re-alignment if the field did fill the entire column,
19583 because, in this case the deletion might narrow the column."
19584 (interactive "p")
19585 (save-match-data
19586 (org-check-before-invisible-edit 'delete)
19587 (if (and (org-table-p)
19588 (not (bolp))
19589 (not (= (char-after) ?|))
19590 (eq N 1))
19591 (if (looking-at ".*?|")
19592 (let ((pos (point))
19593 (noalign (looking-at "[^|\n\r]* |"))
19594 (c org-table-may-need-update))
19595 (replace-match
19596 (concat (substring (match-string 0) 1 -1) " |") nil t)
19597 (goto-char pos)
19598 ;; noalign: if there were two spaces at the end, this field
19599 ;; does not determine the width of the column.
19600 (if noalign (setq org-table-may-need-update c)))
19601 (delete-char N))
19602 (delete-char N)
19603 (org-fix-tags-on-the-fly))))
19605 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19606 (put 'org-self-insert-command 'delete-selection
19607 (lambda ()
19608 (not (run-hook-with-args-until-success
19609 'self-insert-uses-region-functions))))
19610 (put 'orgtbl-self-insert-command 'delete-selection
19611 (lambda ()
19612 (not (run-hook-with-args-until-success
19613 'self-insert-uses-region-functions))))
19614 (put 'org-delete-char 'delete-selection 'supersede)
19615 (put 'org-delete-backward-char 'delete-selection 'supersede)
19616 (put 'org-yank 'delete-selection 'yank)
19618 ;; Make `flyspell-mode' delay after some commands
19619 (put 'org-self-insert-command 'flyspell-delayed t)
19620 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19621 (put 'org-delete-char 'flyspell-delayed t)
19622 (put 'org-delete-backward-char 'flyspell-delayed t)
19624 ;; Make pabbrev-mode expand after org-mode commands
19625 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19626 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19628 (defun org-remap (map &rest commands)
19629 "In MAP, remap the functions given in COMMANDS.
19630 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19631 (let (new old)
19632 (while commands
19633 (setq old (pop commands) new (pop commands))
19634 (if (fboundp 'command-remapping)
19635 (org-defkey map (vector 'remap old) new)
19636 (substitute-key-definition old new map global-map)))))
19638 (defun org-transpose-words ()
19639 "Transpose words for Org.
19640 This uses the `org-mode-transpose-word-syntax-table' syntax
19641 table, which interprets characters in `org-emphasis-alist' as
19642 word constituents."
19643 (interactive)
19644 (with-syntax-table org-mode-transpose-word-syntax-table
19645 (call-interactively 'transpose-words)))
19646 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19648 (when (eq org-enable-table-editor 'optimized)
19649 ;; If the user wants maximum table support, we need to hijack
19650 ;; some standard editing functions
19651 (org-remap org-mode-map
19652 'self-insert-command 'org-self-insert-command
19653 'delete-char 'org-delete-char
19654 'delete-backward-char 'org-delete-backward-char)
19655 (org-defkey org-mode-map "|" 'org-force-self-insert))
19657 (defvar org-ctrl-c-ctrl-c-hook nil
19658 "Hook for functions attaching themselves to `C-c C-c'.
19660 This can be used to add additional functionality to the C-c C-c
19661 key which executes context-dependent commands. This hook is run
19662 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19663 run after the last test.
19665 Each function will be called with no arguments. The function
19666 must check if the context is appropriate for it to act. If yes,
19667 it should do its thing and then return a non-nil value. If the
19668 context is wrong, just do nothing and return nil.")
19670 (defvar org-ctrl-c-ctrl-c-final-hook nil
19671 "Hook for functions attaching themselves to `C-c C-c'.
19673 This can be used to add additional functionality to the C-c C-c
19674 key which executes context-dependent commands. This hook is run
19675 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19676 before the first test.
19678 Each function will be called with no arguments. The function
19679 must check if the context is appropriate for it to act. If yes,
19680 it should do its thing and then return a non-nil value. If the
19681 context is wrong, just do nothing and return nil.")
19683 (defvar org-tab-first-hook nil
19684 "Hook for functions to attach themselves to TAB.
19685 See `org-ctrl-c-ctrl-c-hook' for more information.
19686 This hook runs as the first action when TAB is pressed, even before
19687 `org-cycle' messes around with the `outline-regexp' to cater for
19688 inline tasks and plain list item folding.
19689 If any function in this hook returns t, any other actions that
19690 would have been caused by TAB (such as table field motion or visibility
19691 cycling) will not occur.")
19693 (defvar org-tab-after-check-for-table-hook nil
19694 "Hook for functions to attach themselves to TAB.
19695 See `org-ctrl-c-ctrl-c-hook' for more information.
19696 This hook runs after it has been established that the cursor is not in a
19697 table, but before checking if the cursor is in a headline or if global cycling
19698 should be done.
19699 If any function in this hook returns t, not other actions like visibility
19700 cycling will be done.")
19702 (defvar org-tab-after-check-for-cycling-hook nil
19703 "Hook for functions to attach themselves to TAB.
19704 See `org-ctrl-c-ctrl-c-hook' for more information.
19705 This hook runs after it has been established that not table field motion and
19706 not visibility should be done because of current context. This is probably
19707 the place where a package like yasnippets can hook in.")
19709 (defvar org-tab-before-tab-emulation-hook nil
19710 "Hook for functions to attach themselves to TAB.
19711 See `org-ctrl-c-ctrl-c-hook' for more information.
19712 This hook runs after every other options for TAB have been exhausted, but
19713 before indentation and \t insertion takes place.")
19715 (defvar org-metaleft-hook nil
19716 "Hook for functions attaching themselves to `M-left'.
19717 See `org-ctrl-c-ctrl-c-hook' for more information.")
19718 (defvar org-metaright-hook nil
19719 "Hook for functions attaching themselves to `M-right'.
19720 See `org-ctrl-c-ctrl-c-hook' for more information.")
19721 (defvar org-metaup-hook nil
19722 "Hook for functions attaching themselves to `M-up'.
19723 See `org-ctrl-c-ctrl-c-hook' for more information.")
19724 (defvar org-metadown-hook nil
19725 "Hook for functions attaching themselves to `M-down'.
19726 See `org-ctrl-c-ctrl-c-hook' for more information.")
19727 (defvar org-shiftmetaleft-hook nil
19728 "Hook for functions attaching themselves to `M-S-left'.
19729 See `org-ctrl-c-ctrl-c-hook' for more information.")
19730 (defvar org-shiftmetaright-hook nil
19731 "Hook for functions attaching themselves to `M-S-right'.
19732 See `org-ctrl-c-ctrl-c-hook' for more information.")
19733 (defvar org-shiftmetaup-hook nil
19734 "Hook for functions attaching themselves to `M-S-up'.
19735 See `org-ctrl-c-ctrl-c-hook' for more information.")
19736 (defvar org-shiftmetadown-hook nil
19737 "Hook for functions attaching themselves to `M-S-down'.
19738 See `org-ctrl-c-ctrl-c-hook' for more information.")
19739 (defvar org-metareturn-hook nil
19740 "Hook for functions attaching themselves to `M-RET'.
19741 See `org-ctrl-c-ctrl-c-hook' for more information.")
19742 (defvar org-shiftup-hook nil
19743 "Hook for functions attaching themselves to `S-up'.
19744 See `org-ctrl-c-ctrl-c-hook' for more information.")
19745 (defvar org-shiftup-final-hook nil
19746 "Hook for functions attaching themselves to `S-up'.
19747 This one runs after all other options except shift-select have been excluded.
19748 See `org-ctrl-c-ctrl-c-hook' for more information.")
19749 (defvar org-shiftdown-hook nil
19750 "Hook for functions attaching themselves to `S-down'.
19751 See `org-ctrl-c-ctrl-c-hook' for more information.")
19752 (defvar org-shiftdown-final-hook nil
19753 "Hook for functions attaching themselves to `S-down'.
19754 This one runs after all other options except shift-select have been excluded.
19755 See `org-ctrl-c-ctrl-c-hook' for more information.")
19756 (defvar org-shiftleft-hook nil
19757 "Hook for functions attaching themselves to `S-left'.
19758 See `org-ctrl-c-ctrl-c-hook' for more information.")
19759 (defvar org-shiftleft-final-hook nil
19760 "Hook for functions attaching themselves to `S-left'.
19761 This one runs after all other options except shift-select have been excluded.
19762 See `org-ctrl-c-ctrl-c-hook' for more information.")
19763 (defvar org-shiftright-hook nil
19764 "Hook for functions attaching themselves to `S-right'.
19765 See `org-ctrl-c-ctrl-c-hook' for more information.")
19766 (defvar org-shiftright-final-hook nil
19767 "Hook for functions attaching themselves to `S-right'.
19768 This one runs after all other options except shift-select have been excluded.
19769 See `org-ctrl-c-ctrl-c-hook' for more information.")
19771 (defun org-modifier-cursor-error ()
19772 "Throw an error, a modified cursor command was applied in wrong context."
19773 (user-error "This command is active in special context like tables, headlines or items"))
19775 (defun org-shiftselect-error ()
19776 "Throw an error because Shift-Cursor command was applied in wrong context."
19777 (if (and (boundp 'shift-select-mode) shift-select-mode)
19778 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19779 (user-error "This command works only in special context like headlines or timestamps")))
19781 (defun org-call-for-shift-select (cmd)
19782 (let ((this-command-keys-shift-translated t))
19783 (call-interactively cmd)))
19785 (defun org-shifttab (&optional arg)
19786 "Global visibility cycling or move to previous table field.
19787 Call `org-table-previous-field' within a table.
19788 When ARG is nil, cycle globally through visibility states.
19789 When ARG is a numeric prefix, show contents of this level."
19790 (interactive "P")
19791 (cond
19792 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19793 ((integerp arg)
19794 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19795 (message "Content view to level: %d" arg)
19796 (org-content (prefix-numeric-value arg2))
19797 (org-cycle-show-empty-lines t)
19798 (setq org-cycle-global-status 'overview)))
19799 (t (call-interactively 'org-global-cycle))))
19801 (defun org-shiftmetaleft ()
19802 "Promote subtree or delete table column.
19803 Calls `org-promote-subtree', `org-outdent-item-tree', or
19804 `org-table-delete-column', depending on context. See the
19805 individual commands for more information."
19806 (interactive)
19807 (cond
19808 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19809 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19810 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19811 ((if (not (org-region-active-p)) (org-at-item-p)
19812 (save-excursion (goto-char (region-beginning))
19813 (org-at-item-p)))
19814 (call-interactively 'org-outdent-item-tree))
19815 (t (org-modifier-cursor-error))))
19817 (defun org-shiftmetaright ()
19818 "Demote subtree or insert table column.
19819 Calls `org-demote-subtree', `org-indent-item-tree', or
19820 `org-table-insert-column', depending on context. See the
19821 individual commands for more information."
19822 (interactive)
19823 (cond
19824 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19825 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19826 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19827 ((if (not (org-region-active-p)) (org-at-item-p)
19828 (save-excursion (goto-char (region-beginning))
19829 (org-at-item-p)))
19830 (call-interactively 'org-indent-item-tree))
19831 (t (org-modifier-cursor-error))))
19833 (defun org-shiftmetaup (&optional arg)
19834 "Move subtree up or kill table row.
19835 Calls `org-move-subtree-up' or `org-table-kill-row' or
19836 `org-move-item-up' or `org-timestamp-up', depending on context.
19837 See the individual commands for more information."
19838 (interactive "P")
19839 (cond
19840 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19841 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19842 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19843 ((org-at-item-p) (call-interactively 'org-move-item-up))
19844 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19845 (call-interactively 'org-timestamp-up)))
19846 (t (call-interactively 'org-drag-line-backward))))
19848 (defun org-shiftmetadown (&optional arg)
19849 "Move subtree down or insert table row.
19850 Calls `org-move-subtree-down' or `org-table-insert-row' or
19851 `org-move-item-down' or `org-timestamp-up', depending on context.
19852 See the individual commands for more information."
19853 (interactive "P")
19854 (cond
19855 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19856 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19857 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19858 ((org-at-item-p) (call-interactively 'org-move-item-down))
19859 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19860 (call-interactively 'org-timestamp-down)))
19861 (t (call-interactively 'org-drag-line-forward))))
19863 (defsubst org-hidden-tree-error ()
19864 (user-error
19865 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19867 (defun org-metaleft (&optional arg)
19868 "Promote heading or move table column to left.
19869 Calls `org-do-promote' or `org-table-move-column', depending on context.
19870 With no specific context, calls the Emacs default `backward-word'.
19871 See the individual commands for more information."
19872 (interactive "P")
19873 (cond
19874 ((run-hook-with-args-until-success 'org-metaleft-hook))
19875 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19876 ((org-with-limited-levels
19877 (or (org-at-heading-p)
19878 (and (org-region-active-p)
19879 (save-excursion
19880 (goto-char (region-beginning))
19881 (org-at-heading-p)))))
19882 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19883 (call-interactively 'org-do-promote))
19884 ;; At an inline task.
19885 ((org-at-heading-p)
19886 (call-interactively 'org-inlinetask-promote))
19887 ((or (org-at-item-p)
19888 (and (org-region-active-p)
19889 (save-excursion
19890 (goto-char (region-beginning))
19891 (org-at-item-p))))
19892 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19893 (call-interactively 'org-outdent-item))
19894 (t (call-interactively 'backward-word))))
19896 (defun org-metaright (&optional arg)
19897 "Demote a subtree, a list item or move table column to right.
19898 In front of a drawer or a block keyword, indent it correctly.
19899 With no specific context, calls the Emacs default `forward-word'.
19900 See the individual commands for more information."
19901 (interactive "P")
19902 (cond
19903 ((run-hook-with-args-until-success 'org-metaright-hook))
19904 ((org-at-table-p) (call-interactively 'org-table-move-column))
19905 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19906 ((org-at-block-p) (call-interactively 'org-indent-block))
19907 ((org-with-limited-levels
19908 (or (org-at-heading-p)
19909 (and (org-region-active-p)
19910 (save-excursion
19911 (goto-char (region-beginning))
19912 (org-at-heading-p)))))
19913 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19914 (call-interactively 'org-do-demote))
19915 ;; At an inline task.
19916 ((org-at-heading-p)
19917 (call-interactively 'org-inlinetask-demote))
19918 ((or (org-at-item-p)
19919 (and (org-region-active-p)
19920 (save-excursion
19921 (goto-char (region-beginning))
19922 (org-at-item-p))))
19923 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19924 (call-interactively 'org-indent-item))
19925 (t (call-interactively 'forward-word))))
19927 (defun org-check-for-hidden (what)
19928 "Check if there are hidden headlines/items in the current visual line.
19929 WHAT can be either `headlines' or `items'. If the current line is
19930 an outline or item heading and it has a folded subtree below it,
19931 this function returns t, nil otherwise."
19932 (let ((re (cond
19933 ((eq what 'headlines) org-outline-regexp-bol)
19934 ((eq what 'items) (org-item-beginning-re))
19935 (t (error "This should not happen"))))
19936 beg end)
19937 (save-excursion
19938 (catch 'exit
19939 (unless (org-region-active-p)
19940 (setq beg (point-at-bol))
19941 (beginning-of-line 2)
19942 (while (and (not (eobp)) ;; this is like `next-line'
19943 (get-char-property (1- (point)) 'invisible))
19944 (beginning-of-line 2))
19945 (setq end (point))
19946 (goto-char beg)
19947 (goto-char (point-at-eol))
19948 (setq end (max end (point)))
19949 (while (re-search-forward re end t)
19950 (if (get-char-property (match-beginning 0) 'invisible)
19951 (throw 'exit t))))
19952 nil))))
19954 (defun org-metaup (&optional arg)
19955 "Move subtree up or move table row up.
19956 Calls `org-move-subtree-up' or `org-table-move-row' or
19957 `org-move-item-up', depending on context. See the individual commands
19958 for more information."
19959 (interactive "P")
19960 (cond
19961 ((run-hook-with-args-until-success 'org-metaup-hook))
19962 ((org-region-active-p)
19963 (let* ((a (min (region-beginning) (region-end)))
19964 (b (1- (max (region-beginning) (region-end))))
19965 (c (save-excursion (goto-char a)
19966 (move-beginning-of-line 0)))
19967 (d (save-excursion (goto-char a)
19968 (move-end-of-line 0) (point))))
19969 (transpose-regions a b c d)
19970 (goto-char c)))
19971 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19972 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19973 ((org-at-item-p) (call-interactively 'org-move-item-up))
19974 (t (org-drag-element-backward))))
19976 (defun org-metadown (&optional arg)
19977 "Move subtree down or move table row down.
19978 Calls `org-move-subtree-down' or `org-table-move-row' or
19979 `org-move-item-down', depending on context. See the individual
19980 commands for more information."
19981 (interactive "P")
19982 (cond
19983 ((run-hook-with-args-until-success 'org-metadown-hook))
19984 ((org-region-active-p)
19985 (let* ((a (min (region-beginning) (region-end)))
19986 (b (max (region-beginning) (region-end)))
19987 (c (save-excursion (goto-char b)
19988 (move-beginning-of-line 1)))
19989 (d (save-excursion (goto-char b)
19990 (move-end-of-line 1) (1+ (point)))))
19991 (transpose-regions a b c d)
19992 (goto-char d)))
19993 ((org-at-table-p) (call-interactively 'org-table-move-row))
19994 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19995 ((org-at-item-p) (call-interactively 'org-move-item-down))
19996 (t (org-drag-element-forward))))
19998 (defun org-shiftup (&optional arg)
19999 "Increase item in timestamp or increase priority of current headline.
20000 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20001 depending on context. See the individual commands for more information."
20002 (interactive "P")
20003 (cond
20004 ((run-hook-with-args-until-success 'org-shiftup-hook))
20005 ((and org-support-shift-select (org-region-active-p))
20006 (org-call-for-shift-select 'previous-line))
20007 ((org-at-timestamp-p t)
20008 (call-interactively (if org-edit-timestamp-down-means-later
20009 'org-timestamp-down 'org-timestamp-up)))
20010 ((and (not (eq org-support-shift-select 'always))
20011 org-enable-priority-commands
20012 (org-at-heading-p))
20013 (call-interactively 'org-priority-up))
20014 ((and (not org-support-shift-select) (org-at-item-p))
20015 (call-interactively 'org-previous-item))
20016 ((org-clocktable-try-shift 'up arg))
20017 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20018 (org-support-shift-select
20019 (org-call-for-shift-select 'previous-line))
20020 (t (org-shiftselect-error))))
20022 (defun org-shiftdown (&optional arg)
20023 "Decrease item in timestamp or decrease priority of current headline.
20024 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20025 depending on context. See the individual commands for more information."
20026 (interactive "P")
20027 (cond
20028 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20029 ((and org-support-shift-select (org-region-active-p))
20030 (org-call-for-shift-select 'next-line))
20031 ((org-at-timestamp-p t)
20032 (call-interactively (if org-edit-timestamp-down-means-later
20033 'org-timestamp-up 'org-timestamp-down)))
20034 ((and (not (eq org-support-shift-select 'always))
20035 org-enable-priority-commands
20036 (org-at-heading-p))
20037 (call-interactively 'org-priority-down))
20038 ((and (not org-support-shift-select) (org-at-item-p))
20039 (call-interactively 'org-next-item))
20040 ((org-clocktable-try-shift 'down arg))
20041 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20042 (org-support-shift-select
20043 (org-call-for-shift-select 'next-line))
20044 (t (org-shiftselect-error))))
20046 (defun org-shiftright (&optional arg)
20047 "Cycle the thing at point or in the current line, depending on context.
20048 Depending on context, this does one of the following:
20050 - switch a timestamp at point one day into the future
20051 - on a headline, switch to the next TODO keyword.
20052 - on an item, switch entire list to the next bullet type
20053 - on a property line, switch to the next allowed value
20054 - on a clocktable definition line, move time block into the future"
20055 (interactive "P")
20056 (cond
20057 ((run-hook-with-args-until-success 'org-shiftright-hook))
20058 ((and org-support-shift-select (org-region-active-p))
20059 (org-call-for-shift-select 'forward-char))
20060 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20061 ((and (not (eq org-support-shift-select 'always))
20062 (org-at-heading-p))
20063 (let ((org-inhibit-logging
20064 (not org-treat-S-cursor-todo-selection-as-state-change))
20065 (org-inhibit-blocking
20066 (not org-treat-S-cursor-todo-selection-as-state-change)))
20067 (org-call-with-arg 'org-todo 'right)))
20068 ((or (and org-support-shift-select
20069 (not (eq org-support-shift-select 'always))
20070 (org-at-item-bullet-p))
20071 (and (not org-support-shift-select) (org-at-item-p)))
20072 (org-call-with-arg 'org-cycle-list-bullet nil))
20073 ((and (not (eq org-support-shift-select 'always))
20074 (org-at-property-p))
20075 (call-interactively 'org-property-next-allowed-value))
20076 ((org-clocktable-try-shift 'right arg))
20077 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20078 (org-support-shift-select
20079 (org-call-for-shift-select 'forward-char))
20080 (t (org-shiftselect-error))))
20082 (defun org-shiftleft (&optional arg)
20083 "Cycle the thing at point or in the current line, depending on context.
20084 Depending on context, this does one of the following:
20086 - switch a timestamp at point one day into the past
20087 - on a headline, switch to the previous TODO keyword.
20088 - on an item, switch entire list to the previous bullet type
20089 - on a property line, switch to the previous allowed value
20090 - on a clocktable definition line, move time block into the past"
20091 (interactive "P")
20092 (cond
20093 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20094 ((and org-support-shift-select (org-region-active-p))
20095 (org-call-for-shift-select 'backward-char))
20096 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20097 ((and (not (eq org-support-shift-select 'always))
20098 (org-at-heading-p))
20099 (let ((org-inhibit-logging
20100 (not org-treat-S-cursor-todo-selection-as-state-change))
20101 (org-inhibit-blocking
20102 (not org-treat-S-cursor-todo-selection-as-state-change)))
20103 (org-call-with-arg 'org-todo 'left)))
20104 ((or (and org-support-shift-select
20105 (not (eq org-support-shift-select 'always))
20106 (org-at-item-bullet-p))
20107 (and (not org-support-shift-select) (org-at-item-p)))
20108 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20109 ((and (not (eq org-support-shift-select 'always))
20110 (org-at-property-p))
20111 (call-interactively 'org-property-previous-allowed-value))
20112 ((org-clocktable-try-shift 'left arg))
20113 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20114 (org-support-shift-select
20115 (org-call-for-shift-select 'backward-char))
20116 (t (org-shiftselect-error))))
20118 (defun org-shiftcontrolright ()
20119 "Switch to next TODO set."
20120 (interactive)
20121 (cond
20122 ((and org-support-shift-select (org-region-active-p))
20123 (org-call-for-shift-select 'forward-word))
20124 ((and (not (eq org-support-shift-select 'always))
20125 (org-at-heading-p))
20126 (org-call-with-arg 'org-todo 'nextset))
20127 (org-support-shift-select
20128 (org-call-for-shift-select 'forward-word))
20129 (t (org-shiftselect-error))))
20131 (defun org-shiftcontrolleft ()
20132 "Switch to previous TODO set."
20133 (interactive)
20134 (cond
20135 ((and org-support-shift-select (org-region-active-p))
20136 (org-call-for-shift-select 'backward-word))
20137 ((and (not (eq org-support-shift-select 'always))
20138 (org-at-heading-p))
20139 (org-call-with-arg 'org-todo 'previousset))
20140 (org-support-shift-select
20141 (org-call-for-shift-select 'backward-word))
20142 (t (org-shiftselect-error))))
20144 (defun org-shiftcontrolup (&optional n)
20145 "Change timestamps synchronously up in CLOCK log lines.
20146 Optional argument N tells to change by that many units."
20147 (interactive "P")
20148 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20149 (let (org-support-shift-select)
20150 (org-clock-timestamps-up n))
20151 (user-error "Not at a clock log")))
20153 (defun org-shiftcontroldown (&optional n)
20154 "Change timestamps synchronously down in CLOCK log lines.
20155 Optional argument N tells to change by that many units."
20156 (interactive "P")
20157 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20158 (let (org-support-shift-select)
20159 (org-clock-timestamps-down n))
20160 (user-error "Not at a clock log")))
20162 (defun org-ctrl-c-ret ()
20163 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20164 (interactive)
20165 (cond
20166 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20167 (t (call-interactively 'org-insert-heading))))
20169 (defun org-find-visible ()
20170 (let ((s (point)))
20171 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20172 (get-char-property s 'invisible)))
20174 (defun org-find-invisible ()
20175 (let ((s (point)))
20176 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20177 (not (get-char-property s 'invisible))))
20180 (defun org-copy-visible (beg end)
20181 "Copy the visible parts of the region."
20182 (interactive "r")
20183 (let (snippets s)
20184 (save-excursion
20185 (save-restriction
20186 (narrow-to-region beg end)
20187 (setq s (goto-char (point-min)))
20188 (while (not (= (point) (point-max)))
20189 (goto-char (org-find-invisible))
20190 (push (buffer-substring s (point)) snippets)
20191 (setq s (goto-char (org-find-visible))))))
20192 (kill-new (apply 'concat (nreverse snippets)))))
20194 (defun org-copy-special ()
20195 "Copy region in table or copy current subtree.
20196 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20197 See the individual commands for more information."
20198 (interactive)
20199 (call-interactively
20200 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20202 (defun org-cut-special ()
20203 "Cut region in table or cut current subtree.
20204 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20205 See the individual commands for more information."
20206 (interactive)
20207 (call-interactively
20208 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20210 (defun org-paste-special (arg)
20211 "Paste rectangular region into table, or past subtree relative to level.
20212 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20213 See the individual commands for more information."
20214 (interactive "P")
20215 (if (org-at-table-p)
20216 (org-table-paste-rectangle)
20217 (org-paste-subtree arg)))
20219 (defsubst org-in-fixed-width-region-p ()
20220 "Is point in a fixed-width region?"
20221 (save-match-data
20222 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20224 (defun org-edit-special (&optional arg)
20225 "Call a special editor for the element at point.
20226 When at a table, call the formula editor with `org-table-edit-formulas'.
20227 When in a source code block, call `org-edit-src-code'.
20228 When in a fixed-width region, call `org-edit-fixed-width-region'.
20229 When at an #+INCLUDE keyword, visit the included file.
20230 On a link, call `ffap' to visit the link at point.
20231 Otherwise, return a user error."
20232 (interactive "P")
20233 (let ((element (org-element-at-point)))
20234 (assert (not buffer-read-only) nil
20235 "Buffer is read-only: %s" (buffer-name))
20236 (case (org-element-type element)
20237 (src-block
20238 (if (not arg) (org-edit-src-code)
20239 (let* ((info (org-babel-get-src-block-info))
20240 (lang (nth 0 info))
20241 (params (nth 2 info))
20242 (session (cdr (assq :session params))))
20243 (if (not session) (org-edit-src-code)
20244 ;; At a src-block with a session and function called with
20245 ;; an ARG: switch to the buffer related to the inferior
20246 ;; process.
20247 (switch-to-buffer
20248 (funcall (intern (concat "org-babel-prep-session:" lang))
20249 session params))))))
20250 (keyword
20251 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20252 (find-file-other-window
20253 (org-remove-double-quotes
20254 (car (org-split-string (org-element-property :value element)))))
20255 (user-error "No special environment to edit here")))
20256 (table
20257 (if (eq (org-element-property :type element) 'table.el)
20258 (org-edit-src-code)
20259 (call-interactively 'org-table-edit-formulas)))
20260 ;; Only Org tables contain `table-row' type elements.
20261 (table-row (call-interactively 'org-table-edit-formulas))
20262 ((example-block export-block) (org-edit-src-code))
20263 (fixed-width (org-edit-fixed-width-region))
20264 (otherwise
20265 ;; No notable element at point. Though, we may be at a link,
20266 ;; which is an object. Thus, scan deeper.
20267 (if (eq (org-element-type (org-element-context element)) 'link)
20268 (call-interactively 'ffap)
20269 (user-error "No special environment to edit here"))))))
20271 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20272 (defun org-ctrl-c-ctrl-c (&optional arg)
20273 "Set tags in headline, or update according to changed information at point.
20275 This command does many different things, depending on context:
20277 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20278 this is what we do.
20280 - If the cursor is on a statistics cookie, update it.
20282 - If the cursor is in a headline, prompt for tags and insert them
20283 into the current line, aligned to `org-tags-column'. When called
20284 with prefix arg, realign all tags in the current buffer.
20286 - If the cursor is in one of the special #+KEYWORD lines, this
20287 triggers scanning the buffer for these lines and updating the
20288 information.
20290 - If the cursor is inside a table, realign the table. This command
20291 works even if the automatic table editor has been turned off.
20293 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20294 the entire table.
20296 - If the cursor is at a footnote reference or definition, jump to
20297 the corresponding definition or references, respectively.
20299 - If the cursor is a the beginning of a dynamic block, update it.
20301 - If the current buffer is a capture buffer, close note and file it.
20303 - If the cursor is on a <<<target>>>, update radio targets and
20304 corresponding links in this buffer.
20306 - If the cursor is on a numbered item in a plain list, renumber the
20307 ordered list.
20309 - If the cursor is on a checkbox, toggle it.
20311 - If the cursor is on a code block, evaluate it. The variable
20312 `org-confirm-babel-evaluate' can be used to control prompting
20313 before code block evaluation, by default every code block
20314 evaluation requires confirmation. Code block evaluation can be
20315 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20316 (interactive "P")
20317 (cond
20318 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20319 org-occur-highlights
20320 org-latex-fragment-image-overlays)
20321 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20322 (org-remove-occur-highlights)
20323 (org-remove-latex-fragment-image-overlays)
20324 (message "Temporary highlights/overlays removed from current buffer"))
20325 ((and (local-variable-p 'org-finish-function (current-buffer))
20326 (fboundp org-finish-function))
20327 (funcall org-finish-function))
20328 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20330 (let* ((context (org-element-context)) (type (org-element-type context)))
20331 ;; Test if point is within a blank line.
20332 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20333 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20334 (user-error "C-c C-c can do nothing useful at this location"))
20335 (case type
20336 ;; When at a link, act according to the parent instead.
20337 (link (setq context (org-element-property :parent context))
20338 (setq type (org-element-type context)))
20339 ;; Unsupported object types: check parent element instead.
20340 ((bold code entity export-snippet inline-babel-call inline-src-block
20341 italic latex-fragment line-break macro strike-through subscript
20342 superscript underline verbatim)
20343 (while (and (setq context (org-element-property :parent context))
20344 (not (memq (setq type (org-element-type context))
20345 '(paragraph verse-block)))))))
20346 ;; For convenience: at the first line of a paragraph on the
20347 ;; same line as an item, apply function on that item instead.
20348 (when (eq type 'paragraph)
20349 (let ((parent (org-element-property :parent context)))
20350 (when (and (eq (org-element-type parent) 'item)
20351 (= (point-at-bol) (org-element-property :begin parent)))
20352 (setq context parent type 'item))))
20353 ;; Act according to type of element or object at point.
20354 (case type
20355 (clock (org-clock-update-time-maybe))
20356 (dynamic-block
20357 (save-excursion
20358 (goto-char (org-element-property :post-affiliated context))
20359 (org-update-dblock)))
20360 (footnote-definition
20361 (goto-char (org-element-property :post-affiliated context))
20362 (call-interactively 'org-footnote-action))
20363 (footnote-reference (call-interactively 'org-footnote-action))
20364 ((headline inlinetask)
20365 (save-excursion (goto-char (org-element-property :begin context))
20366 (call-interactively 'org-set-tags)))
20367 (item
20368 ;; At an item: a double C-u set checkbox to "[-]"
20369 ;; unconditionally, whereas a single one will toggle its
20370 ;; presence. Without an universal argument, if the item
20371 ;; has a checkbox, toggle it. Otherwise repair the list.
20372 (let* ((box (org-element-property :checkbox context))
20373 (struct (org-element-property :structure context))
20374 (old-struct (copy-tree struct))
20375 (parents (org-list-parents-alist struct))
20376 (prevs (org-list-prevs-alist struct))
20377 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20378 (org-list-set-checkbox
20379 (org-element-property :begin context) struct
20380 (cond ((equal arg '(16)) "[-]")
20381 ((and (not box) (equal arg '(4))) "[ ]")
20382 ((or (not box) (equal arg '(4))) nil)
20383 ((eq box 'on) "[ ]")
20384 (t "[X]")))
20385 ;; Mimic `org-list-write-struct' but with grabbing
20386 ;; a return value from `org-list-struct-fix-box'.
20387 (org-list-struct-fix-ind struct parents 2)
20388 (org-list-struct-fix-item-end struct)
20389 (org-list-struct-fix-bul struct prevs)
20390 (org-list-struct-fix-ind struct parents)
20391 (let ((block-item
20392 (org-list-struct-fix-box struct parents prevs orderedp)))
20393 (if (and box (equal struct old-struct))
20394 (if (equal arg '(16))
20395 (message "Checkboxes already reset")
20396 (user-error "Cannot toggle this checkbox: %s"
20397 (if (eq box 'on)
20398 "all subitems checked"
20399 "unchecked subitems")))
20400 (org-list-struct-apply-struct struct old-struct)
20401 (org-update-checkbox-count-maybe))
20402 (when block-item
20403 (message "Checkboxes were removed due to empty box at line %d"
20404 (org-current-line block-item))))))
20405 (keyword
20406 (let ((org-inhibit-startup-visibility-stuff t)
20407 (org-startup-align-all-tables nil))
20408 (when (boundp 'org-table-coordinate-overlays)
20409 (mapc 'delete-overlay org-table-coordinate-overlays)
20410 (setq org-table-coordinate-overlays nil))
20411 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20412 (message "Local setup has been refreshed"))
20413 (plain-list
20414 ;; At a plain list, with a double C-u argument, set
20415 ;; checkboxes of each item to "[-]", whereas a single one
20416 ;; will toggle their presence according to the state of the
20417 ;; first item in the list. Without an argument, repair the
20418 ;; list.
20419 (let* ((begin (org-element-property :contents-begin context))
20420 (beginm (move-marker (make-marker) begin))
20421 (struct (org-element-property :structure context))
20422 (old-struct (copy-tree struct))
20423 (first-box (save-excursion
20424 (goto-char begin)
20425 (looking-at org-list-full-item-re)
20426 (match-string-no-properties 3)))
20427 (new-box (cond ((equal arg '(16)) "[-]")
20428 ((equal arg '(4)) (unless first-box "[ ]"))
20429 ((equal first-box "[X]") "[ ]")
20430 (t "[X]"))))
20431 (cond
20432 (arg
20433 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20434 (org-list-get-all-items
20435 begin struct (org-list-prevs-alist struct))))
20436 ((and first-box (eq (point) begin))
20437 ;; For convenience, when point is at bol on the first
20438 ;; item of the list and no argument is provided, simply
20439 ;; toggle checkbox of that item, if any.
20440 (org-list-set-checkbox begin struct new-box)))
20441 (org-list-write-struct
20442 struct (org-list-parents-alist struct) old-struct)
20443 (org-update-checkbox-count-maybe)
20444 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20445 ((property-drawer node-property)
20446 (call-interactively 'org-property-action))
20447 ((radio-target target)
20448 (call-interactively 'org-update-radio-target-regexp))
20449 (statistics-cookie
20450 (call-interactively 'org-update-statistics-cookies))
20451 ((table table-cell table-row)
20452 ;; At a table, recalculate every field and align it. Also
20453 ;; send the table if necessary. If the table has
20454 ;; a `table.el' type, just give up. At a table row or
20455 ;; cell, maybe recalculate line but always align table.
20456 (if (eq (org-element-property :type context) 'table.el)
20457 (message "Use C-c ' to edit table.el tables")
20458 (let ((org-enable-table-editor t))
20459 (if (or (eq type 'table)
20460 ;; Check if point is at a TBLFM line.
20461 (and (eq type 'table-row)
20462 (= (point) (org-element-property :end context))))
20463 (save-excursion
20464 (if (org-at-TBLFM-p)
20465 (progn (require 'org-table)
20466 (org-table-calc-current-TBLFM))
20467 (goto-char (org-element-property :contents-begin context))
20468 (org-call-with-arg 'org-table-recalculate (or arg t))
20469 (orgtbl-send-table 'maybe)))
20470 (org-table-maybe-eval-formula)
20471 (cond (arg (call-interactively 'org-table-recalculate))
20472 ((org-table-maybe-recalculate-line))
20473 (t (org-table-align)))))))
20474 (timestamp (org-timestamp-change 0 'day))
20475 (otherwise
20476 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20477 (user-error
20478 "C-c C-c can do nothing useful at this location")))))))))
20480 (defun org-mode-restart ()
20481 "Restart Org-mode, to scan again for special lines.
20482 Also updates the keyword regular expressions."
20483 (interactive)
20484 ;; this will set the mode *and* set file local variables.
20485 (normal-mode)
20486 ;; but it may leave us in some unrelated mode
20487 (unless (derived-mode-p "org-mode")
20488 (org-mode))
20489 (message "Org-mode restarted"))
20491 (defun org-kill-note-or-show-branches ()
20492 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20493 (interactive)
20494 (if (not org-finish-function)
20495 (progn
20496 (hide-subtree)
20497 (call-interactively 'show-branches))
20498 (let ((org-note-abort t))
20499 (funcall org-finish-function))))
20501 (defun org-open-line (n)
20502 "Insert a new row in tables, call `open-line' elsewhere.
20503 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20504 (interactive "*p")
20505 (cond
20506 ((not org-special-ctrl-o)
20507 (open-line n))
20508 ((org-at-table-p)
20509 (org-table-insert-row))
20511 (open-line n))))
20513 (defun org-return (&optional indent)
20514 "Goto next table row or insert a newline.
20515 Calls `org-table-next-row' or `newline', depending on context.
20516 See the individual commands for more information."
20517 (interactive)
20518 (let (org-ts-what)
20519 (cond
20520 ((or (bobp) (org-in-src-block-p))
20521 (if indent (newline-and-indent) (newline)))
20522 ((org-at-table-p)
20523 (org-table-justify-field-maybe)
20524 (call-interactively 'org-table-next-row))
20525 ;; when `newline-and-indent' is called within a list, make sure
20526 ;; text moved stays inside the item.
20527 ((and (org-in-item-p) indent)
20528 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20529 (progn
20530 (save-match-data (newline))
20531 (org-indent-line-to (length (match-string 0))))
20532 (let ((ind (org-get-indentation)))
20533 (newline)
20534 (if (org-looking-back org-list-end-re)
20535 (org-indent-line)
20536 (org-indent-line-to ind)))))
20537 ((and org-return-follows-link
20538 (org-at-timestamp-p t)
20539 (not (eq org-ts-what 'after)))
20540 (org-follow-timestamp-link))
20541 ((and org-return-follows-link
20542 (let ((tprop (get-text-property (point) 'face)))
20543 (or (eq tprop 'org-link)
20544 (and (listp tprop) (memq 'org-link tprop)))))
20545 (call-interactively 'org-open-at-point))
20546 ((and (org-at-heading-p)
20547 (looking-at
20548 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20549 (org-show-entry)
20550 (end-of-line 1)
20551 (newline))
20552 (t (if indent (newline-and-indent) (newline))))))
20554 (defun org-return-indent ()
20555 "Goto next table row or insert a newline and indent.
20556 Calls `org-table-next-row' or `newline-and-indent', depending on
20557 context. See the individual commands for more information."
20558 (interactive)
20559 (org-return t))
20561 (defun org-ctrl-c-star ()
20562 "Compute table, or change heading status of lines.
20563 Calls `org-table-recalculate' or `org-toggle-heading',
20564 depending on context."
20565 (interactive)
20566 (cond
20567 ((org-at-table-p)
20568 (call-interactively 'org-table-recalculate))
20570 ;; Convert all lines in region to list items
20571 (call-interactively 'org-toggle-heading))))
20573 (defun org-ctrl-c-minus ()
20574 "Insert separator line in table or modify bullet status of line.
20575 Also turns a plain line or a region of lines into list items.
20576 Calls `org-table-insert-hline', `org-toggle-item', or
20577 `org-cycle-list-bullet', depending on context."
20578 (interactive)
20579 (cond
20580 ((org-at-table-p)
20581 (call-interactively 'org-table-insert-hline))
20582 ((org-region-active-p)
20583 (call-interactively 'org-toggle-item))
20584 ((org-in-item-p)
20585 (call-interactively 'org-cycle-list-bullet))
20587 (call-interactively 'org-toggle-item))))
20589 (defun org-toggle-item (arg)
20590 "Convert headings or normal lines to items, items to normal lines.
20591 If there is no active region, only the current line is considered.
20593 If the first non blank line in the region is a headline, convert
20594 all headlines to items, shifting text accordingly.
20596 If it is an item, convert all items to normal lines.
20598 If it is normal text, change region into a list of items.
20599 With a prefix argument ARG, change the region in a single item."
20600 (interactive "P")
20601 (let ((shift-text
20602 (function
20603 ;; Shift text in current section to IND, from point to END.
20604 ;; The function leaves point to END line.
20605 (lambda (ind end)
20606 (let ((min-i 1000) (end (copy-marker end)))
20607 ;; First determine the minimum indentation (MIN-I) of
20608 ;; the text.
20609 (save-excursion
20610 (catch 'exit
20611 (while (< (point) end)
20612 (let ((i (org-get-indentation)))
20613 (cond
20614 ;; Skip blank lines and inline tasks.
20615 ((looking-at "^[ \t]*$"))
20616 ((looking-at org-outline-regexp-bol))
20617 ;; We can't find less than 0 indentation.
20618 ((zerop i) (throw 'exit (setq min-i 0)))
20619 ((< i min-i) (setq min-i i))))
20620 (forward-line))))
20621 ;; Then indent each line so that a line indented to
20622 ;; MIN-I becomes indented to IND. Ignore blank lines
20623 ;; and inline tasks in the process.
20624 (let ((delta (- ind min-i)))
20625 (while (< (point) end)
20626 (unless (or (looking-at "^[ \t]*$")
20627 (looking-at org-outline-regexp-bol))
20628 (org-indent-line-to (+ (org-get-indentation) delta)))
20629 (forward-line)))))))
20630 (skip-blanks
20631 (function
20632 ;; Return beginning of first non-blank line, starting from
20633 ;; line at POS.
20634 (lambda (pos)
20635 (save-excursion
20636 (goto-char pos)
20637 (skip-chars-forward " \r\t\n")
20638 (point-at-bol)))))
20639 beg end)
20640 ;; Determine boundaries of changes.
20641 (if (org-region-active-p)
20642 (setq beg (funcall skip-blanks (region-beginning))
20643 end (copy-marker (region-end)))
20644 (setq beg (funcall skip-blanks (point-at-bol))
20645 end (copy-marker (point-at-eol))))
20646 ;; Depending on the starting line, choose an action on the text
20647 ;; between BEG and END.
20648 (org-with-limited-levels
20649 (save-excursion
20650 (goto-char beg)
20651 (cond
20652 ;; Case 1. Start at an item: de-itemize. Note that it only
20653 ;; happens when a region is active: `org-ctrl-c-minus'
20654 ;; would call `org-cycle-list-bullet' otherwise.
20655 ((org-at-item-p)
20656 (while (< (point) end)
20657 (when (org-at-item-p)
20658 (skip-chars-forward " \t")
20659 (delete-region (point) (match-end 0)))
20660 (forward-line)))
20661 ;; Case 2. Start at an heading: convert to items.
20662 ((org-at-heading-p)
20663 (let* ((bul (org-list-bullet-string "-"))
20664 (bul-len (length bul))
20665 (done (org-entry-is-done-p))
20666 (todo (org-entry-is-todo-p))
20667 ;; Indentation of the first heading. It should be
20668 ;; relative to the indentation of its parent, if any.
20669 (start-ind (save-excursion
20670 (cond
20671 ((not org-adapt-indentation) 0)
20672 ((not (outline-previous-heading)) 0)
20673 (t (length (match-string 0))))))
20674 ;; Level of first heading. Further headings will be
20675 ;; compared to it to determine hierarchy in the list.
20676 (ref-level (org-reduced-level (org-outline-level))))
20677 (when (or done todo) (org-todo ""))
20678 (while (< (point) end)
20679 (let* ((level (org-reduced-level (org-outline-level)))
20680 (delta (max 0 (- level ref-level))))
20681 ;; If current headline is less indented than the first
20682 ;; one, set it as reference, in order to preserve
20683 ;; subtrees.
20684 (when (< level ref-level) (setq ref-level level))
20685 (replace-match bul t t)
20686 (org-indent-line-to (+ start-ind (* delta bul-len)))
20687 (when (or done todo)
20688 (let ((struct (org-list-struct)))
20689 (org-list-set-checkbox (point) struct (if done "[X]" "[ ]"))
20690 (org-list-write-struct struct
20691 (org-list-parents-alist struct))))
20692 ;; Ensure all text down to END (or SECTION-END) belongs
20693 ;; to the newly created item.
20694 (let ((section-end (save-excursion
20695 (or (outline-next-heading) (point)))))
20696 (forward-line)
20697 (funcall shift-text
20698 (+ start-ind (* (1+ delta) bul-len))
20699 (min end section-end)))))))
20700 ;; Case 3. Normal line with ARG: make the first line of region
20701 ;; an item, and shift indentation of others lines to
20702 ;; set them as item's body.
20703 (arg (let* ((bul (org-list-bullet-string "-"))
20704 (bul-len (length bul))
20705 (ref-ind (org-get-indentation)))
20706 (skip-chars-forward " \t")
20707 (insert bul)
20708 (forward-line)
20709 (while (< (point) end)
20710 ;; Ensure that lines less indented than first one
20711 ;; still get included in item body.
20712 (funcall shift-text
20713 (+ ref-ind bul-len)
20714 (min end (save-excursion (or (outline-next-heading)
20715 (point)))))
20716 (forward-line))))
20717 ;; Case 4. Normal line without ARG: turn each non-item line
20718 ;; into an item.
20720 (while (< (point) end)
20721 (unless (or (org-at-heading-p) (org-at-item-p))
20722 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20723 (replace-match
20724 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20725 (forward-line))))))))
20727 (defun org-toggle-heading (&optional nstars)
20728 "Convert headings to normal text, or items or text to headings.
20729 If there is no active region, only convert the current line.
20731 With a \\[universal-argument] prefix, convert the whole list at
20732 point into heading.
20734 In a region:
20736 - If the first non blank line is a headline, remove the stars
20737 from all headlines in the region.
20739 - If it is a normal line, turn each and every normal line (i.e.,
20740 not an heading or an item) in the region into headings. If you
20741 want to convert only the first line of this region, use one
20742 universal prefix argument.
20744 - If it is a plain list item, turn all plain list items into headings.
20746 When converting a line into a heading, the number of stars is chosen
20747 such that the lines become children of the current entry. However,
20748 when a numeric prefix argument is given, its value determines the
20749 number of stars to add."
20750 (interactive "P")
20751 (let ((skip-blanks
20752 (function
20753 ;; Return beginning of first non-blank line, starting from
20754 ;; line at POS.
20755 (lambda (pos)
20756 (save-excursion
20757 (goto-char pos)
20758 (while (org-at-comment-p) (forward-line))
20759 (skip-chars-forward " \r\t\n")
20760 (point-at-bol)))))
20761 beg end toggled)
20762 ;; Determine boundaries of changes. If a universal prefix has
20763 ;; been given, put the list in a region. If region ends at a bol,
20764 ;; do not consider the last line to be in the region.
20766 (when (and current-prefix-arg (org-at-item-p))
20767 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20768 (org-mark-element))
20770 (if (org-region-active-p)
20771 (setq beg (funcall skip-blanks (region-beginning))
20772 end (copy-marker (save-excursion
20773 (goto-char (region-end))
20774 (if (bolp) (point) (point-at-eol)))))
20775 (setq beg (funcall skip-blanks (point-at-bol))
20776 end (copy-marker (point-at-eol))))
20777 ;; Ensure inline tasks don't count as headings.
20778 (org-with-limited-levels
20779 (save-excursion
20780 (goto-char beg)
20781 (cond
20782 ;; Case 1. Started at an heading: de-star headings.
20783 ((org-at-heading-p)
20784 (while (< (point) end)
20785 (when (org-at-heading-p t)
20786 (looking-at org-outline-regexp) (replace-match "")
20787 (setq toggled t))
20788 (forward-line)))
20789 ;; Case 2. Started at an item: change items into headlines.
20790 ;; One star will be added by `org-list-to-subtree'.
20791 ((org-at-item-p)
20792 (let* ((stars (make-string
20793 ;; subtract the star that will be added again by
20794 ;; `org-list-to-subtree'
20795 (if (numberp nstars) (1- nstars)
20796 (or (org-current-level) 0))
20797 ?*))
20798 (add-stars
20799 (cond (nstars "") ; stars from prefix only
20800 ((equal stars "") "") ; before first heading
20801 (org-odd-levels-only "*") ; inside heading, odd
20802 (t "")))) ; inside heading, oddeven
20803 (while (< (point) end)
20804 (when (org-at-item-p)
20805 ;; Pay attention to cases when region ends before list.
20806 (let* ((struct (org-list-struct))
20807 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20808 (save-restriction
20809 (narrow-to-region (point) list-end)
20810 (insert
20811 (org-list-to-subtree
20812 (org-list-parse-list t)
20813 '(:istart (concat stars add-stars (funcall get-stars depth))
20814 :icount (concat stars add-stars (funcall get-stars depth)))))))
20815 (setq toggled t))
20816 (forward-line))))
20817 ;; Case 3. Started at normal text: make every line an heading,
20818 ;; skipping headlines and items.
20819 (t (let* ((stars
20820 (make-string
20821 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20822 (add-stars
20823 (cond (nstars "") ; stars from prefix only
20824 ((equal stars "") "*") ; before first heading
20825 (org-odd-levels-only "**") ; inside heading, odd
20826 (t "*"))) ; inside heading, oddeven
20827 (rpl (concat stars add-stars " "))
20828 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20829 (while (< (point) (if (equal nstars '(4)) lend end))
20830 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20831 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20832 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20833 (forward-line)))))))
20834 (unless toggled (message "Cannot toggle heading from here"))))
20836 (defun org-meta-return (&optional arg)
20837 "Insert a new heading or wrap a region in a table.
20838 Calls `org-insert-heading' or `org-table-wrap-region', depending
20839 on context. See the individual commands for more information."
20840 (interactive "P")
20841 (org-check-before-invisible-edit 'insert)
20842 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20843 (let* ((element (org-element-at-point))
20844 (type (org-element-type element)))
20845 (when (eq type 'table-row)
20846 (setq element (org-element-property :parent element))
20847 (setq type 'table))
20848 (if (and (eq type 'table)
20849 (eq (org-element-property :type element) 'org)
20850 (>= (point) (org-element-property :contents-begin element))
20851 (< (point) (org-element-property :contents-end element)))
20852 (call-interactively 'org-table-wrap-region)
20853 (call-interactively 'org-insert-heading)))))
20855 ;;; Menu entries
20857 (defsubst org-in-subtree-not-table-p ()
20858 "Are we in a subtree and not in a table?"
20859 (and (not (org-before-first-heading-p))
20860 (not (org-at-table-p))))
20862 ;; Define the Org-mode menus
20863 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20864 '("Tbl"
20865 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20866 ["Next Field" org-cycle (org-at-table-p)]
20867 ["Previous Field" org-shifttab (org-at-table-p)]
20868 ["Next Row" org-return (org-at-table-p)]
20869 "--"
20870 ["Blank Field" org-table-blank-field (org-at-table-p)]
20871 ["Edit Field" org-table-edit-field (org-at-table-p)]
20872 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20873 "--"
20874 ("Column"
20875 ["Move Column Left" org-metaleft (org-at-table-p)]
20876 ["Move Column Right" org-metaright (org-at-table-p)]
20877 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20878 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20879 ("Row"
20880 ["Move Row Up" org-metaup (org-at-table-p)]
20881 ["Move Row Down" org-metadown (org-at-table-p)]
20882 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20883 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20884 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20885 "--"
20886 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20887 ("Rectangle"
20888 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20889 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20890 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20891 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20892 "--"
20893 ("Calculate"
20894 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20895 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20896 ["Edit Formulas" org-edit-special (org-at-table-p)]
20897 "--"
20898 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20899 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20900 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20901 "--"
20902 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20903 "--"
20904 ["Sum Column/Rectangle" org-table-sum
20905 (or (org-at-table-p) (org-region-active-p))]
20906 ["Which Column?" org-table-current-column (org-at-table-p)])
20907 ["Debug Formulas"
20908 org-table-toggle-formula-debugger
20909 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20910 ["Show Col/Row Numbers"
20911 org-table-toggle-coordinate-overlays
20912 :style toggle
20913 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20914 "--"
20915 ["Create" org-table-create (and (not (org-at-table-p))
20916 org-enable-table-editor)]
20917 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20918 ["Import from File" org-table-import (not (org-at-table-p))]
20919 ["Export to File" org-table-export (org-at-table-p)]
20920 "--"
20921 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20923 (easy-menu-define org-org-menu org-mode-map "Org menu"
20924 '("Org"
20925 ("Show/Hide"
20926 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20927 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20928 ["Sparse Tree..." org-sparse-tree t]
20929 ["Reveal Context" org-reveal t]
20930 ["Show All" show-all t]
20931 "--"
20932 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20933 "--"
20934 ["New Heading" org-insert-heading t]
20935 ("Navigate Headings"
20936 ["Up" outline-up-heading t]
20937 ["Next" outline-next-visible-heading t]
20938 ["Previous" outline-previous-visible-heading t]
20939 ["Next Same Level" outline-forward-same-level t]
20940 ["Previous Same Level" outline-backward-same-level t]
20941 "--"
20942 ["Jump" org-goto t])
20943 ("Edit Structure"
20944 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20945 "--"
20946 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20947 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20948 "--"
20949 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20950 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20951 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20952 "--"
20953 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20954 "--"
20955 ["Copy visible text" org-copy-visible t]
20956 "--"
20957 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20958 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20959 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20960 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20961 "--"
20962 ["Sort Region/Children" org-sort t]
20963 "--"
20964 ["Convert to odd levels" org-convert-to-odd-levels t]
20965 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20966 ("Editing"
20967 ["Emphasis..." org-emphasize t]
20968 ["Edit Source Example" org-edit-special t]
20969 "--"
20970 ["Footnote new/jump" org-footnote-action t]
20971 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20972 ("Archive"
20973 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20974 "--"
20975 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
20976 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
20977 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
20979 "--"
20980 ("Hyperlinks"
20981 ["Store Link (Global)" org-store-link t]
20982 ["Find existing link to here" org-occur-link-in-agenda-files t]
20983 ["Insert Link" org-insert-link t]
20984 ["Follow Link" org-open-at-point t]
20985 "--"
20986 ["Next link" org-next-link t]
20987 ["Previous link" org-previous-link t]
20988 "--"
20989 ["Descriptive Links"
20990 org-toggle-link-display
20991 :style radio
20992 :selected org-descriptive-links
20994 ["Literal Links"
20995 org-toggle-link-display
20996 :style radio
20997 :selected (not org-descriptive-links)])
20998 "--"
20999 ("TODO Lists"
21000 ["TODO/DONE/-" org-todo t]
21001 ("Select keyword"
21002 ["Next keyword" org-shiftright (org-at-heading-p)]
21003 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21004 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21005 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21006 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21007 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21008 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21009 "--"
21010 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21011 :selected org-enforce-todo-dependencies :style toggle :active t]
21012 "Settings for tree at point"
21013 ["Do Children sequentially" org-toggle-ordered-property :style radio
21014 :selected (org-entry-get nil "ORDERED")
21015 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21016 ["Do Children parallel" org-toggle-ordered-property :style radio
21017 :selected (not (org-entry-get nil "ORDERED"))
21018 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21019 "--"
21020 ["Set Priority" org-priority t]
21021 ["Priority Up" org-shiftup t]
21022 ["Priority Down" org-shiftdown t]
21023 "--"
21024 ["Get news from all feeds" org-feed-update-all t]
21025 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21026 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21027 ("TAGS and Properties"
21028 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21029 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21030 "--"
21031 ["Set property" org-set-property (not (org-before-first-heading-p))]
21032 ["Column view of properties" org-columns t]
21033 ["Insert Column View DBlock" org-insert-columns-dblock t])
21034 ("Dates and Scheduling"
21035 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21036 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21037 ("Change Date"
21038 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21039 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21040 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21041 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21042 ["Compute Time Range" org-evaluate-time-range t]
21043 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21044 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21045 "--"
21046 ["Custom time format" org-toggle-time-stamp-overlays
21047 :style radio :selected org-display-custom-times]
21048 "--"
21049 ["Goto Calendar" org-goto-calendar t]
21050 ["Date from Calendar" org-date-from-calendar t]
21051 "--"
21052 ["Start/Restart Timer" org-timer-start t]
21053 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21054 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21055 ["Insert Timer String" org-timer t]
21056 ["Insert Timer Item" org-timer-item t])
21057 ("Logging work"
21058 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21059 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21060 ["Clock out" org-clock-out t]
21061 ["Clock cancel" org-clock-cancel t]
21062 "--"
21063 ["Mark as default task" org-clock-mark-default-task t]
21064 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21065 ["Goto running clock" org-clock-goto t]
21066 "--"
21067 ["Display times" org-clock-display t]
21068 ["Create clock table" org-clock-report t]
21069 "--"
21070 ["Record DONE time"
21071 (progn (setq org-log-done (not org-log-done))
21072 (message "Switching to %s will %s record a timestamp"
21073 (car org-done-keywords)
21074 (if org-log-done "automatically" "not")))
21075 :style toggle :selected org-log-done])
21076 "--"
21077 ["Agenda Command..." org-agenda t]
21078 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21079 ("File List for Agenda")
21080 ("Special views current file"
21081 ["TODO Tree" org-show-todo-tree t]
21082 ["Check Deadlines" org-check-deadlines t]
21083 ["Timeline" org-timeline t]
21084 ["Tags/Property tree" org-match-sparse-tree t])
21085 "--"
21086 ["Export/Publish..." org-export-dispatch t]
21087 ("LaTeX"
21088 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21089 :selected org-cdlatex-mode]
21090 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21091 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21092 ["Modify math symbol" org-cdlatex-math-modify
21093 (org-inside-LaTeX-fragment-p)]
21094 ["Insert citation" org-reftex-citation t]
21095 "--"
21096 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21097 "--"
21098 ("MobileOrg"
21099 ["Push Files and Views" org-mobile-push t]
21100 ["Get Captured and Flagged" org-mobile-pull t]
21101 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21102 "--"
21103 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21104 "--"
21105 ("Documentation"
21106 ["Show Version" org-version t]
21107 ["Info Documentation" org-info t])
21108 ("Customize"
21109 ["Browse Org Group" org-customize t]
21110 "--"
21111 ["Expand This Menu" org-create-customize-menu
21112 (fboundp 'customize-menu-create)])
21113 ["Send bug report" org-submit-bug-report t]
21114 "--"
21115 ("Refresh/Reload"
21116 ["Refresh setup current buffer" org-mode-restart t]
21117 ["Reload Org (after update)" org-reload t]
21118 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21121 (defun org-info (&optional node)
21122 "Read documentation for Org-mode in the info system.
21123 With optional NODE, go directly to that node."
21124 (interactive)
21125 (info (format "(org)%s" (or node ""))))
21127 ;;;###autoload
21128 (defun org-submit-bug-report ()
21129 "Submit a bug report on Org-mode via mail.
21131 Don't hesitate to report any problems or inaccurate documentation.
21133 If you don't have setup sending mail from (X)Emacs, please copy the
21134 output buffer into your mail program, as it gives us important
21135 information about your Org-mode version and configuration."
21136 (interactive)
21137 (require 'reporter)
21138 (org-load-modules-maybe)
21139 (org-require-autoloaded-modules)
21140 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21141 (reporter-submit-bug-report
21142 "emacs-orgmode@gnu.org"
21143 (org-version nil 'full)
21144 (let (list)
21145 (save-window-excursion
21146 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21147 (delete-other-windows)
21148 (erase-buffer)
21149 (insert "You are about to submit a bug report to the Org-mode mailing list.
21151 We would like to add your full Org-mode and Outline configuration to the
21152 bug report. This greatly simplifies the work of the maintainer and
21153 other experts on the mailing list.
21155 HOWEVER, some variables you have customized may contain private
21156 information. The names of customers, colleagues, or friends, might
21157 appear in the form of file names, tags, todo states, or search strings.
21158 If you answer yes to the prompt, you might want to check and remove
21159 such private information before sending the email.")
21160 (add-text-properties (point-min) (point-max) '(face org-warning))
21161 (when (yes-or-no-p "Include your Org-mode configuration ")
21162 (mapatoms
21163 (lambda (v)
21164 (and (boundp v)
21165 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21166 (or (and (symbol-value v)
21167 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21168 (and
21169 (get v 'custom-type) (get v 'standard-value)
21170 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21171 (push v list)))))
21172 (kill-buffer (get-buffer "*Warn about privacy*"))
21173 list))
21174 nil nil
21175 "Remember to cover the basics, that is, what you expected to happen and
21176 what in fact did happen. You don't know how to make a good report? See
21178 http://orgmode.org/manual/Feedback.html#Feedback
21180 Your bug report will be posted to the Org-mode mailing list.
21181 ------------------------------------------------------------------------")
21182 (save-excursion
21183 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21184 (replace-match "\\1Bug: \\3 [\\2]")))))
21187 (defun org-install-agenda-files-menu ()
21188 (let ((bl (buffer-list)))
21189 (save-excursion
21190 (while bl
21191 (set-buffer (pop bl))
21192 (if (derived-mode-p 'org-mode) (setq bl nil)))
21193 (when (derived-mode-p 'org-mode)
21194 (easy-menu-change
21195 '("Org") "File List for Agenda"
21196 (append
21197 (list
21198 ["Edit File List" (org-edit-agenda-file-list) t]
21199 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21200 ["Remove Current File from List" org-remove-file t]
21201 ["Cycle through agenda files" org-cycle-agenda-files t]
21202 ["Occur in all agenda files" org-occur-in-agenda-files t]
21203 "--")
21204 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21206 ;;;; Documentation
21208 (defun org-require-autoloaded-modules ()
21209 (interactive)
21210 (mapc 'require
21211 '(org-agenda org-archive org-attach org-clock org-colview org-id
21212 org-table org-timer)))
21214 ;;;###autoload
21215 (defun org-reload (&optional uncompiled)
21216 "Reload all org lisp files.
21217 With prefix arg UNCOMPILED, load the uncompiled versions."
21218 (interactive "P")
21219 (require 'loadhist)
21220 (let* ((org-dir (org-find-library-dir "org"))
21221 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21222 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21223 (remove-re (mapconcat 'identity
21224 (mapcar (lambda (f) (concat "^" f "$"))
21225 (list (if (featurep 'xemacs)
21226 "org-colview"
21227 "org-colview-xemacs")
21228 "org" "org-loaddefs" "org-version"))
21229 "\\|"))
21230 (feats (delete-dups
21231 (mapcar 'file-name-sans-extension
21232 (mapcar 'file-name-nondirectory
21233 (delq nil
21234 (mapcar 'feature-file
21235 features))))))
21236 (lfeat (append
21237 (sort
21238 (setq feats
21239 (delq nil (mapcar
21240 (lambda (f)
21241 (if (and (string-match feature-re f)
21242 (not (string-match remove-re f)))
21243 f nil))
21244 feats)))
21245 'string-lessp)
21246 (list "org-version" "org")))
21247 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21248 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21249 load-uncore load-misses)
21250 (setq load-misses
21251 (delq 't
21252 (mapcar (lambda (f)
21253 (or (org-load-noerror-mustsuffix (concat org-dir f))
21254 (and (string= org-dir contrib-dir)
21255 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21256 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21257 (add-to-list 'load-uncore f 'append)
21260 lfeat)))
21261 (if load-uncore
21262 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21263 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21264 (if load-misses
21265 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21266 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21267 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21269 ;;;###autoload
21270 (defun org-customize ()
21271 "Call the customize function with org as argument."
21272 (interactive)
21273 (org-load-modules-maybe)
21274 (org-require-autoloaded-modules)
21275 (customize-browse 'org))
21277 (defun org-create-customize-menu ()
21278 "Create a full customization menu for Org-mode, insert it into the menu."
21279 (interactive)
21280 (org-load-modules-maybe)
21281 (org-require-autoloaded-modules)
21282 (if (fboundp 'customize-menu-create)
21283 (progn
21284 (easy-menu-change
21285 '("Org") "Customize"
21286 `(["Browse Org group" org-customize t]
21287 "--"
21288 ,(customize-menu-create 'org)
21289 ["Set" Custom-set t]
21290 ["Save" Custom-save t]
21291 ["Reset to Current" Custom-reset-current t]
21292 ["Reset to Saved" Custom-reset-saved t]
21293 ["Reset to Standard Settings" Custom-reset-standard t]))
21294 (message "\"Org\"-menu now contains full customization menu"))
21295 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21297 ;;;; Miscellaneous stuff
21299 ;;; Generally useful functions
21301 (defun org-get-at-bol (property)
21302 "Get text property PROPERTY at beginning of line."
21303 (get-text-property (point-at-bol) property))
21305 (defun org-find-text-property-in-string (prop s)
21306 "Return the first non-nil value of property PROP in string S."
21307 (or (get-text-property 0 prop s)
21308 (get-text-property (or (next-single-property-change 0 prop s) 0)
21309 prop s)))
21311 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21312 "Display the given MESSAGE as a warning."
21313 (if (fboundp 'display-warning)
21314 (display-warning 'org message
21315 (if (featurep 'xemacs) 'warning :warning))
21316 (let ((buf (get-buffer-create "*Org warnings*")))
21317 (with-current-buffer buf
21318 (goto-char (point-max))
21319 (insert "Warning (Org): " message)
21320 (unless (bolp)
21321 (newline)))
21322 (display-buffer buf)
21323 (sit-for 0))))
21325 (defun org-eval (form)
21326 "Eval FORM and return result."
21327 (condition-case error
21328 (eval form)
21329 (error (format "%%![Error: %s]" error))))
21331 (defun org-in-clocktable-p ()
21332 "Check if the cursor is in a clocktable."
21333 (let ((pos (point)) start)
21334 (save-excursion
21335 (end-of-line 1)
21336 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21337 (setq start (match-beginning 0))
21338 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21339 (>= (match-end 0) pos)
21340 start))))
21342 (defun org-in-commented-line ()
21343 "Is point in a line starting with `#'?"
21344 (equal (char-after (point-at-bol)) ?#))
21346 (defun org-in-indented-comment-line ()
21347 "Is point in a line starting with `#' after some white space?"
21348 (save-excursion
21349 (save-match-data
21350 (goto-char (point-at-bol))
21351 (looking-at "[ \t]*#"))))
21353 (defun org-in-verbatim-emphasis ()
21354 (save-match-data
21355 (and (org-in-regexp org-emph-re 2)
21356 (>= (point) (match-beginning 3))
21357 (<= (point) (match-end 4))
21358 (member (match-string 3) '("=" "~")))))
21360 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21361 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21362 (if (and marker (marker-buffer marker)
21363 (buffer-live-p (marker-buffer marker)))
21364 (progn
21365 (org-pop-to-buffer-same-window (marker-buffer marker))
21366 (if (or (> marker (point-max)) (< marker (point-min)))
21367 (widen))
21368 (goto-char marker)
21369 (org-show-context 'org-goto))
21370 (if bookmark
21371 (bookmark-jump bookmark)
21372 (error "Cannot find location"))))
21374 (defun org-quote-csv-field (s)
21375 "Quote field for inclusion in CSV material."
21376 (if (string-match "[\",]" s)
21377 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21380 (defun org-force-self-insert (N)
21381 "Needed to enforce self-insert under remapping."
21382 (interactive "p")
21383 (self-insert-command N))
21385 (defun org-string-width (s)
21386 "Compute width of string, ignoring invisible characters.
21387 This ignores character with invisibility property `org-link', and also
21388 characters with property `org-cwidth', because these will become invisible
21389 upon the next fontification round."
21390 (let (b l)
21391 (when (or (eq t buffer-invisibility-spec)
21392 (assq 'org-link buffer-invisibility-spec))
21393 (while (setq b (text-property-any 0 (length s)
21394 'invisible 'org-link s))
21395 (setq s (concat (substring s 0 b)
21396 (substring s (or (next-single-property-change
21397 b 'invisible s) (length s)))))))
21398 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21399 (setq s (concat (substring s 0 b)
21400 (substring s (or (next-single-property-change
21401 b 'org-cwidth s) (length s))))))
21402 (setq l (string-width s) b -1)
21403 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21404 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21407 (defun org-shorten-string (s maxlength)
21408 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21409 If the string is shorter or has length MAXLENGTH, just return the
21410 original string. If it is longer, the functions finds a space in the
21411 string, breaks this string off at that locations and adds three dots
21412 as ellipsis. Including the ellipsis, the string will not be longer
21413 than MAXLENGTH. If finding a good breaking point in the string does
21414 not work, the string is just chopped off in the middle of a word
21415 if necessary."
21416 (if (<= (length s) maxlength)
21418 (let* ((n (max (- maxlength 4) 1))
21419 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21420 (if (string-match re s)
21421 (concat (match-string 1 s) "...")
21422 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21424 (defun org-get-indentation (&optional line)
21425 "Get the indentation of the current line, interpreting tabs.
21426 When LINE is given, assume it represents a line and compute its indentation."
21427 (if line
21428 (if (string-match "^ *" (org-remove-tabs line))
21429 (match-end 0))
21430 (save-excursion
21431 (beginning-of-line 1)
21432 (skip-chars-forward " \t")
21433 (current-column))))
21435 (defun org-get-string-indentation (s)
21436 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21437 (let ((n -1) (i 0) (w tab-width) c)
21438 (catch 'exit
21439 (while (< (setq n (1+ n)) (length s))
21440 (setq c (aref s n))
21441 (cond ((= c ?\ ) (setq i (1+ i)))
21442 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21443 (t (throw 'exit t)))))
21446 (defun org-remove-tabs (s &optional width)
21447 "Replace tabulators in S with spaces.
21448 Assumes that s is a single line, starting in column 0."
21449 (setq width (or width tab-width))
21450 (while (string-match "\t" s)
21451 (setq s (replace-match
21452 (make-string
21453 (- (* width (/ (+ (match-beginning 0) width) width))
21454 (match-beginning 0)) ?\ )
21455 t t s)))
21458 (defun org-fix-indentation (line ind)
21459 "Fix indentation in LINE.
21460 IND is a cons cell with target and minimum indentation.
21461 If the current indentation in LINE is smaller than the minimum,
21462 leave it alone. If it is larger than ind, set it to the target."
21463 (let* ((l (org-remove-tabs line))
21464 (i (org-get-indentation l))
21465 (i1 (car ind)) (i2 (cdr ind)))
21466 (if (>= i i2) (setq l (substring line i2)))
21467 (if (> i1 0)
21468 (concat (make-string i1 ?\ ) l)
21469 l)))
21471 (defun org-remove-indentation (code &optional n)
21472 "Remove the maximum common indentation from the lines in CODE.
21473 N may optionally be the number of spaces to remove."
21474 (with-temp-buffer
21475 (insert code)
21476 (org-do-remove-indentation n)
21477 (buffer-string)))
21479 (defun org-do-remove-indentation (&optional n)
21480 "Remove the maximum common indentation from the buffer."
21481 (untabify (point-min) (point-max))
21482 (let ((min 10000) re)
21483 (if n
21484 (setq min n)
21485 (goto-char (point-min))
21486 (while (re-search-forward "^ *[^ \n]" nil t)
21487 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21488 (unless (or (= min 0) (= min 10000))
21489 (setq re (format "^ \\{%d\\}" min))
21490 (goto-char (point-min))
21491 (while (re-search-forward re nil t)
21492 (replace-match "")
21493 (end-of-line 1))
21494 min)))
21496 (defun org-fill-template (template alist)
21497 "Find each %key of ALIST in TEMPLATE and replace it."
21498 (let ((case-fold-search nil)
21499 entry key value)
21500 (setq alist (sort (copy-sequence alist)
21501 (lambda (a b) (< (length (car a)) (length (car b))))))
21502 (while (setq entry (pop alist))
21503 (setq template
21504 (replace-regexp-in-string
21505 (concat "%" (regexp-quote (car entry)))
21506 (or (cdr entry) "") template t t)))
21507 template))
21509 (defun org-base-buffer (buffer)
21510 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21511 (if (not buffer)
21512 buffer
21513 (or (buffer-base-buffer buffer)
21514 buffer)))
21516 (defun org-trim (s)
21517 "Remove whitespace at beginning and end of string."
21518 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21519 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21522 (defun org-wrap (string &optional width lines)
21523 "Wrap string to either a number of lines, or a width in characters.
21524 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21525 that costs. If there is a word longer than WIDTH, the text is actually
21526 wrapped to the length of that word.
21527 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21528 many lines, whatever width that takes.
21529 The return value is a list of lines, without newlines at the end."
21530 (let* ((words (org-split-string string "[ \t\n]+"))
21531 (maxword (apply 'max (mapcar 'org-string-width words)))
21532 w ll)
21533 (cond (width
21534 (org-do-wrap words (max maxword width)))
21535 (lines
21536 (setq w maxword)
21537 (setq ll (org-do-wrap words maxword))
21538 (if (<= (length ll) lines)
21540 (setq ll words)
21541 (while (> (length ll) lines)
21542 (setq w (1+ w))
21543 (setq ll (org-do-wrap words w)))
21544 ll))
21545 (t (error "Cannot wrap this")))))
21547 (defun org-do-wrap (words width)
21548 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21549 (let (lines line)
21550 (while words
21551 (setq line (pop words))
21552 (while (and words (< (+ (length line) (length (car words))) width))
21553 (setq line (concat line " " (pop words))))
21554 (setq lines (push line lines)))
21555 (nreverse lines)))
21557 (defun org-split-string (string &optional separators)
21558 "Splits STRING into substrings at SEPARATORS.
21559 No empty strings are returned if there are matches at the beginning
21560 and end of string."
21561 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21562 (start 0)
21563 notfirst
21564 (list nil))
21565 (while (and (string-match rexp string
21566 (if (and notfirst
21567 (= start (match-beginning 0))
21568 (< start (length string)))
21569 (1+ start) start))
21570 (< (match-beginning 0) (length string)))
21571 (setq notfirst t)
21572 (or (eq (match-beginning 0) 0)
21573 (and (eq (match-beginning 0) (match-end 0))
21574 (eq (match-beginning 0) start))
21575 (setq list
21576 (cons (substring string start (match-beginning 0))
21577 list)))
21578 (setq start (match-end 0)))
21579 (or (eq start (length string))
21580 (setq list
21581 (cons (substring string start)
21582 list)))
21583 (nreverse list)))
21585 (defun org-quote-vert (s)
21586 "Replace \"|\" with \"\\vert\"."
21587 (while (string-match "|" s)
21588 (setq s (replace-match "\\vert" t t s)))
21591 (defun org-uuidgen-p (s)
21592 "Is S an ID created by UUIDGEN?"
21593 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21595 (defun org-in-src-block-p (&optional inside)
21596 "Whether point is in a code source block.
21597 When INSIDE is non-nil, don't consider we are within a src block
21598 when point is at #+BEGIN_SRC or #+END_SRC."
21599 (let ((case-fold-search t) ov)
21600 (or (and (setq ov (overlays-at (point)))
21601 (memq 'org-block-background
21602 (overlay-properties (car ov))))
21603 (and (not inside)
21604 (save-match-data
21605 (save-excursion
21606 (beginning-of-line)
21607 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21609 (defun org-context ()
21610 "Return a list of contexts of the current cursor position.
21611 If several contexts apply, all are returned.
21612 Each context entry is a list with a symbol naming the context, and
21613 two positions indicating start and end of the context. Possible
21614 contexts are:
21616 :headline anywhere in a headline
21617 :headline-stars on the leading stars in a headline
21618 :todo-keyword on a TODO keyword (including DONE) in a headline
21619 :tags on the TAGS in a headline
21620 :priority on the priority cookie in a headline
21621 :item on the first line of a plain list item
21622 :item-bullet on the bullet/number of a plain list item
21623 :checkbox on the checkbox in a plain list item
21624 :table in an org-mode table
21625 :table-special on a special filed in a table
21626 :table-table in a table.el table
21627 :clocktable in a clocktable
21628 :src-block in a source block
21629 :link on a hyperlink
21630 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21631 :target on a <<target>>
21632 :radio-target on a <<<radio-target>>>
21633 :latex-fragment on a LaTeX fragment
21634 :latex-preview on a LaTeX fragment with overlaid preview image
21636 This function expects the position to be visible because it uses font-lock
21637 faces as a help to recognize the following contexts: :table-special, :link,
21638 and :keyword."
21639 (let* ((f (get-text-property (point) 'face))
21640 (faces (if (listp f) f (list f)))
21641 (case-fold-search t)
21642 (p (point)) clist o)
21643 ;; First the large context
21644 (cond
21645 ((org-at-heading-p t)
21646 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21647 (when (progn
21648 (beginning-of-line 1)
21649 (looking-at org-todo-line-tags-regexp))
21650 (push (org-point-in-group p 1 :headline-stars) clist)
21651 (push (org-point-in-group p 2 :todo-keyword) clist)
21652 (push (org-point-in-group p 4 :tags) clist))
21653 (goto-char p)
21654 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21655 (if (looking-at "\\[#[A-Z0-9]\\]")
21656 (push (org-point-in-group p 0 :priority) clist)))
21658 ((org-at-item-p)
21659 (push (org-point-in-group p 2 :item-bullet) clist)
21660 (push (list :item (point-at-bol)
21661 (save-excursion (org-end-of-item) (point)))
21662 clist)
21663 (and (org-at-item-checkbox-p)
21664 (push (org-point-in-group p 0 :checkbox) clist)))
21666 ((org-at-table-p)
21667 (push (list :table (org-table-begin) (org-table-end)) clist)
21668 (if (memq 'org-formula faces)
21669 (push (list :table-special
21670 (previous-single-property-change p 'face)
21671 (next-single-property-change p 'face)) clist)))
21672 ((org-at-table-p 'any)
21673 (push (list :table-table) clist)))
21674 (goto-char p)
21676 (let ((case-fold-search t))
21677 ;; New the "medium" contexts: clocktables, source blocks
21678 (cond ((org-in-clocktable-p)
21679 (push (list :clocktable
21680 (and (or (looking-at "#\\+BEGIN: clocktable")
21681 (search-backward "#+BEGIN: clocktable" nil t))
21682 (match-beginning 0))
21683 (and (re-search-forward "#\\+END:?" nil t)
21684 (match-end 0))) clist))
21685 ((org-in-src-block-p)
21686 (push (list :src-block
21687 (and (or (looking-at "#\\+BEGIN_SRC")
21688 (search-backward "#+BEGIN_SRC" nil t))
21689 (match-beginning 0))
21690 (and (search-forward "#+END_SRC" nil t)
21691 (match-beginning 0))) clist))))
21692 (goto-char p)
21694 ;; Now the small context
21695 (cond
21696 ((org-at-timestamp-p)
21697 (push (org-point-in-group p 0 :timestamp) clist))
21698 ((memq 'org-link faces)
21699 (push (list :link
21700 (previous-single-property-change p 'face)
21701 (next-single-property-change p 'face)) clist))
21702 ((memq 'org-special-keyword faces)
21703 (push (list :keyword
21704 (previous-single-property-change p 'face)
21705 (next-single-property-change p 'face)) clist))
21706 ((org-at-target-p)
21707 (push (org-point-in-group p 0 :target) clist)
21708 (goto-char (1- (match-beginning 0)))
21709 (if (looking-at org-radio-target-regexp)
21710 (push (org-point-in-group p 0 :radio-target) clist))
21711 (goto-char p))
21712 ((setq o (car (delq nil
21713 (mapcar
21714 (lambda (x)
21715 (if (memq x org-latex-fragment-image-overlays) x))
21716 (overlays-at (point))))))
21717 (push (list :latex-fragment
21718 (overlay-start o) (overlay-end o)) clist)
21719 (push (list :latex-preview
21720 (overlay-start o) (overlay-end o)) clist))
21721 ((org-inside-LaTeX-fragment-p)
21722 ;; FIXME: positions wrong.
21723 (push (list :latex-fragment (point) (point)) clist)))
21725 (setq clist (nreverse (delq nil clist)))
21726 clist))
21728 ;; FIXME: Compare with at-regexp-p Do we need both?
21729 (defun org-in-regexp (re &optional nlines visually)
21730 "Check if point is inside a match of regexp.
21731 Normally only the current line is checked, but you can include NLINES extra
21732 lines both before and after point into the search.
21733 If VISUALLY is set, require that the cursor is not after the match but
21734 really on, so that the block visually is on the match."
21735 (catch 'exit
21736 (let ((pos (point))
21737 (eol (point-at-eol (+ 1 (or nlines 0))))
21738 (inc (if visually 1 0)))
21739 (save-excursion
21740 (beginning-of-line (- 1 (or nlines 0)))
21741 (while (re-search-forward re eol t)
21742 (if (and (<= (match-beginning 0) pos)
21743 (>= (+ inc (match-end 0)) pos))
21744 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21746 (defun org-at-regexp-p (regexp)
21747 "Is point inside a match of REGEXP in the current line?"
21748 (catch 'exit
21749 (save-excursion
21750 (let ((pos (point)) (end (point-at-eol)))
21751 (beginning-of-line 1)
21752 (while (re-search-forward regexp end t)
21753 (if (and (<= (match-beginning 0) pos)
21754 (>= (match-end 0) pos))
21755 (throw 'exit t)))
21756 nil))))
21758 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21759 "Non-nil when point is between matches of START-RE and END-RE.
21761 Also return a non-nil value when point is on one of the matches.
21763 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21764 buffer positions. Default values are the positions of headlines
21765 surrounding the point.
21767 The functions returns a cons cell whose car (resp. cdr) is the
21768 position before START-RE (resp. after END-RE)."
21769 (save-match-data
21770 (let ((pos (point))
21771 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21772 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21773 beg end)
21774 (save-excursion
21775 ;; Point is on a block when on START-RE or if START-RE can be
21776 ;; found before it...
21777 (and (or (org-at-regexp-p start-re)
21778 (re-search-backward start-re limit-up t))
21779 (setq beg (match-beginning 0))
21780 ;; ... and END-RE after it...
21781 (goto-char (match-end 0))
21782 (re-search-forward end-re limit-down t)
21783 (> (setq end (match-end 0)) pos)
21784 ;; ... without another START-RE in-between.
21785 (goto-char (match-beginning 0))
21786 (not (re-search-backward start-re (1+ beg) t))
21787 ;; Return value.
21788 (cons beg end))))))
21790 (defun org-in-block-p (names)
21791 "Non-nil when point belongs to a block whose name belongs to NAMES.
21793 NAMES is a list of strings containing names of blocks.
21795 Return first block name matched, or nil. Beware that in case of
21796 nested blocks, the returned name may not belong to the closest
21797 block from point."
21798 (save-match-data
21799 (catch 'exit
21800 (let ((case-fold-search t)
21801 (lim-up (save-excursion (outline-previous-heading)))
21802 (lim-down (save-excursion (outline-next-heading))))
21803 (mapc (lambda (name)
21804 (let ((n (regexp-quote name)))
21805 (when (org-between-regexps-p
21806 (concat "^[ \t]*#\\+begin_" n)
21807 (concat "^[ \t]*#\\+end_" n)
21808 lim-up lim-down)
21809 (throw 'exit n))))
21810 names))
21811 nil)))
21813 (defun org-in-drawer-p ()
21814 "Non-nil if point is within a drawer.
21815 If point is within a drawer, return it, as parsed data."
21816 (let ((element (save-match-data (org-element-at-point))))
21817 (while (and element (not (memq (org-element-type element)
21818 '(drawer property-drawer))))
21819 (setq element (org-element-property :parent element)))
21820 element))
21822 (defun org-occur-in-agenda-files (regexp &optional nlines)
21823 "Call `multi-occur' with buffers for all agenda files."
21824 (interactive "sOrg-files matching: \np")
21825 (let* ((files (org-agenda-files))
21826 (tnames (mapcar 'file-truename files))
21827 (extra org-agenda-text-search-extra-files)
21829 (when (eq (car extra) 'agenda-archives)
21830 (setq extra (cdr extra))
21831 (setq files (org-add-archive-files files)))
21832 (while (setq f (pop extra))
21833 (unless (member (file-truename f) tnames)
21834 (add-to-list 'files f 'append)
21835 (add-to-list 'tnames (file-truename f) 'append)))
21836 (multi-occur
21837 (mapcar (lambda (x)
21838 (with-current-buffer
21839 (or (get-file-buffer x) (find-file-noselect x))
21840 (widen)
21841 (current-buffer)))
21842 files)
21843 regexp)))
21845 (if (boundp 'occur-mode-find-occurrence-hook)
21846 ;; Emacs 23
21847 (add-hook 'occur-mode-find-occurrence-hook
21848 (lambda ()
21849 (when (derived-mode-p 'org-mode)
21850 (org-reveal))))
21851 ;; Emacs 22
21852 (defadvice occur-mode-goto-occurrence
21853 (after org-occur-reveal activate)
21854 (and (derived-mode-p 'org-mode) (org-reveal)))
21855 (defadvice occur-mode-goto-occurrence-other-window
21856 (after org-occur-reveal activate)
21857 (and (derived-mode-p 'org-mode) (org-reveal)))
21858 (defadvice occur-mode-display-occurrence
21859 (after org-occur-reveal activate)
21860 (when (derived-mode-p 'org-mode)
21861 (let ((pos (occur-mode-find-occurrence)))
21862 (with-current-buffer (marker-buffer pos)
21863 (save-excursion
21864 (goto-char pos)
21865 (org-reveal)))))))
21867 (defun org-occur-link-in-agenda-files ()
21868 "Create a link and search for it in the agendas.
21869 The link is not stored in `org-stored-links', it is just created
21870 for the search purpose."
21871 (interactive)
21872 (let ((link (condition-case nil
21873 (org-store-link nil)
21874 (error "Unable to create a link to here"))))
21875 (org-occur-in-agenda-files (regexp-quote link))))
21877 (defun org-reverse-string (string)
21878 "Return the reverse of STRING."
21879 (apply 'string (reverse (string-to-list string))))
21881 (defun org-uniquify-alist (alist)
21882 "Merge elements of ALIST with the same key.
21884 For example, in this alist:
21886 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21887 => '((a 1 3) (b 2))
21889 merge (a 1) and (a 3) into (a 1 3).
21891 The function returns the new ALIST."
21892 (let (rtn)
21893 (mapc
21894 (lambda (e)
21895 (let (n)
21896 (if (not (assoc (car e) rtn))
21897 (push e rtn)
21898 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21899 (setq rtn (assq-delete-all (car e) rtn))
21900 (push n rtn))))
21901 alist)
21902 rtn))
21904 (defun org-delete-all (elts list)
21905 "Remove all elements in ELTS from LIST."
21906 (while elts
21907 (setq list (delete (pop elts) list)))
21908 list)
21910 (defun org-count (cl-item cl-seq)
21911 "Count the number of occurrences of ITEM in SEQ.
21912 Taken from `count' in cl-seq.el with all keyword arguments removed."
21913 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21914 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21915 (while (< cl-start cl-end)
21916 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21917 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21918 (setq cl-start (1+ cl-start)))
21919 cl-count))
21921 (defun org-remove-if (predicate seq)
21922 "Remove everything from SEQ that fulfills PREDICATE."
21923 (let (res e)
21924 (while seq
21925 (setq e (pop seq))
21926 (if (not (funcall predicate e)) (push e res)))
21927 (nreverse res)))
21929 (defun org-remove-if-not (predicate seq)
21930 "Remove everything from SEQ that does not fulfill PREDICATE."
21931 (let (res e)
21932 (while seq
21933 (setq e (pop seq))
21934 (if (funcall predicate e) (push e res)))
21935 (nreverse res)))
21937 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21938 "Reduce two-argument FUNCTION across SEQ.
21939 Taken from `reduce' in cl-seq.el with all keyword arguments but
21940 \":initial-value\" removed."
21941 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21942 (cadr (memq :initial-value cl-keys)))
21943 (cl-seq (pop cl-seq))
21944 (t (funcall cl-func)))))
21945 (while cl-seq
21946 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21947 cl-accum))
21949 (defun org-every (pred seq)
21950 "Return true if PREDICATE is true of every element of SEQ.
21951 Adapted from `every' in cl.el."
21952 (catch 'org-every
21953 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21956 (defun org-some (pred seq)
21957 "Return true if PREDICATE is true of any element of SEQ.
21958 Adapted from `some' in cl.el."
21959 (catch 'org-some
21960 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21961 nil))
21963 (defun org-back-over-empty-lines ()
21964 "Move backwards over whitespace, to the beginning of the first empty line.
21965 Returns the number of empty lines passed."
21966 (let ((pos (point)))
21967 (if (cdr (assoc 'heading org-blank-before-new-entry))
21968 (skip-chars-backward " \t\n\r")
21969 (unless (eobp)
21970 (forward-line -1)))
21971 (beginning-of-line 2)
21972 (goto-char (min (point) pos))
21973 (count-lines (point) pos)))
21975 (defun org-skip-whitespace ()
21976 (skip-chars-forward " \t\n\r"))
21978 (defun org-point-in-group (point group &optional context)
21979 "Check if POINT is in match-group GROUP.
21980 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
21981 match. If the match group does not exist or point is not inside it,
21982 return nil."
21983 (and (match-beginning group)
21984 (>= point (match-beginning group))
21985 (<= point (match-end group))
21986 (if context
21987 (list context (match-beginning group) (match-end group))
21988 t)))
21990 (defun org-switch-to-buffer-other-window (&rest args)
21991 "Switch to buffer in a second window on the current frame.
21992 In particular, do not allow pop-up frames.
21993 Returns the newly created buffer."
21994 (org-no-popups
21995 (apply 'switch-to-buffer-other-window args)))
21997 (defun org-combine-plists (&rest plists)
21998 "Create a single property list from all plists in PLISTS.
21999 The process starts by copying the first list, and then setting properties
22000 from the other lists. Settings in the last list are the most significant
22001 ones and overrule settings in the other lists."
22002 (let ((rtn (copy-sequence (pop plists)))
22003 p v ls)
22004 (while plists
22005 (setq ls (pop plists))
22006 (while ls
22007 (setq p (pop ls) v (pop ls))
22008 (setq rtn (plist-put rtn p v))))
22009 rtn))
22011 (defun org-replace-escapes (string table)
22012 "Replace %-escapes in STRING with values in TABLE.
22013 TABLE is an association list with keys like \"%a\" and string values.
22014 The sequences in STRING may contain normal field width and padding information,
22015 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22016 so values can contain further %-escapes if they are define later in TABLE."
22017 (let ((tbl (copy-alist table))
22018 (case-fold-search nil)
22019 (pchg 0)
22020 e re rpl)
22021 (while (setq e (pop tbl))
22022 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22023 (when (and (cdr e) (string-match re (cdr e)))
22024 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22025 (safe "SREF"))
22026 (add-text-properties 0 3 (list 'sref sref) safe)
22027 (setcdr e (replace-match safe t t (cdr e)))))
22028 (while (string-match re string)
22029 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22030 (cdr e)))
22031 (setq string (replace-match rpl t t string))))
22032 (while (setq pchg (next-property-change pchg string))
22033 (let ((sref (get-text-property pchg 'sref string)))
22034 (when (and sref (string-match "SREF" string pchg))
22035 (setq string (replace-match sref t t string)))))
22036 string))
22038 (defun org-sublist (list start end)
22039 "Return a section of LIST, from START to END.
22040 Counting starts at 1."
22041 (let (rtn (c start))
22042 (setq list (nthcdr (1- start) list))
22043 (while (and list (<= c end))
22044 (push (pop list) rtn)
22045 (setq c (1+ c)))
22046 (nreverse rtn)))
22048 (defun org-find-base-buffer-visiting (file)
22049 "Like `find-buffer-visiting' but always return the base buffer and
22050 not an indirect buffer."
22051 (let ((buf (or (get-file-buffer file)
22052 (find-buffer-visiting file))))
22053 (if buf
22054 (or (buffer-base-buffer buf) buf)
22055 nil)))
22057 (defun org-image-file-name-regexp (&optional extensions)
22058 "Return regexp matching the file names of images.
22059 If EXTENSIONS is given, only match these."
22060 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22061 (image-file-name-regexp)
22062 (let ((image-file-name-extensions
22063 (or extensions
22064 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22065 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22066 (concat "\\."
22067 (regexp-opt (nconc (mapcar 'upcase
22068 image-file-name-extensions)
22069 image-file-name-extensions)
22071 "\\'"))))
22073 (defun org-file-image-p (file &optional extensions)
22074 "Return non-nil if FILE is an image."
22075 (save-match-data
22076 (string-match (org-image-file-name-regexp extensions) file)))
22078 (defun org-get-cursor-date (&optional with-time)
22079 "Return the date at cursor in as a time.
22080 This works in the calendar and in the agenda, anywhere else it just
22081 returns the current time.
22082 If WITH-TIME is non-nil, returns the time of the event at point (in
22083 the agenda) or the current time of the day."
22084 (let (date day defd tp tm hod mod)
22085 (when with-time
22086 (setq tp (get-text-property (point) 'time))
22087 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22088 (setq hod (string-to-number (match-string 1 tp))
22089 mod (string-to-number (match-string 2 tp))))
22090 (or tp (setq hod (nth 2 (decode-time (current-time)))
22091 mod (nth 1 (decode-time (current-time))))))
22092 (cond
22093 ((eq major-mode 'calendar-mode)
22094 (setq date (calendar-cursor-to-date)
22095 defd (encode-time 0 (or mod 0) (or hod 0)
22096 (nth 1 date) (nth 0 date) (nth 2 date))))
22097 ((eq major-mode 'org-agenda-mode)
22098 (setq day (get-text-property (point) 'day))
22099 (if day
22100 (setq date (calendar-gregorian-from-absolute day)
22101 defd (encode-time 0 (or mod 0) (or hod 0)
22102 (nth 1 date) (nth 0 date) (nth 2 date))))))
22103 (or defd (current-time))))
22105 (defun org-mark-subtree (&optional up)
22106 "Mark the current subtree.
22107 This puts point at the start of the current subtree, and mark at
22108 the end. If a numeric prefix UP is given, move up into the
22109 hierarchy of headlines by UP levels before marking the subtree."
22110 (interactive "P")
22111 (org-with-limited-levels
22112 (cond ((org-at-heading-p) (beginning-of-line))
22113 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22114 (t (outline-previous-visible-heading 1))))
22115 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22116 (if (org-called-interactively-p 'any)
22117 (call-interactively 'org-mark-element)
22118 (org-mark-element)))
22121 ;;; Indentation
22123 (defun org-indent-line ()
22124 "Indent line depending on context."
22125 (interactive)
22126 (let* ((pos (point))
22127 (itemp (org-at-item-p))
22128 (case-fold-search t)
22129 (org-drawer-regexp (or org-drawer-regexp "\000"))
22130 (inline-task-p (and (featurep 'org-inlinetask)
22131 (org-inlinetask-in-task-p)))
22132 (inline-re (and inline-task-p
22133 (org-inlinetask-outline-regexp)))
22134 column)
22135 (if (and orgstruct-is-++ (eq pos (point)))
22136 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22137 (indent-according-to-mode))
22138 (beginning-of-line 1)
22139 (cond
22140 ;; Headings
22141 ((looking-at org-outline-regexp) (setq column 0))
22142 ;; Footnote definition
22143 ((looking-at org-footnote-definition-re) (setq column 0))
22144 ;; Literal examples
22145 ((looking-at "[ \t]*:\\( \\|$\\)")
22146 (setq column (org-get-indentation))) ; do nothing
22147 ;; Lists
22148 ((ignore-errors (goto-char (org-in-item-p)))
22149 (setq column (if itemp
22150 (org-get-indentation)
22151 (org-list-item-body-column (point))))
22152 (goto-char pos))
22153 ;; Drawers
22154 ((and (looking-at "[ \t]*:END:")
22155 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22156 (save-excursion
22157 (goto-char (1- (match-beginning 1)))
22158 (setq column (current-column))))
22159 ;; Special blocks
22160 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22161 (save-excursion
22162 (re-search-backward
22163 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22164 (setq column (org-get-indentation (match-string 0))))
22165 ((and (not (looking-at "[ \t]*#\\+begin_"))
22166 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22167 (save-excursion
22168 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22169 (setq column
22170 (cond ((equal (downcase (match-string 1)) "src")
22171 ;; src blocks: let `org-edit-src-exit' handle them
22172 (org-get-indentation))
22173 ((equal (downcase (match-string 1)) "example")
22174 (max (org-get-indentation)
22175 (org-get-indentation (match-string 0))))
22177 (org-get-indentation (match-string 0))))))
22178 ;; This line has nothing special, look at the previous relevant
22179 ;; line to compute indentation
22181 (beginning-of-line 0)
22182 (while (and (not (bobp))
22183 (not (looking-at org-table-line-regexp))
22184 (not (looking-at org-drawer-regexp))
22185 ;; When point started in an inline task, do not move
22186 ;; above task starting line.
22187 (not (and inline-task-p (looking-at inline-re)))
22188 ;; Skip drawers, blocks, empty lines, verbatim,
22189 ;; comments, tables, footnotes definitions, lists,
22190 ;; inline tasks.
22191 (or (and (looking-at "[ \t]*:END:")
22192 (re-search-backward org-drawer-regexp nil t))
22193 (and (looking-at "[ \t]*#\\+end_")
22194 (re-search-backward "[ \t]*#\\+begin_"nil t))
22195 (looking-at "[ \t]*[\n:#|]")
22196 (looking-at org-footnote-definition-re)
22197 (and (not inline-task-p)
22198 (featurep 'org-inlinetask)
22199 (org-inlinetask-in-task-p)
22200 (or (org-inlinetask-goto-beginning) t))))
22201 (beginning-of-line 0))
22202 (cond
22203 ;; There was a list item above.
22204 ((ignore-errors (goto-char (org-in-item-p)))
22205 (goto-char (org-list-get-top-point (org-list-struct)))
22206 (setq column (org-get-indentation)))
22207 ;; There was an heading above.
22208 ((looking-at "\\*+[ \t]+")
22209 (if (not org-adapt-indentation)
22210 (setq column 0)
22211 (goto-char (match-end 0))
22212 (setq column (current-column))))
22213 ;; A drawer had started and is unfinished
22214 ((looking-at org-drawer-regexp)
22215 (goto-char (1- (match-beginning 1)))
22216 (setq column (current-column)))
22217 ;; Else, nothing noticeable found: get indentation and go on.
22218 (t (setq column (org-get-indentation))))))
22219 ;; Now apply indentation and move cursor accordingly
22220 (goto-char pos)
22221 (if (<= (current-column) (current-indentation))
22222 (org-indent-line-to column)
22223 (save-excursion (org-indent-line-to column)))
22224 ;; Special polishing for properties, see `org-property-format'
22225 (setq column (current-column))
22226 (beginning-of-line 1)
22227 (if (looking-at org-property-re)
22228 (replace-match (concat (match-string 4)
22229 (format org-property-format
22230 (match-string 1) (match-string 3)))
22231 t t))
22232 (org-move-to-column column))))
22234 (defun org-indent-drawer ()
22235 "Indent the drawer at point."
22236 (interactive)
22237 (let ((p (point))
22238 (e (and (save-excursion (re-search-forward ":END:" nil t))
22239 (match-end 0)))
22240 (folded
22241 (save-excursion
22242 (end-of-line)
22243 (when (overlays-at (point))
22244 (member 'invisible (overlay-properties
22245 (car (overlays-at (point)))))))))
22246 (when folded (org-cycle))
22247 (indent-for-tab-command)
22248 (while (and (move-beginning-of-line 2) (< (point) e))
22249 (indent-for-tab-command))
22250 (goto-char p)
22251 (when folded (org-cycle)))
22252 (message "Drawer at point indented"))
22254 (defun org-indent-block ()
22255 "Indent the block at point."
22256 (interactive)
22257 (let ((p (point))
22258 (case-fold-search t)
22259 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22260 (match-end 0)))
22261 (folded
22262 (save-excursion
22263 (end-of-line)
22264 (when (overlays-at (point))
22265 (member 'invisible (overlay-properties
22266 (car (overlays-at (point)))))))))
22267 (when folded (org-cycle))
22268 (indent-for-tab-command)
22269 (while (and (move-beginning-of-line 2) (< (point) e))
22270 (indent-for-tab-command))
22271 (goto-char p)
22272 (when folded (org-cycle)))
22273 (message "Block at point indented"))
22275 (defun org-indent-region (start end)
22276 "Indent region."
22277 (interactive "r")
22278 (save-excursion
22279 (let ((line-end (org-current-line end)))
22280 (goto-char start)
22281 (while (< (org-current-line) line-end)
22282 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22283 (t (call-interactively 'org-indent-line)))
22284 (move-beginning-of-line 2)))))
22287 ;;; Filling
22289 ;; We use our own fill-paragraph and auto-fill functions.
22291 ;; `org-fill-paragraph' relies on adaptive filling and context
22292 ;; checking. Appropriate `fill-prefix' is computed with
22293 ;; `org-adaptive-fill-function'.
22295 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22296 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22297 ;; `org-adaptive-fill-function' value. Internally,
22298 ;; `org-comment-line-break-function' breaks the line.
22300 ;; `org-setup-filling' installs filling and auto-filling related
22301 ;; variables during `org-mode' initialization.
22303 (defvar org-element-paragraph-separate) ; org-element.el
22304 (defun org-setup-filling ()
22305 (require 'org-element)
22306 ;; Prevent auto-fill from inserting unwanted new items.
22307 (when (boundp 'fill-nobreak-predicate)
22308 (org-set-local
22309 'fill-nobreak-predicate
22310 (org-uniquify
22311 (append fill-nobreak-predicate
22312 '(org-fill-line-break-nobreak-p
22313 org-fill-paragraph-with-timestamp-nobreak-p)))))
22314 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22315 (org-set-local 'paragraph-start paragraph-ending)
22316 (org-set-local 'paragraph-separate paragraph-ending))
22317 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22318 (org-set-local 'auto-fill-inhibit-regexp nil)
22319 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22320 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22321 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22323 (defun org-fill-line-break-nobreak-p ()
22324 "Non-nil when a new line at point would create an Org line break."
22325 (save-excursion
22326 (skip-chars-backward "[ \t]")
22327 (skip-chars-backward "\\\\")
22328 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22330 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22331 "Non-nil when a new line at point would split a timestamp."
22332 (and (org-at-timestamp-p t)
22333 (not (looking-at org-ts-regexp-both))))
22335 (declare-function message-in-body-p "message" ())
22336 (defvar orgtbl-line-start-regexp) ; From org-table.el
22337 (defun org-adaptive-fill-function ()
22338 "Compute a fill prefix for the current line.
22339 Return fill prefix, as a string, or nil if current line isn't
22340 meant to be filled. For convenience, if `adaptive-fill-regexp'
22341 matches in paragraphs or comments, use it."
22342 (catch 'exit
22343 (when (derived-mode-p 'message-mode)
22344 (save-excursion
22345 (beginning-of-line)
22346 (cond ((or (not (message-in-body-p))
22347 (looking-at orgtbl-line-start-regexp))
22348 (throw 'exit nil))
22349 ((looking-at message-cite-prefix-regexp)
22350 (throw 'exit (match-string-no-properties 0)))
22351 ((looking-at org-outline-regexp)
22352 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22353 (org-with-wide-buffer
22354 (let* ((p (line-beginning-position))
22355 (element (save-excursion
22356 (beginning-of-line)
22357 (or (ignore-errors (org-element-at-point))
22358 (user-error "An element cannot be parsed line %d"
22359 (line-number-at-pos (point))))))
22360 (type (org-element-type element))
22361 (post-affiliated (org-element-property :post-affiliated element)))
22362 (unless (and post-affiliated (< p post-affiliated))
22363 (case type
22364 (comment
22365 (save-excursion
22366 (beginning-of-line)
22367 (looking-at "[ \t]*")
22368 (concat (match-string 0) "# ")))
22369 (footnote-definition "")
22370 ((item plain-list)
22371 (make-string (org-list-item-body-column
22372 (or post-affiliated
22373 (org-element-property :begin element)))
22374 ? ))
22375 (paragraph
22376 ;; Fill prefix is usually the same as the current line,
22377 ;; unless the paragraph is at the beginning of an item.
22378 (let ((parent (org-element-property :parent element)))
22379 (save-excursion
22380 (beginning-of-line)
22381 (cond ((eq (org-element-type parent) 'item)
22382 (make-string (org-list-item-body-column
22383 (org-element-property :begin parent))
22384 ? ))
22385 ((and adaptive-fill-regexp
22386 ;; Locally disable
22387 ;; `adaptive-fill-function' to let
22388 ;; `fill-context-prefix' handle
22389 ;; `adaptive-fill-regexp' variable.
22390 (let (adaptive-fill-function)
22391 (fill-context-prefix
22392 post-affiliated
22393 (org-element-property :end element)))))
22394 ((looking-at "[ \t]+") (match-string 0))
22395 (t "")))))
22396 (comment-block
22397 ;; Only fill contents if P is within block boundaries.
22398 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22399 (forward-line)
22400 (point)))
22401 (cend (save-excursion
22402 (goto-char (org-element-property :end element))
22403 (skip-chars-backward " \r\t\n")
22404 (line-beginning-position))))
22405 (when (and (>= p cbeg) (< p cend))
22406 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22407 (match-string 0)
22408 ""))))))))))
22410 (declare-function message-goto-body "message" ())
22411 (defvar message-cite-prefix-regexp) ; From message.el
22412 (defun org-fill-paragraph (&optional justify)
22413 "Fill element at point, when applicable.
22415 This function only applies to comment blocks, comments, example
22416 blocks and paragraphs. Also, as a special case, re-align table
22417 when point is at one.
22419 If JUSTIFY is non-nil (interactively, with prefix argument),
22420 justify as well. If `sentence-end-double-space' is non-nil, then
22421 period followed by one space does not end a sentence, so don't
22422 break a line there. The variable `fill-column' controls the
22423 width for filling.
22425 For convenience, when point is at a plain list, an item or
22426 a footnote definition, try to fill the first paragraph within."
22427 (interactive)
22428 (if (and (derived-mode-p 'message-mode)
22429 (or (not (message-in-body-p))
22430 (save-excursion (move-beginning-of-line 1)
22431 (looking-at message-cite-prefix-regexp))))
22432 ;; First ensure filling is correct in message-mode.
22433 (let ((fill-paragraph-function
22434 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22435 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22436 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22437 (paragraph-separate
22438 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22439 (fill-paragraph nil))
22440 (with-syntax-table org-mode-transpose-word-syntax-table
22441 ;; Move to end of line in order to get the first paragraph
22442 ;; within a plain list or a footnote definition.
22443 (let ((element (save-excursion
22444 (end-of-line)
22445 (or (ignore-errors (org-element-at-point))
22446 (user-error "An element cannot be parsed line %d"
22447 (line-number-at-pos (point)))))))
22448 ;; First check if point is in a blank line at the beginning of
22449 ;; the buffer. In that case, ignore filling.
22450 (case (org-element-type element)
22451 ;; Use major mode filling function is src blocks.
22452 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22453 ;; Align Org tables, leave table.el tables as-is.
22454 (table-row (org-table-align) t)
22455 (table
22456 (when (eq (org-element-property :type element) 'org)
22457 (save-excursion
22458 (goto-char (org-element-property :post-affiliated element))
22459 (org-table-align)))
22461 (paragraph
22462 ;; Paragraphs may contain `line-break' type objects.
22463 (let ((beg (max (point-min)
22464 (org-element-property :contents-begin element)))
22465 (end (min (point-max)
22466 (org-element-property :contents-end element))))
22467 ;; Do nothing if point is at an affiliated keyword.
22468 (if (< (line-end-position) beg) t
22469 (when (derived-mode-p 'message-mode)
22470 ;; In `message-mode', do not fill following citation
22471 ;; in current paragraph nor text before message body.
22472 (let ((body-start (save-excursion (message-goto-body))))
22473 (when body-start (setq beg (max body-start beg))))
22474 (when (save-excursion
22475 (re-search-forward
22476 (concat "^" message-cite-prefix-regexp) end t))
22477 (setq end (match-beginning 0))))
22478 ;; Fill paragraph, taking line breaks into account.
22479 ;; For that, slice the paragraph using line breaks as
22480 ;; separators, and fill the parts in reverse order to
22481 ;; avoid messing with markers.
22482 (save-excursion
22483 (goto-char end)
22484 (mapc
22485 (lambda (pos)
22486 (fill-region-as-paragraph pos (point) justify)
22487 (goto-char pos))
22488 ;; Find the list of ending positions for line breaks
22489 ;; in the current paragraph. Add paragraph
22490 ;; beginning to include first slice.
22491 (nreverse
22492 (cons beg
22493 (org-element-map
22494 (org-element--parse-objects
22495 beg end nil (org-element-restriction 'paragraph))
22496 'line-break
22497 (lambda (lb) (org-element-property :end lb)))))))
22498 t)))
22499 ;; Contents of `comment-block' type elements should be
22500 ;; filled as plain text, but only if point is within block
22501 ;; markers.
22502 (comment-block
22503 (let* ((case-fold-search t)
22504 (beg (save-excursion
22505 (goto-char (org-element-property :begin element))
22506 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22507 (forward-line)
22508 (point)))
22509 (end (save-excursion
22510 (goto-char (org-element-property :end element))
22511 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22512 (line-beginning-position))))
22513 (if (or (< (point) beg) (> (point) end)) t
22514 (fill-region-as-paragraph
22515 (save-excursion (end-of-line)
22516 (re-search-backward "^[ \t]*$" beg 'move)
22517 (line-beginning-position))
22518 (save-excursion (beginning-of-line)
22519 (re-search-forward "^[ \t]*$" end 'move)
22520 (line-beginning-position))
22521 justify))))
22522 ;; Fill comments.
22523 (comment
22524 (let ((begin (org-element-property :post-affiliated element))
22525 (end (org-element-property :end element)))
22526 (when (and (>= (point) begin) (<= (point) end))
22527 (let ((begin (save-excursion
22528 (end-of-line)
22529 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22530 (progn (forward-line) (point))
22531 begin)))
22532 (end (save-excursion
22533 (end-of-line)
22534 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22535 (1- (line-beginning-position))
22536 (skip-chars-backward " \r\t\n")
22537 (line-end-position)))))
22538 ;; Do not fill comments when at a blank line.
22539 (when (> end begin)
22540 (let ((fill-prefix
22541 (save-excursion
22542 (beginning-of-line)
22543 (looking-at "[ \t]*#")
22544 (let ((comment-prefix (match-string 0)))
22545 (goto-char (match-end 0))
22546 (if (looking-at adaptive-fill-regexp)
22547 (concat comment-prefix (match-string 0))
22548 (concat comment-prefix " "))))))
22549 (save-excursion
22550 (fill-region-as-paragraph begin end justify))))))
22552 ;; Ignore every other element.
22553 (otherwise t))))))
22555 (defun org-auto-fill-function ()
22556 "Auto-fill function."
22557 ;; Check if auto-filling is meaningful.
22558 (let ((fc (current-fill-column)))
22559 (when (and fc (> (current-column) fc))
22560 (let* ((fill-prefix (org-adaptive-fill-function))
22561 ;; Enforce empty fill prefix, if required. Otherwise, it
22562 ;; will be computed again.
22563 (adaptive-fill-mode (not (equal fill-prefix ""))))
22564 (when fill-prefix (do-auto-fill))))))
22566 (defun org-comment-line-break-function (&optional soft)
22567 "Break line at point and indent, continuing comment if within one.
22568 The inserted newline is marked hard if variable
22569 `use-hard-newlines' is true, unless optional argument SOFT is
22570 non-nil."
22571 (if soft (insert-and-inherit ?\n) (newline 1))
22572 (save-excursion (forward-char -1) (delete-horizontal-space))
22573 (delete-horizontal-space)
22574 (indent-to-left-margin)
22575 (insert-before-markers-and-inherit fill-prefix))
22578 ;;; Comments
22580 ;; Org comments syntax is quite complex. It requires the entire line
22581 ;; to be just a comment. Also, even with the right syntax at the
22582 ;; beginning of line, some some elements (i.e. verse-block or
22583 ;; example-block) don't accept comments. Usual Emacs comment commands
22584 ;; cannot cope with those requirements. Therefore, Org replaces them.
22586 ;; Org still relies on `comment-dwim', but cannot trust
22587 ;; `comment-only-p'. So, `comment-region-function' and
22588 ;; `uncomment-region-function' both point
22589 ;; to`org-comment-or-uncomment-region'. Eventually,
22590 ;; `org-insert-comment' takes care of insertion of comments at the
22591 ;; beginning of line.
22593 ;; `org-setup-comments-handling' install comments related variables
22594 ;; during `org-mode' initialization.
22596 (defun org-setup-comments-handling ()
22597 (interactive)
22598 (org-set-local 'comment-use-syntax nil)
22599 (org-set-local 'comment-start "# ")
22600 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22601 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22602 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22603 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22605 (defun org-insert-comment ()
22606 "Insert an empty comment above current line.
22607 If the line is empty, insert comment at its beginning. When
22608 point is within a source block, comment according to the related
22609 major mode."
22610 (if (let ((element (org-element-at-point)))
22611 (and (eq (org-element-type element) 'src-block)
22612 (< (save-excursion
22613 (goto-char (org-element-property :post-affiliated element))
22614 (line-end-position))
22615 (point))
22616 (> (save-excursion
22617 (goto-char (org-element-property :end element))
22618 (skip-chars-backward " \r\t\n")
22619 (line-beginning-position))
22620 (point))))
22621 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22622 (beginning-of-line)
22623 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
22624 (open-line 1))
22625 (org-indent-line)
22626 (insert "# ")))
22628 (defvar comment-empty-lines) ; From newcomment.el.
22629 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22630 "Comment or uncomment each non-blank line in the region.
22631 Uncomment each non-blank line between BEG and END if it only
22632 contains commented lines. Otherwise, comment them. If region is
22633 strictly within a source block, use appropriate comment syntax."
22634 (if (let ((element (org-element-at-point)))
22635 (and (eq (org-element-type element) 'src-block)
22636 (< (save-excursion
22637 (goto-char (org-element-property :post-affiliated element))
22638 (line-end-position))
22639 beg)
22640 (>= (save-excursion
22641 (goto-char (org-element-property :end element))
22642 (skip-chars-backward " \r\t\n")
22643 (line-beginning-position))
22644 end)))
22645 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22646 (save-restriction
22647 ;; Restrict region
22648 (narrow-to-region (save-excursion (goto-char beg)
22649 (skip-chars-forward " \r\t\n" end)
22650 (line-beginning-position))
22651 (save-excursion (goto-char end)
22652 (skip-chars-backward " \r\t\n" beg)
22653 (line-end-position)))
22654 (let ((uncommentp
22655 ;; UNCOMMENTP is non-nil when every non blank line between
22656 ;; BEG and END is a comment.
22657 (save-excursion
22658 (goto-char (point-min))
22659 (while (and (not (eobp))
22660 (let ((element (org-element-at-point)))
22661 (and (eq (org-element-type element) 'comment)
22662 (goto-char (min (point-max)
22663 (org-element-property
22664 :end element)))))))
22665 (eobp))))
22666 (if uncommentp
22667 ;; Only blank lines and comments in region: uncomment it.
22668 (save-excursion
22669 (goto-char (point-min))
22670 (while (not (eobp))
22671 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22672 (replace-match "" nil nil nil 1))
22673 (forward-line)))
22674 ;; Comment each line in region.
22675 (let ((min-indent (point-max)))
22676 ;; First find the minimum indentation across all lines.
22677 (save-excursion
22678 (goto-char (point-min))
22679 (while (and (not (eobp)) (not (zerop min-indent)))
22680 (unless (looking-at "[ \t]*$")
22681 (setq min-indent (min min-indent (current-indentation))))
22682 (forward-line)))
22683 ;; Then loop over all lines.
22684 (save-excursion
22685 (goto-char (point-min))
22686 (while (not (eobp))
22687 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22688 ;; Don't get fooled by invisible text (e.g. link path)
22689 ;; when moving to column MIN-INDENT.
22690 (let ((buffer-invisibility-spec nil))
22691 (org-move-to-column min-indent t))
22692 (insert comment-start))
22693 (forward-line)))))))))
22695 (defun org-comment-dwim (arg)
22696 (interactive "*P")
22697 "Call `comment-dwim' within a source edit buffer if needed."
22698 (if (org-in-src-block-p)
22699 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22700 (call-interactively #'comment-dwim)))
22703 ;;; Planning
22705 ;; This section contains tools to operate on timestamp objects, as
22706 ;; returned by, e.g. `org-element-context'.
22708 (defun org-timestamp-has-time-p (timestamp)
22709 "Non-nil when TIMESTAMP has a time specified."
22710 (org-element-property :hour-start timestamp))
22712 (defun org-timestamp-format (timestamp format &optional end utc)
22713 "Format a TIMESTAMP element into a string.
22715 FORMAT is a format specifier to be passed to
22716 `format-time-string'.
22718 When optional argument END is non-nil, use end of date-range or
22719 time-range, if possible.
22721 When optional argument UTC is non-nil, time will be expressed as
22722 Universal Time."
22723 (format-time-string
22724 format
22725 (apply 'encode-time
22726 (cons 0
22727 (mapcar
22728 (lambda (prop) (or (org-element-property prop timestamp) 0))
22729 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22730 '(:minute-start :hour-start :day-start :month-start
22731 :year-start)))))
22732 utc))
22734 (defun org-timestamp-split-range (timestamp &optional end)
22735 "Extract a timestamp object from a date or time range.
22737 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22738 the end of the range. Otherwise, extract its start.
22740 Return a new timestamp object sharing the same parent as
22741 TIMESTAMP."
22742 (let ((type (org-element-property :type timestamp)))
22743 (if (memq type '(active inactive diary)) timestamp
22744 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22745 ;; Set new type.
22746 (org-element-put-property
22747 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22748 ;; Copy start properties over end properties if END is
22749 ;; non-nil. Otherwise, copy end properties over `start' ones.
22750 (let ((p-alist '((:minute-start . :minute-end)
22751 (:hour-start . :hour-end)
22752 (:day-start . :day-end)
22753 (:month-start . :month-end)
22754 (:year-start . :year-end))))
22755 (dolist (p-cell p-alist)
22756 (org-element-put-property
22757 split-ts
22758 (funcall (if end 'car 'cdr) p-cell)
22759 (org-element-property
22760 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22761 ;; Eventually refresh `:raw-value'.
22762 (org-element-put-property split-ts :raw-value nil)
22763 (org-element-put-property
22764 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22766 (defun org-timestamp-translate (timestamp &optional boundary)
22767 "Apply `org-translate-time' on a TIMESTAMP object.
22768 When optional argument BOUNDARY is non-nil, it is either the
22769 symbol `start' or `end'. In this case, only translate the
22770 starting or ending part of TIMESTAMP if it is a date or time
22771 range. Otherwise, translate both parts."
22772 (if (and (not boundary)
22773 (memq (org-element-property :type timestamp)
22774 '(active-range inactive-range)))
22775 (concat
22776 (org-translate-time
22777 (org-element-property :raw-value
22778 (org-timestamp-split-range timestamp)))
22779 "--"
22780 (org-translate-time
22781 (org-element-property :raw-value
22782 (org-timestamp-split-range timestamp t))))
22783 (org-translate-time
22784 (org-element-property
22785 :raw-value
22786 (if (not boundary) timestamp
22787 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22791 ;;; Other stuff.
22793 (defun org-toggle-fixed-width-section (arg)
22794 "Toggle the fixed-width export.
22795 If there is no active region, the QUOTE keyword at the current headline is
22796 inserted or removed. When present, it causes the text between this headline
22797 and the next to be exported as fixed-width text, and unmodified.
22798 If there is an active region, this command adds or removes a colon as the
22799 first character of this line. If the first character of a line is a colon,
22800 this line is also exported in fixed-width font."
22801 (interactive "P")
22802 (let* ((cc 0)
22803 (regionp (org-region-active-p))
22804 (beg (if regionp (region-beginning) (point)))
22805 (end (if regionp (region-end)))
22806 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22807 (case-fold-search nil)
22808 (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
22809 off)
22810 (if regionp
22811 (save-excursion
22812 (goto-char beg)
22813 (setq cc (current-column))
22814 (beginning-of-line 1)
22815 (setq off (looking-at re))
22816 (while (> nlines 0)
22817 (setq nlines (1- nlines))
22818 (beginning-of-line 1)
22819 (cond
22820 (arg
22821 (org-move-to-column cc t)
22822 (insert ": \n")
22823 (forward-line -1))
22824 ((and off (looking-at re))
22825 (replace-match "" t t nil 1))
22826 ((not off) (org-move-to-column cc t) (insert ": ")))
22827 (forward-line 1)))
22828 (save-excursion
22829 (org-back-to-heading)
22830 (cond
22831 ((looking-at (format org-heading-keyword-regexp-format
22832 org-quote-string))
22833 (goto-char (match-end 1))
22834 (looking-at (concat " +" org-quote-string))
22835 (replace-match "" t t)
22836 (when (eolp) (insert " ")))
22837 ((looking-at org-outline-regexp)
22838 (goto-char (match-end 0))
22839 (insert org-quote-string " ")))))))
22841 (defun org-reftex-citation ()
22842 "Use reftex-citation to insert a citation into the buffer.
22843 This looks for a line like
22845 #+BIBLIOGRAPHY: foo plain option:-d
22847 and derives from it that foo.bib is the bibliography file relevant
22848 for this document. It then installs the necessary environment for RefTeX
22849 to work in this buffer and calls `reftex-citation' to insert a citation
22850 into the buffer.
22852 Export of such citations to both LaTeX and HTML is handled by the contributed
22853 package ox-bibtex by Taru Karttunen."
22854 (interactive)
22855 (let ((reftex-docstruct-symbol 'rds)
22856 (reftex-cite-format "\\cite{%l}")
22857 rds bib)
22858 (save-excursion
22859 (save-restriction
22860 (widen)
22861 (let ((case-fold-search t)
22862 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22863 (if (not (save-excursion
22864 (or (re-search-forward re nil t)
22865 (re-search-backward re nil t))))
22866 (error "No bibliography defined in file")
22867 (setq bib (concat (match-string 1) ".bib")
22868 rds (list (list 'bib bib)))))))
22869 (call-interactively 'reftex-citation)))
22871 ;;;; Functions extending outline functionality
22873 (defun org-beginning-of-line (&optional arg)
22874 "Go to the beginning of the current line. If that is invisible, continue
22875 to a visible line beginning. This makes the function of C-a more intuitive.
22876 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22877 first attempt, and only move to after the tags when the cursor is already
22878 beyond the end of the headline."
22879 (interactive "P")
22880 (let ((pos (point))
22881 (special (if (consp org-special-ctrl-a/e)
22882 (car org-special-ctrl-a/e)
22883 org-special-ctrl-a/e))
22884 deactivate-mark refpos)
22885 (if (org-bound-and-true-p visual-line-mode)
22886 (beginning-of-visual-line 1)
22887 (beginning-of-line 1))
22888 (if (and arg (fboundp 'move-beginning-of-line))
22889 (call-interactively 'move-beginning-of-line)
22890 (if (bobp)
22892 (backward-char 1)
22893 (if (org-truely-invisible-p)
22894 (while (and (not (bobp)) (org-truely-invisible-p))
22895 (backward-char 1)
22896 (beginning-of-line 1))
22897 (forward-char 1))))
22898 (when special
22899 (cond
22900 ((and (looking-at org-complex-heading-regexp)
22901 (= (char-after (match-end 1)) ?\ ))
22902 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22903 (point-at-eol)))
22904 (goto-char
22905 (if (eq special t)
22906 (cond ((> pos refpos) refpos)
22907 ((= pos (point)) refpos)
22908 (t (point)))
22909 (cond ((> pos (point)) (point))
22910 ((not (eq last-command this-command)) (point))
22911 (t refpos)))))
22912 ((org-at-item-p)
22913 ;; Being at an item and not looking at an the item means point
22914 ;; was previously moved to beginning of a visual line, which
22915 ;; doesn't contain the item. Therefore, do nothing special,
22916 ;; just stay here.
22917 (when (looking-at org-list-full-item-re)
22918 ;; Set special position at first white space character after
22919 ;; bullet, and check-box, if any.
22920 (let ((after-bullet
22921 (let ((box (match-end 3)))
22922 (if (not box) (match-end 1)
22923 (let ((after (char-after box)))
22924 (if (and after (= after ? )) (1+ box) box))))))
22925 ;; Special case: Move point to special position when
22926 ;; currently after it or at beginning of line.
22927 (if (eq special t)
22928 (when (or (> pos after-bullet) (= (point) pos))
22929 (goto-char after-bullet))
22930 ;; Reversed case: Move point to special position when
22931 ;; point was already at beginning of line and command is
22932 ;; repeated.
22933 (when (and (= (point) pos) (eq last-command this-command))
22934 (goto-char after-bullet))))))))
22935 (org-no-warnings
22936 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22937 (setq disable-point-adjustment
22938 (or (not (invisible-p (point)))
22939 (not (invisible-p (max (point-min) (1- (point))))))))
22941 (defun org-end-of-line (&optional arg)
22942 "Go to the end of the line.
22943 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22944 tags on the first attempt, and only move to after the tags when
22945 the cursor is already beyond the end of the headline."
22946 (interactive "P")
22947 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22948 org-special-ctrl-a/e))
22949 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22950 'end-of-visual-line)
22951 ((fboundp 'move-end-of-line) 'move-end-of-line)
22952 (t 'end-of-line)))
22953 deactivate-mark)
22954 (if (or (not special) arg) (call-interactively move-fun)
22955 (let* ((element (save-excursion (beginning-of-line)
22956 (org-element-at-point)))
22957 (type (org-element-type element)))
22958 (cond
22959 ((memq type '(headline inlinetask))
22960 (let ((pos (point)))
22961 (beginning-of-line 1)
22962 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
22963 (if (eq special t)
22964 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
22965 (goto-char (match-beginning 1))
22966 (goto-char (match-end 0)))
22967 (if (or (< pos (match-end 0))
22968 (not (eq this-command last-command)))
22969 (goto-char (match-end 0))
22970 (goto-char (match-beginning 1))))
22971 (call-interactively move-fun))))
22972 ((outline-invisible-p (line-end-position))
22973 ;; If element is hidden, `move-end-of-line' would put point
22974 ;; after it. Use `end-of-line' to stay on current line.
22975 (call-interactively 'end-of-line))
22976 (t (call-interactively move-fun)))))
22977 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
22978 (setq disable-point-adjustment
22979 (or (not (invisible-p (point)))
22980 (not (invisible-p (max (point-min) (1- (point))))))))
22982 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
22983 (define-key org-mode-map "\C-e" 'org-end-of-line)
22985 (defun org-backward-sentence (&optional arg)
22986 "Go to beginning of sentence, or beginning of table field.
22987 This will call `backward-sentence' or `org-table-beginning-of-field',
22988 depending on context."
22989 (interactive "P")
22990 (cond
22991 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
22992 (t (call-interactively 'backward-sentence))))
22994 (defun org-forward-sentence (&optional arg)
22995 "Go to end of sentence, or end of table field.
22996 This will call `forward-sentence' or `org-table-end-of-field',
22997 depending on context."
22998 (interactive "P")
22999 (cond
23000 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23001 (t (call-interactively 'forward-sentence))))
23003 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23004 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23006 (defun org-kill-line (&optional arg)
23007 "Kill line, to tags or end of line."
23008 (interactive "P")
23009 (cond
23010 ((or (not org-special-ctrl-k)
23011 (bolp)
23012 (not (org-at-heading-p)))
23013 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23014 org-ctrl-k-protect-subtree)
23015 (if (or (eq org-ctrl-k-protect-subtree 'error)
23016 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23017 (user-error "C-k aborted as it would kill a hidden subtree")))
23018 (call-interactively
23019 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23020 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23021 (kill-region (point) (match-beginning 1))
23022 (org-set-tags nil t))
23023 (t (kill-region (point) (point-at-eol)))))
23025 (define-key org-mode-map "\C-k" 'org-kill-line)
23027 (defun org-yank (&optional arg)
23028 "Yank. If the kill is a subtree, treat it specially.
23029 This command will look at the current kill and check if is a single
23030 subtree, or a series of subtrees[1]. If it passes the test, and if the
23031 cursor is at the beginning of a line or after the stars of a currently
23032 empty headline, then the yank is handled specially. How exactly depends
23033 on the value of the following variables, both set by default.
23035 org-yank-folded-subtrees
23036 When set, the subtree(s) will be folded after insertion, but only
23037 if doing so would now swallow text after the yanked text.
23039 org-yank-adjusted-subtrees
23040 When set, the subtree will be promoted or demoted in order to
23041 fit into the local outline tree structure, which means that the level
23042 will be adjusted so that it becomes the smaller one of the two
23043 *visible* surrounding headings.
23045 Any prefix to this command will cause `yank' to be called directly with
23046 no special treatment. In particular, a simple \\[universal-argument] prefix \
23047 will just
23048 plainly yank the text as it is.
23050 \[1] The test checks if the first non-white line is a heading
23051 and if there are no other headings with fewer stars."
23052 (interactive "P")
23053 (org-yank-generic 'yank arg))
23055 (defun org-yank-generic (command arg)
23056 "Perform some yank-like command.
23058 This function implements the behavior described in the `org-yank'
23059 documentation. However, it has been generalized to work for any
23060 interactive command with similar behavior."
23062 ;; pretend to be command COMMAND
23063 (setq this-command command)
23065 (if arg
23066 (call-interactively command)
23068 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23069 (and (org-kill-is-subtree-p)
23070 (or (bolp)
23071 (and (looking-at "[ \t]*$")
23072 (string-match
23073 "\\`\\*+\\'"
23074 (buffer-substring (point-at-bol) (point)))))))
23075 swallowp)
23076 (cond
23077 ((and subtreep org-yank-folded-subtrees)
23078 (let ((beg (point))
23079 end)
23080 (if (and subtreep org-yank-adjusted-subtrees)
23081 (org-paste-subtree nil nil 'for-yank)
23082 (call-interactively command))
23084 (setq end (point))
23085 (goto-char beg)
23086 (when (and (bolp) subtreep
23087 (not (setq swallowp
23088 (org-yank-folding-would-swallow-text beg end))))
23089 (org-with-limited-levels
23090 (or (looking-at org-outline-regexp)
23091 (re-search-forward org-outline-regexp-bol end t))
23092 (while (and (< (point) end) (looking-at org-outline-regexp))
23093 (hide-subtree)
23094 (org-cycle-show-empty-lines 'folded)
23095 (condition-case nil
23096 (outline-forward-same-level 1)
23097 (error (goto-char end))))))
23098 (when swallowp
23099 (message
23100 "Inserted text not folded because that would swallow text"))
23102 (goto-char end)
23103 (skip-chars-forward " \t\n\r")
23104 (beginning-of-line 1)
23105 (push-mark beg 'nomsg)))
23106 ((and subtreep org-yank-adjusted-subtrees)
23107 (let ((beg (point-at-bol)))
23108 (org-paste-subtree nil nil 'for-yank)
23109 (push-mark beg 'nomsg)))
23111 (call-interactively command))))))
23113 (defun org-yank-folding-would-swallow-text (beg end)
23114 "Would hide-subtree at BEG swallow any text after END?"
23115 (let (level)
23116 (org-with-limited-levels
23117 (save-excursion
23118 (goto-char beg)
23119 (when (or (looking-at org-outline-regexp)
23120 (re-search-forward org-outline-regexp-bol end t))
23121 (setq level (org-outline-level)))
23122 (goto-char end)
23123 (skip-chars-forward " \t\r\n\v\f")
23124 (if (or (eobp)
23125 (and (bolp) (looking-at org-outline-regexp)
23126 (<= (org-outline-level) level)))
23127 nil ; Nothing would be swallowed
23128 t))))) ; something would swallow
23130 (define-key org-mode-map "\C-y" 'org-yank)
23132 (defun org-truely-invisible-p ()
23133 "Check if point is at a character currently not visible.
23134 This version does not only check the character property, but also
23135 `visible-mode'."
23136 ;; Early versions of noutline don't have `outline-invisible-p'.
23137 (if (org-bound-and-true-p visible-mode)
23139 (outline-invisible-p)))
23141 (defun org-invisible-p2 ()
23142 "Check if point is at a character currently not visible."
23143 (save-excursion
23144 (if (and (eolp) (not (bobp))) (backward-char 1))
23145 ;; Early versions of noutline don't have `outline-invisible-p'.
23146 (outline-invisible-p)))
23148 (defun org-back-to-heading (&optional invisible-ok)
23149 "Call `outline-back-to-heading', but provide a better error message."
23150 (condition-case nil
23151 (outline-back-to-heading invisible-ok)
23152 (error (error "Before first headline at position %d in buffer %s"
23153 (point) (current-buffer)))))
23155 (defun org-before-first-heading-p ()
23156 "Before first heading?"
23157 (save-excursion
23158 (end-of-line)
23159 (null (re-search-backward org-outline-regexp-bol nil t))))
23161 (defun org-at-heading-p (&optional ignored)
23162 (outline-on-heading-p t))
23163 ;; Compatibility alias with Org versions < 7.8.03
23164 (defalias 'org-on-heading-p 'org-at-heading-p)
23166 (defun org-at-comment-p nil
23167 "Is cursor in a line starting with a # character?"
23168 (save-excursion
23169 (beginning-of-line)
23170 (looking-at "^#")))
23172 (defun org-at-drawer-p nil
23173 "Is cursor at a drawer keyword?"
23174 (save-excursion
23175 (move-beginning-of-line 1)
23176 (looking-at org-drawer-regexp)))
23178 (defun org-at-block-p nil
23179 "Is cursor at a block keyword?"
23180 (save-excursion
23181 (move-beginning-of-line 1)
23182 (looking-at org-block-regexp)))
23184 (defun org-point-at-end-of-empty-headline ()
23185 "If point is at the end of an empty headline, return t, else nil.
23186 If the heading only contains a TODO keyword, it is still still considered
23187 empty."
23188 (and (looking-at "[ \t]*$")
23189 (when org-todo-line-regexp
23190 (save-excursion
23191 (beginning-of-line 1)
23192 (let ((case-fold-search nil))
23193 (looking-at org-todo-line-regexp)
23194 (string= (match-string 3) ""))))))
23196 (defun org-at-heading-or-item-p ()
23197 (or (org-at-heading-p) (org-at-item-p)))
23199 (defun org-at-target-p ()
23200 (or (org-in-regexp org-radio-target-regexp)
23201 (org-in-regexp org-target-regexp)))
23202 ;; Compatibility alias with Org versions < 7.8.03
23203 (defalias 'org-on-target-p 'org-at-target-p)
23205 (defun org-up-heading-all (arg)
23206 "Move to the heading line of which the present line is a subheading.
23207 This function considers both visible and invisible heading lines.
23208 With argument, move up ARG levels."
23209 (if (fboundp 'outline-up-heading-all)
23210 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23211 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23213 (defun org-up-heading-safe ()
23214 "Move to the heading line of which the present line is a subheading.
23215 This version will not throw an error. It will return the level of the
23216 headline found, or nil if no higher level is found.
23218 Also, this function will be a lot faster than `outline-up-heading',
23219 because it relies on stars being the outline starters. This can really
23220 make a significant difference in outlines with very many siblings."
23221 (let (start-level re)
23222 (org-back-to-heading t)
23223 (setq start-level (funcall outline-level))
23224 (if (equal start-level 1)
23226 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23227 (if (re-search-backward re nil t)
23228 (funcall outline-level)))))
23230 (defun org-first-sibling-p ()
23231 "Is this heading the first child of its parents?"
23232 (interactive)
23233 (let ((re org-outline-regexp-bol)
23234 level l)
23235 (unless (org-at-heading-p t)
23236 (user-error "Not at a heading"))
23237 (setq level (funcall outline-level))
23238 (save-excursion
23239 (if (not (re-search-backward re nil t))
23241 (setq l (funcall outline-level))
23242 (< l level)))))
23244 (defun org-goto-sibling (&optional previous)
23245 "Goto the next sibling, even if it is invisible.
23246 When PREVIOUS is set, go to the previous sibling instead. Returns t
23247 when a sibling was found. When none is found, return nil and don't
23248 move point."
23249 (let ((fun (if previous 're-search-backward 're-search-forward))
23250 (pos (point))
23251 (re org-outline-regexp-bol)
23252 level l)
23253 (when (condition-case nil (org-back-to-heading t) (error nil))
23254 (setq level (funcall outline-level))
23255 (catch 'exit
23256 (or previous (forward-char 1))
23257 (while (funcall fun re nil t)
23258 (setq l (funcall outline-level))
23259 (when (< l level) (goto-char pos) (throw 'exit nil))
23260 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23261 (goto-char pos)
23262 nil))))
23264 (defun org-show-siblings ()
23265 "Show all siblings of the current headline."
23266 (save-excursion
23267 (while (org-goto-sibling) (org-flag-heading nil)))
23268 (save-excursion
23269 (while (org-goto-sibling 'previous)
23270 (org-flag-heading nil))))
23272 (defun org-goto-first-child ()
23273 "Goto the first child, even if it is invisible.
23274 Return t when a child was found. Otherwise don't move point and
23275 return nil."
23276 (let (level (pos (point)) (re org-outline-regexp-bol))
23277 (when (condition-case nil (org-back-to-heading t) (error nil))
23278 (setq level (outline-level))
23279 (forward-char 1)
23280 (if (and (re-search-forward re nil t) (> (outline-level) level))
23281 (progn (goto-char (match-beginning 0)) t)
23282 (goto-char pos) nil))))
23284 (defun org-show-hidden-entry ()
23285 "Show an entry where even the heading is hidden."
23286 (save-excursion
23287 (org-show-entry)))
23289 (defun org-flag-heading (flag &optional entry)
23290 "Flag the current heading. FLAG non-nil means make invisible.
23291 When ENTRY is non-nil, show the entire entry."
23292 (save-excursion
23293 (org-back-to-heading t)
23294 ;; Check if we should show the entire entry
23295 (if entry
23296 (progn
23297 (org-show-entry)
23298 (save-excursion
23299 (and (outline-next-heading)
23300 (org-flag-heading nil))))
23301 (outline-flag-region (max (point-min) (1- (point)))
23302 (save-excursion (outline-end-of-heading) (point))
23303 flag))))
23305 (defun org-get-next-sibling ()
23306 "Move to next heading of the same level, and return point.
23307 If there is no such heading, return nil.
23308 This is like outline-next-sibling, but invisible headings are ok."
23309 (let ((level (funcall outline-level)))
23310 (outline-next-heading)
23311 (while (and (not (eobp)) (> (funcall outline-level) level))
23312 (outline-next-heading))
23313 (if (or (eobp) (< (funcall outline-level) level))
23315 (point))))
23317 (defun org-get-last-sibling ()
23318 "Move to previous heading of the same level, and return point.
23319 If there is no such heading, return nil."
23320 (let ((opoint (point))
23321 (level (funcall outline-level)))
23322 (outline-previous-heading)
23323 (when (and (/= (point) opoint) (outline-on-heading-p t))
23324 (while (and (> (funcall outline-level) level)
23325 (not (bobp)))
23326 (outline-previous-heading))
23327 (if (< (funcall outline-level) level)
23329 (point)))))
23331 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23332 "Goto to the end of a subtree."
23333 ;; This contains an exact copy of the original function, but it uses
23334 ;; `org-back-to-heading', to make it work also in invisible
23335 ;; trees. And is uses an invisible-ok argument.
23336 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23337 ;; Furthermore, when used inside Org, finding the end of a large subtree
23338 ;; with many children and grandchildren etc, this can be much faster
23339 ;; than the outline version.
23340 (org-back-to-heading invisible-ok)
23341 (let ((first t)
23342 (level (funcall outline-level)))
23343 (if (and (derived-mode-p 'org-mode) (< level 1000))
23344 ;; A true heading (not a plain list item), in Org-mode
23345 ;; This means we can easily find the end by looking
23346 ;; only for the right number of stars. Using a regexp to do
23347 ;; this is so much faster than using a Lisp loop.
23348 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23349 (forward-char 1)
23350 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23351 ;; something else, do it the slow way
23352 (while (and (not (eobp))
23353 (or first (> (funcall outline-level) level)))
23354 (setq first nil)
23355 (outline-next-heading)))
23356 (unless to-heading
23357 (if (memq (preceding-char) '(?\n ?\^M))
23358 (progn
23359 ;; Go to end of line before heading
23360 (forward-char -1)
23361 (if (memq (preceding-char) '(?\n ?\^M))
23362 ;; leave blank line before heading
23363 (forward-char -1))))))
23364 (point))
23366 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23367 "Use Org version in org-mode, for dramatic speed-up."
23368 (if (derived-mode-p 'org-mode)
23369 (progn
23370 (org-end-of-subtree nil t)
23371 (unless (eobp) (backward-char 1)))
23372 ad-do-it))
23374 (defun org-end-of-meta-data-and-drawers ()
23375 "Jump to the first text after meta data and drawers in the current entry.
23376 This will move over empty lines, lines with planning time stamps,
23377 clocking lines, and drawers."
23378 (org-back-to-heading t)
23379 (let ((end (save-excursion (outline-next-heading) (point)))
23380 (re (concat "\\(" org-drawer-regexp "\\)"
23381 "\\|" "[ \t]*" org-keyword-time-regexp)))
23382 (forward-line 1)
23383 (while (re-search-forward re end t)
23384 (if (not (match-end 1))
23385 ;; empty or planning line
23386 (forward-line 1)
23387 ;; a drawer, find the end
23388 (re-search-forward "^[ \t]*:END:" end 'move)
23389 (forward-line 1)))
23390 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23391 (point)))
23393 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23394 "Move forward to the ARG'th subheading at same level as this one.
23395 Stop at the first and last subheadings of a superior heading.
23396 Normally this only looks at visible headings, but when INVISIBLE-OK is
23397 non-nil it will also look at invisible ones."
23398 (interactive "p")
23399 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23400 (if (and arg (< arg 0))
23401 (goto-char (point-min))
23402 (outline-next-heading))
23403 (org-at-heading-p)
23404 (let ((level (- (match-end 0) (match-beginning 0) 1))
23405 (f (if (and arg (< arg 0))
23406 're-search-backward
23407 're-search-forward))
23408 (count (if arg (abs arg) 1))
23409 (result (point)))
23410 (while (and (prog1 (> count 0)
23411 (forward-char (if (and arg (< arg 0)) -1 1)))
23412 (funcall f org-outline-regexp-bol nil 'move))
23413 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23414 (cond ((< l level) (setq count 0))
23415 ((and (= l level)
23416 (or invisible-ok
23417 (progn
23418 (goto-char (line-beginning-position))
23419 (not (outline-invisible-p)))))
23420 (setq count (1- count))
23421 (when (eq l level)
23422 (setq result (point)))))))
23423 (goto-char result))
23424 (beginning-of-line 1)))
23426 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23427 "Move backward to the ARG'th subheading at same level as this one.
23428 Stop at the first and last subheadings of a superior heading."
23429 (interactive "p")
23430 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23432 (defun org-next-block (arg &optional backward block-regexp)
23433 "Jump to the next block.
23434 With a prefix argument ARG, jump forward ARG many source blocks.
23435 When BACKWARD is non-nil, jump to the previous block.
23436 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23437 (interactive "p")
23438 (let ((re (or block-regexp org-block-regexp))
23439 (re-search-fn (or (and backward 're-search-backward)
23440 're-search-forward)))
23441 (if (looking-at re) (forward-char 1))
23442 (condition-case nil
23443 (funcall re-search-fn re nil nil arg)
23444 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23445 (goto-char (match-beginning 0)) (org-show-context)))
23447 (defun org-previous-block (arg &optional block-regexp)
23448 "Jump to the previous block.
23449 With a prefix argument ARG, jump backward ARG many source blocks.
23450 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23451 (interactive "p")
23452 (org-next-block arg t block-regexp))
23454 (defun org-forward-paragraph ()
23455 "Move forward to beginning of next paragraph or equivalent.
23457 The function moves point to the beginning of the next visible
23458 structural element, which can be a paragraph, a table, a list
23459 item, etc. It also provides some special moves for convenience:
23461 - On an affiliated keyword, jump to the beginning of the
23462 relative element.
23463 - On an item or a footnote definition, move to the second
23464 element inside, if any.
23465 - On a table or a property drawer, jump after it.
23466 - On a verse or source block, stop after blank lines."
23467 (interactive)
23468 (when (eobp) (user-error "Cannot move further down"))
23469 (let* ((deactivate-mark nil)
23470 (element (org-element-at-point))
23471 (type (org-element-type element))
23472 (post-affiliated (org-element-property :post-affiliated element))
23473 (contents-begin (org-element-property :contents-begin element))
23474 (contents-end (org-element-property :contents-end element))
23475 (end (let ((end (org-element-property :end element)) (parent element))
23476 (while (and (setq parent (org-element-property :parent parent))
23477 (= (org-element-property :contents-end parent) end))
23478 (setq end (org-element-property :end parent)))
23479 end)))
23480 (cond ((not element)
23481 (skip-chars-forward " \r\t\n")
23482 (or (eobp) (beginning-of-line)))
23483 ;; On affiliated keywords, move to element's beginning.
23484 ((and post-affiliated (< (point) post-affiliated))
23485 (goto-char post-affiliated))
23486 ;; At a table row, move to the end of the table. Similarly,
23487 ;; at a node property, move to the end of the property
23488 ;; drawer.
23489 ((memq type '(node-property table-row))
23490 (goto-char (org-element-property
23491 :end (org-element-property :parent element))))
23492 ((memq type '(property-drawer table)) (goto-char end))
23493 ;; Consider blank lines as separators in verse and source
23494 ;; blocks to ease editing.
23495 ((memq type '(src-block verse-block))
23496 (when (eq type 'src-block)
23497 (setq contents-end
23498 (save-excursion (goto-char end)
23499 (skip-chars-backward " \r\t\n")
23500 (line-beginning-position))))
23501 (beginning-of-line)
23502 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23503 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23504 (goto-char end)
23505 (skip-chars-forward " \r\t\n")
23506 (if (= (point) contents-end) (goto-char end)
23507 (beginning-of-line))))
23508 ;; With no contents, just skip element.
23509 ((not contents-begin) (goto-char end))
23510 ;; If contents are invisible, skip the element altogether.
23511 ((outline-invisible-p (line-end-position))
23512 (case type
23513 (headline
23514 (org-with-limited-levels (outline-next-visible-heading 1)))
23515 ;; At a plain list, make sure we move to the next item
23516 ;; instead of skipping the whole list.
23517 (plain-list (forward-char)
23518 (org-forward-paragraph))
23519 (otherwise (goto-char end))))
23520 ((>= (point) contents-end) (goto-char end))
23521 ((>= (point) contents-begin)
23522 ;; This can only happen on paragraphs and plain lists.
23523 (case type
23524 (paragraph (goto-char end))
23525 ;; At a plain list, try to move to second element in
23526 ;; first item, if possible.
23527 (plain-list (end-of-line)
23528 (org-forward-paragraph))))
23529 ;; When contents start on the middle of a line (e.g. in
23530 ;; items and footnote definitions), try to reach first
23531 ;; element starting after current line.
23532 ((> (line-end-position) contents-begin)
23533 (end-of-line)
23534 (org-forward-paragraph))
23535 (t (goto-char contents-begin)))))
23537 (defun org-backward-paragraph ()
23538 "Move backward to start of previous paragraph or equivalent.
23540 The function moves point to the beginning of the current
23541 structural element, which can be a paragraph, a table, a list
23542 item, etc., or to the beginning of the previous visible one if
23543 point is already there. It also provides some special moves for
23544 convenience:
23546 - On an affiliated keyword, jump to the first one.
23547 - On a table or a property drawer, move to its beginning.
23548 - On a verse or source block, stop before blank lines."
23549 (interactive)
23550 (when (bobp) (user-error "Cannot move further up"))
23551 (let* ((deactivate-mark nil)
23552 (element (org-element-at-point))
23553 (type (org-element-type element))
23554 (contents-begin (org-element-property :contents-begin element))
23555 (contents-end (org-element-property :contents-end element))
23556 (post-affiliated (org-element-property :post-affiliated element))
23557 (begin (org-element-property :begin element)))
23558 (cond
23559 ((not element) (goto-char (point-min)))
23560 ((= (point) begin)
23561 (backward-char)
23562 (org-backward-paragraph))
23563 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23564 ((memq type '(node-property table-row))
23565 (goto-char (org-element-property
23566 :post-affiliated (org-element-property :parent element))))
23567 ((memq type '(property-drawer table)) (goto-char begin))
23568 ((memq type '(src-block verse-block))
23569 (when (eq type 'src-block)
23570 (setq contents-begin
23571 (save-excursion (goto-char begin) (forward-line) (point))))
23572 (if (= (point) contents-begin) (goto-char post-affiliated)
23573 ;; Inside a verse block, see blank lines as paragraph
23574 ;; separators.
23575 (let ((origin (point)))
23576 (skip-chars-backward " \r\t\n" contents-begin)
23577 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23578 (skip-chars-forward " \r\t\n" origin)
23579 (if (= (point) origin) (goto-char contents-begin)
23580 (beginning-of-line))))))
23581 ((not contents-begin) (goto-char (or post-affiliated begin)))
23582 ((eq type 'paragraph)
23583 (goto-char contents-begin)
23584 ;; When at first paragraph in an item or a footnote definition,
23585 ;; move directly to beginning of line.
23586 (let ((parent-contents
23587 (org-element-property
23588 :contents-begin (org-element-property :parent element))))
23589 (when (and parent-contents (= parent-contents contents-begin))
23590 (beginning-of-line))))
23591 ;; At the end of a greater element, move to the beginning of the
23592 ;; last element within.
23593 ((>= (point) contents-end)
23594 (goto-char (1- contents-end))
23595 (org-backward-paragraph))
23596 (t (goto-char (or post-affiliated begin))))
23597 ;; Ensure we never leave point invisible.
23598 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23600 (defun org-forward-element ()
23601 "Move forward by one element.
23602 Move to the next element at the same level, when possible."
23603 (interactive)
23604 (cond ((eobp) (user-error "Cannot move further down"))
23605 ((org-with-limited-levels (org-at-heading-p))
23606 (let ((origin (point)))
23607 (goto-char (org-end-of-subtree nil t))
23608 (unless (org-with-limited-levels (org-at-heading-p))
23609 (goto-char origin)
23610 (user-error "Cannot move further down"))))
23612 (let* ((elem (org-element-at-point))
23613 (end (org-element-property :end elem))
23614 (parent (org-element-property :parent elem)))
23615 (cond ((and parent (= (org-element-property :contents-end parent) end))
23616 (goto-char (org-element-property :end parent)))
23617 ((integer-or-marker-p end) (goto-char end))
23618 (t (message "No element at point")))))))
23620 (defun org-backward-element ()
23621 "Move backward by one element.
23622 Move to the previous element at the same level, when possible."
23623 (interactive)
23624 (cond ((bobp) (user-error "Cannot move further up"))
23625 ((org-with-limited-levels (org-at-heading-p))
23626 ;; At a headline, move to the previous one, if any, or stay
23627 ;; here.
23628 (let ((origin (point)))
23629 (org-with-limited-levels (org-backward-heading-same-level 1))
23630 ;; When current headline has no sibling above, move to its
23631 ;; parent.
23632 (when (= (point) origin)
23633 (or (org-with-limited-levels (org-up-heading-safe))
23634 (progn (goto-char origin)
23635 (user-error "Cannot move further up"))))))
23637 (let* ((elem (org-element-at-point))
23638 (beg (org-element-property :begin elem)))
23639 (cond
23640 ;; Move to beginning of current element if point isn't
23641 ;; there already.
23642 ((null beg) (message "No element at point"))
23643 ((/= (point) beg) (goto-char beg))
23644 (t (goto-char beg)
23645 (skip-chars-backward " \r\t\n")
23646 (unless (bobp)
23647 (let ((prev (org-element-at-point)))
23648 (goto-char (org-element-property :begin prev))
23649 (while (and (setq prev (org-element-property :parent prev))
23650 (<= (org-element-property :end prev) beg))
23651 (goto-char (org-element-property :begin prev)))))))))))
23653 (defun org-up-element ()
23654 "Move to upper element."
23655 (interactive)
23656 (if (org-with-limited-levels (org-at-heading-p))
23657 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23658 (let* ((elem (org-element-at-point))
23659 (parent (org-element-property :parent elem)))
23660 (if parent (goto-char (org-element-property :begin parent))
23661 (if (org-with-limited-levels (org-before-first-heading-p))
23662 (user-error "No surrounding element")
23663 (org-with-limited-levels (org-back-to-heading)))))))
23665 (defvar org-element-greater-elements)
23666 (defun org-down-element ()
23667 "Move to inner element."
23668 (interactive)
23669 (let ((element (org-element-at-point)))
23670 (cond
23671 ((memq (org-element-type element) '(plain-list table))
23672 (goto-char (org-element-property :contents-begin element))
23673 (forward-char))
23674 ((memq (org-element-type element) org-element-greater-elements)
23675 ;; If contents are hidden, first disclose them.
23676 (when (outline-invisible-p (line-end-position)) (org-cycle))
23677 (goto-char (or (org-element-property :contents-begin element)
23678 (user-error "No content for this element"))))
23679 (t (user-error "No inner element")))))
23681 (defun org-drag-element-backward ()
23682 "Move backward element at point."
23683 (interactive)
23684 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23685 (let* ((elem (org-element-at-point))
23686 (prev-elem
23687 (save-excursion
23688 (goto-char (org-element-property :begin elem))
23689 (skip-chars-backward " \r\t\n")
23690 (unless (bobp)
23691 (let* ((beg (org-element-property :begin elem))
23692 (prev (org-element-at-point))
23693 (up prev))
23694 (while (and (setq up (org-element-property :parent up))
23695 (<= (org-element-property :end prev) beg))
23696 (setq prev up))
23697 prev)))))
23698 ;; Error out if no previous element or previous element is
23699 ;; a parent of the current one.
23700 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23701 (user-error "Cannot drag element backward")
23702 (let ((pos (point)))
23703 (org-element-swap-A-B prev-elem elem)
23704 (goto-char (+ (org-element-property :begin prev-elem)
23705 (- pos (org-element-property :begin elem)))))))))
23707 (defun org-drag-element-forward ()
23708 "Move forward element at point."
23709 (interactive)
23710 (let* ((pos (point))
23711 (elem (org-element-at-point)))
23712 (when (= (point-max) (org-element-property :end elem))
23713 (user-error "Cannot drag element forward"))
23714 (goto-char (org-element-property :end elem))
23715 (let ((next-elem (org-element-at-point)))
23716 (when (or (org-element-nested-p elem next-elem)
23717 (and (eq (org-element-type next-elem) 'headline)
23718 (not (eq (org-element-type elem) 'headline))))
23719 (goto-char pos)
23720 (user-error "Cannot drag element forward"))
23721 ;; Compute new position of point: it's shifted by NEXT-ELEM
23722 ;; body's length (without final blanks) and by the length of
23723 ;; blanks between ELEM and NEXT-ELEM.
23724 (let ((size-next (- (save-excursion
23725 (goto-char (org-element-property :end next-elem))
23726 (skip-chars-backward " \r\t\n")
23727 (forward-line)
23728 ;; Small correction if buffer doesn't end
23729 ;; with a newline character.
23730 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23731 (org-element-property :begin next-elem)))
23732 (size-blank (- (org-element-property :end elem)
23733 (save-excursion
23734 (goto-char (org-element-property :end elem))
23735 (skip-chars-backward " \r\t\n")
23736 (forward-line)
23737 (point)))))
23738 (org-element-swap-A-B elem next-elem)
23739 (goto-char (+ pos size-next size-blank))))))
23741 (defun org-drag-line-forward (arg)
23742 "Drag the line at point ARG lines forward."
23743 (interactive "p")
23744 (dotimes (n (abs arg))
23745 (let ((c (current-column)))
23746 (if (< 0 arg)
23747 (progn
23748 (beginning-of-line 2)
23749 (transpose-lines 1)
23750 (beginning-of-line 0))
23751 (transpose-lines 1)
23752 (beginning-of-line -1))
23753 (org-move-to-column c))))
23755 (defun org-drag-line-backward (arg)
23756 "Drag the line at point ARG lines backward."
23757 (interactive "p")
23758 (org-drag-line-forward (- arg)))
23760 (defun org-mark-element ()
23761 "Put point at beginning of this element, mark at end.
23763 Interactively, if this command is repeated or (in Transient Mark
23764 mode) if the mark is active, it marks the next element after the
23765 ones already marked."
23766 (interactive)
23767 (let (deactivate-mark)
23768 (if (and (org-called-interactively-p 'any)
23769 (or (and (eq last-command this-command) (mark t))
23770 (and transient-mark-mode mark-active)))
23771 (set-mark
23772 (save-excursion
23773 (goto-char (mark))
23774 (goto-char (org-element-property :end (org-element-at-point)))))
23775 (let ((element (org-element-at-point)))
23776 (end-of-line)
23777 (push-mark (org-element-property :end element) t t)
23778 (goto-char (org-element-property :begin element))))))
23780 (defun org-narrow-to-element ()
23781 "Narrow buffer to current element."
23782 (interactive)
23783 (let ((elem (org-element-at-point)))
23784 (cond
23785 ((eq (car elem) 'headline)
23786 (narrow-to-region
23787 (org-element-property :begin elem)
23788 (org-element-property :end elem)))
23789 ((memq (car elem) org-element-greater-elements)
23790 (narrow-to-region
23791 (org-element-property :contents-begin elem)
23792 (org-element-property :contents-end elem)))
23794 (narrow-to-region
23795 (org-element-property :begin elem)
23796 (org-element-property :end elem))))))
23798 (defun org-transpose-element ()
23799 "Transpose current and previous elements, keeping blank lines between.
23800 Point is moved after both elements."
23801 (interactive)
23802 (org-skip-whitespace)
23803 (let ((end (org-element-property :end (org-element-at-point))))
23804 (org-drag-element-backward)
23805 (goto-char end)))
23807 (defun org-unindent-buffer ()
23808 "Un-indent the visible part of the buffer.
23809 Relative indentation (between items, inside blocks, etc.) isn't
23810 modified."
23811 (interactive)
23812 (unless (eq major-mode 'org-mode)
23813 (user-error "Cannot un-indent a buffer not in Org mode"))
23814 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23815 unindent-tree ; For byte-compiler.
23816 (unindent-tree
23817 (function
23818 (lambda (contents)
23819 (mapc
23820 (lambda (element)
23821 (if (memq (org-element-type element) '(headline section))
23822 (funcall unindent-tree (org-element-contents element))
23823 (save-excursion
23824 (save-restriction
23825 (narrow-to-region
23826 (org-element-property :begin element)
23827 (org-element-property :end element))
23828 (org-do-remove-indentation)))))
23829 (reverse contents))))))
23830 (funcall unindent-tree (org-element-contents parse-tree))))
23832 (defun org-show-subtree ()
23833 "Show everything after this heading at deeper levels."
23834 (interactive)
23835 (outline-flag-region
23836 (point)
23837 (save-excursion
23838 (org-end-of-subtree t t))
23839 nil))
23841 (defun org-show-entry ()
23842 "Show the body directly following this heading.
23843 Show the heading too, if it is currently invisible."
23844 (interactive)
23845 (save-excursion
23846 (condition-case nil
23847 (progn
23848 (org-back-to-heading t)
23849 (outline-flag-region
23850 (max (point-min) (1- (point)))
23851 (save-excursion
23852 (if (re-search-forward
23853 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23854 (match-beginning 1)
23855 (point-max)))
23856 nil)
23857 (org-cycle-hide-drawers 'children))
23858 (error nil))))
23860 (defun org-make-options-regexp (kwds &optional extra)
23861 "Make a regular expression for keyword lines."
23862 (concat
23863 "^#\\+\\("
23864 (mapconcat 'regexp-quote kwds "\\|")
23865 (if extra (concat "\\|" extra))
23866 "\\):[ \t]*\\(.*\\)"))
23868 ;; Make isearch reveal the necessary context
23869 (defun org-isearch-end ()
23870 "Reveal context after isearch exits."
23871 (when isearch-success ; only if search was successful
23872 (if (featurep 'xemacs)
23873 ;; Under XEmacs, the hook is run in the correct place,
23874 ;; we directly show the context.
23875 (org-show-context 'isearch)
23876 ;; In Emacs the hook runs *before* restoring the overlays.
23877 ;; So we have to use a one-time post-command-hook to do this.
23878 ;; (Emacs 22 has a special variable, see function `org-mode')
23879 (unless (and (boundp 'isearch-mode-end-hook-quit)
23880 isearch-mode-end-hook-quit)
23881 ;; Only when the isearch was not quitted.
23882 (org-add-hook 'post-command-hook 'org-isearch-post-command
23883 'append 'local)))
23884 (org-fix-ellipsis-at-bol)))
23886 (defun org-isearch-post-command ()
23887 "Remove self from hook, and show context."
23888 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23889 (org-show-context 'isearch))
23892 ;;;; Integration with and fixes for other packages
23894 ;;; Imenu support
23896 (defvar org-imenu-markers nil
23897 "All markers currently used by Imenu.")
23898 (make-variable-buffer-local 'org-imenu-markers)
23900 (defun org-imenu-new-marker (&optional pos)
23901 "Return a new marker for use by Imenu, and remember the marker."
23902 (let ((m (make-marker)))
23903 (move-marker m (or pos (point)))
23904 (push m org-imenu-markers)
23907 (defun org-imenu-get-tree ()
23908 "Produce the index for Imenu."
23909 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23910 (setq org-imenu-markers nil)
23911 (let* ((n org-imenu-depth)
23912 (re (concat "^" (org-get-limited-outline-regexp)))
23913 (subs (make-vector (1+ n) nil))
23914 (last-level 0)
23915 m level head0 head)
23916 (save-excursion
23917 (save-restriction
23918 (widen)
23919 (goto-char (point-max))
23920 (while (re-search-backward re nil t)
23921 (setq level (org-reduced-level (funcall outline-level)))
23922 (when (and (<= level n)
23923 (looking-at org-complex-heading-regexp)
23924 (setq head0 (org-match-string-no-properties 4)))
23925 (setq head (org-link-display-format head0)
23926 m (org-imenu-new-marker))
23927 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23928 (if (>= level last-level)
23929 (push (cons head m) (aref subs level))
23930 (push (cons head (aref subs (1+ level))) (aref subs level))
23931 (loop for i from (1+ level) to n do (aset subs i nil)))
23932 (setq last-level level)))))
23933 (aref subs 1)))
23935 (eval-after-load "imenu"
23936 '(progn
23937 (add-hook 'imenu-after-jump-hook
23938 (lambda ()
23939 (if (derived-mode-p 'org-mode)
23940 (org-show-context 'org-goto))))))
23942 (defun org-link-display-format (link)
23943 "Replace a link with its the description.
23944 If there is no description, use the link target."
23945 (save-match-data
23946 (if (string-match org-bracket-link-analytic-regexp link)
23947 (replace-match (if (match-end 5)
23948 (match-string 5 link)
23949 (concat (match-string 1 link)
23950 (match-string 3 link)))
23951 nil t link)
23952 link)))
23954 (defun org-toggle-link-display ()
23955 "Toggle the literal or descriptive display of links."
23956 (interactive)
23957 (if org-descriptive-links
23958 (progn (org-remove-from-invisibility-spec '(org-link))
23959 (org-restart-font-lock)
23960 (setq org-descriptive-links nil))
23961 (progn (add-to-invisibility-spec '(org-link))
23962 (org-restart-font-lock)
23963 (setq org-descriptive-links t))))
23965 ;; Speedbar support
23967 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
23968 "Overlay marking the agenda restriction line in speedbar.")
23969 (overlay-put org-speedbar-restriction-lock-overlay
23970 'face 'org-agenda-restriction-lock)
23971 (overlay-put org-speedbar-restriction-lock-overlay
23972 'help-echo "Agendas are currently limited to this item.")
23973 (org-detach-overlay org-speedbar-restriction-lock-overlay)
23975 (defun org-speedbar-set-agenda-restriction ()
23976 "Restrict future agenda commands to the location at point in speedbar.
23977 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
23978 (interactive)
23979 (require 'org-agenda)
23980 (let (p m tp np dir txt)
23981 (cond
23982 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23983 'org-imenu t))
23984 (setq m (get-text-property p 'org-imenu-marker))
23985 (with-current-buffer (marker-buffer m)
23986 (goto-char m)
23987 (org-agenda-set-restriction-lock 'subtree)))
23988 ((setq p (text-property-any (point-at-bol) (point-at-eol)
23989 'speedbar-function 'speedbar-find-file))
23990 (setq tp (previous-single-property-change
23991 (1+ p) 'speedbar-function)
23992 np (next-single-property-change
23993 tp 'speedbar-function)
23994 dir (speedbar-line-directory)
23995 txt (buffer-substring-no-properties (or tp (point-min))
23996 (or np (point-max))))
23997 (with-current-buffer (find-file-noselect
23998 (let ((default-directory dir))
23999 (expand-file-name txt)))
24000 (unless (derived-mode-p 'org-mode)
24001 (user-error "Cannot restrict to non-Org-mode file"))
24002 (org-agenda-set-restriction-lock 'file)))
24003 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24004 (move-overlay org-speedbar-restriction-lock-overlay
24005 (point-at-bol) (point-at-eol))
24006 (setq current-prefix-arg nil)
24007 (org-agenda-maybe-redo)))
24009 (defvar speedbar-file-key-map)
24010 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24011 (eval-after-load "speedbar"
24012 '(progn
24013 (speedbar-add-supported-extension ".org")
24014 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24015 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24016 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24017 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24018 (add-hook 'speedbar-visiting-tag-hook
24019 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24021 ;;; Fixes and Hacks for problems with other packages
24023 (defun org-mode-flyspell-verify ()
24024 "Function used for `flyspell-generic-check-word-predicate'."
24025 (if (org-at-heading-p)
24026 ;; At a headline or an inlinetask, check title only. This is
24027 ;; faster than relying on `org-element-at-point'.
24028 (and (save-excursion (beginning-of-line)
24029 (and (let ((case-fold-search t))
24030 (not (looking-at "\\*+ END[ \t]*$")))
24031 (looking-at org-complex-heading-regexp)))
24032 (match-beginning 4)
24033 (>= (point) (match-beginning 4))
24034 (or (not (match-beginning 5))
24035 (< (point) (match-beginning 5))))
24036 (let* ((element (org-element-at-point))
24037 (post-affiliated (org-element-property :post-affiliated element))
24038 (object-check
24039 (function
24040 ;; Non-nil if checks can be done for object at point.
24041 (lambda ()
24042 (let ((object (save-excursion
24043 (when (org-looking-at-p "\\>") (backward-char))
24044 (org-element-context element))))
24045 (case (org-element-type object)
24046 ;; Prevent checks in links due to keybinding conflict
24047 ;; with Flyspell.
24048 ((code entity export-snippet inline-babel-call
24049 inline-src-block line-break latex-fragment link macro
24050 statistics-cookie target timestamp verbatim)
24051 nil)
24052 (footnote-reference
24053 ;; Only in inline footnotes, within the definition.
24054 (and (eq (org-element-property :type object) 'inline)
24055 (< (save-excursion
24056 (goto-char (org-element-property :begin object))
24057 (search-forward ":" nil t 2))
24058 (point))))
24059 (otherwise t)))))))
24060 (cond
24061 ;; Ignore checks in all affiliated keywords but captions.
24062 ((and post-affiliated (< (point) post-affiliated))
24063 (and (save-excursion
24064 (beginning-of-line)
24065 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24066 (> (point) (match-end 0))
24067 (funcall object-check)))
24068 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24069 ((and org-log-into-drawer
24070 (let ((log (or (org-string-nw-p org-log-into-drawer) "LOGBOOK"))
24071 (parent element))
24072 (while (and parent (not (eq (org-element-type parent) 'drawer)))
24073 (setq parent (org-element-property :parent parent)))
24074 (and parent
24075 (eq (compare-strings
24076 log nil nil
24077 (org-element-property :drawer-name parent) nil nil t)
24078 t))))
24079 nil)
24081 (case (org-element-type element)
24082 ((comment quote-section) t)
24083 (comment-block
24084 ;; Allow checks between block markers, not on them.
24085 (and (> (line-beginning-position)
24086 (org-element-property :post-affiliated element))
24087 (save-excursion
24088 (end-of-line)
24089 (skip-chars-forward " \r\t\n")
24090 (< (point) (org-element-property :end element)))))
24091 ;; Arbitrary list of keywords where checks are meaningful.
24092 ;; Make sure point is on the value part of the element.
24093 (keyword
24094 (and (member (org-element-property :key element)
24095 '("DESCRIPTION" "TITLE"))
24096 (< (save-excursion
24097 (beginning-of-line) (search-forward ":") (point))
24098 (point))))
24099 ;; Check is globally allowed in paragraphs verse blocks and
24100 ;; table rows (after affiliated keywords) but some objects
24101 ;; must not be affected.
24102 ((paragraph table-row verse-block)
24103 (and (>= (point) (org-element-property :contents-begin element))
24104 (< (point) (org-element-property :contents-end element))
24105 (funcall object-check)))))))))
24106 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24108 (defun org-remove-flyspell-overlays-in (beg end)
24109 "Remove flyspell overlays in region."
24110 (and (org-bound-and-true-p flyspell-mode)
24111 (fboundp 'flyspell-delete-region-overlays)
24112 (flyspell-delete-region-overlays beg end)))
24114 (eval-after-load "flyspell"
24115 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24117 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24118 (eval-after-load "bookmark"
24119 '(if (boundp 'bookmark-after-jump-hook)
24120 ;; We can use the hook
24121 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24122 ;; Hook not available, use advice
24123 (defadvice bookmark-jump (after org-make-visible activate)
24124 "Make the position visible."
24125 (org-bookmark-jump-unhide))))
24127 ;; Make sure saveplace shows the location if it was hidden
24128 (eval-after-load "saveplace"
24129 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24130 "Make the position visible."
24131 (org-bookmark-jump-unhide)))
24133 ;; Make sure ecb shows the location if it was hidden
24134 (eval-after-load "ecb"
24135 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24136 "Make hierarchy visible when jumping into location from ECB tree buffer."
24137 (if (derived-mode-p 'org-mode)
24138 (org-show-context))))
24140 (defun org-bookmark-jump-unhide ()
24141 "Unhide the current position, to show the bookmark location."
24142 (and (derived-mode-p 'org-mode)
24143 (or (outline-invisible-p)
24144 (save-excursion (goto-char (max (point-min) (1- (point))))
24145 (outline-invisible-p)))
24146 (org-show-context 'bookmark-jump)))
24148 ;; Make session.el ignore our circular variable
24149 (defvar session-globals-exclude)
24150 (eval-after-load "session"
24151 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24153 ;;;; Finish up
24155 (provide 'org)
24157 (run-hooks 'org-load-hook)
24159 ;;; org.el ends here