Fix 80fc5ad
[org-mode.git] / lisp / org.el
blobd2e6d998a0a553e999f8f4d4f49d3e6f4fc20793
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.
2570 When set to a list of two lists, the first list contains keywords
2571 to consider as TODO keywords, the second list contains keywords
2572 to consider as DONE keywords.
2574 When this is set, todo statistics is updated in the parent of the
2575 current entry each time a todo state is changed."
2576 :group 'org-todo
2577 :type '(choice
2578 (const :tag "Yes, only for TODO entries" t)
2579 (const :tag "Yes, including all entries" all-headlines)
2580 (repeat :tag "Yes, for TODOs in this list"
2581 (string :tag "TODO keyword"))
2582 (list :tag "Yes, for TODOs and DONEs in these lists"
2583 (repeat (string :tag "TODO keyword"))
2584 (repeat (string :tag "DONE keyword")))
2585 (other :tag "No TODO statistics" nil)))
2587 (defcustom org-hierarchical-todo-statistics t
2588 "Non-nil means TODO statistics covers just direct children.
2589 When nil, all entries in the subtree are considered.
2590 This has only an effect if `org-provide-todo-statistics' is set.
2591 To set this to nil for only a single subtree, use a COOKIE_DATA
2592 property and include the word \"recursive\" into the value."
2593 :group 'org-todo
2594 :type 'boolean)
2596 (defcustom org-after-todo-state-change-hook nil
2597 "Hook which is run after the state of a TODO item was changed.
2598 The new state (a string with a TODO keyword, or nil) is available in the
2599 Lisp variable `org-state'."
2600 :group 'org-todo
2601 :type 'hook)
2603 (defvar org-blocker-hook nil
2604 "Hook for functions that are allowed to block a state change.
2606 Functions in this hook should not modify the buffer.
2607 Each function gets as its single argument a property list,
2608 see `org-trigger-hook' for more information about this list.
2610 If any of the functions in this hook returns nil, the state change
2611 is blocked.")
2613 (defvar org-trigger-hook nil
2614 "Hook for functions that are triggered by a state change.
2616 Each function gets as its single argument a property list with at
2617 least the following elements:
2619 (:type type-of-change :position pos-at-entry-start
2620 :from old-state :to new-state)
2622 Depending on the type, more properties may be present.
2624 This mechanism is currently implemented for:
2626 TODO state changes
2627 ------------------
2628 :type todo-state-change
2629 :from previous state (keyword as a string), or nil, or a symbol
2630 'todo' or 'done', to indicate the general type of state.
2631 :to new state, like in :from")
2633 (defcustom org-enforce-todo-dependencies nil
2634 "Non-nil means undone TODO entries will block switching the parent to DONE.
2635 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2636 be blocked if any prior sibling is not yet done.
2637 Finally, if the parent is blocked because of ordered siblings of its own,
2638 the child will also be blocked."
2639 :set (lambda (var val)
2640 (set var val)
2641 (if val
2642 (add-hook 'org-blocker-hook
2643 'org-block-todo-from-children-or-siblings-or-parent)
2644 (remove-hook 'org-blocker-hook
2645 'org-block-todo-from-children-or-siblings-or-parent)))
2646 :group 'org-todo
2647 :type 'boolean)
2649 (defcustom org-enforce-todo-checkbox-dependencies nil
2650 "Non-nil means unchecked boxes will block switching the parent to DONE.
2651 When this is nil, checkboxes have no influence on switching TODO states.
2652 When non-nil, you first need to check off all check boxes before the TODO
2653 entry can be switched to DONE.
2654 This variable needs to be set before org.el is loaded, and you need to
2655 restart Emacs after a change to make the change effective. The only way
2656 to change is while Emacs is running is through the customize interface."
2657 :set (lambda (var val)
2658 (set var val)
2659 (if val
2660 (add-hook 'org-blocker-hook
2661 'org-block-todo-from-checkboxes)
2662 (remove-hook 'org-blocker-hook
2663 'org-block-todo-from-checkboxes)))
2664 :group 'org-todo
2665 :type 'boolean)
2667 (defcustom org-treat-insert-todo-heading-as-state-change nil
2668 "Non-nil means inserting a TODO heading is treated as state change.
2669 So when the command \\[org-insert-todo-heading] is used, state change
2670 logging will apply if appropriate. When nil, the new TODO item will
2671 be inserted directly, and no logging will take place."
2672 :group 'org-todo
2673 :type 'boolean)
2675 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2676 "Non-nil means switching TODO states with S-cursor counts as state change.
2677 This is the default behavior. However, setting this to nil allows a
2678 convenient way to select a TODO state and bypass any logging associated
2679 with that."
2680 :group 'org-todo
2681 :type 'boolean)
2683 (defcustom org-todo-state-tags-triggers nil
2684 "Tag changes that should be triggered by TODO state changes.
2685 This is a list. Each entry is
2687 (state-change (tag . flag) .......)
2689 State-change can be a string with a state, and empty string to indicate the
2690 state that has no TODO keyword, or it can be one of the symbols `todo'
2691 or `done', meaning any not-done or done state, respectively."
2692 :group 'org-todo
2693 :group 'org-tags
2694 :type '(repeat
2695 (cons (choice :tag "When changing to"
2696 (const :tag "Not-done state" todo)
2697 (const :tag "Done state" done)
2698 (string :tag "State"))
2699 (repeat
2700 (cons :tag "Tag action"
2701 (string :tag "Tag")
2702 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2704 (defcustom org-log-done nil
2705 "Information to record when a task moves to the DONE state.
2707 Possible values are:
2709 nil Don't add anything, just change the keyword
2710 time Add a time stamp to the task
2711 note Prompt for a note and add it with template `org-log-note-headings'
2713 This option can also be set with on a per-file-basis with
2715 #+STARTUP: nologdone
2716 #+STARTUP: logdone
2717 #+STARTUP: lognotedone
2719 You can have local logging settings for a subtree by setting the LOGGING
2720 property to one or more of these keywords."
2721 :group 'org-todo
2722 :group 'org-progress
2723 :type '(choice
2724 (const :tag "No logging" nil)
2725 (const :tag "Record CLOSED timestamp" time)
2726 (const :tag "Record CLOSED timestamp with note." note)))
2728 ;; Normalize old uses of org-log-done.
2729 (cond
2730 ((eq org-log-done t) (setq org-log-done 'time))
2731 ((and (listp org-log-done) (memq 'done org-log-done))
2732 (setq org-log-done 'note)))
2734 (defcustom org-log-reschedule nil
2735 "Information to record when the scheduling date of a tasks is modified.
2737 Possible values are:
2739 nil Don't add anything, just change the date
2740 time Add a time stamp to the task
2741 note Prompt for a note and add it with template `org-log-note-headings'
2743 This option can also be set with on a per-file-basis with
2745 #+STARTUP: nologreschedule
2746 #+STARTUP: logreschedule
2747 #+STARTUP: lognotereschedule"
2748 :group 'org-todo
2749 :group 'org-progress
2750 :type '(choice
2751 (const :tag "No logging" nil)
2752 (const :tag "Record timestamp" time)
2753 (const :tag "Record timestamp with note." note)))
2755 (defcustom org-log-redeadline nil
2756 "Information to record when the deadline date of a tasks is modified.
2758 Possible values are:
2760 nil Don't add anything, just change the date
2761 time Add a time stamp to the task
2762 note Prompt for a note and add it with template `org-log-note-headings'
2764 This option can also be set with on a per-file-basis with
2766 #+STARTUP: nologredeadline
2767 #+STARTUP: logredeadline
2768 #+STARTUP: lognoteredeadline
2770 You can have local logging settings for a subtree by setting the LOGGING
2771 property to one or more of these keywords."
2772 :group 'org-todo
2773 :group 'org-progress
2774 :type '(choice
2775 (const :tag "No logging" nil)
2776 (const :tag "Record timestamp" time)
2777 (const :tag "Record timestamp with note." note)))
2779 (defcustom org-log-note-clock-out nil
2780 "Non-nil means record a note when clocking out of an item.
2781 This can also be configured on a per-file basis by adding one of
2782 the following lines anywhere in the buffer:
2784 #+STARTUP: lognoteclock-out
2785 #+STARTUP: nolognoteclock-out"
2786 :group 'org-todo
2787 :group 'org-progress
2788 :type 'boolean)
2790 (defcustom org-log-done-with-time t
2791 "Non-nil means the CLOSED time stamp will contain date and time.
2792 When nil, only the date will be recorded."
2793 :group 'org-progress
2794 :type 'boolean)
2796 (defcustom org-log-note-headings
2797 '((done . "CLOSING NOTE %t")
2798 (state . "State %-12s from %-12S %t")
2799 (note . "Note taken on %t")
2800 (reschedule . "Rescheduled from %S on %t")
2801 (delschedule . "Not scheduled, was %S on %t")
2802 (redeadline . "New deadline from %S on %t")
2803 (deldeadline . "Removed deadline, was %S on %t")
2804 (refile . "Refiled on %t")
2805 (clock-out . ""))
2806 "Headings for notes added to entries.
2807 The value is an alist, with the car being a symbol indicating the note
2808 context, and the cdr is the heading to be used. The heading may also be the
2809 empty string.
2810 %t in the heading will be replaced by a time stamp.
2811 %T will be an active time stamp instead the default inactive one
2812 %d will be replaced by a short-format time stamp.
2813 %D will be replaced by an active short-format time stamp.
2814 %s will be replaced by the new TODO state, in double quotes.
2815 %S will be replaced by the old TODO state, in double quotes.
2816 %u will be replaced by the user name.
2817 %U will be replaced by the full user name.
2819 In fact, it is not a good idea to change the `state' entry, because
2820 agenda log mode depends on the format of these entries."
2821 :group 'org-todo
2822 :group 'org-progress
2823 :type '(list :greedy t
2824 (cons (const :tag "Heading when closing an item" done) string)
2825 (cons (const :tag
2826 "Heading when changing todo state (todo sequence only)"
2827 state) string)
2828 (cons (const :tag "Heading when just taking a note" note) string)
2829 (cons (const :tag "Heading when rescheduling" reschedule) string)
2830 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2831 (cons (const :tag "Heading when changing deadline" redeadline) string)
2832 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2833 (cons (const :tag "Heading when refiling" refile) string)
2834 (cons (const :tag "Heading when clocking out" clock-out) string)))
2836 (unless (assq 'note org-log-note-headings)
2837 (push '(note . "%t") org-log-note-headings))
2839 (defcustom org-log-into-drawer nil
2840 "Non-nil means insert state change notes and time stamps into a drawer.
2841 When nil, state changes notes will be inserted after the headline and
2842 any scheduling and clock lines, but not inside a drawer.
2844 The value of this variable should be the name of the drawer to use.
2845 LOGBOOK is proposed as the default drawer for this purpose, you can
2846 also set this to a string to define the drawer of your choice.
2848 A value of t is also allowed, representing \"LOGBOOK\".
2850 A value of t or nil can also be set with on a per-file-basis with
2852 #+STARTUP: logdrawer
2853 #+STARTUP: nologdrawer
2855 If this variable is set, `org-log-state-notes-insert-after-drawers'
2856 will be ignored.
2858 You can set the property LOG_INTO_DRAWER to overrule this setting for
2859 a subtree."
2860 :group 'org-todo
2861 :group 'org-progress
2862 :type '(choice
2863 (const :tag "Not into a drawer" nil)
2864 (const :tag "LOGBOOK" t)
2865 (string :tag "Other")))
2867 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2869 (defun org-log-into-drawer ()
2870 "Return the value of `org-log-into-drawer', but let properties overrule.
2871 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2872 used instead of the default value."
2873 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2874 (cond
2875 ((not p) org-log-into-drawer)
2876 ((equal p "nil") nil)
2877 ((equal p "t") "LOGBOOK")
2878 (t p))))
2880 (defcustom org-log-state-notes-insert-after-drawers nil
2881 "Non-nil means insert state change notes after any drawers in entry.
2882 Only the drawers that *immediately* follow the headline and the
2883 deadline/scheduled line are skipped.
2884 When nil, insert notes right after the heading and perhaps the line
2885 with deadline/scheduling if present.
2887 This variable will have no effect if `org-log-into-drawer' is
2888 set."
2889 :group 'org-todo
2890 :group 'org-progress
2891 :type 'boolean)
2893 (defcustom org-log-states-order-reversed t
2894 "Non-nil means the latest state note will be directly after heading.
2895 When nil, the state change notes will be ordered according to time.
2897 This option can also be set with on a per-file-basis with
2899 #+STARTUP: logstatesreversed
2900 #+STARTUP: nologstatesreversed"
2901 :group 'org-todo
2902 :group 'org-progress
2903 :type 'boolean)
2905 (defcustom org-todo-repeat-to-state nil
2906 "The TODO state to which a repeater should return the repeating task.
2907 By default this is the first task in a TODO sequence, or the previous state
2908 in a TODO_TYP set. But you can specify another task here.
2909 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2910 :group 'org-todo
2911 :version "24.1"
2912 :type '(choice (const :tag "Head of sequence" nil)
2913 (string :tag "Specific state")))
2915 (defcustom org-log-repeat 'time
2916 "Non-nil means record moving through the DONE state when triggering repeat.
2917 An auto-repeating task is immediately switched back to TODO when
2918 marked DONE. If you are not logging state changes (by adding \"@\"
2919 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2920 record a closing note, there will be no record of the task moving
2921 through DONE. This variable forces taking a note anyway.
2923 nil Don't force a record
2924 time Record a time stamp
2925 note Prompt for a note and add it with template `org-log-note-headings'
2927 This option can also be set with on a per-file-basis with
2929 #+STARTUP: nologrepeat
2930 #+STARTUP: logrepeat
2931 #+STARTUP: lognoterepeat
2933 You can have local logging settings for a subtree by setting the LOGGING
2934 property to one or more of these keywords."
2935 :group 'org-todo
2936 :group 'org-progress
2937 :type '(choice
2938 (const :tag "Don't force a record" nil)
2939 (const :tag "Force recording the DONE state" time)
2940 (const :tag "Force recording a note with the DONE state" note)))
2943 (defgroup org-priorities nil
2944 "Priorities in Org-mode."
2945 :tag "Org Priorities"
2946 :group 'org-todo)
2948 (defcustom org-enable-priority-commands t
2949 "Non-nil means priority commands are active.
2950 When nil, these commands will be disabled, so that you never accidentally
2951 set a priority."
2952 :group 'org-priorities
2953 :type 'boolean)
2955 (defcustom org-highest-priority ?A
2956 "The highest priority of TODO items. A character like ?A, ?B etc.
2957 Must have a smaller ASCII number than `org-lowest-priority'."
2958 :group 'org-priorities
2959 :type 'character)
2961 (defcustom org-lowest-priority ?C
2962 "The lowest priority of TODO items. A character like ?A, ?B etc.
2963 Must have a larger ASCII number than `org-highest-priority'."
2964 :group 'org-priorities
2965 :type 'character)
2967 (defcustom org-default-priority ?B
2968 "The default priority of TODO items.
2969 This is the priority an item gets if no explicit priority is given.
2970 When starting to cycle on an empty priority the first step in the cycle
2971 depends on `org-priority-start-cycle-with-default'. The resulting first
2972 step priority must not exceed the range from `org-highest-priority' to
2973 `org-lowest-priority' which means that `org-default-priority' has to be
2974 in this range exclusive or inclusive the range boundaries. Else the
2975 first step refuses to set the default and the second will fall back
2976 to (depending on the command used) the highest or lowest priority."
2977 :group 'org-priorities
2978 :type 'character)
2980 (defcustom org-priority-start-cycle-with-default t
2981 "Non-nil means start with default priority when starting to cycle.
2982 When this is nil, the first step in the cycle will be (depending on the
2983 command used) one higher or lower than the default priority.
2984 See also `org-default-priority'."
2985 :group 'org-priorities
2986 :type 'boolean)
2988 (defcustom org-get-priority-function nil
2989 "Function to extract the priority from a string.
2990 The string is normally the headline. If this is nil Org computes the
2991 priority from the priority cookie like [#A] in the headline. It returns
2992 an integer, increasing by 1000 for each priority level.
2993 The user can set a different function here, which should take a string
2994 as an argument and return the numeric priority."
2995 :group 'org-priorities
2996 :version "24.1"
2997 :type '(choice
2998 (const nil)
2999 (function)))
3001 (defgroup org-time nil
3002 "Options concerning time stamps and deadlines in Org-mode."
3003 :tag "Org Time"
3004 :group 'org)
3006 (defcustom org-insert-labeled-timestamps-at-point nil
3007 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
3008 When nil, these labeled time stamps are forces into the second line of an
3009 entry, just after the headline. When scheduling from the global TODO list,
3010 the time stamp will always be forced into the second line."
3011 :group 'org-time
3012 :type 'boolean)
3014 (defcustom org-time-stamp-rounding-minutes '(0 5)
3015 "Number of minutes to round time stamps to.
3016 These are two values, the first applies when first creating a time stamp.
3017 The second applies when changing it with the commands `S-up' and `S-down'.
3018 When changing the time stamp, this means that it will change in steps
3019 of N minutes, as given by the second value.
3021 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3022 numbers should be factors of 60, so for example 5, 10, 15.
3024 When this is larger than 1, you can still force an exact time stamp by using
3025 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3026 and by using a prefix arg to `S-up/down' to specify the exact number
3027 of minutes to shift."
3028 :group 'org-time
3029 :get #'(lambda (var) ; Make sure both elements are there
3030 (if (integerp (default-value var))
3031 (list (default-value var) 5)
3032 (default-value var)))
3033 :type '(list
3034 (integer :tag "when inserting times")
3035 (integer :tag "when modifying times")))
3037 ;; Normalize old customizations of this variable.
3038 (when (integerp org-time-stamp-rounding-minutes)
3039 (setq org-time-stamp-rounding-minutes
3040 (list org-time-stamp-rounding-minutes
3041 org-time-stamp-rounding-minutes)))
3043 (defcustom org-display-custom-times nil
3044 "Non-nil means overlay custom formats over all time stamps.
3045 The formats are defined through the variable `org-time-stamp-custom-formats'.
3046 To turn this on on a per-file basis, insert anywhere in the file:
3047 #+STARTUP: customtime"
3048 :group 'org-time
3049 :set 'set-default
3050 :type 'sexp)
3051 (make-variable-buffer-local 'org-display-custom-times)
3053 (defcustom org-time-stamp-custom-formats
3054 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3055 "Custom formats for time stamps. See `format-time-string' for the syntax.
3056 These are overlaid over the default ISO format if the variable
3057 `org-display-custom-times' is set. Time like %H:%M should be at the
3058 end of the second format. The custom formats are also honored by export
3059 commands, if custom time display is turned on at the time of export."
3060 :group 'org-time
3061 :type 'sexp)
3063 (defun org-time-stamp-format (&optional long inactive)
3064 "Get the right format for a time string."
3065 (let ((f (if long (cdr org-time-stamp-formats)
3066 (car org-time-stamp-formats))))
3067 (if inactive
3068 (concat "[" (substring f 1 -1) "]")
3069 f)))
3071 (defcustom org-time-clocksum-format
3072 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3073 "The format string used when creating CLOCKSUM lines.
3074 This is also used when Org mode generates a time duration.
3076 The value can be a single format string containing two
3077 %-sequences, which will be filled with the number of hours and
3078 minutes in that order.
3080 Alternatively, the value can be a plist associating any of the
3081 keys :years, :months, :weeks, :days, :hours or :minutes with
3082 format strings. The time duration is formatted using only the
3083 time components that are needed and concatenating the results.
3084 If a time unit in absent, it falls back to the next smallest
3085 unit.
3087 The keys :require-years, :require-months, :require-days,
3088 :require-weeks, :require-hours, :require-minutes are also
3089 meaningful. A non-nil value for these keys indicates that the
3090 corresponding time component should always be included, even if
3091 its value is 0.
3094 For example,
3096 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3097 :require-minutes t)
3099 means durations longer than a day will be expressed in days,
3100 hours and minutes, and durations less than a day will always be
3101 expressed in hours and minutes (even for durations less than an
3102 hour).
3104 The value
3106 \(:days \"%dd\" :minutes \"%dm\")
3108 means durations longer than a day will be expressed in days and
3109 minutes, and durations less than a day will be expressed entirely
3110 in minutes (even for durations longer than an hour)."
3111 :group 'org-time
3112 :group 'org-clock
3113 :version "24.4"
3114 :package-version '(Org . "8.0")
3115 :type '(choice (string :tag "Format string")
3116 (set :tag "Plist"
3117 (group :inline t (const :tag "Years" :years)
3118 (string :tag "Format string"))
3119 (group :inline t
3120 (const :tag "Always show years" :require-years)
3121 (const t))
3122 (group :inline t (const :tag "Months" :months)
3123 (string :tag "Format string"))
3124 (group :inline t
3125 (const :tag "Always show months" :require-months)
3126 (const t))
3127 (group :inline t (const :tag "Weeks" :weeks)
3128 (string :tag "Format string"))
3129 (group :inline t
3130 (const :tag "Always show weeks" :require-weeks)
3131 (const t))
3132 (group :inline t (const :tag "Days" :days)
3133 (string :tag "Format string"))
3134 (group :inline t
3135 (const :tag "Always show days" :require-days)
3136 (const t))
3137 (group :inline t (const :tag "Hours" :hours)
3138 (string :tag "Format string"))
3139 (group :inline t
3140 (const :tag "Always show hours" :require-hours)
3141 (const t))
3142 (group :inline t (const :tag "Minutes" :minutes)
3143 (string :tag "Format string"))
3144 (group :inline t
3145 (const :tag "Always show minutes" :require-minutes)
3146 (const t)))))
3148 (defcustom org-time-clocksum-use-fractional nil
3149 "When non-nil, \\[org-clock-display] uses fractional times.
3150 See `org-time-clocksum-format' for more on time clock formats."
3151 :group 'org-time
3152 :group 'org-clock
3153 :version "24.3"
3154 :type 'boolean)
3156 (defcustom org-time-clocksum-use-effort-durations nil
3157 "When non-nil, \\[org-clock-display] uses effort durations.
3158 E.g. by default, one day is considered to be a 8 hours effort,
3159 so a task that has been clocked for 16 hours will be displayed
3160 as during 2 days in the clock display or in the clocktable.
3162 See `org-effort-durations' on how to set effort durations
3163 and `org-time-clocksum-format' for more on time clock formats."
3164 :group 'org-time
3165 :group 'org-clock
3166 :version "24.4"
3167 :package-version '(Org . "8.0")
3168 :type 'boolean)
3170 (defcustom org-time-clocksum-fractional-format "%.2f"
3171 "The format string used when creating CLOCKSUM lines,
3172 or when Org mode generates a time duration, if
3173 `org-time-clocksum-use-fractional' is enabled.
3175 The value can be a single format string containing one
3176 %-sequence, which will be filled with the number of hours as
3177 a float.
3179 Alternatively, the value can be a plist associating any of the
3180 keys :years, :months, :weeks, :days, :hours or :minutes with
3181 a format string. The time duration is formatted using the
3182 largest time unit which gives a non-zero integer part. If all
3183 specified formats have zero integer part, the smallest time unit
3184 is used."
3185 :group 'org-time
3186 :type '(choice (string :tag "Format string")
3187 (set (group :inline t (const :tag "Years" :years)
3188 (string :tag "Format string"))
3189 (group :inline t (const :tag "Months" :months)
3190 (string :tag "Format string"))
3191 (group :inline t (const :tag "Weeks" :weeks)
3192 (string :tag "Format string"))
3193 (group :inline t (const :tag "Days" :days)
3194 (string :tag "Format string"))
3195 (group :inline t (const :tag "Hours" :hours)
3196 (string :tag "Format string"))
3197 (group :inline t (const :tag "Minutes" :minutes)
3198 (string :tag "Format string")))))
3200 (defcustom org-deadline-warning-days 14
3201 "Number of days before expiration during which a deadline becomes active.
3202 This variable governs the display in sparse trees and in the agenda.
3203 When 0 or negative, it means use this number (the absolute value of it)
3204 even if a deadline has a different individual lead time specified.
3206 Custom commands can set this variable in the options section."
3207 :group 'org-time
3208 :group 'org-agenda-daily/weekly
3209 :type 'integer)
3211 (defcustom org-scheduled-delay-days 0
3212 "Number of days before a scheduled item becomes active.
3213 This variable governs the display in sparse trees and in the agenda.
3214 The default value (i.e. 0) means: don't delay scheduled item.
3215 When negative, it means use this number (the absolute value of it)
3216 even if a scheduled item has a different individual delay time
3217 specified.
3219 Custom commands can set this variable in the options section."
3220 :group 'org-time
3221 :group 'org-agenda-daily/weekly
3222 :version "24.4"
3223 :package-version '(Org . "8.0")
3224 :type 'integer)
3226 (defcustom org-read-date-prefer-future t
3227 "Non-nil means assume future for incomplete date input from user.
3228 This affects the following situations:
3229 1. The user gives a month but not a year.
3230 For example, if it is April and you enter \"feb 2\", this will be read
3231 as Feb 2, *next* year. \"May 5\", however, will be this year.
3232 2. The user gives a day, but no month.
3233 For example, if today is the 15th, and you enter \"3\", Org-mode will
3234 read this as the third of *next* month. However, if you enter \"17\",
3235 it will be considered as *this* month.
3237 If you set this variable to the symbol `time', then also the following
3238 will work:
3240 3. If the user gives a time.
3241 If the time is before now, it will be interpreted as tomorrow.
3243 Currently none of this works for ISO week specifications.
3245 When this option is nil, the current day, month and year will always be
3246 used as defaults.
3248 See also `org-agenda-jump-prefer-future'."
3249 :group 'org-time
3250 :type '(choice
3251 (const :tag "Never" nil)
3252 (const :tag "Check month and day" t)
3253 (const :tag "Check month, day, and time" time)))
3255 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3256 "Should the agenda jump command prefer the future for incomplete dates?
3257 The default is to do the same as configured in `org-read-date-prefer-future'.
3258 But you can also set a deviating value here.
3259 This may t or nil, or the symbol `org-read-date-prefer-future'."
3260 :group 'org-agenda
3261 :group 'org-time
3262 :version "24.1"
3263 :type '(choice
3264 (const :tag "Use org-read-date-prefer-future"
3265 org-read-date-prefer-future)
3266 (const :tag "Never" nil)
3267 (const :tag "Always" t)))
3269 (defcustom org-read-date-force-compatible-dates t
3270 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3272 Depending on the system Emacs is running on, certain dates cannot
3273 be represented with the type used internally to represent time.
3274 Dates between 1970-1-1 and 2038-1-1 can always be represented
3275 correctly. Some systems allow for earlier dates, some for later,
3276 some for both. One way to find out it to insert any date into an
3277 Org buffer, putting the cursor on the year and hitting S-up and
3278 S-down to test the range.
3280 When this variable is set to t, the date/time prompt will not let
3281 you specify dates outside the 1970-2037 range, so it is certain that
3282 these dates will work in whatever version of Emacs you are
3283 running, and also that you can move a file from one Emacs implementation
3284 to another. WHenever Org is forcing the year for you, it will display
3285 a message and beep.
3287 When this variable is nil, Org will check if the date is
3288 representable in the specific Emacs implementation you are using.
3289 If not, it will force a year, usually the current year, and beep
3290 to remind you. Currently this setting is not recommended because
3291 the likelihood that you will open your Org files in an Emacs that
3292 has limited date range is not negligible.
3294 A workaround for this problem is to use diary sexp dates for time
3295 stamps outside of this range."
3296 :group 'org-time
3297 :version "24.1"
3298 :type 'boolean)
3300 (defcustom org-read-date-display-live t
3301 "Non-nil means display current interpretation of date prompt live.
3302 This display will be in an overlay, in the minibuffer."
3303 :group 'org-time
3304 :type 'boolean)
3306 (defcustom org-read-date-popup-calendar t
3307 "Non-nil means pop up a calendar when prompting for a date.
3308 In the calendar, the date can be selected with mouse-1. However, the
3309 minibuffer will also be active, and you can simply enter the date as well.
3310 When nil, only the minibuffer will be available."
3311 :group 'org-time
3312 :type 'boolean)
3313 (org-defvaralias 'org-popup-calendar-for-date-prompt
3314 'org-read-date-popup-calendar)
3316 (make-obsolete-variable
3317 'org-read-date-minibuffer-setup-hook
3318 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3319 (defcustom org-read-date-minibuffer-setup-hook nil
3320 "Hook to be used to set up keys for the date/time interface.
3321 Add key definitions to `minibuffer-local-map', which will be a
3322 temporary copy.
3324 WARNING: This option is obsolete, you should use
3325 `org-read-date-minibuffer-local-map' to set up keys."
3326 :group 'org-time
3327 :type 'hook)
3329 (defcustom org-extend-today-until 0
3330 "The hour when your day really ends. Must be an integer.
3331 This has influence for the following applications:
3332 - When switching the agenda to \"today\". It it is still earlier than
3333 the time given here, the day recognized as TODAY is actually yesterday.
3334 - When a date is read from the user and it is still before the time given
3335 here, the current date and time will be assumed to be yesterday, 23:59.
3336 Also, timestamps inserted in capture templates follow this rule.
3338 IMPORTANT: This is a feature whose implementation is and likely will
3339 remain incomplete. Really, it is only here because past midnight seems to
3340 be the favorite working time of John Wiegley :-)"
3341 :group 'org-time
3342 :type 'integer)
3344 (defcustom org-use-effective-time nil
3345 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3346 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3347 \"effective time\" of any timestamps between midnight and 8am will be
3348 23:59 of the previous day."
3349 :group 'org-time
3350 :version "24.1"
3351 :type 'boolean)
3353 (defcustom org-use-last-clock-out-time-as-effective-time nil
3354 "When non-nil, use the last clock out time for `org-todo'.
3355 Note that this option has precedence over the combined use of
3356 `org-use-effective-time' and `org-extend-today-until'."
3357 :group 'org-time
3358 :version "24.4"
3359 :package-version '(Org . "8.0")
3360 :type 'boolean)
3362 (defcustom org-edit-timestamp-down-means-later nil
3363 "Non-nil means S-down will increase the time in a time stamp.
3364 When nil, S-up will increase."
3365 :group 'org-time
3366 :type 'boolean)
3368 (defcustom org-calendar-follow-timestamp-change t
3369 "Non-nil means make the calendar window follow timestamp changes.
3370 When a timestamp is modified and the calendar window is visible, it will be
3371 moved to the new date."
3372 :group 'org-time
3373 :type 'boolean)
3375 (defgroup org-tags nil
3376 "Options concerning tags in Org-mode."
3377 :tag "Org Tags"
3378 :group 'org)
3380 (defcustom org-tag-alist nil
3381 "List of tags allowed in Org-mode files.
3382 When this list is nil, Org-mode will base TAG input on what is already in the
3383 buffer.
3384 The value of this variable is an alist, the car of each entry must be a
3385 keyword as a string, the cdr may be a character that is used to select
3386 that tag through the fast-tag-selection interface.
3387 See the manual for details."
3388 :group 'org-tags
3389 :type '(repeat
3390 (choice
3391 (cons (string :tag "Tag name")
3392 (character :tag "Access char"))
3393 (list :tag "Start radio group"
3394 (const :startgroup)
3395 (option (string :tag "Group description")))
3396 (list :tag "Group tags delimiter"
3397 (const :grouptags))
3398 (list :tag "End radio group"
3399 (const :endgroup)
3400 (option (string :tag "Group description")))
3401 (const :tag "New line" (:newline)))))
3403 (defcustom org-tag-persistent-alist nil
3404 "List of tags that will always appear in all Org-mode files.
3405 This is in addition to any in buffer settings or customizations
3406 of `org-tag-alist'.
3407 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3408 The value of this variable is an alist, the car of each entry must be a
3409 keyword as a string, the cdr may be a character that is used to select
3410 that tag through the fast-tag-selection interface.
3411 See the manual for details.
3412 To disable these tags on a per-file basis, insert anywhere in the file:
3413 #+STARTUP: noptag"
3414 :group 'org-tags
3415 :type '(repeat
3416 (choice
3417 (cons (string :tag "Tag name")
3418 (character :tag "Access char"))
3419 (const :tag "Start radio group" (:startgroup))
3420 (const :tag "Group tags delimiter" (:grouptags))
3421 (const :tag "End radio group" (:endgroup))
3422 (const :tag "New line" (:newline)))))
3424 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3425 "If non-nil, always offer completion for all tags of all agenda files.
3426 Instead of customizing this variable directly, you might want to
3427 set it locally for capture buffers, because there no list of
3428 tags in that file can be created dynamically (there are none).
3430 (add-hook 'org-capture-mode-hook
3431 (lambda ()
3432 (set (make-local-variable
3433 'org-complete-tags-always-offer-all-agenda-tags)
3434 t)))"
3435 :group 'org-tags
3436 :version "24.1"
3437 :type 'boolean)
3439 (defvar org-file-tags nil
3440 "List of tags that can be inherited by all entries in the file.
3441 The tags will be inherited if the variable `org-use-tag-inheritance'
3442 says they should be.
3443 This variable is populated from #+FILETAGS lines.")
3445 (defcustom org-use-fast-tag-selection 'auto
3446 "Non-nil means use fast tag selection scheme.
3447 This is a special interface to select and deselect tags with single keys.
3448 When nil, fast selection is never used.
3449 When the symbol `auto', fast selection is used if and only if selection
3450 characters for tags have been configured, either through the variable
3451 `org-tag-alist' or through a #+TAGS line in the buffer.
3452 When t, fast selection is always used and selection keys are assigned
3453 automatically if necessary."
3454 :group 'org-tags
3455 :type '(choice
3456 (const :tag "Always" t)
3457 (const :tag "Never" nil)
3458 (const :tag "When selection characters are configured" auto)))
3460 (defcustom org-fast-tag-selection-single-key nil
3461 "Non-nil means fast tag selection exits after first change.
3462 When nil, you have to press RET to exit it.
3463 During fast tag selection, you can toggle this flag with `C-c'.
3464 This variable can also have the value `expert'. In this case, the window
3465 displaying the tags menu is not even shown, until you press C-c again."
3466 :group 'org-tags
3467 :type '(choice
3468 (const :tag "No" nil)
3469 (const :tag "Yes" t)
3470 (const :tag "Expert" expert)))
3472 (defvar org-fast-tag-selection-include-todo nil
3473 "Non-nil means fast tags selection interface will also offer TODO states.
3474 This is an undocumented feature, you should not rely on it.")
3476 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3477 "The column to which tags should be indented in a headline.
3478 If this number is positive, it specifies the column. If it is negative,
3479 it means that the tags should be flushright to that column. For example,
3480 -80 works well for a normal 80 character screen.
3481 When 0, place tags directly after headline text, with only one space in
3482 between."
3483 :group 'org-tags
3484 :type 'integer)
3486 (defcustom org-auto-align-tags t
3487 "Non-nil keeps tags aligned when modifying headlines.
3488 Some operations (i.e. demoting) change the length of a headline and
3489 therefore shift the tags around. With this option turned on, after
3490 each such operation the tags are again aligned to `org-tags-column'."
3491 :group 'org-tags
3492 :type 'boolean)
3494 (defcustom org-use-tag-inheritance t
3495 "Non-nil means tags in levels apply also for sublevels.
3496 When nil, only the tags directly given in a specific line apply there.
3497 This may also be a list of tags that should be inherited, or a regexp that
3498 matches tags that should be inherited. Additional control is possible
3499 with the variable `org-tags-exclude-from-inheritance' which gives an
3500 explicit list of tags to be excluded from inheritance, even if the value of
3501 `org-use-tag-inheritance' would select it for inheritance.
3503 If this option is t, a match early-on in a tree can lead to a large
3504 number of matches in the subtree when constructing the agenda or creating
3505 a sparse tree. If you only want to see the first match in a tree during
3506 a search, check out the variable `org-tags-match-list-sublevels'."
3507 :group 'org-tags
3508 :type '(choice
3509 (const :tag "Not" nil)
3510 (const :tag "Always" t)
3511 (repeat :tag "Specific tags" (string :tag "Tag"))
3512 (regexp :tag "Tags matched by regexp")))
3514 (defcustom org-tags-exclude-from-inheritance nil
3515 "List of tags that should never be inherited.
3516 This is a way to exclude a few tags from inheritance. For way to do
3517 the opposite, to actively allow inheritance for selected tags,
3518 see the variable `org-use-tag-inheritance'."
3519 :group 'org-tags
3520 :type '(repeat (string :tag "Tag")))
3522 (defun org-tag-inherit-p (tag)
3523 "Check if TAG is one that should be inherited."
3524 (cond
3525 ((member tag org-tags-exclude-from-inheritance) nil)
3526 ((eq org-use-tag-inheritance t) t)
3527 ((not org-use-tag-inheritance) nil)
3528 ((stringp org-use-tag-inheritance)
3529 (string-match org-use-tag-inheritance tag))
3530 ((listp org-use-tag-inheritance)
3531 (member tag org-use-tag-inheritance))
3532 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3534 (defcustom org-tags-match-list-sublevels t
3535 "Non-nil means list also sublevels of headlines matching a search.
3536 This variable applies to tags/property searches, and also to stuck
3537 projects because this search is based on a tags match as well.
3539 When set to the symbol `indented', sublevels are indented with
3540 leading dots.
3542 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3543 the sublevels of a headline matching a tag search often also match
3544 the same search. Listing all of them can create very long lists.
3545 Setting this variable to nil causes subtrees of a match to be skipped.
3547 This variable is semi-obsolete and probably should always be true. It
3548 is better to limit inheritance to certain tags using the variables
3549 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3550 :group 'org-tags
3551 :type '(choice
3552 (const :tag "No, don't list them" nil)
3553 (const :tag "Yes, do list them" t)
3554 (const :tag "List them, indented with leading dots" indented)))
3556 (defcustom org-tags-sort-function nil
3557 "When set, tags are sorted using this function as a comparator."
3558 :group 'org-tags
3559 :type '(choice
3560 (const :tag "No sorting" nil)
3561 (const :tag "Alphabetical" string<)
3562 (const :tag "Reverse alphabetical" string>)
3563 (function :tag "Custom function" nil)))
3565 (defvar org-tags-history nil
3566 "History of minibuffer reads for tags.")
3567 (defvar org-last-tags-completion-table nil
3568 "The last used completion table for tags.")
3569 (defvar org-after-tags-change-hook nil
3570 "Hook that is run after the tags in a line have changed.")
3572 (defgroup org-properties nil
3573 "Options concerning properties in Org-mode."
3574 :tag "Org Properties"
3575 :group 'org)
3577 (defcustom org-property-format "%-10s %s"
3578 "How property key/value pairs should be formatted by `indent-line'.
3579 When `indent-line' hits a property definition, it will format the line
3580 according to this format, mainly to make sure that the values are
3581 lined-up with respect to each other."
3582 :group 'org-properties
3583 :type 'string)
3585 (defcustom org-properties-postprocess-alist nil
3586 "Alist of properties and functions to adjust inserted values.
3587 Elements of this alist must be of the form
3589 ([string] [function])
3591 where [string] must be a property name and [function] must be a
3592 lambda expression: this lambda expression must take one argument,
3593 the value to adjust, and return the new value as a string.
3595 For example, this element will allow the property \"Remaining\"
3596 to be updated wrt the relation between the \"Effort\" property
3597 and the clock summary:
3599 ((\"Remaining\" (lambda(value)
3600 (let ((clocksum (org-clock-sum-current-item))
3601 (effort (org-duration-string-to-minutes
3602 (org-entry-get (point) \"Effort\"))))
3603 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3604 :group 'org-properties
3605 :version "24.1"
3606 :type '(alist :key-type (string :tag "Property")
3607 :value-type (function :tag "Function")))
3609 (defcustom org-use-property-inheritance nil
3610 "Non-nil means properties apply also for sublevels.
3612 This setting is chiefly used during property searches. Turning it on can
3613 cause significant overhead when doing a search, which is why it is not
3614 on by default.
3616 When nil, only the properties directly given in the current entry count.
3617 When t, every property is inherited. The value may also be a list of
3618 properties that should have inheritance, or a regular expression matching
3619 properties that should be inherited.
3621 However, note that some special properties use inheritance under special
3622 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3623 and the properties ending in \"_ALL\" when they are used as descriptor
3624 for valid values of a property.
3626 Note for programmers:
3627 When querying an entry with `org-entry-get', you can control if inheritance
3628 should be used. By default, `org-entry-get' looks only at the local
3629 properties. You can request inheritance by setting the inherit argument
3630 to t (to force inheritance) or to `selective' (to respect the setting
3631 in this variable)."
3632 :group 'org-properties
3633 :type '(choice
3634 (const :tag "Not" nil)
3635 (const :tag "Always" t)
3636 (repeat :tag "Specific properties" (string :tag "Property"))
3637 (regexp :tag "Properties matched by regexp")))
3639 (defun org-property-inherit-p (property)
3640 "Check if PROPERTY is one that should be inherited."
3641 (cond
3642 ((eq org-use-property-inheritance t) t)
3643 ((not org-use-property-inheritance) nil)
3644 ((stringp org-use-property-inheritance)
3645 (string-match org-use-property-inheritance property))
3646 ((listp org-use-property-inheritance)
3647 (member property org-use-property-inheritance))
3648 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3650 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3651 "The default column format, if no other format has been defined.
3652 This variable can be set on the per-file basis by inserting a line
3654 #+COLUMNS: %25ITEM ....."
3655 :group 'org-properties
3656 :type 'string)
3658 (defcustom org-columns-ellipses ".."
3659 "The ellipses to be used when a field in column view is truncated.
3660 When this is the empty string, as many characters as possible are shown,
3661 but then there will be no visual indication that the field has been truncated.
3662 When this is a string of length N, the last N characters of a truncated
3663 field are replaced by this string. If the column is narrower than the
3664 ellipses string, only part of the ellipses string will be shown."
3665 :group 'org-properties
3666 :type 'string)
3668 (defcustom org-columns-modify-value-for-display-function nil
3669 "Function that modifies values for display in column view.
3670 For example, it can be used to cut out a certain part from a time stamp.
3671 The function must take 2 arguments:
3673 column-title The title of the column (*not* the property name)
3674 value The value that should be modified.
3676 The function should return the value that should be displayed,
3677 or nil if the normal value should be used."
3678 :group 'org-properties
3679 :type '(choice (const nil) (function)))
3681 (defconst org-global-properties-fixed
3682 '(("VISIBILITY_ALL" . "folded children content all")
3683 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3684 "List of property/value pairs that can be inherited by any entry.
3686 These are fixed values, for the preset properties. The user variable
3687 that can be used to add to this list is `org-global-properties'.
3689 The entries in this list are cons cells where the car is a property
3690 name and cdr is a string with the value. If the value represents
3691 multiple items like an \"_ALL\" property, separate the items by
3692 spaces.")
3694 (defcustom org-global-properties nil
3695 "List of property/value pairs that can be inherited by any entry.
3697 This list will be combined with the constant `org-global-properties-fixed'.
3699 The entries in this list are cons cells where the car is a property
3700 name and cdr is a string with the value.
3702 You can set buffer-local values for the same purpose in the variable
3703 `org-file-properties' this by adding lines like
3705 #+PROPERTY: NAME VALUE"
3706 :group 'org-properties
3707 :type '(repeat
3708 (cons (string :tag "Property")
3709 (string :tag "Value"))))
3711 (defvar org-file-properties nil
3712 "List of property/value pairs that can be inherited by any entry.
3713 Valid for the current buffer.
3714 This variable is populated from #+PROPERTY lines.")
3715 (make-variable-buffer-local 'org-file-properties)
3717 (defgroup org-agenda nil
3718 "Options concerning agenda views in Org-mode."
3719 :tag "Org Agenda"
3720 :group 'org)
3722 (defvar org-category nil
3723 "Variable used by org files to set a category for agenda display.
3724 Such files should use a file variable to set it, for example
3726 # -*- mode: org; org-category: \"ELisp\"
3728 or contain a special line
3730 #+CATEGORY: ELisp
3732 If the file does not specify a category, then file's base name
3733 is used instead.")
3734 (make-variable-buffer-local 'org-category)
3735 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3737 (defcustom org-agenda-files nil
3738 "The files to be used for agenda display.
3739 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3740 \\[org-remove-file]. You can also use customize to edit the list.
3742 If an entry is a directory, all files in that directory that are matched by
3743 `org-agenda-file-regexp' will be part of the file list.
3745 If the value of the variable is not a list but a single file name, then
3746 the list of agenda files is actually stored and maintained in that file, one
3747 agenda file per line. In this file paths can be given relative to
3748 `org-directory'. Tilde expansion and environment variable substitution
3749 are also made."
3750 :group 'org-agenda
3751 :type '(choice
3752 (repeat :tag "List of files and directories" file)
3753 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3755 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3756 "Regular expression to match files for `org-agenda-files'.
3757 If any element in the list in that variable contains a directory instead
3758 of a normal file, all files in that directory that are matched by this
3759 regular expression will be included."
3760 :group 'org-agenda
3761 :type 'regexp)
3763 (defcustom org-agenda-text-search-extra-files nil
3764 "List of extra files to be searched by text search commands.
3765 These files will be searched in addition to the agenda files by the
3766 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3767 Note that these files will only be searched for text search commands,
3768 not for the other agenda views like todo lists, tag searches or the weekly
3769 agenda. This variable is intended to list notes and possibly archive files
3770 that should also be searched by these two commands.
3771 In fact, if the first element in the list is the symbol `agenda-archives',
3772 then all archive files of all agenda files will be added to the search
3773 scope."
3774 :group 'org-agenda
3775 :type '(set :greedy t
3776 (const :tag "Agenda Archives" agenda-archives)
3777 (repeat :inline t (file))))
3779 (org-defvaralias 'org-agenda-multi-occur-extra-files
3780 'org-agenda-text-search-extra-files)
3782 (defcustom org-agenda-skip-unavailable-files nil
3783 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3784 A nil value means to remove them, after a query, from the list."
3785 :group 'org-agenda
3786 :type 'boolean)
3788 (defcustom org-calendar-to-agenda-key [?c]
3789 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3790 The command `org-calendar-goto-agenda' will be bound to this key. The
3791 default is the character `c' because then `c' can be used to switch back and
3792 forth between agenda and calendar."
3793 :group 'org-agenda
3794 :type 'sexp)
3796 (defcustom org-calendar-insert-diary-entry-key [?i]
3797 "The key to be installed in `calendar-mode-map' for adding diary entries.
3798 This option is irrelevant until `org-agenda-diary-file' has been configured
3799 to point to an Org-mode file. When that is the case, the command
3800 `org-agenda-diary-entry' will be bound to the key given here, by default
3801 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3802 if you want to continue doing this, you need to change this to a different
3803 key."
3804 :group 'org-agenda
3805 :type 'sexp)
3807 (defcustom org-agenda-diary-file 'diary-file
3808 "File to which to add new entries with the `i' key in agenda and calendar.
3809 When this is the symbol `diary-file', the functionality in the Emacs
3810 calendar will be used to add entries to the `diary-file'. But when this
3811 points to a file, `org-agenda-diary-entry' will be used instead."
3812 :group 'org-agenda
3813 :type '(choice
3814 (const :tag "The standard Emacs diary file" diary-file)
3815 (file :tag "Special Org file diary entries")))
3817 (eval-after-load "calendar"
3818 '(progn
3819 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3820 'org-calendar-goto-agenda)
3821 (add-hook 'calendar-mode-hook
3822 (lambda ()
3823 (unless (eq org-agenda-diary-file 'diary-file)
3824 (define-key calendar-mode-map
3825 org-calendar-insert-diary-entry-key
3826 'org-agenda-diary-entry))))))
3828 (defgroup org-latex nil
3829 "Options for embedding LaTeX code into Org-mode."
3830 :tag "Org LaTeX"
3831 :group 'org)
3833 (defcustom org-format-latex-options
3834 '(:foreground default :background default :scale 1.0
3835 :html-foreground "Black" :html-background "Transparent"
3836 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3837 "Options for creating images from LaTeX fragments.
3838 This is a property list with the following properties:
3839 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3840 `default' means use the foreground of the default face.
3841 `auto' means use the foreground from the text face.
3842 :background the background color, or \"Transparent\".
3843 `default' means use the background of the default face.
3844 `auto' means use the background from the text face.
3845 :scale a scaling factor for the size of the images, to get more pixels
3846 :html-foreground, :html-background, :html-scale
3847 the same numbers for HTML export.
3848 :matchers a list indicating which matchers should be used to
3849 find LaTeX fragments. Valid members of this list are:
3850 \"begin\" find environments
3851 \"$1\" find single characters surrounded by $.$
3852 \"$\" find math expressions surrounded by $...$
3853 \"$$\" find math expressions surrounded by $$....$$
3854 \"\\(\" find math expressions surrounded by \\(...\\)
3855 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3856 :group 'org-latex
3857 :type 'plist)
3859 (defcustom org-format-latex-signal-error t
3860 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3861 When nil, just push out a message."
3862 :group 'org-latex
3863 :version "24.1"
3864 :type 'boolean)
3866 (defcustom org-latex-to-mathml-jar-file nil
3867 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3868 Use this to specify additional executable file say a jar file.
3870 When using MathToWeb as the converter, specify the full-path to
3871 your mathtoweb.jar file."
3872 :group 'org-latex
3873 :version "24.1"
3874 :type '(choice
3875 (const :tag "None" nil)
3876 (file :tag "JAR file" :must-match t)))
3878 (defcustom org-latex-to-mathml-convert-command nil
3879 "Command to convert LaTeX fragments to MathML.
3880 Replace format-specifiers in the command as noted below and use
3881 `shell-command' to convert LaTeX to MathML.
3882 %j: Executable file in fully expanded form as specified by
3883 `org-latex-to-mathml-jar-file'.
3884 %I: Input LaTeX file in fully expanded form
3885 %o: Output MathML file
3886 This command is used by `org-create-math-formula'.
3888 When using MathToWeb as the converter, set this to
3889 \"java -jar %j -unicode -force -df %o %I\"."
3890 :group 'org-latex
3891 :version "24.1"
3892 :type '(choice
3893 (const :tag "None" nil)
3894 (string :tag "\nShell command")))
3896 (defcustom org-latex-create-formula-image-program 'dvipng
3897 "Program to convert LaTeX fragments with.
3899 dvipng Process the LaTeX fragments to dvi file, then convert
3900 dvi files to png files using dvipng.
3901 This will also include processing of non-math environments.
3902 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3903 to convert pdf files to png files"
3904 :group 'org-latex
3905 :version "24.1"
3906 :type '(choice
3907 (const :tag "dvipng" dvipng)
3908 (const :tag "imagemagick" imagemagick)))
3910 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
3911 "Path to store latex preview images.
3912 A relative path here creates many directories relative to the
3913 processed org files paths. An absolute path puts all preview
3914 images at the same place."
3915 :group 'org-latex
3916 :version "24.3"
3917 :type 'string)
3919 (defun org-format-latex-mathml-available-p ()
3920 "Return t if `org-latex-to-mathml-convert-command' is usable."
3921 (save-match-data
3922 (when (and (boundp 'org-latex-to-mathml-convert-command)
3923 org-latex-to-mathml-convert-command)
3924 (let ((executable (car (split-string
3925 org-latex-to-mathml-convert-command))))
3926 (when (executable-find executable)
3927 (if (string-match
3928 "%j" org-latex-to-mathml-convert-command)
3929 (file-readable-p org-latex-to-mathml-jar-file)
3930 t))))))
3932 (defcustom org-format-latex-header "\\documentclass{article}
3933 \\usepackage[usenames]{color}
3934 \[PACKAGES]
3935 \[DEFAULT-PACKAGES]
3936 \\pagestyle{empty} % do not remove
3937 % The settings below are copied from fullpage.sty
3938 \\setlength{\\textwidth}{\\paperwidth}
3939 \\addtolength{\\textwidth}{-3cm}
3940 \\setlength{\\oddsidemargin}{1.5cm}
3941 \\addtolength{\\oddsidemargin}{-2.54cm}
3942 \\setlength{\\evensidemargin}{\\oddsidemargin}
3943 \\setlength{\\textheight}{\\paperheight}
3944 \\addtolength{\\textheight}{-\\headheight}
3945 \\addtolength{\\textheight}{-\\headsep}
3946 \\addtolength{\\textheight}{-\\footskip}
3947 \\addtolength{\\textheight}{-3cm}
3948 \\setlength{\\topmargin}{1.5cm}
3949 \\addtolength{\\topmargin}{-2.54cm}"
3950 "The document header used for processing LaTeX fragments.
3951 It is imperative that this header make sure that no page number
3952 appears on the page. The package defined in the variables
3953 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3954 will either replace the placeholder \"[PACKAGES]\" in this
3955 header, or they will be appended."
3956 :group 'org-latex
3957 :type 'string)
3959 (defun org-set-packages-alist (var val)
3960 "Set the packages alist and make sure it has 3 elements per entry."
3961 (set var (mapcar (lambda (x)
3962 (if (and (consp x) (= (length x) 2))
3963 (list (car x) (nth 1 x) t)
3965 val)))
3967 (defun org-get-packages-alist (var)
3968 "Get the packages alist and make sure it has 3 elements per entry."
3969 (mapcar (lambda (x)
3970 (if (and (consp x) (= (length x) 2))
3971 (list (car x) (nth 1 x) t)
3973 (default-value var)))
3975 (defcustom org-latex-default-packages-alist
3976 '(("AUTO" "inputenc" t)
3977 ("T1" "fontenc" t)
3978 ("" "fixltx2e" nil)
3979 ("" "graphicx" t)
3980 ("" "longtable" nil)
3981 ("" "float" nil)
3982 ("" "wrapfig" nil)
3983 ("" "rotating" nil)
3984 ("normalem" "ulem" t)
3985 ("" "amsmath" t)
3986 ("" "textcomp" t)
3987 ("" "marvosym" t)
3988 ("" "wasysym" t)
3989 ("" "amssymb" t)
3990 ("" "hyperref" nil)
3991 "\\tolerance=1000")
3992 "Alist of default packages to be inserted in the header.
3994 Change this only if one of the packages here causes an
3995 incompatibility with another package you are using.
3997 The packages in this list are needed by one part or another of
3998 Org mode to function properly:
4000 - inputenc, fontenc: for basic font and character selection
4001 - fixltx2e: Important patches of LaTeX itself
4002 - graphicx: for including images
4003 - longtable: For multipage tables
4004 - float, wrapfig: for figure placement
4005 - rotating: for sideways figures and tables
4006 - ulem: for underline and strike-through
4007 - amsmath: for subscript and superscript and math environments
4008 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4009 for interpreting the entities in `org-entities'. You can skip
4010 some of these packages if you don't use any of their symbols.
4011 - hyperref: for cross references
4013 Therefore you should not modify this variable unless you know
4014 what you are doing. The one reason to change it anyway is that
4015 you might be loading some other package that conflicts with one
4016 of the default packages. Each cell is of the format
4017 \( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
4018 the package also needs to be included when compiling LaTeX
4019 snippets into images for inclusion into non-LaTeX output."
4020 :group 'org-latex
4021 :group 'org-export-latex
4022 :set 'org-set-packages-alist
4023 :get 'org-get-packages-alist
4024 :version "24.1"
4025 :type '(repeat
4026 (choice
4027 (list :tag "options/package pair"
4028 (string :tag "options")
4029 (string :tag "package")
4030 (boolean :tag "Snippet"))
4031 (string :tag "A line of LaTeX"))))
4033 (defcustom org-latex-packages-alist nil
4034 "Alist of packages to be inserted in every LaTeX header.
4036 These will be inserted after `org-latex-default-packages-alist'.
4037 Each cell is of the format:
4039 \(\"options\" \"package\" snippet-flag)
4041 SNIPPET-FLAG, when t, indicates that this package is also needed
4042 when turning LaTeX snippets into images for inclusion into
4043 non-LaTeX output.
4045 Make sure that you only list packages here which:
4047 - you want in every file
4048 - do not conflict with the setup in `org-format-latex-header'.
4049 - do not conflict with the default packages in
4050 `org-latex-default-packages-alist'."
4051 :group 'org-latex
4052 :group 'org-export-latex
4053 :set 'org-set-packages-alist
4054 :get 'org-get-packages-alist
4055 :type '(repeat
4056 (choice
4057 (list :tag "options/package pair"
4058 (string :tag "options")
4059 (string :tag "package")
4060 (boolean :tag "Snippet"))
4061 (string :tag "A line of LaTeX"))))
4063 (defgroup org-appearance nil
4064 "Settings for Org-mode appearance."
4065 :tag "Org Appearance"
4066 :group 'org)
4068 (defcustom org-level-color-stars-only nil
4069 "Non-nil means fontify only the stars in each headline.
4070 When nil, the entire headline is fontified.
4071 Changing it requires restart of `font-lock-mode' to become effective
4072 also in regions already fontified."
4073 :group 'org-appearance
4074 :type 'boolean)
4076 (defcustom org-hide-leading-stars nil
4077 "Non-nil means hide the first N-1 stars in a headline.
4078 This works by using the face `org-hide' for these stars. This
4079 face is white for a light background, and black for a dark
4080 background. You may have to customize the face `org-hide' to
4081 make this work.
4082 Changing it requires restart of `font-lock-mode' to become effective
4083 also in regions already fontified.
4084 You may also set this on a per-file basis by adding one of the following
4085 lines to the buffer:
4087 #+STARTUP: hidestars
4088 #+STARTUP: showstars"
4089 :group 'org-appearance
4090 :type 'boolean)
4092 (defcustom org-hidden-keywords nil
4093 "List of symbols corresponding to keywords to be hidden the org buffer.
4094 For example, a value '(title) for this list will make the document's title
4095 appear in the buffer without the initial #+TITLE: keyword."
4096 :group 'org-appearance
4097 :version "24.1"
4098 :type '(set (const :tag "#+AUTHOR" author)
4099 (const :tag "#+DATE" date)
4100 (const :tag "#+EMAIL" email)
4101 (const :tag "#+TITLE" title)))
4103 (defcustom org-custom-properties nil
4104 "List of properties (as strings) with a special meaning.
4105 The default use of these custom properties is to let the user
4106 hide them with `org-toggle-custom-properties-visibility'."
4107 :group 'org-properties
4108 :group 'org-appearance
4109 :version "24.3"
4110 :type '(repeat (string :tag "Property Name")))
4112 (defcustom org-fontify-done-headline nil
4113 "Non-nil means change the face of a headline if it is marked DONE.
4114 Normally, only the TODO/DONE keyword indicates the state of a headline.
4115 When this is non-nil, the headline after the keyword is set to the
4116 `org-headline-done' as an additional indication."
4117 :group 'org-appearance
4118 :type 'boolean)
4120 (defcustom org-fontify-emphasized-text t
4121 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4122 Changing this variable requires a restart of Emacs to take effect."
4123 :group 'org-appearance
4124 :type 'boolean)
4126 (defcustom org-fontify-whole-heading-line nil
4127 "Non-nil means fontify the whole line for headings.
4128 This is useful when setting a background color for the
4129 org-level-* faces."
4130 :group 'org-appearance
4131 :type 'boolean)
4133 (defcustom org-highlight-latex-and-related nil
4134 "Non-nil means highlight LaTeX related syntax in the buffer.
4135 When non nil, the value should be a list containing any of the
4136 following symbols:
4137 `latex' Highlight LaTeX snippets and environments.
4138 `script' Highlight subscript and superscript.
4139 `entities' Highlight entities."
4140 :group 'org-appearance
4141 :version "24.4"
4142 :package-version '(Org . "8.0")
4143 :type '(choice
4144 (const :tag "No highlighting" nil)
4145 (set :greedy t :tag "Highlight"
4146 (const :tag "LaTeX snippets and environments" latex)
4147 (const :tag "Subscript and superscript" script)
4148 (const :tag "Entities" entities))))
4150 (defcustom org-hide-emphasis-markers nil
4151 "Non-nil mean font-lock should hide the emphasis marker characters."
4152 :group 'org-appearance
4153 :type 'boolean)
4155 (defcustom org-pretty-entities nil
4156 "Non-nil means show entities as UTF8 characters.
4157 When nil, the \\name form remains in the buffer."
4158 :group 'org-appearance
4159 :version "24.1"
4160 :type 'boolean)
4162 (defcustom org-pretty-entities-include-sub-superscripts t
4163 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4164 :group 'org-appearance
4165 :version "24.1"
4166 :type 'boolean)
4168 (defvar org-emph-re nil
4169 "Regular expression for matching emphasis.
4170 After a match, the match groups contain these elements:
4171 0 The match of the full regular expression, including the characters
4172 before and after the proper match
4173 1 The character before the proper match, or empty at beginning of line
4174 2 The proper match, including the leading and trailing markers
4175 3 The leading marker like * or /, indicating the type of highlighting
4176 4 The text between the emphasis markers, not including the markers
4177 5 The character after the match, empty at the end of a line")
4178 (defvar org-verbatim-re nil
4179 "Regular expression for matching verbatim text.")
4180 (defvar org-emphasis-regexp-components) ; defined just below
4181 (defvar org-emphasis-alist) ; defined just below
4182 (defun org-set-emph-re (var val)
4183 "Set variable and compute the emphasis regular expression."
4184 (set var val)
4185 (when (and (boundp 'org-emphasis-alist)
4186 (boundp 'org-emphasis-regexp-components)
4187 org-emphasis-alist org-emphasis-regexp-components)
4188 (let* ((e org-emphasis-regexp-components)
4189 (pre (car e))
4190 (post (nth 1 e))
4191 (border (nth 2 e))
4192 (body (nth 3 e))
4193 (nl (nth 4 e))
4194 (body1 (concat body "*?"))
4195 (markers (mapconcat 'car org-emphasis-alist ""))
4196 (vmarkers (mapconcat
4197 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4198 org-emphasis-alist "")))
4199 ;; make sure special characters appear at the right position in the class
4200 (if (string-match "\\^" markers)
4201 (setq markers (concat (replace-match "" t t markers) "^")))
4202 (if (string-match "-" markers)
4203 (setq markers (concat (replace-match "" t t markers) "-")))
4204 (if (string-match "\\^" vmarkers)
4205 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4206 (if (string-match "-" vmarkers)
4207 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4208 (if (> nl 0)
4209 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4210 (int-to-string nl) "\\}")))
4211 ;; Make the regexp
4212 (setq org-emph-re
4213 (concat "\\([" pre "]\\|^\\)"
4214 "\\("
4215 "\\([" markers "]\\)"
4216 "\\("
4217 "[^" border "]\\|"
4218 "[^" border "]"
4219 body1
4220 "[^" border "]"
4221 "\\)"
4222 "\\3\\)"
4223 "\\([" post "]\\|$\\)"))
4224 (setq org-verbatim-re
4225 (concat "\\([" pre "]\\|^\\)"
4226 "\\("
4227 "\\([" vmarkers "]\\)"
4228 "\\("
4229 "[^" border "]\\|"
4230 "[^" border "]"
4231 body1
4232 "[^" border "]"
4233 "\\)"
4234 "\\3\\)"
4235 "\\([" post "]\\|$\\)")))))
4237 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4238 ;; set this option proved cumbersome. See this message/thread:
4239 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4240 (defvar org-emphasis-regexp-components
4241 '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
4242 "Components used to build the regular expression for emphasis.
4243 This is a list with five entries. Terminology: In an emphasis string
4244 like \" *strong word* \", we call the initial space PREMATCH, the final
4245 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4246 and \"trong wor\" is the body. The different components in this variable
4247 specify what is allowed/forbidden in each part:
4249 pre Chars allowed as prematch. Beginning of line will be allowed too.
4250 post Chars allowed as postmatch. End of line will be allowed too.
4251 border The chars *forbidden* as border characters.
4252 body-regexp A regexp like \".\" to match a body character. Don't use
4253 non-shy groups here, and don't allow newline here.
4254 newline The maximum number of newlines allowed in an emphasis exp.
4256 You need to reload Org or to restart Emacs after customizing this.")
4258 (defcustom org-emphasis-alist
4259 `(("*" bold)
4260 ("/" italic)
4261 ("_" underline)
4262 ("=" org-code verbatim)
4263 ("~" org-verbatim verbatim)
4264 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4265 "Alist of characters and faces to emphasize text.
4266 Text starting and ending with a special character will be emphasized,
4267 for example *bold*, _underlined_ and /italic/. This variable sets the
4268 marker characters and the face to be used by font-lock for highlighting
4269 in Org-mode Emacs buffers.
4271 You need to reload Org or to restart Emacs after customizing this."
4272 :group 'org-appearance
4273 :set 'org-set-emph-re
4274 :version "24.4"
4275 :package-version '(Org . "8.0")
4276 :type '(repeat
4277 (list
4278 (string :tag "Marker character")
4279 (choice
4280 (face :tag "Font-lock-face")
4281 (plist :tag "Face property list"))
4282 (option (const verbatim)))))
4284 (defvar org-protecting-blocks
4285 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4286 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4287 This is needed for font-lock setup.")
4289 ;;; Miscellaneous options
4291 (defgroup org-completion nil
4292 "Completion in Org-mode."
4293 :tag "Org Completion"
4294 :group 'org)
4296 (defcustom org-completion-use-ido nil
4297 "Non-nil means use ido completion wherever possible.
4298 Note that `ido-mode' must be active for this variable to be relevant.
4299 If you decide to turn this variable on, you might well want to turn off
4300 `org-outline-path-complete-in-steps'.
4301 See also `org-completion-use-iswitchb'."
4302 :group 'org-completion
4303 :type 'boolean)
4305 (defcustom org-completion-use-iswitchb nil
4306 "Non-nil means use iswitchb completion wherever possible.
4307 Note that `iswitchb-mode' must be active for this variable to be relevant.
4308 If you decide to turn this variable on, you might well want to turn off
4309 `org-outline-path-complete-in-steps'.
4310 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4311 :group 'org-completion
4312 :type 'boolean)
4314 (defcustom org-completion-fallback-command 'hippie-expand
4315 "The expansion command called by \\[pcomplete] in normal context.
4316 Normal means, no org-mode-specific context."
4317 :group 'org-completion
4318 :type 'function)
4320 ;;; Functions and variables from their packages
4321 ;; Declared here to avoid compiler warnings
4323 ;; XEmacs only
4324 (defvar outline-mode-menu-heading)
4325 (defvar outline-mode-menu-show)
4326 (defvar outline-mode-menu-hide)
4327 (defvar zmacs-regions) ; XEmacs regions
4329 ;; Emacs only
4330 (defvar mark-active)
4332 ;; Various packages
4333 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4334 (declare-function calendar-forward-day "cal-move" (arg))
4335 (declare-function calendar-goto-date "cal-move" (date))
4336 (declare-function calendar-goto-today "cal-move" ())
4337 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4338 (defvar calc-embedded-close-formula)
4339 (defvar calc-embedded-open-formula)
4340 (declare-function cdlatex-tab "ext:cdlatex" ())
4341 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4342 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4343 (defvar font-lock-unfontify-region-function)
4344 (declare-function iswitchb-read-buffer "iswitchb"
4345 (prompt &optional default require-match start matches-set))
4346 (defvar iswitchb-temp-buflist)
4347 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4348 (defvar org-agenda-tags-todo-honor-ignore-options)
4349 (declare-function org-agenda-skip "org-agenda" ())
4350 (declare-function
4351 org-agenda-format-item "org-agenda"
4352 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4353 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4354 (declare-function org-agenda-change-all-lines "org-agenda"
4355 (newhead hdmarker &optional fixface just-this))
4356 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4357 (declare-function org-agenda-maybe-redo "org-agenda" ())
4358 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4359 (beg end))
4360 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4361 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4362 "org-agenda" (&optional end))
4363 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4364 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4365 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4366 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4367 (declare-function org-indent-mode "org-indent" (&optional arg))
4368 (declare-function parse-time-string "parse-time" (string))
4369 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4370 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4371 (defvar remember-data-file)
4372 (defvar texmathp-why)
4373 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4374 (declare-function table--at-cell-p "table" (position &optional object at-column))
4376 ;;;###autoload
4377 (defun turn-on-orgtbl ()
4378 "Unconditionally turn on `orgtbl-mode'."
4379 (require 'org-table)
4380 (orgtbl-mode 1))
4382 (defun org-at-table-p (&optional table-type)
4383 "Return t if the cursor is inside an org-type table.
4384 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4385 (if org-enable-table-editor
4386 (save-excursion
4387 (beginning-of-line 1)
4388 (looking-at (if table-type org-table-any-line-regexp
4389 org-table-line-regexp)))
4390 nil))
4391 (defsubst org-table-p () (org-at-table-p))
4393 (defun org-at-table.el-p ()
4394 "Return t if and only if we are at a table.el table."
4395 (and (org-at-table-p 'any)
4396 (save-excursion
4397 (goto-char (org-table-begin 'any))
4398 (looking-at org-table1-hline-regexp))))
4400 (defun org-table-recognize-table.el ()
4401 "If there is a table.el table nearby, recognize it and move into it."
4402 (if org-table-tab-recognizes-table.el
4403 (if (org-at-table.el-p)
4404 (progn
4405 (beginning-of-line 1)
4406 (if (looking-at org-table-dataline-regexp)
4408 (if (looking-at org-table1-hline-regexp)
4409 (progn
4410 (beginning-of-line 2)
4411 (if (looking-at org-table-any-border-regexp)
4412 (beginning-of-line -1)))))
4413 (if (re-search-forward "|" (org-table-end t) t)
4414 (progn
4415 (require 'table)
4416 (if (table--at-cell-p (point))
4418 (message "recognizing table.el table...")
4419 (table-recognize-table)
4420 (message "recognizing table.el table...done")))
4421 (error "This should not happen"))
4423 nil)
4424 nil))
4426 (defun org-at-table-hline-p ()
4427 "Return t if the cursor is inside a hline in a table."
4428 (if org-enable-table-editor
4429 (save-excursion
4430 (beginning-of-line 1)
4431 (looking-at org-table-hline-regexp))
4432 nil))
4434 (defun org-table-map-tables (function &optional quietly)
4435 "Apply FUNCTION to the start of all tables in the buffer."
4436 (save-excursion
4437 (save-restriction
4438 (widen)
4439 (goto-char (point-min))
4440 (while (re-search-forward org-table-any-line-regexp nil t)
4441 (unless quietly
4442 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4443 (beginning-of-line 1)
4444 (when (and (looking-at org-table-line-regexp)
4445 ;; Exclude tables in src/example/verbatim/clocktable blocks
4446 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4447 (save-excursion (funcall function))
4448 (or (looking-at org-table-line-regexp)
4449 (forward-char 1)))
4450 (re-search-forward org-table-any-border-regexp nil 1))))
4451 (unless quietly (message "Mapping tables: done")))
4453 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4454 (declare-function org-clock-update-mode-line "org-clock" ())
4455 (declare-function org-resolve-clocks "org-clock"
4456 (&optional also-non-dangling-p prompt last-valid))
4458 (defun org-at-TBLFM-p (&optional pos)
4459 "Return t when point (or POS) is in #+TBLFM line."
4460 (save-excursion
4461 (let ((pos pos)))
4462 (goto-char (or pos (point)))
4463 (beginning-of-line 1)
4464 (looking-at org-TBLFM-regexp)))
4466 (defvar org-clock-start-time)
4467 (defvar org-clock-marker (make-marker)
4468 "Marker recording the last clock-in.")
4469 (defvar org-clock-hd-marker (make-marker)
4470 "Marker recording the last clock-in, but the headline position.")
4471 (defvar org-clock-heading ""
4472 "The heading of the current clock entry.")
4473 (defun org-clock-is-active ()
4474 "Return the buffer where the clock is currently running.
4475 Return nil if no clock is running."
4476 (marker-buffer org-clock-marker))
4478 (defun org-check-running-clock ()
4479 "Check if the current buffer contains the running clock.
4480 If yes, offer to stop it and to save the buffer with the changes."
4481 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4482 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4483 (buffer-name))))
4484 (org-clock-out)
4485 (when (y-or-n-p "Save changed buffer?")
4486 (save-buffer))))
4488 (defun org-clocktable-try-shift (dir n)
4489 "Check if this line starts a clock table, if yes, shift the time block."
4490 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4491 (org-clocktable-shift dir n)))
4493 ;;;###autoload
4494 (defun org-clock-persistence-insinuate ()
4495 "Set up hooks for clock persistence."
4496 (require 'org-clock)
4497 (add-hook 'org-mode-hook 'org-clock-load)
4498 (add-hook 'kill-emacs-hook 'org-clock-save))
4500 (defgroup org-archive nil
4501 "Options concerning archiving in Org-mode."
4502 :tag "Org Archive"
4503 :group 'org-structure)
4505 (defcustom org-archive-location "%s_archive::"
4506 "The location where subtrees should be archived.
4508 The value of this variable is a string, consisting of two parts,
4509 separated by a double-colon. The first part is a filename and
4510 the second part is a headline.
4512 When the filename is omitted, archiving happens in the same file.
4513 %s in the filename will be replaced by the current file
4514 name (without the directory part). Archiving to a different file
4515 is useful to keep archived entries from contributing to the
4516 Org-mode Agenda.
4518 The archived entries will be filed as subtrees of the specified
4519 headline. When the headline is omitted, the subtrees are simply
4520 filed away at the end of the file, as top-level entries. Also in
4521 the heading you can use %s to represent the file name, this can be
4522 useful when using the same archive for a number of different files.
4524 Here are a few examples:
4525 \"%s_archive::\"
4526 If the current file is Projects.org, archive in file
4527 Projects.org_archive, as top-level trees. This is the default.
4529 \"::* Archived Tasks\"
4530 Archive in the current file, under the top-level headline
4531 \"* Archived Tasks\".
4533 \"~/org/archive.org::\"
4534 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4536 \"~/org/archive.org::* From %s\"
4537 Archive in file ~/org/archive.org (absolute path), under headlines
4538 \"From FILENAME\" where file name is the current file name.
4540 \"~/org/datetree.org::datetree/* Finished Tasks\"
4541 The \"datetree/\" string is special, signifying to archive
4542 items to the datetree. Items are placed in either the CLOSED
4543 date of the item, or the current date if there is no CLOSED date.
4544 The heading will be a subentry to the current date. There doesn't
4545 need to be a heading, but there always needs to be a slash after
4546 datetree. For example, to store archived items directly in the
4547 datetree, use \"~/org/datetree.org::datetree/\".
4549 \"basement::** Finished Tasks\"
4550 Archive in file ./basement (relative path), as level 3 trees
4551 below the level 2 heading \"** Finished Tasks\".
4553 You may set this option on a per-file basis by adding to the buffer a
4554 line like
4556 #+ARCHIVE: basement::** Finished Tasks
4558 You may also define it locally for a subtree by setting an ARCHIVE property
4559 in the entry. If such a property is found in an entry, or anywhere up
4560 the hierarchy, it will be used."
4561 :group 'org-archive
4562 :type 'string)
4564 (defcustom org-agenda-skip-archived-trees t
4565 "Non-nil means the agenda will skip any items located in archived trees.
4566 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4567 variable is no longer recommended, you should leave it at the value t.
4568 Instead, use the key `v' to cycle the archives-mode in the agenda."
4569 :group 'org-archive
4570 :group 'org-agenda-skip
4571 :type 'boolean)
4573 (defcustom org-columns-skip-archived-trees t
4574 "Non-nil means ignore archived trees when creating column view."
4575 :group 'org-archive
4576 :group 'org-properties
4577 :type 'boolean)
4579 (defcustom org-cycle-open-archived-trees nil
4580 "Non-nil means `org-cycle' will open archived trees.
4581 An archived tree is a tree marked with the tag ARCHIVE.
4582 When nil, archived trees will stay folded. You can still open them with
4583 normal outline commands like `show-all', but not with the cycling commands."
4584 :group 'org-archive
4585 :group 'org-cycle
4586 :type 'boolean)
4588 (defcustom org-sparse-tree-open-archived-trees nil
4589 "Non-nil means sparse tree construction shows matches in archived trees.
4590 When nil, matches in these trees are highlighted, but the trees are kept in
4591 collapsed state."
4592 :group 'org-archive
4593 :group 'org-sparse-trees
4594 :type 'boolean)
4596 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4597 "The default date type when building a sparse tree.
4598 When this is nil, a date is a scheduled or a deadline timestamp.
4599 Otherwise, these types are allowed:
4601 all: all timestamps
4602 active: only active timestamps (<...>)
4603 inactive: only inactive timestamps (<...)
4604 scheduled: only scheduled timestamps
4605 deadline: only deadline timestamps"
4606 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4607 (const :tag "All timestamps" all)
4608 (const :tag "Only active timestamps" active)
4609 (const :tag "Only inactive timestamps" inactive)
4610 (const :tag "Only scheduled timestamps" scheduled)
4611 (const :tag "Only deadline timestamps" deadline)
4612 (const :tag "Only closed timestamps" closed))
4613 :version "24.3"
4614 :group 'org-sparse-trees)
4616 (defun org-cycle-hide-archived-subtrees (state)
4617 "Re-hide all archived subtrees after a visibility state change."
4618 (when (and (not org-cycle-open-archived-trees)
4619 (not (memq state '(overview folded))))
4620 (save-excursion
4621 (let* ((globalp (memq state '(contents all)))
4622 (beg (if globalp (point-min) (point)))
4623 (end (if globalp (point-max) (org-end-of-subtree t))))
4624 (org-hide-archived-subtrees beg end)
4625 (goto-char beg)
4626 (if (looking-at (concat ".*:" org-archive-tag ":"))
4627 (message "%s" (substitute-command-keys
4628 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4630 (defun org-force-cycle-archived ()
4631 "Cycle subtree even if it is archived."
4632 (interactive)
4633 (setq this-command 'org-cycle)
4634 (let ((org-cycle-open-archived-trees t))
4635 (call-interactively 'org-cycle)))
4637 (defun org-hide-archived-subtrees (beg end)
4638 "Re-hide all archived subtrees after a visibility state change."
4639 (save-excursion
4640 (let* ((re (concat ":" org-archive-tag ":")))
4641 (goto-char beg)
4642 (while (re-search-forward re end t)
4643 (when (org-at-heading-p)
4644 (org-flag-subtree t)
4645 (org-end-of-subtree t))))))
4647 (declare-function outline-end-of-heading "outline" ())
4648 (declare-function outline-flag-region "outline" (from to flag))
4649 (defun org-flag-subtree (flag)
4650 (save-excursion
4651 (org-back-to-heading t)
4652 (outline-end-of-heading)
4653 (outline-flag-region (point)
4654 (progn (org-end-of-subtree t) (point))
4655 flag)))
4657 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4659 ;; Declare Column View Code
4661 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4662 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4663 (declare-function org-columns-compute "org-colview" (property))
4665 ;; Declare ID code
4667 (declare-function org-id-store-link "org-id")
4668 (declare-function org-id-locations-load "org-id")
4669 (declare-function org-id-locations-save "org-id")
4670 (defvar org-id-track-globally)
4672 ;;; Variables for pre-computed regular expressions, all buffer local
4674 (defvar org-todo-regexp nil
4675 "Matches any of the TODO state keywords.")
4676 (make-variable-buffer-local 'org-todo-regexp)
4677 (defvar org-not-done-regexp nil
4678 "Matches any of the TODO state keywords except the last one.")
4679 (make-variable-buffer-local 'org-not-done-regexp)
4680 (defvar org-not-done-heading-regexp nil
4681 "Matches a TODO headline that is not done.")
4682 (make-variable-buffer-local 'org-not-done-regexp)
4683 (defvar org-todo-line-regexp nil
4684 "Matches a headline and puts TODO state into group 2 if present.")
4685 (make-variable-buffer-local 'org-todo-line-regexp)
4686 (defvar org-complex-heading-regexp nil
4687 "Matches a headline and puts everything into groups:
4688 group 1: the stars
4689 group 2: The todo keyword, maybe
4690 group 3: Priority cookie
4691 group 4: True headline
4692 group 5: Tags")
4693 (make-variable-buffer-local 'org-complex-heading-regexp)
4694 (defvar org-complex-heading-regexp-format nil
4695 "Printf format to make regexp to match an exact headline.
4696 This regexp will match the headline of any node which has the
4697 exact headline text that is put into the format, but may have any
4698 TODO state, priority and tags.")
4699 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4700 (defvar org-todo-line-tags-regexp nil
4701 "Matches a headline and puts TODO state into group 2 if present.
4702 Also put tags into group 4 if tags are present.")
4703 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4704 (defvar org-ds-keyword-length 12
4705 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4706 (make-variable-buffer-local 'org-ds-keyword-length)
4707 (defvar org-deadline-regexp nil
4708 "Matches the DEADLINE keyword.")
4709 (make-variable-buffer-local 'org-deadline-regexp)
4710 (defvar org-deadline-time-regexp nil
4711 "Matches the DEADLINE keyword together with a time stamp.")
4712 (make-variable-buffer-local 'org-deadline-time-regexp)
4713 (defvar org-deadline-time-hour-regexp nil
4714 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4715 (make-variable-buffer-local 'org-deadline-time-hour-regexp)
4716 (defvar org-deadline-line-regexp nil
4717 "Matches the DEADLINE keyword and the rest of the line.")
4718 (make-variable-buffer-local 'org-deadline-line-regexp)
4719 (defvar org-scheduled-regexp nil
4720 "Matches the SCHEDULED keyword.")
4721 (make-variable-buffer-local 'org-scheduled-regexp)
4722 (defvar org-scheduled-time-regexp nil
4723 "Matches the SCHEDULED keyword together with a time stamp.")
4724 (make-variable-buffer-local 'org-scheduled-time-regexp)
4725 (defvar org-scheduled-time-hour-regexp nil
4726 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4727 (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
4728 (defvar org-closed-time-regexp nil
4729 "Matches the CLOSED keyword together with a time stamp.")
4730 (make-variable-buffer-local 'org-closed-time-regexp)
4732 (defvar org-keyword-time-regexp nil
4733 "Matches any of the 4 keywords, together with the time stamp.")
4734 (make-variable-buffer-local 'org-keyword-time-regexp)
4735 (defvar org-keyword-time-not-clock-regexp nil
4736 "Matches any of the 3 keywords, together with the time stamp.")
4737 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
4738 (defvar org-maybe-keyword-time-regexp nil
4739 "Matches a timestamp, possibly preceded by a keyword.")
4740 (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
4741 (defvar org-all-time-keywords nil
4742 "List of time keywords.")
4743 (make-variable-buffer-local 'org-all-time-keywords)
4745 (defconst org-plain-time-of-day-regexp
4746 (concat
4747 "\\(\\<[012]?[0-9]"
4748 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4749 "\\(--?"
4750 "\\(\\<[012]?[0-9]"
4751 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4752 "\\)?")
4753 "Regular expression to match a plain time or time range.
4754 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4755 groups carry important information:
4756 0 the full match
4757 1 the first time, range or not
4758 8 the second time, if it is a range.")
4760 (defconst org-plain-time-extension-regexp
4761 (concat
4762 "\\(\\<[012]?[0-9]"
4763 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4764 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4765 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4766 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4767 groups carry important information:
4768 0 the full match
4769 7 hours of duration
4770 9 minutes of duration")
4772 (defconst org-stamp-time-of-day-regexp
4773 (concat
4774 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4775 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4776 "\\(--?"
4777 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4778 "Regular expression to match a timestamp time or time range.
4779 After a match, the following groups carry important information:
4780 0 the full match
4781 1 date plus weekday, for back referencing to make sure both times are on the same day
4782 2 the first time, range or not
4783 4 the second time, if it is a range.")
4785 (defconst org-startup-options
4786 '(("fold" org-startup-folded t)
4787 ("overview" org-startup-folded t)
4788 ("nofold" org-startup-folded nil)
4789 ("showall" org-startup-folded nil)
4790 ("showeverything" org-startup-folded showeverything)
4791 ("content" org-startup-folded content)
4792 ("indent" org-startup-indented t)
4793 ("noindent" org-startup-indented nil)
4794 ("hidestars" org-hide-leading-stars t)
4795 ("showstars" org-hide-leading-stars nil)
4796 ("odd" org-odd-levels-only t)
4797 ("oddeven" org-odd-levels-only nil)
4798 ("align" org-startup-align-all-tables t)
4799 ("noalign" org-startup-align-all-tables nil)
4800 ("inlineimages" org-startup-with-inline-images t)
4801 ("noinlineimages" org-startup-with-inline-images nil)
4802 ("latexpreview" org-startup-with-latex-preview t)
4803 ("nolatexpreview" org-startup-with-latex-preview nil)
4804 ("customtime" org-display-custom-times t)
4805 ("logdone" org-log-done time)
4806 ("lognotedone" org-log-done note)
4807 ("nologdone" org-log-done nil)
4808 ("lognoteclock-out" org-log-note-clock-out t)
4809 ("nolognoteclock-out" org-log-note-clock-out nil)
4810 ("logrepeat" org-log-repeat state)
4811 ("lognoterepeat" org-log-repeat note)
4812 ("logdrawer" org-log-into-drawer t)
4813 ("nologdrawer" org-log-into-drawer nil)
4814 ("logstatesreversed" org-log-states-order-reversed t)
4815 ("nologstatesreversed" org-log-states-order-reversed nil)
4816 ("nologrepeat" org-log-repeat nil)
4817 ("logreschedule" org-log-reschedule time)
4818 ("lognotereschedule" org-log-reschedule note)
4819 ("nologreschedule" org-log-reschedule nil)
4820 ("logredeadline" org-log-redeadline time)
4821 ("lognoteredeadline" org-log-redeadline note)
4822 ("nologredeadline" org-log-redeadline nil)
4823 ("logrefile" org-log-refile time)
4824 ("lognoterefile" org-log-refile note)
4825 ("nologrefile" org-log-refile nil)
4826 ("fninline" org-footnote-define-inline t)
4827 ("nofninline" org-footnote-define-inline nil)
4828 ("fnlocal" org-footnote-section nil)
4829 ("fnauto" org-footnote-auto-label t)
4830 ("fnprompt" org-footnote-auto-label nil)
4831 ("fnconfirm" org-footnote-auto-label confirm)
4832 ("fnplain" org-footnote-auto-label plain)
4833 ("fnadjust" org-footnote-auto-adjust t)
4834 ("nofnadjust" org-footnote-auto-adjust nil)
4835 ("constcgs" constants-unit-system cgs)
4836 ("constSI" constants-unit-system SI)
4837 ("noptag" org-tag-persistent-alist nil)
4838 ("hideblocks" org-hide-block-startup t)
4839 ("nohideblocks" org-hide-block-startup nil)
4840 ("beamer" org-startup-with-beamer-mode t)
4841 ("entitiespretty" org-pretty-entities t)
4842 ("entitiesplain" org-pretty-entities nil))
4843 "Variable associated with STARTUP options for org-mode.
4844 Each element is a list of three items: the startup options (as written
4845 in the #+STARTUP line), the corresponding variable, and the value to set
4846 this variable to if the option is found. An optional forth element PUSH
4847 means to push this value onto the list in the variable.")
4849 (defun org-update-property-plist (key val props)
4850 "Update PROPS with KEY and VAL."
4851 (let* ((appending (string= "+" (substring key (- (length key) 1))))
4852 (key (if appending (substring key 0 (- (length key) 1)) key))
4853 (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
4854 (previous (cdr (assoc key props))))
4855 (if appending
4856 (cons (cons key (if previous (concat previous " " val) val)) remainder)
4857 (cons (cons key val) remainder))))
4859 (defcustom org-group-tags t
4860 "When non-nil (the default), use group tags.
4861 This can be turned on/off through `org-toggle-tags-groups'."
4862 :group 'org-tags
4863 :group 'org-startup
4864 :type 'boolean)
4866 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4868 (defun org-toggle-tags-groups ()
4869 "Toggle support for group tags.
4870 Support for group tags is controlled by the option
4871 `org-group-tags', which is non-nil by default."
4872 (interactive)
4873 (setq org-group-tags (not org-group-tags))
4874 (cond ((and (derived-mode-p 'org-agenda-mode)
4875 org-group-tags)
4876 (org-agenda-redo))
4877 ((derived-mode-p 'org-mode)
4878 (let ((org-inhibit-startup t)) (org-mode))))
4879 (message "Groups tags support has been turned %s"
4880 (if org-group-tags "on" "off")))
4882 (defun org-set-regexps-and-options-for-tags ()
4883 "Precompute variables used for tags."
4884 (when (derived-mode-p 'org-mode)
4885 (org-set-local 'org-file-tags nil)
4886 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4887 (splitre "[ \t]+")
4888 (start 0)
4889 tags ftags key value)
4890 (save-excursion
4891 (save-restriction
4892 (widen)
4893 (goto-char (point-min))
4894 (while (re-search-forward re nil t)
4895 (setq key (upcase (org-match-string-no-properties 1))
4896 value (org-match-string-no-properties 2))
4897 (if (stringp value) (setq value (org-trim value)))
4898 (cond
4899 ((equal key "TAGS")
4900 (setq tags (append tags (if tags '("\\n") nil)
4901 (org-split-string value splitre))))
4902 ((equal key "FILETAGS")
4903 (when (string-match "\\S-" value)
4904 (setq ftags
4905 (append
4906 ftags
4907 (apply 'append
4908 (mapcar (lambda (x) (org-split-string x ":"))
4909 (org-split-string value)))))))))))
4910 ;; Process the file tags.
4911 (and ftags (org-set-local 'org-file-tags
4912 (mapcar 'org-add-prop-inherited ftags)))
4913 (org-set-local 'org-tag-groups-alist nil)
4914 ;; Process the tags.
4915 (when (and (not tags) org-tag-alist)
4916 (setq tags
4917 (mapcar
4918 (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
4919 ((eq (car tg) :endgroup) "}")
4920 ((eq (car tg) :grouptags) ":")
4921 ((eq (car tg) :newline) "\n")
4922 (t (concat (car tg)
4923 (if (characterp (cdr tg))
4924 (format "(%s)" (char-to-string (cdr tg))) "")))))
4925 org-tag-alist)))
4926 (let (e tgs g)
4927 (while (setq e (pop tags))
4928 (cond
4929 ((equal e "{")
4930 (progn (push '(:startgroup) tgs)
4931 (when (equal (nth 1 tags) ":")
4932 (push (list (replace-regexp-in-string
4933 "(.+)$" "" (nth 0 tags)))
4934 org-tag-groups-alist)
4935 (setq g 0))))
4936 ((equal e ":") (push '(:grouptags) tgs))
4937 ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
4938 ((equal e "\\n") (push '(:newline) tgs))
4939 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
4940 (push (cons (match-string 1 e)
4941 (string-to-char (match-string 2 e))) tgs)
4942 (if (and g (> g 0))
4943 (setcar org-tag-groups-alist
4944 (append (car org-tag-groups-alist)
4945 (list (match-string 1 e)))))
4946 (if g (setq g (1+ g))))
4947 (t (push (list e) tgs)
4948 (if (and g (> g 0))
4949 (setcar org-tag-groups-alist
4950 (append (car org-tag-groups-alist) (list e))))
4951 (if g (setq g (1+ g))))))
4952 (org-set-local 'org-tag-alist nil)
4953 (while (setq e (pop tgs))
4954 (or (and (stringp (car e))
4955 (assoc (car e) org-tag-alist))
4956 (push e org-tag-alist)))
4957 ;; Return a list with tag variables
4958 (list org-file-tags org-tag-alist org-tag-groups-alist)))))
4960 (defvar org-ota nil)
4961 (defun org-set-regexps-and-options ()
4962 "Precompute regular expressions used in the current buffer."
4963 (when (derived-mode-p 'org-mode)
4964 (org-set-local 'org-todo-kwd-alist nil)
4965 (org-set-local 'org-todo-key-alist nil)
4966 (org-set-local 'org-todo-key-trigger nil)
4967 (org-set-local 'org-todo-keywords-1 nil)
4968 (org-set-local 'org-done-keywords nil)
4969 (org-set-local 'org-todo-heads nil)
4970 (org-set-local 'org-todo-sets nil)
4971 (org-set-local 'org-todo-log-states nil)
4972 (org-set-local 'org-file-properties nil)
4973 (let ((re (org-make-options-regexp
4974 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
4975 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
4976 "SETUPFILE" "OPTIONS")
4977 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4978 (splitre "[ \t]+")
4979 (scripts org-use-sub-superscripts)
4980 kwds kws0 kwsa key log value cat arch const links hw dws
4981 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4982 (start 0))
4983 (save-excursion
4984 (save-restriction
4985 (widen)
4986 (goto-char (point-min))
4987 (while
4988 (or (and
4989 ext-setup-or-nil
4990 (not org-ota)
4991 (let (ret)
4992 (with-temp-buffer
4993 (insert ext-setup-or-nil)
4994 (let ((major-mode 'org-mode) org-ota)
4995 (setq ret (save-match-data
4996 (org-set-regexps-and-options-for-tags)))))
4997 ;; Append setupfile tags to existing tags
4998 (setq org-ota t)
4999 (setq org-file-tags
5000 (delq nil (append org-file-tags (nth 0 ret)))
5001 org-tag-alist
5002 (delq nil (append org-tag-alist (nth 1 ret)))
5003 org-tag-groups-alist
5004 (delq nil (append org-tag-groups-alist (nth 2 ret))))))
5005 (and ext-setup-or-nil
5006 (string-match re ext-setup-or-nil start)
5007 (setq start (match-end 0)))
5008 (and (setq ext-setup-or-nil nil start 0)
5009 (re-search-forward re nil t)))
5010 (setq key (upcase (match-string 1 ext-setup-or-nil))
5011 value (org-match-string-no-properties 2 ext-setup-or-nil))
5012 (if (stringp value) (setq value (org-trim value)))
5013 (cond
5014 ((equal key "CATEGORY")
5015 (setq cat value))
5016 ((member key '("SEQ_TODO" "TODO"))
5017 (push (cons 'sequence (org-split-string value splitre)) kwds))
5018 ((equal key "TYP_TODO")
5019 (push (cons 'type (org-split-string value splitre)) kwds))
5020 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
5021 ;; general TODO-like setup
5022 (push (cons (intern (downcase (match-string 1 key)))
5023 (org-split-string value splitre)) kwds))
5024 ((equal key "COLUMNS")
5025 (org-set-local 'org-columns-default-format value))
5026 ((equal key "LINK")
5027 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5028 (push (cons (match-string 1 value)
5029 (org-trim (match-string 2 value)))
5030 links)))
5031 ((equal key "PRIORITIES")
5032 (setq prio (org-split-string value " +")))
5033 ((equal key "PROPERTY")
5034 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5035 (setq props (org-update-property-plist (match-string 1 value)
5036 (match-string 2 value)
5037 props))))
5038 ((equal key "CONSTANTS")
5039 (org-table-set-constants))
5040 ((equal key "STARTUP")
5041 (let ((opts (org-split-string value splitre))
5042 l var val)
5043 (while (setq l (pop opts))
5044 (when (setq l (assoc l org-startup-options))
5045 (setq var (nth 1 l) val (nth 2 l))
5046 (if (not (nth 3 l))
5047 (set (make-local-variable var) val)
5048 (if (not (listp (symbol-value var)))
5049 (set (make-local-variable var) nil))
5050 (set (make-local-variable var) (symbol-value var))
5051 (add-to-list var val))))))
5052 ((equal key "ARCHIVE")
5053 (setq arch value)
5054 (remove-text-properties 0 (length arch)
5055 '(face t fontified t) arch))
5056 ((equal key "OPTIONS")
5057 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
5058 (setq scripts (read (match-string 2 value)))))
5059 ((and (equal key "SETUPFILE")
5060 ;; Prevent checking in Gnus messages
5061 (not buffer-read-only))
5062 (setq setup-contents (org-file-contents
5063 (expand-file-name
5064 (org-remove-double-quotes value))
5065 'noerror))
5066 (if (not ext-setup-or-nil)
5067 (setq ext-setup-or-nil setup-contents start 0)
5068 (setq ext-setup-or-nil
5069 (concat (substring ext-setup-or-nil 0 start)
5070 "\n" setup-contents "\n"
5071 (substring ext-setup-or-nil start)))))))
5072 ;; search for property blocks
5073 (goto-char (point-min))
5074 (while (re-search-forward org-block-regexp nil t)
5075 (when (equal "PROPERTY" (upcase (match-string 1)))
5076 (setq value (replace-regexp-in-string
5077 "[\n\r]" " " (match-string 4)))
5078 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5079 (setq props (org-update-property-plist (match-string 1 value)
5080 (match-string 2 value)
5081 props)))))))
5082 (org-set-local 'org-use-sub-superscripts scripts)
5083 (when cat
5084 (org-set-local 'org-category (intern cat))
5085 (push (cons "CATEGORY" cat) props))
5086 (when prio
5087 (if (< (length prio) 3) (setq prio '("A" "C" "B")))
5088 (setq prio (mapcar 'string-to-char prio))
5089 (org-set-local 'org-highest-priority (nth 0 prio))
5090 (org-set-local 'org-lowest-priority (nth 1 prio))
5091 (org-set-local 'org-default-priority (nth 2 prio)))
5092 (and props (org-set-local 'org-file-properties (nreverse props)))
5093 (and arch (org-set-local 'org-archive-location arch))
5094 (and links (setq org-link-abbrev-alist-local (nreverse links)))
5095 ;; Process the TODO keywords
5096 (unless kwds
5097 ;; Use the global values as if they had been given locally.
5098 (setq kwds (default-value 'org-todo-keywords))
5099 (if (stringp (car kwds))
5100 (setq kwds (list (cons org-todo-interpretation
5101 (default-value 'org-todo-keywords)))))
5102 (setq kwds (reverse kwds)))
5103 (setq kwds (nreverse kwds))
5104 (let (inter kws kw)
5105 (while (setq kws (pop kwds))
5106 (let ((kws (or
5107 (run-hook-with-args-until-success
5108 'org-todo-setup-filter-hook kws)
5109 kws)))
5110 (setq inter (pop kws) sep (member "|" kws)
5111 kws0 (delete "|" (copy-sequence kws))
5112 kwsa nil
5113 kws1 (mapcar
5114 (lambda (x)
5115 ;; 1 2
5116 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
5117 (progn
5118 (setq kw (match-string 1 x)
5119 key (and (match-end 2) (match-string 2 x))
5120 log (org-extract-log-state-settings x))
5121 (push (cons kw (and key (string-to-char key))) kwsa)
5122 (and log (push log org-todo-log-states))
5124 (error "Invalid TODO keyword %s" x)))
5125 kws0)
5126 kwsa (if kwsa (append '((:startgroup))
5127 (nreverse kwsa)
5128 '((:endgroup))))
5129 hw (car kws1)
5130 dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
5131 tail (list inter hw (car dws) (org-last dws))))
5132 (add-to-list 'org-todo-heads hw 'append)
5133 (push kws1 org-todo-sets)
5134 (setq org-done-keywords (append org-done-keywords dws nil))
5135 (setq org-todo-key-alist (append org-todo-key-alist kwsa))
5136 (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
5137 (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
5138 (setq org-todo-sets (nreverse org-todo-sets)
5139 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5140 org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
5141 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
5142 ;; Compute the regular expressions and other local variables.
5143 ;; Using `org-outline-regexp-bol' would complicate them much,
5144 ;; because of the fixed white space at the end of that string.
5145 (if (not org-done-keywords)
5146 (setq org-done-keywords (and org-todo-keywords-1
5147 (list (org-last org-todo-keywords-1)))))
5148 (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
5149 (length org-scheduled-string)
5150 (length org-clock-string)
5151 (length org-closed-string)))
5152 org-not-done-keywords
5153 (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
5154 org-todo-regexp
5155 (concat "\\("
5156 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
5157 "\\)")
5158 org-not-done-regexp
5159 (concat "\\("
5160 (mapconcat 'regexp-quote org-not-done-keywords "\\|")
5161 "\\)")
5162 org-not-done-heading-regexp
5163 (format org-heading-keyword-regexp-format org-not-done-regexp)
5164 org-todo-line-regexp
5165 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5166 org-complex-heading-regexp
5167 (concat "^\\(\\*+\\)"
5168 "\\(?: +" org-todo-regexp "\\)?"
5169 "\\(?: +\\(\\[#.\\]\\)\\)?"
5170 "\\(?: +\\(.*?\\)\\)??"
5171 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5172 "[ \t]*$")
5173 org-complex-heading-regexp-format
5174 (concat "^\\(\\*+\\)"
5175 "\\(?: +" org-todo-regexp "\\)?"
5176 "\\(?: +\\(\\[#.\\]\\)\\)?"
5177 "\\(?: +"
5178 ;; Stats cookies can be stuck to body.
5179 "\\(?:\\[[0-9%%/]+\\] *\\)?"
5180 "\\(%s\\)"
5181 "\\(?: *\\[[0-9%%/]+\\]\\)?"
5182 "\\)"
5183 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5184 "[ \t]*$")
5185 org-todo-line-tags-regexp
5186 (concat "^\\(\\*+\\)"
5187 "\\(?: +" org-todo-regexp "\\)?"
5188 "\\(?: +\\(.*?\\)\\)??"
5189 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5190 "[ \t]*$")
5191 org-deadline-regexp (concat "\\<" org-deadline-string)
5192 org-deadline-time-regexp
5193 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
5194 org-deadline-time-hour-regexp
5195 (concat "\\<" org-deadline-string
5196 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5197 org-deadline-line-regexp
5198 (concat "\\<\\(" org-deadline-string "\\).*")
5199 org-scheduled-regexp
5200 (concat "\\<" org-scheduled-string)
5201 org-scheduled-time-regexp
5202 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
5203 org-scheduled-time-hour-regexp
5204 (concat "\\<" org-scheduled-string
5205 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5206 org-closed-time-regexp
5207 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
5208 org-keyword-time-regexp
5209 (concat "\\<\\(" org-scheduled-string
5210 "\\|" org-deadline-string
5211 "\\|" org-closed-string
5212 "\\|" org-clock-string "\\)"
5213 " *[[<]\\([^]>]+\\)[]>]")
5214 org-keyword-time-not-clock-regexp
5215 (concat "\\<\\(" org-scheduled-string
5216 "\\|" org-deadline-string
5217 "\\|" org-closed-string
5218 "\\)"
5219 " *[[<]\\([^]>]+\\)[]>]")
5220 org-maybe-keyword-time-regexp
5221 (concat "\\(\\<\\(" org-scheduled-string
5222 "\\|" org-deadline-string
5223 "\\|" org-closed-string
5224 "\\|" org-clock-string "\\)\\)?"
5225 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5226 org-all-time-keywords
5227 (mapcar (lambda (w) (substring w 0 -1))
5228 (list org-scheduled-string org-deadline-string
5229 org-clock-string org-closed-string)))
5230 (setq org-ota nil)
5231 (org-compute-latex-and-related-regexp))))
5233 (defun org-file-contents (file &optional noerror)
5234 "Return the contents of FILE, as a string."
5235 (if (or (not file)
5236 (not (file-readable-p file)))
5237 (if noerror
5238 (message "Cannot read file \"%s\"" file)
5239 (error "Cannot read file \"%s\"" file))
5240 (with-temp-buffer
5241 (insert-file-contents file)
5242 (buffer-string))))
5244 (defun org-extract-log-state-settings (x)
5245 "Extract the log state setting from a TODO keyword string.
5246 This will extract info from a string like \"WAIT(w@/!)\"."
5247 (let (kw key log1 log2)
5248 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5249 (setq kw (match-string 1 x)
5250 key (and (match-end 2) (match-string 2 x))
5251 log1 (and (match-end 3) (match-string 3 x))
5252 log2 (and (match-end 4) (match-string 4 x)))
5253 (and (or log1 log2)
5254 (list kw
5255 (and log1 (if (equal log1 "!") 'time 'note))
5256 (and log2 (if (equal log2 "!") 'time 'note)))))))
5258 (defun org-remove-keyword-keys (list)
5259 "Remove a pair of parenthesis at the end of each string in LIST."
5260 (mapcar (lambda (x)
5261 (if (string-match "(.*)$" x)
5262 (substring x 0 (match-beginning 0))
5264 list))
5266 (defun org-assign-fast-keys (alist)
5267 "Assign fast keys to a keyword-key alist.
5268 Respect keys that are already there."
5269 (let (new e (alt ?0))
5270 (while (setq e (pop alist))
5271 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5272 (cdr e)) ;; Key already assigned.
5273 (push e new)
5274 (let ((clist (string-to-list (downcase (car e))))
5275 (used (append new alist)))
5276 (when (= (car clist) ?@)
5277 (pop clist))
5278 (while (and clist (rassoc (car clist) used))
5279 (pop clist))
5280 (unless clist
5281 (while (rassoc alt used)
5282 (incf alt)))
5283 (push (cons (car e) (or (car clist) alt)) new))))
5284 (nreverse new)))
5286 ;;; Some variables used in various places
5288 (defvar org-window-configuration nil
5289 "Used in various places to store a window configuration.")
5290 (defvar org-selected-window nil
5291 "Used in various places to store a window configuration.")
5292 (defvar org-finish-function nil
5293 "Function to be called when `C-c C-c' is used.
5294 This is for getting out of special buffers like capture.")
5297 ;; FIXME: Occasionally check by commenting these, to make sure
5298 ;; no other functions uses these, forgetting to let-bind them.
5299 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5300 (defvar org-last-state)
5301 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5303 ;; Defined somewhere in this file, but used before definition.
5304 (defvar org-entities) ;; defined in org-entities.el
5305 (defvar org-struct-menu)
5306 (defvar org-org-menu)
5307 (defvar org-tbl-menu)
5309 ;;;; Define the Org-mode
5311 ;; We use a before-change function to check if a table might need
5312 ;; an update.
5313 (defvar org-table-may-need-update t
5314 "Indicates that a table might need an update.
5315 This variable is set by `org-before-change-function'.
5316 `org-table-align' sets it back to nil.")
5317 (defun org-before-change-function (beg end)
5318 "Every change indicates that a table might need an update."
5319 (setq org-table-may-need-update t))
5320 (defvar org-mode-map)
5321 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5322 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5323 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5324 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5325 (defvar org-table-buffer-is-an nil)
5327 (defvar bidi-paragraph-direction)
5328 (defvar buffer-face-mode-face)
5330 (require 'outline)
5331 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5332 (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"))
5333 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5335 ;; Other stuff we need.
5336 (require 'time-date)
5337 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5338 (require 'easymenu)
5339 (require 'overlay)
5341 ;; (require 'org-macs) moved higher up in the file before it is first used
5342 (require 'org-entities)
5343 ;; (require 'org-compat) moved higher up in the file before it is first used
5344 (require 'org-faces)
5345 (require 'org-list)
5346 (require 'org-pcomplete)
5347 (require 'org-src)
5348 (require 'org-footnote)
5349 (require 'org-macro)
5351 ;; babel
5352 (require 'ob)
5354 ;;;###autoload
5355 (define-derived-mode org-mode outline-mode "Org"
5356 "Outline-based notes management and organizer, alias
5357 \"Carsten's outline-mode for keeping track of everything.\"
5359 Org-mode develops organizational tasks around a NOTES file which
5360 contains information about projects as plain text. Org-mode is
5361 implemented on top of outline-mode, which is ideal to keep the content
5362 of large files well structured. It supports ToDo items, deadlines and
5363 time stamps, which magically appear in the diary listing of the Emacs
5364 calendar. Tables are easily created with a built-in table editor.
5365 Plain text URL-like links connect to websites, emails (VM), Usenet
5366 messages (Gnus), BBDB entries, and any files related to the project.
5367 For printing and sharing of notes, an Org-mode file (or a part of it)
5368 can be exported as a structured ASCII or HTML file.
5370 The following commands are available:
5372 \\{org-mode-map}"
5374 ;; Get rid of Outline menus, they are not needed
5375 ;; Need to do this here because define-derived-mode sets up
5376 ;; the keymap so late. Still, it is a waste to call this each time
5377 ;; we switch another buffer into org-mode.
5378 (if (featurep 'xemacs)
5379 (when (boundp 'outline-mode-menu-heading)
5380 ;; Assume this is Greg's port, it uses easymenu
5381 (easy-menu-remove outline-mode-menu-heading)
5382 (easy-menu-remove outline-mode-menu-show)
5383 (easy-menu-remove outline-mode-menu-hide))
5384 (define-key org-mode-map [menu-bar headings] 'undefined)
5385 (define-key org-mode-map [menu-bar hide] 'undefined)
5386 (define-key org-mode-map [menu-bar show] 'undefined))
5388 (org-load-modules-maybe)
5389 (easy-menu-add org-org-menu)
5390 (easy-menu-add org-tbl-menu)
5391 (org-install-agenda-files-menu)
5392 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5393 (add-to-invisibility-spec '(org-cwidth))
5394 (add-to-invisibility-spec '(org-hide-block . t))
5395 (when (featurep 'xemacs)
5396 (org-set-local 'line-move-ignore-invisible t))
5397 (org-set-local 'outline-regexp org-outline-regexp)
5398 (org-set-local 'outline-level 'org-outline-level)
5399 (setq bidi-paragraph-direction 'left-to-right)
5400 (when (and org-ellipsis
5401 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5402 (fboundp 'make-glyph-code))
5403 (unless org-display-table
5404 (setq org-display-table (make-display-table)))
5405 (set-display-table-slot
5406 org-display-table 4
5407 (vconcat (mapcar
5408 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5409 org-ellipsis)))
5410 (if (stringp org-ellipsis) org-ellipsis "..."))))
5411 (setq buffer-display-table org-display-table))
5412 (org-set-regexps-and-options-for-tags)
5413 (org-set-regexps-and-options)
5414 (org-set-font-lock-defaults)
5415 (when (and org-tag-faces (not org-tags-special-faces-re))
5416 ;; tag faces set outside customize.... force initialization.
5417 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5418 ;; Calc embedded
5419 (org-set-local 'calc-embedded-open-mode "# ")
5420 ;; Modify a few syntax entries
5421 (modify-syntax-entry ?@ "w")
5422 (modify-syntax-entry ?\" "\"")
5423 (if org-startup-truncated (setq truncate-lines t))
5424 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5425 (org-set-local 'font-lock-unfontify-region-function
5426 'org-unfontify-region)
5427 ;; Activate before-change-function
5428 (org-set-local 'org-table-may-need-update t)
5429 (org-add-hook 'before-change-functions 'org-before-change-function nil
5430 'local)
5431 ;; Check for running clock before killing a buffer
5432 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5433 ;; Initialize macros templates.
5434 (org-macro-initialize-templates)
5435 ;; Initialize radio targets.
5436 (org-update-radio-target-regexp)
5437 ;; Indentation.
5438 (org-set-local 'indent-line-function 'org-indent-line)
5439 (org-set-local 'indent-region-function 'org-indent-region)
5440 ;; Filling and auto-filling.
5441 (org-setup-filling)
5442 ;; Comments.
5443 (org-setup-comments-handling)
5444 ;; Initialize cache.
5445 (org-element-cache-reset)
5446 ;; Beginning/end of defun
5447 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5448 (org-set-local 'end-of-defun-function 'org-forward-element)
5449 ;; Next error for sparse trees
5450 (org-set-local 'next-error-function 'org-occur-next-match)
5451 ;; Make sure dependence stuff works reliably, even for users who set it
5452 ;; too late :-(
5453 (if org-enforce-todo-dependencies
5454 (add-hook 'org-blocker-hook
5455 'org-block-todo-from-children-or-siblings-or-parent)
5456 (remove-hook 'org-blocker-hook
5457 'org-block-todo-from-children-or-siblings-or-parent))
5458 (if org-enforce-todo-checkbox-dependencies
5459 (add-hook 'org-blocker-hook
5460 'org-block-todo-from-checkboxes)
5461 (remove-hook 'org-blocker-hook
5462 'org-block-todo-from-checkboxes))
5464 ;; Align options lines
5465 (org-set-local
5466 'align-mode-rules-list
5467 '((org-in-buffer-settings
5468 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5469 (modes . '(org-mode)))))
5471 ;; Imenu
5472 (org-set-local 'imenu-create-index-function
5473 'org-imenu-get-tree)
5475 ;; Make isearch reveal context
5476 (if (or (featurep 'xemacs)
5477 (not (boundp 'outline-isearch-open-invisible-function)))
5478 ;; Emacs 21 and XEmacs make use of the hook
5479 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5480 ;; Emacs 22 deals with this through a special variable
5481 (org-set-local 'outline-isearch-open-invisible-function
5482 (lambda (&rest ignore) (org-show-context 'isearch)))
5483 (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
5485 ;; Setup the pcomplete hooks
5486 (set (make-local-variable 'pcomplete-command-completion-function)
5487 'org-pcomplete-initial)
5488 (set (make-local-variable 'pcomplete-command-name-function)
5489 'org-command-at-point)
5490 (set (make-local-variable 'pcomplete-default-completion-function)
5491 'ignore)
5492 (set (make-local-variable 'pcomplete-parse-arguments-function)
5493 'org-parse-arguments)
5494 (set (make-local-variable 'pcomplete-termination-string) "")
5495 (when (>= emacs-major-version 23)
5496 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5498 ;; If empty file that did not turn on org-mode automatically, make it to.
5499 (if (and org-insert-mode-line-in-empty-file
5500 (org-called-interactively-p 'any)
5501 (= (point-min) (point-max)))
5502 (insert "# -*- mode: org -*-\n\n"))
5503 (unless org-inhibit-startup
5504 (org-unmodified
5505 (and org-startup-with-beamer-mode (org-beamer-mode))
5506 (when org-startup-align-all-tables
5507 (org-table-map-tables 'org-table-align 'quietly))
5508 (when org-startup-with-inline-images
5509 (org-display-inline-images))
5510 (when org-startup-with-latex-preview
5511 (org-preview-latex-fragment))
5512 (unless org-inhibit-startup-visibility-stuff
5513 (org-set-startup-visibility))))
5514 ;; Try to set org-hide correctly
5515 (set-face-foreground 'org-hide (org-find-invisible-foreground)))
5517 ;; Update `customize-package-emacs-version-alist'
5518 (add-to-list 'customize-package-emacs-version-alist
5519 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5520 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5521 ("8.2.6" . "24.4")))
5523 (defvar org-mode-transpose-word-syntax-table
5524 (let ((st (make-syntax-table)))
5525 (mapc (lambda(c) (modify-syntax-entry
5526 (string-to-char (car c)) "w p" st))
5527 org-emphasis-alist)
5528 st))
5530 (when (fboundp 'abbrev-table-put)
5531 (abbrev-table-put org-mode-abbrev-table
5532 :parents (list text-mode-abbrev-table)))
5534 (defsubst org-fix-ellipsis-at-bol ()
5535 (save-excursion (goto-char (window-start)) (recenter 0)))
5537 (defun org-find-invisible-foreground ()
5538 (let ((candidates (remove
5539 "unspecified-bg"
5540 (nconc
5541 (list (face-background 'default)
5542 (face-background 'org-default))
5543 (mapcar
5544 (lambda (alist)
5545 (when (boundp alist)
5546 (cdr (assoc 'background-color (symbol-value alist)))))
5547 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5548 (list (face-foreground 'org-hide))))))
5549 (car (remove nil candidates))))
5551 (defun org-current-time (&optional rounding-minutes past)
5552 "Current time, possibly rounded to ROUNDING-MINUTES.
5553 When ROUNDING-MINUTES is not an integer, fall back on the car of
5554 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5555 the rounding returns a past time."
5556 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5557 (car org-time-stamp-rounding-minutes)))
5558 (time (decode-time)) res)
5559 (if (< r 1)
5560 (current-time)
5561 (setq res
5562 (apply 'encode-time
5563 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5564 (nthcdr 2 time))))
5565 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5566 (seconds-to-time (- (org-float-time res) (* r 60)))
5567 res))))
5569 (defun org-today ()
5570 "Return today date, considering `org-extend-today-until'."
5571 (time-to-days
5572 (time-subtract (current-time)
5573 (list 0 (* 3600 org-extend-today-until) 0))))
5575 ;;;; Font-Lock stuff, including the activators
5577 (defvar org-mouse-map (make-sparse-keymap))
5578 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5579 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5580 (when org-mouse-1-follows-link
5581 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5582 (when org-tab-follows-link
5583 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5584 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5586 (require 'font-lock)
5588 (defconst org-non-link-chars "]\t\n\r<>")
5589 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5590 "shell" "elisp" "doi" "message"))
5591 (defvar org-link-types-re nil
5592 "Matches a link that has a url-like prefix like \"http:\"")
5593 (defvar org-link-re-with-space nil
5594 "Matches a link with spaces, optional angular brackets around it.")
5595 (defvar org-link-re-with-space2 nil
5596 "Matches a link with spaces, optional angular brackets around it.")
5597 (defvar org-link-re-with-space3 nil
5598 "Matches a link with spaces, only for internal part in bracket links.")
5599 (defvar org-angle-link-re nil
5600 "Matches link with angular brackets, spaces are allowed.")
5601 (defvar org-plain-link-re nil
5602 "Matches plain link, without spaces.")
5603 (defvar org-bracket-link-regexp nil
5604 "Matches a link in double brackets.")
5605 (defvar org-bracket-link-analytic-regexp nil
5606 "Regular expression used to analyze links.
5607 Here is what the match groups contain after a match:
5608 1: http:
5609 2: http
5610 3: path
5611 4: [desc]
5612 5: desc")
5613 (defvar org-bracket-link-analytic-regexp++ nil
5614 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5615 (defvar org-any-link-re nil
5616 "Regular expression matching any link.")
5618 (defconst org-match-sexp-depth 3
5619 "Number of stacked braces for sub/superscript matching.")
5621 (defun org-create-multibrace-regexp (left right n)
5622 "Create a regular expression which will match a balanced sexp.
5623 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5624 as single character strings.
5625 The regexp returned will match the entire expression including the
5626 delimiters. It will also define a single group which contains the
5627 match except for the outermost delimiters. The maximum depth of
5628 stacked delimiters is N. Escaping delimiters is not possible."
5629 (let* ((nothing (concat "[^" left right "]*?"))
5630 (or "\\|")
5631 (re nothing)
5632 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5633 (while (> n 1)
5634 (setq n (1- n)
5635 re (concat re or next)
5636 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5637 (concat left "\\(" re "\\)" right)))
5639 (defconst org-match-substring-regexp
5640 (concat
5641 "\\(\\S-\\)\\([_^]\\)\\("
5642 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5643 "\\|"
5644 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5645 "\\|"
5646 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5647 "The regular expression matching a sub- or superscript.")
5649 (defconst org-match-substring-with-braces-regexp
5650 (concat
5651 "\\(\\S-\\)\\([_^]\\)"
5652 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5653 "The regular expression matching a sub- or superscript, forcing braces.")
5655 (defun org-make-link-regexps ()
5656 "Update the link regular expressions.
5657 This should be called after the variable `org-link-types' has changed."
5658 (setq org-link-types-re
5659 (concat
5660 "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
5661 org-link-re-with-space
5662 (concat
5663 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5664 "\\([^" org-non-link-chars " ]"
5665 "[^" org-non-link-chars "]*"
5666 "[^" org-non-link-chars " ]\\)>?")
5667 org-link-re-with-space2
5668 (concat
5669 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5670 "\\([^" org-non-link-chars " ]"
5671 "[^\t\n\r]*"
5672 "[^" org-non-link-chars " ]\\)>?")
5673 org-link-re-with-space3
5674 (concat
5675 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5676 "\\([^" org-non-link-chars " ]"
5677 "[^\t\n\r]*\\)")
5678 org-angle-link-re
5679 (concat
5680 "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5681 "\\([^" org-non-link-chars " ]"
5682 "[^" org-non-link-chars "]*"
5683 "\\)>")
5684 org-plain-link-re
5685 (concat
5686 "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5687 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5688 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5689 org-bracket-link-regexp
5690 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5691 org-bracket-link-analytic-regexp
5692 (concat
5693 "\\[\\["
5694 "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
5695 "\\([^]]+\\)"
5696 "\\]"
5697 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5698 "\\]")
5699 org-bracket-link-analytic-regexp++
5700 (concat
5701 "\\[\\["
5702 "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
5703 "\\([^]]+\\)"
5704 "\\]"
5705 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5706 "\\]")
5707 org-any-link-re
5708 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5709 org-angle-link-re "\\)\\|\\("
5710 org-plain-link-re "\\)")))
5712 (org-make-link-regexps)
5714 (defvar org-emph-face nil)
5716 (defun org-do-emphasis-faces (limit)
5717 "Run through the buffer and add overlays to emphasized strings."
5718 (let (rtn a)
5719 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5720 (if (not (= (char-after (match-beginning 3))
5721 (char-after (match-beginning 4))))
5722 (progn
5723 (setq rtn t)
5724 (setq a (assoc (match-string 3) org-emphasis-alist))
5725 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5726 'face
5727 (nth 1 a))
5728 (and (nth 2 a)
5729 (org-remove-flyspell-overlays-in
5730 (match-beginning 0) (match-end 0)))
5731 (add-text-properties (match-beginning 2) (match-end 2)
5732 '(font-lock-multiline t org-emphasis t))
5733 (when org-hide-emphasis-markers
5734 (add-text-properties (match-end 4) (match-beginning 5)
5735 '(invisible org-link))
5736 (add-text-properties (match-beginning 3) (match-end 3)
5737 '(invisible org-link)))))
5738 (goto-char (1+ (match-beginning 0))))
5739 rtn))
5741 (defun org-emphasize (&optional char)
5742 "Insert or change an emphasis, i.e. a font like bold or italic.
5743 If there is an active region, change that region to a new emphasis.
5744 If there is no region, just insert the marker characters and position
5745 the cursor between them.
5746 CHAR should be the marker character. If it is a space, it means to
5747 remove the emphasis of the selected region.
5748 If CHAR is not given (for example in an interactive call) it will be
5749 prompted for."
5750 (interactive)
5751 (let ((erc org-emphasis-regexp-components)
5752 (prompt "")
5753 (string "") beg end move c s)
5754 (if (org-region-active-p)
5755 (setq beg (region-beginning) end (region-end)
5756 string (buffer-substring beg end))
5757 (setq move t))
5759 (unless char
5760 (message "Emphasis marker or tag: [%s]"
5761 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5762 (setq char (read-char-exclusive)))
5763 (if (equal char ?\ )
5764 (setq s "" move nil)
5765 (unless (assoc (char-to-string char) org-emphasis-alist)
5766 (user-error "No such emphasis marker: \"%c\"" char))
5767 (setq s (char-to-string char)))
5768 (while (and (> (length string) 1)
5769 (equal (substring string 0 1) (substring string -1))
5770 (assoc (substring string 0 1) org-emphasis-alist))
5771 (setq string (substring string 1 -1)))
5772 (setq string (concat s string s))
5773 (if beg (delete-region beg end))
5774 (unless (or (bolp)
5775 (string-match (concat "[" (nth 0 erc) "\n]")
5776 (char-to-string (char-before (point)))))
5777 (insert " "))
5778 (unless (or (eobp)
5779 (string-match (concat "[" (nth 1 erc) "\n]")
5780 (char-to-string (char-after (point)))))
5781 (insert " ") (backward-char 1))
5782 (insert string)
5783 (and move (backward-char 1))))
5785 (defconst org-nonsticky-props
5786 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5788 (defsubst org-rear-nonsticky-at (pos)
5789 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5791 (defun org-activate-plain-links (limit)
5792 "Run through the buffer and add overlays to links."
5793 (let (f hl)
5794 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5795 (not (org-in-src-block-p)))
5796 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5797 (setq f (get-text-property (match-beginning 0) 'face))
5798 (setq hl (org-match-string-no-properties 0))
5799 (if (or (eq f 'org-tag)
5800 (and (listp f) (memq 'org-tag f)))
5802 (add-text-properties (match-beginning 0) (match-end 0)
5803 (list 'mouse-face 'highlight
5804 'face 'org-link
5805 'htmlize-link `(:uri ,hl)
5806 'keymap org-mouse-map))
5807 (org-rear-nonsticky-at (match-end 0)))
5808 t)))
5810 (defun org-activate-code (limit)
5811 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5812 (progn
5813 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5814 (remove-text-properties (match-beginning 0) (match-end 0)
5815 '(display t invisible t intangible t))
5816 t)))
5818 (defcustom org-src-fontify-natively t
5819 "When non-nil, fontify code in code blocks."
5820 :type 'boolean
5821 :version "24.4"
5822 :package-version '(Org . "8.3")
5823 :group 'org-appearance
5824 :group 'org-babel)
5826 (defcustom org-allow-promoting-top-level-subtree nil
5827 "When non-nil, allow promoting a top level subtree.
5828 The leading star of the top level headline will be replaced
5829 by a #."
5830 :type 'boolean
5831 :version "24.1"
5832 :group 'org-appearance)
5834 (defun org-fontify-meta-lines-and-blocks (limit)
5835 (condition-case nil
5836 (org-fontify-meta-lines-and-blocks-1 limit)
5837 (error (message "org-mode fontification error"))))
5839 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5840 "Fontify #+ lines and blocks."
5841 (let ((case-fold-search t))
5842 (if (re-search-forward
5843 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5844 limit t)
5845 (let ((beg (match-beginning 0))
5846 (block-start (match-end 0))
5847 (block-end nil)
5848 (lang (match-string 7))
5849 (beg1 (line-beginning-position 2))
5850 (dc1 (downcase (match-string 2)))
5851 (dc3 (downcase (match-string 3)))
5852 end end1 quoting block-type ovl)
5853 (cond
5854 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5855 ;; a single line of backend-specific content
5856 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5857 (remove-text-properties (match-beginning 0) (match-end 0)
5858 '(display t invisible t intangible t))
5859 (add-text-properties (match-beginning 1) (match-end 3)
5860 '(font-lock-fontified t face org-meta-line))
5861 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5862 '(font-lock-fontified t face org-block))
5863 ; for backend-specific code
5865 ((and (match-end 4) (equal dc3 "+begin"))
5866 ;; Truly a block
5867 (setq block-type (downcase (match-string 5))
5868 quoting (member block-type org-protecting-blocks))
5869 (when (re-search-forward
5870 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5871 nil t) ;; on purpose, we look further than LIMIT
5872 (setq end (min (point-max) (match-end 0))
5873 end1 (min (point-max) (1- (match-beginning 0))))
5874 (setq block-end (match-beginning 0))
5875 (when quoting
5876 (org-remove-flyspell-overlays-in beg1 end1)
5877 (remove-text-properties beg end
5878 '(display t invisible t intangible t)))
5879 (add-text-properties
5880 beg end '(font-lock-fontified t font-lock-multiline t))
5881 (add-text-properties beg beg1 '(face org-meta-line))
5882 (org-remove-flyspell-overlays-in beg beg1)
5883 (add-text-properties ; For end_src
5884 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5885 (org-remove-flyspell-overlays-in end1 end)
5886 (cond
5887 ((and lang (not (string= lang "")) org-src-fontify-natively)
5888 (org-src-font-lock-fontify-block lang block-start block-end)
5889 ;; remove old background overlays
5890 (mapc (lambda (ov)
5891 (if (eq (overlay-get ov 'face) 'org-block-background)
5892 (delete-overlay ov)))
5893 (overlays-at (/ (+ beg1 block-end) 2)))
5894 ;; add a background overlay
5895 (setq ovl (make-overlay beg1 block-end))
5896 (overlay-put ovl 'face 'org-block-background)
5897 (overlay-put ovl 'evaporate t)) ; make it go away when empty
5898 (quoting
5899 (add-text-properties beg1 (min (point-max) (1+ end1))
5900 '(face org-block))) ; end of source block
5901 ((not org-fontify-quote-and-verse-blocks))
5902 ((string= block-type "quote")
5903 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5904 ((string= block-type "verse")
5905 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5906 (add-text-properties beg beg1 '(face org-block-begin-line))
5907 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5908 '(face org-block-end-line))
5910 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5911 (org-remove-flyspell-overlays-in
5912 (match-beginning 0)
5913 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5914 (add-text-properties
5915 beg (match-end 3)
5916 (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
5917 '(font-lock-fontified t invisible t)
5918 '(font-lock-fontified t face org-document-info-keyword)))
5919 (add-text-properties
5920 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5921 (if (string-equal dc1 "+title:")
5922 '(font-lock-fontified t face org-document-title)
5923 '(font-lock-fontified t face org-document-info))))
5924 ((or (equal dc1 "+results")
5925 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5926 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5927 "+call:" "+header:" "+headers:" "+name:"))
5928 (and (match-end 4) (equal dc3 "+attr")))
5929 (org-remove-flyspell-overlays-in
5930 (match-beginning 0)
5931 (if (equal "+caption:" dc1) (match-end 2) (match-end 0)))
5932 (add-text-properties
5933 beg (match-end 0)
5934 '(font-lock-fontified t face org-meta-line))
5936 ((member dc3 '(" " ""))
5937 (org-remove-flyspell-overlays-in beg (match-end 0))
5938 (add-text-properties
5939 beg (match-end 0)
5940 '(font-lock-fontified t face font-lock-comment-face)))
5941 ((not (member (char-after beg) '(?\ ?\t)))
5942 ;; just any other in-buffer setting, but not indented
5943 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5944 (add-text-properties
5945 beg (match-end 0)
5946 '(font-lock-fontified t face org-meta-line))
5948 (t nil))))))
5950 (defun org-fontify-drawers (limit)
5951 "Fontify drawers."
5952 (when (re-search-forward org-drawer-regexp limit t)
5953 (add-text-properties
5954 (match-beginning 0) (match-end 0)
5955 '(font-lock-fontified t face org-special-keyword))
5956 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5959 (defun org-activate-angle-links (limit)
5960 "Run through the buffer and add overlays to links."
5961 (if (and (re-search-forward org-angle-link-re limit t)
5962 (not (org-in-src-block-p)))
5963 (progn
5964 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5965 (add-text-properties (match-beginning 0) (match-end 0)
5966 (list 'mouse-face 'highlight
5967 'keymap org-mouse-map))
5968 (org-rear-nonsticky-at (match-end 0))
5969 t)))
5971 (defun org-activate-footnote-links (limit)
5972 "Run through the buffer and add overlays to footnotes."
5973 (let ((fn (org-footnote-next-reference-or-definition limit)))
5974 (when fn
5975 (let* ((beg (nth 1 fn))
5976 (end (nth 2 fn))
5977 (label (car fn))
5978 (referencep (/= (line-beginning-position) beg)))
5979 (when (and referencep (nth 3 fn))
5980 (save-excursion
5981 (goto-char beg)
5982 (search-forward (or label "fn:"))
5983 (org-remove-flyspell-overlays-in beg (match-end 0))))
5984 (add-text-properties beg end
5985 (list 'mouse-face 'highlight
5986 'keymap org-mouse-map
5987 'help-echo
5988 (if referencep "Footnote reference"
5989 "Footnote definition")
5990 'font-lock-fontified t
5991 'font-lock-multiline t
5992 'face 'org-footnote))))))
5994 (defun org-activate-bracket-links (limit)
5995 "Run through the buffer and add overlays to bracketed links."
5996 (if (and (re-search-forward org-bracket-link-regexp limit t)
5997 (not (org-in-src-block-p)))
5998 (let* ((hl (org-match-string-no-properties 1))
5999 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6000 (ip (org-maybe-intangible
6001 (list 'invisible 'org-link
6002 'keymap org-mouse-map 'mouse-face 'highlight
6003 'font-lock-multiline t 'help-echo help
6004 'htmlize-link `(:uri ,hl))))
6005 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6006 'font-lock-multiline t 'help-echo help
6007 'htmlize-link `(:uri ,hl))))
6008 ;; We need to remove the invisible property here. Table narrowing
6009 ;; may have made some of this invisible.
6010 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6011 (remove-text-properties (match-beginning 0) (match-end 0)
6012 '(invisible nil))
6013 (if (match-end 3)
6014 (progn
6015 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6016 (org-rear-nonsticky-at (match-beginning 3))
6017 (add-text-properties (match-beginning 3) (match-end 3) vp)
6018 (org-rear-nonsticky-at (match-end 3))
6019 (add-text-properties (match-end 3) (match-end 0) ip)
6020 (org-rear-nonsticky-at (match-end 0)))
6021 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6022 (org-rear-nonsticky-at (match-beginning 1))
6023 (add-text-properties (match-beginning 1) (match-end 1) vp)
6024 (org-rear-nonsticky-at (match-end 1))
6025 (add-text-properties (match-end 1) (match-end 0) ip)
6026 (org-rear-nonsticky-at (match-end 0)))
6027 t)))
6029 (defun org-activate-dates (limit)
6030 "Run through the buffer and add overlays to dates."
6031 (if (and (re-search-forward org-tsr-regexp-both limit t)
6032 (not (equal (char-before (match-beginning 0)) 91)))
6033 (progn
6034 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6035 (add-text-properties (match-beginning 0) (match-end 0)
6036 (list 'mouse-face 'highlight
6037 'keymap org-mouse-map))
6038 (org-rear-nonsticky-at (match-end 0))
6039 (when org-display-custom-times
6040 (if (match-end 3)
6041 (org-display-custom-time (match-beginning 3) (match-end 3)))
6042 (org-display-custom-time (match-beginning 1) (match-end 1)))
6043 t)))
6045 (defvar org-target-link-regexp nil
6046 "Regular expression matching radio targets in plain text.")
6047 (make-variable-buffer-local 'org-target-link-regexp)
6048 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
6049 "Regular expression matching a link target.")
6050 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
6051 "Regular expression matching a radio target.")
6052 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
6053 "Regular expression matching any target.")
6055 (defun org-activate-target-links (limit)
6056 "Run through the buffer and add overlays to target matches."
6057 (when org-target-link-regexp
6058 (let ((case-fold-search t))
6059 (if (re-search-forward org-target-link-regexp limit t)
6060 (progn
6061 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6062 (add-text-properties (match-beginning 0) (match-end 0)
6063 (list 'mouse-face 'highlight
6064 'keymap org-mouse-map
6065 'help-echo "Radio target link"
6066 'org-linked-text t))
6067 (org-rear-nonsticky-at (match-end 0))
6068 t)))))
6070 (defun org-update-radio-target-regexp ()
6071 "Find all radio targets in this file and update the regular expression."
6072 (interactive)
6073 (when (memq 'radio org-activate-links)
6074 (setq org-target-link-regexp
6075 (org-make-target-link-regexp (org-all-targets 'radio)))
6076 (org-restart-font-lock)))
6078 (defun org-hide-wide-columns (limit)
6079 (let (s e)
6080 (setq s (text-property-any (point) (or limit (point-max))
6081 'org-cwidth t))
6082 (when s
6083 (setq e (next-single-property-change s 'org-cwidth))
6084 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6085 (goto-char e)
6086 t)))
6088 (defvar org-latex-and-related-regexp nil
6089 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6091 (defun org-compute-latex-and-related-regexp ()
6092 "Compute regular expression for LaTeX, entities and sub/superscript.
6093 Result depends on variable `org-highlight-latex-and-related'."
6094 (org-set-local
6095 'org-latex-and-related-regexp
6096 (let* ((re-sub
6097 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6098 ((eq org-use-sub-superscripts '{})
6099 (list org-match-substring-with-braces-regexp))
6100 (org-use-sub-superscripts (list org-match-substring-regexp))))
6101 (re-latex
6102 (when (memq 'latex org-highlight-latex-and-related)
6103 (let ((matchers (plist-get org-format-latex-options :matchers)))
6104 (delq nil
6105 (mapcar (lambda (x)
6106 (and (member (car x) matchers) (nth 1 x)))
6107 org-latex-regexps)))))
6108 (re-entities
6109 (when (memq 'entities org-highlight-latex-and-related)
6110 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6111 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6113 (defun org-do-latex-and-related (limit)
6114 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6115 LIMIT bounds the search for syntax to highlight. Stop at first
6116 highlighted object, if any. Return t if some highlighting was
6117 done, nil otherwise."
6118 (when (org-string-nw-p org-latex-and-related-regexp)
6119 (catch 'found
6120 (while (re-search-forward org-latex-and-related-regexp limit t)
6121 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6122 'face))
6123 '(org-code org-verbatim underline))
6124 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6125 '(?_ ?^))
6127 0)))
6128 (font-lock-prepend-text-property
6129 (+ offset (match-beginning 0)) (match-end 0)
6130 'face 'org-latex-and-related)
6131 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6132 '(font-lock-multiline t)))
6133 (throw 'found t)))
6134 nil)))
6136 (defun org-restart-font-lock ()
6137 "Restart `font-lock-mode', to force refontification."
6138 (when (and (boundp 'font-lock-mode) font-lock-mode)
6139 (font-lock-mode -1)
6140 (font-lock-mode 1)))
6142 (defun org-all-targets (&optional radio)
6143 "Return a list of all targets in this file.
6144 When optional argument RADIO is non-nil, only find radio
6145 targets."
6146 (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
6147 (save-excursion
6148 (goto-char (point-min))
6149 (while (re-search-forward re nil t)
6150 ;; Make sure point is really within the object.
6151 (backward-char)
6152 (let ((obj (org-element-context)))
6153 (when (memq (org-element-type obj) '(radio-target target))
6154 (add-to-list 'rtn (downcase (org-element-property :value obj))))))
6155 rtn)))
6157 (defun org-make-target-link-regexp (targets)
6158 "Make regular expression matching all strings in TARGETS.
6159 The regular expression finds the targets also if there is a line break
6160 between words."
6161 (and targets
6162 (concat
6163 "\\<\\("
6164 (mapconcat
6165 (lambda (x)
6166 (setq x (regexp-quote x))
6167 (while (string-match " +" x)
6168 (setq x (replace-match "\\s-+" t t x)))
6170 targets
6171 "\\|")
6172 "\\)\\>")))
6174 (defun org-activate-tags (limit)
6175 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6176 (progn
6177 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6178 (add-text-properties (match-beginning 1) (match-end 1)
6179 (list 'mouse-face 'highlight
6180 'keymap org-mouse-map))
6181 (org-rear-nonsticky-at (match-end 1))
6182 t)))
6184 (defun org-outline-level ()
6185 "Compute the outline level of the heading at point.
6186 If this is called at a normal headline, the level is the number of stars.
6187 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6188 (save-excursion
6189 (if (not (condition-case nil
6190 (org-back-to-heading t)
6191 (error nil)))
6193 (looking-at org-outline-regexp)
6194 (1- (- (match-end 0) (match-beginning 0))))))
6196 (defvar org-font-lock-keywords nil)
6198 (defsubst org-re-property (property &optional literal)
6199 "Return a regexp matching a PROPERTY line.
6200 Match group 3 will be set to the value if it exists."
6201 (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
6202 (if literal property (regexp-quote property))
6203 "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
6205 (defconst org-property-re
6206 (org-re-property ".*?" 'literal)
6207 "Regular expression matching a property line.
6208 There are four matching groups:
6209 1: :PROPKEY: including the leading and trailing colon,
6210 2: PROPKEY without the leading and trailing colon,
6211 3: PROPVAL without leading or trailing spaces,
6212 4: the indentation of the current line,
6213 5: trailing whitespace.")
6215 (defvar org-font-lock-hook nil
6216 "Functions to be called for special font lock stuff.")
6218 (defvar org-font-lock-set-keywords-hook nil
6219 "Functions that can manipulate `org-font-lock-extra-keywords'.
6220 This is called after `org-font-lock-extra-keywords' is defined, but before
6221 it is installed to be used by font lock. This can be useful if something
6222 needs to be inserted at a specific position in the font-lock sequence.")
6224 (defun org-font-lock-hook (limit)
6225 "Run `org-font-lock-hook' within LIMIT."
6226 (run-hook-with-args 'org-font-lock-hook limit))
6228 (defun org-set-font-lock-defaults ()
6229 "Set font lock defaults for the current buffer."
6230 (let* ((em org-fontify-emphasized-text)
6231 (lk org-activate-links)
6232 (org-font-lock-extra-keywords
6233 (list
6234 ;; Call the hook
6235 '(org-font-lock-hook)
6236 ;; Headlines
6237 `(,(if org-fontify-whole-heading-line
6238 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6239 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6240 (1 (org-get-level-face 1))
6241 (2 (org-get-level-face 2))
6242 (3 (org-get-level-face 3)))
6243 ;; Table lines
6244 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6245 (1 'org-table t))
6246 ;; Table internals
6247 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6248 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6249 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6250 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6251 ;; Drawers
6252 '(org-fontify-drawers)
6253 ;; Properties
6254 (list org-property-re
6255 '(1 'org-special-keyword t)
6256 '(3 'org-property-value t))
6257 ;; Links
6258 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6259 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6260 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6261 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6262 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6263 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6264 (if (memq 'footnote lk) '(org-activate-footnote-links))
6265 ;; Targets.
6266 (list org-any-target-regexp '(0 'org-target t))
6267 ;; Diary sexps.
6268 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6269 ;; Macro
6270 '("{{{.+?}}}" (0 'org-macro t))
6271 '(org-hide-wide-columns (0 nil append))
6272 ;; TODO keyword
6273 (list (format org-heading-keyword-regexp-format
6274 org-todo-regexp)
6275 '(2 (org-get-todo-face 2) t))
6276 ;; DONE
6277 (if org-fontify-done-headline
6278 (list (format org-heading-keyword-regexp-format
6279 (concat
6280 "\\(?:"
6281 (mapconcat 'regexp-quote org-done-keywords "\\|")
6282 "\\)"))
6283 '(2 'org-headline-done t))
6284 nil)
6285 ;; Priorities
6286 '(org-font-lock-add-priority-faces)
6287 ;; Tags
6288 '(org-font-lock-add-tag-faces)
6289 ;; Tags groups
6290 (if (and org-group-tags org-tag-groups-alist)
6291 (list (concat org-outline-regexp-bol ".+\\(:"
6292 (regexp-opt (mapcar 'car org-tag-groups-alist))
6293 ":\\).*$")
6294 '(1 'org-tag-group prepend)))
6295 ;; Special keywords
6296 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6297 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6298 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6299 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6300 ;; Emphasis
6301 (if em
6302 (if (featurep 'xemacs)
6303 '(org-do-emphasis-faces (0 nil append))
6304 '(org-do-emphasis-faces)))
6305 ;; Checkboxes
6306 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6307 1 'org-checkbox prepend)
6308 (if (cdr (assq 'checkbox org-list-automatic-rules))
6309 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6310 (0 (org-get-checkbox-statistics-face) t)))
6311 ;; Description list items
6312 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6313 1 'org-list-dt prepend)
6314 ;; ARCHIVEd headings
6315 (list (concat
6316 org-outline-regexp-bol
6317 "\\(.*:" org-archive-tag ":.*\\)")
6318 '(1 'org-archived prepend))
6319 ;; Specials
6320 '(org-do-latex-and-related)
6321 '(org-fontify-entities)
6322 '(org-raise-scripts)
6323 ;; Code
6324 '(org-activate-code (1 'org-code t))
6325 ;; COMMENT
6326 (list (format org-heading-keyword-regexp-format
6327 (concat "\\("
6328 org-comment-string "\\|" org-quote-string
6329 "\\)"))
6330 '(2 'org-special-keyword t))
6331 ;; Blocks and meta lines
6332 '(org-fontify-meta-lines-and-blocks))))
6333 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6334 (run-hooks 'org-font-lock-set-keywords-hook)
6335 ;; Now set the full font-lock-keywords
6336 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6337 (org-set-local 'font-lock-defaults
6338 '(org-font-lock-keywords t nil nil backward-paragraph))
6339 (kill-local-variable 'font-lock-keywords) nil))
6341 (defun org-toggle-pretty-entities ()
6342 "Toggle the composition display of entities as UTF8 characters."
6343 (interactive)
6344 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6345 (org-restart-font-lock)
6346 (if org-pretty-entities
6347 (message "Entities are now displayed as UTF8 characters")
6348 (save-restriction
6349 (widen)
6350 (org-decompose-region (point-min) (point-max))
6351 (message "Entities are now displayed as plain text"))))
6353 (defvar org-custom-properties-overlays nil
6354 "List of overlays used for custom properties.")
6355 (make-variable-buffer-local 'org-custom-properties-overlays)
6357 (defun org-toggle-custom-properties-visibility ()
6358 "Display or hide properties in `org-custom-properties'."
6359 (interactive)
6360 (if org-custom-properties-overlays
6361 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6362 (setq org-custom-properties-overlays nil))
6363 (unless (not org-custom-properties)
6364 (save-excursion
6365 (save-restriction
6366 (widen)
6367 (goto-char (point-min))
6368 (while (re-search-forward org-property-re nil t)
6369 (mapc (lambda(p)
6370 (when (equal p (substring (match-string 1) 1 -1))
6371 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6372 (overlay-put o 'invisible t)
6373 (overlay-put o 'org-custom-property t)
6374 (push o org-custom-properties-overlays))))
6375 org-custom-properties)))))))
6377 (defun org-fontify-entities (limit)
6378 "Find an entity to fontify."
6379 (let (ee)
6380 (when org-pretty-entities
6381 (catch 'match
6382 (while (re-search-forward
6383 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6384 limit t)
6385 (if (and (not (org-in-indented-comment-line))
6386 (setq ee (org-entity-get (match-string 1)))
6387 (= (length (nth 6 ee)) 1))
6388 (let*
6389 ((end (if (equal (match-string 2) "{}")
6390 (match-end 2)
6391 (match-end 1))))
6392 (add-text-properties
6393 (match-beginning 0) end
6394 (list 'font-lock-fontified t))
6395 (compose-region (match-beginning 0) end
6396 (nth 6 ee) nil)
6397 (backward-char 1)
6398 (throw 'match t))))
6399 nil))))
6401 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6402 "Fontify string S like in Org-mode."
6403 (with-temp-buffer
6404 (insert s)
6405 (let ((org-odd-levels-only odd-levels))
6406 (org-mode)
6407 (font-lock-fontify-buffer)
6408 (buffer-string))))
6410 (defvar org-m nil)
6411 (defvar org-l nil)
6412 (defvar org-f nil)
6413 (defun org-get-level-face (n)
6414 "Get the right face for match N in font-lock matching of headlines."
6415 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6416 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6417 (if org-cycle-level-faces
6418 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6419 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6420 (cond
6421 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6422 ((eq n 2) org-f)
6423 (t (if org-level-color-stars-only nil org-f))))
6426 (defun org-get-todo-face (kwd)
6427 "Get the right face for a TODO keyword KWD.
6428 If KWD is a number, get the corresponding match group."
6429 (if (numberp kwd) (setq kwd (match-string kwd)))
6430 (or (org-face-from-face-or-color
6431 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6432 (and (member kwd org-done-keywords) 'org-done)
6433 'org-todo))
6435 (defun org-face-from-face-or-color (context inherit face-or-color)
6436 "Create a face list that inherits INHERIT, but sets the foreground color.
6437 When FACE-OR-COLOR is not a string, just return it."
6438 (if (stringp face-or-color)
6439 (list :inherit inherit
6440 (cdr (assoc context org-faces-easy-properties))
6441 face-or-color)
6442 face-or-color))
6444 (defun org-font-lock-add-tag-faces (limit)
6445 "Add the special tag faces."
6446 (when (and org-tag-faces org-tags-special-faces-re)
6447 (while (re-search-forward org-tags-special-faces-re limit t)
6448 (add-text-properties (match-beginning 1) (match-end 1)
6449 (list 'face (org-get-tag-face 1)
6450 'font-lock-fontified t))
6451 (backward-char 1))))
6453 (defun org-font-lock-add-priority-faces (limit)
6454 "Add the special priority faces."
6455 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6456 (when (save-match-data (org-at-heading-p))
6457 (add-text-properties
6458 (match-beginning 0) (match-end 0)
6459 (list 'face (or (org-face-from-face-or-color
6460 'priority 'org-priority
6461 (cdr (assoc (char-after (match-beginning 1))
6462 org-priority-faces)))
6463 'org-priority)
6464 'font-lock-fontified t)))))
6466 (defun org-get-tag-face (kwd)
6467 "Get the right face for a TODO keyword KWD.
6468 If KWD is a number, get the corresponding match group."
6469 (if (numberp kwd) (setq kwd (match-string kwd)))
6470 (or (org-face-from-face-or-color
6471 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6472 'org-tag))
6474 (defun org-unfontify-region (beg end &optional maybe_loudly)
6475 "Remove fontification and activation overlays from links."
6476 (font-lock-default-unfontify-region beg end)
6477 (let* ((buffer-undo-list t)
6478 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6479 (inhibit-modification-hooks t)
6480 deactivate-mark buffer-file-name buffer-file-truename)
6481 (org-decompose-region beg end)
6482 (remove-text-properties beg end
6483 '(mouse-face t keymap t org-linked-text t
6484 invisible t intangible t
6485 org-emphasis t))
6486 (org-remove-font-lock-display-properties beg end)))
6488 (defconst org-script-display '(((raise -0.3) (height 0.7))
6489 ((raise 0.3) (height 0.7))
6490 ((raise -0.5))
6491 ((raise 0.5)))
6492 "Display properties for showing superscripts and subscripts.")
6494 (defun org-remove-font-lock-display-properties (beg end)
6495 "Remove specific display properties that have been added by font lock.
6496 The will remove the raise properties that are used to show superscripts
6497 and subscripts."
6498 (let (next prop)
6499 (while (< beg end)
6500 (setq next (next-single-property-change beg 'display nil end)
6501 prop (get-text-property beg 'display))
6502 (if (member prop org-script-display)
6503 (put-text-property beg next 'display nil))
6504 (setq beg next))))
6506 (defun org-raise-scripts (limit)
6507 "Add raise properties to sub/superscripts."
6508 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6509 (if (re-search-forward
6510 (if (eq org-use-sub-superscripts t)
6511 org-match-substring-regexp
6512 org-match-substring-with-braces-regexp)
6513 limit t)
6514 (let* ((pos (point)) table-p comment-p
6515 (mpos (match-beginning 3))
6516 (emph-p (get-text-property mpos 'org-emphasis))
6517 (link-p (get-text-property mpos 'mouse-face))
6518 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6519 (goto-char (point-at-bol))
6520 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6521 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6522 (goto-char pos)
6523 ;; Handle a_b^c
6524 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6525 (if (or comment-p emph-p link-p keyw-p)
6527 (put-text-property (match-beginning 3) (match-end 0)
6528 'display
6529 (if (equal (char-after (match-beginning 2)) ?^)
6530 (nth (if table-p 3 1) org-script-display)
6531 (nth (if table-p 2 0) org-script-display)))
6532 (add-text-properties (match-beginning 2) (match-end 2)
6533 (list 'invisible t
6534 'org-dwidth t 'org-dwidth-n 1))
6535 (if (and (eq (char-after (match-beginning 3)) ?{)
6536 (eq (char-before (match-end 3)) ?}))
6537 (progn
6538 (add-text-properties
6539 (match-beginning 3) (1+ (match-beginning 3))
6540 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6541 (add-text-properties
6542 (1- (match-end 3)) (match-end 3)
6543 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6544 t)))))
6546 ;;;; Visibility cycling, including org-goto and indirect buffer
6548 ;;; Cycling
6550 (defvar org-cycle-global-status nil)
6551 (make-variable-buffer-local 'org-cycle-global-status)
6552 (put 'org-cycle-global-status 'org-state t)
6553 (defvar org-cycle-subtree-status nil)
6554 (make-variable-buffer-local 'org-cycle-subtree-status)
6555 (put 'org-cycle-subtree-status 'org-state t)
6557 (defvar org-inlinetask-min-level)
6559 (defun org-unlogged-message (&rest args)
6560 "Display a message, but avoid logging it in the *Messages* buffer."
6561 (let ((message-log-max nil))
6562 (apply 'message args)))
6564 ;;;###autoload
6565 (defun org-cycle (&optional arg)
6566 "TAB-action and visibility cycling for Org-mode.
6568 This is the command invoked in Org-mode by the TAB key. Its main purpose
6569 is outline visibility cycling, but it also invokes other actions
6570 in special contexts.
6572 - When this function is called with a prefix argument, rotate the entire
6573 buffer through 3 states (global cycling)
6574 1. OVERVIEW: Show only top-level headlines.
6575 2. CONTENTS: Show all headlines of all levels, but no body text.
6576 3. SHOW ALL: Show everything.
6577 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6578 determined by the variable `org-startup-folded', and by any VISIBILITY
6579 properties in the buffer.
6580 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6581 including any drawers.
6583 - When inside a table, re-align the table and move to the next field.
6585 - When point is at the beginning of a headline, rotate the subtree started
6586 by this line through 3 different states (local cycling)
6587 1. FOLDED: Only the main headline is shown.
6588 2. CHILDREN: The main headline and the direct children are shown.
6589 From this state, you can move to one of the children
6590 and zoom in further.
6591 3. SUBTREE: Show the entire subtree, including body text.
6592 If there is no subtree, switch directly from CHILDREN to FOLDED.
6594 - When point is at the beginning of an empty headline and the variable
6595 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6596 of the headline by demoting and promoting it to likely levels. This
6597 speeds up creation document structure by pressing TAB once or several
6598 times right after creating a new headline.
6600 - When there is a numeric prefix, go up to a heading with level ARG, do
6601 a `show-subtree' and return to the previous cursor position. If ARG
6602 is negative, go up that many levels.
6604 - When point is not at the beginning of a headline, execute the global
6605 binding for TAB, which is re-indenting the line. See the option
6606 `org-cycle-emulate-tab' for details.
6608 - Special case: if point is at the beginning of the buffer and there is
6609 no headline in line 1, this function will act as if called with prefix arg
6610 (C-u TAB, same as S-TAB) also when called without prefix arg.
6611 But only if also the variable `org-cycle-global-at-bob' is t."
6612 (interactive "P")
6613 (org-load-modules-maybe)
6614 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6615 (and org-cycle-level-after-item/entry-creation
6616 (or (org-cycle-level)
6617 (org-cycle-item-indentation))))
6618 (let* ((limit-level
6619 (or org-cycle-max-level
6620 (and (boundp 'org-inlinetask-min-level)
6621 org-inlinetask-min-level
6622 (1- org-inlinetask-min-level))))
6623 (nstars (and limit-level
6624 (if org-odd-levels-only
6625 (and limit-level (1- (* limit-level 2)))
6626 limit-level)))
6627 (org-outline-regexp
6628 (if (not (derived-mode-p 'org-mode))
6629 outline-regexp
6630 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6631 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6632 (not (looking-at org-outline-regexp))))
6633 (org-cycle-hook
6634 (if bob-special
6635 (delq 'org-optimize-window-after-visibility-change
6636 (copy-sequence org-cycle-hook))
6637 org-cycle-hook))
6638 (pos (point)))
6640 (if (or bob-special (equal arg '(4)))
6641 ;; special case: use global cycling
6642 (setq arg t))
6644 (cond
6646 ((equal arg '(16))
6647 (setq last-command 'dummy)
6648 (org-set-startup-visibility)
6649 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6651 ((equal arg '(64))
6652 (show-all)
6653 (org-unlogged-message "Entire buffer visible, including drawers"))
6655 ;; Table: enter it or move to the next field.
6656 ((org-at-table-p 'any)
6657 (if (org-at-table.el-p)
6658 (message "Use C-c ' to edit table.el tables")
6659 (if arg (org-table-edit-field t)
6660 (org-table-justify-field-maybe)
6661 (call-interactively 'org-table-next-field))))
6663 ((run-hook-with-args-until-success
6664 'org-tab-after-check-for-table-hook))
6666 ;; Global cycling: delegate to `org-cycle-internal-global'.
6667 ((eq arg t) (org-cycle-internal-global))
6669 ;; Drawers: delegate to `org-flag-drawer'.
6670 ((save-excursion
6671 (beginning-of-line 1)
6672 (looking-at org-drawer-regexp))
6673 (org-flag-drawer ; toggle block visibility
6674 (not (get-char-property (match-end 0) 'invisible))))
6676 ;; Show-subtree, ARG levels up from here.
6677 ((integerp arg)
6678 (save-excursion
6679 (org-back-to-heading)
6680 (outline-up-heading (if (< arg 0) (- arg)
6681 (- (funcall outline-level) arg)))
6682 (org-show-subtree)))
6684 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6685 ((and (featurep 'org-inlinetask)
6686 (org-inlinetask-at-task-p)
6687 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6688 (org-inlinetask-toggle-visibility))
6690 ((org-try-cdlatex-tab))
6692 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6693 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6694 (save-excursion (beginning-of-line 1)
6695 (looking-at org-outline-regexp)))
6696 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6697 (org-cycle-internal-local))
6699 ;; From there: TAB emulation and template completion.
6700 (buffer-read-only (org-back-to-heading))
6702 ((run-hook-with-args-until-success
6703 'org-tab-after-check-for-cycling-hook))
6705 ((org-try-structure-completion))
6707 ((run-hook-with-args-until-success
6708 'org-tab-before-tab-emulation-hook))
6710 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6711 (or (not (bolp))
6712 (not (looking-at org-outline-regexp))))
6713 (call-interactively (global-key-binding "\t")))
6715 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6716 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6717 (or (and (eq org-cycle-emulate-tab 'white)
6718 (= (match-end 0) (point-at-eol)))
6719 (and (eq org-cycle-emulate-tab 'whitestart)
6720 (>= (match-end 0) pos))))
6722 (eq org-cycle-emulate-tab t))
6723 (call-interactively (global-key-binding "\t")))
6725 (t (save-excursion
6726 (org-back-to-heading)
6727 (org-cycle)))))))
6729 (defun org-cycle-internal-global ()
6730 "Do the global cycling action."
6731 ;; Hack to avoid display of messages for .org attachments in Gnus
6732 (let ((ga (string-match "\\*fontification" (buffer-name))))
6733 (cond
6734 ((and (eq last-command this-command)
6735 (eq org-cycle-global-status 'overview))
6736 ;; We just created the overview - now do table of contents
6737 ;; This can be slow in very large buffers, so indicate action
6738 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6739 (unless ga (org-unlogged-message "CONTENTS..."))
6740 (org-content)
6741 (unless ga (org-unlogged-message "CONTENTS...done"))
6742 (setq org-cycle-global-status 'contents)
6743 (run-hook-with-args 'org-cycle-hook 'contents))
6745 ((and (eq last-command this-command)
6746 (eq org-cycle-global-status 'contents))
6747 ;; We just showed the table of contents - now show everything
6748 (run-hook-with-args 'org-pre-cycle-hook 'all)
6749 (show-all)
6750 (unless ga (org-unlogged-message "SHOW ALL"))
6751 (setq org-cycle-global-status 'all)
6752 (run-hook-with-args 'org-cycle-hook 'all))
6755 ;; Default action: go to overview
6756 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6757 (org-overview)
6758 (unless ga (org-unlogged-message "OVERVIEW"))
6759 (setq org-cycle-global-status 'overview)
6760 (run-hook-with-args 'org-cycle-hook 'overview)))))
6762 (defvar org-called-with-limited-levels);Dyn-bound in ̀org-with-limited-levels'.
6764 (defun org-cycle-internal-local ()
6765 "Do the local cycling action."
6766 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6767 ;; First, determine end of headline (EOH), end of subtree or item
6768 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6769 (save-excursion
6770 (if (org-at-item-p)
6771 (progn
6772 (beginning-of-line)
6773 (setq struct (org-list-struct))
6774 (setq eoh (point-at-eol))
6775 (setq eos (org-list-get-item-end-before-blank (point) struct))
6776 (setq has-children (org-list-has-child-p (point) struct)))
6777 (org-back-to-heading)
6778 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6779 (setq eos (save-excursion (1- (org-end-of-subtree t t))))
6780 (setq has-children
6781 (or (save-excursion
6782 (let ((level (funcall outline-level)))
6783 (outline-next-heading)
6784 (and (org-at-heading-p t)
6785 (> (funcall outline-level) level))))
6786 (save-excursion
6787 (org-list-search-forward (org-item-beginning-re) eos t)))))
6788 ;; Determine end invisible part of buffer (EOL)
6789 (beginning-of-line 2)
6790 ;; XEmacs doesn't have `next-single-char-property-change'
6791 (if (featurep 'xemacs)
6792 (while (and (not (eobp)) ;; this is like `next-line'
6793 (get-char-property (1- (point)) 'invisible))
6794 (beginning-of-line 2))
6795 (while (and (not (eobp)) ;; this is like `next-line'
6796 (get-char-property (1- (point)) 'invisible))
6797 (goto-char (next-single-char-property-change (point) 'invisible))
6798 (and (eolp) (beginning-of-line 2))))
6799 (setq eol (point)))
6800 ;; Find out what to do next and set `this-command'
6801 (cond
6802 ((= eos eoh)
6803 ;; Nothing is hidden behind this heading
6804 (unless (org-before-first-heading-p)
6805 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6806 (org-unlogged-message "EMPTY ENTRY")
6807 (setq org-cycle-subtree-status nil)
6808 (save-excursion
6809 (goto-char eos)
6810 (outline-next-heading)
6811 (if (outline-invisible-p) (org-flag-heading nil))))
6812 ((and (or (>= eol eos)
6813 (not (string-match "\\S-" (buffer-substring eol eos))))
6814 (or has-children
6815 (not (setq children-skipped
6816 org-cycle-skip-children-state-if-no-children))))
6817 ;; Entire subtree is hidden in one line: children view
6818 (unless (org-before-first-heading-p)
6819 (run-hook-with-args 'org-pre-cycle-hook 'children))
6820 (if (org-at-item-p)
6821 (org-list-set-item-visibility (point-at-bol) struct 'children)
6822 (org-show-entry)
6823 (org-with-limited-levels (show-children))
6824 ;; FIXME: This slows down the func way too much.
6825 ;; How keep drawers hidden in subtree anyway?
6826 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6827 ;; (org-cycle-hide-drawers 'subtree))
6829 ;; Fold every list in subtree to top-level items.
6830 (when (eq org-cycle-include-plain-lists 'integrate)
6831 (save-excursion
6832 (org-back-to-heading)
6833 (while (org-list-search-forward (org-item-beginning-re) eos t)
6834 (beginning-of-line 1)
6835 (let* ((struct (org-list-struct))
6836 (prevs (org-list-prevs-alist struct))
6837 (end (org-list-get-bottom-point struct)))
6838 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6839 (org-list-get-all-items (point) struct prevs))
6840 (goto-char (if (< end eos) end eos)))))))
6841 (org-unlogged-message "CHILDREN")
6842 (save-excursion
6843 (goto-char eos)
6844 (outline-next-heading)
6845 (if (outline-invisible-p) (org-flag-heading nil)))
6846 (setq org-cycle-subtree-status 'children)
6847 (unless (org-before-first-heading-p)
6848 (run-hook-with-args 'org-cycle-hook 'children)))
6849 ((or children-skipped
6850 (and (eq last-command this-command)
6851 (eq org-cycle-subtree-status 'children)))
6852 ;; We just showed the children, or no children are there,
6853 ;; now show everything.
6854 (unless (org-before-first-heading-p)
6855 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6856 (outline-flag-region eoh eos nil)
6857 (org-unlogged-message
6858 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6859 (setq org-cycle-subtree-status 'subtree)
6860 (unless (org-before-first-heading-p)
6861 (run-hook-with-args 'org-cycle-hook 'subtree)))
6863 ;; Default action: hide the subtree.
6864 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6865 (outline-flag-region eoh eos t)
6866 (org-unlogged-message "FOLDED")
6867 (setq org-cycle-subtree-status 'folded)
6868 (unless (org-before-first-heading-p)
6869 (run-hook-with-args 'org-cycle-hook 'folded))))))
6871 ;;;###autoload
6872 (defun org-global-cycle (&optional arg)
6873 "Cycle the global visibility. For details see `org-cycle'.
6874 With \\[universal-argument] prefix arg, switch to startup visibility.
6875 With a numeric prefix, show all headlines up to that level."
6876 (interactive "P")
6877 (let ((org-cycle-include-plain-lists
6878 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6879 (cond
6880 ((integerp arg)
6881 (show-all)
6882 (hide-sublevels arg)
6883 (setq org-cycle-global-status 'contents))
6884 ((equal arg '(4))
6885 (org-set-startup-visibility)
6886 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6888 (org-cycle '(4))))))
6890 (defun org-set-startup-visibility ()
6891 "Set the visibility required by startup options and properties."
6892 (cond
6893 ((eq org-startup-folded t)
6894 (org-overview))
6895 ((eq org-startup-folded 'content)
6896 (org-content))
6897 ((or (eq org-startup-folded 'showeverything)
6898 (eq org-startup-folded nil))
6899 (show-all)))
6900 (unless (eq org-startup-folded 'showeverything)
6901 (if org-hide-block-startup (org-hide-block-all))
6902 (org-set-visibility-according-to-property 'no-cleanup)
6903 (org-cycle-hide-archived-subtrees 'all)
6904 (org-cycle-hide-drawers 'all)
6905 (org-cycle-show-empty-lines t)))
6907 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6908 "Switch subtree visibilities according to :VISIBILITY: property."
6909 (interactive)
6910 (let (org-show-entry-below state)
6911 (save-excursion
6912 (goto-char (point-min))
6913 (while (re-search-forward
6914 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6915 nil t)
6916 (setq state (match-string 1))
6917 (save-excursion
6918 (org-back-to-heading t)
6919 (hide-subtree)
6920 (org-reveal)
6921 (cond
6922 ((equal state '("fold" "folded"))
6923 (hide-subtree))
6924 ((equal state "children")
6925 (org-show-hidden-entry)
6926 (show-children))
6927 ((equal state "content")
6928 (save-excursion
6929 (save-restriction
6930 (org-narrow-to-subtree)
6931 (org-content))))
6932 ((member state '("all" "showall"))
6933 (show-subtree)))))
6934 (unless no-cleanup
6935 (org-cycle-hide-archived-subtrees 'all)
6936 (org-cycle-hide-drawers 'all)
6937 (org-cycle-show-empty-lines 'all)))))
6939 ;; This function uses outline-regexp instead of the more fundamental
6940 ;; org-outline-regexp so that org-cycle-global works outside of Org
6941 ;; buffers, where outline-regexp is needed.
6942 (defun org-overview ()
6943 "Switch to overview mode, showing only top-level headlines.
6944 Really, this shows all headlines with level equal or greater than the level
6945 of the first headline in the buffer. This is important, because if the
6946 first headline is not level one, then (hide-sublevels 1) gives confusing
6947 results."
6948 (interactive)
6949 (let ((pos (point))
6950 (level (save-excursion
6951 (goto-char (point-min))
6952 (if (re-search-forward (concat "^" outline-regexp) nil t)
6953 (progn
6954 (goto-char (match-beginning 0))
6955 (funcall outline-level))))))
6956 (and level (hide-sublevels level))
6957 (recenter '(4))
6958 (goto-char pos)))
6960 (defun org-content (&optional arg)
6961 "Show all headlines in the buffer, like a table of contents.
6962 With numerical argument N, show content up to level N."
6963 (interactive "P")
6964 (save-excursion
6965 ;; Visit all headings and show their offspring
6966 (and (integerp arg) (org-overview))
6967 (goto-char (point-max))
6968 (catch 'exit
6969 (while (and (progn (condition-case nil
6970 (outline-previous-visible-heading 1)
6971 (error (goto-char (point-min))))
6973 (looking-at org-outline-regexp))
6974 (if (integerp arg)
6975 (show-children (1- arg))
6976 (show-branches))
6977 (if (bobp) (throw 'exit nil))))))
6979 (defun org-optimize-window-after-visibility-change (state)
6980 "Adjust the window after a change in outline visibility.
6981 This function is the default value of the hook `org-cycle-hook'."
6982 (when (get-buffer-window (current-buffer))
6983 (cond
6984 ((eq state 'content) nil)
6985 ((eq state 'all) nil)
6986 ((eq state 'folded) nil)
6987 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
6988 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
6990 (defun org-remove-empty-overlays-at (pos)
6991 "Remove outline overlays that do not contain non-white stuff."
6992 (mapc
6993 (lambda (o)
6994 (and (eq 'outline (overlay-get o 'invisible))
6995 (not (string-match "\\S-" (buffer-substring (overlay-start o)
6996 (overlay-end o))))
6997 (delete-overlay o)))
6998 (overlays-at pos)))
7000 (defun org-clean-visibility-after-subtree-move ()
7001 "Fix visibility issues after moving a subtree."
7002 ;; First, find a reasonable region to look at:
7003 ;; Start two siblings above, end three below
7004 (let* ((beg (save-excursion
7005 (and (org-get-last-sibling)
7006 (org-get-last-sibling))
7007 (point)))
7008 (end (save-excursion
7009 (and (org-get-next-sibling)
7010 (org-get-next-sibling)
7011 (org-get-next-sibling))
7012 (if (org-at-heading-p)
7013 (point-at-eol)
7014 (point))))
7015 (level (looking-at "\\*+"))
7016 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7017 (save-excursion
7018 (save-restriction
7019 (narrow-to-region beg end)
7020 (when re
7021 ;; Properly fold already folded siblings
7022 (goto-char (point-min))
7023 (while (re-search-forward re nil t)
7024 (if (and (not (outline-invisible-p))
7025 (save-excursion
7026 (goto-char (point-at-eol)) (outline-invisible-p)))
7027 (hide-entry))))
7028 (org-cycle-show-empty-lines 'overview)
7029 (org-cycle-hide-drawers 'overview)))))
7031 (defun org-cycle-show-empty-lines (state)
7032 "Show empty lines above all visible headlines.
7033 The region to be covered depends on STATE when called through
7034 `org-cycle-hook'. Lisp program can use t for STATE to get the
7035 entire buffer covered. Note that an empty line is only shown if there
7036 are at least `org-cycle-separator-lines' empty lines before the headline."
7037 (when (not (= org-cycle-separator-lines 0))
7038 (save-excursion
7039 (let* ((n (abs org-cycle-separator-lines))
7040 (re (cond
7041 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7042 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7043 (t (let ((ns (number-to-string (- n 2))))
7044 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7045 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7046 beg end b e)
7047 (cond
7048 ((memq state '(overview contents t))
7049 (setq beg (point-min) end (point-max)))
7050 ((memq state '(children folded))
7051 (setq beg (point) end (progn (org-end-of-subtree t t)
7052 (beginning-of-line 2)
7053 (point)))))
7054 (when beg
7055 (goto-char beg)
7056 (while (re-search-forward re end t)
7057 (unless (get-char-property (match-end 1) 'invisible)
7058 (setq e (match-end 1))
7059 (if (< org-cycle-separator-lines 0)
7060 (setq b (save-excursion
7061 (goto-char (match-beginning 0))
7062 (org-back-over-empty-lines)
7063 (if (save-excursion
7064 (goto-char (max (point-min) (1- (point))))
7065 (org-at-heading-p))
7066 (1- (point))
7067 (point))))
7068 (setq b (match-beginning 1)))
7069 (outline-flag-region b e nil)))))))
7070 ;; Never hide empty lines at the end of the file.
7071 (save-excursion
7072 (goto-char (point-max))
7073 (outline-previous-heading)
7074 (outline-end-of-heading)
7075 (if (and (looking-at "[ \t\n]+")
7076 (= (match-end 0) (point-max)))
7077 (outline-flag-region (point) (match-end 0) nil))))
7079 (defun org-show-empty-lines-in-parent ()
7080 "Move to the parent and re-show empty lines before visible headlines."
7081 (save-excursion
7082 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7083 (org-cycle-show-empty-lines context))))
7085 (defun org-files-list ()
7086 "Return `org-agenda-files' list, plus all open org-mode files.
7087 This is useful for operations that need to scan all of a user's
7088 open and agenda-wise Org files."
7089 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7090 (dolist (buf (buffer-list))
7091 (with-current-buffer buf
7092 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7093 (let ((file (expand-file-name (buffer-file-name))))
7094 (unless (member file files)
7095 (push file files))))))
7096 files))
7098 (defsubst org-entry-beginning-position ()
7099 "Return the beginning position of the current entry."
7100 (save-excursion (outline-back-to-heading t) (point)))
7102 (defsubst org-entry-end-position ()
7103 "Return the end position of the current entry."
7104 (save-excursion (outline-next-heading) (point)))
7106 (defun org-cycle-hide-drawers (state &optional exceptions)
7107 "Re-hide all drawers after a visibility state change.
7108 When non-nil, optional argument EXCEPTIONS is a list of strings
7109 specifying which drawers should not be hidden."
7110 (when (and (derived-mode-p 'org-mode)
7111 (not (memq state '(overview folded contents))))
7112 (save-excursion
7113 (let* ((globalp (memq state '(contents all)))
7114 (beg (if globalp (point-min) (point)))
7115 (end (if globalp (point-max)
7116 (if (eq state 'children)
7117 (save-excursion (outline-next-heading) (point))
7118 (org-end-of-subtree t)))))
7119 (goto-char beg)
7120 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7121 (unless (member-ignore-case (match-string 1) exceptions)
7122 (let ((drawer (org-element-at-point)))
7123 (when (memq (org-element-type drawer) '(drawer property-drawer))
7124 (org-flag-drawer t drawer)
7125 ;; Make sure to skip drawer entirely or we might flag
7126 ;; it another time when matching its ending line with
7127 ;; `org-drawer-regexp'.
7128 (goto-char (org-element-property :end drawer))))))))))
7130 (defun org-cycle-hide-inline-tasks (state)
7131 "Re-hide inline tasks when switching to 'contents or 'children
7132 visibility state."
7133 (case state
7134 (contents
7135 (when (org-bound-and-true-p org-inlinetask-min-level)
7136 (hide-sublevels (1- org-inlinetask-min-level))))
7137 (children
7138 (when (featurep 'org-inlinetask)
7139 (save-excursion
7140 (while (and (outline-next-heading)
7141 (org-inlinetask-at-task-p))
7142 (org-inlinetask-toggle-visibility)
7143 (org-inlinetask-goto-end)))))))
7145 (defun org-flag-drawer (flag &optional element)
7146 "When FLAG is non-nil, hide the drawer we are at.
7147 Otherwise make it visible. When optional argument ELEMENT is
7148 a parsed drawer, as returned by `org-element-at-point', hide or
7149 show that drawer instead."
7150 (let ((drawer (or element (org-element-at-point))))
7151 (when (memq (org-element-type drawer) '(drawer property-drawer))
7152 (save-excursion
7153 (goto-char (org-element-property :post-affiliated drawer))
7154 (outline-flag-region
7155 (line-end-position)
7156 (progn (goto-char (org-element-property :end drawer))
7157 (skip-chars-backward " \r\t\n")
7158 (line-end-position))
7159 flag)))))
7161 (defun org-subtree-end-visible-p ()
7162 "Is the end of the current subtree visible?"
7163 (pos-visible-in-window-p
7164 (save-excursion (org-end-of-subtree t) (point))))
7166 (defun org-first-headline-recenter (&optional N)
7167 "Move cursor to the first headline and recenter the headline.
7168 Optional argument N means put the headline into the Nth line of the window."
7169 (goto-char (point-min))
7170 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7171 (beginning-of-line)
7172 (recenter (prefix-numeric-value N))))
7174 ;;; Saving and restoring visibility
7176 (defun org-outline-overlay-data (&optional use-markers)
7177 "Return a list of the locations of all outline overlays.
7178 These are overlays with the `invisible' property value `outline'.
7179 The return value is a list of cons cells, with start and stop
7180 positions for each overlay.
7181 If USE-MARKERS is set, return the positions as markers."
7182 (let (beg end)
7183 (save-excursion
7184 (save-restriction
7185 (widen)
7186 (delq nil
7187 (mapcar (lambda (o)
7188 (when (eq (overlay-get o 'invisible) 'outline)
7189 (setq beg (overlay-start o)
7190 end (overlay-end o))
7191 (and beg end (> end beg)
7192 (if use-markers
7193 (cons (copy-marker beg)
7194 (copy-marker end t))
7195 (cons beg end)))))
7196 (overlays-in (point-min) (point-max))))))))
7198 (defun org-set-outline-overlay-data (data)
7199 "Create visibility overlays for all positions in DATA.
7200 DATA should have been made by `org-outline-overlay-data'."
7201 (let (o)
7202 (save-excursion
7203 (save-restriction
7204 (widen)
7205 (show-all)
7206 (mapc (lambda (c)
7207 (outline-flag-region (car c) (cdr c) t))
7208 data)))))
7210 ;;; Folding of blocks
7212 (defvar org-hide-block-overlays nil
7213 "Overlays hiding blocks.")
7214 (make-variable-buffer-local 'org-hide-block-overlays)
7216 (defun org-block-map (function &optional start end)
7217 "Call FUNCTION at the head of all source blocks in the current buffer.
7218 Optional arguments START and END can be used to limit the range."
7219 (let ((start (or start (point-min)))
7220 (end (or end (point-max))))
7221 (save-excursion
7222 (goto-char start)
7223 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7224 (save-excursion
7225 (save-match-data
7226 (goto-char (match-beginning 0))
7227 (funcall function)))))))
7229 (defun org-hide-block-toggle-all ()
7230 "Toggle the visibility of all blocks in the current buffer."
7231 (org-block-map #'org-hide-block-toggle))
7233 (defun org-hide-block-all ()
7234 "Fold all blocks in the current buffer."
7235 (interactive)
7236 (org-show-block-all)
7237 (org-block-map #'org-hide-block-toggle-maybe))
7239 (defun org-show-block-all ()
7240 "Unfold all blocks in the current buffer."
7241 (interactive)
7242 (mapc 'delete-overlay org-hide-block-overlays)
7243 (setq org-hide-block-overlays nil))
7245 (defun org-hide-block-toggle-maybe ()
7246 "Toggle visibility of block at point."
7247 (interactive)
7248 (let ((case-fold-search t))
7249 (if (save-excursion
7250 (beginning-of-line 1)
7251 (looking-at org-block-regexp))
7252 (progn (org-hide-block-toggle)
7253 t) ;; to signal that we took action
7254 nil))) ;; to signal that we did not
7256 (defun org-hide-block-toggle (&optional force)
7257 "Toggle the visibility of the current block."
7258 (interactive)
7259 (save-excursion
7260 (beginning-of-line)
7261 (if (re-search-forward org-block-regexp nil t)
7262 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7263 (end (match-end 0)) ;; end of entire body
7265 (if (memq t (mapcar (lambda (overlay)
7266 (eq (overlay-get overlay 'invisible)
7267 'org-hide-block))
7268 (overlays-at start)))
7269 (if (or (not force) (eq force 'off))
7270 (mapc (lambda (ov)
7271 (when (member ov org-hide-block-overlays)
7272 (setq org-hide-block-overlays
7273 (delq ov org-hide-block-overlays)))
7274 (when (eq (overlay-get ov 'invisible)
7275 'org-hide-block)
7276 (delete-overlay ov)))
7277 (overlays-at start)))
7278 (setq ov (make-overlay start end))
7279 (overlay-put ov 'invisible 'org-hide-block)
7280 ;; make the block accessible to isearch
7281 (overlay-put
7282 ov 'isearch-open-invisible
7283 (lambda (ov)
7284 (when (member ov org-hide-block-overlays)
7285 (setq org-hide-block-overlays
7286 (delq ov org-hide-block-overlays)))
7287 (when (eq (overlay-get ov 'invisible)
7288 'org-hide-block)
7289 (delete-overlay ov))))
7290 (push ov org-hide-block-overlays)))
7291 (user-error "Not looking at a source block"))))
7293 ;; org-tab-after-check-for-cycling-hook
7294 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7295 ;; Remove overlays when changing major mode
7296 (add-hook 'org-mode-hook
7297 (lambda () (org-add-hook 'change-major-mode-hook
7298 'org-show-block-all 'append 'local)))
7300 ;;; Org-goto
7302 (defvar org-goto-window-configuration nil)
7303 (defvar org-goto-marker nil)
7304 (defvar org-goto-map)
7305 (defun org-goto-map ()
7306 "Set the keymap `org-goto'."
7307 (setq org-goto-map
7308 (let ((map (make-sparse-keymap)))
7309 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7310 mouse-drag-region universal-argument org-occur))
7311 cmd)
7312 (while (setq cmd (pop cmds))
7313 (substitute-key-definition cmd cmd map global-map)))
7314 (suppress-keymap map)
7315 (org-defkey map "\C-m" 'org-goto-ret)
7316 (org-defkey map [(return)] 'org-goto-ret)
7317 (org-defkey map [(left)] 'org-goto-left)
7318 (org-defkey map [(right)] 'org-goto-right)
7319 (org-defkey map [(control ?g)] 'org-goto-quit)
7320 (org-defkey map "\C-i" 'org-cycle)
7321 (org-defkey map [(tab)] 'org-cycle)
7322 (org-defkey map [(down)] 'outline-next-visible-heading)
7323 (org-defkey map [(up)] 'outline-previous-visible-heading)
7324 (if org-goto-auto-isearch
7325 (if (fboundp 'define-key-after)
7326 (define-key-after map [t] 'org-goto-local-auto-isearch)
7327 nil)
7328 (org-defkey map "q" 'org-goto-quit)
7329 (org-defkey map "n" 'outline-next-visible-heading)
7330 (org-defkey map "p" 'outline-previous-visible-heading)
7331 (org-defkey map "f" 'outline-forward-same-level)
7332 (org-defkey map "b" 'outline-backward-same-level)
7333 (org-defkey map "u" 'outline-up-heading))
7334 (org-defkey map "/" 'org-occur)
7335 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7336 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7337 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7338 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7339 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7340 map)))
7342 (defconst org-goto-help
7343 "Browse buffer copy, to find location or copy text.%s
7344 RET=jump to location C-g=quit and return to previous location
7345 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7347 (defvar org-goto-start-pos) ; dynamically scoped parameter
7349 (defun org-goto (&optional alternative-interface)
7350 "Look up a different location in the current file, keeping current visibility.
7352 When you want look-up or go to a different location in a
7353 document, the fastest way is often to fold the entire buffer and
7354 then dive into the tree. This method has the disadvantage, that
7355 the previous location will be folded, which may not be what you
7356 want.
7358 This command works around this by showing a copy of the current
7359 buffer in an indirect buffer, in overview mode. You can dive
7360 into the tree in that copy, use org-occur and incremental search
7361 to find a location. When pressing RET or `Q', the command
7362 returns to the original buffer in which the visibility is still
7363 unchanged. After RET it will also jump to the location selected
7364 in the indirect buffer and expose the headline hierarchy above.
7366 With a prefix argument, use the alternative interface: e.g. if
7367 `org-goto-interface' is 'outline use 'outline-path-completion."
7368 (interactive "P")
7369 (org-goto-map)
7370 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7371 (org-refile-use-outline-path t)
7372 (org-refile-target-verify-function nil)
7373 (interface
7374 (if (not alternative-interface)
7375 org-goto-interface
7376 (if (eq org-goto-interface 'outline)
7377 'outline-path-completion
7378 'outline)))
7379 (org-goto-start-pos (point))
7380 (selected-point
7381 (if (eq interface 'outline)
7382 (car (org-get-location (current-buffer) org-goto-help))
7383 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7384 (org-refile-check-position pa)
7385 (nth 3 pa)))))
7386 (if selected-point
7387 (progn
7388 (org-mark-ring-push org-goto-start-pos)
7389 (goto-char selected-point)
7390 (if (or (outline-invisible-p) (org-invisible-p2))
7391 (org-show-context 'org-goto)))
7392 (message "Quit"))))
7394 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7395 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7396 (defvar org-goto-local-auto-isearch-map) ; defined below
7398 (defun org-get-location (buf help)
7399 "Let the user select a location in the Org-mode buffer BUF.
7400 This function uses a recursive edit. It returns the selected position
7401 or nil."
7402 (org-no-popups
7403 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7404 (isearch-hide-immediately nil)
7405 (isearch-search-fun-function
7406 (lambda () 'org-goto-local-search-headings))
7407 (org-goto-selected-point org-goto-exit-command))
7408 (save-excursion
7409 (save-window-excursion
7410 (delete-other-windows)
7411 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7412 (org-pop-to-buffer-same-window
7413 (condition-case nil
7414 (make-indirect-buffer (current-buffer) "*org-goto*")
7415 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7416 (with-output-to-temp-buffer "*Org Help*"
7417 (princ (format help (if org-goto-auto-isearch
7418 " Just type for auto-isearch."
7419 " n/p/f/b/u to navigate, q to quit."))))
7420 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7421 (setq buffer-read-only nil)
7422 (let ((org-startup-truncated t)
7423 (org-startup-folded nil)
7424 (org-startup-align-all-tables nil))
7425 (org-mode)
7426 (org-overview))
7427 (setq buffer-read-only t)
7428 (if (and (boundp 'org-goto-start-pos)
7429 (integer-or-marker-p org-goto-start-pos))
7430 (let ((org-show-hierarchy-above t)
7431 (org-show-siblings t)
7432 (org-show-following-heading t))
7433 (goto-char org-goto-start-pos)
7434 (and (outline-invisible-p) (org-show-context)))
7435 (goto-char (point-min)))
7436 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7437 (message "Select location and press RET")
7438 (use-local-map org-goto-map)
7439 (recursive-edit)))
7440 (kill-buffer "*org-goto*")
7441 (cons org-goto-selected-point org-goto-exit-command))))
7443 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7444 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7445 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7446 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7448 (defun org-goto-local-search-headings (string bound noerror)
7449 "Search and make sure that any matches are in headlines."
7450 (catch 'return
7451 (while (if isearch-forward
7452 (search-forward string bound noerror)
7453 (search-backward string bound noerror))
7454 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7455 (and (member :headline context)
7456 (not (member :tags context))))
7457 (throw 'return (point))))))
7459 (defun org-goto-local-auto-isearch ()
7460 "Start isearch."
7461 (interactive)
7462 (goto-char (point-min))
7463 (let ((keys (this-command-keys)))
7464 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7465 (isearch-mode t)
7466 (isearch-process-search-char (string-to-char keys)))))
7468 (defun org-goto-ret (&optional arg)
7469 "Finish `org-goto' by going to the new location."
7470 (interactive "P")
7471 (setq org-goto-selected-point (point)
7472 org-goto-exit-command 'return)
7473 (throw 'exit nil))
7475 (defun org-goto-left ()
7476 "Finish `org-goto' by going to the new location."
7477 (interactive)
7478 (if (org-at-heading-p)
7479 (progn
7480 (beginning-of-line 1)
7481 (setq org-goto-selected-point (point)
7482 org-goto-exit-command 'left)
7483 (throw 'exit nil))
7484 (user-error "Not on a heading")))
7486 (defun org-goto-right ()
7487 "Finish `org-goto' by going to the new location."
7488 (interactive)
7489 (if (org-at-heading-p)
7490 (progn
7491 (setq org-goto-selected-point (point)
7492 org-goto-exit-command 'right)
7493 (throw 'exit nil))
7494 (user-error "Not on a heading")))
7496 (defun org-goto-quit ()
7497 "Finish `org-goto' without cursor motion."
7498 (interactive)
7499 (setq org-goto-selected-point nil)
7500 (setq org-goto-exit-command 'quit)
7501 (throw 'exit nil))
7503 ;;; Indirect buffer display of subtrees
7505 (defvar org-indirect-dedicated-frame nil
7506 "This is the frame being used for indirect tree display.")
7507 (defvar org-last-indirect-buffer nil)
7509 (defun org-tree-to-indirect-buffer (&optional arg)
7510 "Create indirect buffer and narrow it to current subtree.
7511 With a numerical prefix ARG, go up to this level and then take that tree.
7512 If ARG is negative, go up that many levels.
7514 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7515 indirect buffer previously made with this command, to avoid proliferation of
7516 indirect buffers. However, when you call the command with a \
7517 \\[universal-argument] prefix, or
7518 when `org-indirect-buffer-display' is `new-frame', the last buffer
7519 is kept so that you can work with several indirect buffers at the same time.
7520 If `org-indirect-buffer-display' is `dedicated-frame', the \
7521 \\[universal-argument] prefix also
7522 requests that a new frame be made for the new buffer, so that the dedicated
7523 frame is not changed."
7524 (interactive "P")
7525 (let ((cbuf (current-buffer))
7526 (cwin (selected-window))
7527 (pos (point))
7528 beg end level heading ibuf)
7529 (save-excursion
7530 (org-back-to-heading t)
7531 (when (numberp arg)
7532 (setq level (org-outline-level))
7533 (if (< arg 0) (setq arg (+ level arg)))
7534 (while (> (setq level (org-outline-level)) arg)
7535 (org-up-heading-safe)))
7536 (setq beg (point)
7537 heading (org-get-heading))
7538 (org-end-of-subtree t t)
7539 (if (org-at-heading-p) (backward-char 1))
7540 (setq end (point)))
7541 (if (and (buffer-live-p org-last-indirect-buffer)
7542 (not (eq org-indirect-buffer-display 'new-frame))
7543 (not arg))
7544 (kill-buffer org-last-indirect-buffer))
7545 (setq ibuf (org-get-indirect-buffer cbuf heading)
7546 org-last-indirect-buffer ibuf)
7547 (cond
7548 ((or (eq org-indirect-buffer-display 'new-frame)
7549 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7550 (select-frame (make-frame))
7551 (delete-other-windows)
7552 (org-pop-to-buffer-same-window ibuf)
7553 (org-set-frame-title heading))
7554 ((eq org-indirect-buffer-display 'dedicated-frame)
7555 (raise-frame
7556 (select-frame (or (and org-indirect-dedicated-frame
7557 (frame-live-p org-indirect-dedicated-frame)
7558 org-indirect-dedicated-frame)
7559 (setq org-indirect-dedicated-frame (make-frame)))))
7560 (delete-other-windows)
7561 (org-pop-to-buffer-same-window ibuf)
7562 (org-set-frame-title (concat "Indirect: " heading)))
7563 ((eq org-indirect-buffer-display 'current-window)
7564 (org-pop-to-buffer-same-window ibuf))
7565 ((eq org-indirect-buffer-display 'other-window)
7566 (pop-to-buffer ibuf))
7567 (t (error "Invalid value")))
7568 (if (featurep 'xemacs)
7569 (save-excursion (org-mode) (turn-on-font-lock)))
7570 (narrow-to-region beg end)
7571 (show-all)
7572 (goto-char pos)
7573 (run-hook-with-args 'org-cycle-hook 'all)
7574 (and (window-live-p cwin) (select-window cwin))))
7576 (defun org-get-indirect-buffer (&optional buffer heading)
7577 (setq buffer (or buffer (current-buffer)))
7578 (let ((n 1) (base (buffer-name buffer)) bname)
7579 (while (buffer-live-p
7580 (get-buffer
7581 (setq bname
7582 (concat base "-"
7583 (if heading (concat heading "-" (number-to-string n))
7584 (number-to-string n))))))
7585 (setq n (1+ n)))
7586 (condition-case nil
7587 (make-indirect-buffer buffer bname 'clone)
7588 (error (make-indirect-buffer buffer bname)))))
7590 (defun org-set-frame-title (title)
7591 "Set the title of the current frame to the string TITLE."
7592 ;; FIXME: how to name a single frame in XEmacs???
7593 (unless (featurep 'xemacs)
7594 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7596 ;;;; Structure editing
7598 ;;; Inserting headlines
7600 (defun org-previous-line-empty-p (&optional next)
7601 "Is the previous line a blank line?
7602 When NEXT is non-nil, check the next line instead."
7603 (save-excursion
7604 (and (not (bobp))
7605 (or (beginning-of-line (if next 2 0)) t)
7606 (save-match-data
7607 (looking-at "[ \t]*$")))))
7609 (defun org-insert-heading (&optional arg invisible-ok)
7610 "Insert a new heading or item with same depth at point.
7611 If point is in a plain list and ARG is nil, create a new list item.
7612 With one universal prefix argument, insert a heading even in lists.
7613 With two universal prefix arguments, insert the heading at the end
7614 of the parent subtree.
7616 If point is at the beginning of a headline, insert a sibling before
7617 the current headline. If point is not at the beginning, split the line
7618 and create a new headline with the text in the current line after point
7619 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7621 If point is at the beginning of a normal line, turn this line into
7622 a heading.
7624 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7625 This is important for non-interactive uses of the command."
7626 (interactive "P")
7627 (if (org-called-interactively-p 'any) (org-reveal))
7628 (let ((itemp (org-in-item-p))
7629 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7630 (respect-content (or org-insert-heading-respect-content
7631 (equal arg '(16))))
7632 (initial-content "")
7633 (adjust-empty-lines t))
7635 (cond
7637 ((or (= (buffer-size) 0)
7638 (and (not (save-excursion
7639 (and (ignore-errors (org-back-to-heading invisible-ok))
7640 (org-at-heading-p))))
7641 (or arg (not itemp))))
7642 ;; At beginning of buffer or so high up that only a heading
7643 ;; makes sense.
7644 (insert
7645 (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
7646 (if (org-in-src-block-p) ",* " "* "))
7647 (run-hooks 'org-insert-heading-hook))
7649 ((and itemp (not (equal arg '(4))))
7650 ;; Insert an item
7651 (org-insert-item))
7654 ;; Insert a heading
7655 (save-restriction
7656 (widen)
7657 (let* ((level nil)
7658 (on-heading (org-at-heading-p))
7659 (empty-line-p (if on-heading
7660 (org-previous-line-empty-p)
7661 ;; We will decide later
7662 nil))
7663 ;; Get a level string to fall back on
7664 (fix-level
7665 (save-excursion
7666 (org-back-to-heading t)
7667 (if (org-previous-line-empty-p) (setq empty-line-p t))
7668 (looking-at org-outline-regexp)
7669 (make-string (1- (length (match-string 0))) ?*)))
7670 (stars
7671 (save-excursion
7672 (condition-case nil
7673 (progn
7674 (org-back-to-heading invisible-ok)
7675 (when (and (not on-heading)
7676 (featurep 'org-inlinetask)
7677 (integerp org-inlinetask-min-level)
7678 (>= (length (match-string 0))
7679 org-inlinetask-min-level))
7680 ;; Find a heading level before the inline task
7681 (while (and (setq level (org-up-heading-safe))
7682 (>= level org-inlinetask-min-level)))
7683 (if (org-at-heading-p)
7684 (org-back-to-heading invisible-ok)
7685 (error "This should not happen")))
7686 (unless (and (save-excursion
7687 (save-match-data
7688 (org-backward-heading-same-level
7689 1 invisible-ok))
7690 (= (point) (match-beginning 0)))
7691 (not (org-previous-line-empty-p t)))
7692 (setq empty-line-p (or empty-line-p
7693 (org-previous-line-empty-p))))
7694 (match-string 0))
7695 (error (or fix-level "* ")))))
7696 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7697 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7698 pos hide-previous previous-pos)
7700 ;; If we insert after content, move there and clean up whitespace
7701 (when respect-content
7702 (org-end-of-subtree nil t)
7703 (skip-chars-backward " \r\n")
7704 (and (looking-at "[ \t]+") (replace-match ""))
7705 (unless (eobp) (forward-char 1))
7706 (when (looking-at "^\\*")
7707 (unless (bobp) (backward-char 1))
7708 (insert "\n")))
7710 ;; If we are splitting, grab the text that should be moved to the new headline
7711 (when may-split
7712 (if (org-on-heading-p)
7713 ;; This is a heading, we split intelligently (keeping tags)
7714 (let ((pos (point)))
7715 (goto-char (point-at-bol))
7716 (unless (looking-at org-complex-heading-regexp)
7717 (error "This should not happen"))
7718 (when (and (match-beginning 4)
7719 (> pos (match-beginning 4))
7720 (< pos (match-end 4)))
7721 (setq initial-content (buffer-substring pos (match-end 4)))
7722 (goto-char pos)
7723 (delete-region (point) (match-end 4))
7724 (if (looking-at "[ \t]*$")
7725 (replace-match "")
7726 (insert (make-string (length initial-content) ?\ )))
7727 (setq initial-content (org-trim initial-content)))
7728 (goto-char pos))
7729 ;; a normal line
7730 (unless (bolp)
7731 (setq initial-content (buffer-substring (point) (point-at-eol)))
7732 (delete-region (point) (point-at-eol))
7733 (setq initial-content (org-trim initial-content)))))
7735 ;; If we are at the beginning of the line, insert before it. Else after
7736 (cond
7737 ((and (bolp) (looking-at "[ \t]*$")))
7738 ((and (bolp) (not (looking-at "[ \t]*$")))
7739 (open-line 1))
7741 (goto-char (point-at-eol))
7742 (insert "\n")))
7744 ;; Insert the new heading
7745 (insert stars)
7746 (just-one-space)
7747 (insert initial-content)
7748 (when adjust-empty-lines
7749 (if (or (not blank)
7750 (and blank (not (org-previous-line-empty-p))))
7751 (org-N-empty-lines-before-current (if blank 1 0))))
7752 (run-hooks 'org-insert-heading-hook)))))))
7754 (defun org-N-empty-lines-before-current (N)
7755 "Make the number of empty lines before current exactly N.
7756 So this will delete or add empty lines."
7757 (save-excursion
7758 (goto-char (point-at-bol))
7759 (if (looking-back "\\s-+" nil 'greedy)
7760 (replace-match ""))
7761 (or (bobp) (insert "\n"))
7762 (while (> N 0)
7763 (insert "\n")
7764 (setq N (1- N)))))
7766 (defun org-get-heading (&optional no-tags no-todo)
7767 "Return the heading of the current entry, without the stars.
7768 When NO-TAGS is non-nil, don't include tags.
7769 When NO-TODO is non-nil, don't include TODO keywords."
7770 (save-excursion
7771 (org-back-to-heading t)
7772 (cond
7773 ((and no-tags no-todo)
7774 (looking-at org-complex-heading-regexp)
7775 (match-string 4))
7776 (no-tags
7777 (looking-at (concat org-outline-regexp
7778 "\\(.*?\\)"
7779 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7780 (match-string 1))
7781 (no-todo
7782 (looking-at org-todo-line-regexp)
7783 (match-string 3))
7784 (t (looking-at org-heading-regexp)
7785 (match-string 2)))))
7787 (defvar orgstruct-mode) ; defined below
7789 (defun org-heading-components ()
7790 "Return the components of the current heading.
7791 This is a list with the following elements:
7792 - the level as an integer
7793 - the reduced level, different if `org-odd-levels-only' is set.
7794 - the TODO keyword, or nil
7795 - the priority character, like ?A, or nil if no priority is given
7796 - the headline text itself, or the tags string if no headline text
7797 - the tags string, or nil."
7798 (save-excursion
7799 (org-back-to-heading t)
7800 (if (let (case-fold-search)
7801 (looking-at
7802 (if orgstruct-mode
7803 org-heading-regexp
7804 org-complex-heading-regexp)))
7805 (if orgstruct-mode
7806 (list (length (match-string 1))
7807 (org-reduced-level (length (match-string 1)))
7810 (match-string 2)
7811 nil)
7812 (list (length (match-string 1))
7813 (org-reduced-level (length (match-string 1)))
7814 (org-match-string-no-properties 2)
7815 (and (match-end 3) (aref (match-string 3) 2))
7816 (org-match-string-no-properties 4)
7817 (org-match-string-no-properties 5))))))
7819 (defun org-get-entry ()
7820 "Get the entry text, after heading, entire subtree."
7821 (save-excursion
7822 (org-back-to-heading t)
7823 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7825 (defun org-insert-heading-after-current ()
7826 "Insert a new heading with same level as current, after current subtree."
7827 (interactive)
7828 (org-back-to-heading)
7829 (org-insert-heading)
7830 (org-move-subtree-down)
7831 (end-of-line 1))
7833 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7834 "Insert heading with `org-insert-heading-respect-content' set to t."
7835 (interactive "P")
7836 (let ((org-insert-heading-respect-content t))
7837 (org-insert-heading '(4) invisible-ok)))
7839 (defun org-insert-todo-heading-respect-content (&optional force-state)
7840 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7841 (interactive "P")
7842 (let ((org-insert-heading-respect-content t))
7843 (org-insert-todo-heading force-state '(4))))
7845 (defun org-insert-todo-heading (arg &optional force-heading)
7846 "Insert a new heading with the same level and TODO state as current heading.
7847 If the heading has no TODO state, or if the state is DONE, use the first
7848 state (TODO by default). Also one prefix arg, force first state. With two
7849 prefix args, force inserting at the end of the parent subtree."
7850 (interactive "P")
7851 (when (or force-heading (not (org-insert-item 'checkbox)))
7852 (org-insert-heading (or (and (equal arg '(16)) '(16))
7853 force-heading))
7854 (save-excursion
7855 (org-back-to-heading)
7856 (outline-previous-heading)
7857 (looking-at org-todo-line-regexp))
7858 (let*
7859 ((new-mark-x
7860 (if (or arg
7861 (not (match-beginning 2))
7862 (member (match-string 2) org-done-keywords))
7863 (car org-todo-keywords-1)
7864 (match-string 2)))
7865 (new-mark
7867 (run-hook-with-args-until-success
7868 'org-todo-get-default-hook new-mark-x nil)
7869 new-mark-x)))
7870 (beginning-of-line 1)
7871 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7872 (if org-treat-insert-todo-heading-as-state-change
7873 (org-todo new-mark)
7874 (insert new-mark " "))))
7875 (when org-provide-todo-statistics
7876 (org-update-parent-todo-statistics))))
7878 (defun org-insert-subheading (arg)
7879 "Insert a new subheading and demote it.
7880 Works for outline headings and for plain lists alike."
7881 (interactive "P")
7882 (org-insert-heading arg)
7883 (cond
7884 ((org-at-heading-p) (org-do-demote))
7885 ((org-at-item-p) (org-indent-item))))
7887 (defun org-insert-todo-subheading (arg)
7888 "Insert a new subheading with TODO keyword or checkbox and demote it.
7889 Works for outline headings and for plain lists alike."
7890 (interactive "P")
7891 (org-insert-todo-heading arg)
7892 (cond
7893 ((org-at-heading-p) (org-do-demote))
7894 ((org-at-item-p) (org-indent-item))))
7896 ;;; Promotion and Demotion
7898 (defvar org-after-demote-entry-hook nil
7899 "Hook run after an entry has been demoted.
7900 The cursor will be at the beginning of the entry.
7901 When a subtree is being demoted, the hook will be called for each node.")
7903 (defvar org-after-promote-entry-hook nil
7904 "Hook run after an entry has been promoted.
7905 The cursor will be at the beginning of the entry.
7906 When a subtree is being promoted, the hook will be called for each node.")
7908 (defun org-promote-subtree ()
7909 "Promote the entire subtree.
7910 See also `org-promote'."
7911 (interactive)
7912 (save-excursion
7913 (org-with-limited-levels (org-map-tree 'org-promote)))
7914 (org-fix-position-after-promote))
7916 (defun org-demote-subtree ()
7917 "Demote the entire subtree. See `org-demote'.
7918 See also `org-promote'."
7919 (interactive)
7920 (save-excursion
7921 (org-with-limited-levels (org-map-tree 'org-demote)))
7922 (org-fix-position-after-promote))
7925 (defun org-do-promote ()
7926 "Promote the current heading higher up the tree.
7927 If the region is active in `transient-mark-mode', promote all headings
7928 in the region."
7929 (interactive)
7930 (save-excursion
7931 (if (org-region-active-p)
7932 (org-map-region 'org-promote (region-beginning) (region-end))
7933 (org-promote)))
7934 (org-fix-position-after-promote))
7936 (defun org-do-demote ()
7937 "Demote the current heading lower down the tree.
7938 If the region is active in `transient-mark-mode', demote all headings
7939 in the region."
7940 (interactive)
7941 (save-excursion
7942 (if (org-region-active-p)
7943 (org-map-region 'org-demote (region-beginning) (region-end))
7944 (org-demote)))
7945 (org-fix-position-after-promote))
7947 (defun org-fix-position-after-promote ()
7948 "Make sure that after pro/demotion cursor position is right."
7949 (let ((pos (point)))
7950 (when (save-excursion
7951 (beginning-of-line 1)
7952 (looking-at org-todo-line-regexp)
7953 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7954 (cond ((eobp) (insert " "))
7955 ((eolp) (insert " "))
7956 ((equal (char-after) ?\ ) (forward-char 1))))))
7958 (defun org-current-level ()
7959 "Return the level of the current entry, or nil if before the first headline.
7960 The level is the number of stars at the beginning of the headline."
7961 (save-excursion
7962 (org-with-limited-levels
7963 (if (ignore-errors (org-back-to-heading t))
7964 (funcall outline-level)))))
7966 (defun org-get-previous-line-level ()
7967 "Return the outline depth of the last headline before the current line.
7968 Returns 0 for the first headline in the buffer, and nil if before the
7969 first headline."
7970 (and (org-current-level)
7971 (or (and (/= (line-beginning-position) (point-min))
7972 (save-excursion (beginning-of-line 0) (org-current-level)))
7973 0)))
7975 (defun org-reduced-level (l)
7976 "Compute the effective level of a heading.
7977 This takes into account the setting of `org-odd-levels-only'."
7978 (cond
7979 ((zerop l) 0)
7980 (org-odd-levels-only (1+ (floor (/ l 2))))
7981 (t l)))
7983 (defun org-level-increment ()
7984 "Return the number of stars that will be added or removed at a
7985 time to headlines when structure editing, based on the value of
7986 `org-odd-levels-only'."
7987 (if org-odd-levels-only 2 1))
7989 (defun org-get-valid-level (level &optional change)
7990 "Rectify a level change under the influence of `org-odd-levels-only'
7991 LEVEL is a current level, CHANGE is by how much the level should be
7992 modified. Even if CHANGE is nil, LEVEL may be returned modified because
7993 even level numbers will become the next higher odd number."
7994 (if org-odd-levels-only
7995 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
7996 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
7997 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
7998 (max 1 (+ level (or change 0)))))
8000 (if (boundp 'define-obsolete-function-alias)
8001 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8002 (define-obsolete-function-alias 'org-get-legal-level
8003 'org-get-valid-level)
8004 (define-obsolete-function-alias 'org-get-legal-level
8005 'org-get-valid-level "23.1")))
8007 (defun org-promote ()
8008 "Promote the current heading higher up the tree.
8009 If the region is active in `transient-mark-mode', promote all headings
8010 in the region."
8011 (org-back-to-heading t)
8012 (let* ((level (save-match-data (funcall outline-level)))
8013 (after-change-functions (remove 'flyspell-after-change-function
8014 after-change-functions))
8015 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8016 (diff (abs (- level (length up-head) -1))))
8017 (cond ((and (= level 1) org-called-with-limited-levels
8018 org-allow-promoting-top-level-subtree)
8019 (replace-match "# " nil t))
8020 ((= level 1)
8021 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8022 (t (replace-match up-head nil t)))
8023 ;; Fixup tag positioning
8024 (unless (= level 1)
8025 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8026 (if org-adapt-indentation (org-fixup-indentation (- diff))))
8027 (run-hooks 'org-after-promote-entry-hook)))
8029 (defun org-demote ()
8030 "Demote the current heading lower down the tree.
8031 If the region is active in `transient-mark-mode', demote all headings
8032 in the region."
8033 (org-back-to-heading t)
8034 (let* ((level (save-match-data (funcall outline-level)))
8035 (after-change-functions (remove 'flyspell-after-change-function
8036 after-change-functions))
8037 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8038 (diff (abs (- level (length down-head) -1))))
8039 (replace-match down-head nil t)
8040 ;; Fixup tag positioning
8041 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8042 (if org-adapt-indentation (org-fixup-indentation diff))
8043 (run-hooks 'org-after-demote-entry-hook)))
8045 (defun org-cycle-level ()
8046 "Cycle the level of an empty headline through possible states.
8047 This goes first to child, then to parent, level, then up the hierarchy.
8048 After top level, it switches back to sibling level."
8049 (interactive)
8050 (let ((org-adapt-indentation nil))
8051 (when (org-point-at-end-of-empty-headline)
8052 (setq this-command 'org-cycle-level) ; Only needed for caching
8053 (let ((cur-level (org-current-level))
8054 (prev-level (org-get-previous-line-level)))
8055 (cond
8056 ;; If first headline in file, promote to top-level.
8057 ((= prev-level 0)
8058 (loop repeat (/ (- cur-level 1) (org-level-increment))
8059 do (org-do-promote)))
8060 ;; If same level as prev, demote one.
8061 ((= prev-level cur-level)
8062 (org-do-demote))
8063 ;; If parent is top-level, promote to top level if not already.
8064 ((= prev-level 1)
8065 (loop repeat (/ (- cur-level 1) (org-level-increment))
8066 do (org-do-promote)))
8067 ;; If top-level, return to prev-level.
8068 ((= cur-level 1)
8069 (loop repeat (/ (- prev-level 1) (org-level-increment))
8070 do (org-do-demote)))
8071 ;; If less than prev-level, promote one.
8072 ((< cur-level prev-level)
8073 (org-do-promote))
8074 ;; If deeper than prev-level, promote until higher than
8075 ;; prev-level.
8076 ((> cur-level prev-level)
8077 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8078 do (org-do-promote))))
8079 t))))
8081 (defun org-map-tree (fun)
8082 "Call FUN for every heading underneath the current one."
8083 (org-back-to-heading)
8084 (let ((level (funcall outline-level)))
8085 (save-excursion
8086 (funcall fun)
8087 (while (and (progn
8088 (outline-next-heading)
8089 (> (funcall outline-level) level))
8090 (not (eobp)))
8091 (funcall fun)))))
8093 (defun org-map-region (fun beg end)
8094 "Call FUN for every heading between BEG and END."
8095 (let ((org-ignore-region t))
8096 (save-excursion
8097 (setq end (copy-marker end))
8098 (goto-char beg)
8099 (if (and (re-search-forward org-outline-regexp-bol nil t)
8100 (< (point) end))
8101 (funcall fun))
8102 (while (and (progn
8103 (outline-next-heading)
8104 (< (point) end))
8105 (not (eobp)))
8106 (funcall fun)))))
8108 (defvar org-property-end-re) ; silence byte-compiler
8109 (defun org-fixup-indentation (diff)
8110 "Change the indentation in the current entry by DIFF.
8111 However, if any line in the current entry has no indentation, or if it
8112 would end up with no indentation after the change, nothing at all is done."
8113 (save-excursion
8114 (let ((end (save-excursion (outline-next-heading)
8115 (point-marker)))
8116 (prohibit (if (> diff 0)
8117 "^\\S-"
8118 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8119 col)
8120 (unless (save-excursion (end-of-line 1)
8121 (re-search-forward prohibit end t))
8122 (while (and (< (point) end)
8123 (re-search-forward "^[ \t]+" end t))
8124 (goto-char (match-end 0))
8125 (setq col (current-column))
8126 (if (< diff 0) (replace-match ""))
8127 (org-indent-to-column (+ diff col))))
8128 (move-marker end nil))))
8130 (defun org-convert-to-odd-levels ()
8131 "Convert an org-mode file with all levels allowed to one with odd levels.
8132 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8133 level 5 etc."
8134 (interactive)
8135 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8136 (let ((outline-level 'org-outline-level)
8137 (org-odd-levels-only nil) n)
8138 (save-excursion
8139 (goto-char (point-min))
8140 (while (re-search-forward "^\\*\\*+ " nil t)
8141 (setq n (- (length (match-string 0)) 2))
8142 (while (>= (setq n (1- n)) 0)
8143 (org-demote))
8144 (end-of-line 1))))))
8146 (defun org-convert-to-oddeven-levels ()
8147 "Convert an org-mode file with only odd levels to one with odd/even levels.
8148 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8149 file contains a section with an even level, conversion would
8150 destroy the structure of the file. An error is signaled in this
8151 case."
8152 (interactive)
8153 (goto-char (point-min))
8154 ;; First check if there are no even levels
8155 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8156 (org-show-context t)
8157 (error "Not all levels are odd in this file. Conversion not possible"))
8158 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8159 (let ((outline-regexp org-outline-regexp)
8160 (outline-level 'org-outline-level)
8161 (org-odd-levels-only nil) n)
8162 (save-excursion
8163 (goto-char (point-min))
8164 (while (re-search-forward "^\\*\\*+ " nil t)
8165 (setq n (/ (1- (length (match-string 0))) 2))
8166 (while (>= (setq n (1- n)) 0)
8167 (org-promote))
8168 (end-of-line 1))))))
8170 (defun org-tr-level (n)
8171 "Make N odd if required."
8172 (if org-odd-levels-only (1+ (/ n 2)) n))
8174 ;;; Vertical tree motion, cutting and pasting of subtrees
8176 (defun org-move-subtree-up (&optional arg)
8177 "Move the current subtree up past ARG headlines of the same level."
8178 (interactive "p")
8179 (org-move-subtree-down (- (prefix-numeric-value arg))))
8181 (defun org-move-subtree-down (&optional arg)
8182 "Move the current subtree down past ARG headlines of the same level."
8183 (interactive "p")
8184 (setq arg (prefix-numeric-value arg))
8185 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8186 'org-get-last-sibling))
8187 (ins-point (make-marker))
8188 (cnt (abs arg))
8189 (col (current-column))
8190 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8191 ;; Select the tree
8192 (org-back-to-heading)
8193 (setq beg0 (point))
8194 (save-excursion
8195 (setq ne-beg (org-back-over-empty-lines))
8196 (setq beg (point)))
8197 (save-match-data
8198 (save-excursion (outline-end-of-heading)
8199 (setq folded (outline-invisible-p)))
8200 (outline-end-of-subtree))
8201 (outline-next-heading)
8202 (setq ne-end (org-back-over-empty-lines))
8203 (setq end (point))
8204 (goto-char beg0)
8205 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8206 ;; include less whitespace
8207 (save-excursion
8208 (goto-char beg)
8209 (forward-line (- ne-beg ne-end))
8210 (setq beg (point))))
8211 ;; Find insertion point, with error handling
8212 (while (> cnt 0)
8213 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8214 (progn (goto-char beg0)
8215 (user-error "Cannot move past superior level or buffer limit")))
8216 (setq cnt (1- cnt)))
8217 (if (> arg 0)
8218 ;; Moving forward - still need to move over subtree
8219 (progn (org-end-of-subtree t t)
8220 (save-excursion
8221 (org-back-over-empty-lines)
8222 (or (bolp) (newline)))))
8223 (setq ne-ins (org-back-over-empty-lines))
8224 (move-marker ins-point (point))
8225 (setq txt (buffer-substring beg end))
8226 (org-save-markers-in-region beg end)
8227 (delete-region beg end)
8228 (org-remove-empty-overlays-at beg)
8229 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8230 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8231 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8232 (let ((bbb (point)))
8233 (insert-before-markers txt)
8234 (org-reinstall-markers-in-region bbb)
8235 (move-marker ins-point bbb))
8236 (or (bolp) (insert "\n"))
8237 (setq ins-end (point))
8238 (goto-char ins-point)
8239 (org-skip-whitespace)
8240 (when (and (< arg 0)
8241 (org-first-sibling-p)
8242 (> ne-ins ne-beg))
8243 ;; Move whitespace back to beginning
8244 (save-excursion
8245 (goto-char ins-end)
8246 (let ((kill-whole-line t))
8247 (kill-line (- ne-ins ne-beg)) (point)))
8248 (insert (make-string (- ne-ins ne-beg) ?\n)))
8249 (move-marker ins-point nil)
8250 (if folded
8251 (hide-subtree)
8252 (org-show-entry)
8253 (show-children)
8254 (org-cycle-hide-drawers 'children))
8255 (org-clean-visibility-after-subtree-move)
8256 ;; move back to the initial column we were at
8257 (move-to-column col)))
8259 (defvar org-subtree-clip ""
8260 "Clipboard for cut and paste of subtrees.
8261 This is actually only a copy of the kill, because we use the normal kill
8262 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8264 (defvar org-subtree-clip-folded nil
8265 "Was the last copied subtree folded?
8266 This is used to fold the tree back after pasting.")
8268 (defun org-cut-subtree (&optional n)
8269 "Cut the current subtree into the clipboard.
8270 With prefix arg N, cut this many sequential subtrees.
8271 This is a short-hand for marking the subtree and then cutting it."
8272 (interactive "p")
8273 (org-copy-subtree n 'cut))
8275 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8276 "Copy the current subtree it in the clipboard.
8277 With prefix arg N, copy this many sequential subtrees.
8278 This is a short-hand for marking the subtree and then copying it.
8279 If CUT is non-nil, actually cut the subtree.
8280 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8281 of some markers in the region, even if CUT is non-nil. This is
8282 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8283 (interactive "p")
8284 (let (beg end folded (beg0 (point)))
8285 (if (org-called-interactively-p 'any)
8286 (org-back-to-heading nil) ; take what looks like a subtree
8287 (org-back-to-heading t)) ; take what is really there
8288 (setq beg (point))
8289 (skip-chars-forward " \t\r\n")
8290 (save-match-data
8291 (if nosubtrees
8292 (outline-next-heading)
8293 (save-excursion (outline-end-of-heading)
8294 (setq folded (outline-invisible-p)))
8295 (condition-case nil
8296 (org-forward-heading-same-level (1- n) t)
8297 (error nil))
8298 (org-end-of-subtree t t)))
8299 (setq end (point))
8300 (goto-char beg0)
8301 (when (> end beg)
8302 (setq org-subtree-clip-folded folded)
8303 (when (or cut force-store-markers)
8304 (org-save-markers-in-region beg end))
8305 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8306 (setq org-subtree-clip (current-kill 0))
8307 (message "%s: Subtree(s) with %d characters"
8308 (if cut "Cut" "Copied")
8309 (length org-subtree-clip)))))
8311 (defun org-paste-subtree (&optional level tree for-yank)
8312 "Paste the clipboard as a subtree, with modification of headline level.
8313 The entire subtree is promoted or demoted in order to match a new headline
8314 level.
8316 If the cursor is at the beginning of a headline, the same level as
8317 that headline is used to paste the tree.
8319 If not, the new level is derived from the *visible* headings
8320 before and after the insertion point, and taken to be the inferior headline
8321 level of the two. So if the previous visible heading is level 3 and the
8322 next is level 4 (or vice versa), level 4 will be used for insertion.
8323 This makes sure that the subtree remains an independent subtree and does
8324 not swallow low level entries.
8326 You can also force a different level, either by using a numeric prefix
8327 argument, or by inserting the heading marker by hand. For example, if the
8328 cursor is after \"*****\", then the tree will be shifted to level 5.
8330 If optional TREE is given, use this text instead of the kill ring.
8332 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8333 move back over whitespace before inserting, and move point to the end of
8334 the inserted text when done."
8335 (interactive "P")
8336 (setq tree (or tree (and kill-ring (current-kill 0))))
8337 (unless (org-kill-is-subtree-p tree)
8338 (user-error "%s"
8339 (substitute-command-keys
8340 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8341 (org-with-limited-levels
8342 (let* ((visp (not (outline-invisible-p)))
8343 (txt tree)
8344 (^re_ "\\(\\*+\\)[ \t]*")
8345 (old-level (if (string-match org-outline-regexp-bol txt)
8346 (- (match-end 0) (match-beginning 0) 1)
8347 -1))
8348 (force-level (cond (level (prefix-numeric-value level))
8349 ((and (looking-at "[ \t]*$")
8350 (string-match
8351 "^\\*+$" (buffer-substring
8352 (point-at-bol) (point))))
8353 (- (match-end 1) (match-beginning 1)))
8354 ((and (bolp)
8355 (looking-at org-outline-regexp))
8356 (- (match-end 0) (point) 1))))
8357 (previous-level (save-excursion
8358 (condition-case nil
8359 (progn
8360 (outline-previous-visible-heading 1)
8361 (if (looking-at ^re_)
8362 (- (match-end 0) (match-beginning 0) 1)
8364 (error 1))))
8365 (next-level (save-excursion
8366 (condition-case nil
8367 (progn
8368 (or (looking-at org-outline-regexp)
8369 (outline-next-visible-heading 1))
8370 (if (looking-at ^re_)
8371 (- (match-end 0) (match-beginning 0) 1)
8373 (error 1))))
8374 (new-level (or force-level (max previous-level next-level)))
8375 (shift (if (or (= old-level -1)
8376 (= new-level -1)
8377 (= old-level new-level))
8379 (- new-level old-level)))
8380 (delta (if (> shift 0) -1 1))
8381 (func (if (> shift 0) 'org-demote 'org-promote))
8382 (org-odd-levels-only nil)
8383 beg end newend)
8384 ;; Remove the forced level indicator
8385 (if force-level
8386 (delete-region (point-at-bol) (point)))
8387 ;; Paste
8388 (beginning-of-line (if (bolp) 1 2))
8389 (setq beg (point))
8390 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8391 (insert-before-markers txt)
8392 (unless (string-match "\n\\'" txt) (insert "\n"))
8393 (setq newend (point))
8394 (org-reinstall-markers-in-region beg)
8395 (setq end (point))
8396 (goto-char beg)
8397 (skip-chars-forward " \t\n\r")
8398 (setq beg (point))
8399 (if (and (outline-invisible-p) visp)
8400 (save-excursion (outline-show-heading)))
8401 ;; Shift if necessary
8402 (unless (= shift 0)
8403 (save-restriction
8404 (narrow-to-region beg end)
8405 (while (not (= shift 0))
8406 (org-map-region func (point-min) (point-max))
8407 (setq shift (+ delta shift)))
8408 (goto-char (point-min))
8409 (setq newend (point-max))))
8410 (when (or (org-called-interactively-p 'interactive) for-yank)
8411 (message "Clipboard pasted as level %d subtree" new-level))
8412 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8413 kill-ring
8414 (eq org-subtree-clip (current-kill 0))
8415 org-subtree-clip-folded)
8416 ;; The tree was folded before it was killed/copied
8417 (hide-subtree))
8418 (and for-yank (goto-char newend)))))
8420 (defun org-kill-is-subtree-p (&optional txt)
8421 "Check if the current kill is an outline subtree, or a set of trees.
8422 Returns nil if kill does not start with a headline, or if the first
8423 headline level is not the largest headline level in the tree.
8424 So this will actually accept several entries of equal levels as well,
8425 which is OK for `org-paste-subtree'.
8426 If optional TXT is given, check this string instead of the current kill."
8427 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8428 (re (org-get-limited-outline-regexp))
8429 (^re (concat "^" re))
8430 (start-level (and kill
8431 (string-match
8432 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8433 kill)
8434 (- (match-end 2) (match-beginning 2) 1)))
8435 (start (1+ (or (match-beginning 2) -1))))
8436 (if (not start-level)
8437 (progn
8438 nil) ;; does not even start with a heading
8439 (catch 'exit
8440 (while (setq start (string-match ^re kill (1+ start)))
8441 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8442 (throw 'exit nil)))
8443 t))))
8445 (defvar org-markers-to-move nil
8446 "Markers that should be moved with a cut-and-paste operation.
8447 Those markers are stored together with their positions relative to
8448 the start of the region.")
8450 (defun org-save-markers-in-region (beg end)
8451 "Check markers in region.
8452 If these markers are between BEG and END, record their position relative
8453 to BEG, so that after moving the block of text, we can put the markers back
8454 into place.
8455 This function gets called just before an entry or tree gets cut from the
8456 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8457 called immediately, to move the markers with the entries."
8458 (setq org-markers-to-move nil)
8459 (when (featurep 'org-clock)
8460 (org-clock-save-markers-for-cut-and-paste beg end))
8461 (when (featurep 'org-agenda)
8462 (org-agenda-save-markers-for-cut-and-paste beg end)))
8464 (defun org-check-and-save-marker (marker beg end)
8465 "Check if MARKER is between BEG and END.
8466 If yes, remember the marker and the distance to BEG."
8467 (when (and (marker-buffer marker)
8468 (equal (marker-buffer marker) (current-buffer)))
8469 (if (and (>= marker beg) (< marker end))
8470 (push (cons marker (- marker beg)) org-markers-to-move))))
8472 (defun org-reinstall-markers-in-region (beg)
8473 "Move all remembered markers to their position relative to BEG."
8474 (mapc (lambda (x)
8475 (move-marker (car x) (+ beg (cdr x))))
8476 org-markers-to-move)
8477 (setq org-markers-to-move nil))
8479 (defun org-narrow-to-subtree ()
8480 "Narrow buffer to the current subtree."
8481 (interactive)
8482 (save-excursion
8483 (save-match-data
8484 (org-with-limited-levels
8485 (narrow-to-region
8486 (progn (org-back-to-heading t) (point))
8487 (progn (org-end-of-subtree t t)
8488 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8489 (point)))))))
8491 (defun org-narrow-to-block ()
8492 "Narrow buffer to the current block."
8493 (interactive)
8494 (let* ((case-fold-search t)
8495 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8496 "^[ \t]*#\\+end_.*")))
8497 (if blockp
8498 (narrow-to-region (car blockp) (cdr blockp))
8499 (user-error "Not in a block"))))
8501 (eval-when-compile
8502 (defvar org-property-drawer-re))
8504 (defvar org-property-start-re) ;; defined below
8505 (defun org-clone-subtree-with-time-shift (n &optional shift)
8506 "Clone the task (subtree) at point N times.
8507 The clones will be inserted as siblings.
8509 In interactive use, the user will be prompted for the number of
8510 clones to be produced. If the entry has a timestamp, the user
8511 will also be prompted for a time shift, which may be a repeater
8512 as used in time stamps, for example `+3d'. To disable this,
8513 you can call the function with a universal prefix argument.
8515 When a valid repeater is given and the entry contains any time
8516 stamps, the clones will become a sequence in time, with time
8517 stamps in the subtree shifted for each clone produced. If SHIFT
8518 is nil or the empty string, time stamps will be left alone. The
8519 ID property of the original subtree is removed.
8521 If the original subtree did contain time stamps with a repeater,
8522 the following will happen:
8523 - the repeater will be removed in each clone
8524 - an additional clone will be produced, with the current, unshifted
8525 date(s) in the entry.
8526 - the original entry will be placed *after* all the clones, with
8527 repeater intact.
8528 - the start days in the repeater in the original entry will be shifted
8529 to past the last clone.
8530 In this way you can spell out a number of instances of a repeating task,
8531 and still retain the repeater to cover future instances of the task."
8532 (interactive "nNumber of clones to produce: ")
8533 (let ((shift
8534 (or shift
8535 (if (and (not (equal current-prefix-arg '(4)))
8536 (save-excursion
8537 (re-search-forward org-ts-regexp-both
8538 (save-excursion
8539 (org-end-of-subtree t)
8540 (point)) t)))
8541 (read-from-minibuffer
8542 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8543 ""))) ;; No time shift
8544 (n-no-remove -1)
8545 (drawer-re org-drawer-regexp)
8546 beg end template task idprop
8547 shift-n shift-what doshift nmin nmax)
8548 (if (not (and (integerp n) (> n 0)))
8549 (error "Invalid number of replications %s" n))
8550 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8551 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8552 shift)))
8553 (error "Invalid shift specification %s" shift))
8554 (when doshift
8555 (setq shift-n (string-to-number (match-string 1 shift))
8556 shift-what (cdr (assoc (match-string 2 shift)
8557 '(("d" . day) ("w" . week)
8558 ("m" . month) ("y" . year))))))
8559 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8560 (setq nmin 1 nmax n)
8561 (org-back-to-heading t)
8562 (setq beg (point))
8563 (setq idprop (org-entry-get nil "ID"))
8564 (org-end-of-subtree t t)
8565 (or (bolp) (insert "\n"))
8566 (setq end (point))
8567 (setq template (buffer-substring beg end))
8568 (when (and doshift
8569 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8570 (delete-region beg end)
8571 (setq end beg)
8572 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8573 (goto-char end)
8574 (loop for n from nmin to nmax do
8575 ;; prepare clone
8576 (with-temp-buffer
8577 (insert template)
8578 (org-mode)
8579 (goto-char (point-min))
8580 (org-show-subtree)
8581 (and idprop (if org-clone-delete-id
8582 (org-entry-delete nil "ID")
8583 (org-id-get-create t)))
8584 (unless (= n 0)
8585 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8586 (kill-whole-line))
8587 (goto-char (point-min))
8588 (while (re-search-forward drawer-re nil t)
8589 (org-remove-empty-drawer-at (point))))
8590 (goto-char (point-min))
8591 (when doshift
8592 (while (re-search-forward org-ts-regexp-both nil t)
8593 (org-timestamp-change (* n shift-n) shift-what))
8594 (unless (= n n-no-remove)
8595 (goto-char (point-min))
8596 (while (re-search-forward org-ts-regexp nil t)
8597 (save-excursion
8598 (goto-char (match-beginning 0))
8599 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8600 (delete-region (match-beginning 1) (match-end 1)))))))
8601 (setq task (buffer-string)))
8602 (insert task))
8603 (goto-char beg)))
8605 ;;; Outline Sorting
8607 (defun org-sort (with-case)
8608 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8609 Optional argument WITH-CASE means sort case-sensitively."
8610 (interactive "P")
8611 (cond
8612 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8613 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8615 (org-call-with-arg 'org-sort-entries with-case))))
8617 (defun org-sort-remove-invisible (s)
8618 "Remove invisible links from string S."
8619 (remove-text-properties 0 (length s) org-rm-props s)
8620 (while (string-match org-bracket-link-regexp s)
8621 (setq s (replace-match (if (match-end 2)
8622 (match-string 3 s)
8623 (match-string 1 s)) t t s)))
8624 (let ((st (format " %s " s)))
8625 (while (string-match org-emph-re st)
8626 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8627 (setq s (substring st 1 -1)))
8630 (defvar org-priority-regexp) ; defined later in the file
8632 (defvar org-after-sorting-entries-or-items-hook nil
8633 "Hook that is run after a bunch of entries or items have been sorted.
8634 When children are sorted, the cursor is in the parent line when this
8635 hook gets called. When a region or a plain list is sorted, the cursor
8636 will be in the first entry of the sorted region/list.")
8638 (defun org-sort-entries
8639 (&optional with-case sorting-type getkey-func compare-func property)
8640 "Sort entries on a certain level of an outline tree.
8641 If there is an active region, the entries in the region are sorted.
8642 Else, if the cursor is before the first entry, sort the top-level items.
8643 Else, the children of the entry at point are sorted.
8645 Sorting can be alphabetically, numerically, by date/time as given by
8646 a time stamp, by a property, by priority order, or by a custom function.
8648 The command prompts for the sorting type unless it has been given to the
8649 function through the SORTING-TYPE argument, which needs to be a character,
8650 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8651 precise meaning of each character:
8653 n Numerically, by converting the beginning of the entry/item to a number.
8654 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8655 o By order of TODO keywords.
8656 t By date/time, either the first active time stamp in the entry, or, if
8657 none exist, by the first inactive one.
8658 s By the scheduled date/time.
8659 d By deadline date/time.
8660 c By creation time, which is assumed to be the first inactive time stamp
8661 at the beginning of a line.
8662 p By priority according to the cookie.
8663 r By the value of a property.
8665 Capital letters will reverse the sort order.
8667 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8668 called with point at the beginning of the record. It must return either
8669 a string or a number that should serve as the sorting key for that record.
8671 Comparing entries ignores case by default. However, with an optional argument
8672 WITH-CASE, the sorting considers case as well.
8674 Sorting is done against the visible part of the headlines, it ignores hidden
8675 links.
8677 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8678 (interactive "P")
8679 (let ((case-func (if with-case 'identity 'downcase))
8680 (cmstr
8681 ;; The clock marker is lost when using `sort-subr', let's
8682 ;; store the clocking string.
8683 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8684 (save-excursion
8685 (goto-char org-clock-marker)
8686 (looking-back "^.*") (match-string-no-properties 0))))
8687 start beg end stars re re2
8688 txt what tmp)
8689 ;; Find beginning and end of region to sort
8690 (cond
8691 ((org-region-active-p)
8692 ;; we will sort the region
8693 (setq end (region-end)
8694 what "region")
8695 (goto-char (region-beginning))
8696 (if (not (org-at-heading-p)) (outline-next-heading))
8697 (setq start (point)))
8698 ((or (org-at-heading-p)
8699 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8700 ;; we will sort the children of the current headline
8701 (org-back-to-heading)
8702 (setq start (point)
8703 end (progn (org-end-of-subtree t t)
8704 (or (bolp) (insert "\n"))
8705 (org-back-over-empty-lines)
8706 (point))
8707 what "children")
8708 (goto-char start)
8709 (show-subtree)
8710 (outline-next-heading))
8712 ;; we will sort the top-level entries in this file
8713 (goto-char (point-min))
8714 (or (org-at-heading-p) (outline-next-heading))
8715 (setq start (point))
8716 (goto-char (point-max))
8717 (beginning-of-line 1)
8718 (when (looking-at ".*?\\S-")
8719 ;; File ends in a non-white line
8720 (end-of-line 1)
8721 (insert "\n"))
8722 (setq end (point-max))
8723 (setq what "top-level")
8724 (goto-char start)
8725 (show-all)))
8727 (setq beg (point))
8728 (if (>= beg end) (user-error "Nothing to sort"))
8730 (looking-at "\\(\\*+\\)")
8731 (setq stars (match-string 1)
8732 re (concat "^" (regexp-quote stars) " +")
8733 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8734 txt (buffer-substring beg end))
8735 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8736 (if (and (not (equal stars "*")) (string-match re2 txt))
8737 (user-error "Region to sort contains a level above the first entry"))
8739 (unless sorting-type
8740 (message
8741 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8742 [t]ime [s]cheduled [d]eadline [c]reated
8743 A/N/P/R/O/F/T/S/D/C means reversed:"
8744 what)
8745 (setq sorting-type (read-char-exclusive))
8747 (unless getkey-func
8748 (and (= (downcase sorting-type) ?f)
8749 (setq getkey-func
8750 (org-icompleting-read "Sort using function: "
8751 obarray 'fboundp t nil nil))
8752 (setq getkey-func (intern getkey-func))))
8754 (and (= (downcase sorting-type) ?r)
8755 (not property)
8756 (setq property
8757 (org-icompleting-read "Property: "
8758 (mapcar 'list (org-buffer-property-keys t))
8759 nil t))))
8761 (message "Sorting entries...")
8763 (save-restriction
8764 (narrow-to-region start end)
8765 (let ((dcst (downcase sorting-type))
8766 (case-fold-search nil)
8767 (now (current-time)))
8768 (sort-subr
8769 (/= dcst sorting-type)
8770 ;; This function moves to the beginning character of the "record" to
8771 ;; be sorted.
8772 (lambda nil
8773 (if (re-search-forward re nil t)
8774 (goto-char (match-beginning 0))
8775 (goto-char (point-max))))
8776 ;; This function moves to the last character of the "record" being
8777 ;; sorted.
8778 (lambda nil
8779 (save-match-data
8780 (condition-case nil
8781 (outline-forward-same-level 1)
8782 (error
8783 (goto-char (point-max))))))
8784 ;; This function returns the value that gets sorted against.
8785 (lambda nil
8786 (cond
8787 ((= dcst ?n)
8788 (if (looking-at org-complex-heading-regexp)
8789 (string-to-number (org-sort-remove-invisible (match-string 4)))
8790 nil))
8791 ((= dcst ?a)
8792 (if (looking-at org-complex-heading-regexp)
8793 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8794 nil))
8795 ((= dcst ?t)
8796 (let ((end (save-excursion (outline-next-heading) (point))))
8797 (if (or (re-search-forward org-ts-regexp end t)
8798 (re-search-forward org-ts-regexp-both end t))
8799 (org-time-string-to-seconds (match-string 0))
8800 (org-float-time now))))
8801 ((= dcst ?c)
8802 (let ((end (save-excursion (outline-next-heading) (point))))
8803 (if (re-search-forward
8804 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8805 end t)
8806 (org-time-string-to-seconds (match-string 0))
8807 (org-float-time now))))
8808 ((= dcst ?s)
8809 (let ((end (save-excursion (outline-next-heading) (point))))
8810 (if (re-search-forward org-scheduled-time-regexp end t)
8811 (org-time-string-to-seconds (match-string 1))
8812 (org-float-time now))))
8813 ((= dcst ?d)
8814 (let ((end (save-excursion (outline-next-heading) (point))))
8815 (if (re-search-forward org-deadline-time-regexp end t)
8816 (org-time-string-to-seconds (match-string 1))
8817 (org-float-time now))))
8818 ((= dcst ?p)
8819 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8820 (string-to-char (match-string 2))
8821 org-default-priority))
8822 ((= dcst ?r)
8823 (or (org-entry-get nil property) ""))
8824 ((= dcst ?o)
8825 (if (looking-at org-complex-heading-regexp)
8826 (- 9999 (length (member (match-string 2)
8827 org-todo-keywords-1)))))
8828 ((= dcst ?f)
8829 (if getkey-func
8830 (progn
8831 (setq tmp (funcall getkey-func))
8832 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8833 tmp)
8834 (error "Invalid key function `%s'" getkey-func)))
8835 (t (error "Invalid sorting type `%c'" sorting-type))))
8837 (cond
8838 ((= dcst ?a) 'string<)
8839 ((= dcst ?f) compare-func)
8840 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8841 (run-hooks 'org-after-sorting-entries-or-items-hook)
8842 ;; Reset the clock marker if needed
8843 (when cmstr
8844 (save-excursion
8845 (goto-char start)
8846 (search-forward cmstr nil t)
8847 (move-marker org-clock-marker (point))))
8848 (message "Sorting entries...done")))
8850 (defun org-do-sort (table what &optional with-case sorting-type)
8851 "Sort TABLE of WHAT according to SORTING-TYPE.
8852 The user will be prompted for the SORTING-TYPE if the call to this
8853 function does not specify it. WHAT is only for the prompt, to indicate
8854 what is being sorted. The sorting key will be extracted from
8855 the car of the elements of the table.
8856 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8857 (unless sorting-type
8858 (message
8859 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8860 what)
8861 (setq sorting-type (read-char-exclusive)))
8862 (let ((dcst (downcase sorting-type))
8863 extractfun comparefun)
8864 ;; Define the appropriate functions
8865 (cond
8866 ((= dcst ?n)
8867 (setq extractfun 'string-to-number
8868 comparefun (if (= dcst sorting-type) '< '>)))
8869 ((= dcst ?a)
8870 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8871 (lambda(x) (downcase (org-sort-remove-invisible x))))
8872 comparefun (if (= dcst sorting-type)
8873 'string<
8874 (lambda (a b) (and (not (string< a b))
8875 (not (string= a b)))))))
8876 ((= dcst ?t)
8877 (setq extractfun
8878 (lambda (x)
8879 (if (or (string-match org-ts-regexp x)
8880 (string-match org-ts-regexp-both x))
8881 (org-float-time
8882 (org-time-string-to-time (match-string 0 x)))
8884 comparefun (if (= dcst sorting-type) '< '>)))
8885 (t (error "Invalid sorting type `%c'" sorting-type)))
8887 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8888 table)
8889 (lambda (a b) (funcall comparefun (car a) (car b))))))
8892 ;;; The orgstruct minor mode
8894 ;; Define a minor mode which can be used in other modes in order to
8895 ;; integrate the org-mode structure editing commands.
8897 ;; This is really a hack, because the org-mode structure commands use
8898 ;; keys which normally belong to the major mode. Here is how it
8899 ;; works: The minor mode defines all the keys necessary to operate the
8900 ;; structure commands, but wraps the commands into a function which
8901 ;; tests if the cursor is currently at a headline or a plain list
8902 ;; item. If that is the case, the structure command is used,
8903 ;; temporarily setting many Org-mode variables like regular
8904 ;; expressions for filling etc. However, when any of those keys is
8905 ;; used at a different location, function uses `key-binding' to look
8906 ;; up if the key has an associated command in another currently active
8907 ;; keymap (minor modes, major mode, global), and executes that
8908 ;; command. There might be problems if any of the keys is otherwise
8909 ;; used as a prefix key.
8911 (defcustom orgstruct-heading-prefix-regexp ""
8912 "Regexp that matches the custom prefix of Org headlines in
8913 orgstruct(++)-mode."
8914 :group 'org
8915 :version "24.4"
8916 :package-version '(Org . "8.3")
8917 :type 'regexp)
8918 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8920 (defcustom orgstruct-setup-hook nil
8921 "Hook run after orgstruct-mode-map is filled."
8922 :group 'org
8923 :version "24.4"
8924 :package-version '(Org . "8.0")
8925 :type 'hook)
8927 (defvar orgstruct-initialized nil)
8929 (defvar org-local-vars nil
8930 "List of local variables, for use by `orgstruct-mode'.")
8932 ;;;###autoload
8933 (define-minor-mode orgstruct-mode
8934 "Toggle the minor mode `orgstruct-mode'.
8935 This mode is for using Org-mode structure commands in other
8936 modes. The following keys behave as if Org-mode were active, if
8937 the cursor is on a headline, or on a plain list item (both as
8938 defined by Org-mode)."
8939 nil " OrgStruct" (make-sparse-keymap)
8940 (funcall (if orgstruct-mode
8941 'add-to-invisibility-spec
8942 'remove-from-invisibility-spec)
8943 '(outline . t))
8944 (when orgstruct-mode
8945 (org-load-modules-maybe)
8946 (unless orgstruct-initialized
8947 (orgstruct-setup)
8948 (setq orgstruct-initialized t))))
8950 ;;;###autoload
8951 (defun turn-on-orgstruct ()
8952 "Unconditionally turn on `orgstruct-mode'."
8953 (orgstruct-mode 1))
8955 (defvar org-fb-vars nil)
8956 (make-variable-buffer-local 'org-fb-vars)
8957 (defun orgstruct++-mode (&optional arg)
8958 "Toggle `orgstruct-mode', the enhanced version of it.
8959 In addition to setting orgstruct-mode, this also exports all
8960 indentation and autofilling variables from org-mode into the
8961 buffer. It will also recognize item context in multiline items."
8962 (interactive "P")
8963 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8964 (if (< arg 1)
8965 (progn (orgstruct-mode -1)
8966 (mapc (lambda(v)
8967 (org-set-local (car v)
8968 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8969 org-fb-vars))
8970 (orgstruct-mode 1)
8971 (setq org-fb-vars nil)
8972 (unless org-local-vars
8973 (setq org-local-vars (org-get-local-variables)))
8974 (let (var val)
8975 (mapc
8976 (lambda (x)
8977 (when (string-match
8978 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8979 (symbol-name (car x)))
8980 (setq var (car x) val (nth 1 x))
8981 (push (list var `(quote ,(eval var))) org-fb-vars)
8982 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8983 org-local-vars)
8984 (org-set-local 'orgstruct-is-++ t))))
8986 (defvar orgstruct-is-++ nil
8987 "Is `orgstruct-mode' in ++ version in the current-buffer?")
8988 (make-variable-buffer-local 'orgstruct-is-++)
8990 ;;;###autoload
8991 (defun turn-on-orgstruct++ ()
8992 "Unconditionally turn on `orgstruct++-mode'."
8993 (orgstruct++-mode 1))
8995 (defun orgstruct-error ()
8996 "Error when there is no default binding for a structure key."
8997 (interactive)
8998 (funcall (if (fboundp 'user-error)
8999 'user-error
9000 'error)
9001 "This key has no function outside structure elements"))
9003 (defun orgstruct-setup ()
9004 "Setup orgstruct keymap."
9005 (dolist (cell '((org-demote . t)
9006 (org-metaleft . t)
9007 (org-metaright . t)
9008 (org-promote . t)
9009 (org-shiftmetaleft . t)
9010 (org-shiftmetaright . t)
9011 org-backward-element
9012 org-backward-heading-same-level
9013 org-ctrl-c-ret
9014 org-ctrl-c-minus
9015 org-ctrl-c-star
9016 org-cycle
9017 org-forward-heading-same-level
9018 org-insert-heading
9019 org-insert-heading-respect-content
9020 org-kill-note-or-show-branches
9021 org-mark-subtree
9022 org-meta-return
9023 org-metadown
9024 org-metaup
9025 org-narrow-to-subtree
9026 org-promote-subtree
9027 org-reveal
9028 org-shiftdown
9029 org-shiftleft
9030 org-shiftmetadown
9031 org-shiftmetaup
9032 org-shiftright
9033 org-shifttab
9034 org-shifttab
9035 org-shiftup
9036 org-show-subtree
9037 org-sort
9038 org-up-element
9039 outline-demote
9040 outline-next-visible-heading
9041 outline-previous-visible-heading
9042 outline-promote
9043 outline-up-heading
9044 show-children))
9045 (let ((f (or (car-safe cell) cell))
9046 (disable-when-heading-prefix (cdr-safe cell)))
9047 (when (fboundp f)
9048 (let ((new-bindings))
9049 (dolist (binding (nconc (where-is-internal f org-mode-map)
9050 (where-is-internal f outline-mode-map)))
9051 (push binding new-bindings)
9052 ;; TODO use local-function-key-map
9053 (dolist (rep '(("<tab>" . "TAB")
9054 ("<return>" . "RET")
9055 ("<escape>" . "ESC")
9056 ("<delete>" . "DEL")))
9057 (setq binding (read-kbd-macro
9058 (let ((case-fold-search))
9059 (replace-regexp-in-string
9060 (regexp-quote (cdr rep))
9061 (car rep)
9062 (key-description binding)))))
9063 (pushnew binding new-bindings :test 'equal)))
9064 (dolist (binding new-bindings)
9065 (let ((key (lookup-key orgstruct-mode-map binding)))
9066 (when (or (not key) (numberp key))
9067 (condition-case nil
9068 (org-defkey orgstruct-mode-map
9069 binding
9070 (orgstruct-make-binding f binding disable-when-heading-prefix))
9071 (error nil)))))))))
9072 (run-hooks 'orgstruct-setup-hook))
9074 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9075 "Create a function for binding in the structure minor mode.
9076 FUN is the command to call inside a table. KEY is the key that
9077 should be checked in for a command to execute outside of tables.
9078 Non-nil `disable-when-heading-prefix' means to disable the command
9079 if `orgstruct-heading-prefix-regexp' is not empty."
9080 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9081 (let ((nname name)
9082 (i 0))
9083 (while (fboundp (intern nname))
9084 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9085 (setq name (intern nname)))
9086 (eval
9087 (let ((bindings '((org-heading-regexp
9088 (concat "^"
9089 orgstruct-heading-prefix-regexp
9090 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9091 (org-outline-regexp
9092 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9093 (org-outline-regexp-bol
9094 (concat "^" org-outline-regexp))
9095 (outline-regexp org-outline-regexp)
9096 (outline-heading-end-regexp "\n")
9097 (outline-level 'org-outline-level)
9098 (outline-heading-alist))))
9099 `(defun ,name (arg)
9100 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9101 "Outside of structure, run the binding of `"
9102 (key-description key) "'."
9103 (when disable-when-heading-prefix
9104 (concat
9105 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9106 "back to the default binding due to limitations of Org's implementation of\n"
9107 "`" (symbol-name fun) "'.")))
9108 (interactive "p")
9109 (let* ((disable
9110 ,(and disable-when-heading-prefix
9111 '(not (string= orgstruct-heading-prefix-regexp ""))))
9112 (fallback
9113 (or disable
9114 (not
9115 (let* ,bindings
9116 (org-context-p 'headline 'item
9117 ,(when (memq fun
9118 '(org-insert-heading
9119 org-insert-heading-respect-content
9120 org-meta-return))
9121 '(when orgstruct-is-++
9122 'item-body))))))))
9123 (if fallback
9124 (let* ((orgstruct-mode)
9125 (binding
9126 (loop with key = ,key
9127 for rep in
9128 '(nil
9129 ("<\\([^>]*\\)tab>" . "\\1TAB")
9130 ("<\\([^>]*\\)return>" . "\\1RET")
9131 ("<\\([^>]*\\)escape>" . "\\1ESC")
9132 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9134 (when rep
9135 (setq key (read-kbd-macro
9136 (let ((case-fold-search))
9137 (replace-regexp-in-string
9138 (car rep)
9139 (cdr rep)
9140 (key-description key))))))
9141 thereis (key-binding key))))
9142 (if (keymapp binding)
9143 (org-set-transient-map binding)
9144 (let ((func (or binding
9145 (unless disable
9146 'orgstruct-error))))
9147 (when func
9148 (call-interactively func)))))
9149 (org-run-like-in-org-mode
9150 (lambda ()
9151 (interactive)
9152 (let* ,bindings
9153 (call-interactively ',fun)))))))))
9154 name))
9156 (defun org-contextualize-keys (alist contexts)
9157 "Return valid elements in ALIST depending on CONTEXTS.
9159 `org-agenda-custom-commands' or `org-capture-templates' are the
9160 values used for ALIST, and `org-agenda-custom-commands-contexts'
9161 or `org-capture-templates-contexts' are the associated contexts
9162 definitions."
9163 (let ((contexts
9164 ;; normalize contexts
9165 (mapcar
9166 (lambda(c) (cond ((listp (cadr c))
9167 (list (car c) (car c) (cadr c)))
9168 ((string= "" (cadr c))
9169 (list (car c) (car c) (caddr c)))
9170 (t c))) contexts))
9171 (a alist) c r s)
9172 ;; loop over all commands or templates
9173 (while (setq c (pop a))
9174 (let (vrules repl)
9175 (cond
9176 ((not (assoc (car c) contexts))
9177 (push c r))
9178 ((and (assoc (car c) contexts)
9179 (setq vrules (org-contextualize-validate-key
9180 (car c) contexts)))
9181 (mapc (lambda (vr)
9182 (when (not (equal (car vr) (cadr vr)))
9183 (setq repl vr))) vrules)
9184 (if (not repl) (push c r)
9185 (push (cadr repl) s)
9186 (push
9187 (cons (car c)
9188 (cdr (or (assoc (cadr repl) alist)
9189 (error "Undefined key `%s' as contextual replacement for `%s'"
9190 (cadr repl) (car c)))))
9191 r))))))
9192 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9193 (delq
9195 (delete-dups
9196 (mapcar (lambda (x)
9197 (let ((tpl (car x)))
9198 (when (not (delq
9200 (mapcar (lambda(y)
9201 (equal y tpl)) s))) x)))
9202 (reverse r))))))
9204 (defun org-contextualize-validate-key (key contexts)
9205 "Check CONTEXTS for agenda or capture KEY."
9206 (let (r rr res)
9207 (while (setq r (pop contexts))
9208 (mapc
9209 (lambda (rr)
9210 (when
9211 (and (equal key (car r))
9212 (if (functionp rr) (funcall rr)
9213 (or (and (eq (car rr) 'in-file)
9214 (buffer-file-name)
9215 (string-match (cdr rr) (buffer-file-name)))
9216 (and (eq (car rr) 'in-mode)
9217 (string-match (cdr rr) (symbol-name major-mode)))
9218 (and (eq (car rr) 'in-buffer)
9219 (string-match (cdr rr) (buffer-name)))
9220 (when (and (eq (car rr) 'not-in-file)
9221 (buffer-file-name))
9222 (not (string-match (cdr rr) (buffer-file-name))))
9223 (when (eq (car rr) 'not-in-mode)
9224 (not (string-match (cdr rr) (symbol-name major-mode))))
9225 (when (eq (car rr) 'not-in-buffer)
9226 (not (string-match (cdr rr) (buffer-name)))))))
9227 (push r res)))
9228 (car (last r))))
9229 (delete-dups (delq nil res))))
9231 (defun org-context-p (&rest contexts)
9232 "Check if local context is any of CONTEXTS.
9233 Possible values in the list of contexts are `table', `headline', and `item'."
9234 (let ((pos (point)))
9235 (goto-char (point-at-bol))
9236 (prog1 (or (and (memq 'table contexts)
9237 (looking-at "[ \t]*|"))
9238 (and (memq 'headline contexts)
9239 (looking-at org-outline-regexp))
9240 (and (memq 'item contexts)
9241 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9242 (and (memq 'item-body contexts)
9243 (org-in-item-p)))
9244 (goto-char pos))))
9246 (defun org-get-local-variables ()
9247 "Return a list of all local variables in an Org mode buffer."
9248 (let (varlist)
9249 (with-current-buffer (get-buffer-create "*Org tmp*")
9250 (erase-buffer)
9251 (org-mode)
9252 (setq varlist (buffer-local-variables)))
9253 (kill-buffer "*Org tmp*")
9254 (delq nil
9255 (mapcar
9256 (lambda (x)
9257 (setq x
9258 (if (symbolp x)
9259 (list x)
9260 (list (car x) (cdr x))))
9261 (if (and (not (get (car x) 'org-state))
9262 (string-match
9263 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9264 (symbol-name (car x))))
9265 x nil))
9266 varlist))))
9268 (defun org-clone-local-variables (from-buffer &optional regexp)
9269 "Clone local variables from FROM-BUFFER.
9270 Optional argument REGEXP selects variables to clone."
9271 (mapc
9272 (lambda (pair)
9273 (and (symbolp (car pair))
9274 (or (null regexp)
9275 (string-match regexp (symbol-name (car pair))))
9276 (set (make-local-variable (car pair))
9277 (cdr pair))))
9278 (buffer-local-variables from-buffer)))
9280 ;;;###autoload
9281 (defun org-run-like-in-org-mode (cmd)
9282 "Run a command, pretending that the current buffer is in Org-mode.
9283 This will temporarily bind local variables that are typically bound in
9284 Org-mode to the values they have in Org-mode, and then interactively
9285 call CMD."
9286 (org-load-modules-maybe)
9287 (unless org-local-vars
9288 (setq org-local-vars (org-get-local-variables)))
9289 (let (binds)
9290 (dolist (var org-local-vars)
9291 (when (or (not (boundp (car var)))
9292 (eq (symbol-value (car var))
9293 (default-value (car var))))
9294 (push (list (car var) `(quote ,(cadr var))) binds)))
9295 (eval `(let ,binds
9296 (call-interactively (quote ,cmd))))))
9298 ;;;; Archiving
9300 (defun org-get-category (&optional pos force-refresh)
9301 "Get the category applying to position POS."
9302 (save-match-data
9303 (if force-refresh (org-refresh-category-properties))
9304 (let ((pos (or pos (point))))
9305 (or (get-text-property pos 'org-category)
9306 (progn (org-refresh-category-properties)
9307 (get-text-property pos 'org-category))))))
9309 (defun org-refresh-category-properties ()
9310 "Refresh category text properties in the buffer."
9311 (let ((case-fold-search t)
9312 (inhibit-read-only t)
9313 (def-cat (cond
9314 ((null org-category)
9315 (if buffer-file-name
9316 (file-name-sans-extension
9317 (file-name-nondirectory buffer-file-name))
9318 "???"))
9319 ((symbolp org-category) (symbol-name org-category))
9320 (t org-category)))
9321 beg end cat pos optionp)
9322 (org-with-silent-modifications
9323 (save-excursion
9324 (save-restriction
9325 (widen)
9326 (goto-char (point-min))
9327 (put-text-property (point) (point-max) 'org-category def-cat)
9328 (while (re-search-forward
9329 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9330 (setq pos (match-end 0)
9331 optionp (equal (char-after (match-beginning 0)) ?#)
9332 cat (org-trim (match-string 2)))
9333 (if optionp
9334 (setq beg (point-at-bol) end (point-max))
9335 (org-back-to-heading t)
9336 (setq beg (point) end (org-end-of-subtree t t)))
9337 (put-text-property beg end 'org-category cat)
9338 (put-text-property beg end 'org-category-position beg)
9339 (goto-char pos)))))))
9341 (defun org-refresh-properties (dprop tprop)
9342 "Refresh buffer text properties.
9343 DPROP is the drawer property and TPROP is the corresponding text
9344 property to set."
9345 (let ((case-fold-search t)
9346 (inhibit-read-only t) p)
9347 (org-with-silent-modifications
9348 (save-excursion
9349 (save-restriction
9350 (widen)
9351 (goto-char (point-min))
9352 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9353 (setq p (org-match-string-no-properties 1))
9354 (save-excursion
9355 (org-back-to-heading t)
9356 (put-text-property
9357 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9360 ;;;; Link Stuff
9362 ;;; Link abbreviations
9364 (defun org-link-expand-abbrev (link)
9365 "Apply replacements as defined in `org-link-abbrev-alist'."
9366 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9367 (let* ((key (match-string 1 link))
9368 (as (or (assoc key org-link-abbrev-alist-local)
9369 (assoc key org-link-abbrev-alist)))
9370 (tag (and (match-end 2) (match-string 3 link)))
9371 rpl)
9372 (if (not as)
9373 link
9374 (setq rpl (cdr as))
9375 (cond
9376 ((symbolp rpl) (funcall rpl tag))
9377 ((string-match "%(\\([^)]+\\))" rpl)
9378 (replace-match
9379 (save-match-data
9380 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9381 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9382 ((string-match "%h" rpl)
9383 (replace-match (url-hexify-string (or tag "")) t t rpl))
9384 (t (concat rpl tag)))))
9385 link))
9387 ;;; Storing and inserting links
9389 (defvar org-insert-link-history nil
9390 "Minibuffer history for links inserted with `org-insert-link'.")
9392 (defvar org-stored-links nil
9393 "Contains the links stored with `org-store-link'.")
9395 (defvar org-store-link-plist nil
9396 "Plist with info about the most recently link created with `org-store-link'.")
9398 (defvar org-link-protocols nil
9399 "Link protocols added to Org-mode using `org-add-link-type'.")
9401 (defvar org-store-link-functions nil
9402 "List of functions that are called to create and store a link.
9403 Each function will be called in turn until one returns a non-nil
9404 value. Each function should check if it is responsible for creating
9405 this link (for example by looking at the major mode).
9406 If not, it must exit and return nil.
9407 If yes, it should return a non-nil value after a calling
9408 `org-store-link-props' with a list of properties and values.
9409 Special properties are:
9411 :type The link prefix, like \"http\". This must be given.
9412 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9413 This is obligatory as well.
9414 :description Optional default description for the second pair
9415 of brackets in an Org-mode link. The user can still change
9416 this when inserting this link into an Org-mode buffer.
9418 In addition to these, any additional properties can be specified
9419 and then used in capture templates.")
9421 (defun org-add-link-type (type &optional follow export)
9422 "Add TYPE to the list of `org-link-types'.
9423 Re-compute all regular expressions depending on `org-link-types'
9425 FOLLOW and EXPORT are two functions.
9427 FOLLOW should take the link path as the single argument and do whatever
9428 is necessary to follow the link, for example find a file or display
9429 a mail message.
9431 EXPORT should format the link path for export to one of the export formats.
9432 It should be a function accepting three arguments:
9434 path the path of the link, the text after the prefix (like \"http:\")
9435 desc the description of the link, if any, or a description added by
9436 org-export-normalize-links if there is none
9437 format the export format, a symbol like `html' or `latex' or `ascii'..
9439 The function may use the FORMAT information to return different values
9440 depending on the format. The return value will be put literally into
9441 the exported file. If the return value is nil, this means Org should
9442 do what it normally does with links which do not have EXPORT defined.
9444 Org-mode has a built-in default for exporting links. If you are happy with
9445 this default, there is no need to define an export function for the link
9446 type. For a simple example of an export function, see `org-bbdb.el'."
9447 (add-to-list 'org-link-types type t)
9448 (org-make-link-regexps)
9449 (if (assoc type org-link-protocols)
9450 (setcdr (assoc type org-link-protocols) (list follow export))
9451 (push (list type follow export) org-link-protocols)))
9453 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9454 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9456 ;;;###autoload
9457 (defun org-store-link (arg)
9458 "\\<org-mode-map>Store an org-link to the current location.
9459 This link is added to `org-stored-links' and can later be inserted
9460 into an org-buffer with \\[org-insert-link].
9462 For some link types, a prefix arg is interpreted.
9463 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9464 For file links, arg negates `org-context-in-file-links'.
9466 A double prefix arg force skipping storing functions that are not
9467 part of Org's core.
9469 A triple prefix arg force storing a link for each line in the
9470 active region."
9471 (interactive "P")
9472 (org-load-modules-maybe)
9473 (if (and (equal arg '(64)) (org-region-active-p))
9474 (save-excursion
9475 (let ((end (region-end)))
9476 (goto-char (region-beginning))
9477 (set-mark (point))
9478 (while (< (point-at-eol) end)
9479 (move-end-of-line 1) (activate-mark)
9480 (let (current-prefix-arg)
9481 (call-interactively 'org-store-link))
9482 (move-beginning-of-line 2)
9483 (set-mark (point)))))
9484 (org-with-limited-levels
9485 (setq org-store-link-plist nil)
9486 (let (link cpltxt desc description search
9487 txt custom-id agenda-link sfuns sfunsn)
9488 (cond
9490 ;; Store a link using an external link type
9491 ((and (not (equal arg '(16)))
9492 (setq sfuns
9493 (delq
9494 nil (mapcar (lambda (f)
9495 (let (fs) (if (funcall f) (push f fs))))
9496 org-store-link-functions))
9497 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9498 (or (and (cdr sfuns)
9499 (funcall (intern
9500 (completing-read
9501 "Which function for creating the link? "
9502 sfunsn t (car sfunsn)))))
9503 (funcall (caar sfuns)))
9504 (setq link (plist-get org-store-link-plist :link)
9505 desc (or (plist-get org-store-link-plist
9506 :description) link))))
9508 ;; Store a link from a source code buffer
9509 ((org-src-edit-buffer-p)
9510 (let (label gc)
9511 (while (or (not label)
9512 (save-excursion
9513 (save-restriction
9514 (widen)
9515 (goto-char (point-min))
9516 (re-search-forward
9517 (regexp-quote (format org-coderef-label-format label))
9518 nil t))))
9519 (when label (message "Label exists already") (sit-for 2))
9520 (setq label (read-string "Code line label: " label)))
9521 (end-of-line 1)
9522 (setq link (format org-coderef-label-format label))
9523 (setq gc (- 79 (length link)))
9524 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9525 (insert link)
9526 (setq link (concat "(" label ")") desc nil)))
9528 ;; We are in the agenda, link to referenced location
9529 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9530 (let ((m (or (get-text-property (point) 'org-hd-marker)
9531 (get-text-property (point) 'org-marker))))
9532 (when m
9533 (org-with-point-at m
9534 (setq agenda-link
9535 (if (org-called-interactively-p 'any)
9536 (call-interactively 'org-store-link)
9537 (org-store-link nil)))))))
9539 ((eq major-mode 'calendar-mode)
9540 (let ((cd (calendar-cursor-to-date)))
9541 (setq link
9542 (format-time-string
9543 (car org-time-stamp-formats)
9544 (apply 'encode-time
9545 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9546 nil nil nil))))
9547 (org-store-link-props :type "calendar" :date cd)))
9549 ((eq major-mode 'help-mode)
9550 (setq link (concat "help:" (save-excursion
9551 (goto-char (point-min))
9552 (looking-at "^[^ ]+")
9553 (match-string 0))))
9554 (org-store-link-props :type "help"))
9556 ((eq major-mode 'w3-mode)
9557 (setq cpltxt (if (and (buffer-name)
9558 (not (string-match "Untitled" (buffer-name))))
9559 (buffer-name)
9560 (url-view-url t))
9561 link (url-view-url t))
9562 (org-store-link-props :type "w3" :url (url-view-url t)))
9564 ((eq major-mode 'image-mode)
9565 (setq cpltxt (concat "file:"
9566 (abbreviate-file-name buffer-file-name))
9567 link cpltxt)
9568 (org-store-link-props :type "image" :file buffer-file-name))
9570 ;; In dired, store a link to the file of the current line
9571 ((eq major-mode 'dired-mode)
9572 (let ((file (dired-get-filename nil t)))
9573 (setq file (if file
9574 (abbreviate-file-name
9575 (expand-file-name (dired-get-filename nil t)))
9576 ;; otherwise, no file so use current directory.
9577 default-directory))
9578 (setq cpltxt (concat "file:" file)
9579 link cpltxt)))
9581 ((setq search (run-hook-with-args-until-success
9582 'org-create-file-search-functions))
9583 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9584 "::" search))
9585 (setq cpltxt (or description link)))
9587 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9588 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9589 (cond
9590 ;; Store a link using the target at point
9591 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9592 (setq cpltxt
9593 (concat "file:"
9594 (abbreviate-file-name
9595 (buffer-file-name (buffer-base-buffer)))
9596 "::" (match-string 1))
9597 link cpltxt))
9598 ((and (featurep 'org-id)
9599 (or (eq org-id-link-to-org-use-id t)
9600 (and (org-called-interactively-p 'any)
9601 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9602 (and (eq org-id-link-to-org-use-id
9603 'create-if-interactive-and-no-custom-id)
9604 (not custom-id))))
9605 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9606 ;; Store a link using the ID at point
9607 (setq link (condition-case nil
9608 (prog1 (org-id-store-link)
9609 (setq desc (plist-get org-store-link-plist
9610 :description)))
9611 (error
9612 ;; Probably before first headline, link only to file
9613 (concat "file:"
9614 (abbreviate-file-name
9615 (buffer-file-name (buffer-base-buffer))))))))
9617 ;; Just link to current headline
9618 (setq cpltxt (concat "file:"
9619 (abbreviate-file-name
9620 (buffer-file-name (buffer-base-buffer)))))
9621 ;; Add a context search string
9622 (when (org-xor org-context-in-file-links arg)
9623 (let* ((ee (org-element-at-point))
9624 (et (org-element-type ee))
9625 (ev (plist-get (cadr ee) :value))
9626 (ek (plist-get (cadr ee) :key))
9627 (eok (and (stringp ek) (string-match "name" ek))))
9628 (setq txt (cond
9629 ((org-at-heading-p) nil)
9630 ((and (eq et 'keyword) eok) ev)
9631 ((org-region-active-p)
9632 (buffer-substring (region-beginning) (region-end)))))
9633 (when (or (null txt) (string-match "\\S-" txt))
9634 (setq cpltxt
9635 (concat cpltxt "::"
9636 (condition-case nil
9637 (org-make-org-heading-search-string txt)
9638 (error "")))
9639 desc (or (and (eq et 'keyword) eok ev)
9640 (nth 4 (ignore-errors (org-heading-components)))
9641 "NONE")))))
9642 (if (string-match "::\\'" cpltxt)
9643 (setq cpltxt (substring cpltxt 0 -2)))
9644 (setq link cpltxt))))
9646 ((buffer-file-name (buffer-base-buffer))
9647 ;; Just link to this file here.
9648 (setq cpltxt (concat "file:"
9649 (abbreviate-file-name
9650 (buffer-file-name (buffer-base-buffer)))))
9651 ;; Add a context string.
9652 (when (org-xor org-context-in-file-links arg)
9653 (setq txt (if (org-region-active-p)
9654 (buffer-substring (region-beginning) (region-end))
9655 (buffer-substring (point-at-bol) (point-at-eol))))
9656 ;; Only use search option if there is some text.
9657 (when (string-match "\\S-" txt)
9658 (setq cpltxt
9659 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9660 desc "NONE")))
9661 (setq link cpltxt))
9663 ((org-called-interactively-p 'interactive)
9664 (user-error "No method for storing a link from this buffer"))
9666 (t (setq link nil)))
9668 ;; We're done setting link and desc, clean up
9669 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9670 (setq link (or link cpltxt)
9671 desc (or desc cpltxt))
9672 (cond ((equal desc "NONE") (setq desc nil))
9673 ((string-match org-bracket-link-analytic-regexp desc)
9674 (let ((d0 (match-string 3 desc))
9675 (p0 (match-string 5 desc)))
9676 (setq desc
9677 (replace-regexp-in-string
9678 org-bracket-link-regexp
9679 (concat (or p0 d0)
9680 (if (equal (length (match-string 0 desc))
9681 (length desc)) "*" "")) desc)))))
9683 ;; Return the link
9684 (if (not (and (or (org-called-interactively-p 'any)
9685 executing-kbd-macro) link))
9686 (or agenda-link (and link (org-make-link-string link desc)))
9687 (push (list link desc) org-stored-links)
9688 (message "Stored: %s" (or desc link))
9689 (when custom-id
9690 (setq link (concat "file:" (abbreviate-file-name
9691 (buffer-file-name)) "::#" custom-id))
9692 (push (list link desc) org-stored-links))
9693 (car 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 (arg &optional pre post)
9933 "Insert all links in `org-stored-links'.
9934 When a universal prefix, do not delete the links from `org-stored-links'.
9935 When `ARG' is a number, insert the last N link(s).
9936 `PRE' and `POST' are optional arguments to define a string to
9937 prepend or to append."
9938 (interactive "P")
9939 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
9940 (links (copy-seq org-stored-links))
9941 (pr (or pre "- "))
9942 (po (or post "\n"))
9943 (cnt 1) l)
9944 (if (null org-stored-links)
9945 (message "No link to insert")
9946 (while (and (or (listp arg) (>= arg cnt))
9947 (setq l (if (listp arg)
9948 (pop links)
9949 (pop org-stored-links))))
9950 (setq cnt (1+ cnt))
9951 (insert pr)
9952 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9953 (insert po)))))
9955 (defun org-insert-last-stored-link (arg)
9956 "Insert the last link stored in `org-stored-links'."
9957 (interactive "p")
9958 (org-insert-all-links arg "" "\n"))
9960 (defun org-link-fontify-links-to-this-file ()
9961 "Fontify links to the current file in `org-stored-links'."
9962 (let ((f (buffer-file-name)) a b)
9963 (setq a (mapcar (lambda(l)
9964 (let ((ll (car l)))
9965 (when (and (string-match "^file:\\(.+\\)::" ll)
9966 (equal f (expand-file-name (match-string 1 ll))))
9967 ll)))
9968 org-stored-links))
9969 (when (featurep 'org-id)
9970 (setq b (mapcar (lambda(l)
9971 (let ((ll (car l)))
9972 (when (and (string-match "^id:\\(.+\\)$" ll)
9973 (equal f (expand-file-name
9974 (or (org-id-find-id-file
9975 (match-string 1 ll)) ""))))
9976 ll)))
9977 org-stored-links)))
9978 (mapcar (lambda(l)
9979 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
9980 (delq nil (append a b)))))
9982 (defvar org-link-links-in-this-file nil)
9983 (defun org-insert-link (&optional complete-file link-location default-description)
9984 "Insert a link. At the prompt, enter the link.
9986 Completion can be used to insert any of the link protocol prefixes like
9987 http or ftp in use.
9989 The history can be used to select a link previously stored with
9990 `org-store-link'. When the empty string is entered (i.e. if you just
9991 press RET at the prompt), the link defaults to the most recently
9992 stored link. As SPC triggers completion in the minibuffer, you need to
9993 use M-SPC or C-q SPC to force the insertion of a space character.
9995 You will also be prompted for a description, and if one is given, it will
9996 be displayed in the buffer instead of the link.
9998 If there is already a link at point, this command will allow you to edit link
9999 and description parts.
10001 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10002 be selected using completion. The path to the file will be relative to the
10003 current directory if the file is in the current directory or a subdirectory.
10004 Otherwise, the link will be the absolute path as completed in the minibuffer
10005 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10006 option `org-link-file-path-type'.
10008 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10009 the current directory or below.
10011 With three \\[universal-argument] prefixes, negate the meaning of
10012 `org-keep-stored-link-after-insertion'.
10014 If `org-make-link-description-function' is non-nil, this function will be
10015 called with the link target, and the result will be the default
10016 link description.
10018 If the LINK-LOCATION parameter is non-nil, this value will be
10019 used as the link location instead of reading one interactively.
10021 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10022 be used as the default description."
10023 (interactive "P")
10024 (let* ((wcf (current-window-configuration))
10025 (origbuf (current-buffer))
10026 (region (if (org-region-active-p)
10027 (buffer-substring (region-beginning) (region-end))))
10028 (remove (and region (list (region-beginning) (region-end))))
10029 (desc region)
10030 tmphist ; byte-compile incorrectly complains about this
10031 (link link-location)
10032 (abbrevs org-link-abbrev-alist-local)
10033 entry file all-prefixes auto-desc)
10034 (cond
10035 (link-location) ; specified by arg, just use it.
10036 ((org-in-regexp org-bracket-link-regexp 1)
10037 ;; We do have a link at point, and we are going to edit it.
10038 (setq remove (list (match-beginning 0) (match-end 0)))
10039 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10040 (setq link (read-string "Link: "
10041 (org-link-unescape
10042 (org-match-string-no-properties 1)))))
10043 ((or (org-in-regexp org-angle-link-re)
10044 (org-in-regexp org-plain-link-re))
10045 ;; Convert to bracket link
10046 (setq remove (list (match-beginning 0) (match-end 0))
10047 link (read-string "Link: "
10048 (org-remove-angle-brackets (match-string 0)))))
10049 ((member complete-file '((4) (16)))
10050 ;; Completing read for file names.
10051 (setq link (org-file-complete-link complete-file)))
10053 ;; Read link, with completion for stored links.
10054 (org-link-fontify-links-to-this-file)
10055 (org-switch-to-buffer-other-window "*Org Links*")
10056 (with-current-buffer "*Org Links*"
10057 (erase-buffer)
10058 (insert "Insert a link.
10059 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10060 (when org-stored-links
10061 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10062 (insert (mapconcat 'org-link-prettify
10063 (reverse org-stored-links) "\n")))
10064 (goto-char (point-min)))
10065 (let ((cw (selected-window)))
10066 (select-window (get-buffer-window "*Org Links*" 'visible))
10067 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10068 (unless (pos-visible-in-window-p (point-max))
10069 (org-fit-window-to-buffer))
10070 (and (window-live-p cw) (select-window cw)))
10071 ;; Fake a link history, containing the stored links.
10072 (setq tmphist (append (mapcar 'car org-stored-links)
10073 org-insert-link-history))
10074 (setq all-prefixes (append (mapcar 'car abbrevs)
10075 (mapcar 'car org-link-abbrev-alist)
10076 org-link-types))
10077 (unwind-protect
10078 (progn
10079 (setq link
10080 (org-completing-read
10081 "Link: "
10082 (append
10083 (mapcar (lambda (x) (concat x ":"))
10084 all-prefixes)
10085 (mapcar 'car org-stored-links))
10086 nil nil nil
10087 'tmphist
10088 (caar org-stored-links)))
10089 (if (not (string-match "\\S-" link))
10090 (user-error "No link selected"))
10091 (mapc (lambda(l)
10092 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10093 org-stored-links)
10094 (if (or (member link all-prefixes)
10095 (and (equal ":" (substring link -1))
10096 (member (substring link 0 -1) all-prefixes)
10097 (setq link (substring link 0 -1))))
10098 (setq link (with-current-buffer origbuf
10099 (org-link-try-special-completion link)))))
10100 (set-window-configuration wcf)
10101 (kill-buffer "*Org Links*"))
10102 (setq entry (assoc link org-stored-links))
10103 (or entry (push link org-insert-link-history))
10104 (setq desc (or desc (nth 1 entry)))))
10106 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10107 (not org-keep-stored-link-after-insertion))
10108 (setq org-stored-links (delq (assoc link org-stored-links)
10109 org-stored-links)))
10111 (if (and (string-match org-plain-link-re link)
10112 (not (string-match org-ts-regexp link)))
10113 ;; URL-like link, normalize the use of angular brackets.
10114 (setq link (org-remove-angle-brackets link)))
10116 ;; Check if we are linking to the current file with a search
10117 ;; option If yes, simplify the link by using only the search
10118 ;; option.
10119 (when (and buffer-file-name
10120 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10121 (let* ((path (match-string 1 link))
10122 (case-fold-search nil)
10123 (search (match-string 2 link)))
10124 (save-match-data
10125 (if (equal (file-truename buffer-file-name) (file-truename path))
10126 ;; We are linking to this same file, with a search option
10127 (setq link search)))))
10129 ;; Check if we can/should use a relative path. If yes, simplify the link
10130 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10131 (let* ((type (match-string 1 link))
10132 (path (match-string 2 link))
10133 (origpath path)
10134 (case-fold-search nil))
10135 (cond
10136 ((or (eq org-link-file-path-type 'absolute)
10137 (equal complete-file '(16)))
10138 (setq path (abbreviate-file-name (expand-file-name path))))
10139 ((eq org-link-file-path-type 'noabbrev)
10140 (setq path (expand-file-name path)))
10141 ((eq org-link-file-path-type 'relative)
10142 (setq path (file-relative-name path)))
10144 (save-match-data
10145 (if (string-match (concat "^" (regexp-quote
10146 (expand-file-name
10147 (file-name-as-directory
10148 default-directory))))
10149 (expand-file-name path))
10150 ;; We are linking a file with relative path name.
10151 (setq path (substring (expand-file-name path)
10152 (match-end 0)))
10153 (setq path (abbreviate-file-name (expand-file-name path)))))))
10154 (setq link (concat type path))
10155 (if (equal desc origpath)
10156 (setq desc path))))
10158 (if org-make-link-description-function
10159 (setq desc
10160 (or (condition-case nil
10161 (funcall org-make-link-description-function link desc)
10162 (error (progn (message "Can't get link description from `%s'"
10163 (symbol-name org-make-link-description-function))
10164 (sit-for 2) nil)))
10165 (read-string "Description: " default-description)))
10166 (if default-description (setq desc default-description)
10167 (setq desc (or (and auto-desc desc)
10168 (read-string "Description: " desc)))))
10170 (unless (string-match "\\S-" desc) (setq desc nil))
10171 (if remove (apply 'delete-region remove))
10172 (insert (org-make-link-string link desc))))
10174 (defun org-link-try-special-completion (type)
10175 "If there is completion support for link type TYPE, offer it."
10176 (let ((fun (intern (concat "org-" type "-complete-link"))))
10177 (if (functionp fun)
10178 (funcall fun)
10179 (read-string "Link (no completion support): " (concat type ":")))))
10181 (defun org-file-complete-link (&optional arg)
10182 "Create a file link using completion."
10183 (let (file link)
10184 (setq file (org-iread-file-name "File: "))
10185 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10186 (pwd1 (file-name-as-directory (abbreviate-file-name
10187 (expand-file-name ".")))))
10188 (cond
10189 ((equal arg '(16))
10190 (setq link (concat
10191 "file:"
10192 (abbreviate-file-name (expand-file-name file)))))
10193 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10194 (setq link (concat "file:" (match-string 1 file))))
10195 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10196 (expand-file-name file))
10197 (setq link (concat
10198 "file:" (match-string 1 (expand-file-name file)))))
10199 (t (setq link (concat "file:" file)))))
10200 link))
10202 (defun org-iread-file-name (&rest args)
10203 "Read-file-name using `ido-mode' speedup if available.
10204 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10205 See `read-file-name' for a description of parameters."
10206 (org-without-partial-completion
10207 (if (and org-completion-use-ido
10208 (fboundp 'ido-read-file-name)
10209 (boundp 'ido-mode) ido-mode
10210 (listp (second args)))
10211 (let ((ido-enter-matching-directory nil))
10212 (apply 'ido-read-file-name args))
10213 (apply 'read-file-name args))))
10215 (defun org-completing-read (&rest args)
10216 "Completing-read with SPACE being a normal character."
10217 (let ((enable-recursive-minibuffers t)
10218 (minibuffer-local-completion-map
10219 (copy-keymap minibuffer-local-completion-map)))
10220 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10221 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10222 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10223 (apply 'org-icompleting-read args)))
10225 (defun org-completing-read-no-i (&rest args)
10226 (let (org-completion-use-ido org-completion-use-iswitchb)
10227 (apply 'org-completing-read args)))
10229 (defun org-iswitchb-completing-read (prompt choices &rest args)
10230 "Use iswitch as a completing-read replacement to choose from choices.
10231 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10232 from."
10233 (let* ((iswitchb-use-virtual-buffers nil)
10234 (iswitchb-make-buflist-hook
10235 (lambda ()
10236 (setq iswitchb-temp-buflist choices))))
10237 (iswitchb-read-buffer prompt)))
10239 (defun org-icompleting-read (&rest args)
10240 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10241 (org-without-partial-completion
10242 (if (and org-completion-use-ido
10243 (fboundp 'ido-completing-read)
10244 (boundp 'ido-mode) ido-mode
10245 (listp (second args)))
10246 (let ((ido-enter-matching-directory nil))
10247 (apply 'ido-completing-read (concat (car args))
10248 (if (consp (car (nth 1 args)))
10249 (mapcar 'car (nth 1 args))
10250 (nth 1 args))
10251 (cddr args)))
10252 (if (and org-completion-use-iswitchb
10253 (boundp 'iswitchb-mode) iswitchb-mode
10254 (listp (second args)))
10255 (apply 'org-iswitchb-completing-read (concat (car args))
10256 (if (consp (car (nth 1 args)))
10257 (mapcar 'car (nth 1 args))
10258 (nth 1 args))
10259 (cddr args))
10260 (apply 'completing-read args)))))
10262 (defun org-extract-attributes (s)
10263 "Extract the attributes cookie from a string and set as text property."
10264 (let (a attr (start 0) key value)
10265 (save-match-data
10266 (when (string-match "{{\\([^}]+\\)}}$" s)
10267 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10268 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10269 (setq key (match-string 1 a) value (match-string 2 a)
10270 start (match-end 0)
10271 attr (plist-put attr (intern key) value))))
10272 (org-add-props s nil 'org-attr attr))
10275 ;;; Opening/following a link
10277 (defvar org-link-search-failed nil)
10279 (defvar org-open-link-functions nil
10280 "Hook for functions finding a plain text link.
10281 These functions must take a single argument, the link content.
10282 They will be called for links that look like [[link text][description]]
10283 when LINK TEXT does not have a protocol like \"http:\" and does not look
10284 like a filename (e.g. \"./blue.png\").
10286 These functions will be called *before* Org attempts to resolve the
10287 link by doing text searches in the current buffer - so if you want a
10288 link \"[[target]]\" to still find \"<<target>>\", your function should
10289 handle this as a special case.
10291 When the function does handle the link, it must return a non-nil value.
10292 If it decides that it is not responsible for this link, it must return
10293 nil to indicate that that Org-mode can continue with other options
10294 like exact and fuzzy text search.")
10296 (defun org-next-link (&optional search-backward)
10297 "Move forward to the next link.
10298 If the link is in hidden text, expose it."
10299 (interactive "P")
10300 (when (and org-link-search-failed (eq this-command last-command))
10301 (goto-char (point-min))
10302 (message "Link search wrapped back to beginning of buffer"))
10303 (setq org-link-search-failed nil)
10304 (let* ((pos (point))
10305 (ct (org-context))
10306 (a (assoc :link ct))
10307 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10308 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10309 ((looking-at org-any-link-re)
10310 ;; Don't stay stuck at link without an org-link face
10311 (forward-char (if search-backward -1 1))))
10312 (if (funcall srch-fun org-any-link-re nil t)
10313 (progn
10314 (goto-char (match-beginning 0))
10315 (if (outline-invisible-p) (org-show-context)))
10316 (goto-char pos)
10317 (setq org-link-search-failed t)
10318 (message "No further link found"))))
10320 (defun org-previous-link ()
10321 "Move backward to the previous link.
10322 If the link is in hidden text, expose it."
10323 (interactive)
10324 (funcall 'org-next-link t))
10326 (defun org-translate-link (s)
10327 "Translate a link string if a translation function has been defined."
10328 (if (and org-link-translation-function
10329 (fboundp org-link-translation-function)
10330 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10331 (progn
10332 (setq s (funcall org-link-translation-function
10333 (match-string 1 s) (match-string 2 s)))
10334 (concat (car s) ":" (cdr s)))
10337 (defun org-translate-link-from-planner (type path)
10338 "Translate a link from Emacs Planner syntax so that Org can follow it.
10339 This is still an experimental function, your mileage may vary."
10340 (cond
10341 ((member type '("http" "https" "news" "ftp"))
10342 ;; standard Internet links are the same.
10343 nil)
10344 ((and (equal type "irc") (string-match "^//" path))
10345 ;; Planner has two / at the beginning of an irc link, we have 1.
10346 ;; We should have zero, actually....
10347 (setq path (substring path 1)))
10348 ((and (equal type "lisp") (string-match "^/" path))
10349 ;; Planner has a slash, we do not.
10350 (setq type "elisp" path (substring path 1)))
10351 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10352 ;; A typical message link. Planner has the id after the final slash,
10353 ;; we separate it with a hash mark
10354 (setq path (concat (match-string 1 path) "#"
10355 (org-remove-angle-brackets (match-string 2 path))))))
10356 (cons type path))
10358 (defun org-find-file-at-mouse (ev)
10359 "Open file link or URL at mouse."
10360 (interactive "e")
10361 (mouse-set-point ev)
10362 (org-open-at-point 'in-emacs))
10364 (defun org-open-at-mouse (ev)
10365 "Open file link or URL at mouse.
10366 See the docstring of `org-open-file' for details."
10367 (interactive "e")
10368 (mouse-set-point ev)
10369 (if (eq major-mode 'org-agenda-mode)
10370 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10371 (org-open-at-point))
10373 (defvar org-window-config-before-follow-link nil
10374 "The window configuration before following a link.
10375 This is saved in case the need arises to restore it.")
10377 (defvar org-open-link-marker (make-marker)
10378 "Marker pointing to the location where `org-open-at-point; was called.")
10380 ;;;###autoload
10381 (defun org-open-at-point-global ()
10382 "Follow a link like Org-mode does.
10383 This command can be called in any mode to follow a link that has
10384 Org-mode syntax."
10385 (interactive)
10386 (org-run-like-in-org-mode 'org-open-at-point))
10388 ;;;###autoload
10389 (defun org-open-link-from-string (s &optional arg reference-buffer)
10390 "Open a link in the string S, as if it was in Org-mode."
10391 (interactive "sLink: \nP")
10392 (let ((reference-buffer (or reference-buffer (current-buffer))))
10393 (with-temp-buffer
10394 (let ((org-inhibit-startup (not reference-buffer)))
10395 (org-mode)
10396 (insert s)
10397 (goto-char (point-min))
10398 (when reference-buffer
10399 (setq org-link-abbrev-alist-local
10400 (with-current-buffer reference-buffer
10401 org-link-abbrev-alist-local)))
10402 (org-open-at-point arg reference-buffer)))))
10404 (defvar org-open-at-point-functions nil
10405 "Hook that is run when following a link at point.
10407 Functions in this hook must return t if they identify and follow
10408 a link at point. If they don't find anything interesting at point,
10409 they must return nil.")
10411 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10412 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10413 (defun org-open-at-point (&optional arg reference-buffer)
10414 "Open link at or after point.
10415 If there is no link at point, this function will search forward up to
10416 the end of the current line.
10417 Normally, files will be opened by an appropriate application. If the
10418 optional prefix argument ARG is non-nil, Emacs will visit the file.
10419 With a double prefix argument, try to open outside of Emacs, in the
10420 application the system uses for this file type."
10421 (interactive "P")
10422 ;; if in a code block, then open the block's results
10423 (unless (call-interactively #'org-babel-open-src-block-result)
10424 (org-load-modules-maybe)
10425 (move-marker org-open-link-marker (point))
10426 (setq org-window-config-before-follow-link (current-window-configuration))
10427 (org-remove-occur-highlights nil nil t)
10428 (cond
10429 ((and (org-at-heading-p)
10430 (not (org-at-timestamp-p t))
10431 (not (org-in-regexp
10432 (concat org-plain-link-re "\\|"
10433 org-bracket-link-regexp "\\|"
10434 org-angle-link-re "\\|"
10435 "[ \t]:[^ \t\n]+:[ \t]*$")))
10436 (not (get-text-property (point) 'org-linked-text)))
10437 (or (let* ((lkall (org-offer-links-in-entry (current-buffer) (point) arg))
10438 (lk0 (car lkall))
10439 (lk (if (stringp lk0) (list lk0) lk0))
10440 (lkend (cdr lkall)))
10441 (mapcar (lambda(l)
10442 (search-forward l nil lkend)
10443 (goto-char (match-beginning 0))
10444 (org-open-at-point))
10445 lk))
10446 (progn (require 'org-attach) (org-attach-reveal 'if-exists))))
10447 ((run-hook-with-args-until-success 'org-open-at-point-functions))
10448 ((and (org-at-timestamp-p t)
10449 (not (org-in-regexp org-bracket-link-regexp)))
10450 (org-follow-timestamp-link))
10451 ((and (or (org-footnote-at-reference-p) (org-footnote-at-definition-p))
10452 (not (org-in-regexp org-any-link-re)))
10453 (org-footnote-action))
10455 (let (type path link line search (pos (point)))
10456 (catch 'match
10457 (save-excursion
10458 (skip-chars-forward "^]\n\r")
10459 (when (org-in-regexp org-bracket-link-regexp 1)
10460 (setq link (org-extract-attributes
10461 (org-link-unescape (org-match-string-no-properties 1))))
10462 (while (string-match " *\n *" link)
10463 (setq link (replace-match " " t t link)))
10464 (setq link (org-link-expand-abbrev link))
10465 (cond
10466 ((or (file-name-absolute-p link)
10467 (string-match "^\\.\\.?/" link))
10468 (setq type "file" path link))
10469 ((string-match org-link-re-with-space3 link)
10470 (setq type (match-string 1 link) path (match-string 2 link)))
10471 ((string-match "^help:+\\(.+\\)" link)
10472 (setq type "help" path (match-string 1 link)))
10473 (t (setq type "thisfile" path link)))
10474 (throw 'match t)))
10476 (when (get-text-property (point) 'org-linked-text)
10477 (setq type "thisfile"
10478 pos (if (get-text-property (1+ (point)) 'org-linked-text)
10479 (1+ (point)) (point))
10480 path (buffer-substring
10481 (or (previous-single-property-change pos 'org-linked-text)
10482 (point-min))
10483 (or (next-single-property-change pos 'org-linked-text)
10484 (point-max)))
10485 ;; Ensure we will search for a <<<radio>>> link, not
10486 ;; a simple reference like <<ref>>
10487 path (concat "<" path))
10488 (throw 'match t))
10490 (save-excursion
10491 (when (or (org-in-regexp org-angle-link-re)
10492 (let ((match (org-in-regexp org-plain-link-re)))
10493 ;; Check a plain link is not within a bracket link
10494 (and match
10495 (save-excursion
10496 (progn
10497 (goto-char (car match))
10498 (not (org-in-regexp org-bracket-link-regexp))))))
10499 (let ((line_ending (save-excursion (end-of-line) (point))))
10500 ;; We are in a line before a plain or bracket link
10501 (or (re-search-forward org-plain-link-re line_ending t)
10502 (re-search-forward org-bracket-link-regexp line_ending t))))
10503 (setq type (match-string 1)
10504 path (org-link-unescape (match-string 2)))
10505 (throw 'match t)))
10506 (save-excursion
10507 (when (org-in-regexp (org-re "\\(:[[:alnum:]_@#%:]+\\):[ \t]*$"))
10508 (setq type "tags"
10509 path (match-string 1))
10510 (while (string-match ":" path)
10511 (setq path (replace-match "+" t t path)))
10512 (throw 'match t)))
10513 (when (org-in-regexp "<\\([^><\n]+\\)>")
10514 (setq type "tree-match"
10515 path (match-string 1))
10516 (throw 'match t)))
10517 (unless path
10518 (user-error "No link found"))
10520 ;; switch back to reference buffer
10521 ;; needed when if called in a temporary buffer through
10522 ;; org-open-link-from-string
10523 (with-current-buffer (or reference-buffer (current-buffer))
10525 ;; Remove any trailing spaces in path
10526 (if (string-match " +\\'" path)
10527 (setq path (replace-match "" t t path)))
10528 (if (and org-link-translation-function
10529 (fboundp org-link-translation-function))
10530 ;; Check if we need to translate the link
10531 (let ((tmp (funcall org-link-translation-function type path)))
10532 (setq type (car tmp) path (cdr tmp))))
10534 (cond
10536 ((assoc type org-link-protocols)
10537 (funcall (nth 1 (assoc type org-link-protocols)) path))
10539 ((equal type "help")
10540 (let ((f-or-v (intern path)))
10541 (cond ((fboundp f-or-v)
10542 (describe-function f-or-v))
10543 ((boundp f-or-v)
10544 (describe-variable f-or-v))
10545 (t (error "Not a known function or variable")))))
10547 ((equal type "mailto")
10548 (let ((cmd (car org-link-mailto-program))
10549 (args (cdr org-link-mailto-program)) args1
10550 (address path) (subject "") a)
10551 (if (string-match "\\(.*\\)::\\(.*\\)" path)
10552 (setq address (match-string 1 path)
10553 subject (org-link-escape (match-string 2 path))))
10554 (while args
10555 (cond
10556 ((not (stringp (car args))) (push (pop args) args1))
10557 (t (setq a (pop args))
10558 (if (string-match "%a" a)
10559 (setq a (replace-match address t t a)))
10560 (if (string-match "%s" a)
10561 (setq a (replace-match subject t t a)))
10562 (push a args1))))
10563 (apply cmd (nreverse args1))))
10565 ((member type '("http" "https" "ftp" "news"))
10566 ;; In the example of the http Org link
10567 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
10568 ;; to open a browser with +subject:"Release 8.2" in the
10569 ;; query field the variable `path' contains
10570 ;; [...]=%2Bsubject:"Release+8.2", `url-encode-url'
10571 ;; converts correct to [...]=%2Bsubject:%22Release+8.2%22
10572 ;; and `org-link-escape-browser' converts wrong to
10573 ;; [...]=%252Bsubject:%22Release+8.2%22.
10575 ;; `url-encode-url' is available since Emacs 24.3.1 and
10576 ;; `org-link-escape-browser' can be removed altogether
10577 ;; once Org drops support for Emacs 24.1 and 24.2.
10578 (browse-url (funcall (if (fboundp 'url-encode-url)
10579 #'url-encode-url
10580 #'org-link-escape-browser)
10581 (concat type ":" path))))
10583 ((string= type "doi")
10584 ;; See comments for type http above
10585 (browse-url (funcall (if (fboundp 'url-encode-url)
10586 #'url-encode-url
10587 #'org-link-escape-browser)
10588 (concat org-doi-server-url path))))
10590 ((member type '("message"))
10591 (browse-url (concat type ":" path)))
10593 ((string= type "tags")
10594 (org-tags-view arg path))
10596 ((string= type "tree-match")
10597 (org-occur (concat "\\[" (regexp-quote path) "\\]")))
10599 ((string= type "file")
10600 (if (string-match "::\\([0-9]+\\)\\'" path)
10601 (setq line (string-to-number (match-string 1 path))
10602 path (substring path 0 (match-beginning 0)))
10603 (if (string-match "::\\(.+\\)\\'" path)
10604 (setq search (match-string 1 path)
10605 path (substring path 0 (match-beginning 0)))))
10606 (if (string-match "[*?{]" (file-name-nondirectory path))
10607 (dired path)
10608 (org-open-file path arg line search)))
10610 ((string= type "shell")
10611 (let ((buf (generate-new-buffer "*Org Shell Output"))
10612 (cmd path))
10613 (if (or (and (not (string= org-confirm-shell-link-not-regexp ""))
10614 (string-match org-confirm-shell-link-not-regexp cmd))
10615 (not org-confirm-shell-link-function)
10616 (funcall org-confirm-shell-link-function
10617 (format "Execute \"%s\" in shell? "
10618 (org-add-props cmd nil
10619 'face 'org-warning))))
10620 (progn
10621 (message "Executing %s" cmd)
10622 (shell-command cmd buf)
10623 (if (featurep 'midnight)
10624 (setq clean-buffer-list-kill-buffer-names
10625 (cons buf clean-buffer-list-kill-buffer-names))))
10626 (error "Abort"))))
10628 ((string= type "elisp")
10629 (let ((cmd path))
10630 (if (or (and (not (string= org-confirm-elisp-link-not-regexp ""))
10631 (string-match org-confirm-elisp-link-not-regexp cmd))
10632 (not org-confirm-elisp-link-function)
10633 (funcall org-confirm-elisp-link-function
10634 (format "Execute \"%s\" as elisp? "
10635 (org-add-props cmd nil
10636 'face 'org-warning))))
10637 (message "%s => %s" cmd
10638 (if (equal (string-to-char cmd) ?\()
10639 (eval (read cmd))
10640 (call-interactively (read cmd))))
10641 (error "Abort"))))
10643 ((and (string= type "thisfile")
10644 (or (run-hook-with-args-until-success
10645 'org-open-link-functions path)
10646 (and link
10647 (string-match "^id:" link)
10648 (or (featurep 'org-id) (require 'org-id))
10649 (progn
10650 (funcall (nth 1 (assoc "id" org-link-protocols))
10651 (substring path 3))
10652 t)))))
10654 ((string= type "thisfile")
10655 (if arg
10656 (switch-to-buffer-other-window
10657 (org-get-buffer-for-internal-link (current-buffer)))
10658 (org-mark-ring-push))
10659 (let ((cmd `(org-link-search
10660 ,path
10661 ,(cond ((equal arg '(4)) ''occur)
10662 ((equal arg '(16)) ''org-occur))
10663 ,pos)))
10664 (condition-case nil (let ((org-link-search-inhibit-query t))
10665 (eval cmd))
10666 (error (progn (widen) (eval cmd))))))
10668 (t (browse-url-at-point)))))))
10669 (move-marker org-open-link-marker nil)
10670 (run-hook-with-args 'org-follow-link-hook)))
10672 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10673 "Offer links in the current entry and return the selected link.
10674 If there is only one link, return it.
10675 If NTH is an integer, return the NTH link found.
10676 If ZERO is a string, check also this string for a link, and if
10677 there is one, return it."
10678 (with-current-buffer buffer
10679 (save-excursion
10680 (save-restriction
10681 (widen)
10682 (goto-char marker)
10683 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10684 "\\(" org-angle-link-re "\\)\\|"
10685 "\\(" org-plain-link-re "\\)"))
10686 (cnt ?0)
10687 (in-emacs (if (integerp nth) nil nth))
10688 have-zero end links link c)
10689 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10690 (push (match-string 0 zero) links)
10691 (setq cnt (1- cnt) have-zero t))
10692 (save-excursion
10693 (org-back-to-heading t)
10694 (setq end (save-excursion (outline-next-heading) (point)))
10695 (while (re-search-forward re end t)
10696 (push (match-string 0) links))
10697 (setq links (org-uniquify (reverse links))))
10698 (cond
10699 ((null links)
10700 (message "No links"))
10701 ((equal (length links) 1)
10702 (setq link (car links)))
10703 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10704 (setq link (nth (if have-zero nth (1- nth)) links)))
10705 (t ; we have to select a link
10706 (save-excursion
10707 (save-window-excursion
10708 (delete-other-windows)
10709 (with-output-to-temp-buffer "*Select Link*"
10710 (mapc (lambda (l)
10711 (if (not (string-match org-bracket-link-regexp l))
10712 (princ (format "[%c] %s\n" (incf cnt)
10713 (org-remove-angle-brackets l)))
10714 (if (match-end 3)
10715 (princ (format "[%c] %s (%s)\n" (incf cnt)
10716 (match-string 3 l) (match-string 1 l)))
10717 (princ (format "[%c] %s\n" (incf cnt)
10718 (match-string 1 l))))))
10719 links))
10720 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10721 (message "Select link to open, RET to open all:")
10722 (setq c (read-char-exclusive))
10723 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10724 (when (equal c ?q) (error "Abort"))
10725 (if (equal c ?\C-m)
10726 (setq link links)
10727 (setq nth (- c ?0))
10728 (if have-zero (setq nth (1+ nth)))
10729 (unless (and (integerp nth) (>= (length links) nth))
10730 (user-error "Invalid link selection"))
10731 (setq link (nth (1- nth) links)))))
10732 (cons link end))))))
10734 ;; Add special file links that specify the way of opening
10736 (org-add-link-type "file+sys" 'org-open-file-with-system)
10737 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10738 (defun org-open-file-with-system (path)
10739 "Open file at PATH using the system way of opening it."
10740 (org-open-file path 'system))
10741 (defun org-open-file-with-emacs (path)
10742 "Open file at PATH in Emacs."
10743 (org-open-file path 'emacs))
10746 ;;; File search
10748 (defvar org-create-file-search-functions nil
10749 "List of functions to construct the right search string for a file link.
10750 These functions are called in turn with point at the location to
10751 which the link should point.
10753 A function in the hook should first test if it would like to
10754 handle this file type, for example by checking the `major-mode'
10755 or the file extension. If it decides not to handle this file, it
10756 should just return nil to give other functions a chance. If it
10757 does handle the file, it must return the search string to be used
10758 when following the link. The search string will be part of the
10759 file link, given after a double colon, and `org-open-at-point'
10760 will automatically search for it. If special measures must be
10761 taken to make the search successful, another function should be
10762 added to the companion hook `org-execute-file-search-functions',
10763 which see.
10765 A function in this hook may also use `setq' to set the variable
10766 `description' to provide a suggestion for the descriptive text to
10767 be used for this link when it gets inserted into an Org-mode
10768 buffer with \\[org-insert-link].")
10770 (defvar org-execute-file-search-functions nil
10771 "List of functions to execute a file search triggered by a link.
10773 Functions added to this hook must accept a single argument, the
10774 search string that was part of the file link, the part after the
10775 double colon. The function must first check if it would like to
10776 handle this search, for example by checking the `major-mode' or
10777 the file extension. If it decides not to handle this search, it
10778 should just return nil to give other functions a chance. If it
10779 does handle the search, it must return a non-nil value to keep
10780 other functions from trying.
10782 Each function can access the current prefix argument through the
10783 variable `current-prefix-arg'. Note that a single prefix is used
10784 to force opening a link in Emacs, so it may be good to only use a
10785 numeric or double prefix to guide the search function.
10787 In case this is needed, a function in this hook can also restore
10788 the window configuration before `org-open-at-point' was called using:
10790 (set-window-configuration org-window-config-before-follow-link)")
10792 (defun org-link-search (s &optional type avoid-pos stealth)
10793 "Search for a link search option.
10794 If S is surrounded by forward slashes, it is interpreted as a
10795 regular expression. In org-mode files, this will create an `org-occur'
10796 sparse tree. In ordinary files, `occur' will be used to list matches.
10797 If the current buffer is in `dired-mode', grep will be used to search
10798 in all files. If AVOID-POS is given, ignore matches near that position.
10800 When optional argument STEALTH is non-nil, do not modify
10801 visibility around point, thus ignoring
10802 `org-show-hierarchy-above', `org-show-following-heading' and
10803 `org-show-siblings' variables."
10804 (let ((case-fold-search t)
10805 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10806 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10807 (append '(("") (" ") ("\t") ("\n"))
10808 org-emphasis-alist)
10809 "\\|") "\\)"))
10810 (pos (point))
10811 (pre nil) (post nil)
10812 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10813 (cond
10814 ;; First check if there are any special search functions
10815 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10816 ;; Now try the builtin stuff
10817 ((and (equal (string-to-char s0) ?#)
10818 (> (length s0) 1)
10819 (save-excursion
10820 (goto-char (point-min))
10821 (and
10822 (re-search-forward
10823 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10824 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10825 (setq type 'dedicated
10826 pos (match-beginning 0))))
10827 ;; There is an exact target for this
10828 (goto-char pos)
10829 (org-back-to-heading t)))
10830 ((save-excursion
10831 (goto-char (point-min))
10832 (and
10833 (re-search-forward
10834 (concat "<<" (regexp-quote s0) ">>") nil t)
10835 (setq type 'dedicated
10836 pos (match-beginning 0))))
10837 ;; There is an exact target for this
10838 (goto-char pos))
10839 ((save-excursion
10840 (goto-char (point-min))
10841 (and
10842 (re-search-forward
10843 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10844 (setq type 'dedicated pos (match-beginning 0))))
10845 ;; Found an element with a matching #+name affiliated keyword.
10846 (goto-char pos))
10847 ((and (string-match "^(\\(.*\\))$" s0)
10848 (save-excursion
10849 (goto-char (point-min))
10850 (and
10851 (re-search-forward
10852 (concat "[^[]" (regexp-quote
10853 (format org-coderef-label-format
10854 (match-string 1 s0))))
10855 nil t)
10856 (setq type 'dedicated
10857 pos (1+ (match-beginning 0))))))
10858 ;; There is a coderef target for this
10859 (goto-char pos))
10860 ((string-match "^/\\(.*\\)/$" s)
10861 ;; A regular expression
10862 (cond
10863 ((derived-mode-p 'org-mode)
10864 (org-occur (match-string 1 s)))
10865 (t (org-do-occur (match-string 1 s)))))
10866 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10867 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10868 (goto-char (point-min))
10869 (cond
10870 ((let (case-fold-search)
10871 (re-search-forward (format org-complex-heading-regexp-format
10872 (regexp-quote s))
10873 nil t))
10874 ;; OK, found a match
10875 (setq type 'dedicated)
10876 (goto-char (match-beginning 0)))
10877 ((and (not org-link-search-inhibit-query)
10878 (eq org-link-search-must-match-exact-headline 'query-to-create)
10879 (y-or-n-p "No match - create this as a new heading? "))
10880 (goto-char (point-max))
10881 (or (bolp) (newline))
10882 (insert "* " s "\n")
10883 (beginning-of-line 0))
10885 (goto-char pos)
10886 (error "No match"))))
10888 ;; A normal search string
10889 (when (equal (string-to-char s) ?*)
10890 ;; Anchor on headlines, post may include tags.
10891 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10892 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10893 s (substring s 1)))
10894 (remove-text-properties
10895 0 (length s)
10896 '(face nil mouse-face nil keymap nil fontified nil) s)
10897 ;; Make a series of regular expressions to find a match
10898 (setq words (org-split-string s "[ \n\r\t]+")
10900 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10901 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10902 "\\)" markers)
10903 re2a_ (concat "\\(" (mapconcat 'downcase words
10904 "[ \t\r\n]+") "\\)[ \t\r\n]")
10905 re2a (concat "[ \t\r\n]" re2a_)
10906 re4_ (concat "\\(" (mapconcat 'downcase words
10907 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10908 re4 (concat "[^a-zA-Z_]" re4_)
10910 re1 (concat pre re2 post)
10911 re3 (concat pre (if pre re4_ re4) post)
10912 re5 (concat pre ".*" re4)
10913 re2 (concat pre re2)
10914 re2a (concat pre (if pre re2a_ re2a))
10915 re4 (concat pre (if pre re4_ re4))
10916 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10917 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10918 re5 "\\)"))
10919 (cond
10920 ((eq type 'org-occur) (org-occur reall))
10921 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10922 (t (goto-char (point-min))
10923 (setq type 'fuzzy)
10924 (if (or (and (org-search-not-self 1 re0 nil t)
10925 (setq type 'dedicated))
10926 (org-search-not-self 1 re1 nil t)
10927 (org-search-not-self 1 re2 nil t)
10928 (org-search-not-self 1 re2a nil t)
10929 (org-search-not-self 1 re3 nil t)
10930 (org-search-not-self 1 re4 nil t)
10931 (org-search-not-self 1 re5 nil t))
10932 (goto-char (match-beginning 1))
10933 (goto-char pos)
10934 (error "No match"))))))
10935 (and (derived-mode-p 'org-mode)
10936 (not stealth)
10937 (org-show-context 'link-search))
10938 type))
10940 (defun org-search-not-self (group &rest args)
10941 "Execute `re-search-forward', but only accept matches that do not
10942 enclose the position of `org-open-link-marker'."
10943 (let ((m org-open-link-marker))
10944 (catch 'exit
10945 (while (apply 're-search-forward args)
10946 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10947 (goto-char (match-end group))
10948 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10949 (> (match-beginning 0) (marker-position m))
10950 (< (match-end 0) (marker-position m)))
10951 (save-match-data
10952 (or (not (org-in-regexp
10953 org-bracket-link-analytic-regexp 1))
10954 (not (match-end 4)) ; no description
10955 (and (<= (match-beginning 4) (point))
10956 (>= (match-end 4) (point))))))
10957 (throw 'exit (point))))))))
10959 (defun org-get-buffer-for-internal-link (buffer)
10960 "Return a buffer to be used for displaying the link target of internal links."
10961 (cond
10962 ((not org-display-internal-link-with-indirect-buffer)
10963 buffer)
10964 ((string-match "(Clone)$" (buffer-name buffer))
10965 (message "Buffer is already a clone, not making another one")
10966 ;; we also do not modify visibility in this case
10967 buffer)
10968 (t ; make a new indirect buffer for displaying the link
10969 (let* ((bn (buffer-name buffer))
10970 (ibn (concat bn "(Clone)"))
10971 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10972 (with-current-buffer ib (org-overview))
10973 ib))))
10975 (defun org-do-occur (regexp &optional cleanup)
10976 "Call the Emacs command `occur'.
10977 If CLEANUP is non-nil, remove the printout of the regular expression
10978 in the *Occur* buffer. This is useful if the regex is long and not useful
10979 to read."
10980 (occur regexp)
10981 (when cleanup
10982 (let ((cwin (selected-window)) win beg end)
10983 (when (setq win (get-buffer-window "*Occur*"))
10984 (select-window win))
10985 (goto-char (point-min))
10986 (when (re-search-forward "match[a-z]+" nil t)
10987 (setq beg (match-end 0))
10988 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10989 (setq end (1- (match-beginning 0)))))
10990 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10991 (goto-char (point-min))
10992 (select-window cwin))))
10994 ;;; The mark ring for links jumps
10996 (defvar org-mark-ring nil
10997 "Mark ring for positions before jumps in Org-mode.")
10998 (defvar org-mark-ring-last-goto nil
10999 "Last position in the mark ring used to go back.")
11000 ;; Fill and close the ring
11001 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
11002 (loop for i from 1 to org-mark-ring-length do
11003 (push (make-marker) org-mark-ring))
11004 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
11005 org-mark-ring)
11007 (defun org-mark-ring-push (&optional pos buffer)
11008 "Put the current position or POS into the mark ring and rotate it."
11009 (interactive)
11010 (setq pos (or pos (point)))
11011 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
11012 (move-marker (car org-mark-ring)
11013 (or pos (point))
11014 (or buffer (current-buffer)))
11015 (message "%s"
11016 (substitute-command-keys
11017 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
11019 (defun org-mark-ring-goto (&optional n)
11020 "Jump to the previous position in the mark ring.
11021 With prefix arg N, jump back that many stored positions. When
11022 called several times in succession, walk through the entire ring.
11023 Org-mode commands jumping to a different position in the current file,
11024 or to another Org-mode file, automatically push the old position
11025 onto the ring."
11026 (interactive "p")
11027 (let (p m)
11028 (if (eq last-command this-command)
11029 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11030 (setq p org-mark-ring))
11031 (setq org-mark-ring-last-goto p)
11032 (setq m (car p))
11033 (org-pop-to-buffer-same-window (marker-buffer m))
11034 (goto-char m)
11035 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11037 (defun org-remove-angle-brackets (s)
11038 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11039 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11041 (defun org-add-angle-brackets (s)
11042 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11043 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11045 (defun org-remove-double-quotes (s)
11046 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11047 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11050 ;;; Following specific links
11052 (defun org-follow-timestamp-link ()
11053 "Open an agenda view for the time-stamp date/range at point."
11054 (cond
11055 ((org-at-date-range-p t)
11056 (let ((org-agenda-start-on-weekday)
11057 (t1 (match-string 1))
11058 (t2 (match-string 2)) tt1 tt2)
11059 (setq tt1 (time-to-days (org-time-string-to-time t1))
11060 tt2 (time-to-days (org-time-string-to-time t2)))
11061 (let ((org-agenda-buffer-tmp-name
11062 (format "*Org Agenda(a:%s)"
11063 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11064 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11065 ((org-at-timestamp-p t)
11066 (let ((org-agenda-buffer-tmp-name
11067 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11068 (org-agenda-list nil (time-to-days (org-time-string-to-time
11069 (substring (match-string 1) 0 10)))
11070 1)))
11071 (t (error "This should not happen"))))
11074 ;;; Following file links
11075 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11076 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11077 (declare-function mailcap-mime-info
11078 "mailcap" (string &optional request no-decode))
11079 (defvar org-wait nil)
11080 (defun org-open-file (path &optional in-emacs line search)
11081 "Open the file at PATH.
11082 First, this expands any special file name abbreviations. Then the
11083 configuration variable `org-file-apps' is checked if it contains an
11084 entry for this file type, and if yes, the corresponding command is launched.
11086 If no application is found, Emacs simply visits the file.
11088 With optional prefix argument IN-EMACS, Emacs will visit the file.
11089 With a double \\[universal-argument] \\[universal-argument] \
11090 prefix arg, Org tries to avoid opening in Emacs
11091 and to use an external application to visit the file.
11093 Optional LINE specifies a line to go to, optional SEARCH a string
11094 to search for. If LINE or SEARCH is given, the file will be
11095 opened in Emacs, unless an entry from org-file-apps that makes
11096 use of groups in a regexp matches.
11098 If you want to change the way frames are used when following a
11099 link, please customize `org-link-frame-setup'.
11101 If the file does not exist, an error is thrown."
11102 (let* ((file (if (equal path "")
11103 buffer-file-name
11104 (substitute-in-file-name (expand-file-name path))))
11105 (file-apps (append org-file-apps (org-default-apps)))
11106 (apps (org-remove-if
11107 'org-file-apps-entry-match-against-dlink-p file-apps))
11108 (apps-dlink (org-remove-if-not
11109 'org-file-apps-entry-match-against-dlink-p file-apps))
11110 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11111 (dirp (if remp nil (file-directory-p file)))
11112 (file (if (and dirp org-open-directory-means-index-dot-org)
11113 (concat (file-name-as-directory file) "index.org")
11114 file))
11115 (a-m-a-p (assq 'auto-mode apps))
11116 (dfile (downcase file))
11117 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11118 (link (cond ((and (eq line nil)
11119 (eq search nil))
11120 file)
11121 (line
11122 (concat file "::" (number-to-string line)))
11123 (search
11124 (concat file "::" search))))
11125 (dlink (downcase link))
11126 (old-buffer (current-buffer))
11127 (old-pos (point))
11128 (old-mode major-mode)
11129 ext cmd link-match-data)
11130 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11131 (setq ext (match-string 1 dfile))
11132 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11133 (setq ext (match-string 1 dfile))))
11134 (cond
11135 ((member in-emacs '((16) system))
11136 (setq cmd (cdr (assoc 'system apps))))
11137 (in-emacs (setq cmd 'emacs))
11139 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11140 (and dirp (cdr (assoc 'directory apps)))
11141 ; first, try matching against apps-dlink
11142 ; if we get a match here, store the match data for later
11143 (let ((match (assoc-default dlink apps-dlink
11144 'string-match)))
11145 (if match
11146 (progn (setq link-match-data (match-data))
11147 match)
11148 (progn (setq in-emacs (or in-emacs line search))
11149 nil))) ; if we have no match in apps-dlink,
11150 ; always open the file in emacs if line or search
11151 ; is given (for backwards compatibility)
11152 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11153 'string-match)
11154 (cdr (assoc ext apps))
11155 (cdr (assoc t apps))))))
11156 (when (eq cmd 'system)
11157 (setq cmd (cdr (assoc 'system apps))))
11158 (when (eq cmd 'default)
11159 (setq cmd (cdr (assoc t apps))))
11160 (when (eq cmd 'mailcap)
11161 (require 'mailcap)
11162 (mailcap-parse-mailcaps)
11163 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11164 (command (mailcap-mime-info mime-type)))
11165 (if (stringp command)
11166 (setq cmd command)
11167 (setq cmd 'emacs))))
11168 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11169 (not (file-exists-p file))
11170 (not org-open-non-existing-files))
11171 (user-error "No such file: %s" file))
11172 (cond
11173 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11174 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11175 (while (string-match "['\"]%s['\"]" cmd)
11176 (setq cmd (replace-match "%s" t t cmd)))
11177 (while (string-match "%s" cmd)
11178 (setq cmd (replace-match
11179 (save-match-data
11180 (shell-quote-argument
11181 (convert-standard-filename file)))
11182 t t cmd)))
11184 ;; Replace "%1", "%2" etc. in command with group matches from regex
11185 (save-match-data
11186 (let ((match-index 1)
11187 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11188 (set-match-data link-match-data)
11189 (while (<= match-index number-of-groups)
11190 (let ((regex (concat "%" (number-to-string match-index)))
11191 (replace-with (match-string match-index dlink)))
11192 (while (string-match regex cmd)
11193 (setq cmd (replace-match replace-with t t cmd))))
11194 (setq match-index (+ match-index 1)))))
11196 (save-window-excursion
11197 (message "Running %s...done" cmd)
11198 (start-process-shell-command cmd nil cmd)
11199 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11200 ((or (stringp cmd)
11201 (eq cmd 'emacs))
11202 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11203 (widen)
11204 (if line (progn (org-goto-line line)
11205 (if (derived-mode-p 'org-mode)
11206 (org-reveal)))
11207 (if search (org-link-search search))))
11208 ((consp cmd)
11209 (let ((file (convert-standard-filename file)))
11210 (save-match-data
11211 (set-match-data link-match-data)
11212 (eval cmd))))
11213 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11214 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11215 (or (not (equal old-buffer (current-buffer)))
11216 (not (equal old-pos (point))))
11217 (org-mark-ring-push old-pos old-buffer))))
11219 (defun org-file-apps-entry-match-against-dlink-p (entry)
11220 "This function returns non-nil if `entry' uses a regular
11221 expression which should be matched against the whole link by
11222 org-open-file.
11224 It assumes that is the case when the entry uses a regular
11225 expression which has at least one grouping construct and the
11226 action is either a lisp form or a command string containing
11227 '%1', i.e. using at least one subexpression match as a
11228 parameter."
11229 (let ((selector (car entry))
11230 (action (cdr entry)))
11231 (if (stringp selector)
11232 (and (> (regexp-opt-depth selector) 0)
11233 (or (and (stringp action)
11234 (string-match "%[0-9]" action))
11235 (consp action)))
11236 nil)))
11238 (defun org-default-apps ()
11239 "Return the default applications for this operating system."
11240 (cond
11241 ((eq system-type 'darwin)
11242 org-file-apps-defaults-macosx)
11243 ((eq system-type 'windows-nt)
11244 org-file-apps-defaults-windowsnt)
11245 (t org-file-apps-defaults-gnu)))
11247 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11248 "Convert extensions to regular expressions in the cars of LIST.
11249 Also, weed out any non-string entries, because the return value is used
11250 only for regexp matching.
11251 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11252 point to the symbol `emacs', indicating that the file should
11253 be opened in Emacs."
11254 (append
11255 (delq nil
11256 (mapcar (lambda (x)
11257 (if (not (stringp (car x)))
11259 (if (string-match "\\W" (car x))
11261 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11262 list))
11263 (if add-auto-mode
11264 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11266 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11267 (defun org-file-remote-p (file)
11268 "Test whether FILE specifies a location on a remote system.
11269 Return non-nil if the location is indeed remote.
11271 For example, the filename \"/user@host:/foo\" specifies a location
11272 on the system \"/user@host:\"."
11273 (cond ((fboundp 'file-remote-p)
11274 (file-remote-p file))
11275 ((fboundp 'tramp-handle-file-remote-p)
11276 (tramp-handle-file-remote-p file))
11277 ((and (boundp 'ange-ftp-name-format)
11278 (string-match (car ange-ftp-name-format) file))
11279 t)))
11282 ;;;; Refiling
11284 (defun org-get-org-file ()
11285 "Read a filename, with default directory `org-directory'."
11286 (let ((default (or org-default-notes-file remember-data-file)))
11287 (read-file-name (format "File name [%s]: " default)
11288 (file-name-as-directory org-directory)
11289 default)))
11291 (defun org-notes-order-reversed-p ()
11292 "Check if the current file should receive notes in reversed order."
11293 (cond
11294 ((not org-reverse-note-order) nil)
11295 ((eq t org-reverse-note-order) t)
11296 ((not (listp org-reverse-note-order)) nil)
11297 (t (catch 'exit
11298 (let ((all org-reverse-note-order)
11299 entry)
11300 (while (setq entry (pop all))
11301 (if (string-match (car entry) buffer-file-name)
11302 (throw 'exit (cdr entry))))
11303 nil)))))
11305 (defvar org-refile-target-table nil
11306 "The list of refile targets, created by `org-refile'.")
11308 (defvar org-agenda-new-buffers nil
11309 "Buffers created to visit agenda files.")
11311 (defvar org-refile-cache nil
11312 "Cache for refile targets.")
11314 (defvar org-refile-markers nil
11315 "All the markers used for caching refile locations.")
11317 (defun org-refile-marker (pos)
11318 "Get a new refile marker, but only if caching is in use."
11319 (if (not org-refile-use-cache)
11321 (let ((m (make-marker)))
11322 (move-marker m pos)
11323 (push m org-refile-markers)
11324 m)))
11326 (defun org-refile-cache-clear ()
11327 "Clear the refile cache and disable all the markers."
11328 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11329 (setq org-refile-markers nil)
11330 (setq org-refile-cache nil)
11331 (message "Refile cache has been cleared"))
11333 (defun org-refile-cache-check-set (set)
11334 "Check if all the markers in the cache still have live buffers."
11335 (let (marker)
11336 (catch 'exit
11337 (while (and set (setq marker (nth 3 (pop set))))
11338 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11339 (when (and marker (null (marker-buffer marker)))
11340 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11341 (sit-for 3)
11342 (throw 'exit nil)))
11343 t)))
11345 (defun org-refile-cache-put (set &rest identifiers)
11346 "Push the refile targets SET into the cache, under IDENTIFIERS."
11347 (let* ((key (sha1 (prin1-to-string identifiers)))
11348 (entry (assoc key org-refile-cache)))
11349 (if entry
11350 (setcdr entry set)
11351 (push (cons key set) org-refile-cache))))
11353 (defun org-refile-cache-get (&rest identifiers)
11354 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11355 (cond
11356 ((not org-refile-cache) nil)
11357 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11359 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11360 org-refile-cache))))
11361 (and set (org-refile-cache-check-set set) set)))))
11363 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11364 "Produce a table with refile targets."
11365 (let ((case-fold-search nil)
11366 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11367 (entries (or org-refile-targets '((nil . (:level . 1)))))
11368 targets tgs txt re files f desc descre fast-path-p level pos0)
11369 (message "Getting targets...")
11370 (with-current-buffer (or default-buffer (current-buffer))
11371 (while (setq entry (pop entries))
11372 (setq files (car entry) desc (cdr entry))
11373 (setq fast-path-p nil)
11374 (cond
11375 ((null files) (setq files (list (current-buffer))))
11376 ((eq files 'org-agenda-files)
11377 (setq files (org-agenda-files 'unrestricted)))
11378 ((and (symbolp files) (fboundp files))
11379 (setq files (funcall files)))
11380 ((and (symbolp files) (boundp files))
11381 (setq files (symbol-value files))))
11382 (if (stringp files) (setq files (list files)))
11383 (cond
11384 ((eq (car desc) :tag)
11385 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11386 ((eq (car desc) :todo)
11387 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11388 ((eq (car desc) :regexp)
11389 (setq descre (cdr desc)))
11390 ((eq (car desc) :level)
11391 (setq descre (concat "^\\*\\{" (number-to-string
11392 (if org-odd-levels-only
11393 (1- (* 2 (cdr desc)))
11394 (cdr desc)))
11395 "\\}[ \t]")))
11396 ((eq (car desc) :maxlevel)
11397 (setq fast-path-p t)
11398 (setq descre (concat "^\\*\\{1," (number-to-string
11399 (if org-odd-levels-only
11400 (1- (* 2 (cdr desc)))
11401 (cdr desc)))
11402 "\\}[ \t]")))
11403 (t (error "Bad refiling target description %s" desc)))
11404 (while (setq f (pop files))
11405 (with-current-buffer
11406 (if (bufferp f) f (org-get-agenda-file-buffer f))
11408 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11409 (progn
11410 (if (bufferp f) (setq f (buffer-file-name
11411 (buffer-base-buffer f))))
11412 (setq f (and f (expand-file-name f)))
11413 (if (eq org-refile-use-outline-path 'file)
11414 (push (list (file-name-nondirectory f) f nil nil) tgs))
11415 (save-excursion
11416 (save-restriction
11417 (widen)
11418 (goto-char (point-min))
11419 (while (re-search-forward descre nil t)
11420 (goto-char (setq pos0 (point-at-bol)))
11421 (catch 'next
11422 (when org-refile-target-verify-function
11423 (save-match-data
11424 (or (funcall org-refile-target-verify-function)
11425 (throw 'next t))))
11426 (when (and (looking-at org-complex-heading-regexp)
11427 (not (member (match-string 4) excluded-entries))
11428 (match-string 4))
11429 (setq level (org-reduced-level
11430 (- (match-end 1) (match-beginning 1)))
11431 txt (org-link-display-format (match-string 4))
11432 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11433 re (format org-complex-heading-regexp-format
11434 (regexp-quote (match-string 4))))
11435 (when org-refile-use-outline-path
11436 (setq txt (mapconcat
11437 'org-protect-slash
11438 (append
11439 (if (eq org-refile-use-outline-path
11440 'file)
11441 (list (file-name-nondirectory
11442 (buffer-file-name
11443 (buffer-base-buffer))))
11444 (if (eq org-refile-use-outline-path
11445 'full-file-path)
11446 (list (buffer-file-name
11447 (buffer-base-buffer)))))
11448 (org-get-outline-path fast-path-p
11449 level txt)
11450 (list txt))
11451 "/")))
11452 (push (list txt f re (org-refile-marker (point)))
11453 tgs)))
11454 (when (= (point) pos0)
11455 ;; verification function has not moved point
11456 (goto-char (point-at-eol))))))))
11457 (when org-refile-use-cache
11458 (org-refile-cache-put tgs (buffer-file-name) descre))
11459 (setq targets (append tgs targets))))))
11460 (message "Getting targets...done")
11461 (nreverse targets)))
11463 (defun org-protect-slash (s)
11464 (while (string-match "/" s)
11465 (setq s (replace-match "\\" t t s)))
11468 (defvar org-olpa (make-vector 20 nil))
11470 (defun org-get-outline-path (&optional fastp level heading)
11471 "Return the outline path to the current entry, as a list.
11473 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11474 routine which makes outline path derivations for an entire file,
11475 avoiding backtracing. Refile target collection makes use of that."
11476 (if fastp
11477 (progn
11478 (if (> level 19)
11479 (error "Outline path failure, more than 19 levels"))
11480 (loop for i from level upto 19 do
11481 (aset org-olpa i nil))
11482 (prog1
11483 (delq nil (append org-olpa nil))
11484 (aset org-olpa level heading)))
11485 (let (rtn case-fold-search)
11486 (save-excursion
11487 (save-restriction
11488 (widen)
11489 (while (org-up-heading-safe)
11490 (when (looking-at org-complex-heading-regexp)
11491 (push (org-trim
11492 (replace-regexp-in-string
11493 ;; Remove statistical/checkboxes cookies
11494 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11495 (org-match-string-no-properties 4)))
11496 rtn)))
11497 rtn)))))
11499 (defun org-format-outline-path (path &optional width prefix separator)
11500 "Format the outline path PATH for display.
11501 WIDTH is the maximum number of characters that is available.
11502 PREFIX is a prefix to be included in the returned string,
11503 such as the file name.
11504 SEPARATOR is inserted between the different parts of the path,
11505 the default is \"/\"."
11506 (setq width (or width 79))
11507 (if prefix (setq width (- width (length prefix))))
11508 (if (not path)
11509 (or prefix "")
11510 (let* ((nsteps (length path))
11511 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11512 (maxwidth (if (<= total-width width)
11513 10000 ;; everything fits
11514 ;; we need to shorten the level headings
11515 (/ (- width nsteps) nsteps)))
11516 (org-odd-levels-only nil)
11517 (n 0)
11518 (total (1+ (length prefix))))
11519 (setq maxwidth (max maxwidth 10))
11520 (concat prefix
11521 (if prefix (or separator "/"))
11522 (mapconcat
11523 (lambda (h)
11524 (setq n (1+ n))
11525 (if (and (= n nsteps) (< maxwidth 10000))
11526 (setq maxwidth (- total-width total)))
11527 (if (< (length h) maxwidth)
11528 (progn (setq total (+ total (length h) 1)) h)
11529 (setq h (substring h 0 (- maxwidth 2))
11530 total (+ total maxwidth 1))
11531 (if (string-match "[ \t]+\\'" h)
11532 (setq h (substring h 0 (match-beginning 0))))
11533 (setq h (concat h "..")))
11534 (org-add-props h nil 'face
11535 (nth (% (1- n) org-n-level-faces)
11536 org-level-faces))
11538 path (or separator "/"))))))
11540 (defun org-display-outline-path (&optional file current separator just-return-string)
11541 "Display the current outline path in the echo area.
11543 If FILE is non-nil, prepend the output with the file name.
11544 If CURRENT is non-nil, append the current heading to the output.
11545 SEPARATOR is passed through to `org-format-outline-path'. It separates
11546 the different parts of the path and defaults to \"/\".
11547 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11548 (interactive "P")
11549 (let* (case-fold-search
11550 (bfn (buffer-file-name (buffer-base-buffer)))
11551 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11552 res)
11553 (if current (setq path (append path
11554 (save-excursion
11555 (org-back-to-heading t)
11556 (if (looking-at org-complex-heading-regexp)
11557 (list (match-string 4)))))))
11558 (setq res
11559 (org-format-outline-path
11560 path
11561 (1- (frame-width))
11562 (and file bfn (concat (file-name-nondirectory bfn) separator))
11563 separator))
11564 (if just-return-string
11565 (org-no-properties res)
11566 (org-unlogged-message "%s" res))))
11568 (defvar org-refile-history nil
11569 "History for refiling operations.")
11571 (defvar org-after-refile-insert-hook nil
11572 "Hook run after `org-refile' has inserted its stuff at the new location.
11573 Note that this is still *before* the stuff will be removed from
11574 the *old* location.")
11576 (defvar org-capture-last-stored-marker)
11577 (defvar org-refile-keep nil
11578 "Non-nil means `org-refile' will copy instead of refile.")
11580 (defun org-copy ()
11581 "Like `org-refile', but copy."
11582 (interactive)
11583 (let ((org-refile-keep t))
11584 (funcall 'org-refile nil nil nil "Copy")))
11586 (defun org-refile (&optional goto default-buffer rfloc msg)
11587 "Move the entry or entries at point to another heading.
11588 The list of target headings is compiled using the information in
11589 `org-refile-targets', which see.
11591 At the target location, the entry is filed as a subitem of the target
11592 heading. Depending on `org-reverse-note-order', the new subitem will
11593 either be the first or the last subitem.
11595 If there is an active region, all entries in that region will be moved.
11596 However, the region must fulfill the requirement that the first heading
11597 is the first one sets the top-level of the moved text - at most siblings
11598 below it are allowed.
11600 With prefix arg GOTO, the command will only visit the target location
11601 and not actually move anything.
11603 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11604 go to the location where the last refiling operation has put the subtree.
11606 With a numeric prefix argument of `2', refile to the running clock.
11608 With a numeric prefix argument of `3', emulate `org-refile-keep'
11609 being set to `t' and copy to the target location, don't move it.
11610 Beware that keeping refiled entries may result in duplicated ID
11611 properties.
11613 RFLOC can be a refile location obtained in a different way.
11615 MSG is a string to replace \"Refile\" in the default prompt with
11616 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11618 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11620 If you are using target caching (see `org-refile-use-cache'),
11621 you have to clear the target cache in order to find new targets.
11622 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11623 prefix argument (`C-u C-u C-u C-c C-w')."
11625 (interactive "P")
11626 (if (member goto '(0 (64)))
11627 (org-refile-cache-clear)
11628 (let* ((actionmsg (or msg "Refile"))
11629 (cbuf (current-buffer))
11630 (regionp (org-region-active-p))
11631 (region-start (and regionp (region-beginning)))
11632 (region-end (and regionp (region-end)))
11633 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11634 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11635 pos it nbuf file re level reversed)
11636 (setq last-command nil)
11637 (when regionp
11638 (goto-char region-start)
11639 (or (bolp) (goto-char (point-at-bol)))
11640 (setq region-start (point))
11641 (unless (or (org-kill-is-subtree-p
11642 (buffer-substring region-start region-end))
11643 (prog1 org-refile-active-region-within-subtree
11644 (let ((s (point-at-eol)))
11645 (org-toggle-heading)
11646 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11647 (user-error "The region is not a (sequence of) subtree(s)")))
11648 (if (equal goto '(16))
11649 (org-refile-goto-last-stored)
11650 (when (or
11651 (and (equal goto 2)
11652 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11653 (prog1
11654 (setq it (list (or org-clock-heading "running clock")
11655 (buffer-file-name
11656 (marker-buffer org-clock-hd-marker))
11658 (marker-position org-clock-hd-marker)))
11659 (setq goto nil)))
11660 (setq it (or rfloc
11661 (let (heading-text)
11662 (save-excursion
11663 (unless goto
11664 (org-back-to-heading t)
11665 (setq heading-text
11666 (nth 4 (org-heading-components))))
11668 (org-refile-get-location
11669 (cond (goto "Goto")
11670 (regionp (concat actionmsg " region to"))
11671 (t (concat actionmsg " subtree \""
11672 heading-text "\" to")))
11673 default-buffer
11674 (and (not (equal '(4) goto))
11675 org-refile-allow-creating-parent-nodes)
11676 goto))))))
11677 (setq file (nth 1 it)
11678 re (nth 2 it)
11679 pos (nth 3 it))
11680 (if (and (not goto)
11682 (equal (buffer-file-name) file)
11683 (if regionp
11684 (and (>= pos region-start)
11685 (<= pos region-end))
11686 (and (>= pos (point))
11687 (< pos (save-excursion
11688 (org-end-of-subtree t t))))))
11689 (error "Cannot refile to position inside the tree or region"))
11691 (setq nbuf (or (find-buffer-visiting file)
11692 (find-file-noselect file)))
11693 (if (and goto (not (equal goto 3)))
11694 (progn
11695 (org-pop-to-buffer-same-window nbuf)
11696 (goto-char pos)
11697 (org-show-context 'org-goto))
11698 (if regionp
11699 (progn
11700 (org-kill-new (buffer-substring region-start region-end))
11701 (org-save-markers-in-region region-start region-end))
11702 (org-copy-subtree 1 nil t))
11703 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11704 (find-file-noselect file)))
11705 (setq reversed (org-notes-order-reversed-p))
11706 (save-excursion
11707 (save-restriction
11708 (widen)
11709 (if pos
11710 (progn
11711 (goto-char pos)
11712 (looking-at org-outline-regexp)
11713 (setq level (org-get-valid-level (funcall outline-level) 1))
11714 (goto-char
11715 (if reversed
11716 (or (outline-next-heading) (point-max))
11717 (or (save-excursion (org-get-next-sibling))
11718 (org-end-of-subtree t t)
11719 (point-max)))))
11720 (setq level 1)
11721 (if (not reversed)
11722 (goto-char (point-max))
11723 (goto-char (point-min))
11724 (or (outline-next-heading) (goto-char (point-max)))))
11725 (if (not (bolp)) (newline))
11726 (org-paste-subtree level)
11727 (when org-log-refile
11728 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11729 (unless (eq org-log-refile 'note)
11730 (save-excursion (org-add-log-note))))
11731 (and org-auto-align-tags
11732 (let ((org-loop-over-headlines-in-active-region nil))
11733 (org-set-tags nil t)))
11734 (let ((bookmark-name (plist-get org-bookmark-names-plist
11735 :last-refile)))
11736 (when bookmark-name
11737 (with-demoted-errors
11738 (bookmark-set bookmark-name))))
11739 ;; If we are refiling for capture, make sure that the
11740 ;; last-capture pointers point here
11741 (when (org-bound-and-true-p org-refile-for-capture)
11742 (let ((bookmark-name (plist-get org-bookmark-names-plist
11743 :last-capture-marker)))
11744 (when bookmark-name
11745 (with-demoted-errors
11746 (bookmark-set bookmark-name))))
11747 (move-marker org-capture-last-stored-marker (point)))
11748 (if (fboundp 'deactivate-mark) (deactivate-mark))
11749 (run-hooks 'org-after-refile-insert-hook))))
11750 (unless org-refile-keep
11751 (if regionp
11752 (delete-region (point) (+ (point) (- region-end region-start)))
11753 (delete-region
11754 (and (org-back-to-heading t) (point))
11755 (min (buffer-size) (org-end-of-subtree t t) (point)))))
11756 (when (featurep 'org-inlinetask)
11757 (org-inlinetask-remove-END-maybe))
11758 (setq org-markers-to-move nil)
11759 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11761 (defun org-refile-goto-last-stored ()
11762 "Go to the location where the last refile was stored."
11763 (interactive)
11764 (bookmark-jump "org-refile-last-stored")
11765 (message "This is the location of the last refile"))
11767 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11768 no-exclude)
11769 "Prompt the user for a refile location, using PROMPT.
11770 PROMPT should not be suffixed with a colon and a space, because
11771 this function appends the default value from
11772 `org-refile-history' automatically, if that is not empty.
11773 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11774 this is used for the GOTO interface."
11775 (let ((org-refile-targets org-refile-targets)
11776 (org-refile-use-outline-path org-refile-use-outline-path)
11777 excluded-entries)
11778 (when (and (derived-mode-p 'org-mode)
11779 (not org-refile-use-cache)
11780 (not no-exclude))
11781 (org-map-tree
11782 (lambda()
11783 (setq excluded-entries
11784 (append excluded-entries (list (org-get-heading t t)))))))
11785 (setq org-refile-target-table
11786 (org-refile-get-targets default-buffer excluded-entries)))
11787 (unless org-refile-target-table
11788 (user-error "No refile targets"))
11789 (let* ((cbuf (current-buffer))
11790 (partial-completion-mode nil)
11791 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11792 (cfunc (if (and org-refile-use-outline-path
11793 org-outline-path-complete-in-steps)
11794 'org-olpath-completing-read
11795 'org-icompleting-read))
11796 (extra (if org-refile-use-outline-path "/" ""))
11797 (cbnex (concat (buffer-name) extra))
11798 (filename (and cfn (expand-file-name cfn)))
11799 (tbl (mapcar
11800 (lambda (x)
11801 (if (and (not (member org-refile-use-outline-path
11802 '(file full-file-path)))
11803 (not (equal filename (nth 1 x))))
11804 (cons (concat (car x) extra " ("
11805 (file-name-nondirectory (nth 1 x)) ")")
11806 (cdr x))
11807 (cons (concat (car x) extra) (cdr x))))
11808 org-refile-target-table))
11809 (completion-ignore-case t)
11810 cdef
11811 (prompt (concat prompt
11812 (or (and (car org-refile-history)
11813 (concat " (default " (car org-refile-history) ")"))
11814 (and (assoc cbnex tbl) (setq cdef cbnex)
11815 (concat " (default " cbnex ")"))) ": "))
11816 pa answ parent-target child parent old-hist)
11817 (setq old-hist org-refile-history)
11818 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11819 nil 'org-refile-history (or cdef (car org-refile-history))))
11820 (setq pa (or (assoc answ tbl) (assoc (concat answ "/") tbl)))
11821 (if pa
11822 (progn
11823 (org-refile-check-position pa)
11824 (when (or (not org-refile-history)
11825 (not (eq old-hist org-refile-history))
11826 (not (equal (car pa) (car org-refile-history))))
11827 (setq org-refile-history
11828 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11829 org-refile-history
11830 (cdr org-refile-history))))
11831 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11832 (pop org-refile-history)))
11834 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11835 (progn
11836 (setq parent (match-string 1 answ)
11837 child (match-string 2 answ))
11838 (setq parent-target (or (assoc parent tbl)
11839 (assoc (concat parent "/") tbl)))
11840 (when (and parent-target
11841 (or (eq new-nodes t)
11842 (and (eq new-nodes 'confirm)
11843 (y-or-n-p (format "Create new node \"%s\"? "
11844 child)))))
11845 (org-refile-new-child parent-target child)))
11846 (user-error "Invalid target location")))))
11848 (declare-function org-string-nw-p "org-macs" (s))
11849 (defun org-refile-check-position (refile-pointer)
11850 "Check if the refile pointer matches the headline to which it points."
11851 (let* ((file (nth 1 refile-pointer))
11852 (re (nth 2 refile-pointer))
11853 (pos (nth 3 refile-pointer))
11854 buffer)
11855 (if (and (not (markerp pos)) (not file))
11856 (if file
11857 (user-error "Please save the buffer to a file before refiling")
11858 (user-error "Please indicate a target file in the refile path"))
11859 (when (org-string-nw-p re)
11860 (setq buffer (if (markerp pos)
11861 (marker-buffer pos)
11862 (or (find-buffer-visiting file)
11863 (find-file-noselect file))))
11864 (with-current-buffer buffer
11865 (save-excursion
11866 (save-restriction
11867 (widen)
11868 (goto-char pos)
11869 (beginning-of-line 1)
11870 (unless (org-looking-at-p re)
11871 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11873 (defun org-refile-new-child (parent-target child)
11874 "Use refile target PARENT-TARGET to add new CHILD below it."
11875 (unless parent-target
11876 (error "Cannot find parent for new node"))
11877 (let ((file (nth 1 parent-target))
11878 (pos (nth 3 parent-target))
11879 level)
11880 (with-current-buffer (or (find-buffer-visiting file)
11881 (find-file-noselect file))
11882 (save-excursion
11883 (save-restriction
11884 (widen)
11885 (if pos
11886 (goto-char pos)
11887 (goto-char (point-max))
11888 (if (not (bolp)) (newline)))
11889 (when (looking-at org-outline-regexp)
11890 (setq level (funcall outline-level))
11891 (org-end-of-subtree t t))
11892 (org-back-over-empty-lines)
11893 (insert "\n" (make-string
11894 (if pos (org-get-valid-level level 1) 1) ?*)
11895 " " child "\n")
11896 (beginning-of-line 0)
11897 (list (concat (car parent-target) "/" child) file "" (point)))))))
11899 (defun org-olpath-completing-read (prompt collection &rest args)
11900 "Read an outline path like a file name."
11901 (let ((thetable collection)
11902 (org-completion-use-ido nil) ; does not work with ido.
11903 (org-completion-use-iswitchb nil)) ; or iswitchb
11904 (apply
11905 'org-icompleting-read prompt
11906 (lambda (string predicate &optional flag)
11907 (let (rtn r f (l (length string)))
11908 (cond
11909 ((eq flag nil)
11910 ;; try completion
11911 (try-completion string thetable))
11912 ((eq flag t)
11913 ;; all-completions
11914 (setq rtn (all-completions string thetable predicate))
11915 (mapcar
11916 (lambda (x)
11917 (setq r (substring x l))
11918 (if (string-match " ([^)]*)$" x)
11919 (setq f (match-string 0 x))
11920 (setq f ""))
11921 (if (string-match "/" r)
11922 (concat string (substring r 0 (match-end 0)) f)
11924 rtn))
11925 ((eq flag 'lambda)
11926 ;; exact match?
11927 (assoc string thetable)))))
11928 args)))
11930 ;;;; Dynamic blocks
11932 (defun org-find-dblock (name)
11933 "Find the first dynamic block with name NAME in the buffer.
11934 If not found, stay at current position and return nil."
11935 (let ((case-fold-search t) pos)
11936 (save-excursion
11937 (goto-char (point-min))
11938 (setq pos (and (re-search-forward
11939 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11940 (match-beginning 0))))
11941 (if pos (goto-char pos))
11942 pos))
11944 (defun org-create-dblock (plist)
11945 "Create a dynamic block section, with parameters taken from PLIST.
11946 PLIST must contain a :name entry which is used as name of the block."
11947 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11948 (end-of-line 1)
11949 (newline))
11950 (let ((col (current-column))
11951 (name (plist-get plist :name)))
11952 (insert "#+BEGIN: " name)
11953 (while plist
11954 (if (eq (car plist) :name)
11955 (setq plist (cddr plist))
11956 (insert " " (prin1-to-string (pop plist)))))
11957 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11958 (beginning-of-line -2)))
11960 (defun org-prepare-dblock ()
11961 "Prepare dynamic block for refresh.
11962 This empties the block, puts the cursor at the insert position and returns
11963 the property list including an extra property :name with the block name."
11964 (unless (looking-at org-dblock-start-re)
11965 (user-error "Not at a dynamic block"))
11966 (let* ((begdel (1+ (match-end 0)))
11967 (name (org-no-properties (match-string 1)))
11968 (params (append (list :name name)
11969 (read (concat "(" (match-string 3) ")")))))
11970 (save-excursion
11971 (beginning-of-line 1)
11972 (skip-chars-forward " \t")
11973 (setq params (plist-put params :indentation-column (current-column))))
11974 (unless (re-search-forward org-dblock-end-re nil t)
11975 (error "Dynamic block not terminated"))
11976 (setq params
11977 (append params
11978 (list :content (buffer-substring
11979 begdel (match-beginning 0)))))
11980 (delete-region begdel (match-beginning 0))
11981 (goto-char begdel)
11982 (open-line 1)
11983 params))
11985 (defun org-map-dblocks (&optional command)
11986 "Apply COMMAND to all dynamic blocks in the current buffer.
11987 If COMMAND is not given, use `org-update-dblock'."
11988 (let ((cmd (or command 'org-update-dblock)))
11989 (save-excursion
11990 (goto-char (point-min))
11991 (while (re-search-forward org-dblock-start-re nil t)
11992 (goto-char (match-beginning 0))
11993 (save-excursion
11994 (condition-case nil
11995 (funcall cmd)
11996 (error (message "Error during update of dynamic block"))))
11997 (unless (re-search-forward org-dblock-end-re nil t)
11998 (error "Dynamic block not terminated"))))))
12000 (defun org-dblock-update (&optional arg)
12001 "User command for updating dynamic blocks.
12002 Update the dynamic block at point. With prefix ARG, update all dynamic
12003 blocks in the buffer."
12004 (interactive "P")
12005 (if arg
12006 (org-update-all-dblocks)
12007 (or (looking-at org-dblock-start-re)
12008 (org-beginning-of-dblock))
12009 (org-update-dblock)))
12011 (defun org-update-dblock ()
12012 "Update the dynamic block at point.
12013 This means to empty the block, parse for parameters and then call
12014 the correct writing function."
12015 (interactive)
12016 (save-window-excursion
12017 (let* ((pos (point))
12018 (line (org-current-line))
12019 (params (org-prepare-dblock))
12020 (name (plist-get params :name))
12021 (indent (plist-get params :indentation-column))
12022 (cmd (intern (concat "org-dblock-write:" name))))
12023 (message "Updating dynamic block `%s' at line %d..." name line)
12024 (funcall cmd params)
12025 (message "Updating dynamic block `%s' at line %d...done" name line)
12026 (goto-char pos)
12027 (when (and indent (> indent 0))
12028 (setq indent (make-string indent ?\ ))
12029 (save-excursion
12030 (org-beginning-of-dblock)
12031 (forward-line 1)
12032 (while (not (looking-at org-dblock-end-re))
12033 (insert indent)
12034 (beginning-of-line 2))
12035 (when (looking-at org-dblock-end-re)
12036 (and (looking-at "[ \t]+")
12037 (replace-match ""))
12038 (insert indent)))))))
12040 (defun org-beginning-of-dblock ()
12041 "Find the beginning of the dynamic block at point.
12042 Error if there is no such block at point."
12043 (let ((pos (point))
12044 beg)
12045 (end-of-line 1)
12046 (if (and (re-search-backward org-dblock-start-re nil t)
12047 (setq beg (match-beginning 0))
12048 (re-search-forward org-dblock-end-re nil t)
12049 (> (match-end 0) pos))
12050 (goto-char beg)
12051 (goto-char pos)
12052 (error "Not in a dynamic block"))))
12054 (defun org-update-all-dblocks ()
12055 "Update all dynamic blocks in the buffer.
12056 This function can be used in a hook."
12057 (interactive)
12058 (when (derived-mode-p 'org-mode)
12059 (org-map-dblocks 'org-update-dblock)))
12062 ;;;; Completion
12064 (declare-function org-export-backend-name "org-export" (cl-x))
12065 (declare-function org-export-backend-options "org-export" (cl-x))
12066 (defun org-get-export-keywords ()
12067 "Return a list of all currently understood export keywords.
12068 Export keywords include options, block names, attributes and
12069 keywords relative to each registered export back-end."
12070 (let (keywords)
12071 (dolist (backend
12072 (org-bound-and-true-p org-export--registered-backends)
12073 (delq nil keywords))
12074 ;; Back-end name (for keywords, like #+LATEX:)
12075 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12076 (dolist (option-entry (org-export-backend-options backend))
12077 ;; Back-end options.
12078 (push (nth 1 option-entry) keywords)))))
12080 (defconst org-options-keywords
12081 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12082 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12083 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12084 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12085 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12087 (defcustom org-structure-template-alist
12088 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
12089 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
12090 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
12091 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
12092 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
12093 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
12094 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
12095 "<literal style=\"latex\">\n?\n</literal>")
12096 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
12097 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
12098 "<literal style=\"html\">\n?\n</literal>")
12099 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
12100 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
12101 ("A" "#+ASCII: " "")
12102 ("i" "#+INDEX: ?" "#+INDEX: ?")
12103 ("I" "#+INCLUDE: %file ?"
12104 "<include file=%file markup=\"?\">"))
12105 "Structure completion elements.
12106 This is a list of abbreviation keys and values. The value gets inserted
12107 if you type `<' followed by the key and then press the completion key,
12108 usually `M-TAB'. %file will be replaced by a file name after prompting
12109 for the file using completion. The cursor will be placed at the position
12110 of the `?` in the template.
12111 There are two templates for each key, the first uses the original Org syntax,
12112 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12113 the default when the /org-mtags.el/ module has been loaded. See also the
12114 variable `org-mtags-prefer-muse-templates'."
12115 :group 'org-completion
12116 :type '(repeat
12117 (list
12118 (string :tag "Key")
12119 (string :tag "Template")
12120 (string :tag "Muse Template"))))
12122 (defun org-try-structure-completion ()
12123 "Try to complete a structure template before point.
12124 This looks for strings like \"<e\" on an otherwise empty line and
12125 expands them."
12126 (let ((l (buffer-substring (point-at-bol) (point)))
12128 (when (and (looking-at "[ \t]*$")
12129 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12130 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12131 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12132 (match-beginning 1)) a)
12133 t)))
12135 (defun org-complete-expand-structure-template (start cell)
12136 "Expand a structure template."
12137 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12138 (rpl (nth (if musep 2 1) cell))
12139 (ind ""))
12140 (delete-region start (point))
12141 (when (string-match "\\`#\\+" rpl)
12142 (cond
12143 ((bolp))
12144 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12145 (setq ind (buffer-substring (point-at-bol) (point))))
12146 (t (newline))))
12147 (setq start (point))
12148 (if (string-match "%file" rpl)
12149 (setq rpl (replace-match
12150 (concat
12151 "\""
12152 (save-match-data
12153 (abbreviate-file-name (read-file-name "Include file: ")))
12154 "\"")
12155 t t rpl)))
12156 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12157 (concat "\n" ind)))
12158 (insert rpl)
12159 (if (re-search-backward "\\?" start t) (delete-char 1))))
12161 ;;;; TODO, DEADLINE, Comments
12163 (defun org-toggle-comment ()
12164 "Change the COMMENT state of an entry."
12165 (interactive)
12166 (save-excursion
12167 (org-back-to-heading)
12168 (let (case-fold-search)
12169 (cond
12170 ((looking-at (format org-heading-keyword-regexp-format
12171 org-comment-string))
12172 (goto-char (match-end 1))
12173 (looking-at (concat " +" org-comment-string))
12174 (replace-match "" t t)
12175 (when (eolp) (insert " ")))
12176 ((looking-at org-outline-regexp)
12177 (goto-char (match-end 0))
12178 (insert org-comment-string " "))))))
12180 (defvar org-last-todo-state-is-todo nil
12181 "This is non-nil when the last TODO state change led to a TODO state.
12182 If the last change removed the TODO tag or switched to DONE, then
12183 this is nil.")
12185 (defvar org-setting-tags nil) ; dynamically skipped
12187 (defvar org-todo-setup-filter-hook nil
12188 "Hook for functions that pre-filter todo specs.
12189 Each function takes a todo spec and returns either nil or the spec
12190 transformed into canonical form." )
12192 (defvar org-todo-get-default-hook nil
12193 "Hook for functions that get a default item for todo.
12194 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12195 nil or a string to be used for the todo mark." )
12197 (defvar org-agenda-headline-snapshot-before-repeat)
12199 (defun org-current-effective-time ()
12200 "Return current time adjusted for `org-extend-today-until' variable."
12201 (let* ((ct (org-current-time))
12202 (dct (decode-time ct))
12203 (ct1
12204 (cond
12205 (org-use-last-clock-out-time-as-effective-time
12206 (or (org-clock-get-last-clock-out-time) ct))
12207 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12208 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12209 (t ct))))
12210 ct1))
12212 (defun org-todo-yesterday (&optional arg)
12213 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12214 (interactive "P")
12215 (if (eq major-mode 'org-agenda-mode)
12216 (apply 'org-agenda-todo-yesterday arg)
12217 (let* ((hour (third (decode-time
12218 (org-current-time))))
12219 (org-extend-today-until (1+ hour)))
12220 (org-todo arg))))
12222 (defvar org-block-entry-blocking ""
12223 "First entry preventing the TODO state change.")
12225 (defun org-cancel-repeater ()
12226 "Cancel a repeater by setting its numeric value to zero."
12227 (interactive)
12228 (save-excursion
12229 (org-back-to-heading t)
12230 (let ((bound1 (point))
12231 (bound0 (save-excursion (outline-next-heading) (point))))
12232 (when (re-search-forward
12233 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12234 org-deadline-time-regexp "\\)\\|\\("
12235 org-ts-regexp "\\)")
12236 bound0 t)
12237 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12238 (replace-match "0" t nil nil 1))))))
12240 (defun org-todo (&optional arg)
12241 "Change the TODO state of an item.
12242 The state of an item is given by a keyword at the start of the heading,
12243 like
12244 *** TODO Write paper
12245 *** DONE Call mom
12247 The different keywords are specified in the variable `org-todo-keywords'.
12248 By default the available states are \"TODO\" and \"DONE\".
12249 So for this example: when the item starts with TODO, it is changed to DONE.
12250 When it starts with DONE, the DONE is removed. And when neither TODO nor
12251 DONE are present, add TODO at the beginning of the heading.
12253 With \\[universal-argument] prefix arg, use completion to determine the new \
12254 state.
12255 With numeric prefix arg, switch to that state.
12256 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12257 keywords (nextset).
12258 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12259 With a numeric prefix arg of 0, inhibit note taking for the change.
12260 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12262 When called through ELisp, arg is also interpreted in the following way:
12263 'none -> empty state
12264 \"\"(empty string) -> switch to empty state
12265 'done -> switch to DONE
12266 'nextset -> switch to the next set of keywords
12267 'previousset -> switch to the previous set of keywords
12268 \"WAITING\" -> switch to the specified keyword, but only if it
12269 really is a member of `org-todo-keywords'."
12270 (interactive "P")
12271 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12272 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12273 'region-start-level 'region))
12274 org-loop-over-headlines-in-active-region)
12275 (org-map-entries
12276 `(org-todo ,arg)
12277 org-loop-over-headlines-in-active-region
12278 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12279 (if (equal arg '(16)) (setq arg 'nextset))
12280 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12281 (let ((org-blocker-hook org-blocker-hook)
12282 commentp
12283 case-fold-search)
12284 (when (equal arg '(64))
12285 (setq arg nil org-blocker-hook nil))
12286 (when (and org-blocker-hook
12287 (or org-inhibit-blocking
12288 (org-entry-get nil "NOBLOCKING")))
12289 (setq org-blocker-hook nil))
12290 (save-excursion
12291 (catch 'exit
12292 (org-back-to-heading t)
12293 (when (looking-at (concat "^\\*+ " org-comment-string))
12294 (org-toggle-comment)
12295 (setq commentp t))
12296 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12297 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12298 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12299 (let* ((match-data (match-data))
12300 (startpos (point-at-bol))
12301 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12302 (org-log-done org-log-done)
12303 (org-log-repeat org-log-repeat)
12304 (org-todo-log-states org-todo-log-states)
12305 (org-inhibit-logging
12306 (if (equal arg 0)
12307 (progn (setq arg nil) 'note) org-inhibit-logging))
12308 (this (match-string 1))
12309 (hl-pos (match-beginning 0))
12310 (head (org-get-todo-sequence-head this))
12311 (ass (assoc head org-todo-kwd-alist))
12312 (interpret (nth 1 ass))
12313 (done-word (nth 3 ass))
12314 (final-done-word (nth 4 ass))
12315 (org-last-state (or this ""))
12316 (completion-ignore-case t)
12317 (member (member this org-todo-keywords-1))
12318 (tail (cdr member))
12319 (org-state (cond
12320 ((and org-todo-key-trigger
12321 (or (and (equal arg '(4))
12322 (eq org-use-fast-todo-selection 'prefix))
12323 (and (not arg) org-use-fast-todo-selection
12324 (not (eq org-use-fast-todo-selection
12325 'prefix)))))
12326 ;; Use fast selection
12327 (org-fast-todo-selection))
12328 ((and (equal arg '(4))
12329 (or (not org-use-fast-todo-selection)
12330 (not org-todo-key-trigger)))
12331 ;; Read a state with completion
12332 (org-icompleting-read
12333 "State: " (mapcar 'list org-todo-keywords-1)
12334 nil t))
12335 ((eq arg 'right)
12336 (if this
12337 (if tail (car tail) nil)
12338 (car org-todo-keywords-1)))
12339 ((eq arg 'left)
12340 (if (equal member org-todo-keywords-1)
12342 (if this
12343 (nth (- (length org-todo-keywords-1)
12344 (length tail) 2)
12345 org-todo-keywords-1)
12346 (org-last org-todo-keywords-1))))
12347 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12348 (setq arg nil))) ; hack to fall back to cycling
12349 (arg
12350 ;; user or caller requests a specific state
12351 (cond
12352 ((equal arg "") nil)
12353 ((eq arg 'none) nil)
12354 ((eq arg 'done) (or done-word (car org-done-keywords)))
12355 ((eq arg 'nextset)
12356 (or (car (cdr (member head org-todo-heads)))
12357 (car org-todo-heads)))
12358 ((eq arg 'previousset)
12359 (let ((org-todo-heads (reverse org-todo-heads)))
12360 (or (car (cdr (member head org-todo-heads)))
12361 (car org-todo-heads))))
12362 ((car (member arg org-todo-keywords-1)))
12363 ((stringp arg)
12364 (user-error "State `%s' not valid in this file" arg))
12365 ((nth (1- (prefix-numeric-value arg))
12366 org-todo-keywords-1))))
12367 ((null member) (or head (car org-todo-keywords-1)))
12368 ((equal this final-done-word) nil) ;; -> make empty
12369 ((null tail) nil) ;; -> first entry
12370 ((memq interpret '(type priority))
12371 (if (eq this-command last-command)
12372 (car tail)
12373 (if (> (length tail) 0)
12374 (or done-word (car org-done-keywords))
12375 nil)))
12377 (car tail))))
12378 (org-state (or
12379 (run-hook-with-args-until-success
12380 'org-todo-get-default-hook org-state org-last-state)
12381 org-state))
12382 (next (if org-state (concat " " org-state " ") " "))
12383 (change-plist (list :type 'todo-state-change :from this :to org-state
12384 :position startpos))
12385 dolog now-done-p)
12386 (when org-blocker-hook
12387 (setq org-last-todo-state-is-todo
12388 (not (member this org-done-keywords)))
12389 (unless (save-excursion
12390 (save-match-data
12391 (org-with-wide-buffer
12392 (run-hook-with-args-until-failure
12393 'org-blocker-hook change-plist))))
12394 (if (org-called-interactively-p 'interactive)
12395 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12396 this org-state org-block-entry-blocking)
12397 ;; fail silently
12398 (message "TODO state change from %s to %s blocked (by \"%s\")"
12399 this org-state org-block-entry-blocking)
12400 (throw 'exit nil))))
12401 (store-match-data match-data)
12402 (replace-match next t t)
12403 (unless (pos-visible-in-window-p hl-pos)
12404 (message "TODO state changed to %s" (org-trim next)))
12405 (unless head
12406 (setq head (org-get-todo-sequence-head org-state)
12407 ass (assoc head org-todo-kwd-alist)
12408 interpret (nth 1 ass)
12409 done-word (nth 3 ass)
12410 final-done-word (nth 4 ass)))
12411 (when (memq arg '(nextset previousset))
12412 (message "Keyword-Set %d/%d: %s"
12413 (- (length org-todo-sets) -1
12414 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12415 (length org-todo-sets)
12416 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12417 (setq org-last-todo-state-is-todo
12418 (not (member org-state org-done-keywords)))
12419 (setq now-done-p (and (member org-state org-done-keywords)
12420 (not (member this org-done-keywords))))
12421 (and logging (org-local-logging logging))
12422 (when (and (or org-todo-log-states org-log-done)
12423 (not (eq org-inhibit-logging t))
12424 (not (memq arg '(nextset previousset))))
12425 ;; we need to look at recording a time and note
12426 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12427 (nth 2 (assoc this org-todo-log-states))))
12428 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12429 (setq dolog 'time))
12430 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12431 (and org-state
12432 (member org-state org-not-done-keywords)
12433 (not (member this org-not-done-keywords))))
12434 ;; This is now a todo state and was not one before
12435 ;; If there was a CLOSED time stamp, get rid of it.
12436 (org-add-planning-info nil nil 'closed))
12437 (when (and now-done-p org-log-done)
12438 ;; It is now done, and it was not done before
12439 (org-add-planning-info 'closed (org-current-effective-time))
12440 (if (and (not dolog) (eq 'note org-log-done))
12441 (org-add-log-setup 'done org-state this 'findpos 'note)))
12442 (when (and org-state dolog)
12443 ;; This is a non-nil state, and we need to log it
12444 (org-add-log-setup 'state org-state this 'findpos dolog)))
12445 ;; Fixup tag positioning
12446 (org-todo-trigger-tag-changes org-state)
12447 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12448 (when org-provide-todo-statistics
12449 (org-update-parent-todo-statistics))
12450 (run-hooks 'org-after-todo-state-change-hook)
12451 (if (and arg (not (member org-state org-done-keywords)))
12452 (setq head (org-get-todo-sequence-head org-state)))
12453 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12454 ;; Do we need to trigger a repeat?
12455 (when now-done-p
12456 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12457 ;; This is for the agenda, take a snapshot of the headline.
12458 (save-match-data
12459 (setq org-agenda-headline-snapshot-before-repeat
12460 (org-get-heading))))
12461 (org-auto-repeat-maybe org-state))
12462 ;; Fixup cursor location if close to the keyword
12463 (if (and (outline-on-heading-p)
12464 (not (bolp))
12465 (save-excursion (beginning-of-line 1)
12466 (looking-at org-todo-line-regexp))
12467 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12468 (progn
12469 (goto-char (or (match-end 2) (match-end 1)))
12470 (and (looking-at " ") (just-one-space))))
12471 (when org-trigger-hook
12472 (save-excursion
12473 (run-hook-with-args 'org-trigger-hook change-plist)))
12474 (when commentp (org-toggle-comment))))))))
12476 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12477 "Block turning an entry into a TODO, using the hierarchy.
12478 This checks whether the current task should be blocked from state
12479 changes. Such blocking occurs when:
12481 1. The task has children which are not all in a completed state.
12483 2. A task has a parent with the property :ORDERED:, and there
12484 are siblings prior to the current task with incomplete
12485 status.
12487 3. The parent of the task is blocked because it has siblings that should
12488 be done first, or is child of a block grandparent TODO entry."
12490 (if (not org-enforce-todo-dependencies)
12491 t ; if locally turned off don't block
12492 (catch 'dont-block
12493 ;; If this is not a todo state change, or if this entry is already DONE,
12494 ;; do not block
12495 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12496 (member (plist-get change-plist :from)
12497 (cons 'done org-done-keywords))
12498 (member (plist-get change-plist :to)
12499 (cons 'todo org-not-done-keywords))
12500 (not (plist-get change-plist :to)))
12501 (throw 'dont-block t))
12502 ;; If this task has children, and any are undone, it's blocked
12503 (save-excursion
12504 (org-back-to-heading t)
12505 (let ((this-level (funcall outline-level)))
12506 (outline-next-heading)
12507 (let ((child-level (funcall outline-level)))
12508 (while (and (not (eobp))
12509 (> child-level this-level))
12510 ;; this todo has children, check whether they are all
12511 ;; completed
12512 (if (and (not (org-entry-is-done-p))
12513 (org-entry-is-todo-p))
12514 (progn (setq org-block-entry-blocking (org-get-heading))
12515 (throw 'dont-block nil)))
12516 (outline-next-heading)
12517 (setq child-level (funcall outline-level))))))
12518 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12519 ;; any previous siblings are undone, it's blocked
12520 (save-excursion
12521 (org-back-to-heading t)
12522 (let* ((pos (point))
12523 (parent-pos (and (org-up-heading-safe) (point))))
12524 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12525 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12526 (forward-line 1)
12527 (re-search-forward org-not-done-heading-regexp pos t))
12528 (setq org-block-entry-blocking (match-string 0))
12529 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12530 ;; Search further up the hierarchy, to see if an ancestor is blocked
12531 (while t
12532 (goto-char parent-pos)
12533 (if (not (looking-at org-not-done-heading-regexp))
12534 (throw 'dont-block t)) ; do not block, parent is not a TODO
12535 (setq pos (point))
12536 (setq parent-pos (and (org-up-heading-safe) (point)))
12537 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12538 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12539 (forward-line 1)
12540 (re-search-forward org-not-done-heading-regexp pos t)
12541 (setq org-block-entry-blocking (org-get-heading)))
12542 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12544 (defcustom org-track-ordered-property-with-tag nil
12545 "Should the ORDERED property also be shown as a tag?
12546 The ORDERED property decides if an entry should require subtasks to be
12547 completed in sequence. Since a property is not very visible, setting
12548 this option means that toggling the ORDERED property with the command
12549 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12550 not relevant for the behavior, but it makes things more visible.
12552 Note that toggling the tag with tags commands will not change the property
12553 and therefore not influence behavior!
12555 This can be t, meaning the tag ORDERED should be used, It can also be a
12556 string to select a different tag for this task."
12557 :group 'org-todo
12558 :type '(choice
12559 (const :tag "No tracking" nil)
12560 (const :tag "Track with ORDERED tag" t)
12561 (string :tag "Use other tag")))
12563 (defun org-toggle-ordered-property ()
12564 "Toggle the ORDERED property of the current entry.
12565 For better visibility, you can track the value of this property with a tag.
12566 See variable `org-track-ordered-property-with-tag'."
12567 (interactive)
12568 (let* ((t1 org-track-ordered-property-with-tag)
12569 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12570 (save-excursion
12571 (org-back-to-heading)
12572 (if (org-entry-get nil "ORDERED")
12573 (progn
12574 (org-delete-property "ORDERED")
12575 (and tag (org-toggle-tag tag 'off))
12576 (message "Subtasks can be completed in arbitrary order"))
12577 (org-entry-put nil "ORDERED" "t")
12578 (and tag (org-toggle-tag tag 'on))
12579 (message "Subtasks must be completed in sequence")))))
12581 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12582 (defun org-block-todo-from-checkboxes (change-plist)
12583 "Block turning an entry into a TODO, using checkboxes.
12584 This checks whether the current task should be blocked from state
12585 changes because there are unchecked boxes in this entry."
12586 (if (not org-enforce-todo-checkbox-dependencies)
12587 t ; if locally turned off don't block
12588 (catch 'dont-block
12589 ;; If this is not a todo state change, or if this entry is already DONE,
12590 ;; do not block
12591 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12592 (member (plist-get change-plist :from)
12593 (cons 'done org-done-keywords))
12594 (member (plist-get change-plist :to)
12595 (cons 'todo org-not-done-keywords))
12596 (not (plist-get change-plist :to)))
12597 (throw 'dont-block t))
12598 ;; If this task has checkboxes that are not checked, it's blocked
12599 (save-excursion
12600 (org-back-to-heading t)
12601 (let ((beg (point)) end)
12602 (outline-next-heading)
12603 (setq end (point))
12604 (goto-char beg)
12605 (if (org-list-search-forward
12606 (concat (org-item-beginning-re)
12607 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12608 "\\[[- ]\\]")
12609 end t)
12610 (progn
12611 (if (boundp 'org-blocked-by-checkboxes)
12612 (setq org-blocked-by-checkboxes t))
12613 (throw 'dont-block nil)))))
12614 t))) ; do not block
12616 (defun org-entry-blocked-p ()
12617 "Is the current entry blocked?"
12618 (org-with-silent-modifications
12619 (if (org-entry-get nil "NOBLOCKING")
12620 nil ;; Never block this entry
12621 (not (run-hook-with-args-until-failure
12622 'org-blocker-hook
12623 (list :type 'todo-state-change
12624 :position (point)
12625 :from 'todo
12626 :to 'done))))))
12628 (defun org-update-statistics-cookies (all)
12629 "Update the statistics cookie, either from TODO or from checkboxes.
12630 This should be called with the cursor in a line with a statistics cookie."
12631 (interactive "P")
12632 (if all
12633 (progn
12634 (org-update-checkbox-count 'all)
12635 (org-map-entries 'org-update-parent-todo-statistics))
12636 (if (not (org-at-heading-p))
12637 (org-update-checkbox-count)
12638 (let ((pos (point-marker))
12639 end l1 l2)
12640 (ignore-errors (org-back-to-heading t))
12641 (if (not (org-at-heading-p))
12642 (org-update-checkbox-count)
12643 (setq l1 (org-outline-level))
12644 (setq end (save-excursion
12645 (outline-next-heading)
12646 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12647 (point)))
12648 (if (and (save-excursion
12649 (re-search-forward
12650 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12651 (not (save-excursion (re-search-forward
12652 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12653 (org-update-checkbox-count)
12654 (if (and l2 (> l2 l1))
12655 (progn
12656 (goto-char end)
12657 (org-update-parent-todo-statistics))
12658 (goto-char pos)
12659 (beginning-of-line 1)
12660 (while (re-search-forward
12661 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12662 (point-at-eol) t)
12663 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12664 (goto-char pos)
12665 (move-marker pos nil)))))
12667 (defvar org-entry-property-inherited-from) ;; defined below
12668 (defun org-update-parent-todo-statistics ()
12669 "Update any statistics cookie in the parent of the current headline.
12670 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12671 the entire subtree and this will travel up the hierarchy and update
12672 statistics everywhere."
12673 (let* ((prop (save-excursion (org-up-heading-safe)
12674 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12675 (recursive (or (not org-hierarchical-todo-statistics)
12676 (and prop (string-match "\\<recursive\\>" prop))))
12677 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12679 (first t)
12680 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12681 level ltoggle l1 new ndel
12682 (cnt-all 0) (cnt-done 0) is-percent kwd
12683 checkbox-beg ov ovs ove cookie-present)
12684 (catch 'exit
12685 (save-excursion
12686 (beginning-of-line 1)
12687 (setq ltoggle (funcall outline-level))
12688 ;; Three situations are to consider:
12690 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12691 ;; to the top-level ancestor on the headline;
12693 ;; 2. If parent has "recursive" property, repeat up to the
12694 ;; headline setting that property, taking inheritance into
12695 ;; account;
12697 ;; 3. Else, move up to direct parent and proceed only once.
12698 (while (and (setq level (org-up-heading-safe))
12699 (or recursive first)
12700 (>= (point) lim))
12701 (setq first nil cookie-present nil)
12702 (unless (and level
12703 (not (string-match
12704 "\\<checkbox\\>"
12705 (downcase (or (org-entry-get nil "COOKIE_DATA")
12706 "")))))
12707 (throw 'exit nil))
12708 (while (re-search-forward box-re (point-at-eol) t)
12709 (setq cnt-all 0 cnt-done 0 cookie-present t)
12710 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12711 (save-match-data
12712 (unless (outline-next-heading) (throw 'exit nil))
12713 (while (and (looking-at org-complex-heading-regexp)
12714 (> (setq l1 (length (match-string 1))) level))
12715 (setq kwd (and (or recursive (= l1 ltoggle))
12716 (match-string 2)))
12717 (if (or (eq org-provide-todo-statistics 'all-headlines)
12718 (and (eq org-provide-todo-statistics t)
12719 (or (member kwd org-done-keywords)))
12720 (and (listp org-provide-todo-statistics)
12721 (stringp (car org-provide-todo-statistics))
12722 (or (member kwd org-provide-todo-statistics)
12723 (member kwd org-done-keywords)))
12724 (and (listp org-provide-todo-statistics)
12725 (listp (car org-provide-todo-statistics))
12726 (or (member kwd (car org-provide-todo-statistics))
12727 (and (member kwd org-done-keywords)
12728 (member kwd (cadr org-provide-todo-statistics))))))
12729 (setq cnt-all (1+ cnt-all))
12730 (if (eq org-provide-todo-statistics t)
12731 (and kwd (setq cnt-all (1+ cnt-all)))))
12732 (when (or (and (eq org-provide-todo-statistics t)
12733 (member kwd org-done-keywords))
12734 (and (listp org-provide-todo-statistics)
12735 (listp (car org-provide-todo-statistics))
12736 (member kwd org-done-keywords)
12737 (member kwd (cadr org-provide-todo-statistics)))
12738 (and (listp org-provide-todo-statistics)
12739 (stringp (car org-provide-todo-statistics))
12740 (member kwd org-done-keywords)))
12741 (setq cnt-done (1+ cnt-done)))
12742 (outline-next-heading)))
12743 (setq new
12744 (if is-percent
12745 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12746 (format "[%d/%d]" cnt-done cnt-all))
12747 ndel (- (match-end 0) checkbox-beg))
12748 ;; handle overlays when updating cookie from column view
12749 (when (setq ov (car (overlays-at checkbox-beg)))
12750 (setq ovs (overlay-start ov) ove (overlay-end ov))
12751 (delete-overlay ov))
12752 (goto-char checkbox-beg)
12753 (insert new)
12754 (delete-region (point) (+ (point) ndel))
12755 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12756 (when ov (move-overlay ov ovs ove)))
12757 (when cookie-present
12758 (run-hook-with-args 'org-after-todo-statistics-hook
12759 cnt-done (- cnt-all cnt-done))))))
12760 (run-hooks 'org-todo-statistics-hook)))
12762 (defvar org-after-todo-statistics-hook nil
12763 "Hook that is called after a TODO statistics cookie has been updated.
12764 Each function is called with two arguments: the number of not-done entries
12765 and the number of done entries.
12767 For example, the following function, when added to this hook, will switch
12768 an entry to DONE when all children are done, and back to TODO when new
12769 entries are set to a TODO status. Note that this hook is only called
12770 when there is a statistics cookie in the headline!
12772 (defun org-summary-todo (n-done n-not-done)
12773 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12774 (let (org-log-done org-log-states) ; turn off logging
12775 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12778 (defvar org-todo-statistics-hook nil
12779 "Hook that is run whenever Org thinks TODO statistics should be updated.
12780 This hook runs even if there is no statistics cookie present, in which case
12781 `org-after-todo-statistics-hook' would not run.")
12783 (defun org-todo-trigger-tag-changes (state)
12784 "Apply the changes defined in `org-todo-state-tags-triggers'."
12785 (let ((l org-todo-state-tags-triggers)
12786 changes)
12787 (when (or (not state) (equal state ""))
12788 (setq changes (append changes (cdr (assoc "" l)))))
12789 (when (and (stringp state) (> (length state) 0))
12790 (setq changes (append changes (cdr (assoc state l)))))
12791 (when (member state org-not-done-keywords)
12792 (setq changes (append changes (cdr (assoc 'todo l)))))
12793 (when (member state org-done-keywords)
12794 (setq changes (append changes (cdr (assoc 'done l)))))
12795 (dolist (c changes)
12796 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12798 (defun org-local-logging (value)
12799 "Get logging settings from a property VALUE."
12800 (let* (words w a)
12801 ;; directly set the variables, they are already local.
12802 (setq org-log-done nil
12803 org-log-repeat nil
12804 org-todo-log-states nil)
12805 (setq words (org-split-string value))
12806 (while (setq w (pop words))
12807 (cond
12808 ((setq a (assoc w org-startup-options))
12809 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12810 (set (nth 1 a) (nth 2 a))))
12811 ((setq a (org-extract-log-state-settings w))
12812 (and (member (car a) org-todo-keywords-1)
12813 (push a org-todo-log-states)))))))
12815 (defun org-get-todo-sequence-head (kwd)
12816 "Return the head of the TODO sequence to which KWD belongs.
12817 If KWD is not set, check if there is a text property remembering the
12818 right sequence."
12819 (let (p)
12820 (cond
12821 ((not kwd)
12822 (or (get-text-property (point-at-bol) 'org-todo-head)
12823 (progn
12824 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12825 nil (point-at-eol)))
12826 (get-text-property p 'org-todo-head))))
12827 ((not (member kwd org-todo-keywords-1))
12828 (car org-todo-keywords-1))
12829 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12831 (defun org-fast-todo-selection ()
12832 "Fast TODO keyword selection with single keys.
12833 Returns the new TODO keyword, or nil if no state change should occur."
12834 (let* ((fulltable org-todo-key-alist)
12835 (done-keywords org-done-keywords) ;; needed for the faces.
12836 (maxlen (apply 'max (mapcar
12837 (lambda (x)
12838 (if (stringp (car x)) (string-width (car x)) 0))
12839 fulltable)))
12840 (expert nil)
12841 (fwidth (+ maxlen 3 1 3))
12842 (ncol (/ (- (window-width) 4) fwidth))
12843 tg cnt e c tbl
12844 groups ingroup)
12845 (save-excursion
12846 (save-window-excursion
12847 (if expert
12848 (set-buffer (get-buffer-create " *Org todo*"))
12849 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12850 (erase-buffer)
12851 (org-set-local 'org-done-keywords done-keywords)
12852 (setq tbl fulltable cnt 0)
12853 (while (setq e (pop tbl))
12854 (cond
12855 ((equal e '(:startgroup))
12856 (push '() groups) (setq ingroup t)
12857 (when (not (= cnt 0))
12858 (setq cnt 0)
12859 (insert "\n"))
12860 (insert "{ "))
12861 ((equal e '(:endgroup))
12862 (setq ingroup nil cnt 0)
12863 (insert "}\n"))
12864 ((equal e '(:newline))
12865 (when (not (= cnt 0))
12866 (setq cnt 0)
12867 (insert "\n")
12868 (setq e (car tbl))
12869 (while (equal (car tbl) '(:newline))
12870 (insert "\n")
12871 (setq tbl (cdr tbl)))))
12873 (setq tg (car e) c (cdr e))
12874 (if ingroup (push tg (car groups)))
12875 (setq tg (org-add-props tg nil 'face
12876 (org-get-todo-face tg)))
12877 (if (and (= cnt 0) (not ingroup)) (insert " "))
12878 (insert "[" c "] " tg (make-string
12879 (- fwidth 4 (length tg)) ?\ ))
12880 (when (= (setq cnt (1+ cnt)) ncol)
12881 (insert "\n")
12882 (if ingroup (insert " "))
12883 (setq cnt 0)))))
12884 (insert "\n")
12885 (goto-char (point-min))
12886 (if (not expert) (org-fit-window-to-buffer))
12887 (message "[a-z..]:Set [SPC]:clear")
12888 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12889 (cond
12890 ((or (= c ?\C-g)
12891 (and (= c ?q) (not (rassoc c fulltable))))
12892 (setq quit-flag t))
12893 ((= c ?\ ) nil)
12894 ((setq e (rassoc c fulltable) tg (car e))
12896 (t (setq quit-flag t)))))))
12898 (defun org-entry-is-todo-p ()
12899 (member (org-get-todo-state) org-not-done-keywords))
12901 (defun org-entry-is-done-p ()
12902 (member (org-get-todo-state) org-done-keywords))
12904 (defun org-get-todo-state ()
12905 "Return the TODO keyword of the current subtree."
12906 (save-excursion
12907 (org-back-to-heading t)
12908 (and (looking-at org-todo-line-regexp)
12909 (match-end 2)
12910 (match-string 2))))
12912 (defun org-at-date-range-p (&optional inactive-ok)
12913 "Is the cursor inside a date range?"
12914 (interactive)
12915 (save-excursion
12916 (catch 'exit
12917 (let ((pos (point)))
12918 (skip-chars-backward "^[<\r\n")
12919 (skip-chars-backward "<[")
12920 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12921 (>= (match-end 0) pos)
12922 (throw 'exit t))
12923 (skip-chars-backward "^<[\r\n")
12924 (skip-chars-backward "<[")
12925 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12926 (>= (match-end 0) pos)
12927 (throw 'exit t)))
12928 nil)))
12930 (defun org-get-repeat (&optional tagline)
12931 "Check if there is a deadline/schedule with repeater in this entry."
12932 (save-match-data
12933 (save-excursion
12934 (org-back-to-heading t)
12935 (and (re-search-forward (if tagline
12936 (concat tagline "\\s-*" org-repeat-re)
12937 org-repeat-re)
12938 (org-entry-end-position) t)
12939 (match-string-no-properties 1)))))
12941 (defvar org-last-changed-timestamp)
12942 (defvar org-last-inserted-timestamp)
12943 (defvar org-log-post-message)
12944 (defvar org-log-note-purpose)
12945 (defvar org-log-note-how)
12946 (defvar org-log-note-extra)
12947 (defun org-auto-repeat-maybe (done-word)
12948 "Check if the current headline contains a repeated deadline/schedule.
12949 If yes, set TODO state back to what it was and change the base date
12950 of repeating deadline/scheduled time stamps to new date.
12951 This function is run automatically after each state change to a DONE state."
12952 ;; last-state is dynamically scoped into this function
12953 (let* ((repeat (org-get-repeat))
12954 (aa (assoc org-last-state org-todo-kwd-alist))
12955 (interpret (nth 1 aa))
12956 (head (nth 2 aa))
12957 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12958 (msg "Entry repeats: ")
12959 (org-log-done nil)
12960 (org-todo-log-states nil)
12961 re type n what ts time to-state)
12962 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
12963 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12964 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12965 org-todo-repeat-to-state))
12966 (unless (and to-state (member to-state org-todo-keywords-1))
12967 (setq to-state (if (eq interpret 'type) org-last-state head)))
12968 (org-todo to-state)
12969 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12970 (org-entry-put nil "LAST_REPEAT" (format-time-string
12971 (org-time-stamp-format t t))))
12972 (when org-log-repeat
12973 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12974 (memq 'org-add-log-note post-command-hook))
12975 ;; OK, we are already setup for some record
12976 (if (eq org-log-repeat 'note)
12977 ;; make sure we take a note, not only a time stamp
12978 (setq org-log-note-how 'note))
12979 ;; Set up for taking a record
12980 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12981 org-last-state
12982 'findpos org-log-repeat)))
12983 (org-back-to-heading t)
12984 (org-add-planning-info nil nil 'closed)
12985 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12986 org-deadline-time-regexp "\\)\\|\\("
12987 org-ts-regexp "\\)"))
12988 (while (re-search-forward
12989 re (save-excursion (outline-next-heading) (point)) t)
12990 (setq type (if (match-end 1) org-scheduled-string
12991 (if (match-end 3) org-deadline-string "Plain:"))
12992 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12993 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12994 (setq n (string-to-number (match-string 2 ts))
12995 what (match-string 3 ts))
12996 (if (equal what "w") (setq n (* n 7) what "d"))
12997 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12998 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12999 ;; Preparation, see if we need to modify the start date for the change
13000 (when (match-end 1)
13001 (setq time (save-match-data (org-time-string-to-time ts)))
13002 (cond
13003 ((equal (match-string 1 ts) ".")
13004 ;; Shift starting date to today
13005 (org-timestamp-change
13006 (- (org-today) (time-to-days time))
13007 'day))
13008 ((equal (match-string 1 ts) "+")
13009 (let ((nshiftmax 10) (nshift 0))
13010 (while (or (= nshift 0)
13011 (<= (time-to-days time)
13012 (time-to-days (current-time))))
13013 (when (= (incf nshift) nshiftmax)
13014 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
13015 (error "Abort")))
13016 (org-timestamp-change n (cdr (assoc what whata)))
13017 (org-at-timestamp-p t)
13018 (setq ts (match-string 1))
13019 (setq time (save-match-data (org-time-string-to-time ts)))))
13020 (org-timestamp-change (- n) (cdr (assoc what whata)))
13021 ;; rematch, so that we have everything in place for the real shift
13022 (org-at-timestamp-p t)
13023 (setq ts (match-string 1))
13024 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13025 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13026 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13027 (setq org-log-post-message msg)
13028 (message "%s" msg))))
13030 (defun org-show-todo-tree (arg)
13031 "Make a compact tree which shows all headlines marked with TODO.
13032 The tree will show the lines where the regexp matches, and all higher
13033 headlines above the match.
13034 With a \\[universal-argument] prefix, prompt for a regexp to match.
13035 With a numeric prefix N, construct a sparse tree for the Nth element
13036 of `org-todo-keywords-1'."
13037 (interactive "P")
13038 (let ((case-fold-search nil)
13039 (kwd-re
13040 (cond ((null arg) org-not-done-regexp)
13041 ((equal arg '(4))
13042 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13043 (mapcar 'list org-todo-keywords-1))))
13044 (concat "\\("
13045 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13046 "\\)\\>")))
13047 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13048 (regexp-quote (nth (1- (prefix-numeric-value arg))
13049 org-todo-keywords-1)))
13050 (t (user-error "Invalid prefix argument: %s" arg)))))
13051 (message "%d TODO entries found"
13052 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13054 (defun org-deadline (arg &optional time)
13055 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13056 With one universal prefix argument, remove any deadline from the item.
13057 With two universal prefix arguments, prompt for a warning delay.
13058 With argument TIME, set the deadline at the corresponding date. TIME
13059 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13060 (interactive "P")
13061 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13062 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13063 'region-start-level 'region))
13064 org-loop-over-headlines-in-active-region)
13065 (org-map-entries
13066 `(org-deadline ',arg ,time)
13067 org-loop-over-headlines-in-active-region
13068 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13069 (let* ((old-date (org-entry-get nil "DEADLINE"))
13070 (old-date-time (if old-date (org-time-string-to-time old-date)))
13071 (repeater (and old-date
13072 (string-match
13073 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13074 old-date)
13075 (match-string 1 old-date))))
13076 (cond
13077 ((equal arg '(4))
13078 (when (and old-date org-log-redeadline)
13079 (org-add-log-setup 'deldeadline nil old-date 'findpos
13080 org-log-redeadline))
13081 (org-remove-timestamp-with-keyword org-deadline-string)
13082 (message "Item no longer has a deadline."))
13083 ((equal arg '(16))
13084 (save-excursion
13085 (org-back-to-heading t)
13086 (if (re-search-forward
13087 org-deadline-time-regexp
13088 (save-excursion (outline-next-heading) (point)) t)
13089 (let* ((rpl0 (match-string 1))
13090 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13091 (replace-match
13092 (concat org-deadline-string
13093 " <" rpl
13094 (format " -%dd"
13095 (abs
13096 (- (time-to-days
13097 (save-match-data
13098 (org-read-date nil t nil "Warn starting from" old-date-time)))
13099 (time-to-days old-date-time))))
13100 ">") t t))
13101 (user-error "No deadline information to update"))))
13103 (org-add-planning-info 'deadline time 'closed)
13104 (when (and old-date org-log-redeadline
13105 (not (equal old-date
13106 (substring org-last-inserted-timestamp 1 -1))))
13107 (org-add-log-setup 'redeadline nil old-date 'findpos
13108 org-log-redeadline))
13109 (when repeater
13110 (save-excursion
13111 (org-back-to-heading t)
13112 (when (re-search-forward (concat org-deadline-string " "
13113 org-last-inserted-timestamp)
13114 (save-excursion
13115 (outline-next-heading) (point)) t)
13116 (goto-char (1- (match-end 0)))
13117 (insert " " repeater)
13118 (setq org-last-inserted-timestamp
13119 (concat (substring org-last-inserted-timestamp 0 -1)
13120 " " repeater
13121 (substring org-last-inserted-timestamp -1))))))
13122 (message "Deadline on %s" org-last-inserted-timestamp))))))
13124 (defun org-schedule (arg &optional time)
13125 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13126 With one universal prefix argument, remove any scheduling date from the item.
13127 With two universal prefix arguments, prompt for a delay cookie.
13128 With argument TIME, scheduled at the corresponding date. TIME can
13129 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13130 (interactive "P")
13131 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13132 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13133 'region-start-level 'region))
13134 org-loop-over-headlines-in-active-region)
13135 (org-map-entries
13136 `(org-schedule ',arg ,time)
13137 org-loop-over-headlines-in-active-region
13138 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13139 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13140 (old-date-time (if old-date (org-time-string-to-time old-date)))
13141 (repeater (and old-date
13142 (string-match
13143 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13144 old-date)
13145 (match-string 1 old-date))))
13146 (cond
13147 ((equal arg '(4))
13148 (progn
13149 (when (and old-date org-log-reschedule)
13150 (org-add-log-setup 'delschedule nil old-date 'findpos
13151 org-log-reschedule))
13152 (org-remove-timestamp-with-keyword org-scheduled-string)
13153 (message "Item is no longer scheduled.")))
13154 ((equal arg '(16))
13155 (save-excursion
13156 (org-back-to-heading t)
13157 (if (re-search-forward
13158 org-scheduled-time-regexp
13159 (save-excursion (outline-next-heading) (point)) t)
13160 (let* ((rpl0 (match-string 1))
13161 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13162 (replace-match
13163 (concat org-scheduled-string
13164 " <" rpl
13165 (format " -%dd"
13166 (abs
13167 (- (time-to-days
13168 (save-match-data
13169 (org-read-date nil t nil "Delay until" old-date-time)))
13170 (time-to-days old-date-time))))
13171 ">") t t))
13172 (user-error "No scheduled information to update"))))
13174 (org-add-planning-info 'scheduled time 'closed)
13175 (when (and old-date org-log-reschedule
13176 (not (equal old-date
13177 (substring org-last-inserted-timestamp 1 -1))))
13178 (org-add-log-setup 'reschedule nil old-date 'findpos
13179 org-log-reschedule))
13180 (when repeater
13181 (save-excursion
13182 (org-back-to-heading t)
13183 (when (re-search-forward (concat org-scheduled-string " "
13184 org-last-inserted-timestamp)
13185 (save-excursion
13186 (outline-next-heading) (point)) t)
13187 (goto-char (1- (match-end 0)))
13188 (insert " " repeater)
13189 (setq org-last-inserted-timestamp
13190 (concat (substring org-last-inserted-timestamp 0 -1)
13191 " " repeater
13192 (substring org-last-inserted-timestamp -1))))))
13193 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13195 (defun org-get-scheduled-time (pom &optional inherit)
13196 "Get the scheduled time as a time tuple, of a format suitable
13197 for calling org-schedule with, or if there is no scheduling,
13198 returns nil."
13199 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13200 (when time
13201 (apply 'encode-time (org-parse-time-string time)))))
13203 (defun org-get-deadline-time (pom &optional inherit)
13204 "Get the deadline as a time tuple, of a format suitable for
13205 calling org-deadline with, or if there is no scheduling, returns
13206 nil."
13207 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13208 (when time
13209 (apply 'encode-time (org-parse-time-string time)))))
13211 (defun org-remove-timestamp-with-keyword (keyword)
13212 "Remove all time stamps with KEYWORD in the current entry."
13213 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13214 beg)
13215 (save-excursion
13216 (org-back-to-heading t)
13217 (setq beg (point))
13218 (outline-next-heading)
13219 (while (re-search-backward re beg t)
13220 (replace-match "")
13221 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13222 (equal (char-before) ?\ ))
13223 (backward-delete-char 1)
13224 (if (string-match "^[ \t]*$" (buffer-substring
13225 (point-at-bol) (point-at-eol)))
13226 (delete-region (point-at-bol)
13227 (min (point-max) (1+ (point-at-eol))))))))))
13229 (defvar org-time-was-given) ; dynamically scoped parameter
13230 (defvar org-end-time-was-given) ; dynamically scoped parameter
13232 (defun org-add-planning-info (what &optional time &rest remove)
13233 "Insert new timestamp with keyword in the line directly after the headline.
13234 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13235 If non is given, the user is prompted for a date.
13236 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13237 be removed."
13238 (interactive)
13239 (let (org-time-was-given org-end-time-was-given ts
13240 end default-time default-input)
13242 (catch 'exit
13243 (when (and (memq what '(scheduled deadline))
13244 (or (not time)
13245 (and (stringp time)
13246 (string-match "^[-+]+[0-9]" time))))
13247 ;; Try to get a default date/time from existing timestamp
13248 (save-excursion
13249 (org-back-to-heading t)
13250 (setq end (save-excursion (outline-next-heading) (point)))
13251 (when (re-search-forward (if (eq what 'scheduled)
13252 org-scheduled-time-regexp
13253 org-deadline-time-regexp)
13254 end t)
13255 (setq ts (match-string 1)
13256 default-time
13257 (apply 'encode-time (org-parse-time-string ts))
13258 default-input (and ts (org-get-compact-tod ts))))))
13259 (when what
13260 (setq time
13261 (if (stringp time)
13262 ;; This is a string (relative or absolute), set proper date
13263 (apply 'encode-time
13264 (org-read-date-analyze
13265 time default-time (decode-time default-time)))
13266 ;; If necessary, get the time from the user
13267 (or time (org-read-date nil 'to-time nil nil
13268 default-time default-input)))))
13270 (when (and org-insert-labeled-timestamps-at-point
13271 (member what '(scheduled deadline)))
13272 (insert
13273 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13274 (org-insert-time-stamp time org-time-was-given
13275 nil nil nil (list org-end-time-was-given))
13276 (setq what nil))
13277 (save-excursion
13278 (save-restriction
13279 (let (col list elt ts buffer-invisibility-spec)
13280 (org-back-to-heading t)
13281 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13282 (goto-char (match-end 1))
13283 (setq col (current-column))
13284 (goto-char (match-end 0))
13285 (if (eobp) (insert "\n") (forward-char 1))
13286 (when (and (not what)
13287 (not (looking-at
13288 (concat "[ \t]*"
13289 org-keyword-time-not-clock-regexp))))
13290 ;; Nothing to add, nothing to remove...... :-)
13291 (throw 'exit nil))
13292 (if (and (not (looking-at org-outline-regexp))
13293 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13294 "[^\r\n]*"))
13295 (not (equal (match-string 1) org-clock-string)))
13296 (narrow-to-region (match-beginning 0) (match-end 0))
13297 (insert-before-markers "\n")
13298 (backward-char 1)
13299 (narrow-to-region (point) (point))
13300 (and org-adapt-indentation (org-indent-to-column col)))
13301 ;; Check if we have to remove something.
13302 (setq list (cons what remove))
13303 (while list
13304 (setq elt (pop list))
13305 (when (or (and (eq elt 'scheduled)
13306 (re-search-forward org-scheduled-time-regexp nil t))
13307 (and (eq elt 'deadline)
13308 (re-search-forward org-deadline-time-regexp nil t))
13309 (and (eq elt 'closed)
13310 (re-search-forward org-closed-time-regexp nil t)))
13311 (replace-match "")
13312 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13313 (and (looking-at "[ \t]+") (replace-match ""))
13314 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13315 (when what
13316 (insert
13317 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13318 (cond ((eq what 'scheduled) org-scheduled-string)
13319 ((eq what 'deadline) org-deadline-string)
13320 ((eq what 'closed) org-closed-string))
13321 " ")
13322 (setq ts (org-insert-time-stamp
13323 time
13324 (or org-time-was-given
13325 (and (eq what 'closed) org-log-done-with-time))
13326 (eq what 'closed)
13327 nil nil (list org-end-time-was-given)))
13328 (insert
13329 (if (not (or (bolp) (eq (char-before) ?\ )
13330 (memq (char-after) '(32 10))
13331 (eobp))) " " ""))
13332 (end-of-line 1))
13333 (goto-char (point-min))
13334 (widen)
13335 (if (and (looking-at "[ \t]*\n")
13336 (equal (char-before) ?\n))
13337 (delete-region (1- (point)) (point-at-eol)))
13338 ts))))))
13340 (defvar org-log-note-marker (make-marker))
13341 (defvar org-log-note-purpose nil)
13342 (defvar org-log-note-state nil)
13343 (defvar org-log-note-previous-state nil)
13344 (defvar org-log-note-how nil)
13345 (defvar org-log-note-extra nil)
13346 (defvar org-log-note-window-configuration nil)
13347 (defvar org-log-note-return-to (make-marker))
13348 (defvar org-log-note-effective-time nil
13349 "Remembered current time so that dynamically scoped
13350 `org-extend-today-until' affects tha timestamps in state change
13351 log")
13353 (defvar org-log-post-message nil
13354 "Message to be displayed after a log note has been stored.
13355 The auto-repeater uses this.")
13357 (defun org-add-note ()
13358 "Add a note to the current entry.
13359 This is done in the same way as adding a state change note."
13360 (interactive)
13361 (org-add-log-setup 'note nil nil 'findpos nil))
13363 (defvar org-property-end-re)
13364 (defun org-add-log-setup (&optional purpose state prev-state
13365 findpos how extra)
13366 "Set up the post command hook to take a note.
13367 If this is about to TODO state change, the new state is expected in STATE.
13368 When FINDPOS is non-nil, find the correct position for the note in
13369 the current entry. If not, assume that it can be inserted at point.
13370 HOW is an indicator what kind of note should be created.
13371 EXTRA is additional text that will be inserted into the notes buffer."
13372 (let* ((org-log-into-drawer (org-log-into-drawer))
13373 (drawer (cond ((stringp org-log-into-drawer)
13374 org-log-into-drawer)
13375 (org-log-into-drawer "LOGBOOK"))))
13376 (save-restriction
13377 (save-excursion
13378 (when findpos
13379 (org-back-to-heading t)
13380 (narrow-to-region (point) (save-excursion
13381 (outline-next-heading) (point)))
13382 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13383 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13384 "[^\r\n]*\\)?"))
13385 (goto-char (match-end 0))
13386 (cond
13387 (drawer
13388 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13389 nil t)
13390 (progn
13391 (goto-char (match-end 0))
13392 (or org-log-states-order-reversed
13393 (and (re-search-forward org-property-end-re nil t)
13394 (goto-char (1- (match-beginning 0))))))
13395 (insert "\n:" drawer ":\n:END:")
13396 (beginning-of-line 0)
13397 (org-indent-line)
13398 (beginning-of-line 2)
13399 (org-indent-line)
13400 (end-of-line 0)))
13401 ((and org-log-state-notes-insert-after-drawers
13402 (save-excursion
13403 (forward-line) (looking-at org-drawer-regexp)))
13404 (forward-line)
13405 (while (looking-at org-drawer-regexp)
13406 (goto-char (match-end 0))
13407 (re-search-forward org-property-end-re (point-max) t)
13408 (forward-line))
13409 (forward-line -1)))
13410 (unless org-log-states-order-reversed
13411 (and (= (char-after) ?\n) (forward-char 1))
13412 (org-skip-over-state-notes)
13413 (skip-chars-backward " \t\n\r")))
13414 (move-marker org-log-note-marker (point))
13415 (setq org-log-note-purpose purpose
13416 org-log-note-state state
13417 org-log-note-previous-state prev-state
13418 org-log-note-how how
13419 org-log-note-extra extra
13420 org-log-note-effective-time (org-current-effective-time))
13421 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13423 (defun org-skip-over-state-notes ()
13424 "Skip past the list of State notes in an entry."
13425 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13426 (when (ignore-errors (goto-char (org-in-item-p)))
13427 (let* ((struct (org-list-struct))
13428 (prevs (org-list-prevs-alist struct)))
13429 (while (looking-at "[ \t]*- State")
13430 (goto-char (or (org-list-get-next-item (point) struct prevs)
13431 (org-list-get-item-end (point) struct)))))))
13433 (defun org-add-log-note (&optional purpose)
13434 "Pop up a window for taking a note, and add this note later at point."
13435 (remove-hook 'post-command-hook 'org-add-log-note)
13436 (setq org-log-note-window-configuration (current-window-configuration))
13437 (delete-other-windows)
13438 (move-marker org-log-note-return-to (point))
13439 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13440 (goto-char org-log-note-marker)
13441 (org-switch-to-buffer-other-window "*Org Note*")
13442 (erase-buffer)
13443 (if (memq org-log-note-how '(time state))
13444 (let (current-prefix-arg) (org-store-log-note))
13445 (let ((org-inhibit-startup t)) (org-mode))
13446 (insert (format "# Insert note for %s.
13447 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13448 (cond
13449 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13450 ((eq org-log-note-purpose 'done) "closed todo item")
13451 ((eq org-log-note-purpose 'state)
13452 (format "state change from \"%s\" to \"%s\""
13453 (or org-log-note-previous-state "")
13454 (or org-log-note-state "")))
13455 ((eq org-log-note-purpose 'reschedule)
13456 "rescheduling")
13457 ((eq org-log-note-purpose 'delschedule)
13458 "no longer scheduled")
13459 ((eq org-log-note-purpose 'redeadline)
13460 "changing deadline")
13461 ((eq org-log-note-purpose 'deldeadline)
13462 "removing deadline")
13463 ((eq org-log-note-purpose 'refile)
13464 "refiling")
13465 ((eq org-log-note-purpose 'note)
13466 "this entry")
13467 (t (error "This should not happen")))))
13468 (if org-log-note-extra (insert org-log-note-extra))
13469 (org-set-local 'org-finish-function 'org-store-log-note)
13470 (run-hooks 'org-log-buffer-setup-hook)))
13472 (defvar org-note-abort nil) ; dynamically scoped
13473 (defun org-store-log-note ()
13474 "Finish taking a log note, and insert it to where it belongs."
13475 (let ((txt (buffer-string)))
13476 (kill-buffer (current-buffer))
13477 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13478 lines ind bul)
13479 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13480 (setq txt (replace-match "" t t txt)))
13481 (if (string-match "\\s-+\\'" txt)
13482 (setq txt (replace-match "" t t txt)))
13483 (setq lines (org-split-string txt "\n"))
13484 (when (and note (string-match "\\S-" note))
13485 (setq note
13486 (org-replace-escapes
13487 note
13488 (list (cons "%u" (user-login-name))
13489 (cons "%U" user-full-name)
13490 (cons "%t" (format-time-string
13491 (org-time-stamp-format 'long 'inactive)
13492 org-log-note-effective-time))
13493 (cons "%T" (format-time-string
13494 (org-time-stamp-format 'long nil)
13495 org-log-note-effective-time))
13496 (cons "%d" (format-time-string
13497 (org-time-stamp-format nil 'inactive)
13498 org-log-note-effective-time))
13499 (cons "%D" (format-time-string
13500 (org-time-stamp-format nil nil)
13501 org-log-note-effective-time))
13502 (cons "%s" (if org-log-note-state
13503 (concat "\"" org-log-note-state "\"")
13504 ""))
13505 (cons "%S" (if org-log-note-previous-state
13506 (concat "\"" org-log-note-previous-state "\"")
13507 "\"\"")))))
13508 (if lines (setq note (concat note " \\\\")))
13509 (push note lines))
13510 (when (or current-prefix-arg org-note-abort)
13511 (when org-log-into-drawer
13512 (org-remove-empty-drawer-at org-log-note-marker))
13513 (setq lines nil))
13514 (when lines
13515 (with-current-buffer (marker-buffer org-log-note-marker)
13516 (save-excursion
13517 (goto-char org-log-note-marker)
13518 (move-marker org-log-note-marker nil)
13519 (end-of-line 1)
13520 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13521 (setq ind (save-excursion
13522 (if (ignore-errors (goto-char (org-in-item-p)))
13523 (let ((struct (org-list-struct)))
13524 (org-list-get-ind
13525 (org-list-get-top-point struct) struct))
13526 (skip-chars-backward " \r\t\n")
13527 (cond
13528 ((and (org-at-heading-p)
13529 org-adapt-indentation)
13530 (1+ (org-current-level)))
13531 ((org-at-heading-p) 0)
13532 (t (org-get-indentation))))))
13533 (setq bul (org-list-bullet-string "-"))
13534 (org-indent-line-to ind)
13535 (insert bul (pop lines))
13536 (let ((ind-body (+ (length bul) ind)))
13537 (while lines
13538 (insert "\n")
13539 (org-indent-line-to ind-body)
13540 (insert (pop lines))))
13541 (message "Note stored")
13542 (org-back-to-heading t)
13543 (org-cycle-hide-drawers 'children))
13544 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13545 ;; from within `org-add-log-note' because `buffer-undo-list'
13546 ;; is then modified outside of `org-with-remote-undo'.
13547 (when (eq this-command 'org-agenda-todo)
13548 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13549 ;; Don't add undo information when called from `org-agenda-todo'
13550 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13551 (set-window-configuration org-log-note-window-configuration)
13552 (with-current-buffer (marker-buffer org-log-note-return-to)
13553 (goto-char org-log-note-return-to))
13554 (move-marker org-log-note-return-to nil)
13555 (and org-log-post-message (message "%s" org-log-post-message))))
13557 (defun org-remove-empty-drawer-at (pos)
13558 "Remove an empty drawer at position POS.
13559 POS may also be a marker."
13560 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13561 (org-with-wide-buffer
13562 (goto-char pos)
13563 (let ((drawer (org-element-at-point)))
13564 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13565 (not (org-element-property :contents-begin drawer)))
13566 (delete-region (org-element-property :begin drawer)
13567 (progn (goto-char (org-element-property :end drawer))
13568 (skip-chars-backward " \r\t\n")
13569 (forward-line)
13570 (point))))))))
13572 (defvar org-ts-type nil)
13573 (defun org-sparse-tree (&optional arg type)
13574 "Create a sparse tree, prompt for the details.
13575 This command can create sparse trees. You first need to select the type
13576 of match used to create the tree:
13578 t Show all TODO entries.
13579 T Show entries with a specific TODO keyword.
13580 m Show entries selected by a tags/property match.
13581 p Enter a property name and its value (both with completion on existing
13582 names/values) and show entries with that property.
13583 r Show entries matching a regular expression (`/' can be used as well).
13584 b Show deadlines and scheduled items before a date.
13585 a Show deadlines and scheduled items after a date.
13586 d Show deadlines due within `org-deadline-warning-days'.
13587 D Show deadlines and scheduled items between a date range."
13588 (interactive "P")
13589 (let (ans kwd value ts-type)
13590 (setq type (or type org-sparse-tree-default-date-type))
13591 (setq org-ts-type type)
13592 (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"
13593 (cond ((eq type 'all) "all timestamps")
13594 ((eq type 'scheduled) "only scheduled")
13595 ((eq type 'deadline) "only deadline")
13596 ((eq type 'active) "only active timestamps")
13597 ((eq type 'inactive) "only inactive timestamps")
13598 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13599 ((eq type 'closed) "with a closed time-stamp")
13600 (t "scheduled/deadline")))
13601 (setq ans (read-char-exclusive))
13602 (cond
13603 ((equal ans ?c)
13604 (org-sparse-tree
13605 arg (cadr (member type '(scheduled-or-deadline
13606 all scheduled deadline active inactive closed)))))
13607 ((equal ans ?d)
13608 (call-interactively 'org-check-deadlines))
13609 ((equal ans ?b)
13610 (call-interactively 'org-check-before-date))
13611 ((equal ans ?a)
13612 (call-interactively 'org-check-after-date))
13613 ((equal ans ?D)
13614 (call-interactively 'org-check-dates-range))
13615 ((equal ans ?t)
13616 (call-interactively 'org-show-todo-tree))
13617 ((equal ans ?T)
13618 (org-show-todo-tree '(4)))
13619 ((member ans '(?T ?m))
13620 (call-interactively 'org-match-sparse-tree))
13621 ((member ans '(?p ?P))
13622 (setq kwd (org-icompleting-read "Property: "
13623 (mapcar 'list (org-buffer-property-keys))))
13624 (setq value (org-icompleting-read "Value: "
13625 (mapcar 'list (org-property-values kwd))))
13626 (unless (string-match "\\`{.*}\\'" value)
13627 (setq value (concat "\"" value "\"")))
13628 (org-match-sparse-tree arg (concat kwd "=" value)))
13629 ((member ans '(?r ?R ?/))
13630 (call-interactively 'org-occur))
13631 (t (user-error "No such sparse tree command \"%c\"" ans)))))
13633 (defvar org-occur-highlights nil
13634 "List of overlays used for occur matches.")
13635 (make-variable-buffer-local 'org-occur-highlights)
13636 (defvar org-occur-parameters nil
13637 "Parameters of the active org-occur calls.
13638 This is a list, each call to org-occur pushes as cons cell,
13639 containing the regular expression and the callback, onto the list.
13640 The list can contain several entries if `org-occur' has been called
13641 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13642 will only contain one set of parameters. When the highlights are
13643 removed (for example with `C-c C-c', or with the next edit (depending
13644 on `org-remove-highlights-with-change'), this variable is emptied
13645 as well.")
13646 (make-variable-buffer-local 'org-occur-parameters)
13648 (defun org-occur (regexp &optional keep-previous callback)
13649 "Make a compact tree which shows all matches of REGEXP.
13650 The tree will show the lines where the regexp matches, and all higher
13651 headlines above the match. It will also show the heading after the match,
13652 to make sure editing the matching entry is easy.
13653 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13654 call to `org-occur' will be kept, to allow stacking of calls to this
13655 command.
13656 If CALLBACK is non-nil, it is a function which is called to confirm
13657 that the match should indeed be shown."
13658 (interactive "sRegexp: \nP")
13659 (when (equal regexp "")
13660 (user-error "Regexp cannot be empty"))
13661 (unless keep-previous
13662 (org-remove-occur-highlights nil nil t))
13663 (push (cons regexp callback) org-occur-parameters)
13664 (let ((cnt 0))
13665 (save-excursion
13666 (goto-char (point-min))
13667 (if (or (not keep-previous) ; do not want to keep
13668 (not org-occur-highlights)) ; no previous matches
13669 ;; hide everything
13670 (org-overview))
13671 (while (re-search-forward regexp nil t)
13672 (when (or (not callback)
13673 (save-match-data (funcall callback)))
13674 (setq cnt (1+ cnt))
13675 (when org-highlight-sparse-tree-matches
13676 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13677 (org-show-context 'occur-tree))))
13678 (when org-remove-highlights-with-change
13679 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13680 nil 'local))
13681 (unless org-sparse-tree-open-archived-trees
13682 (org-hide-archived-subtrees (point-min) (point-max)))
13683 (run-hooks 'org-occur-hook)
13684 (if (org-called-interactively-p 'interactive)
13685 (message "%d match(es) for regexp %s" cnt regexp))
13686 cnt))
13688 (defun org-occur-next-match (&optional n reset)
13689 "Function for `next-error-function' to find sparse tree matches.
13690 N is the number of matches to move, when negative move backwards.
13691 RESET is entirely ignored - this function always goes back to the
13692 starting point when no match is found."
13693 (let* ((limit (if (< n 0) (point-min) (point-max)))
13694 (search-func (if (< n 0)
13695 'previous-single-char-property-change
13696 'next-single-char-property-change))
13697 (n (abs n))
13698 (pos (point))
13700 (catch 'exit
13701 (while (setq p1 (funcall search-func (point) 'org-type))
13702 (when (equal p1 limit)
13703 (goto-char pos)
13704 (error "No more matches"))
13705 (when (equal (get-char-property p1 'org-type) 'org-occur)
13706 (setq n (1- n))
13707 (when (= n 0)
13708 (goto-char p1)
13709 (throw 'exit (point))))
13710 (goto-char p1))
13711 (goto-char p1)
13712 (error "No more matches"))))
13714 (defun org-show-context (&optional key)
13715 "Make sure point and context are visible.
13716 How much context is shown depends upon the variables
13717 `org-show-hierarchy-above', `org-show-following-heading',
13718 `org-show-entry-below' and `org-show-siblings'."
13719 (let ((heading-p (org-at-heading-p t))
13720 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13721 (following-p (org-get-alist-option org-show-following-heading key))
13722 (entry-p (org-get-alist-option org-show-entry-below key))
13723 (siblings-p (org-get-alist-option org-show-siblings key)))
13724 ;; Show heading or entry text
13725 (if (and heading-p (not entry-p))
13726 (org-flag-heading nil) ; only show the heading
13727 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13728 (org-show-hidden-entry))) ; show entire entry
13729 (when following-p
13730 ;; Show next sibling, or heading below text
13731 (save-excursion
13732 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13733 (org-flag-heading nil))))
13734 (when siblings-p (org-show-siblings))
13735 (when hierarchy-p
13736 ;; show all higher headings, possibly with siblings
13737 (save-excursion
13738 (while (and (condition-case nil
13739 (progn (org-up-heading-all 1) t)
13740 (error nil))
13741 (not (bobp)))
13742 (org-flag-heading nil)
13743 (when siblings-p (org-show-siblings)))))
13744 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13746 (defvar org-reveal-start-hook nil
13747 "Hook run before revealing a location.")
13749 (defun org-reveal (&optional siblings)
13750 "Show current entry, hierarchy above it, and the following headline.
13751 This can be used to show a consistent set of context around locations
13752 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13753 not t for the search context.
13755 With optional argument SIBLINGS, on each level of the hierarchy all
13756 siblings are shown. This repairs the tree structure to what it would
13757 look like when opened with hierarchical calls to `org-cycle'.
13758 With double optional argument \\[universal-argument] \\[universal-argument], \
13759 go to the parent and show the
13760 entire tree."
13761 (interactive "P")
13762 (run-hooks 'org-reveal-start-hook)
13763 (let ((org-show-hierarchy-above t)
13764 (org-show-following-heading t)
13765 (org-show-siblings (if siblings t org-show-siblings)))
13766 (org-show-context nil))
13767 (when (equal siblings '(16))
13768 (save-excursion
13769 (when (org-up-heading-safe)
13770 (org-show-subtree)
13771 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13773 (defun org-highlight-new-match (beg end)
13774 "Highlight from BEG to END and mark the highlight is an occur headline."
13775 (let ((ov (make-overlay beg end)))
13776 (overlay-put ov 'face 'secondary-selection)
13777 (overlay-put ov 'org-type 'org-occur)
13778 (push ov org-occur-highlights)))
13780 (defun org-remove-occur-highlights (&optional beg end noremove)
13781 "Remove the occur highlights from the buffer.
13782 BEG and END are ignored. If NOREMOVE is nil, remove this function
13783 from the `before-change-functions' in the current buffer."
13784 (interactive)
13785 (unless org-inhibit-highlight-removal
13786 (mapc 'delete-overlay org-occur-highlights)
13787 (setq org-occur-highlights nil)
13788 (setq org-occur-parameters nil)
13789 (unless noremove
13790 (remove-hook 'before-change-functions
13791 'org-remove-occur-highlights 'local))))
13793 ;;;; Priorities
13795 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13796 "Regular expression matching the priority indicator.")
13798 (defvar org-remove-priority-next-time nil)
13800 (defun org-priority-up ()
13801 "Increase the priority of the current item."
13802 (interactive)
13803 (org-priority 'up))
13805 (defun org-priority-down ()
13806 "Decrease the priority of the current item."
13807 (interactive)
13808 (org-priority 'down))
13810 (defun org-priority (&optional action show)
13811 "Change the priority of an item.
13812 ACTION can be `set', `up', `down', or a character."
13813 (interactive "P")
13814 (if (equal action '(4))
13815 (org-show-priority)
13816 (unless org-enable-priority-commands
13817 (user-error "Priority commands are disabled"))
13818 (setq action (or action 'set))
13819 (let (current new news have remove)
13820 (save-excursion
13821 (org-back-to-heading t)
13822 (if (looking-at org-priority-regexp)
13823 (setq current (string-to-char (match-string 2))
13824 have t))
13825 (cond
13826 ((eq action 'remove)
13827 (setq remove t new ?\ ))
13828 ((or (eq action 'set)
13829 (if (featurep 'xemacs) (characterp action) (integerp action)))
13830 (if (not (eq action 'set))
13831 (setq new action)
13832 (message "Priority %c-%c, SPC to remove: "
13833 org-highest-priority org-lowest-priority)
13834 (save-match-data
13835 (setq new (read-char-exclusive))))
13836 (if (and (= (upcase org-highest-priority) org-highest-priority)
13837 (= (upcase org-lowest-priority) org-lowest-priority))
13838 (setq new (upcase new)))
13839 (cond ((equal new ?\ ) (setq remove t))
13840 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13841 (user-error "Priority must be between `%c' and `%c'"
13842 org-highest-priority org-lowest-priority))))
13843 ((eq action 'up)
13844 (setq new (if have
13845 (1- current) ; normal cycling
13846 ;; last priority was empty
13847 (if (eq last-command this-command)
13848 org-lowest-priority ; wrap around empty to lowest
13849 ;; default
13850 (if org-priority-start-cycle-with-default
13851 org-default-priority
13852 (1- org-default-priority))))))
13853 ((eq action 'down)
13854 (setq new (if have
13855 (1+ current) ; normal cycling
13856 ;; last priority was empty
13857 (if (eq last-command this-command)
13858 org-highest-priority ; wrap around empty to highest
13859 ;; default
13860 (if org-priority-start-cycle-with-default
13861 org-default-priority
13862 (1+ org-default-priority))))))
13863 (t (user-error "Invalid action")))
13864 (if (or (< (upcase new) org-highest-priority)
13865 (> (upcase new) org-lowest-priority))
13866 (if (and (memq action '(up down))
13867 (not have) (not (eq last-command this-command)))
13868 ;; `new' is from default priority
13869 (error
13870 "The default can not be set, see `org-default-priority' why")
13871 ;; normal cycling: `new' is beyond highest/lowest priority
13872 ;; and is wrapped around to the empty priority
13873 (setq remove t)))
13874 (setq news (format "%c" new))
13875 (if have
13876 (if remove
13877 (replace-match "" t t nil 1)
13878 (replace-match news t t nil 2))
13879 (if remove
13880 (user-error "No priority cookie found in line")
13881 (let ((case-fold-search nil))
13882 (looking-at org-todo-line-regexp))
13883 (if (match-end 2)
13884 (progn
13885 (goto-char (match-end 2))
13886 (insert " [#" news "]"))
13887 (goto-char (match-beginning 3))
13888 (insert "[#" news "] "))))
13889 (org-set-tags nil 'align))
13890 (if remove
13891 (message "Priority removed")
13892 (message "Priority of current item set to %s" news)))))
13894 (defun org-show-priority ()
13895 "Show the priority of the current item.
13896 This priority is composed of the main priority given with the [#A] cookies,
13897 and by additional input from the age of a schedules or deadline entry."
13898 (interactive)
13899 (let ((pri (if (eq major-mode 'org-agenda-mode)
13900 (org-get-at-bol 'priority)
13901 (save-excursion
13902 (save-match-data
13903 (beginning-of-line)
13904 (and (looking-at org-heading-regexp)
13905 (org-get-priority (match-string 0))))))))
13906 (message "Priority is %d" (if pri pri -1000))))
13908 (defun org-get-priority (s)
13909 "Find priority cookie and return priority."
13910 (save-match-data
13911 (if (functionp org-get-priority-function)
13912 (funcall org-get-priority-function)
13913 (if (not (string-match org-priority-regexp s))
13914 (* 1000 (- org-lowest-priority org-default-priority))
13915 (* 1000 (- org-lowest-priority
13916 (string-to-char (match-string 2 s))))))))
13918 ;;;; Tags
13920 (defvar org-agenda-archives-mode)
13921 (defvar org-map-continue-from nil
13922 "Position from where mapping should continue.
13923 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13925 (defvar org-scanner-tags nil
13926 "The current tag list while the tags scanner is running.")
13927 (defvar org-trust-scanner-tags nil
13928 "Should `org-get-tags-at' use the tags for the scanner.
13929 This is for internal dynamical scoping only.
13930 When this is non-nil, the function `org-get-tags-at' will return the value
13931 of `org-scanner-tags' instead of building the list by itself. This
13932 can lead to large speed-ups when the tags scanner is used in a file with
13933 many entries, and when the list of tags is retrieved, for example to
13934 obtain a list of properties. Building the tags list for each entry in such
13935 a file becomes an N^2 operation - but with this variable set, it scales
13936 as N.")
13938 (defun org-scan-tags (action matcher todo-only &optional start-level)
13939 "Sca headline tags with inheritance and produce output ACTION.
13941 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13942 or `agenda' to produce an entry list for an agenda view. It can also be
13943 a Lisp form or a function that should be called at each matched headline, in
13944 this case the return value is a list of all return values from these calls.
13946 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13947 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13948 only lines with a not-done TODO keyword are included in the output.
13949 This should be the same variable that was scoped into
13950 and set by `org-make-tags-matcher' when it constructed MATCHER.
13952 START-LEVEL can be a string with asterisks, reducing the scope to
13953 headlines matching this string."
13954 (require 'org-agenda)
13955 (let* ((re (concat "^"
13956 (if start-level
13957 ;; Get the correct level to match
13958 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13959 org-outline-regexp)
13960 " *\\(\\<\\("
13961 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13962 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13963 (props (list 'face 'default
13964 'done-face 'org-agenda-done
13965 'undone-face 'default
13966 'mouse-face 'highlight
13967 'org-not-done-regexp org-not-done-regexp
13968 'org-todo-regexp org-todo-regexp
13969 'org-complex-heading-regexp org-complex-heading-regexp
13970 'help-echo
13971 (format "mouse-2 or RET jump to org file %s"
13972 (abbreviate-file-name
13973 (or (buffer-file-name (buffer-base-buffer))
13974 (buffer-name (buffer-base-buffer)))))))
13975 (org-map-continue-from nil)
13976 lspos tags tags-list
13977 (tags-alist (list (cons 0 org-file-tags)))
13978 (llast 0) rtn rtn1 level category i txt
13979 todo marker entry priority)
13980 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13981 (setq action (list 'lambda nil action)))
13982 (save-excursion
13983 (goto-char (point-min))
13984 (when (eq action 'sparse-tree)
13985 (org-overview)
13986 (org-remove-occur-highlights))
13987 (while (let (case-fold-search)
13988 (re-search-forward re nil t))
13989 (setq org-map-continue-from nil)
13990 (catch :skip
13991 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13992 tags (if (match-end 4) (org-match-string-no-properties 4)))
13993 (goto-char (setq lspos (match-beginning 0)))
13994 (setq level (org-reduced-level (org-outline-level))
13995 category (org-get-category))
13996 (setq i llast llast level)
13997 ;; remove tag lists from same and sublevels
13998 (while (>= i level)
13999 (when (setq entry (assoc i tags-alist))
14000 (setq tags-alist (delete entry tags-alist)))
14001 (setq i (1- i)))
14002 ;; add the next tags
14003 (when tags
14004 (setq tags (org-split-string tags ":")
14005 tags-alist
14006 (cons (cons level tags) tags-alist)))
14007 ;; compile tags for current headline
14008 (setq tags-list
14009 (if org-use-tag-inheritance
14010 (apply 'append (mapcar 'cdr (reverse tags-alist)))
14011 tags)
14012 org-scanner-tags tags-list)
14013 (when org-use-tag-inheritance
14014 (setcdr (car tags-alist)
14015 (mapcar (lambda (x)
14016 (setq x (copy-sequence x))
14017 (org-add-prop-inherited x))
14018 (cdar tags-alist))))
14019 (when (and tags org-use-tag-inheritance
14020 (or (not (eq t org-use-tag-inheritance))
14021 org-tags-exclude-from-inheritance))
14022 ;; selective inheritance, remove uninherited ones
14023 (setcdr (car tags-alist)
14024 (org-remove-uninherited-tags (cdar tags-alist))))
14025 (when (and
14027 ;; eval matcher only when the todo condition is OK
14028 (and (or (not todo-only) (member todo org-not-done-keywords))
14029 (let ((case-fold-search t) (org-trust-scanner-tags t))
14030 (eval matcher)))
14032 ;; Call the skipper, but return t if it does not skip,
14033 ;; so that the `and' form continues evaluating
14034 (progn
14035 (unless (eq action 'sparse-tree) (org-agenda-skip))
14038 ;; Check if timestamps are deselecting this entry
14039 (or (not todo-only)
14040 (and (member todo org-not-done-keywords)
14041 (or (not org-agenda-tags-todo-honor-ignore-options)
14042 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14044 ;; select this headline
14045 (cond
14046 ((eq action 'sparse-tree)
14047 (and org-highlight-sparse-tree-matches
14048 (org-get-heading) (match-end 0)
14049 (org-highlight-new-match
14050 (match-beginning 1) (match-end 1)))
14051 (org-show-context 'tags-tree))
14052 ((eq action 'agenda)
14053 (setq txt (org-agenda-format-item
14055 (concat
14056 (if (eq org-tags-match-list-sublevels 'indented)
14057 (make-string (1- level) ?.) "")
14058 (org-get-heading))
14059 level category
14060 tags-list)
14061 priority (org-get-priority txt))
14062 (goto-char lspos)
14063 (setq marker (org-agenda-new-marker))
14064 (org-add-props txt props
14065 'org-marker marker 'org-hd-marker marker 'org-category category
14066 'todo-state todo
14067 'priority priority 'type "tagsmatch")
14068 (push txt rtn))
14069 ((functionp action)
14070 (setq org-map-continue-from nil)
14071 (save-excursion
14072 (setq rtn1 (funcall action))
14073 (push rtn1 rtn)))
14074 (t (user-error "Invalid action")))
14076 ;; if we are to skip sublevels, jump to end of subtree
14077 (unless org-tags-match-list-sublevels
14078 (org-end-of-subtree t)
14079 (backward-char 1))))
14080 ;; Get the correct position from where to continue
14081 (if org-map-continue-from
14082 (goto-char org-map-continue-from)
14083 (and (= (point) lspos) (end-of-line 1)))))
14084 (when (and (eq action 'sparse-tree)
14085 (not org-sparse-tree-open-archived-trees))
14086 (org-hide-archived-subtrees (point-min) (point-max)))
14087 (nreverse rtn)))
14089 (defun org-remove-uninherited-tags (tags)
14090 "Remove all tags that are not inherited from the list TAGS."
14091 (cond
14092 ((eq org-use-tag-inheritance t)
14093 (if org-tags-exclude-from-inheritance
14094 (org-delete-all org-tags-exclude-from-inheritance tags)
14095 tags))
14096 ((not org-use-tag-inheritance) nil)
14097 ((stringp org-use-tag-inheritance)
14098 (delq nil (mapcar
14099 (lambda (x)
14100 (if (and (string-match org-use-tag-inheritance x)
14101 (not (member x org-tags-exclude-from-inheritance)))
14102 x nil))
14103 tags)))
14104 ((listp org-use-tag-inheritance)
14105 (delq nil (mapcar
14106 (lambda (x)
14107 (if (member x org-use-tag-inheritance) x nil))
14108 tags)))))
14110 (defun org-match-sparse-tree (&optional todo-only match)
14111 "Create a sparse tree according to tags string MATCH.
14112 MATCH can contain positive and negative selection of tags, like
14113 \"+WORK+URGENT-WITHBOSS\".
14114 If optional argument TODO-ONLY is non-nil, only select lines that are
14115 also TODO lines."
14116 (interactive "P")
14117 (org-agenda-prepare-buffers (list (current-buffer)))
14118 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14120 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14122 (defvar org-cached-props nil)
14123 (defun org-cached-entry-get (pom property)
14124 (if (or (eq t org-use-property-inheritance)
14125 (and (stringp org-use-property-inheritance)
14126 (string-match org-use-property-inheritance property))
14127 (and (listp org-use-property-inheritance)
14128 (member property org-use-property-inheritance)))
14129 ;; Caching is not possible, check it directly
14130 (org-entry-get pom property 'inherit)
14131 ;; Get all properties, so that we can do complicated checks easily
14132 (cdr (assoc property (or org-cached-props
14133 (setq org-cached-props
14134 (org-entry-properties pom)))))))
14136 (defun org-global-tags-completion-table (&optional files)
14137 "Return the list of all tags in all agenda buffer/files.
14138 Optional FILES argument is a list of files which can be used
14139 instead of the agenda files."
14140 (save-excursion
14141 (org-uniquify
14142 (delq nil
14143 (apply 'append
14144 (mapcar
14145 (lambda (file)
14146 (set-buffer (find-file-noselect file))
14147 (append (org-get-buffer-tags)
14148 (mapcar (lambda (x) (if (stringp (car-safe x))
14149 (list (car-safe x)) nil))
14150 org-tag-alist)))
14151 (if (and files (car files))
14152 files
14153 (org-agenda-files))))))))
14155 (defun org-make-tags-matcher (match)
14156 "Create the TAGS/TODO matcher form for the selection string MATCH.
14158 The variable `todo-only' is scoped dynamically into this function.
14159 It will be set to t if the matcher restricts matching to TODO entries,
14160 otherwise will not be touched.
14162 Returns a cons of the selection string MATCH and the constructed
14163 lisp form implementing the matcher. The matcher is to be evaluated
14164 at an Org entry, with point on the headline, and returns t if the
14165 entry matches the selection string MATCH. The returned lisp form
14166 references two variables with information about the entry, which
14167 must be bound around the form's evaluation: todo, the TODO keyword
14168 at the entry (or nil of none); and tags-list, the list of all tags
14169 at the entry including inherited ones. Additionally, the category
14170 of the entry (if any) must be specified as the text property
14171 'org-category on the headline.
14173 See also `org-scan-tags'.
14175 (declare (special todo-only))
14176 (unless (boundp 'todo-only)
14177 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14178 (unless match
14179 ;; Get a new match request, with completion against the global
14180 ;; tags table and the local tags in current buffer
14181 (let ((org-last-tags-completion-table
14182 (org-uniquify
14183 (delq nil (append (org-get-buffer-tags)
14184 (org-global-tags-completion-table))))))
14185 (setq match (org-completing-read-no-i
14186 "Match: " 'org-tags-completion-function nil nil nil
14187 'org-tags-history))))
14189 ;; Parse the string and create a lisp form
14190 (let ((match0 match)
14191 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14192 minus tag mm
14193 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14194 orterms term orlist re-p str-p level-p level-op time-p
14195 prop-p pn pv po gv rest (start 0) (ss 0))
14196 ;; Expand group tags
14197 (setq match (org-tags-expand match))
14199 ;; Check if there is a TODO part of this match, which would be the
14200 ;; part after a "/". TO make sure that this slash is not part of
14201 ;; a property value to be matched against, we also check that there
14202 ;; is no " after that slash.
14203 ;; First, find the last slash
14204 (while (string-match "/+" match ss)
14205 (setq start (match-beginning 0) ss (match-end 0)))
14206 (if (and (string-match "/+" match start)
14207 (not (save-match-data (string-match "\"" match start))))
14208 ;; match contains also a todo-matching request
14209 (progn
14210 (setq tagsmatch (substring match 0 (match-beginning 0))
14211 todomatch (substring match (match-end 0)))
14212 (if (string-match "^!" todomatch)
14213 (setq todo-only t todomatch (substring todomatch 1)))
14214 (if (string-match "^\\s-*$" todomatch)
14215 (setq todomatch nil)))
14216 ;; only matching tags
14217 (setq tagsmatch match todomatch nil))
14219 ;; Make the tags matcher
14220 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14221 (setq tagsmatcher t)
14222 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14223 (while (setq term (pop orterms))
14224 (while (and (equal (substring term -1) "\\") orterms)
14225 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14226 (while (string-match re term)
14227 (setq rest (substring term (match-end 0))
14228 minus (and (match-end 1)
14229 (equal (match-string 1 term) "-"))
14230 tag (save-match-data (replace-regexp-in-string
14231 "\\\\-" "-"
14232 (match-string 2 term)))
14233 re-p (equal (string-to-char tag) ?{)
14234 level-p (match-end 4)
14235 prop-p (match-end 5)
14236 mm (cond
14237 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14238 (level-p
14239 (setq level-op (org-op-to-function (match-string 3 term)))
14240 `(,level-op level ,(string-to-number
14241 (match-string 4 term))))
14242 (prop-p
14243 (setq pn (match-string 5 term)
14244 po (match-string 6 term)
14245 pv (match-string 7 term)
14246 re-p (equal (string-to-char pv) ?{)
14247 str-p (equal (string-to-char pv) ?\")
14248 time-p (save-match-data
14249 (string-match "^\"[[<].*[]>]\"$" pv))
14250 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14251 (if time-p (setq pv (org-matcher-time pv)))
14252 (setq po (org-op-to-function po (if time-p 'time str-p)))
14253 (cond
14254 ((equal pn "CATEGORY")
14255 (setq gv '(get-text-property (point) 'org-category)))
14256 ((equal pn "TODO")
14257 (setq gv 'todo))
14259 (setq gv `(org-cached-entry-get nil ,pn))))
14260 (if re-p
14261 (if (eq po 'org<>)
14262 `(not (string-match ,pv (or ,gv "")))
14263 `(string-match ,pv (or ,gv "")))
14264 (if str-p
14265 `(,po (or ,gv "") ,pv)
14266 `(,po (string-to-number (or ,gv ""))
14267 ,(string-to-number pv) ))))
14268 (t `(member ,tag tags-list)))
14269 mm (if minus (list 'not mm) mm)
14270 term rest)
14271 (push mm tagsmatcher))
14272 (push (if (> (length tagsmatcher) 1)
14273 (cons 'and tagsmatcher)
14274 (car tagsmatcher))
14275 orlist)
14276 (setq tagsmatcher nil))
14277 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14278 (setq tagsmatcher
14279 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14280 ;; Make the todo matcher
14281 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14282 (setq todomatcher t)
14283 (setq orterms (org-split-string todomatch "|") orlist nil)
14284 (while (setq term (pop orterms))
14285 (while (string-match re term)
14286 (setq minus (and (match-end 1)
14287 (equal (match-string 1 term) "-"))
14288 kwd (match-string 2 term)
14289 re-p (equal (string-to-char kwd) ?{)
14290 term (substring term (match-end 0))
14291 mm (if re-p
14292 `(string-match ,(substring kwd 1 -1) todo)
14293 (list 'equal 'todo kwd))
14294 mm (if minus (list 'not mm) mm))
14295 (push mm todomatcher))
14296 (push (if (> (length todomatcher) 1)
14297 (cons 'and todomatcher)
14298 (car todomatcher))
14299 orlist)
14300 (setq todomatcher nil))
14301 (setq todomatcher (if (> (length orlist) 1)
14302 (cons 'or orlist) (car orlist))))
14304 ;; Return the string and lisp forms of the matcher
14305 (setq matcher (if todomatcher
14306 (list 'and tagsmatcher todomatcher)
14307 tagsmatcher))
14308 (when todo-only
14309 (setq matcher (list 'and '(member todo org-not-done-keywords)
14310 matcher)))
14311 (cons match0 matcher)))
14313 (defun org-tags-expand (match &optional single-as-list downcased)
14314 "Expand group tags in MATCH.
14316 This replaces every group tag in MATCH with a regexp tag search.
14317 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14318 will be replaced like this:
14320 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14321 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14322 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14324 Replacing by a regexp preserves the structure of the match.
14325 E.g., this expansion
14327 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14329 will match anything tagged with \"Lab\" and \"Home\", or tagged
14330 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14332 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14333 assumed to be a single group tag, and the function will return
14334 the list of tags in this group.
14336 When DOWNCASE is non-nil, expand downcased TAGS."
14337 (if org-group-tags
14338 (let* ((case-fold-search t)
14339 (stable org-mode-syntax-table)
14340 (tal (or org-tag-groups-alist-for-agenda
14341 org-tag-groups-alist))
14342 (tal (if downcased
14343 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14344 (tml (mapcar 'car tal))
14345 (rtnmatch match) rpl)
14346 ;; @ and _ are allowed as word-components in tags
14347 (modify-syntax-entry ?@ "w" stable)
14348 (modify-syntax-entry ?_ "w" stable)
14349 (while (and tml
14350 (with-syntax-table stable
14351 (string-match
14352 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14353 (regexp-opt tml) "\\>\\)") rtnmatch)))
14354 (let* ((dir (match-string 1 rtnmatch))
14355 (tag (match-string 2 rtnmatch))
14356 (tag (if downcased (downcase tag) tag)))
14357 (setq tml (delete tag tml))
14358 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14359 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14360 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14361 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14362 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14363 (if single-as-list
14364 (or (reverse rpl) (list rtnmatch))
14365 rtnmatch))
14366 (if single-as-list (list (if downcased (downcase match) match))
14367 match)))
14369 (defun org-op-to-function (op &optional stringp)
14370 "Turn an operator into the appropriate function."
14371 (setq op
14372 (cond
14373 ((equal op "<" ) '(< string< org-time<))
14374 ((equal op ">" ) '(> org-string> org-time>))
14375 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14376 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14377 ((member op '("=" "==")) '(= string= org-time=))
14378 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14379 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14381 (defun org<> (a b) (not (= a b)))
14382 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14383 (defun org-string>= (a b) (not (string< a b)))
14384 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14385 (defun org-string<> (a b) (not (string= a b)))
14386 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14387 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14388 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14389 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14390 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14391 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14392 (defun org-2ft (s)
14393 "Convert S to a floating point time.
14394 If S is already a number, just return it. If it is a string, parse
14395 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14396 (cond
14397 ((numberp s) s)
14398 ((stringp s)
14399 (condition-case nil
14400 (float-time (apply 'encode-time (org-parse-time-string s)))
14401 (error 0.)))
14402 (t 0.)))
14404 (defun org-time-today ()
14405 "Time in seconds today at 0:00.
14406 Returns the float number of seconds since the beginning of the
14407 epoch to the beginning of today (00:00)."
14408 (float-time (apply 'encode-time
14409 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14411 (defun org-matcher-time (s)
14412 "Interpret a time comparison value."
14413 (save-match-data
14414 (cond
14415 ((string= s "<now>") (float-time))
14416 ((string= s "<today>") (org-time-today))
14417 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14418 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14419 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14420 (+ (org-time-today)
14421 (* (string-to-number (match-string 1 s))
14422 (cdr (assoc (match-string 2 s)
14423 '(("d" . 86400.0) ("w" . 604800.0)
14424 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14425 (t (org-2ft s)))))
14427 (defun org-match-any-p (re list)
14428 "Does re match any element of list?"
14429 (setq list (mapcar (lambda (x) (string-match re x)) list))
14430 (delq nil list))
14432 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14433 (defvar org-tags-overlay (make-overlay 1 1))
14434 (org-detach-overlay org-tags-overlay)
14436 (defun org-get-local-tags-at (&optional pos)
14437 "Get a list of tags defined in the current headline."
14438 (org-get-tags-at pos 'local))
14440 (defun org-get-local-tags ()
14441 "Get a list of tags defined in the current headline."
14442 (org-get-tags-at nil 'local))
14444 (defun org-get-tags-at (&optional pos local)
14445 "Get a list of all headline tags applicable at POS.
14446 POS defaults to point. If tags are inherited, the list contains
14447 the targets in the same sequence as the headlines appear, i.e.
14448 the tags of the current headline come last.
14449 When LOCAL is non-nil, only return tags from the current headline,
14450 ignore inherited ones."
14451 (interactive)
14452 (if (and org-trust-scanner-tags
14453 (or (not pos) (equal pos (point)))
14454 (not local))
14455 org-scanner-tags
14456 (let (tags ltags lastpos parent)
14457 (save-excursion
14458 (save-restriction
14459 (widen)
14460 (goto-char (or pos (point)))
14461 (save-match-data
14462 (catch 'done
14463 (condition-case nil
14464 (progn
14465 (org-back-to-heading t)
14466 (while (not (equal lastpos (point)))
14467 (setq lastpos (point))
14468 (when (looking-at
14469 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14470 (setq ltags (org-split-string
14471 (org-match-string-no-properties 1) ":"))
14472 (when parent
14473 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14474 (setq tags (append
14475 (if parent
14476 (org-remove-uninherited-tags ltags)
14477 ltags)
14478 tags)))
14479 (or org-use-tag-inheritance (throw 'done t))
14480 (if local (throw 'done t))
14481 (or (org-up-heading-safe) (error nil))
14482 (setq parent t)))
14483 (error nil)))))
14484 (if local
14485 tags
14486 (reverse (delete-dups
14487 (reverse (append
14488 (org-remove-uninherited-tags
14489 org-file-tags) tags)))))))))
14491 (defun org-add-prop-inherited (s)
14492 (add-text-properties 0 (length s) '(inherited t) s)
14495 (defun org-toggle-tag (tag &optional onoff)
14496 "Toggle the tag TAG for the current line.
14497 If ONOFF is `on' or `off', don't toggle but set to this state."
14498 (let (res current)
14499 (save-excursion
14500 (org-back-to-heading t)
14501 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14502 (point-at-eol) t)
14503 (progn
14504 (setq current (match-string 1))
14505 (replace-match ""))
14506 (setq current ""))
14507 (setq current (nreverse (org-split-string current ":")))
14508 (cond
14509 ((eq onoff 'on)
14510 (setq res t)
14511 (or (member tag current) (push tag current)))
14512 ((eq onoff 'off)
14513 (or (not (member tag current)) (setq current (delete tag current))))
14514 (t (if (member tag current)
14515 (setq current (delete tag current))
14516 (setq res t)
14517 (push tag current))))
14518 (end-of-line 1)
14519 (if current
14520 (progn
14521 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14522 (org-set-tags nil t))
14523 (delete-horizontal-space))
14524 (run-hooks 'org-after-tags-change-hook))
14525 res))
14527 (defun org-align-tags-here (to-col)
14528 ;; Assumes that this is a headline
14529 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14530 (beginning-of-line 1)
14531 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14532 (< pos (match-beginning 2)))
14533 (progn
14534 (setq tags-l (- (match-end 2) (match-beginning 2)))
14535 (goto-char (match-beginning 1))
14536 (insert " ")
14537 (delete-region (point) (1+ (match-beginning 2)))
14538 (setq ncol (max (current-column)
14539 (1+ col)
14540 (if (> to-col 0)
14541 to-col
14542 (- (abs to-col) tags-l))))
14543 (setq p (point))
14544 (insert (make-string (- ncol (current-column)) ?\ ))
14545 (setq ncol (current-column))
14546 (when indent-tabs-mode (tabify p (point-at-eol)))
14547 (org-move-to-column (min ncol col) t nil t))
14548 (goto-char pos))))
14550 (defun org-set-tags-command (&optional arg just-align)
14551 "Call the set-tags command for the current entry."
14552 (interactive "P")
14553 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14554 (org-set-tags arg just-align)
14555 (save-excursion
14556 (unless (and (org-region-active-p)
14557 org-loop-over-headlines-in-active-region)
14558 (org-back-to-heading t))
14559 (org-set-tags arg just-align))))
14561 (defun org-set-tags-to (data)
14562 "Set the tags of the current entry to DATA, replacing the current tags.
14563 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14564 If DATA is nil or the empty string, any tags will be removed."
14565 (interactive "sTags: ")
14566 (setq data
14567 (cond
14568 ((eq data nil) "")
14569 ((equal data "") "")
14570 ((stringp data)
14571 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14572 ":"))
14573 ((listp data)
14574 (concat ":" (mapconcat 'identity data ":") ":"))))
14575 (when data
14576 (save-excursion
14577 (org-back-to-heading t)
14578 (when (looking-at org-complex-heading-regexp)
14579 (if (match-end 5)
14580 (progn
14581 (goto-char (match-beginning 5))
14582 (insert data)
14583 (delete-region (point) (point-at-eol))
14584 (org-set-tags nil 'align))
14585 (goto-char (point-at-eol))
14586 (insert " " data)
14587 (org-set-tags nil 'align)))
14588 (beginning-of-line 1)
14589 (if (looking-at ".*?\\([ \t]+\\)$")
14590 (delete-region (match-beginning 1) (match-end 1))))))
14592 (defun org-align-all-tags ()
14593 "Align the tags i all headings."
14594 (interactive)
14595 (save-excursion
14596 (or (ignore-errors (org-back-to-heading t))
14597 (outline-next-heading))
14598 (if (org-at-heading-p)
14599 (org-set-tags t)
14600 (message "No headings"))))
14602 (defvar org-indent-indentation-per-level)
14603 (defun org-set-tags (&optional arg just-align)
14604 "Set the tags for the current headline.
14605 With prefix ARG, realign all tags in headings in the current buffer.
14606 When JUST-ALIGN is non-nil, only align tags.
14607 When JUST-ALIGN is 'ignore-column, align tags without trying to set
14608 the column by ignoring invisible text."
14609 (interactive "P")
14610 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14611 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14612 'region-start-level 'region))
14613 org-loop-over-headlines-in-active-region)
14614 (org-map-entries
14615 ;; We don't use ARG and JUST-ALIGN here because these args
14616 ;; are not useful when looping over headlines.
14617 `(org-set-tags)
14618 org-loop-over-headlines-in-active-region
14619 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14620 (let* ((re org-outline-regexp-bol)
14621 (current (unless arg (org-get-tags-string)))
14622 (col (current-column))
14623 (org-setting-tags t)
14624 table current-tags inherited-tags ; computed below when needed
14625 tags p0 c0 c1 rpl di tc level)
14626 (if arg
14627 (save-excursion
14628 (goto-char (point-min))
14629 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14630 (while (re-search-forward re nil t)
14631 (org-set-tags nil t)
14632 (end-of-line 1)))
14633 (message "All tags realigned to column %d" org-tags-column))
14634 (if just-align
14635 (setq tags current)
14636 ;; Get a new set of tags from the user
14637 (save-excursion
14638 (setq table (append org-tag-persistent-alist
14639 (or org-tag-alist (org-get-buffer-tags))
14640 (and
14641 org-complete-tags-always-offer-all-agenda-tags
14642 (org-global-tags-completion-table
14643 (org-agenda-files))))
14644 org-last-tags-completion-table table
14645 current-tags (org-split-string current ":")
14646 inherited-tags (nreverse
14647 (nthcdr (length current-tags)
14648 (nreverse (org-get-tags-at))))
14649 tags
14650 (if (or (eq t org-use-fast-tag-selection)
14651 (and org-use-fast-tag-selection
14652 (delq nil (mapcar 'cdr table))))
14653 (org-fast-tag-selection
14654 current-tags inherited-tags table
14655 (if org-fast-tag-selection-include-todo
14656 org-todo-key-alist))
14657 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14658 (org-trim
14659 (org-icompleting-read "Tags: "
14660 'org-tags-completion-function
14661 nil nil current 'org-tags-history))))))
14662 (while (string-match "[-+&]+" tags)
14663 ;; No boolean logic, just a list
14664 (setq tags (replace-match ":" t t tags))))
14666 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14668 (if org-tags-sort-function
14669 (setq tags (mapconcat 'identity
14670 (sort (org-split-string
14671 tags (org-re "[^[:alnum:]_@#%]+"))
14672 org-tags-sort-function) ":")))
14674 (if (string-match "\\`[\t ]*\\'" tags)
14675 (setq tags "")
14676 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14677 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14679 ;; Insert new tags at the correct column
14680 (beginning-of-line 1)
14681 (setq level (or (and (looking-at org-outline-regexp)
14682 (- (match-end 0) (point) 1))
14684 (cond
14685 ((and (equal current "") (equal tags "")))
14686 ((re-search-forward
14687 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14688 (point-at-eol) t)
14689 (if (equal tags "")
14690 (setq rpl "")
14691 (goto-char (match-beginning 0))
14692 (setq c0 (current-column)
14693 ;; compute offset for the case of org-indent-mode active
14694 di (if (org-bound-and-true-p org-indent-mode)
14695 (* (1- org-indent-indentation-per-level) (1- level))
14697 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14698 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14699 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14700 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14701 (replace-match rpl t t)
14702 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14703 tags)
14704 (t (error "Tags alignment failed")))
14705 (org-move-to-column col nil nil (not (eq just-align 'ignore-column)))
14706 (unless just-align
14707 (run-hooks 'org-after-tags-change-hook))))))
14709 (defun org-change-tag-in-region (beg end tag off)
14710 "Add or remove TAG for each entry in the region.
14711 This works in the agenda, and also in an org-mode buffer."
14712 (interactive
14713 (list (region-beginning) (region-end)
14714 (let ((org-last-tags-completion-table
14715 (if (derived-mode-p 'org-mode)
14716 (org-uniquify
14717 (delq nil (append (org-get-buffer-tags)
14718 (org-global-tags-completion-table))))
14719 (org-global-tags-completion-table))))
14720 (org-icompleting-read
14721 "Tag: " 'org-tags-completion-function nil nil nil
14722 'org-tags-history))
14723 (progn
14724 (message "[s]et or [r]emove? ")
14725 (equal (read-char-exclusive) ?r))))
14726 (if (fboundp 'deactivate-mark) (deactivate-mark))
14727 (let ((agendap (equal major-mode 'org-agenda-mode))
14728 l1 l2 m buf pos newhead (cnt 0))
14729 (goto-char end)
14730 (setq l2 (1- (org-current-line)))
14731 (goto-char beg)
14732 (setq l1 (org-current-line))
14733 (loop for l from l1 to l2 do
14734 (org-goto-line l)
14735 (setq m (get-text-property (point) 'org-hd-marker))
14736 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14737 (and agendap m))
14738 (setq buf (if agendap (marker-buffer m) (current-buffer))
14739 pos (if agendap m (point)))
14740 (with-current-buffer buf
14741 (save-excursion
14742 (save-restriction
14743 (goto-char pos)
14744 (setq cnt (1+ cnt))
14745 (org-toggle-tag tag (if off 'off 'on))
14746 (setq newhead (org-get-heading)))))
14747 (and agendap (org-agenda-change-all-lines newhead m))))
14748 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14750 (defun org-tags-completion-function (string predicate &optional flag)
14751 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14752 (confirm (lambda (x) (stringp (car x)))))
14753 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14754 (setq s1 (match-string 1 string)
14755 s2 (match-string 2 string))
14756 (setq s1 "" s2 string))
14757 (cond
14758 ((eq flag nil)
14759 ;; try completion
14760 (setq rtn (try-completion s2 ctable confirm))
14761 (if (stringp rtn)
14762 (setq rtn
14763 (concat s1 s2 (substring rtn (length s2))
14764 (if (and org-add-colon-after-tag-completion
14765 (assoc rtn ctable))
14766 ":" ""))))
14767 rtn)
14768 ((eq flag t)
14769 ;; all-completions
14770 (all-completions s2 ctable confirm))
14771 ((eq flag 'lambda)
14772 ;; exact match?
14773 (assoc s2 ctable)))))
14775 (defun org-fast-tag-insert (kwd tags face &optional end)
14776 "Insert KDW, and the TAGS, the latter with face FACE.
14777 Also insert END."
14778 (insert (format "%-12s" (concat kwd ":"))
14779 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14780 (or end "")))
14782 (defun org-fast-tag-show-exit (flag)
14783 (save-excursion
14784 (org-goto-line 3)
14785 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14786 (replace-match ""))
14787 (when flag
14788 (end-of-line 1)
14789 (org-move-to-column (- (window-width) 19) t)
14790 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14792 (defun org-set-current-tags-overlay (current prefix)
14793 "Add an overlay to CURRENT tag with PREFIX."
14794 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14795 (if (featurep 'xemacs)
14796 (org-overlay-display org-tags-overlay (concat prefix s)
14797 'secondary-selection)
14798 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14799 (org-overlay-display org-tags-overlay (concat prefix s)))))
14801 (defvar org-last-tag-selection-key nil)
14802 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14803 "Fast tag selection with single keys.
14804 CURRENT is the current list of tags in the headline, INHERITED is the
14805 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14806 possibly with grouping information. TODO-TABLE is a similar table with
14807 TODO keywords, should these have keys assigned to them.
14808 If the keys are nil, a-z are automatically assigned.
14809 Returns the new tags string, or nil to not change the current settings."
14810 (let* ((fulltable (append table todo-table))
14811 (maxlen (apply 'max (mapcar
14812 (lambda (x)
14813 (if (stringp (car x)) (string-width (car x)) 0))
14814 fulltable)))
14815 (buf (current-buffer))
14816 (expert (eq org-fast-tag-selection-single-key 'expert))
14817 (buffer-tags nil)
14818 (fwidth (+ maxlen 3 1 3))
14819 (ncol (/ (- (window-width) 4) fwidth))
14820 (i-face 'org-done)
14821 (c-face 'org-todo)
14822 tg cnt e c char c1 c2 ntable tbl rtn
14823 ov-start ov-end ov-prefix
14824 (exit-after-next org-fast-tag-selection-single-key)
14825 (done-keywords org-done-keywords)
14826 groups ingroup)
14827 (save-excursion
14828 (beginning-of-line 1)
14829 (if (looking-at
14830 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14831 (setq ov-start (match-beginning 1)
14832 ov-end (match-end 1)
14833 ov-prefix "")
14834 (setq ov-start (1- (point-at-eol))
14835 ov-end (1+ ov-start))
14836 (skip-chars-forward "^\n\r")
14837 (setq ov-prefix
14838 (concat
14839 (buffer-substring (1- (point)) (point))
14840 (if (> (current-column) org-tags-column)
14842 (make-string (- org-tags-column (current-column)) ?\ ))))))
14843 (move-overlay org-tags-overlay ov-start ov-end)
14844 (save-window-excursion
14845 (if expert
14846 (set-buffer (get-buffer-create " *Org tags*"))
14847 (delete-other-windows)
14848 (split-window-vertically)
14849 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14850 (erase-buffer)
14851 (org-set-local 'org-done-keywords done-keywords)
14852 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14853 (org-fast-tag-insert "Current" current c-face "\n\n")
14854 (org-fast-tag-show-exit exit-after-next)
14855 (org-set-current-tags-overlay current ov-prefix)
14856 (setq tbl fulltable char ?a cnt 0)
14857 (while (setq e (pop tbl))
14858 (cond
14859 ((equal (car e) :startgroup)
14860 (push '() groups) (setq ingroup t)
14861 (when (not (= cnt 0))
14862 (setq cnt 0)
14863 (insert "\n"))
14864 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14865 ((equal (car e) :endgroup)
14866 (setq ingroup nil cnt 0)
14867 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14868 ((equal e '(:newline))
14869 (when (not (= cnt 0))
14870 (setq cnt 0)
14871 (insert "\n")
14872 (setq e (car tbl))
14873 (while (equal (car tbl) '(:newline))
14874 (insert "\n")
14875 (setq tbl (cdr tbl)))))
14876 ((equal e '(:grouptags)) nil)
14878 (setq tg (copy-sequence (car e)) c2 nil)
14879 (if (cdr e)
14880 (setq c (cdr e))
14881 ;; automatically assign a character.
14882 (setq c1 (string-to-char
14883 (downcase (substring
14884 tg (if (= (string-to-char tg) ?@) 1 0)))))
14885 (if (or (rassoc c1 ntable) (rassoc c1 table))
14886 (while (or (rassoc char ntable) (rassoc char table))
14887 (setq char (1+ char)))
14888 (setq c2 c1))
14889 (setq c (or c2 char)))
14890 (if ingroup (push tg (car groups)))
14891 (setq tg (org-add-props tg nil 'face
14892 (cond
14893 ((not (assoc tg table))
14894 (org-get-todo-face tg))
14895 ((member tg current) c-face)
14896 ((member tg inherited) i-face))))
14897 (if (equal (caar tbl) :grouptags)
14898 (org-add-props tg nil 'face 'org-tag-group))
14899 (if (and (= cnt 0) (not ingroup)) (insert " "))
14900 (insert "[" c "] " tg (make-string
14901 (- fwidth 4 (length tg)) ?\ ))
14902 (push (cons tg c) ntable)
14903 (when (= (setq cnt (1+ cnt)) ncol)
14904 (insert "\n")
14905 (if ingroup (insert " "))
14906 (setq cnt 0)))))
14907 (setq ntable (nreverse ntable))
14908 (insert "\n")
14909 (goto-char (point-min))
14910 (if (not expert) (org-fit-window-to-buffer))
14911 (setq rtn
14912 (catch 'exit
14913 (while t
14914 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14915 (if (not groups) "no " "")
14916 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14917 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14918 (setq org-last-tag-selection-key c)
14919 (cond
14920 ((= c ?\r) (throw 'exit t))
14921 ((= c ?!)
14922 (setq groups (not groups))
14923 (goto-char (point-min))
14924 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14925 ((= c ?\C-c)
14926 (if (not expert)
14927 (org-fast-tag-show-exit
14928 (setq exit-after-next (not exit-after-next)))
14929 (setq expert nil)
14930 (delete-other-windows)
14931 (set-window-buffer (split-window-vertically) " *Org tags*")
14932 (org-switch-to-buffer-other-window " *Org tags*")
14933 (org-fit-window-to-buffer)))
14934 ((or (= c ?\C-g)
14935 (and (= c ?q) (not (rassoc c ntable))))
14936 (org-detach-overlay org-tags-overlay)
14937 (setq quit-flag t))
14938 ((= c ?\ )
14939 (setq current nil)
14940 (if exit-after-next (setq exit-after-next 'now)))
14941 ((= c ?\t)
14942 (condition-case nil
14943 (setq tg (org-icompleting-read
14944 "Tag: "
14945 (or buffer-tags
14946 (with-current-buffer buf
14947 (org-get-buffer-tags)))))
14948 (quit (setq tg "")))
14949 (when (string-match "\\S-" tg)
14950 (add-to-list 'buffer-tags (list tg))
14951 (if (member tg current)
14952 (setq current (delete tg current))
14953 (push tg current)))
14954 (if exit-after-next (setq exit-after-next 'now)))
14955 ((setq e (rassoc c todo-table) tg (car e))
14956 (with-current-buffer buf
14957 (save-excursion (org-todo tg)))
14958 (if exit-after-next (setq exit-after-next 'now)))
14959 ((setq e (rassoc c ntable) tg (car e))
14960 (if (member tg current)
14961 (setq current (delete tg current))
14962 (loop for g in groups do
14963 (if (member tg g)
14964 (mapc (lambda (x)
14965 (setq current (delete x current)))
14966 g)))
14967 (push tg current))
14968 (if exit-after-next (setq exit-after-next 'now))))
14970 ;; Create a sorted list
14971 (setq current
14972 (sort current
14973 (lambda (a b)
14974 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14975 (if (eq exit-after-next 'now) (throw 'exit t))
14976 (goto-char (point-min))
14977 (beginning-of-line 2)
14978 (delete-region (point) (point-at-eol))
14979 (org-fast-tag-insert "Current" current c-face)
14980 (org-set-current-tags-overlay current ov-prefix)
14981 (while (re-search-forward
14982 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14983 (setq tg (match-string 1))
14984 (add-text-properties
14985 (match-beginning 1) (match-end 1)
14986 (list 'face
14987 (cond
14988 ((member tg current) c-face)
14989 ((member tg inherited) i-face)
14990 (t (get-text-property (match-beginning 1) 'face))))))
14991 (goto-char (point-min)))))
14992 (org-detach-overlay org-tags-overlay)
14993 (if rtn
14994 (mapconcat 'identity current ":")
14995 nil))))
14997 (defun org-get-tags-string ()
14998 "Get the TAGS string in the current headline."
14999 (unless (org-at-heading-p t)
15000 (user-error "Not on a heading"))
15001 (save-excursion
15002 (beginning-of-line 1)
15003 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
15004 (org-match-string-no-properties 1)
15005 "")))
15007 (defun org-get-tags ()
15008 "Get the list of tags specified in the current headline."
15009 (org-split-string (org-get-tags-string) ":"))
15011 (defun org-get-buffer-tags ()
15012 "Get a table of all tags used in the buffer, for completion."
15013 (let (tags)
15014 (save-excursion
15015 (goto-char (point-min))
15016 (while (re-search-forward
15017 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
15018 (when (equal (char-after (point-at-bol 0)) ?*)
15019 (mapc (lambda (x) (add-to-list 'tags x))
15020 (org-split-string (org-match-string-no-properties 1) ":")))))
15021 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
15022 (mapcar 'list tags)))
15024 ;;;; The mapping API
15026 (defun org-map-entries (func &optional match scope &rest skip)
15027 "Call FUNC at each headline selected by MATCH in SCOPE.
15029 FUNC is a function or a lisp form. The function will be called without
15030 arguments, with the cursor positioned at the beginning of the headline.
15031 The return values of all calls to the function will be collected and
15032 returned as a list.
15034 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15035 does not need to preserve point. After evaluation, the cursor will be
15036 moved to the end of the line (presumably of the headline of the
15037 processed entry) and search continues from there. Under some
15038 circumstances, this may not produce the wanted results. For example,
15039 if you have removed (e.g. archived) the current (sub)tree it could
15040 mean that the next entry will be skipped entirely. In such cases, you
15041 can specify the position from where search should continue by making
15042 FUNC set the variable `org-map-continue-from' to the desired buffer
15043 position.
15045 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15046 Only headlines that are matched by this query will be considered during
15047 the iteration. When MATCH is nil or t, all headlines will be
15048 visited by the iteration.
15050 SCOPE determines the scope of this command. It can be any of:
15052 nil The current buffer, respecting the restriction if any
15053 tree The subtree started with the entry at point
15054 region The entries within the active region, if any
15055 region-start-level
15056 The entries within the active region, but only those at
15057 the same level than the first one.
15058 file The current buffer, without restriction
15059 file-with-archives
15060 The current buffer, and any archives associated with it
15061 agenda All agenda files
15062 agenda-with-archives
15063 All agenda files with any archive files associated with them
15064 \(file1 file2 ...)
15065 If this is a list, all files in the list will be scanned
15067 The remaining args are treated as settings for the skipping facilities of
15068 the scanner. The following items can be given here:
15070 archive skip trees with the archive tag
15071 comment skip trees with the COMMENT keyword
15072 function or Emacs Lisp form:
15073 will be used as value for `org-agenda-skip-function', so
15074 whenever the function returns a position, FUNC will not be
15075 called for that entry and search will continue from the
15076 position returned
15078 If your function needs to retrieve the tags including inherited tags
15079 at the *current* entry, you can use the value of the variable
15080 `org-scanner-tags' which will be much faster than getting the value
15081 with `org-get-tags-at'. If your function gets properties with
15082 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15083 to t around the call to `org-entry-properties' to get the same speedup.
15084 Note that if your function moves around to retrieve tags and properties at
15085 a *different* entry, you cannot use these techniques."
15086 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15087 (not (org-region-active-p)))
15088 (let* ((org-agenda-archives-mode nil) ; just to make sure
15089 (org-agenda-skip-archived-trees (memq 'archive skip))
15090 (org-agenda-skip-comment-trees (memq 'comment skip))
15091 (org-agenda-skip-function
15092 (car (org-delete-all '(comment archive) skip)))
15093 (org-tags-match-list-sublevels t)
15094 (start-level (eq scope 'region-start-level))
15095 matcher file res
15096 org-todo-keywords-for-agenda
15097 org-done-keywords-for-agenda
15098 org-todo-keyword-alist-for-agenda
15099 org-tag-alist-for-agenda
15100 todo-only)
15102 (cond
15103 ((eq match t) (setq matcher t))
15104 ((eq match nil) (setq matcher t))
15105 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15107 (save-window-excursion
15108 (save-restriction
15109 (cond ((eq scope 'tree)
15110 (org-back-to-heading t)
15111 (org-narrow-to-subtree)
15112 (setq scope nil))
15113 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15114 (org-region-active-p))
15115 ;; If needed, set start-level to a string like "2"
15116 (when start-level
15117 (save-excursion
15118 (goto-char (region-beginning))
15119 (unless (org-at-heading-p) (outline-next-heading))
15120 (setq start-level (org-current-level))))
15121 (narrow-to-region (region-beginning)
15122 (save-excursion
15123 (goto-char (region-end))
15124 (unless (and (bolp) (org-at-heading-p))
15125 (outline-next-heading))
15126 (point)))
15127 (setq scope nil)))
15129 (if (not scope)
15130 (progn
15131 (org-agenda-prepare-buffers
15132 (list (buffer-file-name (current-buffer))))
15133 (setq res (org-scan-tags func matcher todo-only start-level)))
15134 ;; Get the right scope
15135 (cond
15136 ((and scope (listp scope) (symbolp (car scope)))
15137 (setq scope (eval scope)))
15138 ((eq scope 'agenda)
15139 (setq scope (org-agenda-files t)))
15140 ((eq scope 'agenda-with-archives)
15141 (setq scope (org-agenda-files t))
15142 (setq scope (org-add-archive-files scope)))
15143 ((eq scope 'file)
15144 (setq scope (list (buffer-file-name))))
15145 ((eq scope 'file-with-archives)
15146 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15147 (org-agenda-prepare-buffers scope)
15148 (while (setq file (pop scope))
15149 (with-current-buffer (org-find-base-buffer-visiting file)
15150 (save-excursion
15151 (save-restriction
15152 (widen)
15153 (goto-char (point-min))
15154 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15155 res)))
15157 ;;;; Properties
15159 ;;; Setting and retrieving properties
15161 (defconst org-special-properties
15162 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15163 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15164 "The special properties valid in Org-mode.
15166 These are properties that are not defined in the property drawer,
15167 but in some other way.")
15169 (defconst org-default-properties
15170 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15171 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15172 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15173 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15174 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15175 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15176 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15177 "Some properties that are used by Org-mode for various purposes.
15178 Being in this list makes sure that they are offered for completion.")
15180 (defun org-property-action ()
15181 "Do an action on properties."
15182 (interactive)
15183 (let (c)
15184 (org-at-property-p)
15185 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15186 (setq c (read-char-exclusive))
15187 (cond
15188 ((equal c ?s)
15189 (call-interactively 'org-set-property))
15190 ((equal c ?d)
15191 (call-interactively 'org-delete-property))
15192 ((equal c ?D)
15193 (call-interactively 'org-delete-property-globally))
15194 ((equal c ?c)
15195 (call-interactively 'org-compute-property-at-point))
15196 (t (user-error "No such property action %c" c)))))
15198 (defun org-inc-effort ()
15199 "Increment the value of the effort property in the current entry."
15200 (interactive)
15201 (org-set-effort nil t))
15203 (defvar org-clock-effort) ;; Defined in org-clock.el
15204 (defvar org-clock-current-task) ;; Defined in org-clock.el
15205 (defun org-set-effort (&optional value increment)
15206 "Set the effort property of the current entry.
15207 With numerical prefix arg, use the nth allowed value, 0 stands for the
15208 10th allowed value.
15210 When INCREMENT is non-nil, set the property to the next allowed value."
15211 (interactive "P")
15212 (if (equal value 0) (setq value 10))
15213 (let* ((completion-ignore-case t)
15214 (prop org-effort-property)
15215 (cur (org-entry-get nil prop))
15216 (allowed (org-property-get-allowed-values nil prop 'table))
15217 (existing (mapcar 'list (org-property-values prop)))
15218 (heading (nth 4 (org-heading-components)))
15220 (val (cond
15221 ((stringp value) value)
15222 ((and allowed (integerp value))
15223 (or (car (nth (1- value) allowed))
15224 (car (org-last allowed))))
15225 ((and allowed increment)
15226 (or (caadr (member (list cur) allowed))
15227 (user-error "Allowed effort values are not set")))
15228 (allowed
15229 (message "Select 1-9,0, [RET%s]: %s"
15230 (if cur (concat "=" cur) "")
15231 (mapconcat 'car allowed " "))
15232 (setq rpl (read-char-exclusive))
15233 (if (equal rpl ?\r)
15235 (setq rpl (- rpl ?0))
15236 (if (equal rpl 0) (setq rpl 10))
15237 (if (and (> rpl 0) (<= rpl (length allowed)))
15238 (car (nth (1- rpl) allowed))
15239 (org-completing-read "Effort: " allowed nil))))
15241 (let (org-completion-use-ido org-completion-use-iswitchb)
15242 (org-completing-read
15243 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15244 (concat "[" cur "]") "")
15245 ": ")
15246 existing nil nil "" nil cur))))))
15247 (unless (equal (org-entry-get nil prop) val)
15248 (org-entry-put nil prop val))
15249 (save-excursion
15250 (org-back-to-heading t)
15251 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15252 (when (string= heading org-clock-current-task)
15253 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15254 (org-clock-update-mode-line))
15255 (message "%s is now %s" prop val)))
15257 (defun org-at-property-p ()
15258 "Is cursor inside a property drawer?"
15259 (save-excursion
15260 (when (equal 'node-property (car (org-element-at-point)))
15261 (beginning-of-line 1)
15262 (looking-at org-property-re))))
15264 (defun org-get-property-block (&optional beg end force)
15265 "Return the (beg . end) range of the body of the property drawer.
15266 BEG and END are the beginning and end of the current subtree, or of
15267 the part before the first headline. If they are not given, they will
15268 be found. If the drawer does not exist and FORCE is non-nil, create
15269 the drawer."
15270 (catch 'exit
15271 (save-excursion
15272 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15273 (progn (org-back-to-heading t) (point))))
15274 (end (or end (and (not (outline-next-heading)) (point-max))
15275 (point))))
15276 (goto-char beg)
15277 (if (re-search-forward org-property-start-re end t)
15278 (setq beg (1+ (match-end 0)))
15279 (if force
15280 (save-excursion
15281 (org-insert-property-drawer)
15282 (setq end (progn (outline-next-heading) (point))))
15283 (throw 'exit nil))
15284 (goto-char beg)
15285 (if (re-search-forward org-property-start-re end t)
15286 (setq beg (1+ (match-end 0)))))
15287 (if (re-search-forward org-property-end-re end t)
15288 (setq end (match-beginning 0))
15289 (or force (throw 'exit nil))
15290 (goto-char beg)
15291 (setq end beg)
15292 (org-indent-line)
15293 (insert ":END:\n"))
15294 (cons beg end)))))
15296 (defun org-entry-properties (&optional pom which specific)
15297 "Get all properties of the entry at point-or-marker POM.
15298 This includes the TODO keyword, the tags, time strings for deadline,
15299 scheduled, and clocking, and any additional properties defined in the
15300 entry. The return value is an alist, keys may occur multiple times
15301 if the property key was used several times.
15302 POM may also be nil, in which case the current entry is used.
15303 If WHICH is nil or `all', get all properties. If WHICH is
15304 `special' or `standard', only get that subclass. If WHICH
15305 is a string only get exactly this property. SPECIFIC can be a string, the
15306 specific property we are interested in. Specifying it can speed
15307 things up because then unnecessary parsing is avoided."
15308 (setq which (or which 'all))
15309 (org-with-wide-buffer
15310 (org-with-point-at pom
15311 (let ((clockstr (substring org-clock-string 0 -1))
15312 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15313 (case-fold-search nil)
15314 beg end range props sum-props key key1 value string clocksum clocksumt)
15315 (when (and (derived-mode-p 'org-mode)
15316 (ignore-errors (org-back-to-heading t)))
15317 (setq beg (point))
15318 (setq sum-props (get-text-property (point) 'org-summaries))
15319 (setq clocksum (get-text-property (point) :org-clock-minutes)
15320 clocksumt (get-text-property (point) :org-clock-minutes-today))
15321 (outline-next-heading)
15322 (setq end (point))
15323 (when (memq which '(all special))
15324 ;; Get the special properties, like TODO and tags
15325 (goto-char beg)
15326 (when (and (or (not specific) (string= specific "TODO"))
15327 (looking-at org-todo-line-regexp) (match-end 2))
15328 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15329 (when (and (or (not specific) (string= specific "PRIORITY"))
15330 (looking-at org-priority-regexp))
15331 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15332 (when (or (not specific) (string= specific "FILE"))
15333 (push (cons "FILE" buffer-file-name) props))
15334 (when (and (or (not specific) (string= specific "TAGS"))
15335 (setq value (org-get-tags-string))
15336 (string-match "\\S-" value))
15337 (push (cons "TAGS" value) props))
15338 (when (and (or (not specific) (string= specific "ALLTAGS"))
15339 (setq value (org-get-tags-at)))
15340 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15341 ":"))
15342 props))
15343 (when (or (not specific) (string= specific "BLOCKED"))
15344 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15345 (when (or (not specific)
15346 (member specific
15347 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15348 "TIMESTAMP" "TIMESTAMP_IA")))
15349 (catch 'match
15350 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15351 (setq key (if (match-end 1)
15352 (substring (org-match-string-no-properties 1)
15353 0 -1))
15354 string (if (equal key clockstr)
15355 (org-trim
15356 (buffer-substring-no-properties
15357 (match-beginning 3) (goto-char
15358 (point-at-eol))))
15359 (substring (org-match-string-no-properties 3)
15360 1 -1)))
15361 ;; Get the correct property name from the key. This is
15362 ;; necessary if the user has configured time keywords.
15363 (setq key1 (concat key ":"))
15364 (cond
15365 ((not key)
15366 (setq key
15367 (if (= (char-after (match-beginning 3)) ?\[)
15368 "TIMESTAMP_IA" "TIMESTAMP")))
15369 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15370 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15371 ((equal key1 org-closed-string) (setq key "CLOSED"))
15372 ((equal key1 org-clock-string) (setq key "CLOCK")))
15373 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15374 (progn
15375 (push (cons key string) props)
15376 ;; no need to search further if match is found
15377 (throw 'match t))
15378 (when (or (equal key "CLOCK") (not (assoc key props)))
15379 (push (cons key string) props)))))))
15381 (when (memq which '(all standard))
15382 ;; Get the standard properties, like :PROP: ...
15383 (setq range (org-get-property-block beg end))
15384 (when range
15385 (goto-char (car range))
15386 (while (re-search-forward org-property-re
15387 (cdr range) t)
15388 (setq key (org-match-string-no-properties 2)
15389 value (org-trim (or (org-match-string-no-properties 3) "")))
15390 (unless (member key excluded)
15391 (push (cons key (or value "")) props)))))
15392 (if clocksum
15393 (push (cons "CLOCKSUM"
15394 (org-columns-number-to-string (/ (float clocksum) 60.)
15395 'add_times))
15396 props))
15397 (if clocksumt
15398 (push (cons "CLOCKSUM_T"
15399 (org-columns-number-to-string (/ (float clocksumt) 60.)
15400 'add_times))
15401 props))
15402 (unless (assoc "CATEGORY" props)
15403 (push (cons "CATEGORY" (org-get-category)) props))
15404 (append sum-props (nreverse props)))))))
15406 (defun org-entry-get (pom property &optional inherit literal-nil)
15407 "Get value of PROPERTY for entry or content at point-or-marker POM.
15408 If INHERIT is non-nil and the entry does not have the property,
15409 then also check higher levels of the hierarchy.
15410 If INHERIT is the symbol `selective', use inheritance only if the setting
15411 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15412 If the property is present but empty, the return value is the empty string.
15413 If the property is not present at all, nil is returned.
15415 Return the value as a string.
15417 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15418 do not interpret it as the list atom nil. This is used for inheritance
15419 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15420 (org-with-point-at pom
15421 (if (and inherit (if (eq inherit 'selective)
15422 (org-property-inherit-p property)
15424 (org-entry-get-with-inheritance property literal-nil)
15425 (if (member property org-special-properties)
15426 ;; We need a special property. Use `org-entry-properties'
15427 ;; to retrieve it, but specify the wanted property
15428 (cdr (assoc property (org-entry-properties nil 'special property)))
15429 (org-with-wide-buffer
15430 (let ((range (org-get-property-block)))
15431 (when (and range (not (eq (car range) (cdr range))))
15432 (let* ((props
15433 (list (or (assoc property org-file-properties)
15434 (assoc property org-global-properties)
15435 (assoc property org-global-properties-fixed))))
15436 (ap (lambda (key)
15437 (when (re-search-forward
15438 (org-re-property key) (cdr range) t)
15439 (setq props
15440 (org-update-property-plist
15442 (if (match-end 3)
15443 (org-match-string-no-properties 3) "")
15444 props)))))
15445 val)
15446 (goto-char (car range))
15447 (funcall ap property)
15448 (goto-char (car range))
15449 (while (funcall ap (concat property "+")))
15450 (setq val (cdr (assoc property props)))
15451 (when val (if literal-nil val (org-not-nil val)))))))))))
15453 (defun org-property-or-variable-value (var &optional inherit)
15454 "Check if there is a property fixing the value of VAR.
15455 If yes, return this value. If not, return the current value of the variable."
15456 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15457 (if (and prop (stringp prop) (string-match "\\S-" prop))
15458 (read prop)
15459 (symbol-value var))))
15461 (defun org-entry-delete (pom property)
15462 "Delete the property PROPERTY from entry at point-or-marker POM."
15463 (unless (member property org-special-properties)
15464 (org-with-point-at pom
15465 (let ((range (org-get-property-block)))
15466 (if (and range
15467 (goto-char (car range))
15468 (re-search-forward
15469 (org-re-property property)
15470 (cdr range) t))
15471 (progn
15472 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15473 (org-remove-empty-drawer-at (car range))
15475 nil)))))
15477 ;; Multi-values properties are properties that contain multiple values
15478 ;; These values are assumed to be single words, separated by whitespace.
15479 (defun org-entry-add-to-multivalued-property (pom property value)
15480 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15481 (let* ((old (org-entry-get pom property))
15482 (values (and old (org-split-string old "[ \t]"))))
15483 (setq value (org-entry-protect-space value))
15484 (unless (member value values)
15485 (setq values (append values (list value)))
15486 (org-entry-put pom property
15487 (mapconcat 'identity values " ")))))
15489 (defun org-entry-remove-from-multivalued-property (pom property value)
15490 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15491 (let* ((old (org-entry-get pom property))
15492 (values (and old (org-split-string old "[ \t]"))))
15493 (setq value (org-entry-protect-space value))
15494 (when (member value values)
15495 (setq values (delete value values))
15496 (org-entry-put pom property
15497 (mapconcat 'identity values " ")))))
15499 (defun org-entry-member-in-multivalued-property (pom property value)
15500 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15501 (let* ((old (org-entry-get pom property))
15502 (values (and old (org-split-string old "[ \t]"))))
15503 (setq value (org-entry-protect-space value))
15504 (member value values)))
15506 (defun org-entry-get-multivalued-property (pom property)
15507 "Return a list of values in a multivalued property."
15508 (let* ((value (org-entry-get pom property))
15509 (values (and value (org-split-string value "[ \t]"))))
15510 (mapcar 'org-entry-restore-space values)))
15512 (defun org-entry-put-multivalued-property (pom property &rest values)
15513 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15514 VALUES should be a list of strings. Spaces will be protected."
15515 (org-entry-put pom property
15516 (mapconcat 'org-entry-protect-space values " "))
15517 (let* ((value (org-entry-get pom property))
15518 (values (and value (org-split-string value "[ \t]"))))
15519 (mapcar 'org-entry-restore-space values)))
15521 (defun org-entry-protect-space (s)
15522 "Protect spaces and newline in string S."
15523 (while (string-match " " s)
15524 (setq s (replace-match "%20" t t s)))
15525 (while (string-match "\n" s)
15526 (setq s (replace-match "%0A" t t s)))
15529 (defun org-entry-restore-space (s)
15530 "Restore spaces and newline in string S."
15531 (while (string-match "%20" s)
15532 (setq s (replace-match " " t t s)))
15533 (while (string-match "%0A" s)
15534 (setq s (replace-match "\n" t t s)))
15537 (defvar org-entry-property-inherited-from (make-marker)
15538 "Marker pointing to the entry from where a property was inherited.
15539 Each call to `org-entry-get-with-inheritance' will set this marker to the
15540 location of the entry where the inheritance search matched. If there was
15541 no match, the marker will point nowhere.
15542 Note that also `org-entry-get' calls this function, if the INHERIT flag
15543 is set.")
15545 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15546 "Get PROPERTY of entry or content at point, search higher levels if needed.
15547 The search will stop at the first ancestor which has the property defined.
15548 If the value found is \"nil\", return nil to show that the property
15549 should be considered as undefined (this is the meaning of nil here).
15550 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15551 (move-marker org-entry-property-inherited-from nil)
15552 (let (tmp)
15553 (save-excursion
15554 (save-restriction
15555 (widen)
15556 (catch 'ex
15557 (while t
15558 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15559 (or (ignore-errors (org-back-to-heading t))
15560 (goto-char (point-min)))
15561 (move-marker org-entry-property-inherited-from (point))
15562 (throw 'ex tmp))
15563 (or (ignore-errors (org-up-heading-safe))
15564 (throw 'ex nil))))))
15565 (setq tmp (or tmp
15566 (cdr (assoc property org-file-properties))
15567 (cdr (assoc property org-global-properties))
15568 (cdr (assoc property org-global-properties-fixed))))
15569 (if literal-nil tmp (org-not-nil tmp))))
15571 (defvar org-property-changed-functions nil
15572 "Hook called when the value of a property has changed.
15573 Each hook function should accept two arguments, the name of the property
15574 and the new value.")
15576 (defun org-entry-put (pom property value)
15577 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15578 If the value is `nil', it is converted to the empty string.
15579 If it is not a string, an error is raised."
15580 (cond ((null value) (setq value ""))
15581 ((not (stringp value))
15582 (error "Properties values should be strings.")))
15583 (org-with-point-at pom
15584 (org-back-to-heading t)
15585 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15586 range)
15587 (cond
15588 ((equal property "TODO")
15589 (when (and (string-match "\\S-" value)
15590 (not (member value org-todo-keywords-1)))
15591 (user-error "\"%s\" is not a valid TODO state" value))
15592 (if (or (not value)
15593 (not (string-match "\\S-" value)))
15594 (setq value 'none))
15595 (org-todo value)
15596 (org-set-tags nil 'align))
15597 ((equal property "PRIORITY")
15598 (org-priority (if (and value (string-match "\\S-" value))
15599 (string-to-char value) ?\ ))
15600 (org-set-tags nil 'align))
15601 ((equal property "CLOCKSUM")
15602 (if (not (re-search-forward
15603 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15604 (error "Cannot find a clock log")
15605 (goto-char (- (match-end 1) 2))
15606 (cond
15607 ((eq value 'earlier) (org-timestamp-down))
15608 ((eq value 'later) (org-timestamp-up)))
15609 (org-clock-sum-current-item)))
15610 ((equal property "SCHEDULED")
15611 (if (re-search-forward org-scheduled-time-regexp end t)
15612 (cond
15613 ((eq value 'earlier) (org-timestamp-change -1 'day))
15614 ((eq value 'later) (org-timestamp-change 1 'day))
15615 (t (call-interactively 'org-schedule)))
15616 (call-interactively 'org-schedule)))
15617 ((equal property "DEADLINE")
15618 (if (re-search-forward org-deadline-time-regexp end t)
15619 (cond
15620 ((eq value 'earlier) (org-timestamp-change -1 'day))
15621 ((eq value 'later) (org-timestamp-change 1 'day))
15622 (t (call-interactively 'org-deadline)))
15623 (call-interactively 'org-deadline)))
15624 ((member property org-special-properties)
15625 (error "The %s property can not yet be set with `org-entry-put'"
15626 property))
15627 (t ; a non-special property
15628 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15629 (setq range (org-get-property-block beg end 'force))
15630 (goto-char (car range))
15631 (if (re-search-forward
15632 (org-re-property property) (cdr range) t)
15633 (progn
15634 (delete-region (match-beginning 0) (match-end 0))
15635 (goto-char (match-beginning 0)))
15636 (goto-char (cdr range))
15637 (insert "\n")
15638 (backward-char 1)
15639 (org-indent-line))
15640 (insert ":" property ":")
15641 (and value (insert " " value))
15642 (org-indent-line)))))
15643 (run-hook-with-args 'org-property-changed-functions property value)))
15645 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15646 "Get all property keys in the current buffer.
15647 With INCLUDE-SPECIALS, also list the special properties that reflect things
15648 like tags and TODO state.
15649 With INCLUDE-DEFAULTS, also include properties that has special meaning
15650 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15651 and others.
15652 With INCLUDE-COLUMNS, also include property names given in COLUMN
15653 formats in the current buffer."
15654 (let (rtn range cfmt s p)
15655 (save-excursion
15656 (save-restriction
15657 (widen)
15658 (goto-char (point-min))
15659 (while (re-search-forward org-property-start-re nil t)
15660 (setq range (org-get-property-block))
15661 (goto-char (car range))
15662 (while (re-search-forward org-property-re
15663 (cdr range) t)
15664 (add-to-list 'rtn (org-match-string-no-properties 2)))
15665 (outline-next-heading))))
15667 (when include-specials
15668 (setq rtn (append org-special-properties rtn)))
15670 (when include-defaults
15671 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15672 (add-to-list 'rtn org-effort-property))
15674 (when include-columns
15675 (save-excursion
15676 (save-restriction
15677 (widen)
15678 (goto-char (point-min))
15679 (while (re-search-forward
15680 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15681 nil t)
15682 (setq cfmt (match-string 2) s 0)
15683 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15684 cfmt s)
15685 (setq s (match-end 0)
15686 p (match-string 1 cfmt))
15687 (unless (or (equal p "ITEM")
15688 (member p org-special-properties))
15689 (add-to-list 'rtn (match-string 1 cfmt))))))))
15691 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15693 (defun org-property-values (key)
15694 "Return a list of all values of property KEY in the current buffer."
15695 (save-excursion
15696 (save-restriction
15697 (widen)
15698 (goto-char (point-min))
15699 (let ((re (org-re-property key))
15700 values)
15701 (while (re-search-forward re nil t)
15702 (add-to-list 'values (org-trim (match-string 3))))
15703 (delete "" values)))))
15705 (defun org-insert-property-drawer ()
15706 "Insert a property drawer into the current entry."
15707 (org-back-to-heading t)
15708 (looking-at org-outline-regexp)
15709 (let ((indent (if org-adapt-indentation
15710 (- (match-end 0) (match-beginning 0))
15712 (beg (point))
15713 (re (concat "^[ \t]*" org-keyword-time-regexp))
15714 end hiddenp)
15715 (outline-next-heading)
15716 (setq end (point))
15717 (goto-char beg)
15718 (while (re-search-forward re end t))
15719 (setq hiddenp (outline-invisible-p))
15720 (end-of-line 1)
15721 (and (equal (char-after) ?\n) (forward-char 1))
15722 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15723 (if (member (match-string 1) '("CLOCK:" ":END:"))
15724 ;; just skip this line
15725 (beginning-of-line 2)
15726 ;; Drawer start, find the end
15727 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15728 (beginning-of-line 1)))
15729 (org-skip-over-state-notes)
15730 (skip-chars-backward " \t\n\r")
15731 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15732 (forward-char 1))
15733 (goto-char (point-at-eol))
15734 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15735 (beginning-of-line 0)
15736 (org-indent-to-column indent)
15737 (beginning-of-line 2)
15738 (org-indent-to-column indent)
15739 (beginning-of-line 0)
15740 (if hiddenp
15741 (save-excursion
15742 (org-back-to-heading t)
15743 (hide-entry))
15744 (org-flag-drawer t))))
15746 (defun org-insert-drawer (&optional arg drawer)
15747 "Insert a drawer at point.
15749 Optional argument DRAWER, when non-nil, is a string representing
15750 drawer's name. Otherwise, the user is prompted for a name.
15752 If a region is active, insert the drawer around that region
15753 instead.
15755 Point is left between drawer's boundaries."
15756 (interactive "P")
15757 (let* ((drawer (if arg "PROPERTIES"
15758 (or drawer (read-from-minibuffer "Drawer: ")))))
15759 (cond
15760 ;; With C-u, fall back on `org-insert-property-drawer'
15761 (arg (org-insert-property-drawer))
15763 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
15764 (user-error "Invalid drawer name"))
15765 ;; With an active region, insert a drawer at point.
15766 ((not (org-region-active-p))
15767 (progn
15768 (unless (bolp) (insert "\n"))
15769 (insert (format ":%s:\n\n:END:\n" drawer))
15770 (forward-line -2)))
15771 ;; Otherwise, insert the drawer at point
15773 (let ((rbeg (region-beginning))
15774 (rend (copy-marker (region-end))))
15775 (unwind-protect
15776 (progn
15777 (goto-char rbeg)
15778 (beginning-of-line)
15779 (when (save-excursion
15780 (re-search-forward org-outline-regexp-bol rend t))
15781 (user-error "Drawers cannot contain headlines"))
15782 ;; Position point at the beginning of the first
15783 ;; non-blank line in region. Insert drawer's opening
15784 ;; there, then indent it.
15785 (org-skip-whitespace)
15786 (beginning-of-line)
15787 (insert ":" drawer ":\n")
15788 (forward-line -1)
15789 (indent-for-tab-command)
15790 ;; Move point to the beginning of the first blank line
15791 ;; after the last non-blank line in region. Insert
15792 ;; drawer's closing, then indent it.
15793 (goto-char rend)
15794 (skip-chars-backward " \r\t\n")
15795 (insert "\n:END:")
15796 (deactivate-mark t)
15797 (indent-for-tab-command)
15798 (unless (eolp) (insert "\n")))
15799 ;; Clear marker, whatever the outcome of insertion is.
15800 (set-marker rend nil)))))))
15802 (defvar org-property-set-functions-alist nil
15803 "Property set function alist.
15804 Each entry should have the following format:
15806 (PROPERTY . READ-FUNCTION)
15808 The read function will be called with the same argument as
15809 `org-completing-read'.")
15811 (defun org-set-property-function (property)
15812 "Get the function that should be used to set PROPERTY.
15813 This is computed according to `org-property-set-functions-alist'."
15814 (or (cdr (assoc property org-property-set-functions-alist))
15815 'org-completing-read))
15817 (defun org-read-property-value (property)
15818 "Read PROPERTY value from user."
15819 (let* ((completion-ignore-case t)
15820 (allowed (org-property-get-allowed-values nil property 'table))
15821 (cur (org-entry-get nil property))
15822 (prompt (concat property " value"
15823 (if (and cur (string-match "\\S-" cur))
15824 (concat " [" cur "]") "") ": "))
15825 (set-function (org-set-property-function property))
15826 (val (if allowed
15827 (funcall set-function prompt allowed nil
15828 (not (get-text-property 0 'org-unrestricted
15829 (caar allowed))))
15830 (let (org-completion-use-ido org-completion-use-iswitchb)
15831 (funcall set-function prompt
15832 (mapcar 'list (org-property-values property))
15833 nil nil "" nil cur)))))
15834 (if (equal val "")
15836 val)))
15838 (defvar org-last-set-property nil)
15839 (defvar org-last-set-property-value nil)
15840 (defun org-read-property-name ()
15841 "Read a property name."
15842 (let* ((completion-ignore-case t)
15843 (keys (org-buffer-property-keys nil t t))
15844 (default-prop (or (save-excursion
15845 (save-match-data
15846 (beginning-of-line)
15847 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15848 (null (string= (match-string 1) "END"))
15849 (match-string 1))))
15850 org-last-set-property))
15851 (property (org-icompleting-read
15852 (concat "Property"
15853 (if default-prop (concat " [" default-prop "]") "")
15854 ": ")
15855 (mapcar 'list keys)
15856 nil nil nil nil
15857 default-prop)))
15858 (if (member property keys)
15859 property
15860 (or (cdr (assoc (downcase property)
15861 (mapcar (lambda (x) (cons (downcase x) x))
15862 keys)))
15863 property))))
15865 (defun org-set-property-and-value (use-last)
15866 "Allow to set [PROPERTY]: [value] direction from prompt.
15867 When use-default, don't even ask, just use the last
15868 \"[PROPERTY]: [value]\" string from the history."
15869 (interactive "P")
15870 (let* ((completion-ignore-case t)
15871 (pv (or (and use-last org-last-set-property-value)
15872 (org-completing-read
15873 "Enter a \"[Property]: [value]\" pair: "
15874 nil nil nil nil nil
15875 org-last-set-property-value)))
15876 prop val)
15877 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15878 (setq prop (match-string 1 pv)
15879 val (match-string 2 pv))
15880 (org-set-property prop val))))
15882 (defun org-set-property (property value)
15883 "In the current entry, set PROPERTY to VALUE.
15884 When called interactively, this will prompt for a property name, offering
15885 completion on existing and default properties. And then it will prompt
15886 for a value, offering completion either on allowed values (via an inherited
15887 xxx_ALL property) or on existing values in other instances of this property
15888 in the current file."
15889 (interactive (list nil nil))
15890 (let* ((property (or property (org-read-property-name)))
15891 (value (or value (org-read-property-value property)))
15892 (fn (cdr (assoc property org-properties-postprocess-alist))))
15893 (setq org-last-set-property property)
15894 (setq org-last-set-property-value (concat property ": " value))
15895 ;; Possibly postprocess the inserted value:
15896 (when fn (setq value (funcall fn value)))
15897 (unless (equal (org-entry-get nil property) value)
15898 (org-entry-put nil property value))))
15900 (defun org-delete-property (property)
15901 "In the current entry, delete PROPERTY."
15902 (interactive
15903 (let* ((completion-ignore-case t)
15904 (prop (org-icompleting-read "Property: "
15905 (org-entry-properties nil 'standard))))
15906 (list prop)))
15907 (message "Property %s %s" property
15908 (if (org-entry-delete nil property)
15909 "deleted"
15910 "was not present in the entry")))
15912 (defun org-delete-property-globally (property)
15913 "Remove PROPERTY globally, from all entries."
15914 (interactive
15915 (let* ((completion-ignore-case t)
15916 (prop (org-icompleting-read
15917 "Globally remove property: "
15918 (mapcar 'list (org-buffer-property-keys)))))
15919 (list prop)))
15920 (save-excursion
15921 (save-restriction
15922 (widen)
15923 (goto-char (point-min))
15924 (let ((cnt 0))
15925 (while (re-search-forward
15926 (org-re-property property)
15927 nil t)
15928 (setq cnt (1+ cnt))
15929 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15930 (message "Property \"%s\" removed from %d entries" property cnt)))))
15932 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15934 (defun org-compute-property-at-point ()
15935 "Compute the property at point.
15936 This looks for an enclosing column format, extracts the operator and
15937 then applies it to the property in the column format's scope."
15938 (interactive)
15939 (unless (org-at-property-p)
15940 (user-error "Not at a property"))
15941 (let ((prop (org-match-string-no-properties 2)))
15942 (org-columns-get-format-and-top-level)
15943 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15944 (user-error "No operator defined for property %s" prop))
15945 (org-columns-compute prop)))
15947 (defvar org-property-allowed-value-functions nil
15948 "Hook for functions supplying allowed values for a specific property.
15949 The functions must take a single argument, the name of the property, and
15950 return a flat list of allowed values. If \":ETC\" is one of
15951 the values, this means that these values are intended as defaults for
15952 completion, but that other values should be allowed too.
15953 The functions must return nil if they are not responsible for this
15954 property.")
15956 (defun org-property-get-allowed-values (pom property &optional table)
15957 "Get allowed values for the property PROPERTY.
15958 When TABLE is non-nil, return an alist that can directly be used for
15959 completion."
15960 (let (vals)
15961 (cond
15962 ((equal property "TODO")
15963 (setq vals (org-with-point-at pom
15964 (append org-todo-keywords-1 '("")))))
15965 ((equal property "PRIORITY")
15966 (let ((n org-lowest-priority))
15967 (while (>= n org-highest-priority)
15968 (push (char-to-string n) vals)
15969 (setq n (1- n)))))
15970 ((member property org-special-properties))
15971 ((setq vals (run-hook-with-args-until-success
15972 'org-property-allowed-value-functions property)))
15974 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15975 (when (and vals (string-match "\\S-" vals))
15976 (setq vals (car (read-from-string (concat "(" vals ")"))))
15977 (setq vals (mapcar (lambda (x)
15978 (cond ((stringp x) x)
15979 ((numberp x) (number-to-string x))
15980 ((symbolp x) (symbol-name x))
15981 (t "???")))
15982 vals)))))
15983 (when (member ":ETC" vals)
15984 (setq vals (remove ":ETC" vals))
15985 (org-add-props (car vals) '(org-unrestricted t)))
15986 (if table (mapcar 'list vals) vals)))
15988 (defun org-property-previous-allowed-value (&optional previous)
15989 "Switch to the next allowed value for this property."
15990 (interactive)
15991 (org-property-next-allowed-value t))
15993 (defun org-property-next-allowed-value (&optional previous)
15994 "Switch to the next allowed value for this property."
15995 (interactive)
15996 (unless (org-at-property-p)
15997 (user-error "Not at a property"))
15998 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15999 (key (match-string 2))
16000 (value (match-string 3))
16001 (allowed (or (org-property-get-allowed-values (point) key)
16002 (and (member value '("[ ]" "[-]" "[X]"))
16003 '("[ ]" "[X]"))))
16004 (heading (save-match-data (nth 4 (org-heading-components))))
16005 nval)
16006 (unless allowed
16007 (user-error "Allowed values for this property have not been defined"))
16008 (if previous (setq allowed (reverse allowed)))
16009 (if (member value allowed)
16010 (setq nval (car (cdr (member value allowed)))))
16011 (setq nval (or nval (car allowed)))
16012 (if (equal nval value)
16013 (user-error "Only one allowed value for this property"))
16014 (org-at-property-p)
16015 (replace-match (concat " :" key ": " nval) t t)
16016 (org-indent-line)
16017 (beginning-of-line 1)
16018 (skip-chars-forward " \t")
16019 (when (equal prop org-effort-property)
16020 (save-excursion
16021 (org-back-to-heading t)
16022 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
16023 (when (string= org-clock-current-task heading)
16024 (setq org-clock-effort nval)
16025 (org-clock-update-mode-line)))
16026 (run-hook-with-args 'org-property-changed-functions key nval)))
16028 (defun org-find-olp (path &optional this-buffer)
16029 "Return a marker pointing to the entry at outline path OLP.
16030 If anything goes wrong, throw an error.
16031 You can wrap this call to catch the error like this:
16033 (condition-case msg
16034 (org-mobile-locate-entry (match-string 4))
16035 (error (nth 1 msg)))
16037 The return value will then be either a string with the error message,
16038 or a marker if everything is OK.
16040 If THIS-BUFFER is set, the outline path does not contain a file,
16041 only headings."
16042 (let* ((file (if this-buffer buffer-file-name (pop path)))
16043 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16044 (level 1)
16045 (lmin 1)
16046 (lmax 1)
16047 limit re end found pos heading cnt flevel)
16048 (unless buffer (error "File not found :%s" file))
16049 (with-current-buffer buffer
16050 (save-excursion
16051 (save-restriction
16052 (widen)
16053 (setq limit (point-max))
16054 (goto-char (point-min))
16055 (while (setq heading (pop path))
16056 (setq re (format org-complex-heading-regexp-format
16057 (regexp-quote heading)))
16058 (setq cnt 0 pos (point))
16059 (while (re-search-forward re end t)
16060 (setq level (- (match-end 1) (match-beginning 1)))
16061 (if (and (>= level lmin) (<= level lmax))
16062 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16063 (when (= cnt 0) (error "Heading not found on level %d: %s"
16064 lmax heading))
16065 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16066 lmax heading))
16067 (goto-char found)
16068 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16069 (setq end (save-excursion (org-end-of-subtree t t))))
16070 (when (org-at-heading-p)
16071 (point-marker)))))))
16073 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16074 "Find node HEADING in BUFFER.
16075 Return a marker to the heading if it was found, or nil if not.
16076 If POS-ONLY is set, return just the position instead of a marker.
16078 The heading text must match exact, but it may have a TODO keyword,
16079 a priority cookie and tags in the standard locations."
16080 (with-current-buffer (or buffer (current-buffer))
16081 (save-excursion
16082 (save-restriction
16083 (widen)
16084 (goto-char (point-min))
16085 (let (case-fold-search)
16086 (if (re-search-forward
16087 (format org-complex-heading-regexp-format
16088 (regexp-quote heading)) nil t)
16089 (if pos-only
16090 (match-beginning 0)
16091 (move-marker (make-marker) (match-beginning 0)))))))))
16093 (defun org-find-exact-heading-in-directory (heading &optional dir)
16094 "Find Org node headline HEADING in all .org files in directory DIR.
16095 When the target headline is found, return a marker to this location."
16096 (let ((files (directory-files (or dir default-directory)
16097 nil "\\`[^.#].*\\.org\\'"))
16098 file visiting m buffer)
16099 (catch 'found
16100 (while (setq file (pop files))
16101 (message "trying %s" file)
16102 (setq visiting (org-find-base-buffer-visiting file))
16103 (setq buffer (or visiting (find-file-noselect file)))
16104 (setq m (org-find-exact-headline-in-buffer
16105 heading buffer))
16106 (when (and (not m) (not visiting)) (kill-buffer buffer))
16107 (and m (throw 'found m))))))
16109 (defun org-find-entry-with-id (ident)
16110 "Locate the entry that contains the ID property with exact value IDENT.
16111 IDENT can be a string, a symbol or a number, this function will search for
16112 the string representation of it.
16113 Return the position where this entry starts, or nil if there is no such entry."
16114 (interactive "sID: ")
16115 (let ((id (cond
16116 ((stringp ident) ident)
16117 ((symbol-name ident) (symbol-name ident))
16118 ((numberp ident) (number-to-string ident))
16119 (t (error "IDENT %s must be a string, symbol or number" ident))))
16120 (case-fold-search nil))
16121 (save-excursion
16122 (save-restriction
16123 (widen)
16124 (goto-char (point-min))
16125 (when (re-search-forward
16126 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16127 nil t)
16128 (org-back-to-heading t)
16129 (point))))))
16131 ;;;; Timestamps
16133 (defvar org-last-changed-timestamp nil)
16134 (defvar org-last-inserted-timestamp nil
16135 "The last time stamp inserted with `org-insert-time-stamp'.")
16136 (defvar org-ts-what) ; dynamically scoped parameter
16138 (defun org-time-stamp (arg &optional inactive)
16139 "Prompt for a date/time and insert a time stamp.
16140 If the user specifies a time like HH:MM or if this command is
16141 called with at least one prefix argument, the time stamp contains
16142 the date and the time. Otherwise, only the date is be included.
16144 All parts of a date not specified by the user is filled in from
16145 the current date/time. So if you just press return without
16146 typing anything, the time stamp will represent the current
16147 date/time.
16149 If there is already a timestamp at the cursor, it will be
16150 modified.
16152 With two universal prefix arguments, insert an active timestamp
16153 with the current time without prompting the user.
16155 When called from lisp, the timestamp is inactive if INACTIVE is
16156 non-nil."
16157 (interactive "P")
16158 (let* ((ts nil)
16159 (default-time
16160 ;; Default time is either today, or, when entering a range,
16161 ;; the range start.
16162 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16163 (save-excursion
16164 (re-search-backward
16165 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16166 (- (point) 20) t)))
16167 (apply 'encode-time (org-parse-time-string (match-string 1)))
16168 (current-time)))
16169 (default-input (and ts (org-get-compact-tod ts)))
16170 (repeater (save-excursion
16171 (save-match-data
16172 (beginning-of-line)
16173 (when (re-search-forward
16174 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16175 (save-excursion (progn (end-of-line) (point))) t)
16176 (match-string 0)))))
16177 org-time-was-given org-end-time-was-given time)
16178 (cond
16179 ((and (org-at-timestamp-p t)
16180 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16181 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16182 (insert "--")
16183 (setq time (let ((this-command this-command))
16184 (org-read-date arg 'totime nil nil
16185 default-time default-input inactive)))
16186 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16187 ((org-at-timestamp-p t)
16188 (setq time (let ((this-command this-command))
16189 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16190 (when (org-at-timestamp-p t) ; just to get the match data
16191 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16192 (replace-match "")
16193 (setq org-last-changed-timestamp
16194 (org-insert-time-stamp
16195 time (or org-time-was-given arg)
16196 inactive nil nil (list org-end-time-was-given)))
16197 (when repeater (goto-char (1- (point))) (insert " " repeater)
16198 (setq org-last-changed-timestamp
16199 (concat (substring org-last-inserted-timestamp 0 -1)
16200 " " repeater ">"))))
16201 (message "Timestamp updated"))
16202 ((equal arg '(16))
16203 (org-insert-time-stamp (current-time) t inactive))
16205 (setq time (let ((this-command this-command))
16206 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16207 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16208 nil nil (list org-end-time-was-given))))))
16210 ;; FIXME: can we use this for something else, like computing time differences?
16211 (defun org-get-compact-tod (s)
16212 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16213 (let* ((t1 (match-string 1 s))
16214 (h1 (string-to-number (match-string 2 s)))
16215 (m1 (string-to-number (match-string 3 s)))
16216 (t2 (and (match-end 4) (match-string 5 s)))
16217 (h2 (and t2 (string-to-number (match-string 6 s))))
16218 (m2 (and t2 (string-to-number (match-string 7 s))))
16219 dh dm)
16220 (if (not t2)
16222 (setq dh (- h2 h1) dm (- m2 m1))
16223 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16224 (concat t1 "+" (number-to-string dh)
16225 (and (/= 0 dm) (format ":%02d" dm)))))))
16227 (defun org-time-stamp-inactive (&optional arg)
16228 "Insert an inactive time stamp.
16229 An inactive time stamp is enclosed in square brackets instead of angle
16230 brackets. It is inactive in the sense that it does not trigger agenda entries,
16231 does not link to the calendar and cannot be changed with the S-cursor keys.
16232 So these are more for recording a certain time/date."
16233 (interactive "P")
16234 (org-time-stamp arg 'inactive))
16236 (defvar org-date-ovl (make-overlay 1 1))
16237 (overlay-put org-date-ovl 'face 'org-date-selected)
16238 (org-detach-overlay org-date-ovl)
16240 (defvar org-ans1) ; dynamically scoped parameter
16241 (defvar org-ans2) ; dynamically scoped parameter
16243 (defvar org-plain-time-of-day-regexp) ; defined below
16245 (defvar org-overriding-default-time nil) ; dynamically scoped
16246 (defvar org-read-date-overlay nil)
16247 (defvar org-dcst nil) ; dynamically scoped
16248 (defvar org-read-date-history nil)
16249 (defvar org-read-date-final-answer nil)
16250 (defvar org-read-date-analyze-futurep nil)
16251 (defvar org-read-date-analyze-forced-year nil)
16252 (defvar org-read-date-inactive)
16254 (defvar org-read-date-minibuffer-local-map
16255 (let* ((org-replace-disputed-keys nil)
16256 (map (make-sparse-keymap)))
16257 (set-keymap-parent map minibuffer-local-map)
16258 (org-defkey map (kbd ".")
16259 (lambda () (interactive)
16260 ;; Are we at the beginning of the prompt?
16261 (if (looking-back "^[^:]+: ")
16262 (org-eval-in-calendar '(calendar-goto-today))
16263 (insert "."))))
16264 (org-defkey map (kbd "C-.")
16265 (lambda () (interactive)
16266 (org-eval-in-calendar '(calendar-goto-today))))
16267 (org-defkey map [(meta shift left)]
16268 (lambda () (interactive)
16269 (org-eval-in-calendar '(calendar-backward-month 1))))
16270 (org-defkey map [(meta shift right)]
16271 (lambda () (interactive)
16272 (org-eval-in-calendar '(calendar-forward-month 1))))
16273 (org-defkey map [(meta shift up)]
16274 (lambda () (interactive)
16275 (org-eval-in-calendar '(calendar-backward-year 1))))
16276 (org-defkey map [(meta shift down)]
16277 (lambda () (interactive)
16278 (org-eval-in-calendar '(calendar-forward-year 1))))
16279 (org-defkey map [?\e (shift left)]
16280 (lambda () (interactive)
16281 (org-eval-in-calendar '(calendar-backward-month 1))))
16282 (org-defkey map [?\e (shift right)]
16283 (lambda () (interactive)
16284 (org-eval-in-calendar '(calendar-forward-month 1))))
16285 (org-defkey map [?\e (shift up)]
16286 (lambda () (interactive)
16287 (org-eval-in-calendar '(calendar-backward-year 1))))
16288 (org-defkey map [?\e (shift down)]
16289 (lambda () (interactive)
16290 (org-eval-in-calendar '(calendar-forward-year 1))))
16291 (org-defkey map [(shift up)]
16292 (lambda () (interactive)
16293 (org-eval-in-calendar '(calendar-backward-week 1))))
16294 (org-defkey map [(shift down)]
16295 (lambda () (interactive)
16296 (org-eval-in-calendar '(calendar-forward-week 1))))
16297 (org-defkey map [(shift left)]
16298 (lambda () (interactive)
16299 (org-eval-in-calendar '(calendar-backward-day 1))))
16300 (org-defkey map [(shift right)]
16301 (lambda () (interactive)
16302 (org-eval-in-calendar '(calendar-forward-day 1))))
16303 (org-defkey map "!"
16304 (lambda () (interactive)
16305 (org-eval-in-calendar '(diary-view-entries))
16306 (message "")))
16307 (org-defkey map ">"
16308 (lambda () (interactive)
16309 (org-eval-in-calendar '(scroll-calendar-left 1))))
16310 (org-defkey map "<"
16311 (lambda () (interactive)
16312 (org-eval-in-calendar '(scroll-calendar-right 1))))
16313 (org-defkey map "\C-v"
16314 (lambda () (interactive)
16315 (org-eval-in-calendar
16316 '(calendar-scroll-left-three-months 1))))
16317 (org-defkey map "\M-v"
16318 (lambda () (interactive)
16319 (org-eval-in-calendar
16320 '(calendar-scroll-right-three-months 1))))
16321 map)
16322 "Keymap for minibuffer commands when using `org-read-date'.")
16324 (defvar org-def)
16325 (defvar org-defdecode)
16326 (defvar org-with-time)
16328 (defun org-read-date (&optional org-with-time to-time from-string prompt
16329 default-time default-input inactive)
16330 "Read a date, possibly a time, and make things smooth for the user.
16331 The prompt will suggest to enter an ISO date, but you can also enter anything
16332 which will at least partially be understood by `parse-time-string'.
16333 Unrecognized parts of the date will default to the current day, month, year,
16334 hour and minute. If this command is called to replace a timestamp at point,
16335 or to enter the second timestamp of a range, the default time is taken
16336 from the existing stamp. Furthermore, the command prefers the future,
16337 so if you are giving a date where the year is not given, and the day-month
16338 combination is already past in the current year, it will assume you
16339 mean next year. For details, see the manual. A few examples:
16341 3-2-5 --> 2003-02-05
16342 feb 15 --> currentyear-02-15
16343 2/15 --> currentyear-02-15
16344 sep 12 9 --> 2009-09-12
16345 12:45 --> today 12:45
16346 22 sept 0:34 --> currentyear-09-22 0:34
16347 12 --> currentyear-currentmonth-12
16348 Fri --> nearest Friday after today
16349 -Tue --> last Tuesday
16350 etc.
16352 Furthermore you can specify a relative date by giving, as the *first* thing
16353 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16354 change in days weeks, months, years.
16355 With a single plus or minus, the date is relative to today. With a double
16356 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16357 +4d --> four days from today
16358 +4 --> same as above
16359 +2w --> two weeks from today
16360 ++5 --> five days from default date
16362 The function understands only English month and weekday abbreviations.
16364 While prompting, a calendar is popped up - you can also select the
16365 date with the mouse (button 1). The calendar shows a period of three
16366 months. To scroll it to other months, use the keys `>' and `<'.
16367 If you don't like the calendar, turn it off with
16368 \(setq org-read-date-popup-calendar nil)
16370 With optional argument TO-TIME, the date will immediately be converted
16371 to an internal time.
16372 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16373 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16374 still enter a time, and this function will inform the calling routine
16375 about this change. The calling routine may then choose to change the
16376 format used to insert the time stamp into the buffer to include the time.
16377 With optional argument FROM-STRING, read from this string instead from
16378 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16379 the time/date that is used for everything that is not specified by the
16380 user."
16381 (require 'parse-time)
16382 (let* ((org-time-stamp-rounding-minutes
16383 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16384 (org-dcst org-display-custom-times)
16385 (ct (org-current-time))
16386 (org-def (or org-overriding-default-time default-time ct))
16387 (org-defdecode (decode-time org-def))
16388 (dummy (progn
16389 (when (< (nth 2 org-defdecode) org-extend-today-until)
16390 (setcar (nthcdr 2 org-defdecode) -1)
16391 (setcar (nthcdr 1 org-defdecode) 59)
16392 (setq org-def (apply 'encode-time org-defdecode)
16393 org-defdecode (decode-time org-def)))))
16394 (mouse-autoselect-window nil) ; Don't let the mouse jump
16395 (calendar-frame-setup nil)
16396 (calendar-setup nil)
16397 (calendar-move-hook nil)
16398 (calendar-view-diary-initially-flag nil)
16399 (calendar-view-holidays-initially-flag nil)
16400 (timestr (format-time-string
16401 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16402 (prompt (concat (if prompt (concat prompt " ") "")
16403 (format "Date+time [%s]: " timestr)))
16404 ans (org-ans0 "") org-ans1 org-ans2 final)
16406 (cond
16407 (from-string (setq ans from-string))
16408 (org-read-date-popup-calendar
16409 (save-excursion
16410 (save-window-excursion
16411 (calendar)
16412 (org-eval-in-calendar '(setq cursor-type nil) t)
16413 (unwind-protect
16414 (progn
16415 (calendar-forward-day (- (time-to-days org-def)
16416 (calendar-absolute-from-gregorian
16417 (calendar-current-date))))
16418 (org-eval-in-calendar nil t)
16419 (let* ((old-map (current-local-map))
16420 (map (copy-keymap calendar-mode-map))
16421 (minibuffer-local-map
16422 (copy-keymap org-read-date-minibuffer-local-map)))
16423 (org-defkey map (kbd "RET") 'org-calendar-select)
16424 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16425 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16426 (unwind-protect
16427 (progn
16428 (use-local-map map)
16429 (setq org-read-date-inactive inactive)
16430 (add-hook 'post-command-hook 'org-read-date-display)
16431 (setq org-ans0 (read-string prompt default-input
16432 'org-read-date-history nil))
16433 ;; org-ans0: from prompt
16434 ;; org-ans1: from mouse click
16435 ;; org-ans2: from calendar motion
16436 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16437 (remove-hook 'post-command-hook 'org-read-date-display)
16438 (use-local-map old-map)
16439 (when org-read-date-overlay
16440 (delete-overlay org-read-date-overlay)
16441 (setq org-read-date-overlay nil)))))
16442 (bury-buffer "*Calendar*")))))
16444 (t ; Naked prompt only
16445 (unwind-protect
16446 (setq ans (read-string prompt default-input
16447 'org-read-date-history timestr))
16448 (when org-read-date-overlay
16449 (delete-overlay org-read-date-overlay)
16450 (setq org-read-date-overlay nil)))))
16452 (setq final (org-read-date-analyze ans org-def org-defdecode))
16454 (when org-read-date-analyze-forced-year
16455 (message "Year was forced into %s"
16456 (if org-read-date-force-compatible-dates
16457 "compatible range (1970-2037)"
16458 "range representable on this machine"))
16459 (ding))
16461 ;; One round trip to get rid of 34th of August and stuff like that....
16462 (setq final (decode-time (apply 'encode-time final)))
16464 (setq org-read-date-final-answer ans)
16466 (if to-time
16467 (apply 'encode-time final)
16468 (if (and (boundp 'org-time-was-given) org-time-was-given)
16469 (format "%04d-%02d-%02d %02d:%02d"
16470 (nth 5 final) (nth 4 final) (nth 3 final)
16471 (nth 2 final) (nth 1 final))
16472 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16474 (defun org-read-date-display ()
16475 "Display the current date prompt interpretation in the minibuffer."
16476 (when org-read-date-display-live
16477 (when org-read-date-overlay
16478 (delete-overlay org-read-date-overlay))
16479 (when (minibufferp (current-buffer))
16480 (save-excursion
16481 (end-of-line 1)
16482 (while (not (equal (buffer-substring
16483 (max (point-min) (- (point) 4)) (point))
16484 " "))
16485 (insert " ")))
16486 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16487 " " (or org-ans1 org-ans2)))
16488 (org-end-time-was-given nil)
16489 (f (org-read-date-analyze ans org-def org-defdecode))
16490 (fmts (if org-dcst
16491 org-time-stamp-custom-formats
16492 org-time-stamp-formats))
16493 (fmt (if (or org-with-time
16494 (and (boundp 'org-time-was-given) org-time-was-given))
16495 (cdr fmts)
16496 (car fmts)))
16497 (txt (format-time-string fmt (apply 'encode-time f)))
16498 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16499 (txt (concat "=> " txt)))
16500 (when (and org-end-time-was-given
16501 (string-match org-plain-time-of-day-regexp txt))
16502 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16503 org-end-time-was-given
16504 (substring txt (match-end 0)))))
16505 (when org-read-date-analyze-futurep
16506 (setq txt (concat txt " (=>F)")))
16507 (setq org-read-date-overlay
16508 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16509 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16511 (defun org-read-date-analyze (ans org-def org-defdecode)
16512 "Analyze the combined answer of the date prompt."
16513 ;; FIXME: cleanup and comment
16514 (let ((nowdecode (decode-time (current-time)))
16515 delta deltan deltaw deltadef year month day
16516 hour minute second wday pm h2 m2 tl wday1
16517 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16518 (setq org-read-date-analyze-futurep nil
16519 org-read-date-analyze-forced-year nil)
16520 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16521 (setq ans "+0"))
16523 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16524 (setq ans (replace-match "" t t ans)
16525 deltan (car delta)
16526 deltaw (nth 1 delta)
16527 deltadef (nth 2 delta)))
16529 ;; Check if there is an iso week date in there. If yes, store the
16530 ;; info and postpone interpreting it until the rest of the parsing
16531 ;; is done.
16532 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16533 (setq iso-year (if (match-end 1)
16534 (org-small-year-to-year
16535 (string-to-number (match-string 1 ans))))
16536 iso-weekday (if (match-end 3)
16537 (string-to-number (match-string 3 ans)))
16538 iso-week (string-to-number (match-string 2 ans)))
16539 (setq ans (replace-match "" t t ans)))
16541 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16542 (when (string-match
16543 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16544 (setq year (if (match-end 2)
16545 (string-to-number (match-string 2 ans))
16546 (progn (setq kill-year t)
16547 (string-to-number (format-time-string "%Y"))))
16548 month (string-to-number (match-string 3 ans))
16549 day (string-to-number (match-string 4 ans)))
16550 (if (< year 100) (setq year (+ 2000 year)))
16551 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16552 t nil ans)))
16554 ;; Help matching dotted european dates
16555 (when (string-match
16556 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16557 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16558 (setq kill-year t)
16559 (string-to-number (format-time-string "%Y")))
16560 day (string-to-number (match-string 1 ans))
16561 month (string-to-number (match-string 2 ans))
16562 ans (replace-match (format "%04d-%02d-%02d" year month day)
16563 t nil ans)))
16565 ;; Help matching american dates, like 5/30 or 5/30/7
16566 (when (string-match
16567 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16568 (setq year (if (match-end 4)
16569 (string-to-number (match-string 4 ans))
16570 (progn (setq kill-year t)
16571 (string-to-number (format-time-string "%Y"))))
16572 month (string-to-number (match-string 1 ans))
16573 day (string-to-number (match-string 2 ans)))
16574 (if (< year 100) (setq year (+ 2000 year)))
16575 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16576 t nil ans)))
16577 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16578 ;; If there is a time with am/pm, and *no* time without it, we convert
16579 ;; so that matching will be successful.
16580 (loop for i from 1 to 2 do ; twice, for end time as well
16581 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16582 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16583 (setq hour (string-to-number (match-string 1 ans))
16584 minute (if (match-end 3)
16585 (string-to-number (match-string 3 ans))
16587 pm (equal ?p
16588 (string-to-char (downcase (match-string 4 ans)))))
16589 (if (and (= hour 12) (not pm))
16590 (setq hour 0)
16591 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16592 (setq ans (replace-match (format "%02d:%02d" hour minute)
16593 t t ans))))
16595 ;; Check if a time range is given as a duration
16596 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16597 (setq hour (string-to-number (match-string 1 ans))
16598 h2 (+ hour (string-to-number (match-string 3 ans)))
16599 minute (string-to-number (match-string 2 ans))
16600 m2 (+ minute (if (match-end 5) (string-to-number
16601 (match-string 5 ans))0)))
16602 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16603 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16604 t t ans)))
16606 ;; Check if there is a time range
16607 (when (boundp 'org-end-time-was-given)
16608 (setq org-time-was-given nil)
16609 (when (and (string-match org-plain-time-of-day-regexp ans)
16610 (match-end 8))
16611 (setq org-end-time-was-given (match-string 8 ans))
16612 (setq ans (concat (substring ans 0 (match-beginning 7))
16613 (substring ans (match-end 7))))))
16615 (setq tl (parse-time-string ans)
16616 day (or (nth 3 tl) (nth 3 org-defdecode))
16617 month (or (nth 4 tl)
16618 (if (and org-read-date-prefer-future
16619 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16620 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16621 (nth 4 org-defdecode)))
16622 year (or (and (not kill-year) (nth 5 tl))
16623 (if (and org-read-date-prefer-future
16624 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16625 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16626 (nth 5 org-defdecode)))
16627 hour (or (nth 2 tl) (nth 2 org-defdecode))
16628 minute (or (nth 1 tl) (nth 1 org-defdecode))
16629 second (or (nth 0 tl) 0)
16630 wday (nth 6 tl))
16632 (when (and (eq org-read-date-prefer-future 'time)
16633 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16634 (equal day (nth 3 nowdecode))
16635 (equal month (nth 4 nowdecode))
16636 (equal year (nth 5 nowdecode))
16637 (nth 2 tl)
16638 (or (< (nth 2 tl) (nth 2 nowdecode))
16639 (and (= (nth 2 tl) (nth 2 nowdecode))
16640 (nth 1 tl)
16641 (< (nth 1 tl) (nth 1 nowdecode)))))
16642 (setq day (1+ day)
16643 futurep t))
16645 ;; Special date definitions below
16646 (cond
16647 (iso-week
16648 ;; There was an iso week
16649 (require 'cal-iso)
16650 (setq futurep nil)
16651 (setq year (or iso-year year)
16652 day (or iso-weekday wday 1)
16653 wday nil ; to make sure that the trigger below does not match
16654 iso-date (calendar-gregorian-from-absolute
16655 (calendar-absolute-from-iso
16656 (list iso-week day year))))
16657 ; FIXME: Should we also push ISO weeks into the future?
16658 ; (when (and org-read-date-prefer-future
16659 ; (not iso-year)
16660 ; (< (calendar-absolute-from-gregorian iso-date)
16661 ; (time-to-days (current-time))))
16662 ; (setq year (1+ year)
16663 ; iso-date (calendar-gregorian-from-absolute
16664 ; (calendar-absolute-from-iso
16665 ; (list iso-week day year)))))
16666 (setq month (car iso-date)
16667 year (nth 2 iso-date)
16668 day (nth 1 iso-date)))
16669 (deltan
16670 (setq futurep nil)
16671 (unless deltadef
16672 (let ((now (decode-time (current-time))))
16673 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16674 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16675 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16676 ((equal deltaw "m") (setq month (+ month deltan)))
16677 ((equal deltaw "y") (setq year (+ year deltan)))))
16678 ((and wday (not (nth 3 tl)))
16679 ;; Weekday was given, but no day, so pick that day in the week
16680 ;; on or after the derived date.
16681 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16682 (unless (equal wday wday1)
16683 (setq day (+ day (% (- wday wday1 -7) 7))))))
16684 (if (and (boundp 'org-time-was-given)
16685 (nth 2 tl))
16686 (setq org-time-was-given t))
16687 (if (< year 100) (setq year (+ 2000 year)))
16688 ;; Check of the date is representable
16689 (if org-read-date-force-compatible-dates
16690 (progn
16691 (if (< year 1970)
16692 (setq year 1970 org-read-date-analyze-forced-year t))
16693 (if (> year 2037)
16694 (setq year 2037 org-read-date-analyze-forced-year t)))
16695 (condition-case nil
16696 (ignore (encode-time second minute hour day month year))
16697 (error
16698 (setq year (nth 5 org-defdecode))
16699 (setq org-read-date-analyze-forced-year t))))
16700 (setq org-read-date-analyze-futurep futurep)
16701 (list second minute hour day month year)))
16703 (defvar parse-time-weekdays)
16704 (defun org-read-date-get-relative (s today default)
16705 "Check string S for special relative date string.
16706 TODAY and DEFAULT are internal times, for today and for a default.
16707 Return shift list (N what def-flag)
16708 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16709 N is the number of WHATs to shift.
16710 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16711 the DEFAULT date rather than TODAY."
16712 (require 'parse-time)
16713 (when (and
16714 (string-match
16715 (concat
16716 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16717 "\\([0-9]+\\)?"
16718 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16719 "\\([ \t]\\|$\\)") s)
16720 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16721 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16722 (string-to-char (substring (match-string 1 s) -1))
16723 ?+))
16724 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16725 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16726 (what (if (match-end 3) (match-string 3 s) "d"))
16727 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16728 (date (if rel default today))
16729 (wday (nth 6 (decode-time date)))
16730 delta)
16731 (if wday1
16732 (progn
16733 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16734 (if (= delta 0) (setq delta 7))
16735 (if (= dir ?-)
16736 (progn
16737 (setq delta (- delta 7))
16738 (if (= delta 0) (setq delta -7))))
16739 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16740 (list delta "d" rel))
16741 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16743 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16744 "Turn a user-specified date into the internal representation.
16745 The internal representation needed by the calendar is (month day year).
16746 This is a wrapper to handle the brain-dead convention in calendar that
16747 user function argument order change dependent on argument order."
16748 (if (boundp 'calendar-date-style)
16749 (cond
16750 ((eq calendar-date-style 'american)
16751 (list arg1 arg2 arg3))
16752 ((eq calendar-date-style 'european)
16753 (list arg2 arg1 arg3))
16754 ((eq calendar-date-style 'iso)
16755 (list arg2 arg3 arg1)))
16756 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16757 (if (org-bound-and-true-p european-calendar-style)
16758 (list arg2 arg1 arg3)
16759 (list arg1 arg2 arg3)))))
16761 (defun org-eval-in-calendar (form &optional keepdate)
16762 "Eval FORM in the calendar window and return to current window.
16763 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16764 otherwise stick to the current value of `org-ans2'."
16765 (let ((sf (selected-frame))
16766 (sw (selected-window)))
16767 (select-window (get-buffer-window "*Calendar*" t))
16768 (eval form)
16769 (when (and (not keepdate) (calendar-cursor-to-date))
16770 (let* ((date (calendar-cursor-to-date))
16771 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16772 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16773 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16774 (select-window sw)
16775 (org-select-frame-set-input-focus sf)))
16777 (defun org-calendar-select ()
16778 "Return to `org-read-date' with the date currently selected.
16779 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16780 (interactive)
16781 (when (calendar-cursor-to-date)
16782 (let* ((date (calendar-cursor-to-date))
16783 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16784 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16785 (if (active-minibuffer-window) (exit-minibuffer))))
16787 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16788 "Insert a date stamp for the date given by the internal TIME.
16789 WITH-HM means use the stamp format that includes the time of the day.
16790 INACTIVE means use square brackets instead of angular ones, so that the
16791 stamp will not contribute to the agenda.
16792 PRE and POST are optional strings to be inserted before and after the
16793 stamp.
16794 The command returns the inserted time stamp."
16795 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16796 stamp)
16797 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16798 (insert-before-markers (or pre ""))
16799 (when (listp extra)
16800 (setq extra (car extra))
16801 (if (and (stringp extra)
16802 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16803 (setq extra (format "-%02d:%02d"
16804 (string-to-number (match-string 1 extra))
16805 (string-to-number (match-string 2 extra))))
16806 (setq extra nil)))
16807 (when extra
16808 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16809 (insert-before-markers (setq stamp (format-time-string fmt time)))
16810 (insert-before-markers (or post ""))
16811 (setq org-last-inserted-timestamp stamp)))
16813 (defun org-toggle-time-stamp-overlays ()
16814 "Toggle the use of custom time stamp formats."
16815 (interactive)
16816 (setq org-display-custom-times (not org-display-custom-times))
16817 (unless org-display-custom-times
16818 (let ((p (point-min)) (bmp (buffer-modified-p)))
16819 (while (setq p (next-single-property-change p 'display))
16820 (if (and (get-text-property p 'display)
16821 (eq (get-text-property p 'face) 'org-date))
16822 (remove-text-properties
16823 p (setq p (next-single-property-change p 'display))
16824 '(display t))))
16825 (set-buffer-modified-p bmp)))
16826 (if (featurep 'xemacs)
16827 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16828 (org-restart-font-lock)
16829 (setq org-table-may-need-update t)
16830 (if org-display-custom-times
16831 (message "Time stamps are overlaid with custom format")
16832 (message "Time stamp overlays removed")))
16834 (defun org-display-custom-time (beg end)
16835 "Overlay modified time stamp format over timestamp between BEG and END."
16836 (let* ((ts (buffer-substring beg end))
16837 t1 w1 with-hm tf time str w2 (off 0))
16838 (save-match-data
16839 (setq t1 (org-parse-time-string ts t))
16840 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16841 (setq off (- (match-end 0) (match-beginning 0)))))
16842 (setq end (- end off))
16843 (setq w1 (- end beg)
16844 with-hm (and (nth 1 t1) (nth 2 t1))
16845 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16846 time (org-fix-decoded-time t1)
16847 str (org-add-props
16848 (format-time-string
16849 (substring tf 1 -1) (apply 'encode-time time))
16850 nil 'mouse-face 'highlight)
16851 w2 (length str))
16852 (if (not (= w2 w1))
16853 (add-text-properties (1+ beg) (+ 2 beg)
16854 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16855 (if (featurep 'xemacs)
16856 (progn
16857 (put-text-property beg end 'invisible t)
16858 (put-text-property beg end 'end-glyph (make-glyph str)))
16859 (put-text-property beg end 'display str))))
16861 (defun org-translate-time (string)
16862 "Translate all timestamps in STRING to custom format.
16863 But do this only if the variable `org-display-custom-times' is set."
16864 (when org-display-custom-times
16865 (save-match-data
16866 (let* ((start 0)
16867 (re org-ts-regexp-both)
16868 t1 with-hm inactive tf time str beg end)
16869 (while (setq start (string-match re string start))
16870 (setq beg (match-beginning 0)
16871 end (match-end 0)
16872 t1 (save-match-data
16873 (org-parse-time-string (substring string beg end) t))
16874 with-hm (and (nth 1 t1) (nth 2 t1))
16875 inactive (equal (substring string beg (1+ beg)) "[")
16876 tf (funcall (if with-hm 'cdr 'car)
16877 org-time-stamp-custom-formats)
16878 time (org-fix-decoded-time t1)
16879 str (format-time-string
16880 (concat
16881 (if inactive "[" "<") (substring tf 1 -1)
16882 (if inactive "]" ">"))
16883 (apply 'encode-time time))
16884 string (replace-match str t t string)
16885 start (+ start (length str)))))))
16886 string)
16888 (defun org-fix-decoded-time (time)
16889 "Set 0 instead of nil for the first 6 elements of time.
16890 Don't touch the rest."
16891 (let ((n 0))
16892 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16894 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16896 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16897 "Difference between TIMESTAMP-STRING and now in days.
16898 If SECONDS is non-nil, return the difference in seconds."
16899 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16900 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16901 (funcall fdiff (current-time)))))
16903 (defun org-deadline-close (timestamp-string &optional ndays)
16904 "Is the time in TIMESTAMP-STRING close to the current date?"
16905 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16906 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16907 (not (org-entry-is-done-p))))
16909 (defun org-get-wdays (ts &optional delay zero-delay)
16910 "Get the deadline lead time appropriate for timestring TS.
16911 When DELAY is non-nil, get the delay time for scheduled items
16912 instead of the deadline lead time. When ZERO-DELAY is non-nil
16913 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16914 don't try to find the delay cookie in the scheduled timestamp."
16915 (let ((tv (if delay org-scheduled-delay-days
16916 org-deadline-warning-days)))
16917 (cond
16918 ((or (and delay (< tv 0))
16919 (and delay zero-delay (<= tv 0))
16920 (and (not delay) (<= tv 0)))
16921 ;; Enforce this value no matter what
16922 (- tv))
16923 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16924 ;; lead time is specified.
16925 (floor (* (string-to-number (match-string 1 ts))
16926 (cdr (assoc (match-string 2 ts)
16927 '(("d" . 1) ("w" . 7)
16928 ("m" . 30.4) ("y" . 365.25)
16929 ("h" . 0.041667)))))))
16930 ;; go for the default.
16931 (t tv))))
16933 (defun org-calendar-select-mouse (ev)
16934 "Return to `org-read-date' with the date currently selected.
16935 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16936 (interactive "e")
16937 (mouse-set-point ev)
16938 (when (calendar-cursor-to-date)
16939 (let* ((date (calendar-cursor-to-date))
16940 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16941 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16942 (if (active-minibuffer-window) (exit-minibuffer))))
16944 (defun org-check-deadlines (ndays)
16945 "Check if there are any deadlines due or past due.
16946 A deadline is considered due if it happens within `org-deadline-warning-days'
16947 days from today's date. If the deadline appears in an entry marked DONE,
16948 it is not shown. The prefix arg NDAYS can be used to test that many
16949 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16950 (interactive "P")
16951 (let* ((org-warn-days
16952 (cond
16953 ((equal ndays '(4)) 100000)
16954 (ndays (prefix-numeric-value ndays))
16955 (t (abs org-deadline-warning-days))))
16956 (case-fold-search nil)
16957 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16958 (callback
16959 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16961 (message "%d deadlines past-due or due within %d days"
16962 (org-occur regexp nil callback)
16963 org-warn-days)))
16965 (defsubst org-re-timestamp (type)
16966 "Return a regexp for timestamp TYPE.
16967 Allowed values for TYPE are:
16969 all: all timestamps
16970 active: only active timestamps (<...>)
16971 inactive: only inactive timestamps ([...])
16972 scheduled: only scheduled timestamps
16973 deadline: only deadline timestamps
16974 closed: only closed time-stamps
16976 When TYPE is nil, fall back on returning a regexp that matches
16977 both scheduled and deadline timestamps."
16978 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16979 ((eq type 'active) org-ts-regexp)
16980 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16981 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16982 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16983 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16984 ((eq type 'scheduled-or-deadline)
16985 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16987 (defun org-check-before-date (date)
16988 "Check if there are deadlines or scheduled entries before DATE."
16989 (interactive (list (org-read-date)))
16990 (let ((case-fold-search nil)
16991 (regexp (org-re-timestamp org-ts-type))
16992 (callback
16993 (lambda () (time-less-p
16994 (org-time-string-to-time (match-string 1))
16995 (org-time-string-to-time date)))))
16996 (message "%d entries before %s"
16997 (org-occur regexp nil callback) date)))
16999 (defun org-check-after-date (date)
17000 "Check if there are deadlines or scheduled entries after DATE."
17001 (interactive (list (org-read-date)))
17002 (let ((case-fold-search nil)
17003 (regexp (org-re-timestamp org-ts-type))
17004 (callback
17005 (lambda () (not
17006 (time-less-p
17007 (org-time-string-to-time (match-string 1))
17008 (org-time-string-to-time date))))))
17009 (message "%d entries after %s"
17010 (org-occur regexp nil callback) date)))
17012 (defun org-check-dates-range (start-date end-date)
17013 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
17014 (interactive (list (org-read-date nil nil nil "Range starts")
17015 (org-read-date nil nil nil "Range end")))
17016 (let ((case-fold-search nil)
17017 (regexp (org-re-timestamp org-ts-type))
17018 (callback
17019 (lambda ()
17020 (let ((match (match-string 1)))
17021 (and
17022 (not (time-less-p
17023 (org-time-string-to-time match)
17024 (org-time-string-to-time start-date)))
17025 (time-less-p
17026 (org-time-string-to-time match)
17027 (org-time-string-to-time end-date)))))))
17028 (message "%d entries between %s and %s"
17029 (org-occur regexp nil callback) start-date end-date)))
17031 (defun org-evaluate-time-range (&optional to-buffer)
17032 "Evaluate a time range by computing the difference between start and end.
17033 Normally the result is just printed in the echo area, but with prefix arg
17034 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17035 If the time range is actually in a table, the result is inserted into the
17036 next column.
17037 For time difference computation, a year is assumed to be exactly 365
17038 days in order to avoid rounding problems."
17039 (interactive "P")
17041 (org-clock-update-time-maybe)
17042 (save-excursion
17043 (unless (org-at-date-range-p t)
17044 (goto-char (point-at-bol))
17045 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17046 (if (not (org-at-date-range-p t))
17047 (user-error "Not at a time-stamp range, and none found in current line")))
17048 (let* ((ts1 (match-string 1))
17049 (ts2 (match-string 2))
17050 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17051 (match-end (match-end 0))
17052 (time1 (org-time-string-to-time ts1))
17053 (time2 (org-time-string-to-time ts2))
17054 (t1 (org-float-time time1))
17055 (t2 (org-float-time time2))
17056 (diff (abs (- t2 t1)))
17057 (negative (< (- t2 t1) 0))
17058 ;; (ys (floor (* 365 24 60 60)))
17059 (ds (* 24 60 60))
17060 (hs (* 60 60))
17061 (fy "%dy %dd %02d:%02d")
17062 (fy1 "%dy %dd")
17063 (fd "%dd %02d:%02d")
17064 (fd1 "%dd")
17065 (fh "%02d:%02d")
17066 y d h m align)
17067 (if havetime
17068 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17070 d (floor (/ diff ds)) diff (mod diff ds)
17071 h (floor (/ diff hs)) diff (mod diff hs)
17072 m (floor (/ diff 60)))
17073 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17075 d (floor (+ (/ diff ds) 0.5))
17076 h 0 m 0))
17077 (if (not to-buffer)
17078 (message "%s" (org-make-tdiff-string y d h m))
17079 (if (org-at-table-p)
17080 (progn
17081 (goto-char match-end)
17082 (setq align t)
17083 (and (looking-at " *|") (goto-char (match-end 0))))
17084 (goto-char match-end))
17085 (if (looking-at
17086 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17087 (replace-match ""))
17088 (if negative (insert " -"))
17089 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17090 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17091 (insert " " (format fh h m))))
17092 (if align (org-table-align))
17093 (message "Time difference inserted")))))
17095 (defun org-make-tdiff-string (y d h m)
17096 (let ((fmt "")
17097 (l nil))
17098 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17099 l (push y l)))
17100 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17101 l (push d l)))
17102 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17103 l (push h l)))
17104 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17105 l (push m l)))
17106 (apply 'format fmt (nreverse l))))
17108 (defun org-time-string-to-time (s &optional buffer pos)
17109 "Convert a timestamp string into internal time."
17110 (condition-case errdata
17111 (apply 'encode-time (org-parse-time-string s))
17112 (error (error "Bad timestamp `%s'%s\nError was: %s"
17113 s (if (not (and buffer pos))
17115 (format " at %d in buffer `%s'" pos buffer))
17116 (cdr errdata)))))
17118 (defun org-time-string-to-seconds (s)
17119 "Convert a timestamp string to a number of seconds."
17120 (org-float-time (org-time-string-to-time s)))
17122 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17123 "Convert a time stamp to an absolute day number.
17124 If there is a specifier for a cyclic time stamp, get the closest
17125 date to DAYNR.
17126 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17127 The variable `date' is bound by the calendar when this is called."
17128 (cond
17129 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17130 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17131 daynr
17132 (+ daynr 1000)))
17133 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17134 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17135 (time-to-days (current-time))) (match-string 0 s)
17136 prefer show-all))
17137 (t (time-to-days
17138 (condition-case errdata
17139 (apply 'encode-time (org-parse-time-string s))
17140 (error (error "Bad timestamp `%s'%s\nError was: %s"
17141 s (if (not (and buffer pos))
17143 (format " at %d in buffer `%s'" pos buffer))
17144 (cdr errdata))))))))
17146 (defun org-days-to-iso-week (days)
17147 "Return the iso week number."
17148 (require 'cal-iso)
17149 (car (calendar-iso-from-absolute days)))
17151 (defun org-small-year-to-year (year)
17152 "Convert 2-digit years into 4-digit years.
17153 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17154 The year 2000 cannot be abbreviated. Any year larger than 99
17155 is returned unchanged."
17156 (if (< year 38)
17157 (setq year (+ 2000 year))
17158 (if (< year 100)
17159 (setq year (+ 1900 year))))
17160 year)
17162 (defun org-time-from-absolute (d)
17163 "Return the time corresponding to date D.
17164 D may be an absolute day number, or a calendar-type list (month day year)."
17165 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17166 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17168 (defun org-calendar-holiday ()
17169 "List of holidays, for Diary display in Org-mode."
17170 (require 'holidays)
17171 (let ((hl (funcall
17172 (if (fboundp 'calendar-check-holidays)
17173 'calendar-check-holidays 'check-calendar-holidays) date)))
17174 (if hl (mapconcat 'identity hl "; "))))
17176 (defun org-diary-sexp-entry (sexp entry date)
17177 "Process a SEXP diary ENTRY for DATE."
17178 (require 'diary-lib)
17179 (let ((result (if calendar-debug-sexp
17180 (let ((stack-trace-on-error t))
17181 (eval (car (read-from-string sexp))))
17182 (condition-case nil
17183 (eval (car (read-from-string sexp)))
17184 (error
17185 (beep)
17186 (message "Bad sexp at line %d in %s: %s"
17187 (org-current-line)
17188 (buffer-file-name) sexp)
17189 (sleep-for 2))))))
17190 (cond ((stringp result) (split-string result "; "))
17191 ((and (consp result)
17192 (not (consp (cdr result)))
17193 (stringp (cdr result))) (cdr result))
17194 ((and (consp result)
17195 (stringp (car result))) result)
17196 (result entry))))
17198 (defun org-diary-to-ical-string (frombuf)
17199 "Get iCalendar entries from diary entries in buffer FROMBUF.
17200 This uses the icalendar.el library."
17201 (let* ((tmpdir (if (featurep 'xemacs)
17202 (temp-directory)
17203 temporary-file-directory))
17204 (tmpfile (make-temp-name
17205 (expand-file-name "orgics" tmpdir)))
17206 buf rtn b e)
17207 (with-current-buffer frombuf
17208 (icalendar-export-region (point-min) (point-max) tmpfile)
17209 (setq buf (find-buffer-visiting tmpfile))
17210 (set-buffer buf)
17211 (goto-char (point-min))
17212 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17213 (setq b (match-beginning 0)))
17214 (goto-char (point-max))
17215 (if (re-search-backward "^END:VEVENT" nil t)
17216 (setq e (match-end 0)))
17217 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17218 (kill-buffer buf)
17219 (delete-file tmpfile)
17220 rtn))
17222 (defun org-closest-date (start current change prefer show-all)
17223 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17224 When PREFER is `past', return a date that is either CURRENT or past.
17225 When PREFER is `future', return a date that is either CURRENT or future.
17226 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17227 ;; Make the proper lists from the dates
17228 (catch 'exit
17229 (let ((a1 '(("h" . hour)
17230 ("d" . day)
17231 ("w" . week)
17232 ("m" . month)
17233 ("y" . year)))
17234 (shour (nth 2 (org-parse-time-string start)))
17235 dn dw sday cday n1 n2 n0
17236 d m y y1 y2 date1 date2 nmonths nm ny m2)
17238 (setq start (org-date-to-gregorian start)
17239 current (org-date-to-gregorian
17240 (if show-all
17241 current
17242 (time-to-days (current-time))))
17243 sday (calendar-absolute-from-gregorian start)
17244 cday (calendar-absolute-from-gregorian current))
17246 (if (<= cday sday) (throw 'exit sday))
17248 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17249 (setq dn (string-to-number (match-string 1 change))
17250 dw (cdr (assoc (match-string 2 change) a1)))
17251 (user-error "Invalid change specifier: %s" change))
17252 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17253 (cond
17254 ((eq dw 'hour)
17255 (let ((missing-hours
17256 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17257 dn)))
17258 (setq n1 (if (zerop missing-hours) cday
17259 (- cday (1+ (floor (/ missing-hours 24)))))
17260 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17261 ((eq dw 'day)
17262 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17263 n2 (+ n1 dn)))
17264 ((eq dw 'year)
17265 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17266 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17267 (setq date1 (list m d y1)
17268 n1 (calendar-absolute-from-gregorian date1)
17269 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17270 n2 (calendar-absolute-from-gregorian date2)))
17271 ((eq dw 'month)
17272 ;; approx number of month between the two dates
17273 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17274 ;; How often does dn fit in there?
17275 (setq d (nth 1 start) m (car start) y (nth 2 start)
17276 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17277 m (+ m nm)
17278 ny (floor (/ m 12))
17279 y (+ y ny)
17280 m (- m (* ny 12)))
17281 (while (> m 12) (setq m (- m 12) y (1+ y)))
17282 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17283 (setq m2 (+ m dn) y2 y)
17284 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17285 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17286 (while (<= n2 cday)
17287 (setq n1 n2 m m2 y y2)
17288 (setq m2 (+ m dn) y2 y)
17289 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17290 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17291 ;; Make sure n1 is the earlier date
17292 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17293 (if show-all
17294 (cond
17295 ((eq prefer 'past) (if (= cday n2) n2 n1))
17296 ((eq prefer 'future) (if (= cday n1) n1 n2))
17297 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17298 (cond
17299 ((eq prefer 'past) (if (= cday n2) n2 n1))
17300 ((eq prefer 'future) (if (= cday n1) n1 n2))
17301 (t (if (= cday n1) n1 n2)))))))
17303 (defun org-date-to-gregorian (date)
17304 "Turn any specification of DATE into a Gregorian date for the calendar."
17305 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17306 ((and (listp date) (= (length date) 3)) date)
17307 ((stringp date)
17308 (setq date (org-parse-time-string date))
17309 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17310 ((listp date)
17311 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17313 (defun org-parse-time-string (s &optional nodefault)
17314 "Parse the standard Org-mode time string.
17315 This should be a lot faster than the normal `parse-time-string'.
17316 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17317 hour and minute fields will be nil if not given."
17318 (cond ((string-match org-ts-regexp0 s)
17319 (list 0
17320 (if (or (match-beginning 8) (not nodefault))
17321 (string-to-number (or (match-string 8 s) "0")))
17322 (if (or (match-beginning 7) (not nodefault))
17323 (string-to-number (or (match-string 7 s) "0")))
17324 (string-to-number (match-string 4 s))
17325 (string-to-number (match-string 3 s))
17326 (string-to-number (match-string 2 s))
17327 nil nil nil))
17328 ((string-match "^<[^>]+>$" s)
17329 (decode-time (seconds-to-time (org-matcher-time s))))
17330 (t (error "Not a standard Org-mode time string: %s" s))))
17332 (defun org-timestamp-up (&optional arg)
17333 "Increase the date item at the cursor by one.
17334 If the cursor is on the year, change the year. If it is on the month,
17335 the day or the time, change that.
17336 With prefix ARG, change by that many units."
17337 (interactive "p")
17338 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17340 (defun org-timestamp-down (&optional arg)
17341 "Decrease the date item at the cursor by one.
17342 If the cursor is on the year, change the year. If it is on the month,
17343 the day or the time, change that.
17344 With prefix ARG, change by that many units."
17345 (interactive "p")
17346 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17348 (defun org-timestamp-up-day (&optional arg)
17349 "Increase the date in the time stamp by one day.
17350 With prefix ARG, change that many days."
17351 (interactive "p")
17352 (if (and (not (org-at-timestamp-p t))
17353 (org-at-heading-p))
17354 (org-todo 'up)
17355 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17357 (defun org-timestamp-down-day (&optional arg)
17358 "Decrease the date in the time stamp by one day.
17359 With prefix ARG, change that many days."
17360 (interactive "p")
17361 (if (and (not (org-at-timestamp-p t))
17362 (org-at-heading-p))
17363 (org-todo 'down)
17364 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17366 (defun org-at-timestamp-p (&optional inactive-ok)
17367 "Determine if the cursor is in or at a timestamp."
17368 (interactive)
17369 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17370 (pos (point))
17371 (ans (or (looking-at tsr)
17372 (save-excursion
17373 (skip-chars-backward "^[<\n\r\t")
17374 (if (> (point) (point-min)) (backward-char 1))
17375 (and (looking-at tsr)
17376 (> (- (match-end 0) pos) -1))))))
17377 (and ans
17378 (boundp 'org-ts-what)
17379 (setq org-ts-what
17380 (cond
17381 ((= pos (match-beginning 0)) 'bracket)
17382 ;; Point is considered to be "on the bracket" whether
17383 ;; it's really on it or right after it.
17384 ((= pos (1- (match-end 0))) 'bracket)
17385 ((= pos (match-end 0)) 'after)
17386 ((org-pos-in-match-range pos 2) 'year)
17387 ((org-pos-in-match-range pos 3) 'month)
17388 ((org-pos-in-match-range pos 7) 'hour)
17389 ((org-pos-in-match-range pos 8) 'minute)
17390 ((or (org-pos-in-match-range pos 4)
17391 (org-pos-in-match-range pos 5)) 'day)
17392 ((and (> pos (or (match-end 8) (match-end 5)))
17393 (< pos (match-end 0)))
17394 (- pos (or (match-end 8) (match-end 5))))
17395 (t 'day))))
17396 ans))
17398 (defun org-toggle-timestamp-type ()
17399 "Toggle the type (<active> or [inactive]) of a time stamp."
17400 (interactive)
17401 (when (org-at-timestamp-p t)
17402 (let ((beg (match-beginning 0)) (end (match-end 0))
17403 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17404 (save-excursion
17405 (goto-char beg)
17406 (while (re-search-forward "[][<>]" end t)
17407 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17408 t t)))
17409 (message "Timestamp is now %sactive"
17410 (if (equal (char-after beg) ?<) "" "in")))))
17412 (defun org-at-clock-log-p nil
17413 "Is the cursor on the clock log line?"
17414 (save-excursion
17415 (move-beginning-of-line 1)
17416 (looking-at "^[ \t]*CLOCK:")))
17418 (defvar org-clock-history) ; defined in org-clock.el
17419 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17420 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17421 "Change the date in the time stamp at point.
17422 The date will be changed by N times WHAT. WHAT can be `day', `month',
17423 `year', `minute', `second'. If WHAT is not given, the cursor position
17424 in the timestamp determines what will be changed.
17425 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17426 (let ((origin (point)) origin-cat
17427 with-hm inactive
17428 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17429 org-ts-what
17430 extra rem
17431 ts time time0 fixnext clrgx)
17432 (if (not (org-at-timestamp-p t))
17433 (user-error "Not at a timestamp"))
17434 (if (and (not what) (eq org-ts-what 'bracket))
17435 (org-toggle-timestamp-type)
17436 ;; Point isn't on brackets. Remember the part of the time-stamp
17437 ;; the point was in. Indeed, size of time-stamps may change,
17438 ;; but point must be kept in the same category nonetheless.
17439 (setq origin-cat org-ts-what)
17440 (if (and (not what) (not (eq org-ts-what 'day))
17441 org-display-custom-times
17442 (get-text-property (point) 'display)
17443 (not (get-text-property (1- (point)) 'display)))
17444 (setq org-ts-what 'day))
17445 (setq org-ts-what (or what org-ts-what)
17446 inactive (= (char-after (match-beginning 0)) ?\[)
17447 ts (match-string 0))
17448 (replace-match "")
17449 (when (string-match
17450 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17452 (setq extra (match-string 1 ts))
17453 (if suppress-tmp-delay
17454 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17455 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17456 (setq with-hm t))
17457 (setq time0 (org-parse-time-string ts))
17458 (when (and updown
17459 (eq org-ts-what 'minute)
17460 (not current-prefix-arg))
17461 ;; This looks like s-up and s-down. Change by one rounding step.
17462 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17463 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17464 (setcar (cdr time0) (+ (nth 1 time0)
17465 (if (> n 0) (- rem) (- dm rem))))))
17466 (setq time
17467 (encode-time (or (car time0) 0)
17468 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17469 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17470 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17471 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17472 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17473 (nthcdr 6 time0)))
17474 (when (and (member org-ts-what '(hour minute))
17475 extra
17476 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17477 (setq extra (org-modify-ts-extra
17478 extra
17479 (if (eq org-ts-what 'hour) 2 5)
17480 n dm)))
17481 (when (integerp org-ts-what)
17482 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17483 (if (eq what 'calendar)
17484 (let ((cal-date (org-get-date-from-calendar)))
17485 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17486 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17487 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17488 (setcar time0 (or (car time0) 0))
17489 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17490 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17491 (setq time (apply 'encode-time time0))))
17492 ;; Insert the new time-stamp, and ensure point stays in the same
17493 ;; category as before (i.e. not after the last position in that
17494 ;; category).
17495 (let ((pos (point)))
17496 ;; Stay before inserted string. `save-excursion' is of no use.
17497 (setq org-last-changed-timestamp
17498 (org-insert-time-stamp time with-hm inactive nil nil extra))
17499 (goto-char pos))
17500 (save-match-data
17501 (looking-at org-ts-regexp3)
17502 (goto-char (cond
17503 ;; `day' category ends before `hour' if any, or at
17504 ;; the end of the day name.
17505 ((eq origin-cat 'day)
17506 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17507 ((eq origin-cat 'hour) (min (match-end 7) origin))
17508 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17509 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17510 ;; `year' and `month' have both fixed size: point
17511 ;; couldn't have moved into another part.
17512 (t origin))))
17513 ;; Update clock if on a CLOCK line.
17514 (org-clock-update-time-maybe)
17515 ;; Maybe adjust the closest clock in `org-clock-history'
17516 (when org-clock-adjust-closest
17517 (if (not (and (org-at-clock-log-p)
17518 (< 1 (length (delq nil (mapcar 'marker-position
17519 org-clock-history))))))
17520 (message "No clock to adjust")
17521 (cond ((save-excursion ; fix previous clock?
17522 (re-search-backward org-ts-regexp0 nil t)
17523 (org-looking-back (concat org-clock-string " \\[")))
17524 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17525 ((save-excursion ; fix next clock?
17526 (re-search-backward org-ts-regexp0 nil t)
17527 (looking-at (concat org-ts-regexp0 "\\] =>")))
17528 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17529 (save-window-excursion
17530 ;; Find closest clock to point, adjust the previous/next one in history
17531 (let* ((p (save-excursion (org-back-to-heading t)))
17532 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17533 (clfixnth
17534 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17535 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17536 (if (not clfixpos)
17537 (message "No clock to adjust")
17538 (save-excursion
17539 (org-goto-marker-or-bmk clfixpos)
17540 (org-show-subtree)
17541 (when (re-search-forward clrgx nil t)
17542 (goto-char (match-beginning 1))
17543 (let (org-clock-adjust-closest)
17544 (org-timestamp-change n org-ts-what updown))
17545 (message "Clock adjusted in %s for heading: %s"
17546 (file-name-nondirectory (buffer-file-name))
17547 (org-get-heading t t)))))))))
17548 ;; Try to recenter the calendar window, if any.
17549 (if (and org-calendar-follow-timestamp-change
17550 (get-buffer-window "*Calendar*" t)
17551 (memq org-ts-what '(day month year)))
17552 (org-recenter-calendar (time-to-days time))))))
17554 (defun org-modify-ts-extra (s pos n dm)
17555 "Change the different parts of the lead-time and repeat fields in timestamp."
17556 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17557 ng h m new rem)
17558 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17559 (cond
17560 ((or (org-pos-in-match-range pos 2)
17561 (org-pos-in-match-range pos 3))
17562 (setq m (string-to-number (match-string 3 s))
17563 h (string-to-number (match-string 2 s)))
17564 (if (org-pos-in-match-range pos 2)
17565 (setq h (+ h n))
17566 (setq n (* dm (org-no-warnings (signum n))))
17567 (when (not (= 0 (setq rem (% m dm))))
17568 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17569 (setq m (+ m n)))
17570 (if (< m 0) (setq m (+ m 60) h (1- h)))
17571 (if (> m 59) (setq m (- m 60) h (1+ h)))
17572 (setq h (min 24 (max 0 h)))
17573 (setq ng 1 new (format "-%02d:%02d" h m)))
17574 ((org-pos-in-match-range pos 6)
17575 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17576 ((org-pos-in-match-range pos 5)
17577 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17579 ((org-pos-in-match-range pos 9)
17580 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17581 ((org-pos-in-match-range pos 8)
17582 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17584 (when ng
17585 (setq s (concat
17586 (substring s 0 (match-beginning ng))
17588 (substring s (match-end ng))))))
17591 (defun org-recenter-calendar (date)
17592 "If the calendar is visible, recenter it to DATE."
17593 (let ((cwin (get-buffer-window "*Calendar*" t)))
17594 (when cwin
17595 (let ((calendar-move-hook nil))
17596 (with-selected-window cwin
17597 (calendar-goto-date (if (listp date) date
17598 (calendar-gregorian-from-absolute date))))))))
17600 (defun org-goto-calendar (&optional arg)
17601 "Go to the Emacs calendar at the current date.
17602 If there is a time stamp in the current line, go to that date.
17603 A prefix ARG can be used to force the current date."
17604 (interactive "P")
17605 (let ((tsr org-ts-regexp) diff
17606 (calendar-move-hook nil)
17607 (calendar-view-holidays-initially-flag nil)
17608 (calendar-view-diary-initially-flag nil))
17609 (if (or (org-at-timestamp-p)
17610 (save-excursion
17611 (beginning-of-line 1)
17612 (looking-at (concat ".*" tsr))))
17613 (let ((d1 (time-to-days (current-time)))
17614 (d2 (time-to-days
17615 (org-time-string-to-time (match-string 1)))))
17616 (setq diff (- d2 d1))))
17617 (calendar)
17618 (calendar-goto-today)
17619 (if (and diff (not arg)) (calendar-forward-day diff))))
17621 (defun org-get-date-from-calendar ()
17622 "Return a list (month day year) of date at point in calendar."
17623 (with-current-buffer "*Calendar*"
17624 (save-match-data
17625 (calendar-cursor-to-date))))
17627 (defun org-date-from-calendar ()
17628 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17629 If there is already a time stamp at the cursor position, update it."
17630 (interactive)
17631 (if (org-at-timestamp-p t)
17632 (org-timestamp-change 0 'calendar)
17633 (let ((cal-date (org-get-date-from-calendar)))
17634 (org-insert-time-stamp
17635 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17637 (defcustom org-effort-durations
17638 `(("h" . 60)
17639 ("d" . ,(* 60 8))
17640 ("w" . ,(* 60 8 5))
17641 ("m" . ,(* 60 8 5 4))
17642 ("y" . ,(* 60 8 5 40)))
17643 "Conversion factor to minutes for an effort modifier.
17645 Each entry has the form (MODIFIER . MINUTES).
17647 In an effort string, a number followed by MODIFIER is multiplied
17648 by the specified number of MINUTES to obtain an effort in
17649 minutes.
17651 For example, if the value of this variable is ((\"hours\" . 60)), then an
17652 effort string \"2hours\" is equivalent to 120 minutes."
17653 :group 'org-agenda
17654 :version "24.1"
17655 :type '(alist :key-type (string :tag "Modifier")
17656 :value-type (number :tag "Minutes")))
17658 (defun org-minutes-to-clocksum-string (m)
17659 "Format number of minutes as a clocksum string.
17660 The format is determined by `org-time-clocksum-format',
17661 `org-time-clocksum-use-fractional' and
17662 `org-time-clocksum-fractional-format' and
17663 `org-time-clocksum-use-effort-durations'."
17664 (let ((clocksum "")
17665 (m (round m)) ; Don't allow fractions of minutes
17666 h d w mo y fmt n)
17667 (setq h (if org-time-clocksum-use-effort-durations
17668 (cdr (assoc "h" org-effort-durations)) 60)
17669 d (if org-time-clocksum-use-effort-durations
17670 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17671 w (if org-time-clocksum-use-effort-durations
17672 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17673 mo (if org-time-clocksum-use-effort-durations
17674 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17675 y (if org-time-clocksum-use-effort-durations
17676 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17677 ;; fractional format
17678 (if org-time-clocksum-use-fractional
17679 (cond
17680 ;; single format string
17681 ((stringp org-time-clocksum-fractional-format)
17682 (format org-time-clocksum-fractional-format (/ m (float h))))
17683 ;; choice of fractional formats for different time units
17684 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17685 (> (/ (truncate m) (* y d h)) 0))
17686 (format fmt (/ m (* y d (float h)))))
17687 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17688 (> (/ (truncate m) (* mo d h)) 0))
17689 (format fmt (/ m (* mo d (float h)))))
17690 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17691 (> (/ (truncate m) (* w d h)) 0))
17692 (format fmt (/ m (* w d (float h)))))
17693 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17694 (> (/ (truncate m) (* d h)) 0))
17695 (format fmt (/ m (* d (float h)))))
17696 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17697 (> (/ (truncate m) h) 0))
17698 (format fmt (/ m (float h))))
17699 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17700 (format fmt m))
17701 ;; fall back to smallest time unit with a format
17702 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17703 (format fmt (/ m (float h))))
17704 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17705 (format fmt (/ m (* d (float h)))))
17706 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17707 (format fmt (/ m (* w d (float h)))))
17708 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17709 (format fmt (/ m (* mo d (float h)))))
17710 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17711 (format fmt (/ m (* y d (float h))))))
17712 ;; standard (non-fractional) format, with single format string
17713 (if (stringp org-time-clocksum-format)
17714 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17715 ;; separate formats components
17716 (and (setq fmt (plist-get org-time-clocksum-format :years))
17717 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17718 (plist-get org-time-clocksum-format :require-years))
17719 (setq clocksum (concat clocksum (format fmt n))
17720 m (- m (* n y d h))))
17721 (and (setq fmt (plist-get org-time-clocksum-format :months))
17722 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17723 (plist-get org-time-clocksum-format :require-months))
17724 (setq clocksum (concat clocksum (format fmt n))
17725 m (- m (* n mo d h))))
17726 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17727 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17728 (plist-get org-time-clocksum-format :require-weeks))
17729 (setq clocksum (concat clocksum (format fmt n))
17730 m (- m (* n w d h))))
17731 (and (setq fmt (plist-get org-time-clocksum-format :days))
17732 (or (> (setq n (/ (truncate m) (* d h))) 0)
17733 (plist-get org-time-clocksum-format :require-days))
17734 (setq clocksum (concat clocksum (format fmt n))
17735 m (- m (* n d h))))
17736 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17737 (or (> (setq n (/ (truncate m) h)) 0)
17738 (plist-get org-time-clocksum-format :require-hours))
17739 (setq clocksum (concat clocksum (format fmt n))
17740 m (- m (* n h))))
17741 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17742 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17743 (setq clocksum (concat clocksum (format fmt m))))
17744 ;; return formatted time duration
17745 clocksum))))
17747 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17748 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17749 "Org mode version 8.0")
17751 (defun org-hours-to-clocksum-string (n)
17752 (org-minutes-to-clocksum-string (* n 60)))
17754 (defun org-hh:mm-string-to-minutes (s)
17755 "Convert a string H:MM to a number of minutes.
17756 If the string is just a number, interpret it as minutes.
17757 In fact, the first hh:mm or number in the string will be taken,
17758 there can be extra stuff in the string.
17759 If no number is found, the return value is 0."
17760 (cond
17761 ((integerp s) s)
17762 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17763 (+ (* (string-to-number (match-string 1 s)) 60)
17764 (string-to-number (match-string 2 s))))
17765 ((string-match "\\([0-9]+\\)" s)
17766 (string-to-number (match-string 1 s)))
17767 (t 0)))
17769 (defcustom org-image-actual-width t
17770 "Should we use the actual width of images when inlining them?
17772 When set to `t', always use the image width.
17774 When set to a number, use imagemagick (when available) to set
17775 the image's width to this value.
17777 When set to a number in a list, try to get the width from any
17778 #+ATTR.* keyword if it matches a width specification like
17780 #+ATTR_HTML: :width 300px
17782 and fall back on that number if none is found.
17784 When set to nil, try to get the width from an #+ATTR.* keyword
17785 and fall back on the original width if none is found.
17787 This requires Emacs >= 24.1, build with imagemagick support."
17788 :group 'org-appearance
17789 :version "24.4"
17790 :package-version '(Org . "8.0")
17791 :type '(choice
17792 (const :tag "Use the image width" t)
17793 (integer :tag "Use a number of pixels")
17794 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17795 (const :tag "Use #+ATTR* or don't resize" nil)))
17797 (defcustom org-agenda-inhibit-startup nil
17798 "Inhibit startup when preparing agenda buffers.
17799 When this variable is `t' (the default), the initialization of
17800 the Org agenda buffers is inhibited: e.g. the visibility state
17801 is not set, the tables are not re-aligned, etc."
17802 :type 'boolean
17803 :version "24.3"
17804 :group 'org-agenda)
17806 (defcustom org-agenda-ignore-drawer-properties nil
17807 "Avoid updating text properties when building the agenda.
17808 Properties are used to prepare buffers for effort estimates, appointments,
17809 and subtree-local categories.
17810 If you don't use these in the agenda, you can add them to this list and
17811 agenda building will be a bit faster.
17812 The value is a list, with zero or more of the symbols `effort', `appt',
17813 or `category'."
17814 :type '(set :greedy t
17815 (const effort)
17816 (const appt)
17817 (const category))
17818 :version "24.3"
17819 :group 'org-agenda)
17821 (defun org-duration-string-to-minutes (s &optional output-to-string)
17822 "Convert a duration string S to minutes.
17824 A bare number is interpreted as minutes, modifiers can be set by
17825 customizing `org-effort-durations' (which see).
17827 Entries containing a colon are interpreted as H:MM by
17828 `org-hh:mm-string-to-minutes'."
17829 (let ((result 0)
17830 (re (concat "\\([0-9.]+\\) *\\("
17831 (regexp-opt (mapcar 'car org-effort-durations))
17832 "\\)")))
17833 (while (string-match re s)
17834 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17835 (string-to-number (match-string 1 s))))
17836 (setq s (replace-match "" nil t s)))
17837 (setq result (floor result))
17838 (incf result (org-hh:mm-string-to-minutes s))
17839 (if output-to-string (number-to-string result) result)))
17841 ;;;; Files
17843 (defun org-save-all-org-buffers ()
17844 "Save all Org-mode buffers without user confirmation."
17845 (interactive)
17846 (message "Saving all Org-mode buffers...")
17847 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17848 (when (featurep 'org-id) (org-id-locations-save))
17849 (message "Saving all Org-mode buffers... done"))
17851 (defun org-revert-all-org-buffers ()
17852 "Revert all Org-mode buffers.
17853 Prompt for confirmation when there are unsaved changes.
17854 Be sure you know what you are doing before letting this function
17855 overwrite your changes.
17857 This function is useful in a setup where one tracks org files
17858 with a version control system, to revert on one machine after pulling
17859 changes from another. I believe the procedure must be like this:
17861 1. M-x org-save-all-org-buffers
17862 2. Pull changes from the other machine, resolve conflicts
17863 3. M-x org-revert-all-org-buffers"
17864 (interactive)
17865 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17866 (user-error "Abort"))
17867 (save-excursion
17868 (save-window-excursion
17869 (mapc
17870 (lambda (b)
17871 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17872 (with-current-buffer b buffer-file-name))
17873 (org-pop-to-buffer-same-window b)
17874 (revert-buffer t 'no-confirm)))
17875 (buffer-list))
17876 (when (and (featurep 'org-id) org-id-track-globally)
17877 (org-id-locations-load)))))
17879 ;;;; Agenda files
17881 ;;;###autoload
17882 (defun org-switchb (&optional arg)
17883 "Switch between Org buffers.
17884 With one prefix argument, restrict available buffers to files.
17885 With two prefix arguments, restrict available buffers to agenda files.
17887 Defaults to `iswitchb' for buffer name completion.
17888 Set `org-completion-use-ido' to make it use ido instead."
17889 (interactive "P")
17890 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17891 ((equal arg '(16)) (org-buffer-list 'agenda))
17892 (t (org-buffer-list))))
17893 (org-completion-use-iswitchb org-completion-use-iswitchb)
17894 (org-completion-use-ido org-completion-use-ido))
17895 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17896 (setq org-completion-use-iswitchb t))
17897 (org-pop-to-buffer-same-window
17898 (org-icompleting-read "Org buffer: "
17899 (mapcar 'list (mapcar 'buffer-name blist))
17900 nil t))))
17902 ;;; Define some older names previously used for this functionality
17903 ;;;###autoload
17904 (defalias 'org-ido-switchb 'org-switchb)
17905 ;;;###autoload
17906 (defalias 'org-iswitchb 'org-switchb)
17908 (defun org-buffer-list (&optional predicate exclude-tmp)
17909 "Return a list of Org buffers.
17910 PREDICATE can be `export', `files' or `agenda'.
17912 export restrict the list to Export buffers.
17913 files restrict the list to buffers visiting Org files.
17914 agenda restrict the list to buffers visiting agenda files.
17916 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17917 (let* ((bfn nil)
17918 (agenda-files (and (eq predicate 'agenda)
17919 (mapcar 'file-truename (org-agenda-files t))))
17920 (filter
17921 (cond
17922 ((eq predicate 'files)
17923 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17924 ((eq predicate 'export)
17925 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17926 ((eq predicate 'agenda)
17927 (lambda (b)
17928 (with-current-buffer b
17929 (and (derived-mode-p 'org-mode)
17930 (setq bfn (buffer-file-name b))
17931 (member (file-truename bfn) agenda-files)))))
17932 (t (lambda (b) (with-current-buffer b
17933 (or (derived-mode-p 'org-mode)
17934 (string-match "\*Org .*Export"
17935 (buffer-name b)))))))))
17936 (delq nil
17937 (mapcar
17938 (lambda(b)
17939 (if (and (funcall filter b)
17940 (or (not exclude-tmp)
17941 (not (string-match "tmp" (buffer-name b)))))
17943 nil))
17944 (buffer-list)))))
17946 (defun org-agenda-files (&optional unrestricted archives)
17947 "Get the list of agenda files.
17948 Optional UNRESTRICTED means return the full list even if a restriction
17949 is currently in place.
17950 When ARCHIVES is t, include all archive files that are really being
17951 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17952 `org-agenda-archives-mode' is t."
17953 (let ((files
17954 (cond
17955 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17956 ((stringp org-agenda-files) (org-read-agenda-file-list))
17957 ((listp org-agenda-files) org-agenda-files)
17958 (t (error "Invalid value of `org-agenda-files'")))))
17959 (setq files (apply 'append
17960 (mapcar (lambda (f)
17961 (if (file-directory-p f)
17962 (directory-files
17963 f t org-agenda-file-regexp)
17964 (list f)))
17965 files)))
17966 (when org-agenda-skip-unavailable-files
17967 (setq files (delq nil
17968 (mapcar (function
17969 (lambda (file)
17970 (and (file-readable-p file) file)))
17971 files))))
17972 (when (or (eq archives t)
17973 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17974 (setq files (org-add-archive-files files)))
17975 files))
17977 (defun org-agenda-file-p (&optional file)
17978 "Return non-nil, if FILE is an agenda file.
17979 If FILE is omitted, use the file associated with the current
17980 buffer."
17981 (member (or file (buffer-file-name))
17982 (org-agenda-files t)))
17984 (defun org-edit-agenda-file-list ()
17985 "Edit the list of agenda files.
17986 Depending on setup, this either uses customize to edit the variable
17987 `org-agenda-files', or it visits the file that is holding the list. In the
17988 latter case, the buffer is set up in a way that saving it automatically kills
17989 the buffer and restores the previous window configuration."
17990 (interactive)
17991 (if (stringp org-agenda-files)
17992 (let ((cw (current-window-configuration)))
17993 (find-file org-agenda-files)
17994 (org-set-local 'org-window-configuration cw)
17995 (org-add-hook 'after-save-hook
17996 (lambda ()
17997 (set-window-configuration
17998 (prog1 org-window-configuration
17999 (kill-buffer (current-buffer))))
18000 (org-install-agenda-files-menu)
18001 (message "New agenda file list installed"))
18002 nil 'local)
18003 (message "%s" (substitute-command-keys
18004 "Edit list and finish with \\[save-buffer]")))
18005 (customize-variable 'org-agenda-files)))
18007 (defun org-store-new-agenda-file-list (list)
18008 "Set new value for the agenda file list and save it correctly."
18009 (if (stringp org-agenda-files)
18010 (let ((fe (org-read-agenda-file-list t)) b u)
18011 (while (setq b (find-buffer-visiting org-agenda-files))
18012 (kill-buffer b))
18013 (with-temp-file org-agenda-files
18014 (insert
18015 (mapconcat
18016 (lambda (f) ;; Keep un-expanded entries.
18017 (if (setq u (assoc f fe))
18018 (cdr u)
18020 list "\n")
18021 "\n")))
18022 (let ((org-mode-hook nil) (org-inhibit-startup t)
18023 (org-insert-mode-line-in-empty-file nil))
18024 (setq org-agenda-files list)
18025 (customize-save-variable 'org-agenda-files org-agenda-files))))
18027 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18028 "Read the list of agenda files from a file.
18029 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18030 filenames, used by `org-store-new-agenda-file-list' to write back
18031 un-expanded file names."
18032 (when (file-directory-p org-agenda-files)
18033 (error "`org-agenda-files' cannot be a single directory"))
18034 (when (stringp org-agenda-files)
18035 (with-temp-buffer
18036 (insert-file-contents org-agenda-files)
18037 (mapcar
18038 (lambda (f)
18039 (let ((e (expand-file-name (substitute-in-file-name f)
18040 org-directory)))
18041 (if pair-with-expansion
18042 (cons e f)
18043 e)))
18044 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18046 ;;;###autoload
18047 (defun org-cycle-agenda-files ()
18048 "Cycle through the files in `org-agenda-files'.
18049 If the current buffer visits an agenda file, find the next one in the list.
18050 If the current buffer does not, find the first agenda file."
18051 (interactive)
18052 (let* ((fs (org-agenda-files t))
18053 (files (append fs (list (car fs))))
18054 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18055 file)
18056 (unless files (user-error "No agenda files"))
18057 (catch 'exit
18058 (while (setq file (pop files))
18059 (if (equal (file-truename file) tcf)
18060 (when (car files)
18061 (find-file (car files))
18062 (throw 'exit t))))
18063 (find-file (car fs)))
18064 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18066 (defun org-agenda-file-to-front (&optional to-end)
18067 "Move/add the current file to the top of the agenda file list.
18068 If the file is not present in the list, it is added to the front. If it is
18069 present, it is moved there. With optional argument TO-END, add/move to the
18070 end of the list."
18071 (interactive "P")
18072 (let ((org-agenda-skip-unavailable-files nil)
18073 (file-alist (mapcar (lambda (x)
18074 (cons (file-truename x) x))
18075 (org-agenda-files t)))
18076 (ctf (file-truename
18077 (or buffer-file-name
18078 (user-error "Please save the current buffer to a file"))))
18079 x had)
18080 (setq x (assoc ctf file-alist) had x)
18082 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18083 (if to-end
18084 (setq file-alist (append (delq x file-alist) (list x)))
18085 (setq file-alist (cons x (delq x file-alist))))
18086 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18087 (org-install-agenda-files-menu)
18088 (message "File %s to %s of agenda file list"
18089 (if had "moved" "added") (if to-end "end" "front"))))
18091 (defun org-remove-file (&optional file)
18092 "Remove current file from the list of files in variable `org-agenda-files'.
18093 These are the files which are being checked for agenda entries.
18094 Optional argument FILE means use this file instead of the current."
18095 (interactive)
18096 (let* ((org-agenda-skip-unavailable-files nil)
18097 (file (or file buffer-file-name
18098 (user-error "Current buffer does not visit a file")))
18099 (true-file (file-truename file))
18100 (afile (abbreviate-file-name file))
18101 (files (delq nil (mapcar
18102 (lambda (x)
18103 (if (equal true-file
18104 (file-truename x))
18105 nil x))
18106 (org-agenda-files t)))))
18107 (if (not (= (length files) (length (org-agenda-files t))))
18108 (progn
18109 (org-store-new-agenda-file-list files)
18110 (org-install-agenda-files-menu)
18111 (message "Removed file: %s" afile))
18112 (message "File was not in list: %s (not removed)" afile))))
18114 (defun org-file-menu-entry (file)
18115 (vector file (list 'find-file file) t))
18117 (defun org-check-agenda-file (file)
18118 "Make sure FILE exists. If not, ask user what to do."
18119 (when (not (file-exists-p file))
18120 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18121 (abbreviate-file-name file))
18122 (let ((r (downcase (read-char-exclusive))))
18123 (cond
18124 ((equal r ?r)
18125 (org-remove-file file)
18126 (throw 'nextfile t))
18127 (t (error "Abort"))))))
18129 (defun org-get-agenda-file-buffer (file)
18130 "Get a buffer visiting FILE. If the buffer needs to be created, add
18131 it to the list of buffers which might be released later."
18132 (let ((buf (org-find-base-buffer-visiting file)))
18133 (if buf
18134 buf ; just return it
18135 ;; Make a new buffer and remember it
18136 (setq buf (find-file-noselect file))
18137 (if buf (push buf org-agenda-new-buffers))
18138 buf)))
18140 (defun org-release-buffers (blist)
18141 "Release all buffers in list, asking the user for confirmation when needed.
18142 When a buffer is unmodified, it is just killed. When modified, it is saved
18143 \(if the user agrees) and then killed."
18144 (let (buf file)
18145 (while (setq buf (pop blist))
18146 (setq file (buffer-file-name buf))
18147 (when (and (buffer-modified-p buf)
18148 file
18149 (y-or-n-p (format "Save file %s? " file)))
18150 (with-current-buffer buf (save-buffer)))
18151 (kill-buffer buf))))
18153 (defun org-agenda-prepare-buffers (files)
18154 "Create buffers for all agenda files, protect archived trees and comments."
18155 (interactive)
18156 (let ((pa '(:org-archived t))
18157 (pc '(:org-comment t))
18158 (pall '(:org-archived t :org-comment t))
18159 (inhibit-read-only t)
18160 (org-inhibit-startup org-agenda-inhibit-startup)
18161 (rea (concat ":" org-archive-tag ":"))
18162 file re pos)
18163 (setq org-tag-alist-for-agenda nil
18164 org-tag-groups-alist-for-agenda nil)
18165 (save-window-excursion
18166 (save-restriction
18167 (while (setq file (pop files))
18168 (catch 'nextfile
18169 (if (bufferp file)
18170 (set-buffer file)
18171 (org-check-agenda-file file)
18172 (set-buffer (org-get-agenda-file-buffer file)))
18173 (widen)
18174 (org-set-regexps-and-options-for-tags)
18175 (setq pos (point))
18176 (goto-char (point-min))
18177 (let ((case-fold-search t))
18178 (when (search-forward "#+setupfile" nil t)
18179 ;; Don't set all regexps and options systematically as
18180 ;; this is only run for setting agenda tags from setup
18181 ;; file
18182 (org-set-regexps-and-options)))
18183 (or (memq 'category org-agenda-ignore-drawer-properties)
18184 (org-refresh-category-properties))
18185 (or (memq 'effort org-agenda-ignore-drawer-properties)
18186 (org-refresh-properties org-effort-property 'org-effort))
18187 (or (memq 'appt org-agenda-ignore-drawer-properties)
18188 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18189 (setq org-todo-keywords-for-agenda
18190 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18191 (setq org-done-keywords-for-agenda
18192 (append org-done-keywords-for-agenda org-done-keywords))
18193 (setq org-todo-keyword-alist-for-agenda
18194 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18195 (setq org-tag-alist-for-agenda
18196 (org-uniquify
18197 (append org-tag-alist-for-agenda
18198 org-tag-alist
18199 org-tag-persistent-alist)))
18200 (if org-group-tags
18201 (setq org-tag-groups-alist-for-agenda
18202 (org-uniquify-alist
18203 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18204 (org-with-silent-modifications
18205 (save-excursion
18206 (remove-text-properties (point-min) (point-max) pall)
18207 (when org-agenda-skip-archived-trees
18208 (goto-char (point-min))
18209 (while (re-search-forward rea nil t)
18210 (if (org-at-heading-p t)
18211 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18212 (goto-char (point-min))
18213 (setq re (format org-heading-keyword-regexp-format
18214 org-comment-string))
18215 (while (re-search-forward re nil t)
18216 (add-text-properties
18217 (match-beginning 0) (org-end-of-subtree t) pc))))
18218 (goto-char pos)))))
18219 (setq org-todo-keywords-for-agenda
18220 (org-uniquify org-todo-keywords-for-agenda))
18221 (setq org-todo-keyword-alist-for-agenda
18222 (org-uniquify org-todo-keyword-alist-for-agenda))))
18225 ;;;; CDLaTeX minor mode
18227 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18228 "Keymap for the minor `org-cdlatex-mode'.")
18230 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18231 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18232 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18233 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18234 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18236 (defvar org-cdlatex-texmathp-advice-is-done nil
18237 "Flag remembering if we have applied the advice to texmathp already.")
18239 (define-minor-mode org-cdlatex-mode
18240 "Toggle the minor `org-cdlatex-mode'.
18241 This mode supports entering LaTeX environment and math in LaTeX fragments
18242 in Org-mode.
18243 \\{org-cdlatex-mode-map}"
18244 nil " OCDL" nil
18245 (when org-cdlatex-mode
18246 (require 'cdlatex)
18247 (run-hooks 'cdlatex-mode-hook)
18248 (cdlatex-compute-tables))
18249 (unless org-cdlatex-texmathp-advice-is-done
18250 (setq org-cdlatex-texmathp-advice-is-done t)
18251 (defadvice texmathp (around org-math-always-on activate)
18252 "Always return t in org-mode buffers.
18253 This is because we want to insert math symbols without dollars even outside
18254 the LaTeX math segments. If Orgmode thinks that point is actually inside
18255 an embedded LaTeX fragment, let texmathp do its job.
18256 \\[org-cdlatex-mode-map]"
18257 (interactive)
18258 (let (p)
18259 (cond
18260 ((not (derived-mode-p 'org-mode)) ad-do-it)
18261 ((eq this-command 'cdlatex-math-symbol)
18262 (setq ad-return-value t
18263 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18265 (let ((p (org-inside-LaTeX-fragment-p)))
18266 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18267 (setq ad-return-value t
18268 texmathp-why '("Org-mode embedded math" . 0))
18269 (if p ad-do-it)))))))))
18271 (defun turn-on-org-cdlatex ()
18272 "Unconditionally turn on `org-cdlatex-mode'."
18273 (org-cdlatex-mode 1))
18275 (defun org-try-cdlatex-tab ()
18276 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18277 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18278 - inside a LaTeX fragment, or
18279 - after the first word in a line, where an abbreviation expansion could
18280 insert a LaTeX environment."
18281 (when org-cdlatex-mode
18282 (cond
18283 ;; Before any word on the line: No expansion possible.
18284 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18285 ;; Just after first word on the line: Expand it. Make sure it
18286 ;; cannot happen on headlines, though.
18287 ((save-excursion
18288 (skip-chars-backward "a-zA-Z0-9*")
18289 (skip-chars-backward " \t")
18290 (and (bolp) (not (org-at-heading-p))))
18291 (cdlatex-tab) t)
18292 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18294 (defun org-cdlatex-underscore-caret (&optional arg)
18295 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18296 Revert to the normal definition outside of these fragments."
18297 (interactive "P")
18298 (if (org-inside-LaTeX-fragment-p)
18299 (call-interactively 'cdlatex-sub-superscript)
18300 (let (org-cdlatex-mode)
18301 (call-interactively (key-binding (vector last-input-event))))))
18303 (defun org-cdlatex-math-modify (&optional arg)
18304 "Execute `cdlatex-math-modify' in LaTeX fragments.
18305 Revert to the normal definition outside of these fragments."
18306 (interactive "P")
18307 (if (org-inside-LaTeX-fragment-p)
18308 (call-interactively 'cdlatex-math-modify)
18309 (let (org-cdlatex-mode)
18310 (call-interactively (key-binding (vector last-input-event))))))
18314 ;;;; LaTeX fragments
18316 (defun org-inside-LaTeX-fragment-p ()
18317 "Test if point is inside a LaTeX fragment.
18318 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18319 sequence appearing also before point.
18320 Even though the matchers for math are configurable, this function assumes
18321 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18322 delimiters are skipped when they have been removed by customization.
18323 The return value is nil, or a cons cell with the delimiter and the
18324 position of this delimiter.
18326 This function does a reasonably good job, but can locally be fooled by
18327 for example currency specifications. For example it will assume being in
18328 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18329 fragments that are properly closed, but during editing, we have to live
18330 with the uncertainty caused by missing closing delimiters. This function
18331 looks only before point, not after."
18332 (catch 'exit
18333 (let ((pos (point))
18334 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18335 (lim (progn
18336 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18337 (point)))
18338 dd-on str (start 0) m re)
18339 (goto-char pos)
18340 (when dodollar
18341 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18342 re (nth 1 (assoc "$" org-latex-regexps)))
18343 (while (string-match re str start)
18344 (cond
18345 ((= (match-end 0) (length str))
18346 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18347 ((= (match-end 0) (- (length str) 5))
18348 (throw 'exit nil))
18349 (t (setq start (match-end 0))))))
18350 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18351 (goto-char pos)
18352 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18353 (and (match-beginning 2) (throw 'exit nil))
18354 ;; count $$
18355 (while (re-search-backward "\\$\\$" lim t)
18356 (setq dd-on (not dd-on)))
18357 (goto-char pos)
18358 (if dd-on (cons "$$" m))))))
18360 (defun org-inside-latex-macro-p ()
18361 "Is point inside a LaTeX macro or its arguments?"
18362 (save-match-data
18363 (org-in-regexp
18364 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18366 (defvar org-latex-fragment-image-overlays nil
18367 "List of overlays carrying the images of latex fragments.")
18368 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18370 (defun org-remove-latex-fragment-image-overlays ()
18371 "Remove all overlays with LaTeX fragment images in current buffer."
18372 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18373 (setq org-latex-fragment-image-overlays nil))
18375 (defun org-preview-latex-fragment (&optional subtree)
18376 "Preview the LaTeX fragment at point, or all locally or globally.
18377 If the cursor is in a LaTeX fragment, create the image and overlay
18378 it over the source code. If there is no fragment at point, display
18379 all fragments in the current text, from one headline to the next. With
18380 prefix SUBTREE, display all fragments in the current subtree. With a
18381 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18382 the cursor is before the first headline,
18383 display all fragments in the buffer.
18384 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18385 (interactive "P")
18386 (unless buffer-file-name
18387 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18388 (when (display-graphic-p)
18389 (org-remove-latex-fragment-image-overlays)
18390 (save-excursion
18391 (save-restriction
18392 (let (beg end at msg)
18393 (cond
18394 ((or (equal subtree '(16))
18395 (not (save-excursion
18396 (re-search-backward org-outline-regexp-bol nil t))))
18397 (setq beg (point-min) end (point-max)
18398 msg "Creating images for buffer...%s"))
18399 ((equal subtree '(4))
18400 (org-back-to-heading)
18401 (setq beg (point) end (org-end-of-subtree t)
18402 msg "Creating images for subtree...%s"))
18404 (if (setq at (org-inside-LaTeX-fragment-p))
18405 (goto-char (max (point-min) (- (cdr at) 2)))
18406 (org-back-to-heading))
18407 (setq beg (point) end (progn (outline-next-heading) (point))
18408 msg (if at "Creating image...%s"
18409 "Creating images for entry...%s"))))
18410 (message msg "")
18411 (narrow-to-region beg end)
18412 (goto-char beg)
18413 (org-format-latex
18414 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18415 (file-name-nondirectory
18416 buffer-file-name)))
18417 default-directory 'overlays msg at 'forbuffer
18418 org-latex-create-formula-image-program)
18419 (message msg "done. Use `C-c C-c' to remove images."))))))
18421 (defun org-format-latex (prefix &optional dir overlays msg at
18422 forbuffer processing-type)
18423 "Replace LaTeX fragments with links to an image, and produce images.
18424 Some of the options can be changed using the variable
18425 `org-format-latex-options'."
18426 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18427 (let* ((prefixnodir (file-name-nondirectory prefix))
18428 (absprefix (expand-file-name prefix dir))
18429 (todir (file-name-directory absprefix))
18430 (opt org-format-latex-options)
18431 (optnew org-format-latex-options)
18432 (matchers (plist-get opt :matchers))
18433 (re-list org-latex-regexps)
18434 (cnt 0) txt hash link beg end re e checkdir
18435 string
18436 m n block-type block linkfile movefile ov)
18437 ;; Check the different regular expressions
18438 (while (setq e (pop re-list))
18439 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18440 block (if block-type "\n\n" ""))
18441 (when (member m matchers)
18442 (goto-char (point-min))
18443 (while (re-search-forward re nil t)
18444 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18445 (or (not overlays)
18446 (not (eq (get-char-property (match-beginning n)
18447 'org-overlay-type)
18448 'org-latex-overlay))))
18449 (cond
18450 ((eq processing-type 'verbatim))
18451 ((eq processing-type 'mathjax)
18452 ;; Prepare for MathJax processing.
18453 (setq string (match-string n))
18454 (when (member m '("$" "$1"))
18455 (save-excursion
18456 (delete-region (match-beginning n) (match-end n))
18457 (goto-char (match-beginning n))
18458 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18459 ((or (eq processing-type 'dvipng)
18460 (eq processing-type 'imagemagick))
18461 ;; Process to an image.
18462 (setq txt (match-string n)
18463 beg (match-beginning n) end (match-end n)
18464 cnt (1+ cnt))
18465 (let ((face (face-at-point))
18466 (fg (plist-get opt :foreground))
18467 (bg (plist-get opt :background))
18468 ;; Ensure full list is printed.
18469 print-length print-level)
18470 (when forbuffer
18471 ;; Get the colors from the face at point.
18472 (goto-char beg)
18473 (when (eq fg 'auto)
18474 (setq fg (face-attribute face :foreground nil 'default)))
18475 (when (eq bg 'auto)
18476 (setq bg (face-attribute face :background nil 'default)))
18477 (setq optnew (copy-sequence opt))
18478 (plist-put optnew :foreground fg)
18479 (plist-put optnew :background bg))
18480 (setq hash (sha1 (prin1-to-string
18481 (list org-format-latex-header
18482 org-latex-default-packages-alist
18483 org-latex-packages-alist
18484 org-format-latex-options
18485 forbuffer txt fg bg)))
18486 linkfile (format "%s_%s.png" prefix hash)
18487 movefile (format "%s_%s.png" absprefix hash)))
18488 (setq link (concat block "[[file:" linkfile "]]" block))
18489 (if msg (message msg cnt))
18490 (goto-char beg)
18491 (unless checkdir ; Ensure the directory exists.
18492 (setq checkdir t)
18493 (or (file-directory-p todir) (make-directory todir t)))
18494 (unless (file-exists-p movefile)
18495 (org-create-formula-image
18496 txt movefile optnew forbuffer processing-type))
18497 (if overlays
18498 (progn
18499 (mapc (lambda (o)
18500 (if (eq (overlay-get o 'org-overlay-type)
18501 'org-latex-overlay)
18502 (delete-overlay o)))
18503 (overlays-in beg end))
18504 (setq ov (make-overlay beg end))
18505 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18506 (if (featurep 'xemacs)
18507 (progn
18508 (overlay-put ov 'invisible t)
18509 (overlay-put
18510 ov 'end-glyph
18511 (make-glyph (vector 'png :file movefile))))
18512 (overlay-put
18513 ov 'display
18514 (list 'image :type 'png :file movefile :ascent 'center)))
18515 (push ov org-latex-fragment-image-overlays)
18516 (goto-char end))
18517 (delete-region beg end)
18518 (insert (org-add-props link
18519 (list 'org-latex-src
18520 (replace-regexp-in-string
18521 "\"" "" txt)
18522 'org-latex-src-embed-type
18523 (if block-type 'paragraph 'character))))))
18524 ((eq processing-type 'mathml)
18525 ;; Process to MathML
18526 (unless (save-match-data (org-format-latex-mathml-available-p))
18527 (user-error "LaTeX to MathML converter not configured"))
18528 (setq txt (match-string n)
18529 beg (match-beginning n) end (match-end n)
18530 cnt (1+ cnt))
18531 (if msg (message msg cnt))
18532 (goto-char beg)
18533 (delete-region beg end)
18534 (insert (org-format-latex-as-mathml
18535 txt block-type prefix dir)))
18537 (error "Unknown conversion type %s for LaTeX fragments"
18538 processing-type)))))))))
18540 (defun org-create-math-formula (latex-frag &optional mathml-file)
18541 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18542 Use `org-latex-to-mathml-convert-command'. If the conversion is
18543 sucessful, return the portion between \"<math...> </math>\"
18544 elements otherwise return nil. When MATHML-FILE is specified,
18545 write the results in to that file. When invoked as an
18546 interactive command, prompt for LATEX-FRAG, with initial value
18547 set to the current active region and echo the results for user
18548 inspection."
18549 (interactive (list (let ((frag (when (org-region-active-p)
18550 (buffer-substring-no-properties
18551 (region-beginning) (region-end)))))
18552 (read-string "LaTeX Fragment: " frag nil frag))))
18553 (unless latex-frag (error "Invalid LaTeX fragment"))
18554 (let* ((tmp-in-file (file-relative-name
18555 (make-temp-name (expand-file-name "ltxmathml-in"))))
18556 (ignore (write-region latex-frag nil tmp-in-file))
18557 (tmp-out-file (file-relative-name
18558 (make-temp-name (expand-file-name "ltxmathml-out"))))
18559 (cmd (format-spec
18560 org-latex-to-mathml-convert-command
18561 `((?j . ,(shell-quote-argument
18562 (expand-file-name org-latex-to-mathml-jar-file)))
18563 (?I . ,(shell-quote-argument tmp-in-file))
18564 (?o . ,(shell-quote-argument tmp-out-file)))))
18565 mathml shell-command-output)
18566 (when (org-called-interactively-p 'any)
18567 (unless (org-format-latex-mathml-available-p)
18568 (user-error "LaTeX to MathML converter not configured")))
18569 (message "Running %s" cmd)
18570 (setq shell-command-output (shell-command-to-string cmd))
18571 (setq mathml
18572 (when (file-readable-p tmp-out-file)
18573 (with-current-buffer (find-file-noselect tmp-out-file t)
18574 (goto-char (point-min))
18575 (when (re-search-forward
18576 (concat
18577 (regexp-quote
18578 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18579 "\\(.\\|\n\\)*"
18580 (regexp-quote "</math>")) nil t)
18581 (prog1 (match-string 0) (kill-buffer))))))
18582 (cond
18583 (mathml
18584 (setq mathml
18585 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18586 (when mathml-file
18587 (write-region mathml nil mathml-file))
18588 (when (org-called-interactively-p 'any)
18589 (message mathml)))
18590 ((message "LaTeX to MathML conversion failed")
18591 (message shell-command-output)))
18592 (delete-file tmp-in-file)
18593 (when (file-exists-p tmp-out-file)
18594 (delete-file tmp-out-file))
18595 mathml))
18597 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18598 prefix &optional dir)
18599 "Use `org-create-math-formula' but check local cache first."
18600 (let* ((absprefix (expand-file-name prefix dir))
18601 (print-length nil) (print-level nil)
18602 (formula-id (concat
18603 "formula-"
18604 (sha1
18605 (prin1-to-string
18606 (list latex-frag
18607 org-latex-to-mathml-convert-command)))))
18608 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18609 (formula-cache-dir (file-name-directory formula-cache)))
18611 (unless (file-directory-p formula-cache-dir)
18612 (make-directory formula-cache-dir t))
18614 (unless (file-exists-p formula-cache)
18615 (org-create-math-formula latex-frag formula-cache))
18617 (if (file-exists-p formula-cache)
18618 ;; Successful conversion. Return the link to MathML file.
18619 (org-add-props
18620 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18621 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18622 'org-latex-src-embed-type (if latex-frag-type
18623 'paragraph 'character)))
18624 ;; Failed conversion. Return the LaTeX fragment verbatim
18625 latex-frag)))
18627 (defun org-create-formula-image (string tofile options buffer &optional type)
18628 "Create an image from LaTeX source using dvipng or convert.
18629 This function calls either `org-create-formula-image-with-dvipng'
18630 or `org-create-formula-image-with-imagemagick' depending on the
18631 value of `org-latex-create-formula-image-program' or on the value
18632 of the optional TYPE variable.
18634 Note: ultimately these two function should be combined as they
18635 share a good deal of logic."
18636 (org-check-external-command
18637 "latex" "needed to convert LaTeX fragments to images")
18638 (funcall
18639 (case (or type org-latex-create-formula-image-program)
18640 ('dvipng
18641 (org-check-external-command
18642 "dvipng" "needed to convert LaTeX fragments to images")
18643 #'org-create-formula-image-with-dvipng)
18644 ('imagemagick
18645 (org-check-external-command
18646 "convert" "you need to install imagemagick")
18647 #'org-create-formula-image-with-imagemagick)
18648 (t (error
18649 "Invalid value of `org-latex-create-formula-image-program'")))
18650 string tofile options buffer))
18652 (declare-function org-export-get-backend "ox" (name))
18653 (declare-function org-export--get-global-options "ox" (&optional backend))
18654 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18655 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18656 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18657 (defun org-create-formula--latex-header ()
18658 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18659 (let ((info (org-combine-plists (org-export--get-global-options
18660 (org-export-get-backend 'latex))
18661 (org-export--get-inbuffer-options
18662 (org-export-get-backend 'latex)))))
18663 (org-latex-guess-babel-language
18664 (org-latex-guess-inputenc
18665 (org-splice-latex-header
18666 org-format-latex-header
18667 org-latex-default-packages-alist
18668 org-latex-packages-alist t
18669 (plist-get info :latex-header)))
18670 info)))
18672 ;; This function borrows from Ganesh Swami's latex2png.el
18673 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18674 "This calls dvipng."
18675 (require 'ox-latex)
18676 (let* ((tmpdir (if (featurep 'xemacs)
18677 (temp-directory)
18678 temporary-file-directory))
18679 (texfilebase (make-temp-name
18680 (expand-file-name "orgtex" tmpdir)))
18681 (texfile (concat texfilebase ".tex"))
18682 (dvifile (concat texfilebase ".dvi"))
18683 (pngfile (concat texfilebase ".png"))
18684 (fnh (if (featurep 'xemacs)
18685 (font-height (face-font 'default))
18686 (face-attribute 'default :height nil)))
18687 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18688 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18689 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18690 "Black"))
18691 (bg (or (plist-get options (if buffer :background :html-background))
18692 "Transparent")))
18693 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18694 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18695 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18696 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18697 (let ((latex-header (org-create-formula--latex-header)))
18698 (with-temp-file texfile
18699 (insert latex-header)
18700 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18701 (let ((dir default-directory))
18702 (condition-case nil
18703 (progn
18704 (cd tmpdir)
18705 (call-process "latex" nil nil nil texfile))
18706 (error nil))
18707 (cd dir))
18708 (if (not (file-exists-p dvifile))
18709 (progn (message "Failed to create dvi file from %s" texfile) nil)
18710 (condition-case nil
18711 (if (featurep 'xemacs)
18712 (call-process "dvipng" nil nil nil
18713 "-fg" fg "-bg" bg
18714 "-T" "tight"
18715 "-o" pngfile
18716 dvifile)
18717 (call-process "dvipng" nil nil nil
18718 "-fg" fg "-bg" bg
18719 "-D" dpi
18720 ;;"-x" scale "-y" scale
18721 "-T" "tight"
18722 "-o" pngfile
18723 dvifile))
18724 (error nil))
18725 (if (not (file-exists-p pngfile))
18726 (if org-format-latex-signal-error
18727 (error "Failed to create png file from %s" texfile)
18728 (message "Failed to create png file from %s" texfile)
18729 nil)
18730 ;; Use the requested file name and clean up
18731 (copy-file pngfile tofile 'replace)
18732 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18733 (if (file-exists-p (concat texfilebase e))
18734 (delete-file (concat texfilebase e))))
18735 pngfile))))
18737 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18738 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18739 "This calls convert, which is included into imagemagick."
18740 (require 'ox-latex)
18741 (let* ((tmpdir (if (featurep 'xemacs)
18742 (temp-directory)
18743 temporary-file-directory))
18744 (texfilebase (make-temp-name
18745 (expand-file-name "orgtex" tmpdir)))
18746 (texfile (concat texfilebase ".tex"))
18747 (pdffile (concat texfilebase ".pdf"))
18748 (pngfile (concat texfilebase ".png"))
18749 (fnh (if (featurep 'xemacs)
18750 (font-height (face-font 'default))
18751 (face-attribute 'default :height nil)))
18752 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18753 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18754 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18755 "black"))
18756 (bg (or (plist-get options (if buffer :background :html-background))
18757 "white")))
18758 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18759 (setq fg (org-latex-color-format fg)))
18760 (if (eq bg 'default) (setq bg (org-latex-color :background))
18761 (setq bg (org-latex-color-format
18762 (if (string= bg "Transparent") "white" bg))))
18763 (let ((latex-header (org-create-formula--latex-header)))
18764 (with-temp-file texfile
18765 (insert latex-header)
18766 (insert "\n\\begin{document}\n"
18767 "\\definecolor{fg}{rgb}{" fg "}\n"
18768 "\\definecolor{bg}{rgb}{" bg "}\n"
18769 "\n\\pagecolor{bg}\n"
18770 "\n{\\color{fg}\n"
18771 string
18772 "\n}\n"
18773 "\n\\end{document}\n")))
18774 (org-latex-compile texfile t)
18775 (if (not (file-exists-p pdffile))
18776 (progn (message "Failed to create pdf file from %s" texfile) nil)
18777 (condition-case nil
18778 (if (featurep 'xemacs)
18779 (call-process "convert" nil nil nil
18780 "-density" "96"
18781 "-trim"
18782 "-antialias"
18783 pdffile
18784 "-quality" "100"
18785 ;; "-sharpen" "0x1.0"
18786 pngfile)
18787 (call-process "convert" nil nil nil
18788 "-density" dpi
18789 "-trim"
18790 "-antialias"
18791 pdffile
18792 "-quality" "100"
18793 ;; "-sharpen" "0x1.0"
18794 pngfile))
18795 (error nil))
18796 (if (not (file-exists-p pngfile))
18797 (if org-format-latex-signal-error
18798 (error "Failed to create png file from %s" texfile)
18799 (message "Failed to create png file from %s" texfile)
18800 nil)
18801 ;; Use the requested file name and clean up
18802 (copy-file pngfile tofile 'replace)
18803 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18804 (if (file-exists-p (concat texfilebase e))
18805 (delete-file (concat texfilebase e))))
18806 pngfile))))
18808 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18809 "Fill a LaTeX header template TPL.
18810 In the template, the following place holders will be recognized:
18812 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18813 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18814 [PACKAGES] \\usepackage statements for PKG
18815 [NO-PACKAGES] do not include PKG
18816 [EXTRA] the string EXTRA
18817 [NO-EXTRA] do not include EXTRA
18819 For backward compatibility, if both the positive and the negative place
18820 holder is missing, the positive one (without the \"NO-\") will be
18821 assumed to be present at the end of the template.
18822 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18823 EXTRA is a string.
18824 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18825 (let (rpl (end ""))
18826 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18827 (setq rpl (if (or (match-end 1) (not def-pkg))
18828 "" (org-latex-packages-to-string def-pkg snippets-p t))
18829 tpl (replace-match rpl t t tpl))
18830 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18832 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18833 (setq rpl (if (or (match-end 1) (not pkg))
18834 "" (org-latex-packages-to-string pkg snippets-p t))
18835 tpl (replace-match rpl t t tpl))
18836 (if pkg (setq end
18837 (concat end "\n"
18838 (org-latex-packages-to-string pkg snippets-p)))))
18840 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18841 (setq rpl (if (or (match-end 1) (not extra))
18842 "" (concat extra "\n"))
18843 tpl (replace-match rpl t t tpl))
18844 (if (and extra (string-match "\\S-" extra))
18845 (setq end (concat end "\n" extra))))
18847 (if (string-match "\\S-" end)
18848 (concat tpl "\n" end)
18849 tpl)))
18851 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18852 "Turn an alist of packages into a string with the \\usepackage macros."
18853 (setq pkg (mapconcat (lambda(p)
18854 (cond
18855 ((stringp p) p)
18856 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18857 (format "%% Package %s omitted" (cadr p)))
18858 ((equal "" (car p))
18859 (format "\\usepackage{%s}" (cadr p)))
18861 (format "\\usepackage[%s]{%s}"
18862 (car p) (cadr p)))))
18864 "\n"))
18865 (if newline (concat pkg "\n") pkg))
18867 (defun org-dvipng-color (attr)
18868 "Return a RGB color specification for dvipng."
18869 (apply 'format "rgb %s %s %s"
18870 (mapcar 'org-normalize-color
18871 (if (featurep 'xemacs)
18872 (color-rgb-components
18873 (face-property 'default
18874 (cond ((eq attr :foreground) 'foreground)
18875 ((eq attr :background) 'background))))
18876 (color-values (face-attribute 'default attr nil))))))
18878 (defun org-dvipng-color-format (color-name)
18879 "Convert COLOR-NAME to a RGB color value for dvipng."
18880 (apply 'format "rgb %s %s %s"
18881 (mapcar 'org-normalize-color
18882 (color-values color-name))))
18884 (defun org-latex-color (attr)
18885 "Return a RGB color for the LaTeX color package."
18886 (apply 'format "%s,%s,%s"
18887 (mapcar 'org-normalize-color
18888 (if (featurep 'xemacs)
18889 (color-rgb-components
18890 (face-property 'default
18891 (cond ((eq attr :foreground) 'foreground)
18892 ((eq attr :background) 'background))))
18893 (color-values (face-attribute 'default attr nil))))))
18895 (defun org-latex-color-format (color-name)
18896 "Convert COLOR-NAME to a RGB color value."
18897 (apply 'format "%s,%s,%s"
18898 (mapcar 'org-normalize-color
18899 (color-values color-name))))
18901 (defun org-normalize-color (value)
18902 "Return string to be used as color value for an RGB component."
18903 (format "%g" (/ value 65535.0)))
18907 ;; Image display
18909 (defvar org-inline-image-overlays nil)
18910 (make-variable-buffer-local 'org-inline-image-overlays)
18912 (defun org-toggle-inline-images (&optional include-linked)
18913 "Toggle the display of inline images.
18914 INCLUDE-LINKED is passed to `org-display-inline-images'."
18915 (interactive "P")
18916 (if org-inline-image-overlays
18917 (progn
18918 (org-remove-inline-images)
18919 (message "Inline image display turned off"))
18920 (org-display-inline-images include-linked)
18921 (if (and (org-called-interactively-p)
18922 org-inline-image-overlays)
18923 (message "%d images displayed inline"
18924 (length org-inline-image-overlays))
18925 (message "No images to display inline"))))
18927 (defun org-redisplay-inline-images ()
18928 "Refresh the display of inline images."
18929 (interactive)
18930 (if (not org-inline-image-overlays)
18931 (org-toggle-inline-images)
18932 (org-toggle-inline-images)
18933 (org-toggle-inline-images)))
18935 (defun org-display-inline-images (&optional include-linked refresh beg end)
18936 "Display inline images.
18938 An inline image is a link which follows either of these
18939 conventions:
18941 1. Its path is a file with an extension matching return value
18942 from `image-file-name-regexp' and it has no contents.
18944 2. Its description consists in a single link of the previous
18945 type.
18947 When optional argument INCLUDE-LINKED is non-nil, also links with
18948 a text description part will be inlined. This can be nice for
18949 a quick look at those images, but it does not reflect what
18950 exported files will look like.
18952 When optional argument REFRESH is non-nil, refresh existing
18953 images between BEG and END. This will create new image displays
18954 only if necessary. BEG and END default to the buffer
18955 boundaries."
18956 (interactive "P")
18957 (when (display-graphic-p)
18958 (unless refresh
18959 (org-remove-inline-images)
18960 (when (fboundp 'clear-image-cache) (clear-image-cache)))
18961 (org-with-wide-buffer
18962 (goto-char (or beg (point-min)))
18963 (let ((case-fold-search t)
18964 (file-extension-re (org-image-file-name-regexp)))
18965 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
18966 (let ((link (save-match-data (org-element-context))))
18967 ;; Check if we're at an inline image.
18968 (when (and (equal (org-element-property :type link) "file")
18969 (or include-linked
18970 (not (org-element-property :contents-begin link)))
18971 (let ((parent (org-element-property :parent link)))
18972 (or (not (eq (org-element-type parent) 'link))
18973 (not (cdr (org-element-contents parent)))))
18974 (org-string-match-p file-extension-re
18975 (org-element-property :path link)))
18976 (let ((file (expand-file-name (org-element-property :path link))))
18977 (when (file-exists-p file)
18978 (let ((width
18979 ;; Apply `org-image-actual-width' specifications.
18980 (cond
18981 ((not (image-type-available-p 'imagemagick)) nil)
18982 ((eq org-image-actual-width t) nil)
18983 ((listp org-image-actual-width)
18985 ;; First try to find a width among
18986 ;; attributes associated to the paragraph
18987 ;; containing link.
18988 (let ((paragraph
18989 (let ((e link))
18990 (while (and (setq e (org-element-property
18991 :parent e))
18992 (not (eq (org-element-type e)
18993 'paragraph))))
18994 e)))
18995 (when paragraph
18996 (save-excursion
18997 (goto-char (org-element-property :begin paragraph))
18998 (when (save-match-data
18999 (re-search-forward
19000 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
19001 (org-element-property
19002 :post-affiliated paragraph)
19004 (string-to-number (match-string 1))))))
19005 ;; Otherwise, fall-back to provided number.
19006 (car org-image-actual-width)))
19007 ((numberp org-image-actual-width)
19008 org-image-actual-width)))
19009 (old (get-char-property-and-overlay
19010 (org-element-property :begin link)
19011 'org-image-overlay)))
19012 (if (and (car-safe old) refresh)
19013 (image-refresh (overlay-get (cdr old) 'display))
19014 (let ((image (save-match-data
19015 (create-image file
19016 (and width 'imagemagick)
19018 :width width))))
19019 (when image
19020 (let* ((link
19021 ;; If inline image is the description
19022 ;; of another link, be sure to
19023 ;; consider the latter as the one to
19024 ;; apply the overlay on.
19025 (let ((parent
19026 (org-element-property :parent link)))
19027 (if (eq (org-element-type parent) 'link)
19028 parent
19029 link)))
19030 (ov (make-overlay
19031 (org-element-property :begin link)
19032 (progn
19033 (goto-char
19034 (org-element-property :end link))
19035 (skip-chars-backward " \t")
19036 (point)))))
19037 (overlay-put ov 'display image)
19038 (overlay-put ov 'face 'default)
19039 (overlay-put ov 'org-image-overlay t)
19040 (overlay-put
19041 ov 'modification-hooks
19042 (list 'org-display-inline-remove-overlay))
19043 (push ov org-inline-image-overlays)))))))))))))))
19045 (define-obsolete-function-alias
19046 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19048 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19049 "Remove inline-display overlay if a corresponding region is modified."
19050 (let ((inhibit-modification-hooks t))
19051 (when (and ov after)
19052 (delete ov org-inline-image-overlays)
19053 (delete-overlay ov))))
19055 (defun org-remove-inline-images ()
19056 "Remove inline display of images."
19057 (interactive)
19058 (mapc 'delete-overlay org-inline-image-overlays)
19059 (setq org-inline-image-overlays nil))
19061 ;;;; Key bindings
19063 ;; Outline functions from `outline-mode-prefix-map'
19064 ;; that can be remapped in Org:
19065 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19066 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19067 (define-key org-mode-map [remap outline-forward-same-level]
19068 'org-forward-heading-same-level)
19069 (define-key org-mode-map [remap outline-backward-same-level]
19070 'org-backward-heading-same-level)
19071 (define-key org-mode-map [remap show-branches]
19072 'org-kill-note-or-show-branches)
19073 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19074 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19075 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19077 ;; Outline functions from `outline-mode-prefix-map' that can not
19078 ;; be remapped in Org:
19080 ;; - the column "key binding" shows whether the Outline function is still
19081 ;; available in Org mode on the same key that it has been bound to in
19082 ;; Outline mode:
19083 ;; - "overridden": key used for a different functionality in Org mode
19084 ;; - else: key still bound to the same Outline function in Org mode
19086 ;; | Outline function | key binding | Org replacement |
19087 ;; |------------------------------------+-------------+-----------------------|
19088 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19089 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19090 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19091 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19092 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19093 ;; | `show-entry' | overridden | no replacement |
19094 ;; | `show-children' | `C-c C-i' | visibility cycling |
19095 ;; | `show-branches' | `C-c C-k' | still same function |
19096 ;; | `show-subtree' | overridden | visibility cycling |
19097 ;; | `show-all' | overridden | no replacement |
19098 ;; | `hide-subtree' | overridden | visibility cycling |
19099 ;; | `hide-body' | overridden | no replacement |
19100 ;; | `hide-entry' | overridden | visibility cycling |
19101 ;; | `hide-leaves' | overridden | no replacement |
19102 ;; | `hide-sublevels' | overridden | no replacement |
19103 ;; | `hide-other' | overridden | no replacement |
19105 ;; Make `C-c C-x' a prefix key
19106 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19108 ;; TAB key with modifiers
19109 (org-defkey org-mode-map "\C-i" 'org-cycle)
19110 (org-defkey org-mode-map [(tab)] 'org-cycle)
19111 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19112 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19113 ;; The following line is necessary under Suse GNU/Linux
19114 (unless (featurep 'xemacs)
19115 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19116 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19117 (define-key org-mode-map [backtab] 'org-shifttab)
19119 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19120 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19121 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19123 ;; Cursor keys with modifiers
19124 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19125 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19126 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19127 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19129 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19130 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19131 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19132 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19134 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19135 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19136 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19137 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19139 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19140 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19141 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19142 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19144 ;; Babel keys
19145 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19146 (mapc (lambda (pair)
19147 (define-key org-babel-map (car pair) (cdr pair)))
19148 org-babel-key-bindings)
19150 ;;; Extra keys for tty access.
19151 ;; We only set them when really needed because otherwise the
19152 ;; menus don't show the simple keys
19154 (when (or org-use-extra-keys
19155 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19156 (not window-system))
19157 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19158 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19159 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19160 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19161 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19162 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19163 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19164 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19165 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19166 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19167 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19168 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19169 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19170 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19171 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19172 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19173 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19174 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19175 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19176 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19177 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19178 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19179 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19180 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19181 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19182 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19183 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19184 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19186 ;; All the other keys
19188 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19189 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19190 (if (boundp 'narrow-map)
19191 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19192 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19193 (if (boundp 'narrow-map)
19194 (org-defkey narrow-map "b" 'org-narrow-to-block)
19195 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19196 (if (boundp 'narrow-map)
19197 (org-defkey narrow-map "e" 'org-narrow-to-element)
19198 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19199 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19200 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19201 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19202 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19203 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19204 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19205 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19206 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19207 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19208 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19209 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19210 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19211 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19212 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19213 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19214 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19215 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19216 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19217 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19218 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19219 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19220 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19221 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19222 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19223 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19224 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19225 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19226 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19227 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19228 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19229 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19230 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19231 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19232 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19233 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19234 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19235 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19236 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19237 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19238 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19239 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19240 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19241 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19242 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19243 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19244 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19245 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19246 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19247 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19248 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19249 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19250 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19251 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19252 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19253 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19254 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19255 (org-defkey org-mode-map "\C-c^" 'org-sort)
19256 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19257 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19258 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19259 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19260 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19261 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19262 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19263 (org-defkey org-mode-map "\C-m" 'org-return)
19264 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19265 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19266 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19267 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19268 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19269 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19270 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19271 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19272 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19273 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19274 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19275 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19276 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19277 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19278 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width-section)
19279 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19280 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19281 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19282 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19283 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19284 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19285 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19286 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19288 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19289 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19290 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19292 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19293 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19294 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19295 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19296 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19297 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19298 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19299 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19300 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19301 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19302 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19303 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19304 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19305 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19306 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19307 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19308 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19309 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19310 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19311 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19312 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19313 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19314 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19316 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19317 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19318 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19319 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19320 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19322 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19324 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19326 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19327 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19329 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19332 (when (featurep 'xemacs)
19333 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19336 (defconst org-speed-commands-default
19338 ("Outline Navigation")
19339 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19340 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19341 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19342 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19343 ("F" . org-next-block)
19344 ("B" . org-previous-block)
19345 ("u" . (org-speed-move-safe 'outline-up-heading))
19346 ("j" . org-goto)
19347 ("g" . (org-refile t))
19348 ("Outline Visibility")
19349 ("c" . org-cycle)
19350 ("C" . org-shifttab)
19351 (" " . org-display-outline-path)
19352 ("s" . org-narrow-to-subtree)
19353 ("=" . org-columns)
19354 ("Outline Structure Editing")
19355 ("U" . org-shiftmetaup)
19356 ("D" . org-shiftmetadown)
19357 ("r" . org-metaright)
19358 ("l" . org-metaleft)
19359 ("R" . org-shiftmetaright)
19360 ("L" . org-shiftmetaleft)
19361 ("i" . (progn (forward-char 1) (call-interactively
19362 'org-insert-heading-respect-content)))
19363 ("^" . org-sort)
19364 ("w" . org-refile)
19365 ("a" . org-archive-subtree-default-with-confirmation)
19366 ("@" . org-mark-subtree)
19367 ("#" . org-toggle-comment)
19368 ("Clock Commands")
19369 ("I" . org-clock-in)
19370 ("O" . org-clock-out)
19371 ("Meta Data Editing")
19372 ("t" . org-todo)
19373 ("," . (org-priority))
19374 ("0" . (org-priority ?\ ))
19375 ("1" . (org-priority ?A))
19376 ("2" . (org-priority ?B))
19377 ("3" . (org-priority ?C))
19378 (":" . org-set-tags-command)
19379 ("e" . org-set-effort)
19380 ("E" . org-inc-effort)
19381 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19382 (org-entry-put (point) "APPT_WARNTIME" m)))
19383 ("Agenda Views etc")
19384 ("v" . org-agenda)
19385 ("/" . org-sparse-tree)
19386 ("Misc")
19387 ("o" . org-open-at-point)
19388 ("?" . org-speed-command-help)
19389 ("<" . (org-agenda-set-restriction-lock 'subtree))
19390 (">" . (org-agenda-remove-restriction-lock))
19392 "The default speed commands.")
19394 (defun org-print-speed-command (e)
19395 (if (> (length (car e)) 1)
19396 (progn
19397 (princ "\n")
19398 (princ (car e))
19399 (princ "\n")
19400 (princ (make-string (length (car e)) ?-))
19401 (princ "\n"))
19402 (princ (car e))
19403 (princ " ")
19404 (if (symbolp (cdr e))
19405 (princ (symbol-name (cdr e)))
19406 (prin1 (cdr e)))
19407 (princ "\n")))
19409 (defun org-speed-command-help ()
19410 "Show the available speed commands."
19411 (interactive)
19412 (if (not org-use-speed-commands)
19413 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19414 (with-output-to-temp-buffer "*Help*"
19415 (princ "User-defined Speed commands\n===========================\n")
19416 (mapc 'org-print-speed-command org-speed-commands-user)
19417 (princ "\n")
19418 (princ "Built-in Speed commands\n=======================\n")
19419 (mapc 'org-print-speed-command org-speed-commands-default))
19420 (with-current-buffer "*Help*"
19421 (setq truncate-lines t))))
19423 (defun org-speed-move-safe (cmd)
19424 "Execute CMD, but make sure that the cursor always ends up in a headline.
19425 If not, return to the original position and throw an error."
19426 (interactive)
19427 (let ((pos (point)))
19428 (call-interactively cmd)
19429 (unless (and (bolp) (org-at-heading-p))
19430 (goto-char pos)
19431 (error "Boundary reached while executing %s" cmd))))
19433 (defvar org-self-insert-command-undo-counter 0)
19435 (defvar org-table-auto-blank-field) ; defined in org-table.el
19436 (defvar org-speed-command nil)
19438 (define-obsolete-function-alias
19439 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19441 (defun org-speed-command-activate (keys)
19442 "Hook for activating single-letter speed commands.
19443 `org-speed-commands-default' specifies a minimal command set.
19444 Use `org-speed-commands-user' for further customization."
19445 (when (or (and (bolp) (looking-at org-outline-regexp))
19446 (and (functionp org-use-speed-commands)
19447 (funcall org-use-speed-commands)))
19448 (cdr (assoc keys (append org-speed-commands-user
19449 org-speed-commands-default)))))
19451 (define-obsolete-function-alias
19452 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19454 (defun org-babel-speed-command-activate (keys)
19455 "Hook for activating single-letter code block commands."
19456 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19457 (cdr (assoc keys org-babel-key-bindings))))
19459 (defcustom org-speed-command-hook
19460 '(org-speed-command-default-hook org-babel-speed-command-hook)
19461 "Hook for activating speed commands at strategic locations.
19462 Hook functions are called in sequence until a valid handler is
19463 found.
19465 Each hook takes a single argument, a user-pressed command key
19466 which is also a `self-insert-command' from the global map.
19468 Within the hook, examine the cursor position and the command key
19469 and return nil or a valid handler as appropriate. Handler could
19470 be one of an interactive command, a function, or a form.
19472 Set `org-use-speed-commands' to non-nil value to enable this
19473 hook. The default setting is `org-speed-command-activate'."
19474 :group 'org-structure
19475 :version "24.1"
19476 :type 'hook)
19478 (defun org-self-insert-command (N)
19479 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19480 If the cursor is in a table looking at whitespace, the whitespace is
19481 overwritten, and the table is not marked as requiring realignment."
19482 (interactive "p")
19483 (org-check-before-invisible-edit 'insert)
19484 (cond
19485 ((and org-use-speed-commands
19486 (setq org-speed-command
19487 (run-hook-with-args-until-success
19488 'org-speed-command-hook (this-command-keys))))
19489 (cond
19490 ((commandp org-speed-command)
19491 (setq this-command org-speed-command)
19492 (call-interactively org-speed-command))
19493 ((functionp org-speed-command)
19494 (funcall org-speed-command))
19495 ((and org-speed-command (listp org-speed-command))
19496 (eval org-speed-command))
19497 (t (let (org-use-speed-commands)
19498 (call-interactively 'org-self-insert-command)))))
19499 ((and
19500 (org-table-p)
19501 (progn
19502 ;; check if we blank the field, and if that triggers align
19503 (and (featurep 'org-table) org-table-auto-blank-field
19504 (member last-command
19505 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19506 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19507 ;; got extra space, this field does not determine column width
19508 (let (org-table-may-need-update) (org-table-blank-field))
19509 ;; no extra space, this field may determine column width
19510 (org-table-blank-field)))
19512 (eq N 1)
19513 (looking-at "[^|\n]* |"))
19514 (let (org-table-may-need-update)
19515 (goto-char (1- (match-end 0)))
19516 (backward-delete-char 1)
19517 (goto-char (match-beginning 0))
19518 (self-insert-command N)))
19520 (setq org-table-may-need-update t)
19521 (self-insert-command N)
19522 (org-fix-tags-on-the-fly)
19523 (if org-self-insert-cluster-for-undo
19524 (if (not (eq last-command 'org-self-insert-command))
19525 (setq org-self-insert-command-undo-counter 1)
19526 (if (>= org-self-insert-command-undo-counter 20)
19527 (setq org-self-insert-command-undo-counter 1)
19528 (and (> org-self-insert-command-undo-counter 0)
19529 buffer-undo-list (listp buffer-undo-list)
19530 (not (cadr buffer-undo-list)) ; remove nil entry
19531 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19532 (setq org-self-insert-command-undo-counter
19533 (1+ org-self-insert-command-undo-counter))))))))
19535 (defun org-check-before-invisible-edit (kind)
19536 "Check is editing if kind KIND would be dangerous with invisible text around.
19537 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19538 ;; First, try to get out of here as quickly as possible, to reduce overhead
19539 (if (and org-catch-invisible-edits
19540 (or (not (boundp 'visible-mode)) (not visible-mode))
19541 (or (get-char-property (point) 'invisible)
19542 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19543 ;; OK, we need to take a closer look
19544 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19545 (invisible-before-point (if (bobp) nil (get-char-property
19546 (1- (point)) 'invisible)))
19547 (border-and-ok-direction
19549 ;; Check if we are acting predictably before invisible text
19550 (and invisible-at-point (not invisible-before-point)
19551 (memq kind '(insert delete-backward)))
19552 ;; Check if we are acting predictably after invisible text
19553 ;; This works not well, and I have turned it off. It seems
19554 ;; better to always show and stop after invisible text.
19555 ;; (and (not invisible-at-point) invisible-before-point
19556 ;; (memq kind '(insert delete)))
19558 (when (or (memq invisible-at-point '(outline org-hide-block t))
19559 (memq invisible-before-point '(outline org-hide-block t)))
19560 (if (eq org-catch-invisible-edits 'error)
19561 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19562 (if (and org-custom-properties-overlays
19563 (y-or-n-p "Display invisible properties in this buffer? "))
19564 (org-toggle-custom-properties-visibility)
19565 ;; Make the area visible
19566 (save-excursion
19567 (if invisible-before-point
19568 (goto-char (previous-single-char-property-change
19569 (point) 'invisible)))
19570 (org-cycle))
19571 (cond
19572 ((eq org-catch-invisible-edits 'show)
19573 ;; That's it, we do the edit after showing
19574 (message
19575 "Unfolding invisible region around point before editing")
19576 (sit-for 1))
19577 ((and (eq org-catch-invisible-edits 'smart)
19578 border-and-ok-direction)
19579 (message "Unfolding invisible region around point before editing"))
19581 ;; Don't do the edit, make the user repeat it in full visibility
19582 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19584 (defun org-fix-tags-on-the-fly ()
19585 (when (and (equal (char-after (point-at-bol)) ?*)
19586 (org-at-heading-p))
19587 (org-align-tags-here org-tags-column)))
19589 (defun org-delete-backward-char (N)
19590 "Like `delete-backward-char', insert whitespace at field end in tables.
19591 When deleting backwards, in tables this function will insert whitespace in
19592 front of the next \"|\" separator, to keep the table aligned. The table will
19593 still be marked for re-alignment if the field did fill the entire column,
19594 because, in this case the deletion might narrow the column."
19595 (interactive "p")
19596 (save-match-data
19597 (org-check-before-invisible-edit 'delete-backward)
19598 (if (and (org-table-p)
19599 (eq N 1)
19600 (string-match "|" (buffer-substring (point-at-bol) (point)))
19601 (looking-at ".*?|"))
19602 (let ((pos (point))
19603 (noalign (looking-at "[^|\n\r]* |"))
19604 (c org-table-may-need-update))
19605 (backward-delete-char N)
19606 (if (not overwrite-mode)
19607 (progn
19608 (skip-chars-forward "^|")
19609 (insert " ")
19610 (goto-char (1- pos))))
19611 ;; noalign: if there were two spaces at the end, this field
19612 ;; does not determine the width of the column.
19613 (if noalign (setq org-table-may-need-update c)))
19614 (backward-delete-char N)
19615 (org-fix-tags-on-the-fly))))
19617 (defun org-delete-char (N)
19618 "Like `delete-char', but insert whitespace at field end in tables.
19619 When deleting characters, in tables this function will insert whitespace in
19620 front of the next \"|\" separator, to keep the table aligned. The table will
19621 still be marked for re-alignment if the field did fill the entire column,
19622 because, in this case the deletion might narrow the column."
19623 (interactive "p")
19624 (save-match-data
19625 (org-check-before-invisible-edit 'delete)
19626 (if (and (org-table-p)
19627 (not (bolp))
19628 (not (= (char-after) ?|))
19629 (eq N 1))
19630 (if (looking-at ".*?|")
19631 (let ((pos (point))
19632 (noalign (looking-at "[^|\n\r]* |"))
19633 (c org-table-may-need-update))
19634 (replace-match
19635 (concat (substring (match-string 0) 1 -1) " |") nil t)
19636 (goto-char pos)
19637 ;; noalign: if there were two spaces at the end, this field
19638 ;; does not determine the width of the column.
19639 (if noalign (setq org-table-may-need-update c)))
19640 (delete-char N))
19641 (delete-char N)
19642 (org-fix-tags-on-the-fly))))
19644 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19645 (put 'org-self-insert-command 'delete-selection
19646 (lambda ()
19647 (not (run-hook-with-args-until-success
19648 'self-insert-uses-region-functions))))
19649 (put 'orgtbl-self-insert-command 'delete-selection
19650 (lambda ()
19651 (not (run-hook-with-args-until-success
19652 'self-insert-uses-region-functions))))
19653 (put 'org-delete-char 'delete-selection 'supersede)
19654 (put 'org-delete-backward-char 'delete-selection 'supersede)
19655 (put 'org-yank 'delete-selection 'yank)
19657 ;; Make `flyspell-mode' delay after some commands
19658 (put 'org-self-insert-command 'flyspell-delayed t)
19659 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19660 (put 'org-delete-char 'flyspell-delayed t)
19661 (put 'org-delete-backward-char 'flyspell-delayed t)
19663 ;; Make pabbrev-mode expand after org-mode commands
19664 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19665 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19667 (defun org-remap (map &rest commands)
19668 "In MAP, remap the functions given in COMMANDS.
19669 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19670 (let (new old)
19671 (while commands
19672 (setq old (pop commands) new (pop commands))
19673 (if (fboundp 'command-remapping)
19674 (org-defkey map (vector 'remap old) new)
19675 (substitute-key-definition old new map global-map)))))
19677 (defun org-transpose-words ()
19678 "Transpose words for Org.
19679 This uses the `org-mode-transpose-word-syntax-table' syntax
19680 table, which interprets characters in `org-emphasis-alist' as
19681 word constituents."
19682 (interactive)
19683 (with-syntax-table org-mode-transpose-word-syntax-table
19684 (call-interactively 'transpose-words)))
19685 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19687 (when (eq org-enable-table-editor 'optimized)
19688 ;; If the user wants maximum table support, we need to hijack
19689 ;; some standard editing functions
19690 (org-remap org-mode-map
19691 'self-insert-command 'org-self-insert-command
19692 'delete-char 'org-delete-char
19693 'delete-backward-char 'org-delete-backward-char)
19694 (org-defkey org-mode-map "|" 'org-force-self-insert))
19696 (defvar org-ctrl-c-ctrl-c-hook nil
19697 "Hook for functions attaching themselves to `C-c C-c'.
19699 This can be used to add additional functionality to the C-c C-c
19700 key which executes context-dependent commands. This hook is run
19701 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19702 run after the last test.
19704 Each function will be called with no arguments. The function
19705 must check if the context is appropriate for it to act. If yes,
19706 it should do its thing and then return a non-nil value. If the
19707 context is wrong, just do nothing and return nil.")
19709 (defvar org-ctrl-c-ctrl-c-final-hook nil
19710 "Hook for functions attaching themselves to `C-c C-c'.
19712 This can be used to add additional functionality to the C-c C-c
19713 key which executes context-dependent commands. This hook is run
19714 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19715 before the first test.
19717 Each function will be called with no arguments. The function
19718 must check if the context is appropriate for it to act. If yes,
19719 it should do its thing and then return a non-nil value. If the
19720 context is wrong, just do nothing and return nil.")
19722 (defvar org-tab-first-hook nil
19723 "Hook for functions to attach themselves to TAB.
19724 See `org-ctrl-c-ctrl-c-hook' for more information.
19725 This hook runs as the first action when TAB is pressed, even before
19726 `org-cycle' messes around with the `outline-regexp' to cater for
19727 inline tasks and plain list item folding.
19728 If any function in this hook returns t, any other actions that
19729 would have been caused by TAB (such as table field motion or visibility
19730 cycling) will not occur.")
19732 (defvar org-tab-after-check-for-table-hook nil
19733 "Hook for functions to attach themselves to TAB.
19734 See `org-ctrl-c-ctrl-c-hook' for more information.
19735 This hook runs after it has been established that the cursor is not in a
19736 table, but before checking if the cursor is in a headline or if global cycling
19737 should be done.
19738 If any function in this hook returns t, not other actions like visibility
19739 cycling will be done.")
19741 (defvar org-tab-after-check-for-cycling-hook nil
19742 "Hook for functions to attach themselves to TAB.
19743 See `org-ctrl-c-ctrl-c-hook' for more information.
19744 This hook runs after it has been established that not table field motion and
19745 not visibility should be done because of current context. This is probably
19746 the place where a package like yasnippets can hook in.")
19748 (defvar org-tab-before-tab-emulation-hook nil
19749 "Hook for functions to attach themselves to TAB.
19750 See `org-ctrl-c-ctrl-c-hook' for more information.
19751 This hook runs after every other options for TAB have been exhausted, but
19752 before indentation and \t insertion takes place.")
19754 (defvar org-metaleft-hook nil
19755 "Hook for functions attaching themselves to `M-left'.
19756 See `org-ctrl-c-ctrl-c-hook' for more information.")
19757 (defvar org-metaright-hook nil
19758 "Hook for functions attaching themselves to `M-right'.
19759 See `org-ctrl-c-ctrl-c-hook' for more information.")
19760 (defvar org-metaup-hook nil
19761 "Hook for functions attaching themselves to `M-up'.
19762 See `org-ctrl-c-ctrl-c-hook' for more information.")
19763 (defvar org-metadown-hook nil
19764 "Hook for functions attaching themselves to `M-down'.
19765 See `org-ctrl-c-ctrl-c-hook' for more information.")
19766 (defvar org-shiftmetaleft-hook nil
19767 "Hook for functions attaching themselves to `M-S-left'.
19768 See `org-ctrl-c-ctrl-c-hook' for more information.")
19769 (defvar org-shiftmetaright-hook nil
19770 "Hook for functions attaching themselves to `M-S-right'.
19771 See `org-ctrl-c-ctrl-c-hook' for more information.")
19772 (defvar org-shiftmetaup-hook nil
19773 "Hook for functions attaching themselves to `M-S-up'.
19774 See `org-ctrl-c-ctrl-c-hook' for more information.")
19775 (defvar org-shiftmetadown-hook nil
19776 "Hook for functions attaching themselves to `M-S-down'.
19777 See `org-ctrl-c-ctrl-c-hook' for more information.")
19778 (defvar org-metareturn-hook nil
19779 "Hook for functions attaching themselves to `M-RET'.
19780 See `org-ctrl-c-ctrl-c-hook' for more information.")
19781 (defvar org-shiftup-hook nil
19782 "Hook for functions attaching themselves to `S-up'.
19783 See `org-ctrl-c-ctrl-c-hook' for more information.")
19784 (defvar org-shiftup-final-hook nil
19785 "Hook for functions attaching themselves to `S-up'.
19786 This one runs after all other options except shift-select have been excluded.
19787 See `org-ctrl-c-ctrl-c-hook' for more information.")
19788 (defvar org-shiftdown-hook nil
19789 "Hook for functions attaching themselves to `S-down'.
19790 See `org-ctrl-c-ctrl-c-hook' for more information.")
19791 (defvar org-shiftdown-final-hook nil
19792 "Hook for functions attaching themselves to `S-down'.
19793 This one runs after all other options except shift-select have been excluded.
19794 See `org-ctrl-c-ctrl-c-hook' for more information.")
19795 (defvar org-shiftleft-hook nil
19796 "Hook for functions attaching themselves to `S-left'.
19797 See `org-ctrl-c-ctrl-c-hook' for more information.")
19798 (defvar org-shiftleft-final-hook nil
19799 "Hook for functions attaching themselves to `S-left'.
19800 This one runs after all other options except shift-select have been excluded.
19801 See `org-ctrl-c-ctrl-c-hook' for more information.")
19802 (defvar org-shiftright-hook nil
19803 "Hook for functions attaching themselves to `S-right'.
19804 See `org-ctrl-c-ctrl-c-hook' for more information.")
19805 (defvar org-shiftright-final-hook nil
19806 "Hook for functions attaching themselves to `S-right'.
19807 This one runs after all other options except shift-select have been excluded.
19808 See `org-ctrl-c-ctrl-c-hook' for more information.")
19810 (defun org-modifier-cursor-error ()
19811 "Throw an error, a modified cursor command was applied in wrong context."
19812 (user-error "This command is active in special context like tables, headlines or items"))
19814 (defun org-shiftselect-error ()
19815 "Throw an error because Shift-Cursor command was applied in wrong context."
19816 (if (and (boundp 'shift-select-mode) shift-select-mode)
19817 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19818 (user-error "This command works only in special context like headlines or timestamps")))
19820 (defun org-call-for-shift-select (cmd)
19821 (let ((this-command-keys-shift-translated t))
19822 (call-interactively cmd)))
19824 (defun org-shifttab (&optional arg)
19825 "Global visibility cycling or move to previous table field.
19826 Call `org-table-previous-field' within a table.
19827 When ARG is nil, cycle globally through visibility states.
19828 When ARG is a numeric prefix, show contents of this level."
19829 (interactive "P")
19830 (cond
19831 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19832 ((integerp arg)
19833 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19834 (message "Content view to level: %d" arg)
19835 (org-content (prefix-numeric-value arg2))
19836 (org-cycle-show-empty-lines t)
19837 (setq org-cycle-global-status 'overview)))
19838 (t (call-interactively 'org-global-cycle))))
19840 (defun org-shiftmetaleft ()
19841 "Promote subtree or delete table column.
19842 Calls `org-promote-subtree', `org-outdent-item-tree', or
19843 `org-table-delete-column', depending on context. See the
19844 individual commands for more information."
19845 (interactive)
19846 (cond
19847 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19848 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19849 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19850 ((if (not (org-region-active-p)) (org-at-item-p)
19851 (save-excursion (goto-char (region-beginning))
19852 (org-at-item-p)))
19853 (call-interactively 'org-outdent-item-tree))
19854 (t (org-modifier-cursor-error))))
19856 (defun org-shiftmetaright ()
19857 "Demote subtree or insert table column.
19858 Calls `org-demote-subtree', `org-indent-item-tree', or
19859 `org-table-insert-column', depending on context. See the
19860 individual commands for more information."
19861 (interactive)
19862 (cond
19863 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19864 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19865 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19866 ((if (not (org-region-active-p)) (org-at-item-p)
19867 (save-excursion (goto-char (region-beginning))
19868 (org-at-item-p)))
19869 (call-interactively 'org-indent-item-tree))
19870 (t (org-modifier-cursor-error))))
19872 (defun org-shiftmetaup (&optional arg)
19873 "Move subtree up or kill table row.
19874 Calls `org-move-subtree-up' or `org-table-kill-row' or
19875 `org-move-item-up' or `org-timestamp-up', depending on context.
19876 See the individual commands for more information."
19877 (interactive "P")
19878 (cond
19879 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19880 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19881 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19882 ((org-at-item-p) (call-interactively 'org-move-item-up))
19883 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19884 (call-interactively 'org-timestamp-up)))
19885 (t (call-interactively 'org-drag-line-backward))))
19887 (defun org-shiftmetadown (&optional arg)
19888 "Move subtree down or insert table row.
19889 Calls `org-move-subtree-down' or `org-table-insert-row' or
19890 `org-move-item-down' or `org-timestamp-up', depending on context.
19891 See the individual commands for more information."
19892 (interactive "P")
19893 (cond
19894 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19895 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19896 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19897 ((org-at-item-p) (call-interactively 'org-move-item-down))
19898 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19899 (call-interactively 'org-timestamp-down)))
19900 (t (call-interactively 'org-drag-line-forward))))
19902 (defsubst org-hidden-tree-error ()
19903 (user-error
19904 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19906 (defun org-metaleft (&optional arg)
19907 "Promote heading or move table column to left.
19908 Calls `org-do-promote' or `org-table-move-column', depending on context.
19909 With no specific context, calls the Emacs default `backward-word'.
19910 See the individual commands for more information."
19911 (interactive "P")
19912 (cond
19913 ((run-hook-with-args-until-success 'org-metaleft-hook))
19914 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19915 ((org-with-limited-levels
19916 (or (org-at-heading-p)
19917 (and (org-region-active-p)
19918 (save-excursion
19919 (goto-char (region-beginning))
19920 (org-at-heading-p)))))
19921 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19922 (call-interactively 'org-do-promote))
19923 ;; At an inline task.
19924 ((org-at-heading-p)
19925 (call-interactively 'org-inlinetask-promote))
19926 ((or (org-at-item-p)
19927 (and (org-region-active-p)
19928 (save-excursion
19929 (goto-char (region-beginning))
19930 (org-at-item-p))))
19931 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19932 (call-interactively 'org-outdent-item))
19933 (t (call-interactively 'backward-word))))
19935 (defun org-metaright (&optional arg)
19936 "Demote a subtree, a list item or move table column to right.
19937 In front of a drawer or a block keyword, indent it correctly.
19938 With no specific context, calls the Emacs default `forward-word'.
19939 See the individual commands for more information."
19940 (interactive "P")
19941 (cond
19942 ((run-hook-with-args-until-success 'org-metaright-hook))
19943 ((org-at-table-p) (call-interactively 'org-table-move-column))
19944 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19945 ((org-at-block-p) (call-interactively 'org-indent-block))
19946 ((org-with-limited-levels
19947 (or (org-at-heading-p)
19948 (and (org-region-active-p)
19949 (save-excursion
19950 (goto-char (region-beginning))
19951 (org-at-heading-p)))))
19952 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19953 (call-interactively 'org-do-demote))
19954 ;; At an inline task.
19955 ((org-at-heading-p)
19956 (call-interactively 'org-inlinetask-demote))
19957 ((or (org-at-item-p)
19958 (and (org-region-active-p)
19959 (save-excursion
19960 (goto-char (region-beginning))
19961 (org-at-item-p))))
19962 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19963 (call-interactively 'org-indent-item))
19964 (t (call-interactively 'forward-word))))
19966 (defun org-check-for-hidden (what)
19967 "Check if there are hidden headlines/items in the current visual line.
19968 WHAT can be either `headlines' or `items'. If the current line is
19969 an outline or item heading and it has a folded subtree below it,
19970 this function returns t, nil otherwise."
19971 (let ((re (cond
19972 ((eq what 'headlines) org-outline-regexp-bol)
19973 ((eq what 'items) (org-item-beginning-re))
19974 (t (error "This should not happen"))))
19975 beg end)
19976 (save-excursion
19977 (catch 'exit
19978 (unless (org-region-active-p)
19979 (setq beg (point-at-bol))
19980 (beginning-of-line 2)
19981 (while (and (not (eobp)) ;; this is like `next-line'
19982 (get-char-property (1- (point)) 'invisible))
19983 (beginning-of-line 2))
19984 (setq end (point))
19985 (goto-char beg)
19986 (goto-char (point-at-eol))
19987 (setq end (max end (point)))
19988 (while (re-search-forward re end t)
19989 (if (get-char-property (match-beginning 0) 'invisible)
19990 (throw 'exit t))))
19991 nil))))
19993 (defun org-metaup (&optional arg)
19994 "Move subtree up or move table row up.
19995 Calls `org-move-subtree-up' or `org-table-move-row' or
19996 `org-move-item-up', depending on context. See the individual commands
19997 for more information."
19998 (interactive "P")
19999 (cond
20000 ((run-hook-with-args-until-success 'org-metaup-hook))
20001 ((org-region-active-p)
20002 (let* ((a (min (region-beginning) (region-end)))
20003 (b (1- (max (region-beginning) (region-end))))
20004 (c (save-excursion (goto-char a)
20005 (move-beginning-of-line 0)))
20006 (d (save-excursion (goto-char a)
20007 (move-end-of-line 0) (point))))
20008 (transpose-regions a b c d)
20009 (goto-char c)))
20010 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
20011 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
20012 ((org-at-item-p) (call-interactively 'org-move-item-up))
20013 (t (org-drag-element-backward))))
20015 (defun org-metadown (&optional arg)
20016 "Move subtree down or move table row down.
20017 Calls `org-move-subtree-down' or `org-table-move-row' or
20018 `org-move-item-down', depending on context. See the individual
20019 commands for more information."
20020 (interactive "P")
20021 (cond
20022 ((run-hook-with-args-until-success 'org-metadown-hook))
20023 ((org-region-active-p)
20024 (let* ((a (min (region-beginning) (region-end)))
20025 (b (max (region-beginning) (region-end)))
20026 (c (save-excursion (goto-char b)
20027 (move-beginning-of-line 1)))
20028 (d (save-excursion (goto-char b)
20029 (move-end-of-line 1) (1+ (point)))))
20030 (transpose-regions a b c d)
20031 (goto-char d)))
20032 ((org-at-table-p) (call-interactively 'org-table-move-row))
20033 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20034 ((org-at-item-p) (call-interactively 'org-move-item-down))
20035 (t (org-drag-element-forward))))
20037 (defun org-shiftup (&optional arg)
20038 "Increase item in timestamp or increase priority of current headline.
20039 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20040 depending on context. See the individual commands for more information."
20041 (interactive "P")
20042 (cond
20043 ((run-hook-with-args-until-success 'org-shiftup-hook))
20044 ((and org-support-shift-select (org-region-active-p))
20045 (org-call-for-shift-select 'previous-line))
20046 ((org-at-timestamp-p t)
20047 (call-interactively (if org-edit-timestamp-down-means-later
20048 'org-timestamp-down 'org-timestamp-up)))
20049 ((and (not (eq org-support-shift-select 'always))
20050 org-enable-priority-commands
20051 (org-at-heading-p))
20052 (call-interactively 'org-priority-up))
20053 ((and (not org-support-shift-select) (org-at-item-p))
20054 (call-interactively 'org-previous-item))
20055 ((org-clocktable-try-shift 'up arg))
20056 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20057 (org-support-shift-select
20058 (org-call-for-shift-select 'previous-line))
20059 (t (org-shiftselect-error))))
20061 (defun org-shiftdown (&optional arg)
20062 "Decrease item in timestamp or decrease priority of current headline.
20063 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20064 depending on context. See the individual commands for more information."
20065 (interactive "P")
20066 (cond
20067 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20068 ((and org-support-shift-select (org-region-active-p))
20069 (org-call-for-shift-select 'next-line))
20070 ((org-at-timestamp-p t)
20071 (call-interactively (if org-edit-timestamp-down-means-later
20072 'org-timestamp-up 'org-timestamp-down)))
20073 ((and (not (eq org-support-shift-select 'always))
20074 org-enable-priority-commands
20075 (org-at-heading-p))
20076 (call-interactively 'org-priority-down))
20077 ((and (not org-support-shift-select) (org-at-item-p))
20078 (call-interactively 'org-next-item))
20079 ((org-clocktable-try-shift 'down arg))
20080 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20081 (org-support-shift-select
20082 (org-call-for-shift-select 'next-line))
20083 (t (org-shiftselect-error))))
20085 (defun org-shiftright (&optional arg)
20086 "Cycle the thing at point or in the current line, depending on context.
20087 Depending on context, this does one of the following:
20089 - switch a timestamp at point one day into the future
20090 - on a headline, switch to the next TODO keyword.
20091 - on an item, switch entire list to the next bullet type
20092 - on a property line, switch to the next allowed value
20093 - on a clocktable definition line, move time block into the future"
20094 (interactive "P")
20095 (cond
20096 ((run-hook-with-args-until-success 'org-shiftright-hook))
20097 ((and org-support-shift-select (org-region-active-p))
20098 (org-call-for-shift-select 'forward-char))
20099 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20100 ((and (not (eq org-support-shift-select 'always))
20101 (org-at-heading-p))
20102 (let ((org-inhibit-logging
20103 (not org-treat-S-cursor-todo-selection-as-state-change))
20104 (org-inhibit-blocking
20105 (not org-treat-S-cursor-todo-selection-as-state-change)))
20106 (org-call-with-arg 'org-todo 'right)))
20107 ((or (and org-support-shift-select
20108 (not (eq org-support-shift-select 'always))
20109 (org-at-item-bullet-p))
20110 (and (not org-support-shift-select) (org-at-item-p)))
20111 (org-call-with-arg 'org-cycle-list-bullet nil))
20112 ((and (not (eq org-support-shift-select 'always))
20113 (org-at-property-p))
20114 (call-interactively 'org-property-next-allowed-value))
20115 ((org-clocktable-try-shift 'right arg))
20116 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20117 (org-support-shift-select
20118 (org-call-for-shift-select 'forward-char))
20119 (t (org-shiftselect-error))))
20121 (defun org-shiftleft (&optional arg)
20122 "Cycle the thing at point or in the current line, depending on context.
20123 Depending on context, this does one of the following:
20125 - switch a timestamp at point one day into the past
20126 - on a headline, switch to the previous TODO keyword.
20127 - on an item, switch entire list to the previous bullet type
20128 - on a property line, switch to the previous allowed value
20129 - on a clocktable definition line, move time block into the past"
20130 (interactive "P")
20131 (cond
20132 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20133 ((and org-support-shift-select (org-region-active-p))
20134 (org-call-for-shift-select 'backward-char))
20135 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20136 ((and (not (eq org-support-shift-select 'always))
20137 (org-at-heading-p))
20138 (let ((org-inhibit-logging
20139 (not org-treat-S-cursor-todo-selection-as-state-change))
20140 (org-inhibit-blocking
20141 (not org-treat-S-cursor-todo-selection-as-state-change)))
20142 (org-call-with-arg 'org-todo 'left)))
20143 ((or (and org-support-shift-select
20144 (not (eq org-support-shift-select 'always))
20145 (org-at-item-bullet-p))
20146 (and (not org-support-shift-select) (org-at-item-p)))
20147 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20148 ((and (not (eq org-support-shift-select 'always))
20149 (org-at-property-p))
20150 (call-interactively 'org-property-previous-allowed-value))
20151 ((org-clocktable-try-shift 'left arg))
20152 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20153 (org-support-shift-select
20154 (org-call-for-shift-select 'backward-char))
20155 (t (org-shiftselect-error))))
20157 (defun org-shiftcontrolright ()
20158 "Switch to next TODO set."
20159 (interactive)
20160 (cond
20161 ((and org-support-shift-select (org-region-active-p))
20162 (org-call-for-shift-select 'forward-word))
20163 ((and (not (eq org-support-shift-select 'always))
20164 (org-at-heading-p))
20165 (org-call-with-arg 'org-todo 'nextset))
20166 (org-support-shift-select
20167 (org-call-for-shift-select 'forward-word))
20168 (t (org-shiftselect-error))))
20170 (defun org-shiftcontrolleft ()
20171 "Switch to previous TODO set."
20172 (interactive)
20173 (cond
20174 ((and org-support-shift-select (org-region-active-p))
20175 (org-call-for-shift-select 'backward-word))
20176 ((and (not (eq org-support-shift-select 'always))
20177 (org-at-heading-p))
20178 (org-call-with-arg 'org-todo 'previousset))
20179 (org-support-shift-select
20180 (org-call-for-shift-select 'backward-word))
20181 (t (org-shiftselect-error))))
20183 (defun org-shiftcontrolup (&optional n)
20184 "Change timestamps synchronously up in CLOCK log lines.
20185 Optional argument N tells to change by that many units."
20186 (interactive "P")
20187 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20188 (let (org-support-shift-select)
20189 (org-clock-timestamps-up n))
20190 (user-error "Not at a clock log")))
20192 (defun org-shiftcontroldown (&optional n)
20193 "Change timestamps synchronously down in CLOCK log lines.
20194 Optional argument N tells to change by that many units."
20195 (interactive "P")
20196 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20197 (let (org-support-shift-select)
20198 (org-clock-timestamps-down n))
20199 (user-error "Not at a clock log")))
20201 (defun org-ctrl-c-ret ()
20202 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20203 (interactive)
20204 (cond
20205 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20206 (t (call-interactively 'org-insert-heading))))
20208 (defun org-find-visible ()
20209 (let ((s (point)))
20210 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20211 (get-char-property s 'invisible)))
20213 (defun org-find-invisible ()
20214 (let ((s (point)))
20215 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20216 (not (get-char-property s 'invisible))))
20219 (defun org-copy-visible (beg end)
20220 "Copy the visible parts of the region."
20221 (interactive "r")
20222 (let (snippets s)
20223 (save-excursion
20224 (save-restriction
20225 (narrow-to-region beg end)
20226 (setq s (goto-char (point-min)))
20227 (while (not (= (point) (point-max)))
20228 (goto-char (org-find-invisible))
20229 (push (buffer-substring s (point)) snippets)
20230 (setq s (goto-char (org-find-visible))))))
20231 (kill-new (apply 'concat (nreverse snippets)))))
20233 (defun org-copy-special ()
20234 "Copy region in table or copy current subtree.
20235 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20236 See the individual commands for more information."
20237 (interactive)
20238 (call-interactively
20239 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20241 (defun org-cut-special ()
20242 "Cut region in table or cut current subtree.
20243 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20244 See the individual commands for more information."
20245 (interactive)
20246 (call-interactively
20247 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20249 (defun org-paste-special (arg)
20250 "Paste rectangular region into table, or past subtree relative to level.
20251 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20252 See the individual commands for more information."
20253 (interactive "P")
20254 (if (org-at-table-p)
20255 (org-table-paste-rectangle)
20256 (org-paste-subtree arg)))
20258 (defsubst org-in-fixed-width-region-p ()
20259 "Is point in a fixed-width region?"
20260 (save-match-data
20261 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20263 (defun org-edit-special (&optional arg)
20264 "Call a special editor for the element at point.
20265 When at a table, call the formula editor with `org-table-edit-formulas'.
20266 When in a source code block, call `org-edit-src-code'.
20267 When in a fixed-width region, call `org-edit-fixed-width-region'.
20268 When at an #+INCLUDE keyword, visit the included file.
20269 On a link, call `ffap' to visit the link at point.
20270 Otherwise, return a user error."
20271 (interactive "P")
20272 (let ((element (org-element-at-point)))
20273 (assert (not buffer-read-only) nil
20274 "Buffer is read-only: %s" (buffer-name))
20275 (case (org-element-type element)
20276 (src-block
20277 (if (not arg) (org-edit-src-code)
20278 (let* ((info (org-babel-get-src-block-info))
20279 (lang (nth 0 info))
20280 (params (nth 2 info))
20281 (session (cdr (assq :session params))))
20282 (if (not session) (org-edit-src-code)
20283 ;; At a src-block with a session and function called with
20284 ;; an ARG: switch to the buffer related to the inferior
20285 ;; process.
20286 (switch-to-buffer
20287 (funcall (intern (concat "org-babel-prep-session:" lang))
20288 session params))))))
20289 (keyword
20290 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20291 (find-file-other-window
20292 (org-remove-double-quotes
20293 (car (org-split-string (org-element-property :value element)))))
20294 (user-error "No special environment to edit here")))
20295 (table
20296 (if (eq (org-element-property :type element) 'table.el)
20297 (org-edit-src-code)
20298 (call-interactively 'org-table-edit-formulas)))
20299 ;; Only Org tables contain `table-row' type elements.
20300 (table-row (call-interactively 'org-table-edit-formulas))
20301 ((example-block export-block) (org-edit-src-code))
20302 (fixed-width (org-edit-fixed-width-region))
20303 (otherwise
20304 ;; No notable element at point. Though, we may be at a link,
20305 ;; which is an object. Thus, scan deeper.
20306 (if (eq (org-element-type (org-element-context element)) 'link)
20307 (call-interactively 'ffap)
20308 (user-error "No special environment to edit here"))))))
20310 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20311 (defun org-ctrl-c-ctrl-c (&optional arg)
20312 "Set tags in headline, or update according to changed information at point.
20314 This command does many different things, depending on context:
20316 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20317 this is what we do.
20319 - If the cursor is on a statistics cookie, update it.
20321 - If the cursor is in a headline, prompt for tags and insert them
20322 into the current line, aligned to `org-tags-column'. When called
20323 with prefix arg, realign all tags in the current buffer.
20325 - If the cursor is in one of the special #+KEYWORD lines, this
20326 triggers scanning the buffer for these lines and updating the
20327 information.
20329 - If the cursor is inside a table, realign the table. This command
20330 works even if the automatic table editor has been turned off.
20332 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20333 the entire table.
20335 - If the cursor is at a footnote reference or definition, jump to
20336 the corresponding definition or references, respectively.
20338 - If the cursor is a the beginning of a dynamic block, update it.
20340 - If the current buffer is a capture buffer, close note and file it.
20342 - If the cursor is on a <<<target>>>, update radio targets and
20343 corresponding links in this buffer.
20345 - If the cursor is on a numbered item in a plain list, renumber the
20346 ordered list.
20348 - If the cursor is on a checkbox, toggle it.
20350 - If the cursor is on a code block, evaluate it. The variable
20351 `org-confirm-babel-evaluate' can be used to control prompting
20352 before code block evaluation, by default every code block
20353 evaluation requires confirmation. Code block evaluation can be
20354 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20355 (interactive "P")
20356 (cond
20357 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20358 org-occur-highlights
20359 org-latex-fragment-image-overlays)
20360 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20361 (org-remove-occur-highlights)
20362 (org-remove-latex-fragment-image-overlays)
20363 (message "Temporary highlights/overlays removed from current buffer"))
20364 ((and (local-variable-p 'org-finish-function (current-buffer))
20365 (fboundp org-finish-function))
20366 (funcall org-finish-function))
20367 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20369 (let* ((context (org-element-context)) (type (org-element-type context)))
20370 ;; Test if point is within a blank line.
20371 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20372 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20373 (user-error "C-c C-c can do nothing useful at this location"))
20374 (case type
20375 ;; When at a link, act according to the parent instead.
20376 (link (setq context (org-element-property :parent context))
20377 (setq type (org-element-type context)))
20378 ;; Unsupported object types: check parent element instead.
20379 ((bold code entity export-snippet inline-babel-call inline-src-block
20380 italic latex-fragment line-break macro strike-through subscript
20381 superscript underline verbatim)
20382 (while (and (setq context (org-element-property :parent context))
20383 (not (memq (setq type (org-element-type context))
20384 '(paragraph verse-block)))))))
20385 ;; For convenience: at the first line of a paragraph on the
20386 ;; same line as an item, apply function on that item instead.
20387 (when (eq type 'paragraph)
20388 (let ((parent (org-element-property :parent context)))
20389 (when (and (eq (org-element-type parent) 'item)
20390 (= (point-at-bol) (org-element-property :begin parent)))
20391 (setq context parent type 'item))))
20392 ;; Act according to type of element or object at point.
20393 (case type
20394 (clock (org-clock-update-time-maybe))
20395 (dynamic-block
20396 (save-excursion
20397 (goto-char (org-element-property :post-affiliated context))
20398 (org-update-dblock)))
20399 (footnote-definition
20400 (goto-char (org-element-property :post-affiliated context))
20401 (call-interactively 'org-footnote-action))
20402 (footnote-reference (call-interactively 'org-footnote-action))
20403 ((headline inlinetask)
20404 (save-excursion (goto-char (org-element-property :begin context))
20405 (call-interactively 'org-set-tags)))
20406 (item
20407 ;; At an item: a double C-u set checkbox to "[-]"
20408 ;; unconditionally, whereas a single one will toggle its
20409 ;; presence. Without an universal argument, if the item
20410 ;; has a checkbox, toggle it. Otherwise repair the list.
20411 (let* ((box (org-element-property :checkbox context))
20412 (struct (org-element-property :structure context))
20413 (old-struct (copy-tree struct))
20414 (parents (org-list-parents-alist struct))
20415 (prevs (org-list-prevs-alist struct))
20416 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20417 (org-list-set-checkbox
20418 (org-element-property :begin context) struct
20419 (cond ((equal arg '(16)) "[-]")
20420 ((and (not box) (equal arg '(4))) "[ ]")
20421 ((or (not box) (equal arg '(4))) nil)
20422 ((eq box 'on) "[ ]")
20423 (t "[X]")))
20424 ;; Mimic `org-list-write-struct' but with grabbing
20425 ;; a return value from `org-list-struct-fix-box'.
20426 (org-list-struct-fix-ind struct parents 2)
20427 (org-list-struct-fix-item-end struct)
20428 (org-list-struct-fix-bul struct prevs)
20429 (org-list-struct-fix-ind struct parents)
20430 (let ((block-item
20431 (org-list-struct-fix-box struct parents prevs orderedp)))
20432 (if (and box (equal struct old-struct))
20433 (if (equal arg '(16))
20434 (message "Checkboxes already reset")
20435 (user-error "Cannot toggle this checkbox: %s"
20436 (if (eq box 'on)
20437 "all subitems checked"
20438 "unchecked subitems")))
20439 (org-list-struct-apply-struct struct old-struct)
20440 (org-update-checkbox-count-maybe))
20441 (when block-item
20442 (message "Checkboxes were removed due to empty box at line %d"
20443 (org-current-line block-item))))))
20444 (keyword
20445 (let ((org-inhibit-startup-visibility-stuff t)
20446 (org-startup-align-all-tables nil))
20447 (when (boundp 'org-table-coordinate-overlays)
20448 (mapc 'delete-overlay org-table-coordinate-overlays)
20449 (setq org-table-coordinate-overlays nil))
20450 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20451 (message "Local setup has been refreshed"))
20452 (plain-list
20453 ;; At a plain list, with a double C-u argument, set
20454 ;; checkboxes of each item to "[-]", whereas a single one
20455 ;; will toggle their presence according to the state of the
20456 ;; first item in the list. Without an argument, repair the
20457 ;; list.
20458 (let* ((begin (org-element-property :contents-begin context))
20459 (beginm (move-marker (make-marker) begin))
20460 (struct (org-element-property :structure context))
20461 (old-struct (copy-tree struct))
20462 (first-box (save-excursion
20463 (goto-char begin)
20464 (looking-at org-list-full-item-re)
20465 (match-string-no-properties 3)))
20466 (new-box (cond ((equal arg '(16)) "[-]")
20467 ((equal arg '(4)) (unless first-box "[ ]"))
20468 ((equal first-box "[X]") "[ ]")
20469 (t "[X]"))))
20470 (cond
20471 (arg
20472 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20473 (org-list-get-all-items
20474 begin struct (org-list-prevs-alist struct))))
20475 ((and first-box (eq (point) begin))
20476 ;; For convenience, when point is at bol on the first
20477 ;; item of the list and no argument is provided, simply
20478 ;; toggle checkbox of that item, if any.
20479 (org-list-set-checkbox begin struct new-box)))
20480 (org-list-write-struct
20481 struct (org-list-parents-alist struct) old-struct)
20482 (org-update-checkbox-count-maybe)
20483 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20484 ((property-drawer node-property)
20485 (call-interactively 'org-property-action))
20486 ((radio-target target)
20487 (call-interactively 'org-update-radio-target-regexp))
20488 (statistics-cookie
20489 (call-interactively 'org-update-statistics-cookies))
20490 ((table table-cell table-row)
20491 ;; At a table, recalculate every field and align it. Also
20492 ;; send the table if necessary. If the table has
20493 ;; a `table.el' type, just give up. At a table row or
20494 ;; cell, maybe recalculate line but always align table.
20495 (if (eq (org-element-property :type context) 'table.el)
20496 (message "Use C-c ' to edit table.el tables")
20497 (let ((org-enable-table-editor t))
20498 (if (or (eq type 'table)
20499 ;; Check if point is at a TBLFM line.
20500 (and (eq type 'table-row)
20501 (= (point) (org-element-property :end context))))
20502 (save-excursion
20503 (if (org-at-TBLFM-p)
20504 (progn (require 'org-table)
20505 (org-table-calc-current-TBLFM))
20506 (goto-char (org-element-property :contents-begin context))
20507 (org-call-with-arg 'org-table-recalculate (or arg t))
20508 (orgtbl-send-table 'maybe)))
20509 (org-table-maybe-eval-formula)
20510 (cond (arg (call-interactively 'org-table-recalculate))
20511 ((org-table-maybe-recalculate-line))
20512 (t (org-table-align)))))))
20513 (timestamp (org-timestamp-change 0 'day))
20514 (otherwise
20515 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20516 (user-error
20517 "C-c C-c can do nothing useful at this location")))))))))
20519 (defun org-mode-restart ()
20520 (interactive)
20521 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20522 (funcall major-mode)
20523 (hack-local-variables)
20524 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20525 (org-indent-mode -1)))
20526 (message "%s restarted" major-mode))
20528 (defun org-kill-note-or-show-branches ()
20529 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20530 (interactive)
20531 (if (not org-finish-function)
20532 (progn
20533 (hide-subtree)
20534 (call-interactively 'show-branches))
20535 (let ((org-note-abort t))
20536 (funcall org-finish-function))))
20538 (defun org-open-line (n)
20539 "Insert a new row in tables, call `open-line' elsewhere.
20540 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20541 (interactive "*p")
20542 (cond
20543 ((not org-special-ctrl-o)
20544 (open-line n))
20545 ((org-at-table-p)
20546 (org-table-insert-row))
20548 (open-line n))))
20550 (defun org-return (&optional indent)
20551 "Goto next table row or insert a newline.
20552 Calls `org-table-next-row' or `newline', depending on context.
20553 See the individual commands for more information."
20554 (interactive)
20555 (let (org-ts-what)
20556 (cond
20557 ((or (bobp) (org-in-src-block-p))
20558 (if indent (newline-and-indent) (newline)))
20559 ((org-at-table-p)
20560 (org-table-justify-field-maybe)
20561 (call-interactively 'org-table-next-row))
20562 ;; when `newline-and-indent' is called within a list, make sure
20563 ;; text moved stays inside the item.
20564 ((and (org-in-item-p) indent)
20565 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20566 (progn
20567 (save-match-data (newline))
20568 (org-indent-line-to (length (match-string 0))))
20569 (let ((ind (org-get-indentation)))
20570 (newline)
20571 (if (org-looking-back org-list-end-re)
20572 (org-indent-line)
20573 (org-indent-line-to ind)))))
20574 ((and org-return-follows-link
20575 (org-at-timestamp-p t)
20576 (not (eq org-ts-what 'after)))
20577 (org-follow-timestamp-link))
20578 ((and org-return-follows-link
20579 (let ((tprop (get-text-property (point) 'face)))
20580 (or (eq tprop 'org-link)
20581 (and (listp tprop) (memq 'org-link tprop)))))
20582 (call-interactively 'org-open-at-point))
20583 ((and (org-at-heading-p)
20584 (looking-at
20585 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20586 (org-show-entry)
20587 (end-of-line 1)
20588 (newline))
20589 (t (if indent (newline-and-indent) (newline))))))
20591 (defun org-return-indent ()
20592 "Goto next table row or insert a newline and indent.
20593 Calls `org-table-next-row' or `newline-and-indent', depending on
20594 context. See the individual commands for more information."
20595 (interactive)
20596 (org-return t))
20598 (defun org-ctrl-c-star ()
20599 "Compute table, or change heading status of lines.
20600 Calls `org-table-recalculate' or `org-toggle-heading',
20601 depending on context."
20602 (interactive)
20603 (cond
20604 ((org-at-table-p)
20605 (call-interactively 'org-table-recalculate))
20607 ;; Convert all lines in region to list items
20608 (call-interactively 'org-toggle-heading))))
20610 (defun org-ctrl-c-minus ()
20611 "Insert separator line in table or modify bullet status of line.
20612 Also turns a plain line or a region of lines into list items.
20613 Calls `org-table-insert-hline', `org-toggle-item', or
20614 `org-cycle-list-bullet', depending on context."
20615 (interactive)
20616 (cond
20617 ((org-at-table-p)
20618 (call-interactively 'org-table-insert-hline))
20619 ((org-region-active-p)
20620 (call-interactively 'org-toggle-item))
20621 ((org-in-item-p)
20622 (call-interactively 'org-cycle-list-bullet))
20624 (call-interactively 'org-toggle-item))))
20626 (defun org-toggle-item (arg)
20627 "Convert headings or normal lines to items, items to normal lines.
20628 If there is no active region, only the current line is considered.
20630 If the first non blank line in the region is a headline, convert
20631 all headlines to items, shifting text accordingly.
20633 If it is an item, convert all items to normal lines.
20635 If it is normal text, change region into a list of items.
20636 With a prefix argument ARG, change the region in a single item."
20637 (interactive "P")
20638 (let ((shift-text
20639 (function
20640 ;; Shift text in current section to IND, from point to END.
20641 ;; The function leaves point to END line.
20642 (lambda (ind end)
20643 (let ((min-i 1000) (end (copy-marker end)))
20644 ;; First determine the minimum indentation (MIN-I) of
20645 ;; the text.
20646 (save-excursion
20647 (catch 'exit
20648 (while (< (point) end)
20649 (let ((i (org-get-indentation)))
20650 (cond
20651 ;; Skip blank lines and inline tasks.
20652 ((looking-at "^[ \t]*$"))
20653 ((looking-at org-outline-regexp-bol))
20654 ;; We can't find less than 0 indentation.
20655 ((zerop i) (throw 'exit (setq min-i 0)))
20656 ((< i min-i) (setq min-i i))))
20657 (forward-line))))
20658 ;; Then indent each line so that a line indented to
20659 ;; MIN-I becomes indented to IND. Ignore blank lines
20660 ;; and inline tasks in the process.
20661 (let ((delta (- ind min-i)))
20662 (while (< (point) end)
20663 (unless (or (looking-at "^[ \t]*$")
20664 (looking-at org-outline-regexp-bol))
20665 (org-indent-line-to (+ (org-get-indentation) delta)))
20666 (forward-line)))))))
20667 (skip-blanks
20668 (function
20669 ;; Return beginning of first non-blank line, starting from
20670 ;; line at POS.
20671 (lambda (pos)
20672 (save-excursion
20673 (goto-char pos)
20674 (skip-chars-forward " \r\t\n")
20675 (point-at-bol)))))
20676 beg end)
20677 ;; Determine boundaries of changes.
20678 (if (org-region-active-p)
20679 (setq beg (funcall skip-blanks (region-beginning))
20680 end (copy-marker (region-end)))
20681 (setq beg (funcall skip-blanks (point-at-bol))
20682 end (copy-marker (point-at-eol))))
20683 ;; Depending on the starting line, choose an action on the text
20684 ;; between BEG and END.
20685 (org-with-limited-levels
20686 (save-excursion
20687 (goto-char beg)
20688 (cond
20689 ;; Case 1. Start at an item: de-itemize. Note that it only
20690 ;; happens when a region is active: `org-ctrl-c-minus'
20691 ;; would call `org-cycle-list-bullet' otherwise.
20692 ((org-at-item-p)
20693 (while (< (point) end)
20694 (when (org-at-item-p)
20695 (skip-chars-forward " \t")
20696 (delete-region (point) (match-end 0)))
20697 (forward-line)))
20698 ;; Case 2. Start at an heading: convert to items.
20699 ((org-at-heading-p)
20700 (let* ((bul (org-list-bullet-string "-"))
20701 (bul-len (length bul))
20702 (done (org-entry-is-done-p))
20703 (todo (org-entry-is-todo-p))
20704 ;; Indentation of the first heading. It should be
20705 ;; relative to the indentation of its parent, if any.
20706 (start-ind (save-excursion
20707 (cond
20708 ((not org-adapt-indentation) 0)
20709 ((not (outline-previous-heading)) 0)
20710 (t (length (match-string 0))))))
20711 ;; Level of first heading. Further headings will be
20712 ;; compared to it to determine hierarchy in the list.
20713 (ref-level (org-reduced-level (org-outline-level))))
20714 (when (or done todo) (org-todo ""))
20715 (while (< (point) end)
20716 (let* ((level (org-reduced-level (org-outline-level)))
20717 (delta (max 0 (- level ref-level))))
20718 ;; If current headline is less indented than the first
20719 ;; one, set it as reference, in order to preserve
20720 ;; subtrees.
20721 (when (< level ref-level) (setq ref-level level))
20722 (replace-match bul t t)
20723 (org-indent-line-to (+ start-ind (* delta bul-len)))
20724 (when (or done todo)
20725 (let* ((struct (org-list-struct))
20726 (old (copy-tree struct)))
20727 (org-list-set-checkbox (line-beginning-position)
20728 struct
20729 (if done "[X]" "[ ]"))
20730 (org-list-write-struct struct
20731 (org-list-parents-alist struct)
20732 old)))
20733 ;; Ensure all text down to END (or SECTION-END) belongs
20734 ;; to the newly created item.
20735 (let ((section-end (save-excursion
20736 (or (outline-next-heading) (point)))))
20737 (forward-line)
20738 (funcall shift-text
20739 (+ start-ind (* (1+ delta) bul-len))
20740 (min end section-end)))))))
20741 ;; Case 3. Normal line with ARG: make the first line of region
20742 ;; an item, and shift indentation of others lines to
20743 ;; set them as item's body.
20744 (arg (let* ((bul (org-list-bullet-string "-"))
20745 (bul-len (length bul))
20746 (ref-ind (org-get-indentation)))
20747 (skip-chars-forward " \t")
20748 (insert bul)
20749 (forward-line)
20750 (while (< (point) end)
20751 ;; Ensure that lines less indented than first one
20752 ;; still get included in item body.
20753 (funcall shift-text
20754 (+ ref-ind bul-len)
20755 (min end (save-excursion (or (outline-next-heading)
20756 (point)))))
20757 (forward-line))))
20758 ;; Case 4. Normal line without ARG: turn each non-item line
20759 ;; into an item.
20761 (while (< (point) end)
20762 (unless (or (org-at-heading-p) (org-at-item-p))
20763 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20764 (replace-match
20765 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20766 (forward-line))))))))
20768 (defun org-toggle-heading (&optional nstars)
20769 "Convert headings to normal text, or items or text to headings.
20770 If there is no active region, only convert the current line.
20772 With a \\[universal-argument] prefix, convert the whole list at
20773 point into heading.
20775 In a region:
20777 - If the first non blank line is a headline, remove the stars
20778 from all headlines in the region.
20780 - If it is a normal line, turn each and every normal line (i.e.,
20781 not an heading or an item) in the region into headings. If you
20782 want to convert only the first line of this region, use one
20783 universal prefix argument.
20785 - If it is a plain list item, turn all plain list items into headings.
20787 When converting a line into a heading, the number of stars is chosen
20788 such that the lines become children of the current entry. However,
20789 when a numeric prefix argument is given, its value determines the
20790 number of stars to add."
20791 (interactive "P")
20792 (let ((skip-blanks
20793 (function
20794 ;; Return beginning of first non-blank line, starting from
20795 ;; line at POS.
20796 (lambda (pos)
20797 (save-excursion
20798 (goto-char pos)
20799 (while (org-at-comment-p) (forward-line))
20800 (skip-chars-forward " \r\t\n")
20801 (point-at-bol)))))
20802 beg end toggled)
20803 ;; Determine boundaries of changes. If a universal prefix has
20804 ;; been given, put the list in a region. If region ends at a bol,
20805 ;; do not consider the last line to be in the region.
20807 (when (and current-prefix-arg (org-at-item-p))
20808 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20809 (org-mark-element))
20811 (if (org-region-active-p)
20812 (setq beg (funcall skip-blanks (region-beginning))
20813 end (copy-marker (save-excursion
20814 (goto-char (region-end))
20815 (if (bolp) (point) (point-at-eol)))))
20816 (setq beg (funcall skip-blanks (point-at-bol))
20817 end (copy-marker (point-at-eol))))
20818 ;; Ensure inline tasks don't count as headings.
20819 (org-with-limited-levels
20820 (save-excursion
20821 (goto-char beg)
20822 (cond
20823 ;; Case 1. Started at an heading: de-star headings.
20824 ((org-at-heading-p)
20825 (while (< (point) end)
20826 (when (org-at-heading-p t)
20827 (looking-at org-outline-regexp) (replace-match "")
20828 (setq toggled t))
20829 (forward-line)))
20830 ;; Case 2. Started at an item: change items into headlines.
20831 ;; One star will be added by `org-list-to-subtree'.
20832 ((org-at-item-p)
20833 (let* ((stars (make-string
20834 ;; subtract the star that will be added again by
20835 ;; `org-list-to-subtree'
20836 (if (numberp nstars) (1- nstars)
20837 (or (org-current-level) 0))
20838 ?*))
20839 (add-stars
20840 (cond (nstars "") ; stars from prefix only
20841 ((equal stars "") "") ; before first heading
20842 (org-odd-levels-only "*") ; inside heading, odd
20843 (t "")))) ; inside heading, oddeven
20844 (while (< (point) end)
20845 (when (org-at-item-p)
20846 ;; Pay attention to cases when region ends before list.
20847 (let* ((struct (org-list-struct))
20848 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20849 (save-restriction
20850 (narrow-to-region (point) list-end)
20851 (insert
20852 (org-list-to-subtree
20853 (org-list-parse-list t)
20854 '(:istart (concat stars add-stars (funcall get-stars depth))
20855 :icount (concat stars add-stars (funcall get-stars depth)))))))
20856 (setq toggled t))
20857 (forward-line))))
20858 ;; Case 3. Started at normal text: make every line an heading,
20859 ;; skipping headlines and items.
20860 (t (let* ((stars
20861 (make-string
20862 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20863 (add-stars
20864 (cond (nstars "") ; stars from prefix only
20865 ((equal stars "") "*") ; before first heading
20866 (org-odd-levels-only "**") ; inside heading, odd
20867 (t "*"))) ; inside heading, oddeven
20868 (rpl (concat stars add-stars " "))
20869 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20870 (while (< (point) (if (equal nstars '(4)) lend end))
20871 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20872 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20873 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20874 (forward-line)))))))
20875 (unless toggled (message "Cannot toggle heading from here"))))
20877 (defun org-meta-return (&optional arg)
20878 "Insert a new heading or wrap a region in a table.
20879 Calls `org-insert-heading' or `org-table-wrap-region', depending
20880 on context. See the individual commands for more information."
20881 (interactive "P")
20882 (org-check-before-invisible-edit 'insert)
20883 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20884 (let* ((element (org-element-at-point))
20885 (type (org-element-type element)))
20886 (when (eq type 'table-row)
20887 (setq element (org-element-property :parent element))
20888 (setq type 'table))
20889 (if (and (eq type 'table)
20890 (eq (org-element-property :type element) 'org)
20891 (>= (point) (org-element-property :contents-begin element))
20892 (< (point) (org-element-property :contents-end element)))
20893 (call-interactively 'org-table-wrap-region)
20894 (call-interactively 'org-insert-heading)))))
20896 ;;; Menu entries
20898 (defsubst org-in-subtree-not-table-p ()
20899 "Are we in a subtree and not in a table?"
20900 (and (not (org-before-first-heading-p))
20901 (not (org-at-table-p))))
20903 ;; Define the Org-mode menus
20904 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20905 '("Tbl"
20906 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20907 ["Next Field" org-cycle (org-at-table-p)]
20908 ["Previous Field" org-shifttab (org-at-table-p)]
20909 ["Next Row" org-return (org-at-table-p)]
20910 "--"
20911 ["Blank Field" org-table-blank-field (org-at-table-p)]
20912 ["Edit Field" org-table-edit-field (org-at-table-p)]
20913 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20914 "--"
20915 ("Column"
20916 ["Move Column Left" org-metaleft (org-at-table-p)]
20917 ["Move Column Right" org-metaright (org-at-table-p)]
20918 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20919 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20920 ("Row"
20921 ["Move Row Up" org-metaup (org-at-table-p)]
20922 ["Move Row Down" org-metadown (org-at-table-p)]
20923 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20924 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20925 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20926 "--"
20927 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20928 ("Rectangle"
20929 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20930 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20931 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20932 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20933 "--"
20934 ("Calculate"
20935 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20936 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20937 ["Edit Formulas" org-edit-special (org-at-table-p)]
20938 "--"
20939 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20940 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20941 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20942 "--"
20943 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20944 "--"
20945 ["Sum Column/Rectangle" org-table-sum
20946 (or (org-at-table-p) (org-region-active-p))]
20947 ["Which Column?" org-table-current-column (org-at-table-p)])
20948 ["Debug Formulas"
20949 org-table-toggle-formula-debugger
20950 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20951 ["Show Col/Row Numbers"
20952 org-table-toggle-coordinate-overlays
20953 :style toggle
20954 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20955 "--"
20956 ["Create" org-table-create (and (not (org-at-table-p))
20957 org-enable-table-editor)]
20958 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20959 ["Import from File" org-table-import (not (org-at-table-p))]
20960 ["Export to File" org-table-export (org-at-table-p)]
20961 "--"
20962 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20964 (easy-menu-define org-org-menu org-mode-map "Org menu"
20965 '("Org"
20966 ("Show/Hide"
20967 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20968 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20969 ["Sparse Tree..." org-sparse-tree t]
20970 ["Reveal Context" org-reveal t]
20971 ["Show All" show-all t]
20972 "--"
20973 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20974 "--"
20975 ["New Heading" org-insert-heading t]
20976 ("Navigate Headings"
20977 ["Up" outline-up-heading t]
20978 ["Next" outline-next-visible-heading t]
20979 ["Previous" outline-previous-visible-heading t]
20980 ["Next Same Level" outline-forward-same-level t]
20981 ["Previous Same Level" outline-backward-same-level t]
20982 "--"
20983 ["Jump" org-goto t])
20984 ("Edit Structure"
20985 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20986 "--"
20987 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20988 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20989 "--"
20990 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20991 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20992 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20993 "--"
20994 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20995 "--"
20996 ["Copy visible text" org-copy-visible t]
20997 "--"
20998 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20999 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
21000 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
21001 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
21002 "--"
21003 ["Sort Region/Children" org-sort t]
21004 "--"
21005 ["Convert to odd levels" org-convert-to-odd-levels t]
21006 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
21007 ("Editing"
21008 ["Emphasis..." org-emphasize t]
21009 ["Edit Source Example" org-edit-special t]
21010 "--"
21011 ["Footnote new/jump" org-footnote-action t]
21012 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
21013 ("Archive"
21014 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
21015 "--"
21016 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21017 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21018 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21020 "--"
21021 ("Hyperlinks"
21022 ["Store Link (Global)" org-store-link t]
21023 ["Find existing link to here" org-occur-link-in-agenda-files t]
21024 ["Insert Link" org-insert-link t]
21025 ["Follow Link" org-open-at-point t]
21026 "--"
21027 ["Next link" org-next-link t]
21028 ["Previous link" org-previous-link t]
21029 "--"
21030 ["Descriptive Links"
21031 org-toggle-link-display
21032 :style radio
21033 :selected org-descriptive-links
21035 ["Literal Links"
21036 org-toggle-link-display
21037 :style radio
21038 :selected (not org-descriptive-links)])
21039 "--"
21040 ("TODO Lists"
21041 ["TODO/DONE/-" org-todo t]
21042 ("Select keyword"
21043 ["Next keyword" org-shiftright (org-at-heading-p)]
21044 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21045 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21046 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21047 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21048 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21049 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21050 "--"
21051 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21052 :selected org-enforce-todo-dependencies :style toggle :active t]
21053 "Settings for tree at point"
21054 ["Do Children sequentially" org-toggle-ordered-property :style radio
21055 :selected (org-entry-get nil "ORDERED")
21056 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21057 ["Do Children parallel" org-toggle-ordered-property :style radio
21058 :selected (not (org-entry-get nil "ORDERED"))
21059 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21060 "--"
21061 ["Set Priority" org-priority t]
21062 ["Priority Up" org-shiftup t]
21063 ["Priority Down" org-shiftdown t]
21064 "--"
21065 ["Get news from all feeds" org-feed-update-all t]
21066 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21067 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21068 ("TAGS and Properties"
21069 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21070 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21071 "--"
21072 ["Set property" org-set-property (not (org-before-first-heading-p))]
21073 ["Column view of properties" org-columns t]
21074 ["Insert Column View DBlock" org-insert-columns-dblock t])
21075 ("Dates and Scheduling"
21076 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21077 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21078 ("Change Date"
21079 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21080 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21081 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21082 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21083 ["Compute Time Range" org-evaluate-time-range t]
21084 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21085 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21086 "--"
21087 ["Custom time format" org-toggle-time-stamp-overlays
21088 :style radio :selected org-display-custom-times]
21089 "--"
21090 ["Goto Calendar" org-goto-calendar t]
21091 ["Date from Calendar" org-date-from-calendar t]
21092 "--"
21093 ["Start/Restart Timer" org-timer-start t]
21094 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21095 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21096 ["Insert Timer String" org-timer t]
21097 ["Insert Timer Item" org-timer-item t])
21098 ("Logging work"
21099 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21100 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21101 ["Clock out" org-clock-out t]
21102 ["Clock cancel" org-clock-cancel t]
21103 "--"
21104 ["Mark as default task" org-clock-mark-default-task t]
21105 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21106 ["Goto running clock" org-clock-goto t]
21107 "--"
21108 ["Display times" org-clock-display t]
21109 ["Create clock table" org-clock-report t]
21110 "--"
21111 ["Record DONE time"
21112 (progn (setq org-log-done (not org-log-done))
21113 (message "Switching to %s will %s record a timestamp"
21114 (car org-done-keywords)
21115 (if org-log-done "automatically" "not")))
21116 :style toggle :selected org-log-done])
21117 "--"
21118 ["Agenda Command..." org-agenda t]
21119 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21120 ("File List for Agenda")
21121 ("Special views current file"
21122 ["TODO Tree" org-show-todo-tree t]
21123 ["Check Deadlines" org-check-deadlines t]
21124 ["Timeline" org-timeline t]
21125 ["Tags/Property tree" org-match-sparse-tree t])
21126 "--"
21127 ["Export/Publish..." org-export-dispatch t]
21128 ("LaTeX"
21129 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21130 :selected org-cdlatex-mode]
21131 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21132 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21133 ["Modify math symbol" org-cdlatex-math-modify
21134 (org-inside-LaTeX-fragment-p)]
21135 ["Insert citation" org-reftex-citation t]
21136 "--"
21137 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21138 "--"
21139 ("MobileOrg"
21140 ["Push Files and Views" org-mobile-push t]
21141 ["Get Captured and Flagged" org-mobile-pull t]
21142 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21143 "--"
21144 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21145 "--"
21146 ("Documentation"
21147 ["Show Version" org-version t]
21148 ["Info Documentation" org-info t])
21149 ("Customize"
21150 ["Browse Org Group" org-customize t]
21151 "--"
21152 ["Expand This Menu" org-create-customize-menu
21153 (fboundp 'customize-menu-create)])
21154 ["Send bug report" org-submit-bug-report t]
21155 "--"
21156 ("Refresh/Reload"
21157 ["Refresh setup current buffer" org-mode-restart t]
21158 ["Reload Org (after update)" org-reload t]
21159 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21162 (defun org-info (&optional node)
21163 "Read documentation for Org-mode in the info system.
21164 With optional NODE, go directly to that node."
21165 (interactive)
21166 (info (format "(org)%s" (or node ""))))
21168 ;;;###autoload
21169 (defun org-submit-bug-report ()
21170 "Submit a bug report on Org-mode via mail.
21172 Don't hesitate to report any problems or inaccurate documentation.
21174 If you don't have setup sending mail from (X)Emacs, please copy the
21175 output buffer into your mail program, as it gives us important
21176 information about your Org-mode version and configuration."
21177 (interactive)
21178 (require 'reporter)
21179 (org-load-modules-maybe)
21180 (org-require-autoloaded-modules)
21181 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21182 (reporter-submit-bug-report
21183 "emacs-orgmode@gnu.org"
21184 (org-version nil 'full)
21185 (let (list)
21186 (save-window-excursion
21187 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21188 (delete-other-windows)
21189 (erase-buffer)
21190 (insert "You are about to submit a bug report to the Org-mode mailing list.
21192 We would like to add your full Org-mode and Outline configuration to the
21193 bug report. This greatly simplifies the work of the maintainer and
21194 other experts on the mailing list.
21196 HOWEVER, some variables you have customized may contain private
21197 information. The names of customers, colleagues, or friends, might
21198 appear in the form of file names, tags, todo states, or search strings.
21199 If you answer yes to the prompt, you might want to check and remove
21200 such private information before sending the email.")
21201 (add-text-properties (point-min) (point-max) '(face org-warning))
21202 (when (yes-or-no-p "Include your Org-mode configuration ")
21203 (mapatoms
21204 (lambda (v)
21205 (and (boundp v)
21206 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21207 (or (and (symbol-value v)
21208 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21209 (and
21210 (get v 'custom-type) (get v 'standard-value)
21211 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21212 (push v list)))))
21213 (kill-buffer (get-buffer "*Warn about privacy*"))
21214 list))
21215 nil nil
21216 "Remember to cover the basics, that is, what you expected to happen and
21217 what in fact did happen. You don't know how to make a good report? See
21219 http://orgmode.org/manual/Feedback.html#Feedback
21221 Your bug report will be posted to the Org-mode mailing list.
21222 ------------------------------------------------------------------------")
21223 (save-excursion
21224 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21225 (replace-match "\\1Bug: \\3 [\\2]")))))
21228 (defun org-install-agenda-files-menu ()
21229 (let ((bl (buffer-list)))
21230 (save-excursion
21231 (while bl
21232 (set-buffer (pop bl))
21233 (if (derived-mode-p 'org-mode) (setq bl nil)))
21234 (when (derived-mode-p 'org-mode)
21235 (easy-menu-change
21236 '("Org") "File List for Agenda"
21237 (append
21238 (list
21239 ["Edit File List" (org-edit-agenda-file-list) t]
21240 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21241 ["Remove Current File from List" org-remove-file t]
21242 ["Cycle through agenda files" org-cycle-agenda-files t]
21243 ["Occur in all agenda files" org-occur-in-agenda-files t]
21244 "--")
21245 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21247 ;;;; Documentation
21249 (defun org-require-autoloaded-modules ()
21250 (interactive)
21251 (mapc 'require
21252 '(org-agenda org-archive org-attach org-clock org-colview org-id
21253 org-table org-timer)))
21255 ;;;###autoload
21256 (defun org-reload (&optional uncompiled)
21257 "Reload all org lisp files.
21258 With prefix arg UNCOMPILED, load the uncompiled versions."
21259 (interactive "P")
21260 (require 'loadhist)
21261 (let* ((org-dir (org-find-library-dir "org"))
21262 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21263 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21264 (remove-re (mapconcat 'identity
21265 (mapcar (lambda (f) (concat "^" f "$"))
21266 (list (if (featurep 'xemacs)
21267 "org-colview"
21268 "org-colview-xemacs")
21269 "org" "org-loaddefs" "org-version"))
21270 "\\|"))
21271 (feats (delete-dups
21272 (mapcar 'file-name-sans-extension
21273 (mapcar 'file-name-nondirectory
21274 (delq nil
21275 (mapcar 'feature-file
21276 features))))))
21277 (lfeat (append
21278 (sort
21279 (setq feats
21280 (delq nil (mapcar
21281 (lambda (f)
21282 (if (and (string-match feature-re f)
21283 (not (string-match remove-re f)))
21284 f nil))
21285 feats)))
21286 'string-lessp)
21287 (list "org-version" "org")))
21288 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21289 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21290 load-uncore load-misses)
21291 (setq load-misses
21292 (delq 't
21293 (mapcar (lambda (f)
21294 (or (org-load-noerror-mustsuffix (concat org-dir f))
21295 (and (string= org-dir contrib-dir)
21296 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21297 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21298 (add-to-list 'load-uncore f 'append)
21301 lfeat)))
21302 (if load-uncore
21303 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21304 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21305 (if load-misses
21306 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21307 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21308 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21310 ;;;###autoload
21311 (defun org-customize ()
21312 "Call the customize function with org as argument."
21313 (interactive)
21314 (org-load-modules-maybe)
21315 (org-require-autoloaded-modules)
21316 (customize-browse 'org))
21318 (defun org-create-customize-menu ()
21319 "Create a full customization menu for Org-mode, insert it into the menu."
21320 (interactive)
21321 (org-load-modules-maybe)
21322 (org-require-autoloaded-modules)
21323 (if (fboundp 'customize-menu-create)
21324 (progn
21325 (easy-menu-change
21326 '("Org") "Customize"
21327 `(["Browse Org group" org-customize t]
21328 "--"
21329 ,(customize-menu-create 'org)
21330 ["Set" Custom-set t]
21331 ["Save" Custom-save t]
21332 ["Reset to Current" Custom-reset-current t]
21333 ["Reset to Saved" Custom-reset-saved t]
21334 ["Reset to Standard Settings" Custom-reset-standard t]))
21335 (message "\"Org\"-menu now contains full customization menu"))
21336 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21338 ;;;; Miscellaneous stuff
21340 ;;; Generally useful functions
21342 (defun org-get-at-bol (property)
21343 "Get text property PROPERTY at beginning of line."
21344 (get-text-property (point-at-bol) property))
21346 (defun org-find-text-property-in-string (prop s)
21347 "Return the first non-nil value of property PROP in string S."
21348 (or (get-text-property 0 prop s)
21349 (get-text-property (or (next-single-property-change 0 prop s) 0)
21350 prop s)))
21352 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21353 "Display the given MESSAGE as a warning."
21354 (if (fboundp 'display-warning)
21355 (display-warning 'org message
21356 (if (featurep 'xemacs) 'warning :warning))
21357 (let ((buf (get-buffer-create "*Org warnings*")))
21358 (with-current-buffer buf
21359 (goto-char (point-max))
21360 (insert "Warning (Org): " message)
21361 (unless (bolp)
21362 (newline)))
21363 (display-buffer buf)
21364 (sit-for 0))))
21366 (defun org-eval (form)
21367 "Eval FORM and return result."
21368 (condition-case error
21369 (eval form)
21370 (error (format "%%![Error: %s]" error))))
21372 (defun org-in-clocktable-p ()
21373 "Check if the cursor is in a clocktable."
21374 (let ((pos (point)) start)
21375 (save-excursion
21376 (end-of-line 1)
21377 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21378 (setq start (match-beginning 0))
21379 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21380 (>= (match-end 0) pos)
21381 start))))
21383 (defun org-in-commented-line ()
21384 "Is point in a line starting with `#'?"
21385 (equal (char-after (point-at-bol)) ?#))
21387 (defun org-in-indented-comment-line ()
21388 "Is point in a line starting with `#' after some white space?"
21389 (save-excursion
21390 (save-match-data
21391 (goto-char (point-at-bol))
21392 (looking-at "[ \t]*#"))))
21394 (defun org-in-verbatim-emphasis ()
21395 (save-match-data
21396 (and (org-in-regexp org-emph-re 2)
21397 (>= (point) (match-beginning 3))
21398 (<= (point) (match-end 4))
21399 (member (match-string 3) '("=" "~")))))
21401 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21402 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21403 (if (and marker (marker-buffer marker)
21404 (buffer-live-p (marker-buffer marker)))
21405 (progn
21406 (org-pop-to-buffer-same-window (marker-buffer marker))
21407 (if (or (> marker (point-max)) (< marker (point-min)))
21408 (widen))
21409 (goto-char marker)
21410 (org-show-context 'org-goto))
21411 (if bookmark
21412 (bookmark-jump bookmark)
21413 (error "Cannot find location"))))
21415 (defun org-quote-csv-field (s)
21416 "Quote field for inclusion in CSV material."
21417 (if (string-match "[\",]" s)
21418 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21421 (defun org-force-self-insert (N)
21422 "Needed to enforce self-insert under remapping."
21423 (interactive "p")
21424 (self-insert-command N))
21426 (defun org-string-width (s)
21427 "Compute width of string, ignoring invisible characters.
21428 This ignores character with invisibility property `org-link', and also
21429 characters with property `org-cwidth', because these will become invisible
21430 upon the next fontification round."
21431 (let (b l)
21432 (when (or (eq t buffer-invisibility-spec)
21433 (assq 'org-link buffer-invisibility-spec))
21434 (while (setq b (text-property-any 0 (length s)
21435 'invisible 'org-link s))
21436 (setq s (concat (substring s 0 b)
21437 (substring s (or (next-single-property-change
21438 b 'invisible s) (length s)))))))
21439 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21440 (setq s (concat (substring s 0 b)
21441 (substring s (or (next-single-property-change
21442 b 'org-cwidth s) (length s))))))
21443 (setq l (string-width s) b -1)
21444 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21445 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21448 (defun org-shorten-string (s maxlength)
21449 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21450 If the string is shorter or has length MAXLENGTH, just return the
21451 original string. If it is longer, the functions finds a space in the
21452 string, breaks this string off at that locations and adds three dots
21453 as ellipsis. Including the ellipsis, the string will not be longer
21454 than MAXLENGTH. If finding a good breaking point in the string does
21455 not work, the string is just chopped off in the middle of a word
21456 if necessary."
21457 (if (<= (length s) maxlength)
21459 (let* ((n (max (- maxlength 4) 1))
21460 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21461 (if (string-match re s)
21462 (concat (match-string 1 s) "...")
21463 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21465 (defun org-get-indentation (&optional line)
21466 "Get the indentation of the current line, interpreting tabs.
21467 When LINE is given, assume it represents a line and compute its indentation."
21468 (if line
21469 (if (string-match "^ *" (org-remove-tabs line))
21470 (match-end 0))
21471 (save-excursion
21472 (beginning-of-line 1)
21473 (skip-chars-forward " \t")
21474 (current-column))))
21476 (defun org-get-string-indentation (s)
21477 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21478 (let ((n -1) (i 0) (w tab-width) c)
21479 (catch 'exit
21480 (while (< (setq n (1+ n)) (length s))
21481 (setq c (aref s n))
21482 (cond ((= c ?\ ) (setq i (1+ i)))
21483 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21484 (t (throw 'exit t)))))
21487 (defun org-remove-tabs (s &optional width)
21488 "Replace tabulators in S with spaces.
21489 Assumes that s is a single line, starting in column 0."
21490 (setq width (or width tab-width))
21491 (while (string-match "\t" s)
21492 (setq s (replace-match
21493 (make-string
21494 (- (* width (/ (+ (match-beginning 0) width) width))
21495 (match-beginning 0)) ?\ )
21496 t t s)))
21499 (defun org-fix-indentation (line ind)
21500 "Fix indentation in LINE.
21501 IND is a cons cell with target and minimum indentation.
21502 If the current indentation in LINE is smaller than the minimum,
21503 leave it alone. If it is larger than ind, set it to the target."
21504 (let* ((l (org-remove-tabs line))
21505 (i (org-get-indentation l))
21506 (i1 (car ind)) (i2 (cdr ind)))
21507 (if (>= i i2) (setq l (substring line i2)))
21508 (if (> i1 0)
21509 (concat (make-string i1 ?\ ) l)
21510 l)))
21512 (defun org-remove-indentation (code &optional n)
21513 "Remove the maximum common indentation from the lines in CODE.
21514 N may optionally be the number of spaces to remove."
21515 (with-temp-buffer
21516 (insert code)
21517 (org-do-remove-indentation n)
21518 (buffer-string)))
21520 (defun org-do-remove-indentation (&optional n)
21521 "Remove the maximum common indentation from the buffer."
21522 (untabify (point-min) (point-max))
21523 (let ((min 10000) re)
21524 (if n
21525 (setq min n)
21526 (goto-char (point-min))
21527 (while (re-search-forward "^ *[^ \n]" nil t)
21528 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21529 (unless (or (= min 0) (= min 10000))
21530 (setq re (format "^ \\{%d\\}" min))
21531 (goto-char (point-min))
21532 (while (re-search-forward re nil t)
21533 (replace-match "")
21534 (end-of-line 1))
21535 min)))
21537 (defun org-fill-template (template alist)
21538 "Find each %key of ALIST in TEMPLATE and replace it."
21539 (let ((case-fold-search nil)
21540 entry key value)
21541 (setq alist (sort (copy-sequence alist)
21542 (lambda (a b) (< (length (car a)) (length (car b))))))
21543 (while (setq entry (pop alist))
21544 (setq template
21545 (replace-regexp-in-string
21546 (concat "%" (regexp-quote (car entry)))
21547 (or (cdr entry) "") template t t)))
21548 template))
21550 (defun org-base-buffer (buffer)
21551 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21552 (if (not buffer)
21553 buffer
21554 (or (buffer-base-buffer buffer)
21555 buffer)))
21557 (defun org-trim (s)
21558 "Remove whitespace at beginning and end of string."
21559 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21560 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21563 (defun org-wrap (string &optional width lines)
21564 "Wrap string to either a number of lines, or a width in characters.
21565 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21566 that costs. If there is a word longer than WIDTH, the text is actually
21567 wrapped to the length of that word.
21568 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21569 many lines, whatever width that takes.
21570 The return value is a list of lines, without newlines at the end."
21571 (let* ((words (org-split-string string "[ \t\n]+"))
21572 (maxword (apply 'max (mapcar 'org-string-width words)))
21573 w ll)
21574 (cond (width
21575 (org-do-wrap words (max maxword width)))
21576 (lines
21577 (setq w maxword)
21578 (setq ll (org-do-wrap words maxword))
21579 (if (<= (length ll) lines)
21581 (setq ll words)
21582 (while (> (length ll) lines)
21583 (setq w (1+ w))
21584 (setq ll (org-do-wrap words w)))
21585 ll))
21586 (t (error "Cannot wrap this")))))
21588 (defun org-do-wrap (words width)
21589 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21590 (let (lines line)
21591 (while words
21592 (setq line (pop words))
21593 (while (and words (< (+ (length line) (length (car words))) width))
21594 (setq line (concat line " " (pop words))))
21595 (setq lines (push line lines)))
21596 (nreverse lines)))
21598 (defun org-split-string (string &optional separators)
21599 "Splits STRING into substrings at SEPARATORS.
21600 No empty strings are returned if there are matches at the beginning
21601 and end of string."
21602 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21603 (start 0)
21604 notfirst
21605 (list nil))
21606 (while (and (string-match rexp string
21607 (if (and notfirst
21608 (= start (match-beginning 0))
21609 (< start (length string)))
21610 (1+ start) start))
21611 (< (match-beginning 0) (length string)))
21612 (setq notfirst t)
21613 (or (eq (match-beginning 0) 0)
21614 (and (eq (match-beginning 0) (match-end 0))
21615 (eq (match-beginning 0) start))
21616 (setq list
21617 (cons (substring string start (match-beginning 0))
21618 list)))
21619 (setq start (match-end 0)))
21620 (or (eq start (length string))
21621 (setq list
21622 (cons (substring string start)
21623 list)))
21624 (nreverse list)))
21626 (defun org-quote-vert (s)
21627 "Replace \"|\" with \"\\vert\"."
21628 (while (string-match "|" s)
21629 (setq s (replace-match "\\vert" t t s)))
21632 (defun org-uuidgen-p (s)
21633 "Is S an ID created by UUIDGEN?"
21634 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21636 (defun org-in-src-block-p (&optional inside)
21637 "Whether point is in a code source block.
21638 When INSIDE is non-nil, don't consider we are within a src block
21639 when point is at #+BEGIN_SRC or #+END_SRC."
21640 (let ((case-fold-search t) ov)
21641 (or (and (setq ov (overlays-at (point)))
21642 (memq 'org-block-background
21643 (overlay-properties (car ov))))
21644 (and (not inside)
21645 (save-match-data
21646 (save-excursion
21647 (beginning-of-line)
21648 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21650 (defun org-context ()
21651 "Return a list of contexts of the current cursor position.
21652 If several contexts apply, all are returned.
21653 Each context entry is a list with a symbol naming the context, and
21654 two positions indicating start and end of the context. Possible
21655 contexts are:
21657 :headline anywhere in a headline
21658 :headline-stars on the leading stars in a headline
21659 :todo-keyword on a TODO keyword (including DONE) in a headline
21660 :tags on the TAGS in a headline
21661 :priority on the priority cookie in a headline
21662 :item on the first line of a plain list item
21663 :item-bullet on the bullet/number of a plain list item
21664 :checkbox on the checkbox in a plain list item
21665 :table in an org-mode table
21666 :table-special on a special filed in a table
21667 :table-table in a table.el table
21668 :clocktable in a clocktable
21669 :src-block in a source block
21670 :link on a hyperlink
21671 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT, QUOTE.
21672 :target on a <<target>>
21673 :radio-target on a <<<radio-target>>>
21674 :latex-fragment on a LaTeX fragment
21675 :latex-preview on a LaTeX fragment with overlaid preview image
21677 This function expects the position to be visible because it uses font-lock
21678 faces as a help to recognize the following contexts: :table-special, :link,
21679 and :keyword."
21680 (let* ((f (get-text-property (point) 'face))
21681 (faces (if (listp f) f (list f)))
21682 (case-fold-search t)
21683 (p (point)) clist o)
21684 ;; First the large context
21685 (cond
21686 ((org-at-heading-p t)
21687 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21688 (when (progn
21689 (beginning-of-line 1)
21690 (looking-at org-todo-line-tags-regexp))
21691 (push (org-point-in-group p 1 :headline-stars) clist)
21692 (push (org-point-in-group p 2 :todo-keyword) clist)
21693 (push (org-point-in-group p 4 :tags) clist))
21694 (goto-char p)
21695 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21696 (if (looking-at "\\[#[A-Z0-9]\\]")
21697 (push (org-point-in-group p 0 :priority) clist)))
21699 ((org-at-item-p)
21700 (push (org-point-in-group p 2 :item-bullet) clist)
21701 (push (list :item (point-at-bol)
21702 (save-excursion (org-end-of-item) (point)))
21703 clist)
21704 (and (org-at-item-checkbox-p)
21705 (push (org-point-in-group p 0 :checkbox) clist)))
21707 ((org-at-table-p)
21708 (push (list :table (org-table-begin) (org-table-end)) clist)
21709 (if (memq 'org-formula faces)
21710 (push (list :table-special
21711 (previous-single-property-change p 'face)
21712 (next-single-property-change p 'face)) clist)))
21713 ((org-at-table-p 'any)
21714 (push (list :table-table) clist)))
21715 (goto-char p)
21717 (let ((case-fold-search t))
21718 ;; New the "medium" contexts: clocktables, source blocks
21719 (cond ((org-in-clocktable-p)
21720 (push (list :clocktable
21721 (and (or (looking-at "#\\+BEGIN: clocktable")
21722 (search-backward "#+BEGIN: clocktable" nil t))
21723 (match-beginning 0))
21724 (and (re-search-forward "#\\+END:?" nil t)
21725 (match-end 0))) clist))
21726 ((org-in-src-block-p)
21727 (push (list :src-block
21728 (and (or (looking-at "#\\+BEGIN_SRC")
21729 (search-backward "#+BEGIN_SRC" nil t))
21730 (match-beginning 0))
21731 (and (search-forward "#+END_SRC" nil t)
21732 (match-beginning 0))) clist))))
21733 (goto-char p)
21735 ;; Now the small context
21736 (cond
21737 ((org-at-timestamp-p)
21738 (push (org-point-in-group p 0 :timestamp) clist))
21739 ((memq 'org-link faces)
21740 (push (list :link
21741 (previous-single-property-change p 'face)
21742 (next-single-property-change p 'face)) clist))
21743 ((memq 'org-special-keyword faces)
21744 (push (list :keyword
21745 (previous-single-property-change p 'face)
21746 (next-single-property-change p 'face)) clist))
21747 ((org-at-target-p)
21748 (push (org-point-in-group p 0 :target) clist)
21749 (goto-char (1- (match-beginning 0)))
21750 (if (looking-at org-radio-target-regexp)
21751 (push (org-point-in-group p 0 :radio-target) clist))
21752 (goto-char p))
21753 ((setq o (car (delq nil
21754 (mapcar
21755 (lambda (x)
21756 (if (memq x org-latex-fragment-image-overlays) x))
21757 (overlays-at (point))))))
21758 (push (list :latex-fragment
21759 (overlay-start o) (overlay-end o)) clist)
21760 (push (list :latex-preview
21761 (overlay-start o) (overlay-end o)) clist))
21762 ((org-inside-LaTeX-fragment-p)
21763 ;; FIXME: positions wrong.
21764 (push (list :latex-fragment (point) (point)) clist)))
21766 (setq clist (nreverse (delq nil clist)))
21767 clist))
21769 ;; FIXME: Compare with at-regexp-p Do we need both?
21770 (defun org-in-regexp (re &optional nlines visually)
21771 "Check if point is inside a match of regexp.
21772 Normally only the current line is checked, but you can include NLINES extra
21773 lines both before and after point into the search.
21774 If VISUALLY is set, require that the cursor is not after the match but
21775 really on, so that the block visually is on the match."
21776 (catch 'exit
21777 (let ((pos (point))
21778 (eol (point-at-eol (+ 1 (or nlines 0))))
21779 (inc (if visually 1 0)))
21780 (save-excursion
21781 (beginning-of-line (- 1 (or nlines 0)))
21782 (while (re-search-forward re eol t)
21783 (if (and (<= (match-beginning 0) pos)
21784 (>= (+ inc (match-end 0)) pos))
21785 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21787 (defun org-at-regexp-p (regexp)
21788 "Is point inside a match of REGEXP in the current line?"
21789 (catch 'exit
21790 (save-excursion
21791 (let ((pos (point)) (end (point-at-eol)))
21792 (beginning-of-line 1)
21793 (while (re-search-forward regexp end t)
21794 (if (and (<= (match-beginning 0) pos)
21795 (>= (match-end 0) pos))
21796 (throw 'exit t)))
21797 nil))))
21799 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21800 "Non-nil when point is between matches of START-RE and END-RE.
21802 Also return a non-nil value when point is on one of the matches.
21804 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21805 buffer positions. Default values are the positions of headlines
21806 surrounding the point.
21808 The functions returns a cons cell whose car (resp. cdr) is the
21809 position before START-RE (resp. after END-RE)."
21810 (save-match-data
21811 (let ((pos (point))
21812 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21813 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21814 beg end)
21815 (save-excursion
21816 ;; Point is on a block when on START-RE or if START-RE can be
21817 ;; found before it...
21818 (and (or (org-at-regexp-p start-re)
21819 (re-search-backward start-re limit-up t))
21820 (setq beg (match-beginning 0))
21821 ;; ... and END-RE after it...
21822 (goto-char (match-end 0))
21823 (re-search-forward end-re limit-down t)
21824 (> (setq end (match-end 0)) pos)
21825 ;; ... without another START-RE in-between.
21826 (goto-char (match-beginning 0))
21827 (not (re-search-backward start-re (1+ beg) t))
21828 ;; Return value.
21829 (cons beg end))))))
21831 (defun org-in-block-p (names)
21832 "Non-nil when point belongs to a block whose name belongs to NAMES.
21834 NAMES is a list of strings containing names of blocks.
21836 Return first block name matched, or nil. Beware that in case of
21837 nested blocks, the returned name may not belong to the closest
21838 block from point."
21839 (save-match-data
21840 (catch 'exit
21841 (let ((case-fold-search t)
21842 (lim-up (save-excursion (outline-previous-heading)))
21843 (lim-down (save-excursion (outline-next-heading))))
21844 (mapc (lambda (name)
21845 (let ((n (regexp-quote name)))
21846 (when (org-between-regexps-p
21847 (concat "^[ \t]*#\\+begin_" n)
21848 (concat "^[ \t]*#\\+end_" n)
21849 lim-up lim-down)
21850 (throw 'exit n))))
21851 names))
21852 nil)))
21854 (defun org-in-drawer-p ()
21855 "Non-nil if point is within a drawer.
21856 If point is within a drawer, return it, as parsed data."
21857 (let ((element (save-match-data (org-element-at-point))))
21858 (while (and element (not (memq (org-element-type element)
21859 '(drawer property-drawer))))
21860 (setq element (org-element-property :parent element)))
21861 element))
21863 (defun org-occur-in-agenda-files (regexp &optional nlines)
21864 "Call `multi-occur' with buffers for all agenda files."
21865 (interactive "sOrg-files matching: \np")
21866 (let* ((files (org-agenda-files))
21867 (tnames (mapcar 'file-truename files))
21868 (extra org-agenda-text-search-extra-files)
21870 (when (eq (car extra) 'agenda-archives)
21871 (setq extra (cdr extra))
21872 (setq files (org-add-archive-files files)))
21873 (while (setq f (pop extra))
21874 (unless (member (file-truename f) tnames)
21875 (add-to-list 'files f 'append)
21876 (add-to-list 'tnames (file-truename f) 'append)))
21877 (multi-occur
21878 (mapcar (lambda (x)
21879 (with-current-buffer
21880 (or (get-file-buffer x) (find-file-noselect x))
21881 (widen)
21882 (current-buffer)))
21883 files)
21884 regexp)))
21886 (if (boundp 'occur-mode-find-occurrence-hook)
21887 ;; Emacs 23
21888 (add-hook 'occur-mode-find-occurrence-hook
21889 (lambda ()
21890 (when (derived-mode-p 'org-mode)
21891 (org-reveal))))
21892 ;; Emacs 22
21893 (defadvice occur-mode-goto-occurrence
21894 (after org-occur-reveal activate)
21895 (and (derived-mode-p 'org-mode) (org-reveal)))
21896 (defadvice occur-mode-goto-occurrence-other-window
21897 (after org-occur-reveal activate)
21898 (and (derived-mode-p 'org-mode) (org-reveal)))
21899 (defadvice occur-mode-display-occurrence
21900 (after org-occur-reveal activate)
21901 (when (derived-mode-p 'org-mode)
21902 (let ((pos (occur-mode-find-occurrence)))
21903 (with-current-buffer (marker-buffer pos)
21904 (save-excursion
21905 (goto-char pos)
21906 (org-reveal)))))))
21908 (defun org-occur-link-in-agenda-files ()
21909 "Create a link and search for it in the agendas.
21910 The link is not stored in `org-stored-links', it is just created
21911 for the search purpose."
21912 (interactive)
21913 (let ((link (condition-case nil
21914 (org-store-link nil)
21915 (error "Unable to create a link to here"))))
21916 (org-occur-in-agenda-files (regexp-quote link))))
21918 (defun org-reverse-string (string)
21919 "Return the reverse of STRING."
21920 (apply 'string (reverse (string-to-list string))))
21922 (defun org-uniquify-alist (alist)
21923 "Merge elements of ALIST with the same key.
21925 For example, in this alist:
21927 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21928 => '((a 1 3) (b 2))
21930 merge (a 1) and (a 3) into (a 1 3).
21932 The function returns the new ALIST."
21933 (let (rtn)
21934 (mapc
21935 (lambda (e)
21936 (let (n)
21937 (if (not (assoc (car e) rtn))
21938 (push e rtn)
21939 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21940 (setq rtn (assq-delete-all (car e) rtn))
21941 (push n rtn))))
21942 alist)
21943 rtn))
21945 (defun org-delete-all (elts list)
21946 "Remove all elements in ELTS from LIST."
21947 (while elts
21948 (setq list (delete (pop elts) list)))
21949 list)
21951 (defun org-count (cl-item cl-seq)
21952 "Count the number of occurrences of ITEM in SEQ.
21953 Taken from `count' in cl-seq.el with all keyword arguments removed."
21954 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21955 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21956 (while (< cl-start cl-end)
21957 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21958 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21959 (setq cl-start (1+ cl-start)))
21960 cl-count))
21962 (defun org-remove-if (predicate seq)
21963 "Remove everything from SEQ that fulfills PREDICATE."
21964 (let (res e)
21965 (while seq
21966 (setq e (pop seq))
21967 (if (not (funcall predicate e)) (push e res)))
21968 (nreverse res)))
21970 (defun org-remove-if-not (predicate seq)
21971 "Remove everything from SEQ that does not fulfill PREDICATE."
21972 (let (res e)
21973 (while seq
21974 (setq e (pop seq))
21975 (if (funcall predicate e) (push e res)))
21976 (nreverse res)))
21978 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21979 "Reduce two-argument FUNCTION across SEQ.
21980 Taken from `reduce' in cl-seq.el with all keyword arguments but
21981 \":initial-value\" removed."
21982 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21983 (cadr (memq :initial-value cl-keys)))
21984 (cl-seq (pop cl-seq))
21985 (t (funcall cl-func)))))
21986 (while cl-seq
21987 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21988 cl-accum))
21990 (defun org-every (pred seq)
21991 "Return true if PREDICATE is true of every element of SEQ.
21992 Adapted from `every' in cl.el."
21993 (catch 'org-every
21994 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21997 (defun org-some (pred seq)
21998 "Return true if PREDICATE is true of any element of SEQ.
21999 Adapted from `some' in cl.el."
22000 (catch 'org-some
22001 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
22002 nil))
22004 (defun org-back-over-empty-lines ()
22005 "Move backwards over whitespace, to the beginning of the first empty line.
22006 Returns the number of empty lines passed."
22007 (let ((pos (point)))
22008 (if (cdr (assoc 'heading org-blank-before-new-entry))
22009 (skip-chars-backward " \t\n\r")
22010 (unless (eobp)
22011 (forward-line -1)))
22012 (beginning-of-line 2)
22013 (goto-char (min (point) pos))
22014 (count-lines (point) pos)))
22016 (defun org-skip-whitespace ()
22017 (skip-chars-forward " \t\n\r"))
22019 (defun org-point-in-group (point group &optional context)
22020 "Check if POINT is in match-group GROUP.
22021 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22022 match. If the match group does not exist or point is not inside it,
22023 return nil."
22024 (and (match-beginning group)
22025 (>= point (match-beginning group))
22026 (<= point (match-end group))
22027 (if context
22028 (list context (match-beginning group) (match-end group))
22029 t)))
22031 (defun org-switch-to-buffer-other-window (&rest args)
22032 "Switch to buffer in a second window on the current frame.
22033 In particular, do not allow pop-up frames.
22034 Returns the newly created buffer."
22035 (org-no-popups
22036 (apply 'switch-to-buffer-other-window args)))
22038 (defun org-combine-plists (&rest plists)
22039 "Create a single property list from all plists in PLISTS.
22040 The process starts by copying the first list, and then setting properties
22041 from the other lists. Settings in the last list are the most significant
22042 ones and overrule settings in the other lists."
22043 (let ((rtn (copy-sequence (pop plists)))
22044 p v ls)
22045 (while plists
22046 (setq ls (pop plists))
22047 (while ls
22048 (setq p (pop ls) v (pop ls))
22049 (setq rtn (plist-put rtn p v))))
22050 rtn))
22052 (defun org-replace-escapes (string table)
22053 "Replace %-escapes in STRING with values in TABLE.
22054 TABLE is an association list with keys like \"%a\" and string values.
22055 The sequences in STRING may contain normal field width and padding information,
22056 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22057 so values can contain further %-escapes if they are define later in TABLE."
22058 (let ((tbl (copy-alist table))
22059 (case-fold-search nil)
22060 (pchg 0)
22061 e re rpl)
22062 (while (setq e (pop tbl))
22063 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22064 (when (and (cdr e) (string-match re (cdr e)))
22065 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22066 (safe "SREF"))
22067 (add-text-properties 0 3 (list 'sref sref) safe)
22068 (setcdr e (replace-match safe t t (cdr e)))))
22069 (while (string-match re string)
22070 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22071 (cdr e)))
22072 (setq string (replace-match rpl t t string))))
22073 (while (setq pchg (next-property-change pchg string))
22074 (let ((sref (get-text-property pchg 'sref string)))
22075 (when (and sref (string-match "SREF" string pchg))
22076 (setq string (replace-match sref t t string)))))
22077 string))
22079 (defun org-sublist (list start end)
22080 "Return a section of LIST, from START to END.
22081 Counting starts at 1."
22082 (let (rtn (c start))
22083 (setq list (nthcdr (1- start) list))
22084 (while (and list (<= c end))
22085 (push (pop list) rtn)
22086 (setq c (1+ c)))
22087 (nreverse rtn)))
22089 (defun org-find-base-buffer-visiting (file)
22090 "Like `find-buffer-visiting' but always return the base buffer and
22091 not an indirect buffer."
22092 (let ((buf (or (get-file-buffer file)
22093 (find-buffer-visiting file))))
22094 (if buf
22095 (or (buffer-base-buffer buf) buf)
22096 nil)))
22098 (defun org-image-file-name-regexp (&optional extensions)
22099 "Return regexp matching the file names of images.
22100 If EXTENSIONS is given, only match these."
22101 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22102 (image-file-name-regexp)
22103 (let ((image-file-name-extensions
22104 (or extensions
22105 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22106 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22107 (concat "\\."
22108 (regexp-opt (nconc (mapcar 'upcase
22109 image-file-name-extensions)
22110 image-file-name-extensions)
22112 "\\'"))))
22114 (defun org-file-image-p (file &optional extensions)
22115 "Return non-nil if FILE is an image."
22116 (save-match-data
22117 (string-match (org-image-file-name-regexp extensions) file)))
22119 (defun org-get-cursor-date (&optional with-time)
22120 "Return the date at cursor in as a time.
22121 This works in the calendar and in the agenda, anywhere else it just
22122 returns the current time.
22123 If WITH-TIME is non-nil, returns the time of the event at point (in
22124 the agenda) or the current time of the day."
22125 (let (date day defd tp tm hod mod)
22126 (when with-time
22127 (setq tp (get-text-property (point) 'time))
22128 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22129 (setq hod (string-to-number (match-string 1 tp))
22130 mod (string-to-number (match-string 2 tp))))
22131 (or tp (setq hod (nth 2 (decode-time (current-time)))
22132 mod (nth 1 (decode-time (current-time))))))
22133 (cond
22134 ((eq major-mode 'calendar-mode)
22135 (setq date (calendar-cursor-to-date)
22136 defd (encode-time 0 (or mod 0) (or hod 0)
22137 (nth 1 date) (nth 0 date) (nth 2 date))))
22138 ((eq major-mode 'org-agenda-mode)
22139 (setq day (get-text-property (point) 'day))
22140 (if day
22141 (setq date (calendar-gregorian-from-absolute day)
22142 defd (encode-time 0 (or mod 0) (or hod 0)
22143 (nth 1 date) (nth 0 date) (nth 2 date))))))
22144 (or defd (current-time))))
22146 (defun org-mark-subtree (&optional up)
22147 "Mark the current subtree.
22148 This puts point at the start of the current subtree, and mark at
22149 the end. If a numeric prefix UP is given, move up into the
22150 hierarchy of headlines by UP levels before marking the subtree."
22151 (interactive "P")
22152 (org-with-limited-levels
22153 (cond ((org-at-heading-p) (beginning-of-line))
22154 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22155 (t (outline-previous-visible-heading 1))))
22156 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22157 (if (org-called-interactively-p 'any)
22158 (call-interactively 'org-mark-element)
22159 (org-mark-element)))
22162 ;;; Indentation
22164 (defun org-indent-line ()
22165 "Indent line depending on context."
22166 (interactive)
22167 (let* ((pos (point))
22168 (itemp (org-at-item-p))
22169 (case-fold-search t)
22170 (org-drawer-regexp (or org-drawer-regexp "\000"))
22171 (inline-task-p (and (featurep 'org-inlinetask)
22172 (org-inlinetask-in-task-p)))
22173 (inline-re (and inline-task-p
22174 (org-inlinetask-outline-regexp)))
22175 column)
22176 (if (and orgstruct-is-++ (eq pos (point)))
22177 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22178 (indent-according-to-mode))
22179 (beginning-of-line 1)
22180 (cond
22181 ;; Headings
22182 ((looking-at org-outline-regexp) (setq column 0))
22183 ;; Footnote definition
22184 ((looking-at org-footnote-definition-re) (setq column 0))
22185 ;; Literal examples
22186 ((looking-at "[ \t]*:\\( \\|$\\)")
22187 (setq column (org-get-indentation))) ; do nothing
22188 ;; Lists
22189 ((ignore-errors (goto-char (org-in-item-p)))
22190 (setq column (if itemp
22191 (org-get-indentation)
22192 (org-list-item-body-column (point))))
22193 (goto-char pos))
22194 ;; Drawers
22195 ((and (looking-at "[ \t]*:END:")
22196 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22197 (save-excursion
22198 (goto-char (1- (match-beginning 1)))
22199 (setq column (current-column))))
22200 ;; Special blocks
22201 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22202 (save-excursion
22203 (re-search-backward
22204 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22205 (setq column (org-get-indentation (match-string 0))))
22206 ((and (not (looking-at "[ \t]*#\\+begin_"))
22207 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22208 (save-excursion
22209 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22210 (setq column
22211 (cond ((equal (downcase (match-string 1)) "src")
22212 ;; src blocks: let `org-edit-src-exit' handle them
22213 (org-get-indentation))
22214 ((equal (downcase (match-string 1)) "example")
22215 (max (org-get-indentation)
22216 (org-get-indentation (match-string 0))))
22218 (org-get-indentation (match-string 0))))))
22219 ;; This line has nothing special, look at the previous relevant
22220 ;; line to compute indentation
22222 (beginning-of-line 0)
22223 (while (and (not (bobp))
22224 (not (looking-at org-table-line-regexp))
22225 (not (looking-at org-drawer-regexp))
22226 ;; When point started in an inline task, do not move
22227 ;; above task starting line.
22228 (not (and inline-task-p (looking-at inline-re)))
22229 ;; Skip drawers, blocks, empty lines, verbatim,
22230 ;; comments, tables, footnotes definitions, lists,
22231 ;; inline tasks.
22232 (or (and (looking-at "[ \t]*:END:")
22233 (re-search-backward org-drawer-regexp nil t))
22234 (and (looking-at "[ \t]*#\\+end_")
22235 (re-search-backward "[ \t]*#\\+begin_"nil t))
22236 (looking-at "[ \t]*[\n:#|]")
22237 (looking-at org-footnote-definition-re)
22238 (and (not inline-task-p)
22239 (featurep 'org-inlinetask)
22240 (org-inlinetask-in-task-p)
22241 (or (org-inlinetask-goto-beginning) t))))
22242 (beginning-of-line 0))
22243 (cond
22244 ;; There was a list item above.
22245 ((ignore-errors (goto-char (org-in-item-p)))
22246 (goto-char (org-list-get-top-point (org-list-struct)))
22247 (setq column (org-get-indentation)))
22248 ;; There was an heading above.
22249 ((looking-at "\\*+[ \t]+")
22250 (if (not org-adapt-indentation)
22251 (setq column 0)
22252 (goto-char (match-end 0))
22253 (setq column (current-column))))
22254 ;; A drawer had started and is unfinished
22255 ((looking-at org-drawer-regexp)
22256 (goto-char (1- (match-beginning 1)))
22257 (setq column (current-column)))
22258 ;; Else, nothing noticeable found: get indentation and go on.
22259 (t (setq column (org-get-indentation))))))
22260 ;; Now apply indentation and move cursor accordingly
22261 (goto-char pos)
22262 (if (<= (current-column) (current-indentation))
22263 (org-indent-line-to column)
22264 (save-excursion (org-indent-line-to column)))
22265 ;; Special polishing for properties, see `org-property-format'
22266 (setq column (current-column))
22267 (beginning-of-line 1)
22268 (if (looking-at org-property-re)
22269 (replace-match (concat (match-string 4)
22270 (format org-property-format
22271 (match-string 1) (match-string 3)))
22272 t t))
22273 (org-move-to-column column))))
22275 (defun org-indent-drawer ()
22276 "Indent the drawer at point."
22277 (interactive)
22278 (let ((p (point))
22279 (e (and (save-excursion (re-search-forward ":END:" nil t))
22280 (match-end 0)))
22281 (folded
22282 (save-excursion
22283 (end-of-line)
22284 (when (overlays-at (point))
22285 (member 'invisible (overlay-properties
22286 (car (overlays-at (point)))))))))
22287 (when folded (org-cycle))
22288 (indent-for-tab-command)
22289 (while (and (move-beginning-of-line 2) (< (point) e))
22290 (indent-for-tab-command))
22291 (goto-char p)
22292 (when folded (org-cycle)))
22293 (message "Drawer at point indented"))
22295 (defun org-indent-block ()
22296 "Indent the block at point."
22297 (interactive)
22298 (let ((p (point))
22299 (case-fold-search t)
22300 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22301 (match-end 0)))
22302 (folded
22303 (save-excursion
22304 (end-of-line)
22305 (when (overlays-at (point))
22306 (member 'invisible (overlay-properties
22307 (car (overlays-at (point)))))))))
22308 (when folded (org-cycle))
22309 (indent-for-tab-command)
22310 (while (and (move-beginning-of-line 2) (< (point) e))
22311 (indent-for-tab-command))
22312 (goto-char p)
22313 (when folded (org-cycle)))
22314 (message "Block at point indented"))
22316 (defun org-indent-region (start end)
22317 "Indent region."
22318 (interactive "r")
22319 (save-excursion
22320 (let ((line-end (org-current-line end)))
22321 (goto-char start)
22322 (while (< (org-current-line) line-end)
22323 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22324 (t (call-interactively 'org-indent-line)))
22325 (move-beginning-of-line 2)))))
22328 ;;; Filling
22330 ;; We use our own fill-paragraph and auto-fill functions.
22332 ;; `org-fill-paragraph' relies on adaptive filling and context
22333 ;; checking. Appropriate `fill-prefix' is computed with
22334 ;; `org-adaptive-fill-function'.
22336 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22337 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22338 ;; `org-adaptive-fill-function' value. Internally,
22339 ;; `org-comment-line-break-function' breaks the line.
22341 ;; `org-setup-filling' installs filling and auto-filling related
22342 ;; variables during `org-mode' initialization.
22344 (defvar org-element-paragraph-separate) ; org-element.el
22345 (defun org-setup-filling ()
22346 (require 'org-element)
22347 ;; Prevent auto-fill from inserting unwanted new items.
22348 (when (boundp 'fill-nobreak-predicate)
22349 (org-set-local
22350 'fill-nobreak-predicate
22351 (org-uniquify
22352 (append fill-nobreak-predicate
22353 '(org-fill-line-break-nobreak-p
22354 org-fill-paragraph-with-timestamp-nobreak-p)))))
22355 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22356 (org-set-local 'paragraph-start paragraph-ending)
22357 (org-set-local 'paragraph-separate paragraph-ending))
22358 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22359 (org-set-local 'auto-fill-inhibit-regexp nil)
22360 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22361 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22362 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22364 (defun org-fill-line-break-nobreak-p ()
22365 "Non-nil when a new line at point would create an Org line break."
22366 (save-excursion
22367 (skip-chars-backward "[ \t]")
22368 (skip-chars-backward "\\\\")
22369 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22371 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22372 "Non-nil when a new line at point would split a timestamp."
22373 (and (org-at-timestamp-p t)
22374 (not (looking-at org-ts-regexp-both))))
22376 (declare-function message-in-body-p "message" ())
22377 (defvar orgtbl-line-start-regexp) ; From org-table.el
22378 (defun org-adaptive-fill-function ()
22379 "Compute a fill prefix for the current line.
22380 Return fill prefix, as a string, or nil if current line isn't
22381 meant to be filled. For convenience, if `adaptive-fill-regexp'
22382 matches in paragraphs or comments, use it."
22383 (catch 'exit
22384 (when (derived-mode-p 'message-mode)
22385 (save-excursion
22386 (beginning-of-line)
22387 (cond ((or (not (message-in-body-p))
22388 (looking-at orgtbl-line-start-regexp))
22389 (throw 'exit nil))
22390 ((looking-at message-cite-prefix-regexp)
22391 (throw 'exit (match-string-no-properties 0)))
22392 ((looking-at org-outline-regexp)
22393 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22394 (org-with-wide-buffer
22395 (let* ((p (line-beginning-position))
22396 (element (save-excursion
22397 (beginning-of-line)
22398 (or (ignore-errors (org-element-at-point))
22399 (user-error "An element cannot be parsed line %d"
22400 (line-number-at-pos (point))))))
22401 (type (org-element-type element))
22402 (post-affiliated (org-element-property :post-affiliated element)))
22403 (unless (and post-affiliated (< p post-affiliated))
22404 (case type
22405 (comment
22406 (save-excursion
22407 (beginning-of-line)
22408 (looking-at "[ \t]*")
22409 (concat (match-string 0) "# ")))
22410 (footnote-definition "")
22411 ((item plain-list)
22412 (make-string (org-list-item-body-column
22413 (or post-affiliated
22414 (org-element-property :begin element)))
22415 ? ))
22416 (paragraph
22417 ;; Fill prefix is usually the same as the current line,
22418 ;; unless the paragraph is at the beginning of an item.
22419 (let ((parent (org-element-property :parent element)))
22420 (save-excursion
22421 (beginning-of-line)
22422 (cond ((eq (org-element-type parent) 'item)
22423 (make-string (org-list-item-body-column
22424 (org-element-property :begin parent))
22425 ? ))
22426 ((and adaptive-fill-regexp
22427 ;; Locally disable
22428 ;; `adaptive-fill-function' to let
22429 ;; `fill-context-prefix' handle
22430 ;; `adaptive-fill-regexp' variable.
22431 (let (adaptive-fill-function)
22432 (fill-context-prefix
22433 post-affiliated
22434 (org-element-property :end element)))))
22435 ((looking-at "[ \t]+") (match-string 0))
22436 (t "")))))
22437 (comment-block
22438 ;; Only fill contents if P is within block boundaries.
22439 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22440 (forward-line)
22441 (point)))
22442 (cend (save-excursion
22443 (goto-char (org-element-property :end element))
22444 (skip-chars-backward " \r\t\n")
22445 (line-beginning-position))))
22446 (when (and (>= p cbeg) (< p cend))
22447 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22448 (match-string 0)
22449 ""))))))))))
22451 (declare-function message-goto-body "message" ())
22452 (defvar message-cite-prefix-regexp) ; From message.el
22453 (defun org-fill-paragraph (&optional justify)
22454 "Fill element at point, when applicable.
22456 This function only applies to comment blocks, comments, example
22457 blocks and paragraphs. Also, as a special case, re-align table
22458 when point is at one.
22460 If JUSTIFY is non-nil (interactively, with prefix argument),
22461 justify as well. If `sentence-end-double-space' is non-nil, then
22462 period followed by one space does not end a sentence, so don't
22463 break a line there. The variable `fill-column' controls the
22464 width for filling.
22466 For convenience, when point is at a plain list, an item or
22467 a footnote definition, try to fill the first paragraph within."
22468 (interactive)
22469 (if (and (derived-mode-p 'message-mode)
22470 (or (not (message-in-body-p))
22471 (save-excursion (move-beginning-of-line 1)
22472 (looking-at message-cite-prefix-regexp))))
22473 ;; First ensure filling is correct in message-mode.
22474 (let ((fill-paragraph-function
22475 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22476 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22477 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22478 (paragraph-separate
22479 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22480 (fill-paragraph nil))
22481 (with-syntax-table org-mode-transpose-word-syntax-table
22482 ;; Move to end of line in order to get the first paragraph
22483 ;; within a plain list or a footnote definition.
22484 (let ((element (save-excursion
22485 (end-of-line)
22486 (or (ignore-errors (org-element-at-point))
22487 (user-error "An element cannot be parsed line %d"
22488 (line-number-at-pos (point)))))))
22489 ;; First check if point is in a blank line at the beginning of
22490 ;; the buffer. In that case, ignore filling.
22491 (case (org-element-type element)
22492 ;; Use major mode filling function is src blocks.
22493 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22494 ;; Align Org tables, leave table.el tables as-is.
22495 (table-row (org-table-align) t)
22496 (table
22497 (when (eq (org-element-property :type element) 'org)
22498 (save-excursion
22499 (goto-char (org-element-property :post-affiliated element))
22500 (org-table-align)))
22502 (paragraph
22503 ;; Paragraphs may contain `line-break' type objects.
22504 (let ((beg (max (point-min)
22505 (org-element-property :contents-begin element)))
22506 (end (min (point-max)
22507 (org-element-property :contents-end element))))
22508 ;; Do nothing if point is at an affiliated keyword.
22509 (if (< (line-end-position) beg) t
22510 (when (derived-mode-p 'message-mode)
22511 ;; In `message-mode', do not fill following citation
22512 ;; in current paragraph nor text before message body.
22513 (let ((body-start (save-excursion (message-goto-body))))
22514 (when body-start (setq beg (max body-start beg))))
22515 (when (save-excursion
22516 (re-search-forward
22517 (concat "^" message-cite-prefix-regexp) end t))
22518 (setq end (match-beginning 0))))
22519 ;; Fill paragraph, taking line breaks into account.
22520 ;; For that, slice the paragraph using line breaks as
22521 ;; separators, and fill the parts in reverse order to
22522 ;; avoid messing with markers.
22523 (save-excursion
22524 (goto-char end)
22525 (mapc
22526 (lambda (pos)
22527 (fill-region-as-paragraph pos (point) justify)
22528 (goto-char pos))
22529 ;; Find the list of ending positions for line breaks
22530 ;; in the current paragraph. Add paragraph
22531 ;; beginning to include first slice.
22532 (nreverse
22533 (cons beg
22534 (org-element-map
22535 (org-element--parse-objects
22536 beg end nil (org-element-restriction 'paragraph))
22537 'line-break
22538 (lambda (lb) (org-element-property :end lb)))))))
22539 t)))
22540 ;; Contents of `comment-block' type elements should be
22541 ;; filled as plain text, but only if point is within block
22542 ;; markers.
22543 (comment-block
22544 (let* ((case-fold-search t)
22545 (beg (save-excursion
22546 (goto-char (org-element-property :begin element))
22547 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22548 (forward-line)
22549 (point)))
22550 (end (save-excursion
22551 (goto-char (org-element-property :end element))
22552 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22553 (line-beginning-position))))
22554 (if (or (< (point) beg) (> (point) end)) t
22555 (fill-region-as-paragraph
22556 (save-excursion (end-of-line)
22557 (re-search-backward "^[ \t]*$" beg 'move)
22558 (line-beginning-position))
22559 (save-excursion (beginning-of-line)
22560 (re-search-forward "^[ \t]*$" end 'move)
22561 (line-beginning-position))
22562 justify))))
22563 ;; Fill comments.
22564 (comment
22565 (let ((begin (org-element-property :post-affiliated element))
22566 (end (org-element-property :end element)))
22567 (when (and (>= (point) begin) (<= (point) end))
22568 (let ((begin (save-excursion
22569 (end-of-line)
22570 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22571 (progn (forward-line) (point))
22572 begin)))
22573 (end (save-excursion
22574 (end-of-line)
22575 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22576 (1- (line-beginning-position))
22577 (skip-chars-backward " \r\t\n")
22578 (line-end-position)))))
22579 ;; Do not fill comments when at a blank line.
22580 (when (> end begin)
22581 (let ((fill-prefix
22582 (save-excursion
22583 (beginning-of-line)
22584 (looking-at "[ \t]*#")
22585 (let ((comment-prefix (match-string 0)))
22586 (goto-char (match-end 0))
22587 (if (looking-at adaptive-fill-regexp)
22588 (concat comment-prefix (match-string 0))
22589 (concat comment-prefix " "))))))
22590 (save-excursion
22591 (fill-region-as-paragraph begin end justify))))))
22593 ;; Ignore every other element.
22594 (otherwise t))))))
22596 (defun org-auto-fill-function ()
22597 "Auto-fill function."
22598 ;; Check if auto-filling is meaningful.
22599 (let ((fc (current-fill-column)))
22600 (when (and fc (> (current-column) fc))
22601 (let* ((fill-prefix (org-adaptive-fill-function))
22602 ;; Enforce empty fill prefix, if required. Otherwise, it
22603 ;; will be computed again.
22604 (adaptive-fill-mode (not (equal fill-prefix ""))))
22605 (when fill-prefix (do-auto-fill))))))
22607 (defun org-comment-line-break-function (&optional soft)
22608 "Break line at point and indent, continuing comment if within one.
22609 The inserted newline is marked hard if variable
22610 `use-hard-newlines' is true, unless optional argument SOFT is
22611 non-nil."
22612 (if soft (insert-and-inherit ?\n) (newline 1))
22613 (save-excursion (forward-char -1) (delete-horizontal-space))
22614 (delete-horizontal-space)
22615 (indent-to-left-margin)
22616 (insert-before-markers-and-inherit fill-prefix))
22619 ;;; Comments
22621 ;; Org comments syntax is quite complex. It requires the entire line
22622 ;; to be just a comment. Also, even with the right syntax at the
22623 ;; beginning of line, some some elements (i.e. verse-block or
22624 ;; example-block) don't accept comments. Usual Emacs comment commands
22625 ;; cannot cope with those requirements. Therefore, Org replaces them.
22627 ;; Org still relies on `comment-dwim', but cannot trust
22628 ;; `comment-only-p'. So, `comment-region-function' and
22629 ;; `uncomment-region-function' both point
22630 ;; to`org-comment-or-uncomment-region'. Eventually,
22631 ;; `org-insert-comment' takes care of insertion of comments at the
22632 ;; beginning of line.
22634 ;; `org-setup-comments-handling' install comments related variables
22635 ;; during `org-mode' initialization.
22637 (defun org-setup-comments-handling ()
22638 (interactive)
22639 (org-set-local 'comment-use-syntax nil)
22640 (org-set-local 'comment-start "# ")
22641 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22642 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22643 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22644 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22646 (defun org-insert-comment ()
22647 "Insert an empty comment above current line.
22648 If the line is empty, insert comment at its beginning. When
22649 point is within a source block, comment according to the related
22650 major mode."
22651 (if (let ((element (org-element-at-point)))
22652 (and (eq (org-element-type element) 'src-block)
22653 (< (save-excursion
22654 (goto-char (org-element-property :post-affiliated element))
22655 (line-end-position))
22656 (point))
22657 (> (save-excursion
22658 (goto-char (org-element-property :end element))
22659 (skip-chars-backward " \r\t\n")
22660 (line-beginning-position))
22661 (point))))
22662 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22663 (beginning-of-line)
22664 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
22665 (open-line 1))
22666 (org-indent-line)
22667 (insert "# ")))
22669 (defvar comment-empty-lines) ; From newcomment.el.
22670 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22671 "Comment or uncomment each non-blank line in the region.
22672 Uncomment each non-blank line between BEG and END if it only
22673 contains commented lines. Otherwise, comment them. If region is
22674 strictly within a source block, use appropriate comment syntax."
22675 (if (let ((element (org-element-at-point)))
22676 (and (eq (org-element-type element) 'src-block)
22677 (< (save-excursion
22678 (goto-char (org-element-property :post-affiliated element))
22679 (line-end-position))
22680 beg)
22681 (>= (save-excursion
22682 (goto-char (org-element-property :end element))
22683 (skip-chars-backward " \r\t\n")
22684 (line-beginning-position))
22685 end)))
22686 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22687 (save-restriction
22688 ;; Restrict region
22689 (narrow-to-region (save-excursion (goto-char beg)
22690 (skip-chars-forward " \r\t\n" end)
22691 (line-beginning-position))
22692 (save-excursion (goto-char end)
22693 (skip-chars-backward " \r\t\n" beg)
22694 (line-end-position)))
22695 (let ((uncommentp
22696 ;; UNCOMMENTP is non-nil when every non blank line between
22697 ;; BEG and END is a comment.
22698 (save-excursion
22699 (goto-char (point-min))
22700 (while (and (not (eobp))
22701 (let ((element (org-element-at-point)))
22702 (and (eq (org-element-type element) 'comment)
22703 (goto-char (min (point-max)
22704 (org-element-property
22705 :end element)))))))
22706 (eobp))))
22707 (if uncommentp
22708 ;; Only blank lines and comments in region: uncomment it.
22709 (save-excursion
22710 (goto-char (point-min))
22711 (while (not (eobp))
22712 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22713 (replace-match "" nil nil nil 1))
22714 (forward-line)))
22715 ;; Comment each line in region.
22716 (let ((min-indent (point-max)))
22717 ;; First find the minimum indentation across all lines.
22718 (save-excursion
22719 (goto-char (point-min))
22720 (while (and (not (eobp)) (not (zerop min-indent)))
22721 (unless (looking-at "[ \t]*$")
22722 (setq min-indent (min min-indent (current-indentation))))
22723 (forward-line)))
22724 ;; Then loop over all lines.
22725 (save-excursion
22726 (goto-char (point-min))
22727 (while (not (eobp))
22728 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22729 ;; Don't get fooled by invisible text (e.g. link path)
22730 ;; when moving to column MIN-INDENT.
22731 (let ((buffer-invisibility-spec nil))
22732 (org-move-to-column min-indent t))
22733 (insert comment-start))
22734 (forward-line)))))))))
22736 (defun org-comment-dwim (arg)
22737 (interactive "*P")
22738 "Call `comment-dwim' within a source edit buffer if needed."
22739 (if (org-in-src-block-p)
22740 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22741 (call-interactively #'comment-dwim)))
22744 ;;; Planning
22746 ;; This section contains tools to operate on timestamp objects, as
22747 ;; returned by, e.g. `org-element-context'.
22749 (defun org-timestamp-has-time-p (timestamp)
22750 "Non-nil when TIMESTAMP has a time specified."
22751 (org-element-property :hour-start timestamp))
22753 (defun org-timestamp-format (timestamp format &optional end utc)
22754 "Format a TIMESTAMP element into a string.
22756 FORMAT is a format specifier to be passed to
22757 `format-time-string'.
22759 When optional argument END is non-nil, use end of date-range or
22760 time-range, if possible.
22762 When optional argument UTC is non-nil, time will be expressed as
22763 Universal Time."
22764 (format-time-string
22765 format
22766 (apply 'encode-time
22767 (cons 0
22768 (mapcar
22769 (lambda (prop) (or (org-element-property prop timestamp) 0))
22770 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22771 '(:minute-start :hour-start :day-start :month-start
22772 :year-start)))))
22773 utc))
22775 (defun org-timestamp-split-range (timestamp &optional end)
22776 "Extract a timestamp object from a date or time range.
22778 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22779 the end of the range. Otherwise, extract its start.
22781 Return a new timestamp object sharing the same parent as
22782 TIMESTAMP."
22783 (let ((type (org-element-property :type timestamp)))
22784 (if (memq type '(active inactive diary)) timestamp
22785 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22786 ;; Set new type.
22787 (org-element-put-property
22788 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22789 ;; Copy start properties over end properties if END is
22790 ;; non-nil. Otherwise, copy end properties over `start' ones.
22791 (let ((p-alist '((:minute-start . :minute-end)
22792 (:hour-start . :hour-end)
22793 (:day-start . :day-end)
22794 (:month-start . :month-end)
22795 (:year-start . :year-end))))
22796 (dolist (p-cell p-alist)
22797 (org-element-put-property
22798 split-ts
22799 (funcall (if end 'car 'cdr) p-cell)
22800 (org-element-property
22801 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22802 ;; Eventually refresh `:raw-value'.
22803 (org-element-put-property split-ts :raw-value nil)
22804 (org-element-put-property
22805 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22807 (defun org-timestamp-translate (timestamp &optional boundary)
22808 "Apply `org-translate-time' on a TIMESTAMP object.
22809 When optional argument BOUNDARY is non-nil, it is either the
22810 symbol `start' or `end'. In this case, only translate the
22811 starting or ending part of TIMESTAMP if it is a date or time
22812 range. Otherwise, translate both parts."
22813 (if (and (not boundary)
22814 (memq (org-element-property :type timestamp)
22815 '(active-range inactive-range)))
22816 (concat
22817 (org-translate-time
22818 (org-element-property :raw-value
22819 (org-timestamp-split-range timestamp)))
22820 "--"
22821 (org-translate-time
22822 (org-element-property :raw-value
22823 (org-timestamp-split-range timestamp t))))
22824 (org-translate-time
22825 (org-element-property
22826 :raw-value
22827 (if (not boundary) timestamp
22828 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22832 ;;; Other stuff.
22834 (defun org-toggle-fixed-width-section (arg)
22835 "Toggle the fixed-width export.
22836 If there is no active region, the QUOTE keyword at the current headline is
22837 inserted or removed. When present, it causes the text between this headline
22838 and the next to be exported as fixed-width text, and unmodified.
22839 If there is an active region, this command adds or removes a colon as the
22840 first character of this line. If the first character of a line is a colon,
22841 this line is also exported in fixed-width font."
22842 (interactive "P")
22843 (let* ((cc 0)
22844 (regionp (org-region-active-p))
22845 (beg (if regionp (region-beginning) (point)))
22846 (end (if regionp (region-end)))
22847 (nlines (or arg (if (and beg end) (count-lines beg end) 1)))
22848 (case-fold-search nil)
22849 (re "[ \t]*\\(:\\(?: \\|$\\)\\)")
22850 off)
22851 (if regionp
22852 (save-excursion
22853 (goto-char beg)
22854 (setq cc (current-column))
22855 (beginning-of-line 1)
22856 (setq off (looking-at re))
22857 (while (> nlines 0)
22858 (setq nlines (1- nlines))
22859 (beginning-of-line 1)
22860 (cond
22861 (arg
22862 (org-move-to-column cc t)
22863 (insert ": \n")
22864 (forward-line -1))
22865 ((and off (looking-at re))
22866 (replace-match "" t t nil 1))
22867 ((not off) (org-move-to-column cc t) (insert ": ")))
22868 (forward-line 1)))
22869 (save-excursion
22870 (org-back-to-heading)
22871 (cond
22872 ((looking-at (format org-heading-keyword-regexp-format
22873 org-quote-string))
22874 (goto-char (match-end 1))
22875 (looking-at (concat " +" org-quote-string))
22876 (replace-match "" t t)
22877 (when (eolp) (insert " ")))
22878 ((looking-at org-outline-regexp)
22879 (goto-char (match-end 0))
22880 (insert org-quote-string " ")))))))
22882 (defun org-reftex-citation ()
22883 "Use reftex-citation to insert a citation into the buffer.
22884 This looks for a line like
22886 #+BIBLIOGRAPHY: foo plain option:-d
22888 and derives from it that foo.bib is the bibliography file relevant
22889 for this document. It then installs the necessary environment for RefTeX
22890 to work in this buffer and calls `reftex-citation' to insert a citation
22891 into the buffer.
22893 Export of such citations to both LaTeX and HTML is handled by the contributed
22894 package ox-bibtex by Taru Karttunen."
22895 (interactive)
22896 (let ((reftex-docstruct-symbol 'rds)
22897 (reftex-cite-format "\\cite{%l}")
22898 rds bib)
22899 (save-excursion
22900 (save-restriction
22901 (widen)
22902 (let ((case-fold-search t)
22903 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22904 (if (not (save-excursion
22905 (or (re-search-forward re nil t)
22906 (re-search-backward re nil t))))
22907 (error "No bibliography defined in file")
22908 (setq bib (concat (match-string 1) ".bib")
22909 rds (list (list 'bib bib)))))))
22910 (call-interactively 'reftex-citation)))
22912 ;;;; Functions extending outline functionality
22914 (defun org-beginning-of-line (&optional arg)
22915 "Go to the beginning of the current line. If that is invisible, continue
22916 to a visible line beginning. This makes the function of C-a more intuitive.
22917 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22918 first attempt, and only move to after the tags when the cursor is already
22919 beyond the end of the headline."
22920 (interactive "P")
22921 (let ((pos (point))
22922 (special (if (consp org-special-ctrl-a/e)
22923 (car org-special-ctrl-a/e)
22924 org-special-ctrl-a/e))
22925 deactivate-mark refpos)
22926 (if (org-bound-and-true-p visual-line-mode)
22927 (beginning-of-visual-line 1)
22928 (beginning-of-line 1))
22929 (if (and arg (fboundp 'move-beginning-of-line))
22930 (call-interactively 'move-beginning-of-line)
22931 (if (bobp)
22933 (backward-char 1)
22934 (if (org-truely-invisible-p)
22935 (while (and (not (bobp)) (org-truely-invisible-p))
22936 (backward-char 1)
22937 (beginning-of-line 1))
22938 (forward-char 1))))
22939 (when special
22940 (cond
22941 ((and (looking-at org-complex-heading-regexp)
22942 (= (char-after (match-end 1)) ?\ ))
22943 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
22944 (point-at-eol)))
22945 (goto-char
22946 (if (eq special t)
22947 (cond ((> pos refpos) refpos)
22948 ((= pos (point)) refpos)
22949 (t (point)))
22950 (cond ((> pos (point)) (point))
22951 ((not (eq last-command this-command)) (point))
22952 (t refpos)))))
22953 ((org-at-item-p)
22954 ;; Being at an item and not looking at an the item means point
22955 ;; was previously moved to beginning of a visual line, which
22956 ;; doesn't contain the item. Therefore, do nothing special,
22957 ;; just stay here.
22958 (when (looking-at org-list-full-item-re)
22959 ;; Set special position at first white space character after
22960 ;; bullet, and check-box, if any.
22961 (let ((after-bullet
22962 (let ((box (match-end 3)))
22963 (if (not box) (match-end 1)
22964 (let ((after (char-after box)))
22965 (if (and after (= after ? )) (1+ box) box))))))
22966 ;; Special case: Move point to special position when
22967 ;; currently after it or at beginning of line.
22968 (if (eq special t)
22969 (when (or (> pos after-bullet) (= (point) pos))
22970 (goto-char after-bullet))
22971 ;; Reversed case: Move point to special position when
22972 ;; point was already at beginning of line and command is
22973 ;; repeated.
22974 (when (and (= (point) pos) (eq last-command this-command))
22975 (goto-char after-bullet))))))))
22976 (org-no-warnings
22977 (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 (defun org-end-of-line (&optional arg)
22983 "Go to the end of the line.
22984 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
22985 tags on the first attempt, and only move to after the tags when
22986 the cursor is already beyond the end of the headline."
22987 (interactive "P")
22988 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
22989 org-special-ctrl-a/e))
22990 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
22991 'end-of-visual-line)
22992 ((fboundp 'move-end-of-line) 'move-end-of-line)
22993 (t 'end-of-line)))
22994 deactivate-mark)
22995 (if (or (not special) arg) (call-interactively move-fun)
22996 (let* ((element (save-excursion (beginning-of-line)
22997 (org-element-at-point)))
22998 (type (org-element-type element)))
22999 (cond
23000 ((memq type '(headline inlinetask))
23001 (let ((pos (point)))
23002 (beginning-of-line 1)
23003 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23004 (if (eq special t)
23005 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23006 (goto-char (match-beginning 1))
23007 (goto-char (match-end 0)))
23008 (if (or (< pos (match-end 0))
23009 (not (eq this-command last-command)))
23010 (goto-char (match-end 0))
23011 (goto-char (match-beginning 1))))
23012 (call-interactively move-fun))))
23013 ((outline-invisible-p (line-end-position))
23014 ;; If element is hidden, `move-end-of-line' would put point
23015 ;; after it. Use `end-of-line' to stay on current line.
23016 (call-interactively 'end-of-line))
23017 (t (call-interactively move-fun)))))
23018 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23019 (setq disable-point-adjustment
23020 (or (not (invisible-p (point)))
23021 (not (invisible-p (max (point-min) (1- (point))))))))
23023 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23024 (define-key org-mode-map "\C-e" 'org-end-of-line)
23026 (defun org-backward-sentence (&optional arg)
23027 "Go to beginning of sentence, or beginning of table field.
23028 This will call `backward-sentence' or `org-table-beginning-of-field',
23029 depending on context."
23030 (interactive "P")
23031 (cond
23032 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23033 (t (call-interactively 'backward-sentence))))
23035 (defun org-forward-sentence (&optional arg)
23036 "Go to end of sentence, or end of table field.
23037 This will call `forward-sentence' or `org-table-end-of-field',
23038 depending on context."
23039 (interactive "P")
23040 (cond
23041 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23042 (t (call-interactively 'forward-sentence))))
23044 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23045 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23047 (defun org-kill-line (&optional arg)
23048 "Kill line, to tags or end of line."
23049 (interactive "P")
23050 (cond
23051 ((or (not org-special-ctrl-k)
23052 (bolp)
23053 (not (org-at-heading-p)))
23054 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23055 org-ctrl-k-protect-subtree)
23056 (if (or (eq org-ctrl-k-protect-subtree 'error)
23057 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23058 (user-error "C-k aborted as it would kill a hidden subtree")))
23059 (call-interactively
23060 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23061 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23062 (kill-region (point) (match-beginning 1))
23063 (org-set-tags nil t))
23064 (t (kill-region (point) (point-at-eol)))))
23066 (define-key org-mode-map "\C-k" 'org-kill-line)
23068 (defun org-yank (&optional arg)
23069 "Yank. If the kill is a subtree, treat it specially.
23070 This command will look at the current kill and check if is a single
23071 subtree, or a series of subtrees[1]. If it passes the test, and if the
23072 cursor is at the beginning of a line or after the stars of a currently
23073 empty headline, then the yank is handled specially. How exactly depends
23074 on the value of the following variables, both set by default.
23076 org-yank-folded-subtrees
23077 When set, the subtree(s) will be folded after insertion, but only
23078 if doing so would now swallow text after the yanked text.
23080 org-yank-adjusted-subtrees
23081 When set, the subtree will be promoted or demoted in order to
23082 fit into the local outline tree structure, which means that the level
23083 will be adjusted so that it becomes the smaller one of the two
23084 *visible* surrounding headings.
23086 Any prefix to this command will cause `yank' to be called directly with
23087 no special treatment. In particular, a simple \\[universal-argument] prefix \
23088 will just
23089 plainly yank the text as it is.
23091 \[1] The test checks if the first non-white line is a heading
23092 and if there are no other headings with fewer stars."
23093 (interactive "P")
23094 (org-yank-generic 'yank arg))
23096 (defun org-yank-generic (command arg)
23097 "Perform some yank-like command.
23099 This function implements the behavior described in the `org-yank'
23100 documentation. However, it has been generalized to work for any
23101 interactive command with similar behavior."
23103 ;; pretend to be command COMMAND
23104 (setq this-command command)
23106 (if arg
23107 (call-interactively command)
23109 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23110 (and (org-kill-is-subtree-p)
23111 (or (bolp)
23112 (and (looking-at "[ \t]*$")
23113 (string-match
23114 "\\`\\*+\\'"
23115 (buffer-substring (point-at-bol) (point)))))))
23116 swallowp)
23117 (cond
23118 ((and subtreep org-yank-folded-subtrees)
23119 (let ((beg (point))
23120 end)
23121 (if (and subtreep org-yank-adjusted-subtrees)
23122 (org-paste-subtree nil nil 'for-yank)
23123 (call-interactively command))
23125 (setq end (point))
23126 (goto-char beg)
23127 (when (and (bolp) subtreep
23128 (not (setq swallowp
23129 (org-yank-folding-would-swallow-text beg end))))
23130 (org-with-limited-levels
23131 (or (looking-at org-outline-regexp)
23132 (re-search-forward org-outline-regexp-bol end t))
23133 (while (and (< (point) end) (looking-at org-outline-regexp))
23134 (hide-subtree)
23135 (org-cycle-show-empty-lines 'folded)
23136 (condition-case nil
23137 (outline-forward-same-level 1)
23138 (error (goto-char end))))))
23139 (when swallowp
23140 (message
23141 "Inserted text not folded because that would swallow text"))
23143 (goto-char end)
23144 (skip-chars-forward " \t\n\r")
23145 (beginning-of-line 1)
23146 (push-mark beg 'nomsg)))
23147 ((and subtreep org-yank-adjusted-subtrees)
23148 (let ((beg (point-at-bol)))
23149 (org-paste-subtree nil nil 'for-yank)
23150 (push-mark beg 'nomsg)))
23152 (call-interactively command))))))
23154 (defun org-yank-folding-would-swallow-text (beg end)
23155 "Would hide-subtree at BEG swallow any text after END?"
23156 (let (level)
23157 (org-with-limited-levels
23158 (save-excursion
23159 (goto-char beg)
23160 (when (or (looking-at org-outline-regexp)
23161 (re-search-forward org-outline-regexp-bol end t))
23162 (setq level (org-outline-level)))
23163 (goto-char end)
23164 (skip-chars-forward " \t\r\n\v\f")
23165 (if (or (eobp)
23166 (and (bolp) (looking-at org-outline-regexp)
23167 (<= (org-outline-level) level)))
23168 nil ; Nothing would be swallowed
23169 t))))) ; something would swallow
23171 (define-key org-mode-map "\C-y" 'org-yank)
23173 (defun org-truely-invisible-p ()
23174 "Check if point is at a character currently not visible.
23175 This version does not only check the character property, but also
23176 `visible-mode'."
23177 ;; Early versions of noutline don't have `outline-invisible-p'.
23178 (if (org-bound-and-true-p visible-mode)
23180 (outline-invisible-p)))
23182 (defun org-invisible-p2 ()
23183 "Check if point is at a character currently not visible."
23184 (save-excursion
23185 (if (and (eolp) (not (bobp))) (backward-char 1))
23186 ;; Early versions of noutline don't have `outline-invisible-p'.
23187 (outline-invisible-p)))
23189 (defun org-back-to-heading (&optional invisible-ok)
23190 "Call `outline-back-to-heading', but provide a better error message."
23191 (condition-case nil
23192 (outline-back-to-heading invisible-ok)
23193 (error (error "Before first headline at position %d in buffer %s"
23194 (point) (current-buffer)))))
23196 (defun org-before-first-heading-p ()
23197 "Before first heading?"
23198 (save-excursion
23199 (end-of-line)
23200 (null (re-search-backward org-outline-regexp-bol nil t))))
23202 (defun org-at-heading-p (&optional ignored)
23203 (outline-on-heading-p t))
23204 ;; Compatibility alias with Org versions < 7.8.03
23205 (defalias 'org-on-heading-p 'org-at-heading-p)
23207 (defun org-at-comment-p nil
23208 "Is cursor in a line starting with a # character?"
23209 (save-excursion
23210 (beginning-of-line)
23211 (looking-at "^#")))
23213 (defun org-at-drawer-p nil
23214 "Is cursor at a drawer keyword?"
23215 (save-excursion
23216 (move-beginning-of-line 1)
23217 (looking-at org-drawer-regexp)))
23219 (defun org-at-block-p nil
23220 "Is cursor at a block keyword?"
23221 (save-excursion
23222 (move-beginning-of-line 1)
23223 (looking-at org-block-regexp)))
23225 (defun org-point-at-end-of-empty-headline ()
23226 "If point is at the end of an empty headline, return t, else nil.
23227 If the heading only contains a TODO keyword, it is still still considered
23228 empty."
23229 (and (looking-at "[ \t]*$")
23230 (when org-todo-line-regexp
23231 (save-excursion
23232 (beginning-of-line 1)
23233 (let ((case-fold-search nil))
23234 (looking-at org-todo-line-regexp)
23235 (string= (match-string 3) ""))))))
23237 (defun org-at-heading-or-item-p ()
23238 (or (org-at-heading-p) (org-at-item-p)))
23240 (defun org-at-target-p ()
23241 (or (org-in-regexp org-radio-target-regexp)
23242 (org-in-regexp org-target-regexp)))
23243 ;; Compatibility alias with Org versions < 7.8.03
23244 (defalias 'org-on-target-p 'org-at-target-p)
23246 (defun org-up-heading-all (arg)
23247 "Move to the heading line of which the present line is a subheading.
23248 This function considers both visible and invisible heading lines.
23249 With argument, move up ARG levels."
23250 (if (fboundp 'outline-up-heading-all)
23251 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23252 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23254 (defun org-up-heading-safe ()
23255 "Move to the heading line of which the present line is a subheading.
23256 This version will not throw an error. It will return the level of the
23257 headline found, or nil if no higher level is found.
23259 Also, this function will be a lot faster than `outline-up-heading',
23260 because it relies on stars being the outline starters. This can really
23261 make a significant difference in outlines with very many siblings."
23262 (let (start-level re)
23263 (org-back-to-heading t)
23264 (setq start-level (funcall outline-level))
23265 (if (equal start-level 1)
23267 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23268 (if (re-search-backward re nil t)
23269 (funcall outline-level)))))
23271 (defun org-first-sibling-p ()
23272 "Is this heading the first child of its parents?"
23273 (interactive)
23274 (let ((re org-outline-regexp-bol)
23275 level l)
23276 (unless (org-at-heading-p t)
23277 (user-error "Not at a heading"))
23278 (setq level (funcall outline-level))
23279 (save-excursion
23280 (if (not (re-search-backward re nil t))
23282 (setq l (funcall outline-level))
23283 (< l level)))))
23285 (defun org-goto-sibling (&optional previous)
23286 "Goto the next sibling, even if it is invisible.
23287 When PREVIOUS is set, go to the previous sibling instead. Returns t
23288 when a sibling was found. When none is found, return nil and don't
23289 move point."
23290 (let ((fun (if previous 're-search-backward 're-search-forward))
23291 (pos (point))
23292 (re org-outline-regexp-bol)
23293 level l)
23294 (when (condition-case nil (org-back-to-heading t) (error nil))
23295 (setq level (funcall outline-level))
23296 (catch 'exit
23297 (or previous (forward-char 1))
23298 (while (funcall fun re nil t)
23299 (setq l (funcall outline-level))
23300 (when (< l level) (goto-char pos) (throw 'exit nil))
23301 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23302 (goto-char pos)
23303 nil))))
23305 (defun org-show-siblings ()
23306 "Show all siblings of the current headline."
23307 (save-excursion
23308 (while (org-goto-sibling) (org-flag-heading nil)))
23309 (save-excursion
23310 (while (org-goto-sibling 'previous)
23311 (org-flag-heading nil))))
23313 (defun org-goto-first-child ()
23314 "Goto the first child, even if it is invisible.
23315 Return t when a child was found. Otherwise don't move point and
23316 return nil."
23317 (let (level (pos (point)) (re org-outline-regexp-bol))
23318 (when (condition-case nil (org-back-to-heading t) (error nil))
23319 (setq level (outline-level))
23320 (forward-char 1)
23321 (if (and (re-search-forward re nil t) (> (outline-level) level))
23322 (progn (goto-char (match-beginning 0)) t)
23323 (goto-char pos) nil))))
23325 (defun org-show-hidden-entry ()
23326 "Show an entry where even the heading is hidden."
23327 (save-excursion
23328 (org-show-entry)))
23330 (defun org-flag-heading (flag &optional entry)
23331 "Flag the current heading. FLAG non-nil means make invisible.
23332 When ENTRY is non-nil, show the entire entry."
23333 (save-excursion
23334 (org-back-to-heading t)
23335 ;; Check if we should show the entire entry
23336 (if entry
23337 (progn
23338 (org-show-entry)
23339 (save-excursion
23340 (and (outline-next-heading)
23341 (org-flag-heading nil))))
23342 (outline-flag-region (max (point-min) (1- (point)))
23343 (save-excursion (outline-end-of-heading) (point))
23344 flag))))
23346 (defun org-get-next-sibling ()
23347 "Move to next heading of the same level, and return point.
23348 If there is no such heading, return nil.
23349 This is like outline-next-sibling, but invisible headings are ok."
23350 (let ((level (funcall outline-level)))
23351 (outline-next-heading)
23352 (while (and (not (eobp)) (> (funcall outline-level) level))
23353 (outline-next-heading))
23354 (if (or (eobp) (< (funcall outline-level) level))
23356 (point))))
23358 (defun org-get-last-sibling ()
23359 "Move to previous heading of the same level, and return point.
23360 If there is no such heading, return nil."
23361 (let ((opoint (point))
23362 (level (funcall outline-level)))
23363 (outline-previous-heading)
23364 (when (and (/= (point) opoint) (outline-on-heading-p t))
23365 (while (and (> (funcall outline-level) level)
23366 (not (bobp)))
23367 (outline-previous-heading))
23368 (if (< (funcall outline-level) level)
23370 (point)))))
23372 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23373 "Goto to the end of a subtree."
23374 ;; This contains an exact copy of the original function, but it uses
23375 ;; `org-back-to-heading', to make it work also in invisible
23376 ;; trees. And is uses an invisible-ok argument.
23377 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23378 ;; Furthermore, when used inside Org, finding the end of a large subtree
23379 ;; with many children and grandchildren etc, this can be much faster
23380 ;; than the outline version.
23381 (org-back-to-heading invisible-ok)
23382 (let ((first t)
23383 (level (funcall outline-level)))
23384 (if (and (derived-mode-p 'org-mode) (< level 1000))
23385 ;; A true heading (not a plain list item), in Org-mode
23386 ;; This means we can easily find the end by looking
23387 ;; only for the right number of stars. Using a regexp to do
23388 ;; this is so much faster than using a Lisp loop.
23389 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23390 (forward-char 1)
23391 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23392 ;; something else, do it the slow way
23393 (while (and (not (eobp))
23394 (or first (> (funcall outline-level) level)))
23395 (setq first nil)
23396 (outline-next-heading)))
23397 (unless to-heading
23398 (if (memq (preceding-char) '(?\n ?\^M))
23399 (progn
23400 ;; Go to end of line before heading
23401 (forward-char -1)
23402 (if (memq (preceding-char) '(?\n ?\^M))
23403 ;; leave blank line before heading
23404 (forward-char -1))))))
23405 (point))
23407 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23408 "Use Org version in org-mode, for dramatic speed-up."
23409 (if (derived-mode-p 'org-mode)
23410 (progn
23411 (org-end-of-subtree nil t)
23412 (unless (eobp) (backward-char 1)))
23413 ad-do-it))
23415 (defun org-end-of-meta-data-and-drawers ()
23416 "Jump to the first text after meta data and drawers in the current entry.
23417 This will move over empty lines, lines with planning time stamps,
23418 clocking lines, and drawers."
23419 (org-back-to-heading t)
23420 (let ((end (save-excursion (outline-next-heading) (point)))
23421 (re (concat "\\(" org-drawer-regexp "\\)"
23422 "\\|" "[ \t]*" org-keyword-time-regexp)))
23423 (forward-line 1)
23424 (while (re-search-forward re end t)
23425 (if (not (match-end 1))
23426 ;; empty or planning line
23427 (forward-line 1)
23428 ;; a drawer, find the end
23429 (re-search-forward "^[ \t]*:END:" end 'move)
23430 (forward-line 1)))
23431 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23432 (point)))
23434 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23435 "Move forward to the ARG'th subheading at same level as this one.
23436 Stop at the first and last subheadings of a superior heading.
23437 Normally this only looks at visible headings, but when INVISIBLE-OK is
23438 non-nil it will also look at invisible ones."
23439 (interactive "p")
23440 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23441 (if (and arg (< arg 0))
23442 (goto-char (point-min))
23443 (outline-next-heading))
23444 (org-at-heading-p)
23445 (let ((level (- (match-end 0) (match-beginning 0) 1))
23446 (f (if (and arg (< arg 0))
23447 're-search-backward
23448 're-search-forward))
23449 (count (if arg (abs arg) 1))
23450 (result (point)))
23451 (while (and (prog1 (> count 0)
23452 (forward-char (if (and arg (< arg 0)) -1 1)))
23453 (funcall f org-outline-regexp-bol nil 'move))
23454 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23455 (cond ((< l level) (setq count 0))
23456 ((and (= l level)
23457 (or invisible-ok
23458 (progn
23459 (goto-char (line-beginning-position))
23460 (not (outline-invisible-p)))))
23461 (setq count (1- count))
23462 (when (eq l level)
23463 (setq result (point)))))))
23464 (goto-char result))
23465 (beginning-of-line 1)))
23467 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23468 "Move backward to the ARG'th subheading at same level as this one.
23469 Stop at the first and last subheadings of a superior heading."
23470 (interactive "p")
23471 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23473 (defun org-next-block (arg &optional backward block-regexp)
23474 "Jump to the next block.
23475 With a prefix argument ARG, jump forward ARG many source blocks.
23476 When BACKWARD is non-nil, jump to the previous block.
23477 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23478 (interactive "p")
23479 (let ((re (or block-regexp org-block-regexp))
23480 (re-search-fn (or (and backward 're-search-backward)
23481 're-search-forward)))
23482 (if (looking-at re) (forward-char 1))
23483 (condition-case nil
23484 (funcall re-search-fn re nil nil arg)
23485 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23486 (goto-char (match-beginning 0)) (org-show-context)))
23488 (defun org-previous-block (arg &optional block-regexp)
23489 "Jump to the previous block.
23490 With a prefix argument ARG, jump backward ARG many source blocks.
23491 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23492 (interactive "p")
23493 (org-next-block arg t block-regexp))
23495 (defun org-forward-paragraph ()
23496 "Move forward to beginning of next paragraph or equivalent.
23498 The function moves point to the beginning of the next visible
23499 structural element, which can be a paragraph, a table, a list
23500 item, etc. It also provides some special moves for convenience:
23502 - On an affiliated keyword, jump to the beginning of the
23503 relative element.
23504 - On an item or a footnote definition, move to the second
23505 element inside, if any.
23506 - On a table or a property drawer, jump after it.
23507 - On a verse or source block, stop after blank lines."
23508 (interactive)
23509 (when (eobp) (user-error "Cannot move further down"))
23510 (let* ((deactivate-mark nil)
23511 (element (org-element-at-point))
23512 (type (org-element-type element))
23513 (post-affiliated (org-element-property :post-affiliated element))
23514 (contents-begin (org-element-property :contents-begin element))
23515 (contents-end (org-element-property :contents-end element))
23516 (end (let ((end (org-element-property :end element)) (parent element))
23517 (while (and (setq parent (org-element-property :parent parent))
23518 (= (org-element-property :contents-end parent) end))
23519 (setq end (org-element-property :end parent)))
23520 end)))
23521 (cond ((not element)
23522 (skip-chars-forward " \r\t\n")
23523 (or (eobp) (beginning-of-line)))
23524 ;; On affiliated keywords, move to element's beginning.
23525 ((and post-affiliated (< (point) post-affiliated))
23526 (goto-char post-affiliated))
23527 ;; At a table row, move to the end of the table. Similarly,
23528 ;; at a node property, move to the end of the property
23529 ;; drawer.
23530 ((memq type '(node-property table-row))
23531 (goto-char (org-element-property
23532 :end (org-element-property :parent element))))
23533 ((memq type '(property-drawer table)) (goto-char end))
23534 ;; Consider blank lines as separators in verse and source
23535 ;; blocks to ease editing.
23536 ((memq type '(src-block verse-block))
23537 (when (eq type 'src-block)
23538 (setq contents-end
23539 (save-excursion (goto-char end)
23540 (skip-chars-backward " \r\t\n")
23541 (line-beginning-position))))
23542 (beginning-of-line)
23543 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23544 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23545 (goto-char end)
23546 (skip-chars-forward " \r\t\n")
23547 (if (= (point) contents-end) (goto-char end)
23548 (beginning-of-line))))
23549 ;; With no contents, just skip element.
23550 ((not contents-begin) (goto-char end))
23551 ;; If contents are invisible, skip the element altogether.
23552 ((outline-invisible-p (line-end-position))
23553 (case type
23554 (headline
23555 (org-with-limited-levels (outline-next-visible-heading 1)))
23556 ;; At a plain list, make sure we move to the next item
23557 ;; instead of skipping the whole list.
23558 (plain-list (forward-char)
23559 (org-forward-paragraph))
23560 (otherwise (goto-char end))))
23561 ((>= (point) contents-end) (goto-char end))
23562 ((>= (point) contents-begin)
23563 ;; This can only happen on paragraphs and plain lists.
23564 (case type
23565 (paragraph (goto-char end))
23566 ;; At a plain list, try to move to second element in
23567 ;; first item, if possible.
23568 (plain-list (end-of-line)
23569 (org-forward-paragraph))))
23570 ;; When contents start on the middle of a line (e.g. in
23571 ;; items and footnote definitions), try to reach first
23572 ;; element starting after current line.
23573 ((> (line-end-position) contents-begin)
23574 (end-of-line)
23575 (org-forward-paragraph))
23576 (t (goto-char contents-begin)))))
23578 (defun org-backward-paragraph ()
23579 "Move backward to start of previous paragraph or equivalent.
23581 The function moves point to the beginning of the current
23582 structural element, which can be a paragraph, a table, a list
23583 item, etc., or to the beginning of the previous visible one if
23584 point is already there. It also provides some special moves for
23585 convenience:
23587 - On an affiliated keyword, jump to the first one.
23588 - On a table or a property drawer, move to its beginning.
23589 - On a verse or source block, stop before blank lines."
23590 (interactive)
23591 (when (bobp) (user-error "Cannot move further up"))
23592 (let* ((deactivate-mark nil)
23593 (element (org-element-at-point))
23594 (type (org-element-type element))
23595 (contents-begin (org-element-property :contents-begin element))
23596 (contents-end (org-element-property :contents-end element))
23597 (post-affiliated (org-element-property :post-affiliated element))
23598 (begin (org-element-property :begin element)))
23599 (cond
23600 ((not element) (goto-char (point-min)))
23601 ((= (point) begin)
23602 (backward-char)
23603 (org-backward-paragraph))
23604 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23605 ((memq type '(node-property table-row))
23606 (goto-char (org-element-property
23607 :post-affiliated (org-element-property :parent element))))
23608 ((memq type '(property-drawer table)) (goto-char begin))
23609 ((memq type '(src-block verse-block))
23610 (when (eq type 'src-block)
23611 (setq contents-begin
23612 (save-excursion (goto-char begin) (forward-line) (point))))
23613 (if (= (point) contents-begin) (goto-char post-affiliated)
23614 ;; Inside a verse block, see blank lines as paragraph
23615 ;; separators.
23616 (let ((origin (point)))
23617 (skip-chars-backward " \r\t\n" contents-begin)
23618 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23619 (skip-chars-forward " \r\t\n" origin)
23620 (if (= (point) origin) (goto-char contents-begin)
23621 (beginning-of-line))))))
23622 ((not contents-begin) (goto-char (or post-affiliated begin)))
23623 ((eq type 'paragraph)
23624 (goto-char contents-begin)
23625 ;; When at first paragraph in an item or a footnote definition,
23626 ;; move directly to beginning of line.
23627 (let ((parent-contents
23628 (org-element-property
23629 :contents-begin (org-element-property :parent element))))
23630 (when (and parent-contents (= parent-contents contents-begin))
23631 (beginning-of-line))))
23632 ;; At the end of a greater element, move to the beginning of the
23633 ;; last element within.
23634 ((>= (point) contents-end)
23635 (goto-char (1- contents-end))
23636 (org-backward-paragraph))
23637 (t (goto-char (or post-affiliated begin))))
23638 ;; Ensure we never leave point invisible.
23639 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23641 (defun org-forward-element ()
23642 "Move forward by one element.
23643 Move to the next element at the same level, when possible."
23644 (interactive)
23645 (cond ((eobp) (user-error "Cannot move further down"))
23646 ((org-with-limited-levels (org-at-heading-p))
23647 (let ((origin (point)))
23648 (goto-char (org-end-of-subtree nil t))
23649 (unless (org-with-limited-levels (org-at-heading-p))
23650 (goto-char origin)
23651 (user-error "Cannot move further down"))))
23653 (let* ((elem (org-element-at-point))
23654 (end (org-element-property :end elem))
23655 (parent (org-element-property :parent elem)))
23656 (cond ((and parent (= (org-element-property :contents-end parent) end))
23657 (goto-char (org-element-property :end parent)))
23658 ((integer-or-marker-p end) (goto-char end))
23659 (t (message "No element at point")))))))
23661 (defun org-backward-element ()
23662 "Move backward by one element.
23663 Move to the previous element at the same level, when possible."
23664 (interactive)
23665 (cond ((bobp) (user-error "Cannot move further up"))
23666 ((org-with-limited-levels (org-at-heading-p))
23667 ;; At a headline, move to the previous one, if any, or stay
23668 ;; here.
23669 (let ((origin (point)))
23670 (org-with-limited-levels (org-backward-heading-same-level 1))
23671 ;; When current headline has no sibling above, move to its
23672 ;; parent.
23673 (when (= (point) origin)
23674 (or (org-with-limited-levels (org-up-heading-safe))
23675 (progn (goto-char origin)
23676 (user-error "Cannot move further up"))))))
23678 (let* ((elem (org-element-at-point))
23679 (beg (org-element-property :begin elem)))
23680 (cond
23681 ;; Move to beginning of current element if point isn't
23682 ;; there already.
23683 ((null beg) (message "No element at point"))
23684 ((/= (point) beg) (goto-char beg))
23685 (t (goto-char beg)
23686 (skip-chars-backward " \r\t\n")
23687 (unless (bobp)
23688 (let ((prev (org-element-at-point)))
23689 (goto-char (org-element-property :begin prev))
23690 (while (and (setq prev (org-element-property :parent prev))
23691 (<= (org-element-property :end prev) beg))
23692 (goto-char (org-element-property :begin prev)))))))))))
23694 (defun org-up-element ()
23695 "Move to upper element."
23696 (interactive)
23697 (if (org-with-limited-levels (org-at-heading-p))
23698 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23699 (let* ((elem (org-element-at-point))
23700 (parent (org-element-property :parent elem)))
23701 (if parent (goto-char (org-element-property :begin parent))
23702 (if (org-with-limited-levels (org-before-first-heading-p))
23703 (user-error "No surrounding element")
23704 (org-with-limited-levels (org-back-to-heading)))))))
23706 (defvar org-element-greater-elements)
23707 (defun org-down-element ()
23708 "Move to inner element."
23709 (interactive)
23710 (let ((element (org-element-at-point)))
23711 (cond
23712 ((memq (org-element-type element) '(plain-list table))
23713 (goto-char (org-element-property :contents-begin element))
23714 (forward-char))
23715 ((memq (org-element-type element) org-element-greater-elements)
23716 ;; If contents are hidden, first disclose them.
23717 (when (outline-invisible-p (line-end-position)) (org-cycle))
23718 (goto-char (or (org-element-property :contents-begin element)
23719 (user-error "No content for this element"))))
23720 (t (user-error "No inner element")))))
23722 (defun org-drag-element-backward ()
23723 "Move backward element at point."
23724 (interactive)
23725 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23726 (let* ((elem (org-element-at-point))
23727 (prev-elem
23728 (save-excursion
23729 (goto-char (org-element-property :begin elem))
23730 (skip-chars-backward " \r\t\n")
23731 (unless (bobp)
23732 (let* ((beg (org-element-property :begin elem))
23733 (prev (org-element-at-point))
23734 (up prev))
23735 (while (and (setq up (org-element-property :parent up))
23736 (<= (org-element-property :end prev) beg))
23737 (setq prev up))
23738 prev)))))
23739 ;; Error out if no previous element or previous element is
23740 ;; a parent of the current one.
23741 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23742 (user-error "Cannot drag element backward")
23743 (let ((pos (point)))
23744 (org-element-swap-A-B prev-elem elem)
23745 (goto-char (+ (org-element-property :begin prev-elem)
23746 (- pos (org-element-property :begin elem)))))))))
23748 (defun org-drag-element-forward ()
23749 "Move forward element at point."
23750 (interactive)
23751 (let* ((pos (point))
23752 (elem (org-element-at-point)))
23753 (when (= (point-max) (org-element-property :end elem))
23754 (user-error "Cannot drag element forward"))
23755 (goto-char (org-element-property :end elem))
23756 (let ((next-elem (org-element-at-point)))
23757 (when (or (org-element-nested-p elem next-elem)
23758 (and (eq (org-element-type next-elem) 'headline)
23759 (not (eq (org-element-type elem) 'headline))))
23760 (goto-char pos)
23761 (user-error "Cannot drag element forward"))
23762 ;; Compute new position of point: it's shifted by NEXT-ELEM
23763 ;; body's length (without final blanks) and by the length of
23764 ;; blanks between ELEM and NEXT-ELEM.
23765 (let ((size-next (- (save-excursion
23766 (goto-char (org-element-property :end next-elem))
23767 (skip-chars-backward " \r\t\n")
23768 (forward-line)
23769 ;; Small correction if buffer doesn't end
23770 ;; with a newline character.
23771 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23772 (org-element-property :begin next-elem)))
23773 (size-blank (- (org-element-property :end elem)
23774 (save-excursion
23775 (goto-char (org-element-property :end elem))
23776 (skip-chars-backward " \r\t\n")
23777 (forward-line)
23778 (point)))))
23779 (org-element-swap-A-B elem next-elem)
23780 (goto-char (+ pos size-next size-blank))))))
23782 (defun org-drag-line-forward (arg)
23783 "Drag the line at point ARG lines forward."
23784 (interactive "p")
23785 (dotimes (n (abs arg))
23786 (let ((c (current-column)))
23787 (if (< 0 arg)
23788 (progn
23789 (beginning-of-line 2)
23790 (transpose-lines 1)
23791 (beginning-of-line 0))
23792 (transpose-lines 1)
23793 (beginning-of-line -1))
23794 (org-move-to-column c))))
23796 (defun org-drag-line-backward (arg)
23797 "Drag the line at point ARG lines backward."
23798 (interactive "p")
23799 (org-drag-line-forward (- arg)))
23801 (defun org-mark-element ()
23802 "Put point at beginning of this element, mark at end.
23804 Interactively, if this command is repeated or (in Transient Mark
23805 mode) if the mark is active, it marks the next element after the
23806 ones already marked."
23807 (interactive)
23808 (let (deactivate-mark)
23809 (if (and (org-called-interactively-p 'any)
23810 (or (and (eq last-command this-command) (mark t))
23811 (and transient-mark-mode mark-active)))
23812 (set-mark
23813 (save-excursion
23814 (goto-char (mark))
23815 (goto-char (org-element-property :end (org-element-at-point)))))
23816 (let ((element (org-element-at-point)))
23817 (end-of-line)
23818 (push-mark (org-element-property :end element) t t)
23819 (goto-char (org-element-property :begin element))))))
23821 (defun org-narrow-to-element ()
23822 "Narrow buffer to current element."
23823 (interactive)
23824 (let ((elem (org-element-at-point)))
23825 (cond
23826 ((eq (car elem) 'headline)
23827 (narrow-to-region
23828 (org-element-property :begin elem)
23829 (org-element-property :end elem)))
23830 ((memq (car elem) org-element-greater-elements)
23831 (narrow-to-region
23832 (org-element-property :contents-begin elem)
23833 (org-element-property :contents-end elem)))
23835 (narrow-to-region
23836 (org-element-property :begin elem)
23837 (org-element-property :end elem))))))
23839 (defun org-transpose-element ()
23840 "Transpose current and previous elements, keeping blank lines between.
23841 Point is moved after both elements."
23842 (interactive)
23843 (org-skip-whitespace)
23844 (let ((end (org-element-property :end (org-element-at-point))))
23845 (org-drag-element-backward)
23846 (goto-char end)))
23848 (defun org-unindent-buffer ()
23849 "Un-indent the visible part of the buffer.
23850 Relative indentation (between items, inside blocks, etc.) isn't
23851 modified."
23852 (interactive)
23853 (unless (eq major-mode 'org-mode)
23854 (user-error "Cannot un-indent a buffer not in Org mode"))
23855 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23856 unindent-tree ; For byte-compiler.
23857 (unindent-tree
23858 (function
23859 (lambda (contents)
23860 (mapc
23861 (lambda (element)
23862 (if (memq (org-element-type element) '(headline section))
23863 (funcall unindent-tree (org-element-contents element))
23864 (save-excursion
23865 (save-restriction
23866 (narrow-to-region
23867 (org-element-property :begin element)
23868 (org-element-property :end element))
23869 (org-do-remove-indentation)))))
23870 (reverse contents))))))
23871 (funcall unindent-tree (org-element-contents parse-tree))))
23873 (defun org-show-subtree ()
23874 "Show everything after this heading at deeper levels."
23875 (interactive)
23876 (outline-flag-region
23877 (point)
23878 (save-excursion
23879 (org-end-of-subtree t t))
23880 nil))
23882 (defun org-show-entry ()
23883 "Show the body directly following this heading.
23884 Show the heading too, if it is currently invisible."
23885 (interactive)
23886 (save-excursion
23887 (condition-case nil
23888 (progn
23889 (org-back-to-heading t)
23890 (outline-flag-region
23891 (max (point-min) (1- (point)))
23892 (save-excursion
23893 (if (re-search-forward
23894 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23895 (match-beginning 1)
23896 (point-max)))
23897 nil)
23898 (org-cycle-hide-drawers 'children))
23899 (error nil))))
23901 (defun org-make-options-regexp (kwds &optional extra)
23902 "Make a regular expression for keyword lines."
23903 (concat
23904 "^#\\+\\("
23905 (mapconcat 'regexp-quote kwds "\\|")
23906 (if extra (concat "\\|" extra))
23907 "\\):[ \t]*\\(.*\\)"))
23909 ;; Make isearch reveal the necessary context
23910 (defun org-isearch-end ()
23911 "Reveal context after isearch exits."
23912 (when isearch-success ; only if search was successful
23913 (if (featurep 'xemacs)
23914 ;; Under XEmacs, the hook is run in the correct place,
23915 ;; we directly show the context.
23916 (org-show-context 'isearch)
23917 ;; In Emacs the hook runs *before* restoring the overlays.
23918 ;; So we have to use a one-time post-command-hook to do this.
23919 ;; (Emacs 22 has a special variable, see function `org-mode')
23920 (unless (and (boundp 'isearch-mode-end-hook-quit)
23921 isearch-mode-end-hook-quit)
23922 ;; Only when the isearch was not quitted.
23923 (org-add-hook 'post-command-hook 'org-isearch-post-command
23924 'append 'local)))
23925 (org-fix-ellipsis-at-bol)))
23927 (defun org-isearch-post-command ()
23928 "Remove self from hook, and show context."
23929 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23930 (org-show-context 'isearch))
23933 ;;;; Integration with and fixes for other packages
23935 ;;; Imenu support
23937 (defvar org-imenu-markers nil
23938 "All markers currently used by Imenu.")
23939 (make-variable-buffer-local 'org-imenu-markers)
23941 (defun org-imenu-new-marker (&optional pos)
23942 "Return a new marker for use by Imenu, and remember the marker."
23943 (let ((m (make-marker)))
23944 (move-marker m (or pos (point)))
23945 (push m org-imenu-markers)
23948 (defun org-imenu-get-tree ()
23949 "Produce the index for Imenu."
23950 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
23951 (setq org-imenu-markers nil)
23952 (let* ((n org-imenu-depth)
23953 (re (concat "^" (org-get-limited-outline-regexp)))
23954 (subs (make-vector (1+ n) nil))
23955 (last-level 0)
23956 m level head0 head)
23957 (save-excursion
23958 (save-restriction
23959 (widen)
23960 (goto-char (point-max))
23961 (while (re-search-backward re nil t)
23962 (setq level (org-reduced-level (funcall outline-level)))
23963 (when (and (<= level n)
23964 (looking-at org-complex-heading-regexp)
23965 (setq head0 (org-match-string-no-properties 4)))
23966 (setq head (org-link-display-format head0)
23967 m (org-imenu-new-marker))
23968 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
23969 (if (>= level last-level)
23970 (push (cons head m) (aref subs level))
23971 (push (cons head (aref subs (1+ level))) (aref subs level))
23972 (loop for i from (1+ level) to n do (aset subs i nil)))
23973 (setq last-level level)))))
23974 (aref subs 1)))
23976 (eval-after-load "imenu"
23977 '(progn
23978 (add-hook 'imenu-after-jump-hook
23979 (lambda ()
23980 (if (derived-mode-p 'org-mode)
23981 (org-show-context 'org-goto))))))
23983 (defun org-link-display-format (link)
23984 "Replace a link with its the description.
23985 If there is no description, use the link target."
23986 (save-match-data
23987 (if (string-match org-bracket-link-analytic-regexp link)
23988 (replace-match (if (match-end 5)
23989 (match-string 5 link)
23990 (concat (match-string 1 link)
23991 (match-string 3 link)))
23992 nil t link)
23993 link)))
23995 (defun org-toggle-link-display ()
23996 "Toggle the literal or descriptive display of links."
23997 (interactive)
23998 (if org-descriptive-links
23999 (progn (org-remove-from-invisibility-spec '(org-link))
24000 (org-restart-font-lock)
24001 (setq org-descriptive-links nil))
24002 (progn (add-to-invisibility-spec '(org-link))
24003 (org-restart-font-lock)
24004 (setq org-descriptive-links t))))
24006 ;; Speedbar support
24008 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24009 "Overlay marking the agenda restriction line in speedbar.")
24010 (overlay-put org-speedbar-restriction-lock-overlay
24011 'face 'org-agenda-restriction-lock)
24012 (overlay-put org-speedbar-restriction-lock-overlay
24013 'help-echo "Agendas are currently limited to this item.")
24014 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24016 (defun org-speedbar-set-agenda-restriction ()
24017 "Restrict future agenda commands to the location at point in speedbar.
24018 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24019 (interactive)
24020 (require 'org-agenda)
24021 (let (p m tp np dir txt)
24022 (cond
24023 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24024 'org-imenu t))
24025 (setq m (get-text-property p 'org-imenu-marker))
24026 (with-current-buffer (marker-buffer m)
24027 (goto-char m)
24028 (org-agenda-set-restriction-lock 'subtree)))
24029 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24030 'speedbar-function 'speedbar-find-file))
24031 (setq tp (previous-single-property-change
24032 (1+ p) 'speedbar-function)
24033 np (next-single-property-change
24034 tp 'speedbar-function)
24035 dir (speedbar-line-directory)
24036 txt (buffer-substring-no-properties (or tp (point-min))
24037 (or np (point-max))))
24038 (with-current-buffer (find-file-noselect
24039 (let ((default-directory dir))
24040 (expand-file-name txt)))
24041 (unless (derived-mode-p 'org-mode)
24042 (user-error "Cannot restrict to non-Org-mode file"))
24043 (org-agenda-set-restriction-lock 'file)))
24044 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24045 (move-overlay org-speedbar-restriction-lock-overlay
24046 (point-at-bol) (point-at-eol))
24047 (setq current-prefix-arg nil)
24048 (org-agenda-maybe-redo)))
24050 (defvar speedbar-file-key-map)
24051 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24052 (eval-after-load "speedbar"
24053 '(progn
24054 (speedbar-add-supported-extension ".org")
24055 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24056 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24057 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24058 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24059 (add-hook 'speedbar-visiting-tag-hook
24060 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24062 ;;; Fixes and Hacks for problems with other packages
24064 (defun org-mode-flyspell-verify ()
24065 "Function used for `flyspell-generic-check-word-predicate'."
24066 (if (org-at-heading-p)
24067 ;; At a headline or an inlinetask, check title only. This is
24068 ;; faster than relying on `org-element-at-point'.
24069 (and (save-excursion (beginning-of-line)
24070 (and (let ((case-fold-search t))
24071 (not (looking-at "\\*+ END[ \t]*$")))
24072 (looking-at org-complex-heading-regexp)))
24073 (match-beginning 4)
24074 (>= (point) (match-beginning 4))
24075 (or (not (match-beginning 5))
24076 (< (point) (match-beginning 5))))
24077 (let* ((element (org-element-at-point))
24078 (post-affiliated (org-element-property :post-affiliated element))
24079 (object-check
24080 (function
24081 ;; Non-nil if checks can be done for object at point.
24082 (lambda ()
24083 (let ((object (save-excursion
24084 (when (org-looking-at-p "\\>") (backward-char))
24085 (org-element-context element))))
24086 (case (org-element-type object)
24087 ;; Prevent checks in links due to keybinding conflict
24088 ;; with Flyspell.
24089 ((code entity export-snippet inline-babel-call
24090 inline-src-block line-break latex-fragment link macro
24091 statistics-cookie target timestamp verbatim)
24092 nil)
24093 (footnote-reference
24094 ;; Only in inline footnotes, within the definition.
24095 (and (eq (org-element-property :type object) 'inline)
24096 (< (save-excursion
24097 (goto-char (org-element-property :begin object))
24098 (search-forward ":" nil t 2))
24099 (point))))
24100 (otherwise t)))))))
24101 (cond
24102 ;; Ignore checks in all affiliated keywords but captions.
24103 ((and post-affiliated (< (point) post-affiliated))
24104 (and (save-excursion
24105 (beginning-of-line)
24106 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24107 (> (point) (match-end 0))
24108 (funcall object-check)))
24109 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24110 ((and org-log-into-drawer
24111 (let ((log (or (org-string-nw-p org-log-into-drawer) "LOGBOOK"))
24112 (parent element))
24113 (while (and parent (not (eq (org-element-type parent) 'drawer)))
24114 (setq parent (org-element-property :parent parent)))
24115 (and parent
24116 (eq (compare-strings
24117 log nil nil
24118 (org-element-property :drawer-name parent) nil nil t)
24119 t))))
24120 nil)
24122 (case (org-element-type element)
24123 ((comment quote-section) t)
24124 (comment-block
24125 ;; Allow checks between block markers, not on them.
24126 (and (> (line-beginning-position)
24127 (org-element-property :post-affiliated element))
24128 (save-excursion
24129 (end-of-line)
24130 (skip-chars-forward " \r\t\n")
24131 (< (point) (org-element-property :end element)))))
24132 ;; Arbitrary list of keywords where checks are meaningful.
24133 ;; Make sure point is on the value part of the element.
24134 (keyword
24135 (and (member (org-element-property :key element)
24136 '("DESCRIPTION" "TITLE"))
24137 (< (save-excursion
24138 (beginning-of-line) (search-forward ":") (point))
24139 (point))))
24140 ;; Check is globally allowed in paragraphs verse blocks and
24141 ;; table rows (after affiliated keywords) but some objects
24142 ;; must not be affected.
24143 ((paragraph table-row verse-block)
24144 (and (>= (point) (org-element-property :contents-begin element))
24145 (< (point) (org-element-property :contents-end element))
24146 (funcall object-check)))))))))
24147 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24149 (defun org-remove-flyspell-overlays-in (beg end)
24150 "Remove flyspell overlays in region."
24151 (and (org-bound-and-true-p flyspell-mode)
24152 (fboundp 'flyspell-delete-region-overlays)
24153 (flyspell-delete-region-overlays beg end)))
24155 (eval-after-load "flyspell"
24156 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24158 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24159 (eval-after-load "bookmark"
24160 '(if (boundp 'bookmark-after-jump-hook)
24161 ;; We can use the hook
24162 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24163 ;; Hook not available, use advice
24164 (defadvice bookmark-jump (after org-make-visible activate)
24165 "Make the position visible."
24166 (org-bookmark-jump-unhide))))
24168 ;; Make sure saveplace shows the location if it was hidden
24169 (eval-after-load "saveplace"
24170 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24171 "Make the position visible."
24172 (org-bookmark-jump-unhide)))
24174 ;; Make sure ecb shows the location if it was hidden
24175 (eval-after-load "ecb"
24176 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24177 "Make hierarchy visible when jumping into location from ECB tree buffer."
24178 (if (derived-mode-p 'org-mode)
24179 (org-show-context))))
24181 (defun org-bookmark-jump-unhide ()
24182 "Unhide the current position, to show the bookmark location."
24183 (and (derived-mode-p 'org-mode)
24184 (or (outline-invisible-p)
24185 (save-excursion (goto-char (max (point-min) (1- (point))))
24186 (outline-invisible-p)))
24187 (org-show-context 'bookmark-jump)))
24189 ;; Make session.el ignore our circular variable
24190 (defvar session-globals-exclude)
24191 (eval-after-load "session"
24192 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24194 ;;;; Finish up
24196 (provide 'org)
24198 (run-hooks 'org-load-hook)
24200 ;;; org.el ends here