Merge branch 'maint'
[org-mode.git] / lisp / org.el
bloba1f3b1b492ace6e1cb9e2c20cc5f52c45de361e7
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" shell)
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].")
433 ;;;; LaTeX Environments and Fragments
435 (defconst org-latex-regexps
436 '(("begin" "^[ \t]*\\(\\\\begin{\\([a-zA-Z0-9\\*]+\\)[^\000]+?\\\\end{\\2}\\)" 1 t)
437 ;; ("$" "\\([ (]\\|^\\)\\(\\(\\([$]\\)\\([^ \r\n,.$].*?\\(\n.*?\\)\\{0,5\\}[^ \r\n,.$]\\)\\4\\)\\)\\([ .,?;:'\")]\\|$\\)" 2 nil)
438 ;; \000 in the following regex is needed for org-inside-LaTeX-fragment-p
439 ("$1" "\\([^$]\\|^\\)\\(\\$[^ \r\n,;.$]\\$\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
440 ("$" "\\([^$]\\|^\\)\\(\\(\\$\\([^ \r\n,;.$][^$\n\r]*?\\(\n[^$\n\r]*?\\)\\{0,2\\}[^ \r\n,.$]\\)\\$\\)\\)\\([- .,?;:'\")\000]\\|$\\)" 2 nil)
441 ("\\(" "\\\\([^\000]*?\\\\)" 0 nil)
442 ("\\[" "\\\\\\[[^\000]*?\\\\\\]" 0 nil)
443 ("$$" "\\$\\$[^\000]*?\\$\\$" 0 nil))
444 "Regular expressions for matching embedded LaTeX.")
446 ;;;; Node Property
448 (defconst org-effort-property "Effort"
449 "The property that is being used to keep track of effort estimates.
450 Effort estimates given in this property need to have the format H:MM.")
452 ;;;; Table
454 (defconst org-table-any-line-regexp "^[ \t]*\\(|\\|\\+-[-+]\\)"
455 "Detect an org-type or table-type table.")
457 (defconst org-table-line-regexp "^[ \t]*|"
458 "Detect an org-type table line.")
460 (defconst org-table-dataline-regexp "^[ \t]*|[^-]"
461 "Detect an org-type table line.")
463 (defconst org-table-hline-regexp "^[ \t]*|-"
464 "Detect an org-type table hline.")
466 (defconst org-table1-hline-regexp "^[ \t]*\\+-[-+]"
467 "Detect a table-type table hline.")
469 (defconst org-table-any-border-regexp "^[ \t]*[^|+ \t]"
470 "Detect the first line outside a table when searching from within it.
471 This works for both table types.")
473 (defconst org-TBLFM-regexp "^[ \t]*#\\+TBLFM: "
474 "Detect a #+TBLFM line.")
476 ;;;; Timestamp
478 (defconst org-ts-regexp "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^\r\n>]*?\\)>"
479 "Regular expression for fast time stamp matching.")
481 (defconst org-ts-regexp-both "[[<]\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?\\)[]>]"
482 "Regular expression for fast time stamp matching.")
484 (defconst org-ts-regexp0
485 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\)\\( +[^]+0-9>\r\n -]+\\)?\\( +\\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
486 "Regular expression matching time strings for analysis.
487 This one does not require the space after the date, so it can be used
488 on a string that terminates immediately after the date.")
490 (defconst org-ts-regexp1 "\\(\\([0-9]\\{4\\}\\)-\\([0-9]\\{2\\}\\)-\\([0-9]\\{2\\}\\) *\\([^]+0-9>\r\n -]*\\)\\( \\([0-9]\\{1,2\\}\\):\\([0-9]\\{2\\}\\)\\)?\\)"
491 "Regular expression matching time strings for analysis.")
493 (defconst org-ts-regexp2 (concat "<" org-ts-regexp1 "[^>\n]\\{0,16\\}>")
494 "Regular expression matching time stamps, with groups.")
496 (defconst org-ts-regexp3 (concat "[[<]" org-ts-regexp1 "[^]>\n]\\{0,16\\}[]>]")
497 "Regular expression matching time stamps (also [..]), with groups.")
499 (defconst org-tr-regexp (concat org-ts-regexp "--?-?" org-ts-regexp)
500 "Regular expression matching a time stamp range.")
502 (defconst org-tr-regexp-both
503 (concat org-ts-regexp-both "--?-?" org-ts-regexp-both)
504 "Regular expression matching a time stamp range.")
506 (defconst org-tsr-regexp (concat org-ts-regexp "\\(--?-?"
507 org-ts-regexp "\\)?")
508 "Regular expression matching a time stamp or time stamp range.")
510 (defconst org-tsr-regexp-both
511 (concat org-ts-regexp-both "\\(--?-?"
512 org-ts-regexp-both "\\)?")
513 "Regular expression matching a time stamp or time stamp range.
514 The time stamps may be either active or inactive.")
516 (defconst org-repeat-re
517 "<[0-9]\\{4\\}-[0-9][0-9]-[0-9][0-9] [^>\n]*?\\([.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)"
518 "Regular expression for specifying repeated events.
519 After a match, group 1 contains the repeat expression.")
521 (defconst org-time-stamp-formats '("<%Y-%m-%d %a>" . "<%Y-%m-%d %a %H:%M>")
522 "Formats for `format-time-string' which are used for time stamps.")
525 ;;; The custom variables
527 (defgroup org nil
528 "Outline-based notes management and organizer."
529 :tag "Org"
530 :group 'outlines
531 :group 'calendar)
533 (defcustom org-mode-hook nil
534 "Mode hook for Org-mode, run after the mode was turned on."
535 :group 'org
536 :type 'hook)
538 (defcustom org-load-hook nil
539 "Hook that is run after org.el has been loaded."
540 :group 'org
541 :type 'hook)
543 (defcustom org-log-buffer-setup-hook nil
544 "Hook that is run after an Org log buffer is created."
545 :group 'org
546 :version "24.1"
547 :type 'hook)
549 (defvar org-modules) ; defined below
550 (defvar org-modules-loaded nil
551 "Have the modules been loaded already?")
553 (defun org-load-modules-maybe (&optional force)
554 "Load all extensions listed in `org-modules'."
555 (when (or force (not org-modules-loaded))
556 (mapc (lambda (ext)
557 (condition-case nil (require ext)
558 (error (message "Problems while trying to load feature `%s'" ext))))
559 org-modules)
560 (setq org-modules-loaded t)))
562 (defun org-set-modules (var value)
563 "Set VAR to VALUE and call `org-load-modules-maybe' with the force flag."
564 (set var value)
565 (when (featurep 'org)
566 (org-load-modules-maybe 'force)
567 (org-element-cache-reset 'all)))
569 (defcustom org-modules '(org-w3m org-bbdb org-bibtex org-docview org-gnus org-info org-irc org-mhe org-rmail)
570 "Modules that should always be loaded together with org.el.
572 If a description starts with <C>, the file is not part of Emacs
573 and loading it will require that you have downloaded and properly
574 installed the Org mode distribution.
576 You can also use this system to load external packages (i.e. neither Org
577 core modules, nor modules from the CONTRIB directory). Just add symbols
578 to the end of the list. If the package is called org-xyz.el, then you need
579 to add the symbol `xyz', and the package must have a call to:
581 \(provide 'org-xyz)
583 For export specific modules, see also `org-export-backends'."
584 :group 'org
585 :set 'org-set-modules
586 :version "24.4"
587 :package-version '(Org . "8.0")
588 :type
589 '(set :greedy t
590 (const :tag " bbdb: Links to BBDB entries" org-bbdb)
591 (const :tag " bibtex: Links to BibTeX entries" org-bibtex)
592 (const :tag " crypt: Encryption of subtrees" org-crypt)
593 (const :tag " ctags: Access to Emacs tags with links" org-ctags)
594 (const :tag " docview: Links to doc-view buffers" org-docview)
595 (const :tag " gnus: Links to GNUS folders/messages" org-gnus)
596 (const :tag " habit: Track your consistency with habits" org-habit)
597 (const :tag " id: Global IDs for identifying entries" org-id)
598 (const :tag " info: Links to Info nodes" org-info)
599 (const :tag " inlinetask: Tasks independent of outline hierarchy" org-inlinetask)
600 (const :tag " irc: Links to IRC/ERC chat sessions" org-irc)
601 (const :tag " mhe: Links to MHE folders/messages" org-mhe)
602 (const :tag " mouse: Additional mouse support" org-mouse)
603 (const :tag " protocol: Intercept calls from emacsclient" org-protocol)
604 (const :tag " rmail: Links to RMAIL folders/messages" org-rmail)
605 (const :tag " w3m: Special cut/paste from w3m to Org-mode." org-w3m)
607 (const :tag "C annotate-file: Annotate a file with org syntax" org-annotate-file)
608 (const :tag "C bookmark: Org-mode links to bookmarks" org-bookmark)
609 (const :tag "C bullets: Add overlays to headlines stars" org-bullets)
610 (const :tag "C checklist: Extra functions for checklists in repeated tasks" org-checklist)
611 (const :tag "C choose: Use TODO keywords to mark decisions states" org-choose)
612 (const :tag "C collector: Collect properties into tables" org-collector)
613 (const :tag "C depend: TODO dependencies for Org-mode\n\t\t\t(PARTIALLY OBSOLETE, see built-in dependency support))" org-depend)
614 (const :tag "C drill: Flashcards and spaced repetition for Org-mode" org-drill)
615 (const :tag "C elisp-symbol: Org-mode links to emacs-lisp symbols" org-elisp-symbol)
616 (const :tag "C eshell Support for links to working directories in eshell" org-eshell)
617 (const :tag "C eval-light: Evaluate inbuffer-code on demand" org-eval-light)
618 (const :tag "C eval: Include command output as text" org-eval)
619 (const :tag "C expiry: Expiry mechanism for Org-mode entries" org-expiry)
620 (const :tag "C favtable: Lookup table of favorite references and links" org-favtable)
621 (const :tag "C git-link: Provide org links to specific file version" org-git-link)
622 (const :tag "C interactive-query: Interactive modification of tags query\n\t\t\t(PARTIALLY OBSOLETE, see secondary filtering)" org-interactive-query)
623 (const :tag "C invoice: Help manage client invoices in Org-mode" org-invoice)
624 (const :tag "C jira: Add a jira:ticket protocol to Org-mode" org-jira)
625 (const :tag "C learn: SuperMemo's incremental learning algorithm" org-learn)
626 (const :tag "C mac-iCal Imports events from iCal.app to the Emacs diary" org-mac-iCal)
627 (const :tag "C mac-link: Grab links and url from various mac Applications" org-mac-link)
628 (const :tag "C mairix: Hook mairix search into Org-mode for different MUAs" org-mairix)
629 (const :tag "C man: Support for links to manpages in Org-mode" org-man)
630 (const :tag "C mew: Links to Mew folders/messages" org-mew)
631 (const :tag "C mtags: Support for muse-like tags" org-mtags)
632 (const :tag "C notmuch: Provide org links to notmuch searches or messages" org-notmuch)
633 (const :tag "C panel: Simple routines for us with bad memory" org-panel)
634 (const :tag "C registry: A registry for Org-mode links" org-registry)
635 (const :tag "C screen: Visit screen sessions through Org-mode links" org-screen)
636 (const :tag "C secretary: Team management with org-mode" org-secretary)
637 (const :tag "C sqlinsert: Convert Org-mode tables to SQL insertions" orgtbl-sqlinsert)
638 (const :tag "C toc: Table of contents for Org-mode buffer" org-toc)
639 (const :tag "C track: Keep up with Org-mode development" org-track)
640 (const :tag "C velocity Something like Notational Velocity for Org" org-velocity)
641 (const :tag "C vm: Links to VM folders/messages" org-vm)
642 (const :tag "C wikinodes: CamelCase wiki-like links" org-wikinodes)
643 (const :tag "C wl: Links to Wanderlust folders/messages" org-wl)
644 (repeat :tag "External packages" :inline t (symbol :tag "Package"))))
646 (defvar org-export--registered-backends) ; From ox.el.
647 (declare-function org-export-derived-backend-p "ox" (backend &rest backends))
648 (declare-function org-export-backend-name "ox" (backend))
649 (defcustom org-export-backends '(ascii html icalendar latex)
650 "List of export back-ends that should be always available.
652 If a description starts with <C>, the file is not part of Emacs
653 and loading it will require that you have downloaded and properly
654 installed the Org mode distribution.
656 Unlike to `org-modules', libraries in this list will not be
657 loaded along with Org, but only once the export framework is
658 needed.
660 This variable needs to be set before org.el is loaded. If you
661 need to make a change while Emacs is running, use the customize
662 interface or run the following code, where VAL stands for the new
663 value of the variable, after updating it:
665 \(progn
666 \(setq org-export--registered-backends
667 \(org-remove-if-not
668 \(lambda (backend)
669 \(let ((name (org-export-backend-name backend)))
670 \(or (memq name val)
671 \(catch 'parentp
672 \(dolist (b val)
673 \(and (org-export-derived-backend-p b name)
674 \(throw 'parentp t)))))))
675 org-export--registered-backends))
676 \(let ((new-list (mapcar 'org-export-backend-name
677 org-export--registered-backends)))
678 \(dolist (backend val)
679 \(cond
680 \((not (load (format \"ox-%s\" backend) t t))
681 \(message \"Problems while trying to load export back-end `%s'\"
682 backend))
683 \((not (memq backend new-list)) (push backend new-list))))
684 \(set-default 'org-export-backends new-list)))
686 Adding a back-end to this list will also pull the back-end it
687 depends on, if any."
688 :group 'org
689 :group 'org-export
690 :version "24.4"
691 :package-version '(Org . "8.0")
692 :initialize 'custom-initialize-set
693 :set (lambda (var val)
694 (if (not (featurep 'ox)) (set-default var val)
695 ;; Any back-end not required anymore (not present in VAL and not
696 ;; a parent of any back-end in the new value) is removed from the
697 ;; list of registered back-ends.
698 (setq org-export--registered-backends
699 (org-remove-if-not
700 (lambda (backend)
701 (let ((name (org-export-backend-name backend)))
702 (or (memq name val)
703 (catch 'parentp
704 (dolist (b val)
705 (and (org-export-derived-backend-p b name)
706 (throw 'parentp t)))))))
707 org-export--registered-backends))
708 ;; Now build NEW-LIST of both new back-ends and required
709 ;; parents.
710 (let ((new-list (mapcar 'org-export-backend-name
711 org-export--registered-backends)))
712 (dolist (backend val)
713 (cond
714 ((not (load (format "ox-%s" backend) t t))
715 (message "Problems while trying to load export back-end `%s'"
716 backend))
717 ((not (memq backend new-list)) (push backend new-list))))
718 ;; Set VAR to that list with fixed dependencies.
719 (set-default var new-list))))
720 :type '(set :greedy t
721 (const :tag " ascii Export buffer to ASCII format" ascii)
722 (const :tag " beamer Export buffer to Beamer presentation" beamer)
723 (const :tag " html Export buffer to HTML format" html)
724 (const :tag " icalendar Export buffer to iCalendar format" icalendar)
725 (const :tag " latex Export buffer to LaTeX format" latex)
726 (const :tag " man Export buffer to MAN format" man)
727 (const :tag " md Export buffer to Markdown format" md)
728 (const :tag " odt Export buffer to ODT format" odt)
729 (const :tag " org Export buffer to Org format" org)
730 (const :tag " texinfo Export buffer to Texinfo format" texinfo)
731 (const :tag "C confluence Export buffer to Confluence Wiki format" confluence)
732 (const :tag "C deck Export buffer to deck.js presentations" deck)
733 (const :tag "C freemind Export buffer to Freemind mindmap format" freemind)
734 (const :tag "C groff Export buffer to Groff format" groff)
735 (const :tag "C koma-letter Export buffer to KOMA Scrlttrl2 format" koma-letter)
736 (const :tag "C RSS 2.0 Export buffer to RSS 2.0 format" rss)
737 (const :tag "C s5 Export buffer to s5 presentations" s5)
738 (const :tag "C taskjuggler Export buffer to TaskJuggler format" taskjuggler)))
740 (eval-after-load 'ox
741 '(mapc
742 (lambda (backend)
743 (condition-case nil (require (intern (format "ox-%s" backend)))
744 (error (message "Problems while trying to load export back-end `%s'"
745 backend))))
746 org-export-backends))
748 (defcustom org-support-shift-select nil
749 "Non-nil means make shift-cursor commands select text when possible.
751 In Emacs 23, when `shift-select-mode' is on, shifted cursor keys
752 start selecting a region, or enlarge regions started in this way.
753 In Org-mode, in special contexts, these same keys are used for
754 other purposes, important enough to compete with shift selection.
755 Org tries to balance these needs by supporting `shift-select-mode'
756 outside these special contexts, under control of this variable.
758 The default of this variable is nil, to avoid confusing behavior. Shifted
759 cursor keys will then execute Org commands in the following contexts:
760 - on a headline, changing TODO state (left/right) and priority (up/down)
761 - on a time stamp, changing the time
762 - in a plain list item, changing the bullet type
763 - in a property definition line, switching between allowed values
764 - in the BEGIN line of a clock table (changing the time block).
765 Outside these contexts, the commands will throw an error.
767 When this variable is t and the cursor is not in a special
768 context, Org-mode will support shift-selection for making and
769 enlarging regions. To make this more effective, the bullet
770 cycling will no longer happen anywhere in an item line, but only
771 if the cursor is exactly on the bullet.
773 If you set this variable to the symbol `always', then the keys
774 will not be special in headlines, property lines, and item lines,
775 to make shift selection work there as well. If this is what you
776 want, you can use the following alternative commands: `C-c C-t'
777 and `C-c ,' to change TODO state and priority, `C-u C-u C-c C-t'
778 can be used to switch TODO sets, `C-c -' to cycle item bullet
779 types, and properties can be edited by hand or in column view.
781 However, when the cursor is on a timestamp, shift-cursor commands
782 will still edit the time stamp - this is just too good to give up.
784 XEmacs user should have this variable set to nil, because
785 `shift-select-mode' is in Emacs 23 or later only."
786 :group 'org
787 :type '(choice
788 (const :tag "Never" nil)
789 (const :tag "When outside special context" t)
790 (const :tag "Everywhere except timestamps" always)))
792 (defcustom org-loop-over-headlines-in-active-region nil
793 "Shall some commands act upon headlines in the active region?
795 When set to `t', some commands will be performed in all headlines
796 within the active region.
798 When set to `start-level', some commands will be performed in all
799 headlines within the active region, provided that these headlines
800 are of the same level than the first one.
802 When set to a string, those commands will be performed on the
803 matching headlines within the active region. Such string must be
804 a tags/property/todo match as it is used in the agenda tags view.
806 The list of commands is: `org-schedule', `org-deadline',
807 `org-todo', `org-archive-subtree', `org-archive-set-tag' and
808 `org-archive-to-archive-sibling'. The archiving commands skip
809 already archived entries."
810 :type '(choice (const :tag "Don't loop" nil)
811 (const :tag "All headlines in active region" t)
812 (const :tag "In active region, headlines at the same level than the first one" start-level)
813 (string :tag "Tags/Property/Todo matcher"))
814 :version "24.1"
815 :group 'org-todo
816 :group 'org-archive)
818 (defgroup org-startup nil
819 "Options concerning startup of Org-mode."
820 :tag "Org Startup"
821 :group 'org)
823 (defcustom org-startup-folded t
824 "Non-nil means entering Org-mode will switch to OVERVIEW.
825 This can also be configured on a per-file basis by adding one of
826 the following lines anywhere in the buffer:
828 #+STARTUP: fold (or `overview', this is equivalent)
829 #+STARTUP: nofold (or `showall', this is equivalent)
830 #+STARTUP: content
831 #+STARTUP: showeverything
833 By default, this option is ignored when Org opens agenda files
834 for the first time. If you want the agenda to honor the startup
835 option, set `org-agenda-inhibit-startup' to nil."
836 :group 'org-startup
837 :type '(choice
838 (const :tag "nofold: show all" nil)
839 (const :tag "fold: overview" t)
840 (const :tag "content: all headlines" content)
841 (const :tag "show everything, even drawers" showeverything)))
843 (defcustom org-startup-truncated t
844 "Non-nil means entering Org-mode will set `truncate-lines'.
845 This is useful since some lines containing links can be very long and
846 uninteresting. Also tables look terrible when wrapped."
847 :group 'org-startup
848 :type 'boolean)
850 (defcustom org-startup-indented nil
851 "Non-nil means turn on `org-indent-mode' on startup.
852 This can also be configured on a per-file basis by adding one of
853 the following lines anywhere in the buffer:
855 #+STARTUP: indent
856 #+STARTUP: noindent"
857 :group 'org-structure
858 :type '(choice
859 (const :tag "Not" nil)
860 (const :tag "Globally (slow on startup in large files)" t)))
862 (defcustom org-use-sub-superscripts t
863 "Non-nil means interpret \"_\" and \"^\" for display.
865 If you want to control how Org exports those characters, see
866 `org-export-with-sub-superscripts'. `org-use-sub-superscripts'
867 used to be an alias for `org-export-with-sub-superscripts' in
868 Org <8.0, it is not anymore.
870 When this option is turned on, you can use TeX-like syntax for
871 sub- and superscripts within the buffer. Several characters after
872 \"_\" or \"^\" will be considered as a single item - so grouping
873 with {} is normally not needed. For example, the following things
874 will be parsed as single sub- or superscripts:
876 10^24 or 10^tau several digits will be considered 1 item.
877 10^-12 or 10^-tau a leading sign with digits or a word
878 x^2-y^3 will be read as x^2 - y^3, because items are
879 terminated by almost any nonword/nondigit char.
880 x_{i^2} or x^(2-i) braces or parenthesis do grouping.
882 Still, ambiguity is possible. So when in doubt, use {} to enclose
883 the sub/superscript. If you set this variable to the symbol `{}',
884 the braces are *required* in order to trigger interpretations as
885 sub/superscript. This can be helpful in documents that need \"_\"
886 frequently in plain text."
887 :group 'org-startup
888 :version "24.4"
889 :package-version '(Org . "8.0")
890 :type '(choice
891 (const :tag "Always interpret" t)
892 (const :tag "Only with braces" {})
893 (const :tag "Never interpret" nil)))
895 (defcustom org-startup-with-beamer-mode nil
896 "Non-nil means turn on `org-beamer-mode' on startup.
897 This can also be configured on a per-file basis by adding one of
898 the following lines anywhere in the buffer:
900 #+STARTUP: beamer"
901 :group 'org-startup
902 :version "24.1"
903 :type 'boolean)
905 (defcustom org-startup-align-all-tables nil
906 "Non-nil means align all tables when visiting a file.
907 This is useful when the column width in tables is forced with <N> cookies
908 in table fields. Such tables will look correct only after the first re-align.
909 This can also be configured on a per-file basis by adding one of
910 the following lines anywhere in the buffer:
911 #+STARTUP: align
912 #+STARTUP: noalign"
913 :group 'org-startup
914 :type 'boolean)
916 (defcustom org-startup-with-inline-images nil
917 "Non-nil means show inline images when loading a new Org file.
918 This can also be configured on a per-file basis by adding one of
919 the following lines anywhere in the buffer:
920 #+STARTUP: inlineimages
921 #+STARTUP: noinlineimages"
922 :group 'org-startup
923 :version "24.1"
924 :type 'boolean)
926 (defcustom org-startup-with-latex-preview nil
927 "Non-nil means preview LaTeX fragments when loading a new Org file.
929 This can also be configured on a per-file basis by adding one of
930 the following lines anywhere in the buffer:
931 #+STARTUP: latexpreview
932 #+STARTUP: nolatexpreview"
933 :group 'org-startup
934 :version "24.4"
935 :package-version '(Org . "8.0")
936 :type 'boolean)
938 (defcustom org-insert-mode-line-in-empty-file nil
939 "Non-nil means insert the first line setting Org-mode in empty files.
940 When the function `org-mode' is called interactively in an empty file, this
941 normally means that the file name does not automatically trigger Org-mode.
942 To ensure that the file will always be in Org-mode in the future, a
943 line enforcing Org-mode will be inserted into the buffer, if this option
944 has been set."
945 :group 'org-startup
946 :type 'boolean)
948 (defcustom org-replace-disputed-keys nil
949 "Non-nil means use alternative key bindings for some keys.
950 Org-mode uses S-<cursor> keys for changing timestamps and priorities.
951 These keys are also used by other packages like shift-selection-mode'
952 \(built into Emacs 23), `CUA-mode' or `windmove.el'.
953 If you want to use Org-mode together with one of these other modes,
954 or more generally if you would like to move some Org-mode commands to
955 other keys, set this variable and configure the keys with the variable
956 `org-disputed-keys'.
958 This option is only relevant at load-time of Org-mode, and must be set
959 *before* org.el is loaded. Changing it requires a restart of Emacs to
960 become effective."
961 :group 'org-startup
962 :type 'boolean)
964 (defcustom org-use-extra-keys nil
965 "Non-nil means use extra key sequence definitions for certain commands.
966 This happens automatically if you run XEmacs or if `window-system'
967 is nil. This variable lets you do the same manually. You must
968 set it before loading org.
970 Example: on Carbon Emacs 22 running graphically, with an external
971 keyboard on a Powerbook, the default way of setting M-left might
972 not work for either Alt or ESC. Setting this variable will make
973 it work for ESC."
974 :group 'org-startup
975 :type 'boolean)
977 (org-defvaralias 'org-CUA-compatible 'org-replace-disputed-keys)
979 (defcustom org-disputed-keys
980 '(([(shift up)] . [(meta p)])
981 ([(shift down)] . [(meta n)])
982 ([(shift left)] . [(meta -)])
983 ([(shift right)] . [(meta +)])
984 ([(control shift right)] . [(meta shift +)])
985 ([(control shift left)] . [(meta shift -)]))
986 "Keys for which Org-mode and other modes compete.
987 This is an alist, cars are the default keys, second element specifies
988 the alternative to use when `org-replace-disputed-keys' is t.
990 Keys can be specified in any syntax supported by `define-key'.
991 The value of this option takes effect only at Org-mode's startup,
992 therefore you'll have to restart Emacs to apply it after changing."
993 :group 'org-startup
994 :type 'alist)
996 (defun org-key (key)
997 "Select key according to `org-replace-disputed-keys' and `org-disputed-keys'.
998 Or return the original if not disputed.
999 Also apply the translations defined in `org-xemacs-key-equivalents'."
1000 (when org-replace-disputed-keys
1001 (let* ((nkey (key-description key))
1002 (x (org-find-if (lambda (x)
1003 (equal (key-description (car x)) nkey))
1004 org-disputed-keys)))
1005 (setq key (if x (cdr x) key))))
1006 (when (featurep 'xemacs)
1007 (setq key (or (cdr (assoc key org-xemacs-key-equivalents)) key)))
1008 key)
1010 (defun org-find-if (predicate seq)
1011 (catch 'exit
1012 (while seq
1013 (if (funcall predicate (car seq))
1014 (throw 'exit (car seq))
1015 (pop seq)))))
1017 (defun org-defkey (keymap key def)
1018 "Define a key, possibly translated, as returned by `org-key'."
1019 (define-key keymap (org-key key) def))
1021 (defcustom org-ellipsis nil
1022 "The ellipsis to use in the Org-mode outline.
1023 When nil, just use the standard three dots.
1024 When a string, use that string instead.
1025 When a face, use the standard 3 dots, but with the specified face.
1026 The change affects only Org-mode (which will then use its own display table).
1027 Changing this requires executing `M-x org-mode RET' in a buffer to become
1028 effective."
1029 :group 'org-startup
1030 :type '(choice (const :tag "Default" nil)
1031 (face :tag "Face" :value org-warning)
1032 (string :tag "String" :value "...#")))
1034 (defvar org-display-table nil
1035 "The display table for org-mode, in case `org-ellipsis' is non-nil.")
1037 (defgroup org-keywords nil
1038 "Keywords in Org-mode."
1039 :tag "Org Keywords"
1040 :group 'org)
1042 (defcustom org-closed-keep-when-no-todo nil
1043 "Remove CLOSED: time-stamp when switching back to a non-todo state?"
1044 :group 'org-todo
1045 :group 'org-keywords
1046 :version "24.4"
1047 :package-version '(Org . "8.0")
1048 :type 'boolean)
1050 (defgroup org-structure nil
1051 "Options concerning the general structure of Org-mode files."
1052 :tag "Org Structure"
1053 :group 'org)
1055 (defgroup org-reveal-location nil
1056 "Options about how to make context of a location visible."
1057 :tag "Org Reveal Location"
1058 :group 'org-structure)
1060 (defconst org-context-choice
1061 '(choice
1062 (const :tag "Always" t)
1063 (const :tag "Never" nil)
1064 (repeat :greedy t :tag "Individual contexts"
1065 (cons
1066 (choice :tag "Context"
1067 (const agenda)
1068 (const org-goto)
1069 (const occur-tree)
1070 (const tags-tree)
1071 (const link-search)
1072 (const mark-goto)
1073 (const bookmark-jump)
1074 (const isearch)
1075 (const default))
1076 (boolean))))
1077 "Contexts for the reveal options.")
1079 (defcustom org-show-hierarchy-above '((default . t))
1080 "Non-nil means show full hierarchy when revealing a location.
1081 Org-mode often shows locations in an org-mode file which might have
1082 been invisible before. When this is set, the hierarchy of headings
1083 above the exposed location is shown.
1084 Turning this off for example for sparse trees makes them very compact.
1085 Instead of t, this can also be an alist specifying this option for different
1086 contexts. Valid contexts are
1087 agenda when exposing an entry from the agenda
1088 org-goto when using the command `org-goto' on key C-c C-j
1089 occur-tree when using the command `org-occur' on key C-c /
1090 tags-tree when constructing a sparse tree based on tags matches
1091 link-search when exposing search matches associated with a link
1092 mark-goto when exposing the jump goal of a mark
1093 bookmark-jump when exposing a bookmark location
1094 isearch when exiting from an incremental search
1095 default default for all contexts not set explicitly"
1096 :group 'org-reveal-location
1097 :type org-context-choice)
1099 (defcustom org-show-following-heading '((default . nil))
1100 "Non-nil means show following heading when revealing a location.
1101 Org-mode often shows locations in an org-mode file which might have
1102 been invisible before. When this is set, the heading following the
1103 match is shown.
1104 Turning this off for example for sparse trees makes them very compact,
1105 but makes it harder to edit the location of the match. In such a case,
1106 use the command \\[org-reveal] to show more context.
1107 Instead of t, this can also be an alist specifying this option for different
1108 contexts. See `org-show-hierarchy-above' for valid contexts."
1109 :group 'org-reveal-location
1110 :type org-context-choice)
1112 (defcustom org-show-siblings '((default . nil) (isearch t) (bookmark-jump t))
1113 "Non-nil means show all sibling heading when revealing a location.
1114 Org-mode often shows locations in an org-mode file which might have
1115 been invisible before. When this is set, the sibling of the current entry
1116 heading are all made visible. If `org-show-hierarchy-above' is t,
1117 the same happens on each level of the hierarchy above the current entry.
1119 By default this is on for the isearch context, off for all other contexts.
1120 Turning this off for example for sparse trees makes them very compact,
1121 but makes it harder to edit the location of the match. In such a case,
1122 use the command \\[org-reveal] to show more context.
1123 Instead of t, this can also be an alist specifying this option for different
1124 contexts. See `org-show-hierarchy-above' for valid contexts."
1125 :group 'org-reveal-location
1126 :type org-context-choice
1127 :version "24.4"
1128 :package-version '(Org . "8.0"))
1130 (defcustom org-show-entry-below '((default . nil))
1131 "Non-nil means show the entry below a headline when revealing a location.
1132 Org-mode often shows locations in an org-mode file which might have
1133 been invisible before. When this is set, the text below the headline that is
1134 exposed is also shown.
1136 By default this is off for all contexts.
1137 Instead of t, this can also be an alist specifying this option for different
1138 contexts. See `org-show-hierarchy-above' for valid contexts."
1139 :group 'org-reveal-location
1140 :type org-context-choice)
1142 (defcustom org-indirect-buffer-display 'other-window
1143 "How should indirect tree buffers be displayed?
1144 This applies to indirect buffers created with the commands
1145 \\[org-tree-to-indirect-buffer] and \\[org-agenda-tree-to-indirect-buffer].
1146 Valid values are:
1147 current-window Display in the current window
1148 other-window Just display in another window.
1149 dedicated-frame Create one new frame, and re-use it each time.
1150 new-frame Make a new frame each time. Note that in this case
1151 previously-made indirect buffers are kept, and you need to
1152 kill these buffers yourself."
1153 :group 'org-structure
1154 :group 'org-agenda-windows
1155 :type '(choice
1156 (const :tag "In current window" current-window)
1157 (const :tag "In current frame, other window" other-window)
1158 (const :tag "Each time a new frame" new-frame)
1159 (const :tag "One dedicated frame" dedicated-frame)))
1161 (defcustom org-use-speed-commands nil
1162 "Non-nil means activate single letter commands at beginning of a headline.
1163 This may also be a function to test for appropriate locations where speed
1164 commands should be active.
1166 For example, to activate speed commands when the point is on any
1167 star at the beginning of the headline, you can do this:
1169 (setq org-use-speed-commands
1170 (lambda () (and (looking-at org-outline-regexp) (looking-back \"^\\**\"))))"
1171 :group 'org-structure
1172 :type '(choice
1173 (const :tag "Never" nil)
1174 (const :tag "At beginning of headline stars" t)
1175 (function)))
1177 (defcustom org-speed-commands-user nil
1178 "Alist of additional speed commands.
1179 This list will be checked before `org-speed-commands-default'
1180 when the variable `org-use-speed-commands' is non-nil
1181 and when the cursor is at the beginning of a headline.
1182 The car if each entry is a string with a single letter, which must
1183 be assigned to `self-insert-command' in the global map.
1184 The cdr is either a command to be called interactively, a function
1185 to be called, or a form to be evaluated.
1186 An entry that is just a list with a single string will be interpreted
1187 as a descriptive headline that will be added when listing the speed
1188 commands in the Help buffer using the `?' speed command."
1189 :group 'org-structure
1190 :type '(repeat :value ("k" . ignore)
1191 (choice :value ("k" . ignore)
1192 (list :tag "Descriptive Headline" (string :tag "Headline"))
1193 (cons :tag "Letter and Command"
1194 (string :tag "Command letter")
1195 (choice
1196 (function)
1197 (sexp))))))
1199 (defcustom org-bookmark-names-plist
1200 '(:last-capture "org-capture-last-stored"
1201 :last-refile "org-refile-last-stored"
1202 :last-capture-marker "org-capture-last-stored-marker")
1203 "Names for bookmarks automatically set by some Org commands.
1204 This can provide strings as names for a number of bookmarks Org sets
1205 automatically. The following keys are currently implemented:
1206 :last-capture
1207 :last-capture-marker
1208 :last-refile
1209 When a key does not show up in the property list, the corresponding bookmark
1210 is not set."
1211 :group 'org-structure
1212 :type 'plist)
1214 (defgroup org-cycle nil
1215 "Options concerning visibility cycling in Org-mode."
1216 :tag "Org Cycle"
1217 :group 'org-structure)
1219 (defcustom org-cycle-skip-children-state-if-no-children t
1220 "Non-nil means skip CHILDREN state in entries that don't have any."
1221 :group 'org-cycle
1222 :type 'boolean)
1224 (defcustom org-cycle-max-level nil
1225 "Maximum level which should still be subject to visibility cycling.
1226 Levels higher than this will, for cycling, be treated as text, not a headline.
1227 When `org-odd-levels-only' is set, a value of N in this variable actually
1228 means 2N-1 stars as the limiting headline.
1229 When nil, cycle all levels.
1230 Note that the limiting level of cycling is also influenced by
1231 `org-inlinetask-min-level'. When `org-cycle-max-level' is not set but
1232 `org-inlinetask-min-level' is, cycling will be limited to levels one less
1233 than its value."
1234 :group 'org-cycle
1235 :type '(choice
1236 (const :tag "No limit" nil)
1237 (integer :tag "Maximum level")))
1239 (defcustom org-hide-block-startup nil
1240 "Non-nil means entering Org-mode will fold all blocks.
1241 This can also be set in on a per-file basis with
1243 #+STARTUP: hideblocks
1244 #+STARTUP: showblocks"
1245 :group 'org-startup
1246 :group 'org-cycle
1247 :type 'boolean)
1249 (defcustom org-cycle-global-at-bob nil
1250 "Cycle globally if cursor is at beginning of buffer and not at a headline.
1251 This makes it possible to do global cycling without having to use S-TAB or
1252 \\[universal-argument] TAB. For this special case to work, the first line
1253 of the buffer must not be a headline -- it may be empty or some other text.
1254 When used in this way, `org-cycle-hook' is disabled temporarily to make
1255 sure the cursor stays at the beginning of the buffer. When this option is
1256 nil, don't do anything special at the beginning of the buffer."
1257 :group 'org-cycle
1258 :type 'boolean)
1260 (defcustom org-cycle-level-after-item/entry-creation t
1261 "Non-nil means cycle entry level or item indentation in new empty entries.
1263 When the cursor is at the end of an empty headline, i.e., with only stars
1264 and maybe a TODO keyword, TAB will then switch the entry to become a child,
1265 and then all possible ancestor states, before returning to the original state.
1266 This makes data entry extremely fast: M-RET to create a new headline,
1267 on TAB to make it a child, two or more tabs to make it a (grand-)uncle.
1269 When the cursor is at the end of an empty plain list item, one TAB will
1270 make it a subitem, two or more tabs will back up to make this an item
1271 higher up in the item hierarchy."
1272 :group 'org-cycle
1273 :type 'boolean)
1275 (defcustom org-cycle-emulate-tab t
1276 "Where should `org-cycle' emulate TAB.
1277 nil Never
1278 white Only in completely white lines
1279 whitestart Only at the beginning of lines, before the first non-white char
1280 t Everywhere except in headlines
1281 exc-hl-bol Everywhere except at the start of a headline
1282 If TAB is used in a place where it does not emulate TAB, the current subtree
1283 visibility is cycled."
1284 :group 'org-cycle
1285 :type '(choice (const :tag "Never" nil)
1286 (const :tag "Only in completely white lines" white)
1287 (const :tag "Before first char in a line" whitestart)
1288 (const :tag "Everywhere except in headlines" t)
1289 (const :tag "Everywhere except at bol in headlines" exc-hl-bol)))
1291 (defcustom org-cycle-separator-lines 2
1292 "Number of empty lines needed to keep an empty line between collapsed trees.
1293 If you leave an empty line between the end of a subtree and the following
1294 headline, this empty line is hidden when the subtree is folded.
1295 Org-mode will leave (exactly) one empty line visible if the number of
1296 empty lines is equal or larger to the number given in this variable.
1297 So the default 2 means at least 2 empty lines after the end of a subtree
1298 are needed to produce free space between a collapsed subtree and the
1299 following headline.
1301 If the number is negative, and the number of empty lines is at least -N,
1302 all empty lines are shown.
1304 Special case: when 0, never leave empty lines in collapsed view."
1305 :group 'org-cycle
1306 :type 'integer)
1307 (put 'org-cycle-separator-lines 'safe-local-variable 'integerp)
1309 (defcustom org-pre-cycle-hook nil
1310 "Hook that is run before visibility cycling is happening.
1311 The function(s) in this hook must accept a single argument which indicates
1312 the new state that will be set right after running this hook. The
1313 argument is a symbol. Before a global state change, it can have the values
1314 `overview', `content', or `all'. Before a local state change, it can have
1315 the values `folded', `children', or `subtree'."
1316 :group 'org-cycle
1317 :type 'hook)
1319 (defcustom org-cycle-hook '(org-cycle-hide-archived-subtrees
1320 org-cycle-hide-drawers
1321 org-cycle-hide-inline-tasks
1322 org-cycle-show-empty-lines
1323 org-optimize-window-after-visibility-change)
1324 "Hook that is run after `org-cycle' has changed the buffer visibility.
1325 The function(s) in this hook must accept a single argument which indicates
1326 the new state that was set by the most recent `org-cycle' command. The
1327 argument is a symbol. After a global state change, it can have the values
1328 `overview', `contents', or `all'. After a local state change, it can have
1329 the values `folded', `children', or `subtree'."
1330 :group 'org-cycle
1331 :type 'hook)
1333 (defgroup org-edit-structure nil
1334 "Options concerning structure editing in Org-mode."
1335 :tag "Org Edit Structure"
1336 :group 'org-structure)
1338 (defcustom org-odd-levels-only nil
1339 "Non-nil means skip even levels and only use odd levels for the outline.
1340 This has the effect that two stars are being added/taken away in
1341 promotion/demotion commands. It also influences how levels are
1342 handled by the exporters.
1343 Changing it requires restart of `font-lock-mode' to become effective
1344 for fontification also in regions already fontified.
1345 You may also set this on a per-file basis by adding one of the following
1346 lines to the buffer:
1348 #+STARTUP: odd
1349 #+STARTUP: oddeven"
1350 :group 'org-edit-structure
1351 :group 'org-appearance
1352 :type 'boolean)
1354 (defcustom org-adapt-indentation t
1355 "Non-nil means adapt indentation to outline node level.
1357 When this variable is set, Org assumes that you write outlines by
1358 indenting text in each node to align with the headline (after the stars).
1359 The following issues are influenced by this variable:
1361 - When this is set and the *entire* text in an entry is indented, the
1362 indentation is increased by one space in a demotion command, and
1363 decreased by one in a promotion command. If any line in the entry
1364 body starts with text at column 0, indentation is not changed at all.
1366 - Property drawers and planning information is inserted indented when
1367 this variable s set. When nil, they will not be indented.
1369 - TAB indents a line relative to context. The lines below a headline
1370 will be indented when this variable is set.
1372 Note that this is all about true indentation, by adding and removing
1373 space characters. See also `org-indent.el' which does level-dependent
1374 indentation in a virtual way, i.e. at display time in Emacs."
1375 :group 'org-edit-structure
1376 :type 'boolean)
1378 (defcustom org-special-ctrl-a/e nil
1379 "Non-nil means `C-a' and `C-e' behave specially in headlines and items.
1381 When t, `C-a' will bring back the cursor to the beginning of the
1382 headline text, i.e. after the stars and after a possible TODO
1383 keyword. In an item, this will be the position after bullet and
1384 check-box, if any. When the cursor is already at that position,
1385 another `C-a' will bring it to the beginning of the line.
1387 `C-e' will jump to the end of the headline, ignoring the presence
1388 of tags in the headline. A second `C-e' will then jump to the
1389 true end of the line, after any tags. This also means that, when
1390 this variable is non-nil, `C-e' also will never jump beyond the
1391 end of the heading of a folded section, i.e. not after the
1392 ellipses.
1394 When set to the symbol `reversed', the first `C-a' or `C-e' works
1395 normally, going to the true line boundary first. Only a directly
1396 following, identical keypress will bring the cursor to the
1397 special positions.
1399 This may also be a cons cell where the behavior for `C-a' and
1400 `C-e' is set separately."
1401 :group 'org-edit-structure
1402 :type '(choice
1403 (const :tag "off" nil)
1404 (const :tag "on: after stars/bullet and before tags first" t)
1405 (const :tag "reversed: true line boundary first" reversed)
1406 (cons :tag "Set C-a and C-e separately"
1407 (choice :tag "Special C-a"
1408 (const :tag "off" nil)
1409 (const :tag "on: after stars/bullet first" t)
1410 (const :tag "reversed: before stars/bullet first" reversed))
1411 (choice :tag "Special C-e"
1412 (const :tag "off" nil)
1413 (const :tag "on: before tags first" t)
1414 (const :tag "reversed: after tags first" reversed)))))
1415 (org-defvaralias 'org-special-ctrl-a 'org-special-ctrl-a/e)
1417 (defcustom org-special-ctrl-k nil
1418 "Non-nil means `C-k' will behave specially in headlines.
1419 When nil, `C-k' will call the default `kill-line' command.
1420 When t, the following will happen while the cursor is in the headline:
1422 - When the cursor is at the beginning of a headline, kill the entire
1423 line and possible the folded subtree below the line.
1424 - When in the middle of the headline text, kill the headline up to the tags.
1425 - When after the headline text, kill the tags."
1426 :group 'org-edit-structure
1427 :type 'boolean)
1429 (defcustom org-ctrl-k-protect-subtree nil
1430 "Non-nil means, do not delete a hidden subtree with C-k.
1431 When set to the symbol `error', simply throw an error when C-k is
1432 used to kill (part-of) a headline that has hidden text behind it.
1433 Any other non-nil value will result in a query to the user, if it is
1434 OK to kill that hidden subtree. When nil, kill without remorse."
1435 :group 'org-edit-structure
1436 :version "24.1"
1437 :type '(choice
1438 (const :tag "Do not protect hidden subtrees" nil)
1439 (const :tag "Protect hidden subtrees with a security query" t)
1440 (const :tag "Never kill a hidden subtree with C-k" error)))
1442 (defcustom org-special-ctrl-o t
1443 "Non-nil means, make `C-o' insert a row in tables."
1444 :group 'org-edit-structure
1445 :type 'boolean)
1447 (defcustom org-catch-invisible-edits nil
1448 "Check if in invisible region before inserting or deleting a character.
1449 Valid values are:
1451 nil Do not check, so just do invisible edits.
1452 error Throw an error and do nothing.
1453 show Make point visible, and do the requested edit.
1454 show-and-error Make point visible, then throw an error and abort the edit.
1455 smart Make point visible, and do insertion/deletion if it is
1456 adjacent to visible text and the change feels predictable.
1457 Never delete a previously invisible character or add in the
1458 middle or right after an invisible region. Basically, this
1459 allows insertion and backward-delete right before ellipses.
1460 FIXME: maybe in this case we should not even show?"
1461 :group 'org-edit-structure
1462 :version "24.1"
1463 :type '(choice
1464 (const :tag "Do not check" nil)
1465 (const :tag "Throw error when trying to edit" error)
1466 (const :tag "Unhide, but do not do the edit" show-and-error)
1467 (const :tag "Show invisible part and do the edit" show)
1468 (const :tag "Be smart and do the right thing" smart)))
1470 (defcustom org-yank-folded-subtrees t
1471 "Non-nil means when yanking subtrees, fold them.
1472 If the kill is a single subtree, or a sequence of subtrees, i.e. if
1473 it starts with a heading and all other headings in it are either children
1474 or siblings, then fold all the subtrees. However, do this only if no
1475 text after the yank would be swallowed into a folded tree by this action."
1476 :group 'org-edit-structure
1477 :type 'boolean)
1479 (defcustom org-yank-adjusted-subtrees nil
1480 "Non-nil means when yanking subtrees, adjust the level.
1481 With this setting, `org-paste-subtree' is used to insert the subtree, see
1482 this function for details."
1483 :group 'org-edit-structure
1484 :type 'boolean)
1486 (defcustom org-M-RET-may-split-line '((default . t))
1487 "Non-nil means M-RET will split the line at the cursor position.
1488 When nil, it will go to the end of the line before making a
1489 new line.
1490 You may also set this option in a different way for different
1491 contexts. Valid contexts are:
1493 headline when creating a new headline
1494 item when creating a new item
1495 table in a table field
1496 default the value to be used for all contexts not explicitly
1497 customized"
1498 :group 'org-structure
1499 :group 'org-table
1500 :type '(choice
1501 (const :tag "Always" t)
1502 (const :tag "Never" nil)
1503 (repeat :greedy t :tag "Individual contexts"
1504 (cons
1505 (choice :tag "Context"
1506 (const headline)
1507 (const item)
1508 (const table)
1509 (const default))
1510 (boolean)))))
1513 (defcustom org-insert-heading-respect-content nil
1514 "Non-nil means insert new headings after the current subtree.
1515 When nil, the new heading is created directly after the current line.
1516 The commands \\[org-insert-heading-respect-content] and \\[org-insert-todo-heading-respect-content] turn
1517 this variable on for the duration of the command."
1518 :group 'org-structure
1519 :type 'boolean)
1521 (defcustom org-blank-before-new-entry '((heading . auto)
1522 (plain-list-item . auto))
1523 "Should `org-insert-heading' leave a blank line before new heading/item?
1524 The value is an alist, with `heading' and `plain-list-item' as CAR,
1525 and a boolean flag as CDR. The cdr may also be the symbol `auto', in
1526 which case Org will look at the surrounding headings/items and try to
1527 make an intelligent decision whether to insert a blank line or not.
1529 For plain lists, if `org-list-empty-line-terminates-plain-lists' is set,
1530 the setting here is ignored and no empty line is inserted to avoid breaking
1531 the list structure."
1532 :group 'org-edit-structure
1533 :type '(list
1534 (cons (const heading)
1535 (choice (const :tag "Never" nil)
1536 (const :tag "Always" t)
1537 (const :tag "Auto" auto)))
1538 (cons (const plain-list-item)
1539 (choice (const :tag "Never" nil)
1540 (const :tag "Always" t)
1541 (const :tag "Auto" auto)))))
1543 (defcustom org-insert-heading-hook nil
1544 "Hook being run after inserting a new heading."
1545 :group 'org-edit-structure
1546 :type 'hook)
1548 (defcustom org-enable-fixed-width-editor t
1549 "Non-nil means lines starting with \":\" are treated as fixed-width.
1550 This currently only means they are never auto-wrapped.
1551 When nil, such lines will be treated like ordinary lines."
1552 :group 'org-edit-structure
1553 :type 'boolean)
1555 (defcustom org-goto-auto-isearch t
1556 "Non-nil means typing characters in `org-goto' starts incremental search.
1557 When nil, you can use these keybindings to navigate the buffer:
1559 q Quit the org-goto interface
1560 n Go to the next visible heading
1561 p Go to the previous visible heading
1562 f Go one heading forward on same level
1563 b Go one heading backward on same level
1564 u Go one heading up"
1565 :group 'org-edit-structure
1566 :type 'boolean)
1568 (defgroup org-sparse-trees nil
1569 "Options concerning sparse trees in Org-mode."
1570 :tag "Org Sparse Trees"
1571 :group 'org-structure)
1573 (defcustom org-highlight-sparse-tree-matches t
1574 "Non-nil means highlight all matches that define a sparse tree.
1575 The highlights will automatically disappear the next time the buffer is
1576 changed by an edit command."
1577 :group 'org-sparse-trees
1578 :type 'boolean)
1580 (defcustom org-remove-highlights-with-change t
1581 "Non-nil means any change to the buffer will remove temporary highlights.
1582 Such highlights are created by `org-occur' and `org-clock-display'.
1583 When nil, `C-c C-c needs to be used to get rid of the highlights.
1584 The highlights created by `org-preview-latex-fragment' always need
1585 `C-c C-c' to be removed."
1586 :group 'org-sparse-trees
1587 :group 'org-time
1588 :type 'boolean)
1591 (defcustom org-occur-hook '(org-first-headline-recenter)
1592 "Hook that is run after `org-occur' has constructed a sparse tree.
1593 This can be used to recenter the window to show as much of the structure
1594 as possible."
1595 :group 'org-sparse-trees
1596 :type 'hook)
1598 (defgroup org-imenu-and-speedbar nil
1599 "Options concerning imenu and speedbar in Org-mode."
1600 :tag "Org Imenu and Speedbar"
1601 :group 'org-structure)
1603 (defcustom org-imenu-depth 2
1604 "The maximum level for Imenu access to Org-mode headlines.
1605 This also applied for speedbar access."
1606 :group 'org-imenu-and-speedbar
1607 :type 'integer)
1609 (defgroup org-table nil
1610 "Options concerning tables in Org-mode."
1611 :tag "Org Table"
1612 :group 'org)
1614 (defcustom org-enable-table-editor 'optimized
1615 "Non-nil means lines starting with \"|\" are handled by the table editor.
1616 When nil, such lines will be treated like ordinary lines.
1618 When equal to the symbol `optimized', the table editor will be optimized to
1619 do the following:
1620 - Automatic overwrite mode in front of whitespace in table fields.
1621 This makes the structure of the table stay in tact as long as the edited
1622 field does not exceed the column width.
1623 - Minimize the number of realigns. Normally, the table is aligned each time
1624 TAB or RET are pressed to move to another field. With optimization this
1625 happens only if changes to a field might have changed the column width.
1626 Optimization requires replacing the functions `self-insert-command',
1627 `delete-char', and `backward-delete-char' in Org-mode buffers, with a
1628 slight (in fact: unnoticeable) speed impact for normal typing. Org-mode is
1629 very good at guessing when a re-align will be necessary, but you can always
1630 force one with \\[org-ctrl-c-ctrl-c].
1632 If you would like to use the optimized version in Org-mode, but the
1633 un-optimized version in OrgTbl-mode, see the variable `orgtbl-optimized'.
1635 This variable can be used to turn on and off the table editor during a session,
1636 but in order to toggle optimization, a restart is required.
1638 See also the variable `org-table-auto-blank-field'."
1639 :group 'org-table
1640 :type '(choice
1641 (const :tag "off" nil)
1642 (const :tag "on" t)
1643 (const :tag "on, optimized" optimized)))
1645 (defcustom org-self-insert-cluster-for-undo (or (featurep 'xemacs)
1646 (version<= emacs-version "24.1"))
1647 "Non-nil means cluster self-insert commands for undo when possible.
1648 If this is set, then, like in the Emacs command loop, 20 consecutive
1649 characters will be undone together.
1650 This is configurable, because there is some impact on typing performance."
1651 :group 'org-table
1652 :type 'boolean)
1654 (defcustom org-table-tab-recognizes-table.el t
1655 "Non-nil means TAB will automatically notice a table.el table.
1656 When it sees such a table, it moves point into it and - if necessary -
1657 calls `table-recognize-table'."
1658 :group 'org-table-editing
1659 :type 'boolean)
1661 (defgroup org-link nil
1662 "Options concerning links in Org-mode."
1663 :tag "Org Link"
1664 :group 'org)
1666 (defvar org-link-abbrev-alist-local nil
1667 "Buffer-local version of `org-link-abbrev-alist', which see.
1668 The value of this is taken from the #+LINK lines.")
1669 (make-variable-buffer-local 'org-link-abbrev-alist-local)
1671 (defcustom org-link-abbrev-alist nil
1672 "Alist of link abbreviations.
1673 The car of each element is a string, to be replaced at the start of a link.
1674 The cdrs are replacement values, like (\"linkkey\" . REPLACE). Abbreviated
1675 links in Org-mode buffers can have an optional tag after a double colon, e.g.
1677 [[linkkey:tag][description]]
1679 The 'linkkey' must be a word word, starting with a letter, followed
1680 by letters, numbers, '-' or '_'.
1682 If REPLACE is a string, the tag will simply be appended to create the link.
1683 If the string contains \"%s\", the tag will be inserted there. If the string
1684 contains \"%h\", it will cause a url-encoded version of the tag to be inserted
1685 at that point (see the function `url-hexify-string'). If the string contains
1686 the specifier \"%(my-function)\", then the custom function `my-function' will
1687 be invoked: this function takes the tag as its only argument and must return
1688 a string.
1690 REPLACE may also be a function that will be called with the tag as the
1691 only argument to create the link, which should be returned as a string.
1693 See the manual for examples."
1694 :group 'org-link
1695 :type '(repeat
1696 (cons
1697 (string :tag "Protocol")
1698 (choice
1699 (string :tag "Format")
1700 (function)))))
1702 (defcustom org-descriptive-links t
1703 "Non-nil means Org will display descriptive links.
1704 E.g. [[http://orgmode.org][Org website]] will be displayed as
1705 \"Org Website\", hiding the link itself and just displaying its
1706 description. When set to `nil', Org will display the full links
1707 literally.
1709 You can interactively set the value of this variable by calling
1710 `org-toggle-link-display' or from the menu Org>Hyperlinks menu."
1711 :group 'org-link
1712 :type 'boolean)
1714 (defcustom org-link-file-path-type 'adaptive
1715 "How the path name in file links should be stored.
1716 Valid values are:
1718 relative Relative to the current directory, i.e. the directory of the file
1719 into which the link is being inserted.
1720 absolute Absolute path, if possible with ~ for home directory.
1721 noabbrev Absolute path, no abbreviation of home directory.
1722 adaptive Use relative path for files in the current directory and sub-
1723 directories of it. For other files, use an absolute path."
1724 :group 'org-link
1725 :type '(choice
1726 (const relative)
1727 (const absolute)
1728 (const noabbrev)
1729 (const adaptive)))
1731 (defcustom org-activate-links '(bracket angle plain radio tag date footnote)
1732 "Types of links that should be activated in Org-mode files.
1733 This is a list of symbols, each leading to the activation of a certain link
1734 type. In principle, it does not hurt to turn on most link types - there may
1735 be a small gain when turning off unused link types. The types are:
1737 bracket The recommended [[link][description]] or [[link]] links with hiding.
1738 angle Links in angular brackets that may contain whitespace like
1739 <bbdb:Carsten Dominik>.
1740 plain Plain links in normal text, no whitespace, like http://google.com.
1741 radio Text that is matched by a radio target, see manual for details.
1742 tag Tag settings in a headline (link to tag search).
1743 date Time stamps (link to calendar).
1744 footnote Footnote labels.
1746 Changing this variable requires a restart of Emacs to become effective."
1747 :group 'org-link
1748 :type '(set :greedy t
1749 (const :tag "Double bracket links" bracket)
1750 (const :tag "Angular bracket links" angle)
1751 (const :tag "Plain text links" plain)
1752 (const :tag "Radio target matches" radio)
1753 (const :tag "Tags" tag)
1754 (const :tag "Timestamps" date)
1755 (const :tag "Footnotes" footnote)))
1757 (defcustom org-make-link-description-function nil
1758 "Function to use for generating link descriptions from links.
1759 When nil, the link location will be used. This function must take
1760 two parameters: the first one is the link, the second one is the
1761 description generated by `org-insert-link'. The function should
1762 return the description to use."
1763 :group 'org-link
1764 :type '(choice (const nil) (function)))
1766 (defgroup org-link-store nil
1767 "Options concerning storing links in Org-mode."
1768 :tag "Org Store Link"
1769 :group 'org-link)
1771 (defcustom org-url-hexify-p t
1772 "When non-nil, hexify URL when creating a link."
1773 :type 'boolean
1774 :version "24.3"
1775 :group 'org-link-store)
1777 (defcustom org-email-link-description-format "Email %c: %.30s"
1778 "Format of the description part of a link to an email or usenet message.
1779 The following %-escapes will be replaced by corresponding information:
1781 %F full \"From\" field
1782 %f name, taken from \"From\" field, address if no name
1783 %T full \"To\" field
1784 %t first name in \"To\" field, address if no name
1785 %c correspondent. Usually \"from NAME\", but if you sent it yourself, it
1786 will be \"to NAME\". See also the variable `org-from-is-user-regexp'.
1787 %s subject
1788 %d date
1789 %m message-id.
1791 You may use normal field width specification between the % and the letter.
1792 This is for example useful to limit the length of the subject.
1794 Examples: \"%f on: %.30s\", \"Email from %f\", \"Email %c\""
1795 :group 'org-link-store
1796 :type 'string)
1798 (defcustom org-from-is-user-regexp
1799 (let (r1 r2)
1800 (when (and user-mail-address (not (string= user-mail-address "")))
1801 (setq r1 (concat "\\<" (regexp-quote user-mail-address) "\\>")))
1802 (when (and user-full-name (not (string= user-full-name "")))
1803 (setq r2 (concat "\\<" (regexp-quote user-full-name) "\\>")))
1804 (if (and r1 r2) (concat r1 "\\|" r2) (or r1 r2)))
1805 "Regexp matched against the \"From:\" header of an email or usenet message.
1806 It should match if the message is from the user him/herself."
1807 :group 'org-link-store
1808 :type 'regexp)
1810 (defcustom org-context-in-file-links t
1811 "Non-nil means file links from `org-store-link' contain context.
1812 A search string will be added to the file name with :: as separator and
1813 used to find the context when the link is activated by the command
1814 `org-open-at-point'. When this option is t, the entire active region
1815 will be placed in the search string of the file link. If set to a
1816 positive integer, only the first n lines of context will be stored.
1818 Using a prefix arg to the command \\[org-store-link] (`org-store-link')
1819 negates this setting for the duration of the command."
1820 :group 'org-link-store
1821 :type '(choice boolean integer))
1823 (defcustom org-keep-stored-link-after-insertion nil
1824 "Non-nil means keep link in list for entire session.
1826 The command `org-store-link' adds a link pointing to the current
1827 location to an internal list. These links accumulate during a session.
1828 The command `org-insert-link' can be used to insert links into any
1829 Org-mode file (offering completion for all stored links). When this
1830 option is nil, every link which has been inserted once using \\[org-insert-link]
1831 will be removed from the list, to make completing the unused links
1832 more efficient."
1833 :group 'org-link-store
1834 :type 'boolean)
1836 (defgroup org-link-follow nil
1837 "Options concerning following links in Org-mode."
1838 :tag "Org Follow Link"
1839 :group 'org-link)
1841 (defcustom org-link-translation-function nil
1842 "Function to translate links with different syntax to Org syntax.
1843 This can be used to translate links created for example by the Planner
1844 or emacs-wiki packages to Org syntax.
1845 The function must accept two parameters, a TYPE containing the link
1846 protocol name like \"rmail\" or \"gnus\" as a string, and the linked path,
1847 which is everything after the link protocol. It should return a cons
1848 with possibly modified values of type and path.
1849 Org contains a function for this, so if you set this variable to
1850 `org-translate-link-from-planner', you should be able follow many
1851 links created by planner."
1852 :group 'org-link-follow
1853 :type '(choice (const nil) (function)))
1855 (defcustom org-follow-link-hook nil
1856 "Hook that is run after a link has been followed."
1857 :group 'org-link-follow
1858 :type 'hook)
1860 (defcustom org-tab-follows-link nil
1861 "Non-nil means on links TAB will follow the link.
1862 Needs to be set before org.el is loaded.
1863 This really should not be used, it does not make sense, and the
1864 implementation is bad."
1865 :group 'org-link-follow
1866 :type 'boolean)
1868 (defcustom org-return-follows-link nil
1869 "Non-nil means on links RET will follow the link.
1870 In tables, the special behavior of RET has precedence."
1871 :group 'org-link-follow
1872 :type 'boolean)
1874 (defcustom org-mouse-1-follows-link
1875 (if (boundp 'mouse-1-click-follows-link) mouse-1-click-follows-link t)
1876 "Non-nil means mouse-1 on a link will follow the link.
1877 A longer mouse click will still set point. Does not work on XEmacs.
1878 Needs to be set before org.el is loaded."
1879 :group 'org-link-follow
1880 :version "24.4"
1881 :package-version '(Org . "8.3")
1882 :type '(choice
1883 (const :tag "A double click follows the link" double)
1884 (const :tag "Unconditionally follow the link with mouse-1" t)
1885 (integer :tag "mouse-1 click does not follow the link if longer than N ms" 450)))
1887 (defcustom org-mark-ring-length 4
1888 "Number of different positions to be recorded in the ring.
1889 Changing this requires a restart of Emacs to work correctly."
1890 :group 'org-link-follow
1891 :type 'integer)
1893 (defcustom org-link-search-must-match-exact-headline 'query-to-create
1894 "Non-nil means internal links in Org files must exactly match a headline.
1895 When nil, the link search tries to match a phrase with all words
1896 in the search text."
1897 :group 'org-link-follow
1898 :version "24.1"
1899 :type '(choice
1900 (const :tag "Use fuzzy text search" nil)
1901 (const :tag "Match only exact headline" t)
1902 (const :tag "Match exact headline or query to create it"
1903 query-to-create)))
1905 (defcustom org-link-frame-setup
1906 '((vm . vm-visit-folder-other-frame)
1907 (vm-imap . vm-visit-imap-folder-other-frame)
1908 (gnus . org-gnus-no-new-news)
1909 (file . find-file-other-window)
1910 (wl . wl-other-frame))
1911 "Setup the frame configuration for following links.
1912 When following a link with Emacs, it may often be useful to display
1913 this link in another window or frame. This variable can be used to
1914 set this up for the different types of links.
1915 For VM, use any of
1916 `vm-visit-folder'
1917 `vm-visit-folder-other-window'
1918 `vm-visit-folder-other-frame'
1919 For Gnus, use any of
1920 `gnus'
1921 `gnus-other-frame'
1922 `org-gnus-no-new-news'
1923 For FILE, use any of
1924 `find-file'
1925 `find-file-other-window'
1926 `find-file-other-frame'
1927 For Wanderlust use any of
1928 `wl'
1929 `wl-other-frame'
1930 For the calendar, use the variable `calendar-setup'.
1931 For BBDB, it is currently only possible to display the matches in
1932 another window."
1933 :group 'org-link-follow
1934 :type '(list
1935 (cons (const vm)
1936 (choice
1937 (const vm-visit-folder)
1938 (const vm-visit-folder-other-window)
1939 (const vm-visit-folder-other-frame)))
1940 (cons (const vm-imap)
1941 (choice
1942 (const vm-visit-imap-folder)
1943 (const vm-visit-imap-folder-other-window)
1944 (const vm-visit-imap-folder-other-frame)))
1945 (cons (const gnus)
1946 (choice
1947 (const gnus)
1948 (const gnus-other-frame)
1949 (const org-gnus-no-new-news)))
1950 (cons (const file)
1951 (choice
1952 (const find-file)
1953 (const find-file-other-window)
1954 (const find-file-other-frame)))
1955 (cons (const wl)
1956 (choice
1957 (const wl)
1958 (const wl-other-frame)))))
1960 (defcustom org-display-internal-link-with-indirect-buffer nil
1961 "Non-nil means use indirect buffer to display infile links.
1962 Activating internal links (from one location in a file to another location
1963 in the same file) normally just jumps to the location. When the link is
1964 activated with a \\[universal-argument] prefix (or with mouse-3), the link \
1965 is displayed in
1966 another window. When this option is set, the other window actually displays
1967 an indirect buffer clone of the current buffer, to avoid any visibility
1968 changes to the current buffer."
1969 :group 'org-link-follow
1970 :type 'boolean)
1972 (defcustom org-open-non-existing-files nil
1973 "Non-nil means `org-open-file' will open non-existing files.
1974 When nil, an error will be generated.
1975 This variable applies only to external applications because they
1976 might choke on non-existing files. If the link is to a file that
1977 will be opened in Emacs, the variable is ignored."
1978 :group 'org-link-follow
1979 :type 'boolean)
1981 (defcustom org-open-directory-means-index-dot-org nil
1982 "Non-nil means a link to a directory really means to index.org.
1983 When nil, following a directory link will run dired or open a finder/explorer
1984 window on that directory."
1985 :group 'org-link-follow
1986 :type 'boolean)
1988 (defcustom org-link-mailto-program '(browse-url "mailto:%a?subject=%s")
1989 "Function and arguments to call for following mailto links.
1990 This is a list with the first element being a Lisp function, and the
1991 remaining elements being arguments to the function. In string arguments,
1992 %a will be replaced by the address, and %s will be replaced by the subject
1993 if one was given like in <mailto:arthur@galaxy.org::this subject>."
1994 :group 'org-link-follow
1995 :type '(choice
1996 (const :tag "browse-url" (browse-url-mail "mailto:%a?subject=%s"))
1997 (const :tag "compose-mail" (compose-mail "%a" "%s"))
1998 (const :tag "message-mail" (message-mail "%a" "%s"))
1999 (cons :tag "other" (function) (repeat :tag "argument" sexp))))
2001 (defcustom org-confirm-shell-link-function 'yes-or-no-p
2002 "Non-nil means ask for confirmation before executing shell links.
2003 Shell links can be dangerous: just think about a link
2005 [[shell:rm -rf ~/*][Google Search]]
2007 This link would show up in your Org-mode document as \"Google Search\",
2008 but really it would remove your entire home directory.
2009 Therefore we advise against setting this variable to nil.
2010 Just change it to `y-or-n-p' if you want to confirm with a
2011 single keystroke rather than having to type \"yes\"."
2012 :group 'org-link-follow
2013 :type '(choice
2014 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2015 (const :tag "with y-or-n (faster)" y-or-n-p)
2016 (const :tag "no confirmation (dangerous)" nil)))
2017 (put 'org-confirm-shell-link-function
2018 'safe-local-variable
2019 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2021 (defcustom org-confirm-shell-link-not-regexp ""
2022 "A regexp to skip confirmation for shell links."
2023 :group 'org-link-follow
2024 :version "24.1"
2025 :type 'regexp)
2027 (defcustom org-confirm-elisp-link-function 'yes-or-no-p
2028 "Non-nil means ask for confirmation before executing Emacs Lisp links.
2029 Elisp links can be dangerous: just think about a link
2031 [[elisp:(shell-command \"rm -rf ~/*\")][Google Search]]
2033 This link would show up in your Org-mode document as \"Google Search\",
2034 but really it would remove your entire home directory.
2035 Therefore we advise against setting this variable to nil.
2036 Just change it to `y-or-n-p' if you want to confirm with a
2037 single keystroke rather than having to type \"yes\"."
2038 :group 'org-link-follow
2039 :type '(choice
2040 (const :tag "with yes-or-no (safer)" yes-or-no-p)
2041 (const :tag "with y-or-n (faster)" y-or-n-p)
2042 (const :tag "no confirmation (dangerous)" nil)))
2043 (put 'org-confirm-shell-link-function
2044 'safe-local-variable
2045 #'(lambda (x) (member x '(yes-or-no-p y-or-n-p))))
2047 (defcustom org-confirm-elisp-link-not-regexp ""
2048 "A regexp to skip confirmation for Elisp links."
2049 :group 'org-link-follow
2050 :version "24.1"
2051 :type 'regexp)
2053 (defconst org-file-apps-defaults-gnu
2054 '((remote . emacs)
2055 (system . mailcap)
2056 (t . mailcap))
2057 "Default file applications on a UNIX or GNU/Linux system.
2058 See `org-file-apps'.")
2060 (defconst org-file-apps-defaults-macosx
2061 '((remote . emacs)
2062 (t . "open %s")
2063 (system . "open %s")
2064 ("ps.gz" . "gv %s")
2065 ("eps.gz" . "gv %s")
2066 ("dvi" . "xdvi %s")
2067 ("fig" . "xfig %s"))
2068 "Default file applications on a MacOS X system.
2069 The system \"open\" is known as a default, but we use X11 applications
2070 for some files for which the OS does not have a good default.
2071 See `org-file-apps'.")
2073 (defconst org-file-apps-defaults-windowsnt
2074 (list
2075 '(remote . emacs)
2076 (cons t
2077 (list (if (featurep 'xemacs)
2078 'mswindows-shell-execute
2079 'w32-shell-execute)
2080 "open" 'file))
2081 (cons 'system
2082 (list (if (featurep 'xemacs)
2083 'mswindows-shell-execute
2084 'w32-shell-execute)
2085 "open" 'file)))
2086 "Default file applications on a Windows NT system.
2087 The system \"open\" is used for most files.
2088 See `org-file-apps'.")
2090 (defcustom org-file-apps
2091 '((auto-mode . emacs)
2092 ("\\.mm\\'" . default)
2093 ("\\.x?html?\\'" . default)
2094 ("\\.pdf\\'" . default))
2095 "External applications for opening `file:path' items in a document.
2096 Org-mode uses system defaults for different file types, but
2097 you can use this variable to set the application for a given file
2098 extension. The entries in this list are cons cells where the car identifies
2099 files and the cdr the corresponding command. Possible values for the
2100 file identifier are
2101 \"string\" A string as a file identifier can be interpreted in different
2102 ways, depending on its contents:
2104 - Alphanumeric characters only:
2105 Match links with this file extension.
2106 Example: (\"pdf\" . \"evince %s\")
2107 to open PDFs with evince.
2109 - Regular expression: Match links where the
2110 filename matches the regexp. If you want to
2111 use groups here, use shy groups.
2113 Example: (\"\\.x?html\\'\" . \"firefox %s\")
2114 (\"\\(?:xhtml\\|html\\)\" . \"firefox %s\")
2115 to open *.html and *.xhtml with firefox.
2117 - Regular expression which contains (non-shy) groups:
2118 Match links where the whole link, including \"::\", and
2119 anything after that, matches the regexp.
2120 In a custom command string, %1, %2, etc. are replaced with
2121 the parts of the link that were matched by the groups.
2122 For backwards compatibility, if a command string is given
2123 that does not use any of the group matches, this case is
2124 handled identically to the second one (i.e. match against
2125 file name only).
2126 In a custom lisp form, you can access the group matches with
2127 (match-string n link).
2129 Example: (\"\\.pdf::\\(\\d+\\)\\'\" . \"evince -p %1 %s\")
2130 to open [[file:document.pdf::5]] with evince at page 5.
2132 `directory' Matches a directory
2133 `remote' Matches a remote file, accessible through tramp or efs.
2134 Remote files most likely should be visited through Emacs
2135 because external applications cannot handle such paths.
2136 `auto-mode' Matches files that are matched by any entry in `auto-mode-alist',
2137 so all files Emacs knows how to handle. Using this with
2138 command `emacs' will open most files in Emacs. Beware that this
2139 will also open html files inside Emacs, unless you add
2140 (\"html\" . default) to the list as well.
2141 t Default for files not matched by any of the other options.
2142 `system' The system command to open files, like `open' on Windows
2143 and Mac OS X, and mailcap under GNU/Linux. This is the command
2144 that will be selected if you call `C-c C-o' with a double
2145 \\[universal-argument] \\[universal-argument] prefix.
2147 Possible values for the command are:
2148 `emacs' The file will be visited by the current Emacs process.
2149 `default' Use the default application for this file type, which is the
2150 association for t in the list, most likely in the system-specific
2151 part.
2152 This can be used to overrule an unwanted setting in the
2153 system-specific variable.
2154 `system' Use the system command for opening files, like \"open\".
2155 This command is specified by the entry whose car is `system'.
2156 Most likely, the system-specific version of this variable
2157 does define this command, but you can overrule/replace it
2158 here.
2159 string A command to be executed by a shell; %s will be replaced
2160 by the path to the file.
2161 sexp A Lisp form which will be evaluated. The file path will
2162 be available in the Lisp variable `file'.
2163 For more examples, see the system specific constants
2164 `org-file-apps-defaults-macosx'
2165 `org-file-apps-defaults-windowsnt'
2166 `org-file-apps-defaults-gnu'."
2167 :group 'org-link-follow
2168 :type '(repeat
2169 (cons (choice :value ""
2170 (string :tag "Extension")
2171 (const :tag "System command to open files" system)
2172 (const :tag "Default for unrecognized files" t)
2173 (const :tag "Remote file" remote)
2174 (const :tag "Links to a directory" directory)
2175 (const :tag "Any files that have Emacs modes"
2176 auto-mode))
2177 (choice :value ""
2178 (const :tag "Visit with Emacs" emacs)
2179 (const :tag "Use default" default)
2180 (const :tag "Use the system command" system)
2181 (string :tag "Command")
2182 (sexp :tag "Lisp form")))))
2184 (defcustom org-doi-server-url "http://dx.doi.org/"
2185 "The URL of the DOI server."
2186 :type 'string
2187 :version "24.3"
2188 :group 'org-link-follow)
2190 (defgroup org-refile nil
2191 "Options concerning refiling entries in Org-mode."
2192 :tag "Org Refile"
2193 :group 'org)
2195 (defcustom org-directory "~/org"
2196 "Directory with org files.
2197 This is just a default location to look for Org files. There is no need
2198 at all to put your files into this directory. It is only used in the
2199 following situations:
2201 1. When a capture template specifies a target file that is not an
2202 absolute path. The path will then be interpreted relative to
2203 `org-directory'
2204 2. When a capture note is filed away in an interactive way (when exiting the
2205 note buffer with `C-1 C-c C-c'. The user is prompted for an org file,
2206 with `org-directory' as the default path."
2207 :group 'org-refile
2208 :group 'org-capture
2209 :type 'directory)
2211 (defcustom org-default-notes-file (convert-standard-filename "~/.notes")
2212 "Default target for storing notes.
2213 Used as a fall back file for org-capture.el, for templates that
2214 do not specify a target file."
2215 :group 'org-refile
2216 :group 'org-capture
2217 :type '(choice
2218 (const :tag "Default from remember-data-file" nil)
2219 file))
2221 (defcustom org-goto-interface 'outline
2222 "The default interface to be used for `org-goto'.
2223 Allowed values are:
2224 outline The interface shows an outline of the relevant file
2225 and the correct heading is found by moving through
2226 the outline or by searching with incremental search.
2227 outline-path-completion Headlines in the current buffer are offered via
2228 completion. This is the interface also used by
2229 the refile command."
2230 :group 'org-refile
2231 :type '(choice
2232 (const :tag "Outline" outline)
2233 (const :tag "Outline-path-completion" outline-path-completion)))
2235 (defcustom org-goto-max-level 5
2236 "Maximum target level when running `org-goto' with refile interface."
2237 :group 'org-refile
2238 :type 'integer)
2240 (defcustom org-reverse-note-order nil
2241 "Non-nil means store new notes at the beginning of a file or entry.
2242 When nil, new notes will be filed to the end of a file or entry.
2243 This can also be a list with cons cells of regular expressions that
2244 are matched against file names, and values."
2245 :group 'org-capture
2246 :group 'org-refile
2247 :type '(choice
2248 (const :tag "Reverse always" t)
2249 (const :tag "Reverse never" nil)
2250 (repeat :tag "By file name regexp"
2251 (cons regexp boolean))))
2253 (defcustom org-log-refile nil
2254 "Information to record when a task is refiled.
2256 Possible values are:
2258 nil Don't add anything
2259 time Add a time stamp to the task
2260 note Prompt for a note and add it with template `org-log-note-headings'
2262 This option can also be set with on a per-file-basis with
2264 #+STARTUP: nologrefile
2265 #+STARTUP: logrefile
2266 #+STARTUP: lognoterefile
2268 You can have local logging settings for a subtree by setting the LOGGING
2269 property to one or more of these keywords.
2271 When bulk-refiling from the agenda, the value `note' is forbidden and
2272 will temporarily be changed to `time'."
2273 :group 'org-refile
2274 :group 'org-progress
2275 :version "24.1"
2276 :type '(choice
2277 (const :tag "No logging" nil)
2278 (const :tag "Record timestamp" time)
2279 (const :tag "Record timestamp with note." note)))
2281 (defcustom org-refile-targets nil
2282 "Targets for refiling entries with \\[org-refile].
2283 This is a list of cons cells. Each cell contains:
2284 - a specification of the files to be considered, either a list of files,
2285 or a symbol whose function or variable value will be used to retrieve
2286 a file name or a list of file names. If you use `org-agenda-files' for
2287 that, all agenda files will be scanned for targets. Nil means consider
2288 headings in the current buffer.
2289 - A specification of how to find candidate refile targets. This may be
2290 any of:
2291 - a cons cell (:tag . \"TAG\") to identify refile targets by a tag.
2292 This tag has to be present in all target headlines, inheritance will
2293 not be considered.
2294 - a cons cell (:todo . \"KEYWORD\") to identify refile targets by
2295 todo keyword.
2296 - a cons cell (:regexp . \"REGEXP\") with a regular expression matching
2297 headlines that are refiling targets.
2298 - a cons cell (:level . N). Any headline of level N is considered a target.
2299 Note that, when `org-odd-levels-only' is set, level corresponds to
2300 order in hierarchy, not to the number of stars.
2301 - a cons cell (:maxlevel . N). Any headline with level <= N is a target.
2302 Note that, when `org-odd-levels-only' is set, level corresponds to
2303 order in hierarchy, not to the number of stars.
2305 Each element of this list generates a set of possible targets.
2306 The union of these sets is presented (with completion) to
2307 the user by `org-refile'.
2309 You can set the variable `org-refile-target-verify-function' to a function
2310 to verify each headline found by the simple criteria above.
2312 When this variable is nil, all top-level headlines in the current buffer
2313 are used, equivalent to the value `((nil . (:level . 1))'."
2314 :group 'org-refile
2315 :type '(repeat
2316 (cons
2317 (choice :value org-agenda-files
2318 (const :tag "All agenda files" org-agenda-files)
2319 (const :tag "Current buffer" nil)
2320 (function) (variable) (file))
2321 (choice :tag "Identify target headline by"
2322 (cons :tag "Specific tag" (const :value :tag) (string))
2323 (cons :tag "TODO keyword" (const :value :todo) (string))
2324 (cons :tag "Regular expression" (const :value :regexp) (regexp))
2325 (cons :tag "Level number" (const :value :level) (integer))
2326 (cons :tag "Max Level number" (const :value :maxlevel) (integer))))))
2328 (defcustom org-refile-target-verify-function nil
2329 "Function to verify if the headline at point should be a refile target.
2330 The function will be called without arguments, with point at the
2331 beginning of the headline. It should return t and leave point
2332 where it is if the headline is a valid target for refiling.
2334 If the target should not be selected, the function must return nil.
2335 In addition to this, it may move point to a place from where the search
2336 should be continued. For example, the function may decide that the entire
2337 subtree of the current entry should be excluded and move point to the end
2338 of the subtree."
2339 :group 'org-refile
2340 :type '(choice
2341 (const nil)
2342 (function)))
2344 (defcustom org-refile-use-cache nil
2345 "Non-nil means cache refile targets to speed up the process.
2346 The cache for a particular file will be updated automatically when
2347 the buffer has been killed, or when any of the marker used for flagging
2348 refile targets no longer points at a live buffer.
2349 If you have added new entries to a buffer that might themselves be targets,
2350 you need to clear the cache manually by pressing `C-0 C-c C-w' or, if you
2351 find that easier, `C-u C-u C-u C-c C-w'."
2352 :group 'org-refile
2353 :version "24.1"
2354 :type 'boolean)
2356 (defcustom org-refile-use-outline-path nil
2357 "Non-nil means provide refile targets as paths.
2358 So a level 3 headline will be available as level1/level2/level3.
2360 When the value is `file', also include the file name (without directory)
2361 into the path. In this case, you can also stop the completion after
2362 the file name, to get entries inserted as top level in the file.
2364 When `full-file-path', include the full file path."
2365 :group 'org-refile
2366 :type '(choice
2367 (const :tag "Not" nil)
2368 (const :tag "Yes" t)
2369 (const :tag "Start with file name" file)
2370 (const :tag "Start with full file path" full-file-path)))
2372 (defcustom org-outline-path-complete-in-steps t
2373 "Non-nil means complete the outline path in hierarchical steps.
2374 When Org-mode uses the refile interface to select an outline path
2375 \(see variable `org-refile-use-outline-path'), the completion of
2376 the path can be done is a single go, or if can be done in steps down
2377 the headline hierarchy. Going in steps is probably the best if you
2378 do not use a special completion package like `ido' or `icicles'.
2379 However, when using these packages, going in one step can be very
2380 fast, while still showing the whole path to the entry."
2381 :group 'org-refile
2382 :type 'boolean)
2384 (defcustom org-refile-allow-creating-parent-nodes nil
2385 "Non-nil means allow to create new nodes as refile targets.
2386 New nodes are then created by adding \"/new node name\" to the completion
2387 of an existing node. When the value of this variable is `confirm',
2388 new node creation must be confirmed by the user (recommended).
2389 When nil, the completion must match an existing entry.
2391 Note that, if the new heading is not seen by the criteria
2392 listed in `org-refile-targets', multiple instances of the same
2393 heading would be created by trying again to file under the new
2394 heading."
2395 :group 'org-refile
2396 :type '(choice
2397 (const :tag "Never" nil)
2398 (const :tag "Always" t)
2399 (const :tag "Prompt for confirmation" confirm)))
2401 (defcustom org-refile-active-region-within-subtree nil
2402 "Non-nil means also refile active region within a subtree.
2404 By default `org-refile' doesn't allow refiling regions if they
2405 don't contain a set of subtrees, but it might be convenient to
2406 do so sometimes: in that case, the first line of the region is
2407 converted to a headline before refiling."
2408 :group 'org-refile
2409 :version "24.1"
2410 :type 'boolean)
2412 (defgroup org-todo nil
2413 "Options concerning TODO items in Org-mode."
2414 :tag "Org TODO"
2415 :group 'org)
2417 (defgroup org-progress nil
2418 "Options concerning Progress logging in Org-mode."
2419 :tag "Org Progress"
2420 :group 'org-time)
2422 (defvar org-todo-interpretation-widgets
2423 '((:tag "Sequence (cycling hits every state)" sequence)
2424 (:tag "Type (cycling directly to DONE)" type))
2425 "The available interpretation symbols for customizing `org-todo-keywords'.
2426 Interested libraries should add to this list.")
2428 (defcustom org-todo-keywords '((sequence "TODO" "DONE"))
2429 "List of TODO entry keyword sequences and their interpretation.
2430 \\<org-mode-map>This is a list of sequences.
2432 Each sequence starts with a symbol, either `sequence' or `type',
2433 indicating if the keywords should be interpreted as a sequence of
2434 action steps, or as different types of TODO items. The first
2435 keywords are states requiring action - these states will select a headline
2436 for inclusion into the global TODO list Org-mode produces. If one of
2437 the \"keywords\" is the vertical bar, \"|\", the remaining keywords
2438 signify that no further action is necessary. If \"|\" is not found,
2439 the last keyword is treated as the only DONE state of the sequence.
2441 The command \\[org-todo] cycles an entry through these states, and one
2442 additional state where no keyword is present. For details about this
2443 cycling, see the manual.
2445 TODO keywords and interpretation can also be set on a per-file basis with
2446 the special #+SEQ_TODO and #+TYP_TODO lines.
2448 Each keyword can optionally specify a character for fast state selection
2449 \(in combination with the variable `org-use-fast-todo-selection')
2450 and specifiers for state change logging, using the same syntax that
2451 is used in the \"#+TODO:\" lines. For example, \"WAIT(w)\" says that
2452 the WAIT state can be selected with the \"w\" key. \"WAIT(w!)\"
2453 indicates to record a time stamp each time this state is selected.
2455 Each keyword may also specify if a timestamp or a note should be
2456 recorded when entering or leaving the state, by adding additional
2457 characters in the parenthesis after the keyword. This looks like this:
2458 \"WAIT(w@/!)\". \"@\" means to add a note (with time), \"!\" means to
2459 record only the time of the state change. With X and Y being either
2460 \"@\" or \"!\", \"X/Y\" means use X when entering the state, and use
2461 Y when leaving the state if and only if the *target* state does not
2462 define X. You may omit any of the fast-selection key or X or /Y,
2463 so WAIT(w@), WAIT(w/@) and WAIT(@/@) are all valid.
2465 For backward compatibility, this variable may also be just a list
2466 of keywords. In this case the interpretation (sequence or type) will be
2467 taken from the (otherwise obsolete) variable `org-todo-interpretation'."
2468 :group 'org-todo
2469 :group 'org-keywords
2470 :type '(choice
2471 (repeat :tag "Old syntax, just keywords"
2472 (string :tag "Keyword"))
2473 (repeat :tag "New syntax"
2474 (cons
2475 (choice
2476 :tag "Interpretation"
2477 ;;Quick and dirty way to see
2478 ;;`org-todo-interpretations'. This takes the
2479 ;;place of item arguments
2480 :convert-widget
2481 (lambda (widget)
2482 (widget-put widget
2483 :args (mapcar
2484 #'(lambda (x)
2485 (widget-convert
2486 (cons 'const x)))
2487 org-todo-interpretation-widgets))
2488 widget))
2489 (repeat
2490 (string :tag "Keyword"))))))
2492 (defvar org-todo-keywords-1 nil
2493 "All TODO and DONE keywords active in a buffer.")
2494 (make-variable-buffer-local 'org-todo-keywords-1)
2495 (defvar org-todo-keywords-for-agenda nil)
2496 (defvar org-done-keywords-for-agenda nil)
2497 (defvar org-todo-keyword-alist-for-agenda nil)
2498 (defvar org-tag-alist-for-agenda nil
2499 "Alist of all tags from all agenda files.")
2500 (defvar org-tag-groups-alist-for-agenda nil
2501 "Alist of all groups tags from all current agenda files.")
2502 (defvar org-tag-groups-alist nil)
2503 (make-variable-buffer-local 'org-tag-groups-alist)
2504 (defvar org-agenda-contributing-files nil)
2505 (defvar org-not-done-keywords nil)
2506 (make-variable-buffer-local 'org-not-done-keywords)
2507 (defvar org-done-keywords nil)
2508 (make-variable-buffer-local 'org-done-keywords)
2509 (defvar org-todo-heads nil)
2510 (make-variable-buffer-local 'org-todo-heads)
2511 (defvar org-todo-sets nil)
2512 (make-variable-buffer-local 'org-todo-sets)
2513 (defvar org-todo-log-states nil)
2514 (make-variable-buffer-local 'org-todo-log-states)
2515 (defvar org-todo-kwd-alist nil)
2516 (make-variable-buffer-local 'org-todo-kwd-alist)
2517 (defvar org-todo-key-alist nil)
2518 (make-variable-buffer-local 'org-todo-key-alist)
2519 (defvar org-todo-key-trigger nil)
2520 (make-variable-buffer-local 'org-todo-key-trigger)
2522 (defcustom org-todo-interpretation 'sequence
2523 "Controls how TODO keywords are interpreted.
2524 This variable is in principle obsolete and is only used for
2525 backward compatibility, if the interpretation of todo keywords is
2526 not given already in `org-todo-keywords'. See that variable for
2527 more information."
2528 :group 'org-todo
2529 :group 'org-keywords
2530 :type '(choice (const sequence)
2531 (const type)))
2533 (defcustom org-use-fast-todo-selection t
2534 "Non-nil means use the fast todo selection scheme with C-c C-t.
2535 This variable describes if and under what circumstances the cycling
2536 mechanism for TODO keywords will be replaced by a single-key, direct
2537 selection scheme.
2539 When nil, fast selection is never used.
2541 When the symbol `prefix', it will be used when `org-todo' is called
2542 with a prefix argument, i.e. `C-u C-c C-t' in an Org-mode buffer, and
2543 `C-u t' in an agenda buffer.
2545 When t, fast selection is used by default. In this case, the prefix
2546 argument forces cycling instead.
2548 In all cases, the special interface is only used if access keys have
2549 actually been assigned by the user, i.e. if keywords in the configuration
2550 are followed by a letter in parenthesis, like TODO(t)."
2551 :group 'org-todo
2552 :type '(choice
2553 (const :tag "Never" nil)
2554 (const :tag "By default" t)
2555 (const :tag "Only with C-u C-c C-t" prefix)))
2557 (defcustom org-provide-todo-statistics t
2558 "Non-nil means update todo statistics after insert and toggle.
2559 ALL-HEADLINES means update todo statistics by including headlines
2560 with no TODO keyword as well, counting them as not done.
2561 A list of TODO keywords means the same, but skip keywords that are
2562 not in this list.
2563 When set to a list of two lists, the first list contains keywords
2564 to consider as TODO keywords, the second list contains keywords
2565 to consider as DONE keywords.
2567 When this is set, todo statistics is updated in the parent of the
2568 current entry each time a todo state is changed."
2569 :group 'org-todo
2570 :type '(choice
2571 (const :tag "Yes, only for TODO entries" t)
2572 (const :tag "Yes, including all entries" all-headlines)
2573 (repeat :tag "Yes, for TODOs in this list"
2574 (string :tag "TODO keyword"))
2575 (list :tag "Yes, for TODOs and DONEs in these lists"
2576 (repeat (string :tag "TODO keyword"))
2577 (repeat (string :tag "DONE keyword")))
2578 (other :tag "No TODO statistics" nil)))
2580 (defcustom org-hierarchical-todo-statistics t
2581 "Non-nil means TODO statistics covers just direct children.
2582 When nil, all entries in the subtree are considered.
2583 This has only an effect if `org-provide-todo-statistics' is set.
2584 To set this to nil for only a single subtree, use a COOKIE_DATA
2585 property and include the word \"recursive\" into the value."
2586 :group 'org-todo
2587 :type 'boolean)
2589 (defcustom org-after-todo-state-change-hook nil
2590 "Hook which is run after the state of a TODO item was changed.
2591 The new state (a string with a TODO keyword, or nil) is available in the
2592 Lisp variable `org-state'."
2593 :group 'org-todo
2594 :type 'hook)
2596 (defvar org-blocker-hook nil
2597 "Hook for functions that are allowed to block a state change.
2599 Functions in this hook should not modify the buffer.
2600 Each function gets as its single argument a property list,
2601 see `org-trigger-hook' for more information about this list.
2603 If any of the functions in this hook returns nil, the state change
2604 is blocked.")
2606 (defvar org-trigger-hook nil
2607 "Hook for functions that are triggered by a state change.
2609 Each function gets as its single argument a property list with at
2610 least the following elements:
2612 (:type type-of-change :position pos-at-entry-start
2613 :from old-state :to new-state)
2615 Depending on the type, more properties may be present.
2617 This mechanism is currently implemented for:
2619 TODO state changes
2620 ------------------
2621 :type todo-state-change
2622 :from previous state (keyword as a string), or nil, or a symbol
2623 'todo' or 'done', to indicate the general type of state.
2624 :to new state, like in :from")
2626 (defcustom org-enforce-todo-dependencies nil
2627 "Non-nil means undone TODO entries will block switching the parent to DONE.
2628 Also, if a parent has an :ORDERED: property, switching an entry to DONE will
2629 be blocked if any prior sibling is not yet done.
2630 Finally, if the parent is blocked because of ordered siblings of its own,
2631 the child will also be blocked."
2632 :set (lambda (var val)
2633 (set var val)
2634 (if val
2635 (add-hook 'org-blocker-hook
2636 'org-block-todo-from-children-or-siblings-or-parent)
2637 (remove-hook 'org-blocker-hook
2638 'org-block-todo-from-children-or-siblings-or-parent)))
2639 :group 'org-todo
2640 :type 'boolean)
2642 (defcustom org-enforce-todo-checkbox-dependencies nil
2643 "Non-nil means unchecked boxes will block switching the parent to DONE.
2644 When this is nil, checkboxes have no influence on switching TODO states.
2645 When non-nil, you first need to check off all check boxes before the TODO
2646 entry can be switched to DONE.
2647 This variable needs to be set before org.el is loaded, and you need to
2648 restart Emacs after a change to make the change effective. The only way
2649 to change is while Emacs is running is through the customize interface."
2650 :set (lambda (var val)
2651 (set var val)
2652 (if val
2653 (add-hook 'org-blocker-hook
2654 'org-block-todo-from-checkboxes)
2655 (remove-hook 'org-blocker-hook
2656 'org-block-todo-from-checkboxes)))
2657 :group 'org-todo
2658 :type 'boolean)
2660 (defcustom org-treat-insert-todo-heading-as-state-change nil
2661 "Non-nil means inserting a TODO heading is treated as state change.
2662 So when the command \\[org-insert-todo-heading] is used, state change
2663 logging will apply if appropriate. When nil, the new TODO item will
2664 be inserted directly, and no logging will take place."
2665 :group 'org-todo
2666 :type 'boolean)
2668 (defcustom org-treat-S-cursor-todo-selection-as-state-change t
2669 "Non-nil means switching TODO states with S-cursor counts as state change.
2670 This is the default behavior. However, setting this to nil allows a
2671 convenient way to select a TODO state and bypass any logging associated
2672 with that."
2673 :group 'org-todo
2674 :type 'boolean)
2676 (defcustom org-todo-state-tags-triggers nil
2677 "Tag changes that should be triggered by TODO state changes.
2678 This is a list. Each entry is
2680 (state-change (tag . flag) .......)
2682 State-change can be a string with a state, and empty string to indicate the
2683 state that has no TODO keyword, or it can be one of the symbols `todo'
2684 or `done', meaning any not-done or done state, respectively."
2685 :group 'org-todo
2686 :group 'org-tags
2687 :type '(repeat
2688 (cons (choice :tag "When changing to"
2689 (const :tag "Not-done state" todo)
2690 (const :tag "Done state" done)
2691 (string :tag "State"))
2692 (repeat
2693 (cons :tag "Tag action"
2694 (string :tag "Tag")
2695 (choice (const :tag "Add" t) (const :tag "Remove" nil)))))))
2697 (defcustom org-log-done nil
2698 "Information to record when a task moves to the DONE state.
2700 Possible values are:
2702 nil Don't add anything, just change the keyword
2703 time Add a time stamp to the task
2704 note Prompt for a note and add it with template `org-log-note-headings'
2706 This option can also be set with on a per-file-basis with
2708 #+STARTUP: nologdone
2709 #+STARTUP: logdone
2710 #+STARTUP: lognotedone
2712 You can have local logging settings for a subtree by setting the LOGGING
2713 property to one or more of these keywords."
2714 :group 'org-todo
2715 :group 'org-progress
2716 :type '(choice
2717 (const :tag "No logging" nil)
2718 (const :tag "Record CLOSED timestamp" time)
2719 (const :tag "Record CLOSED timestamp with note." note)))
2721 ;; Normalize old uses of org-log-done.
2722 (cond
2723 ((eq org-log-done t) (setq org-log-done 'time))
2724 ((and (listp org-log-done) (memq 'done org-log-done))
2725 (setq org-log-done 'note)))
2727 (defcustom org-log-reschedule nil
2728 "Information to record when the scheduling date of a tasks is modified.
2730 Possible values are:
2732 nil Don't add anything, just change the date
2733 time Add a time stamp to the task
2734 note Prompt for a note and add it with template `org-log-note-headings'
2736 This option can also be set with on a per-file-basis with
2738 #+STARTUP: nologreschedule
2739 #+STARTUP: logreschedule
2740 #+STARTUP: lognotereschedule"
2741 :group 'org-todo
2742 :group 'org-progress
2743 :type '(choice
2744 (const :tag "No logging" nil)
2745 (const :tag "Record timestamp" time)
2746 (const :tag "Record timestamp with note." note)))
2748 (defcustom org-log-redeadline nil
2749 "Information to record when the deadline date of a tasks is modified.
2751 Possible values are:
2753 nil Don't add anything, just change the date
2754 time Add a time stamp to the task
2755 note Prompt for a note and add it with template `org-log-note-headings'
2757 This option can also be set with on a per-file-basis with
2759 #+STARTUP: nologredeadline
2760 #+STARTUP: logredeadline
2761 #+STARTUP: lognoteredeadline
2763 You can have local logging settings for a subtree by setting the LOGGING
2764 property to one or more of these keywords."
2765 :group 'org-todo
2766 :group 'org-progress
2767 :type '(choice
2768 (const :tag "No logging" nil)
2769 (const :tag "Record timestamp" time)
2770 (const :tag "Record timestamp with note." note)))
2772 (defcustom org-log-note-clock-out nil
2773 "Non-nil means record a note when clocking out of an item.
2774 This can also be configured on a per-file basis by adding one of
2775 the following lines anywhere in the buffer:
2777 #+STARTUP: lognoteclock-out
2778 #+STARTUP: nolognoteclock-out"
2779 :group 'org-todo
2780 :group 'org-progress
2781 :type 'boolean)
2783 (defcustom org-log-done-with-time t
2784 "Non-nil means the CLOSED time stamp will contain date and time.
2785 When nil, only the date will be recorded."
2786 :group 'org-progress
2787 :type 'boolean)
2789 (defcustom org-log-note-headings
2790 '((done . "CLOSING NOTE %t")
2791 (state . "State %-12s from %-12S %t")
2792 (note . "Note taken on %t")
2793 (reschedule . "Rescheduled from %S on %t")
2794 (delschedule . "Not scheduled, was %S on %t")
2795 (redeadline . "New deadline from %S on %t")
2796 (deldeadline . "Removed deadline, was %S on %t")
2797 (refile . "Refiled on %t")
2798 (clock-out . ""))
2799 "Headings for notes added to entries.
2800 The value is an alist, with the car being a symbol indicating the note
2801 context, and the cdr is the heading to be used. The heading may also be the
2802 empty string.
2803 %t in the heading will be replaced by a time stamp.
2804 %T will be an active time stamp instead the default inactive one
2805 %d will be replaced by a short-format time stamp.
2806 %D will be replaced by an active short-format time stamp.
2807 %s will be replaced by the new TODO state, in double quotes.
2808 %S will be replaced by the old TODO state, in double quotes.
2809 %u will be replaced by the user name.
2810 %U will be replaced by the full user name.
2812 In fact, it is not a good idea to change the `state' entry, because
2813 agenda log mode depends on the format of these entries."
2814 :group 'org-todo
2815 :group 'org-progress
2816 :type '(list :greedy t
2817 (cons (const :tag "Heading when closing an item" done) string)
2818 (cons (const :tag
2819 "Heading when changing todo state (todo sequence only)"
2820 state) string)
2821 (cons (const :tag "Heading when just taking a note" note) string)
2822 (cons (const :tag "Heading when rescheduling" reschedule) string)
2823 (cons (const :tag "Heading when an item is no longer scheduled" delschedule) string)
2824 (cons (const :tag "Heading when changing deadline" redeadline) string)
2825 (cons (const :tag "Heading when deleting a deadline" deldeadline) string)
2826 (cons (const :tag "Heading when refiling" refile) string)
2827 (cons (const :tag "Heading when clocking out" clock-out) string)))
2829 (unless (assq 'note org-log-note-headings)
2830 (push '(note . "%t") org-log-note-headings))
2832 (defcustom org-log-into-drawer nil
2833 "Non-nil means insert state change notes and time stamps into a drawer.
2834 When nil, state changes notes will be inserted after the headline and
2835 any scheduling and clock lines, but not inside a drawer.
2837 The value of this variable should be the name of the drawer to use.
2838 LOGBOOK is proposed as the default drawer for this purpose, you can
2839 also set this to a string to define the drawer of your choice.
2841 A value of t is also allowed, representing \"LOGBOOK\".
2843 A value of t or nil can also be set with on a per-file-basis with
2845 #+STARTUP: logdrawer
2846 #+STARTUP: nologdrawer
2848 If this variable is set, `org-log-state-notes-insert-after-drawers'
2849 will be ignored.
2851 You can set the property LOG_INTO_DRAWER to overrule this setting for
2852 a subtree."
2853 :group 'org-todo
2854 :group 'org-progress
2855 :type '(choice
2856 (const :tag "Not into a drawer" nil)
2857 (const :tag "LOGBOOK" t)
2858 (string :tag "Other")))
2860 (org-defvaralias 'org-log-state-notes-into-drawer 'org-log-into-drawer)
2862 (defun org-log-into-drawer ()
2863 "Return the value of `org-log-into-drawer', but let properties overrule.
2864 If the current entry has or inherits a LOG_INTO_DRAWER property, it will be
2865 used instead of the default value."
2866 (let ((p (org-entry-get nil "LOG_INTO_DRAWER" 'inherit t)))
2867 (cond
2868 ((not p) org-log-into-drawer)
2869 ((equal p "nil") nil)
2870 ((equal p "t") "LOGBOOK")
2871 (t p))))
2873 (defcustom org-log-state-notes-insert-after-drawers nil
2874 "Non-nil means insert state change notes after any drawers in entry.
2875 Only the drawers that *immediately* follow the headline and the
2876 deadline/scheduled line are skipped.
2877 When nil, insert notes right after the heading and perhaps the line
2878 with deadline/scheduling if present.
2880 This variable will have no effect if `org-log-into-drawer' is
2881 set."
2882 :group 'org-todo
2883 :group 'org-progress
2884 :type 'boolean)
2886 (defcustom org-log-states-order-reversed t
2887 "Non-nil means the latest state note will be directly after heading.
2888 When nil, the state change notes will be ordered according to time.
2890 This option can also be set with on a per-file-basis with
2892 #+STARTUP: logstatesreversed
2893 #+STARTUP: nologstatesreversed"
2894 :group 'org-todo
2895 :group 'org-progress
2896 :type 'boolean)
2898 (defcustom org-todo-repeat-to-state nil
2899 "The TODO state to which a repeater should return the repeating task.
2900 By default this is the first task in a TODO sequence, or the previous state
2901 in a TODO_TYP set. But you can specify another task here.
2902 alternatively, set the :REPEAT_TO_STATE: property of the entry."
2903 :group 'org-todo
2904 :version "24.1"
2905 :type '(choice (const :tag "Head of sequence" nil)
2906 (string :tag "Specific state")))
2908 (defcustom org-log-repeat 'time
2909 "Non-nil means record moving through the DONE state when triggering repeat.
2910 An auto-repeating task is immediately switched back to TODO when
2911 marked DONE. If you are not logging state changes (by adding \"@\"
2912 or \"!\" to the TODO keyword definition), or set `org-log-done' to
2913 record a closing note, there will be no record of the task moving
2914 through DONE. This variable forces taking a note anyway.
2916 nil Don't force a record
2917 time Record a time stamp
2918 note Prompt for a note and add it with template `org-log-note-headings'
2920 This option can also be set with on a per-file-basis with
2922 #+STARTUP: nologrepeat
2923 #+STARTUP: logrepeat
2924 #+STARTUP: lognoterepeat
2926 You can have local logging settings for a subtree by setting the LOGGING
2927 property to one or more of these keywords."
2928 :group 'org-todo
2929 :group 'org-progress
2930 :type '(choice
2931 (const :tag "Don't force a record" nil)
2932 (const :tag "Force recording the DONE state" time)
2933 (const :tag "Force recording a note with the DONE state" note)))
2936 (defgroup org-priorities nil
2937 "Priorities in Org-mode."
2938 :tag "Org Priorities"
2939 :group 'org-todo)
2941 (defcustom org-enable-priority-commands t
2942 "Non-nil means priority commands are active.
2943 When nil, these commands will be disabled, so that you never accidentally
2944 set a priority."
2945 :group 'org-priorities
2946 :type 'boolean)
2948 (defcustom org-highest-priority ?A
2949 "The highest priority of TODO items. A character like ?A, ?B etc.
2950 Must have a smaller ASCII number than `org-lowest-priority'."
2951 :group 'org-priorities
2952 :type 'character)
2954 (defcustom org-lowest-priority ?C
2955 "The lowest priority of TODO items. A character like ?A, ?B etc.
2956 Must have a larger ASCII number than `org-highest-priority'."
2957 :group 'org-priorities
2958 :type 'character)
2960 (defcustom org-default-priority ?B
2961 "The default priority of TODO items.
2962 This is the priority an item gets if no explicit priority is given.
2963 When starting to cycle on an empty priority the first step in the cycle
2964 depends on `org-priority-start-cycle-with-default'. The resulting first
2965 step priority must not exceed the range from `org-highest-priority' to
2966 `org-lowest-priority' which means that `org-default-priority' has to be
2967 in this range exclusive or inclusive the range boundaries. Else the
2968 first step refuses to set the default and the second will fall back
2969 to (depending on the command used) the highest or lowest priority."
2970 :group 'org-priorities
2971 :type 'character)
2973 (defcustom org-priority-start-cycle-with-default t
2974 "Non-nil means start with default priority when starting to cycle.
2975 When this is nil, the first step in the cycle will be (depending on the
2976 command used) one higher or lower than the default priority.
2977 See also `org-default-priority'."
2978 :group 'org-priorities
2979 :type 'boolean)
2981 (defcustom org-get-priority-function nil
2982 "Function to extract the priority from a string.
2983 The string is normally the headline. If this is nil Org computes the
2984 priority from the priority cookie like [#A] in the headline. It returns
2985 an integer, increasing by 1000 for each priority level.
2986 The user can set a different function here, which should take a string
2987 as an argument and return the numeric priority."
2988 :group 'org-priorities
2989 :version "24.1"
2990 :type '(choice
2991 (const nil)
2992 (function)))
2994 (defgroup org-time nil
2995 "Options concerning time stamps and deadlines in Org-mode."
2996 :tag "Org Time"
2997 :group 'org)
2999 (defcustom org-insert-labeled-timestamps-at-point nil
3000 "Non-nil means SCHEDULED and DEADLINE timestamps are inserted at point.
3001 When nil, these labeled time stamps are forces into the second line of an
3002 entry, just after the headline. When scheduling from the global TODO list,
3003 the time stamp will always be forced into the second line."
3004 :group 'org-time
3005 :type 'boolean)
3007 (defcustom org-time-stamp-rounding-minutes '(0 5)
3008 "Number of minutes to round time stamps to.
3009 These are two values, the first applies when first creating a time stamp.
3010 The second applies when changing it with the commands `S-up' and `S-down'.
3011 When changing the time stamp, this means that it will change in steps
3012 of N minutes, as given by the second value.
3014 When a setting is 0 or 1, insert the time unmodified. Useful rounding
3015 numbers should be factors of 60, so for example 5, 10, 15.
3017 When this is larger than 1, you can still force an exact time stamp by using
3018 a double prefix argument to a time stamp command like `C-c .' or `C-c !',
3019 and by using a prefix arg to `S-up/down' to specify the exact number
3020 of minutes to shift."
3021 :group 'org-time
3022 :get #'(lambda (var) ; Make sure both elements are there
3023 (if (integerp (default-value var))
3024 (list (default-value var) 5)
3025 (default-value var)))
3026 :type '(list
3027 (integer :tag "when inserting times")
3028 (integer :tag "when modifying times")))
3030 ;; Normalize old customizations of this variable.
3031 (when (integerp org-time-stamp-rounding-minutes)
3032 (setq org-time-stamp-rounding-minutes
3033 (list org-time-stamp-rounding-minutes
3034 org-time-stamp-rounding-minutes)))
3036 (defcustom org-display-custom-times nil
3037 "Non-nil means overlay custom formats over all time stamps.
3038 The formats are defined through the variable `org-time-stamp-custom-formats'.
3039 To turn this on on a per-file basis, insert anywhere in the file:
3040 #+STARTUP: customtime"
3041 :group 'org-time
3042 :set 'set-default
3043 :type 'sexp)
3044 (make-variable-buffer-local 'org-display-custom-times)
3046 (defcustom org-time-stamp-custom-formats
3047 '("<%m/%d/%y %a>" . "<%m/%d/%y %a %H:%M>") ; american
3048 "Custom formats for time stamps. See `format-time-string' for the syntax.
3049 These are overlaid over the default ISO format if the variable
3050 `org-display-custom-times' is set. Time like %H:%M should be at the
3051 end of the second format. The custom formats are also honored by export
3052 commands, if custom time display is turned on at the time of export."
3053 :group 'org-time
3054 :type 'sexp)
3056 (defun org-time-stamp-format (&optional long inactive)
3057 "Get the right format for a time string."
3058 (let ((f (if long (cdr org-time-stamp-formats)
3059 (car org-time-stamp-formats))))
3060 (if inactive
3061 (concat "[" (substring f 1 -1) "]")
3062 f)))
3064 (defcustom org-time-clocksum-format
3065 '(:days "%dd " :hours "%d" :require-hours t :minutes ":%02d" :require-minutes t)
3066 "The format string used when creating CLOCKSUM lines.
3067 This is also used when Org mode generates a time duration.
3069 The value can be a single format string containing two
3070 %-sequences, which will be filled with the number of hours and
3071 minutes in that order.
3073 Alternatively, the value can be a plist associating any of the
3074 keys :years, :months, :weeks, :days, :hours or :minutes with
3075 format strings. The time duration is formatted using only the
3076 time components that are needed and concatenating the results.
3077 If a time unit in absent, it falls back to the next smallest
3078 unit.
3080 The keys :require-years, :require-months, :require-days,
3081 :require-weeks, :require-hours, :require-minutes are also
3082 meaningful. A non-nil value for these keys indicates that the
3083 corresponding time component should always be included, even if
3084 its value is 0.
3087 For example,
3089 \(:days \"%dd\" :hours \"%d\" :require-hours t :minutes \":%02d\"
3090 :require-minutes t)
3092 means durations longer than a day will be expressed in days,
3093 hours and minutes, and durations less than a day will always be
3094 expressed in hours and minutes (even for durations less than an
3095 hour).
3097 The value
3099 \(:days \"%dd\" :minutes \"%dm\")
3101 means durations longer than a day will be expressed in days and
3102 minutes, and durations less than a day will be expressed entirely
3103 in minutes (even for durations longer than an hour)."
3104 :group 'org-time
3105 :group 'org-clock
3106 :version "24.4"
3107 :package-version '(Org . "8.0")
3108 :type '(choice (string :tag "Format string")
3109 (set :tag "Plist"
3110 (group :inline t (const :tag "Years" :years)
3111 (string :tag "Format string"))
3112 (group :inline t
3113 (const :tag "Always show years" :require-years)
3114 (const t))
3115 (group :inline t (const :tag "Months" :months)
3116 (string :tag "Format string"))
3117 (group :inline t
3118 (const :tag "Always show months" :require-months)
3119 (const t))
3120 (group :inline t (const :tag "Weeks" :weeks)
3121 (string :tag "Format string"))
3122 (group :inline t
3123 (const :tag "Always show weeks" :require-weeks)
3124 (const t))
3125 (group :inline t (const :tag "Days" :days)
3126 (string :tag "Format string"))
3127 (group :inline t
3128 (const :tag "Always show days" :require-days)
3129 (const t))
3130 (group :inline t (const :tag "Hours" :hours)
3131 (string :tag "Format string"))
3132 (group :inline t
3133 (const :tag "Always show hours" :require-hours)
3134 (const t))
3135 (group :inline t (const :tag "Minutes" :minutes)
3136 (string :tag "Format string"))
3137 (group :inline t
3138 (const :tag "Always show minutes" :require-minutes)
3139 (const t)))))
3141 (defcustom org-time-clocksum-use-fractional nil
3142 "When non-nil, \\[org-clock-display] uses fractional times.
3143 See `org-time-clocksum-format' for more on time clock formats."
3144 :group 'org-time
3145 :group 'org-clock
3146 :version "24.3"
3147 :type 'boolean)
3149 (defcustom org-time-clocksum-use-effort-durations nil
3150 "When non-nil, \\[org-clock-display] uses effort durations.
3151 E.g. by default, one day is considered to be a 8 hours effort,
3152 so a task that has been clocked for 16 hours will be displayed
3153 as during 2 days in the clock display or in the clocktable.
3155 See `org-effort-durations' on how to set effort durations
3156 and `org-time-clocksum-format' for more on time clock formats."
3157 :group 'org-time
3158 :group 'org-clock
3159 :version "24.4"
3160 :package-version '(Org . "8.0")
3161 :type 'boolean)
3163 (defcustom org-time-clocksum-fractional-format "%.2f"
3164 "The format string used when creating CLOCKSUM lines,
3165 or when Org mode generates a time duration, if
3166 `org-time-clocksum-use-fractional' is enabled.
3168 The value can be a single format string containing one
3169 %-sequence, which will be filled with the number of hours as
3170 a float.
3172 Alternatively, the value can be a plist associating any of the
3173 keys :years, :months, :weeks, :days, :hours or :minutes with
3174 a format string. The time duration is formatted using the
3175 largest time unit which gives a non-zero integer part. If all
3176 specified formats have zero integer part, the smallest time unit
3177 is used."
3178 :group 'org-time
3179 :type '(choice (string :tag "Format string")
3180 (set (group :inline t (const :tag "Years" :years)
3181 (string :tag "Format string"))
3182 (group :inline t (const :tag "Months" :months)
3183 (string :tag "Format string"))
3184 (group :inline t (const :tag "Weeks" :weeks)
3185 (string :tag "Format string"))
3186 (group :inline t (const :tag "Days" :days)
3187 (string :tag "Format string"))
3188 (group :inline t (const :tag "Hours" :hours)
3189 (string :tag "Format string"))
3190 (group :inline t (const :tag "Minutes" :minutes)
3191 (string :tag "Format string")))))
3193 (defcustom org-deadline-warning-days 14
3194 "Number of days before expiration during which a deadline becomes active.
3195 This variable governs the display in sparse trees and in the agenda.
3196 When 0 or negative, it means use this number (the absolute value of it)
3197 even if a deadline has a different individual lead time specified.
3199 Custom commands can set this variable in the options section."
3200 :group 'org-time
3201 :group 'org-agenda-daily/weekly
3202 :type 'integer)
3204 (defcustom org-scheduled-delay-days 0
3205 "Number of days before a scheduled item becomes active.
3206 This variable governs the display in sparse trees and in the agenda.
3207 The default value (i.e. 0) means: don't delay scheduled item.
3208 When negative, it means use this number (the absolute value of it)
3209 even if a scheduled item has a different individual delay time
3210 specified.
3212 Custom commands can set this variable in the options section."
3213 :group 'org-time
3214 :group 'org-agenda-daily/weekly
3215 :version "24.4"
3216 :package-version '(Org . "8.0")
3217 :type 'integer)
3219 (defcustom org-read-date-prefer-future t
3220 "Non-nil means assume future for incomplete date input from user.
3221 This affects the following situations:
3222 1. The user gives a month but not a year.
3223 For example, if it is April and you enter \"feb 2\", this will be read
3224 as Feb 2, *next* year. \"May 5\", however, will be this year.
3225 2. The user gives a day, but no month.
3226 For example, if today is the 15th, and you enter \"3\", Org-mode will
3227 read this as the third of *next* month. However, if you enter \"17\",
3228 it will be considered as *this* month.
3230 If you set this variable to the symbol `time', then also the following
3231 will work:
3233 3. If the user gives a time.
3234 If the time is before now, it will be interpreted as tomorrow.
3236 Currently none of this works for ISO week specifications.
3238 When this option is nil, the current day, month and year will always be
3239 used as defaults.
3241 See also `org-agenda-jump-prefer-future'."
3242 :group 'org-time
3243 :type '(choice
3244 (const :tag "Never" nil)
3245 (const :tag "Check month and day" t)
3246 (const :tag "Check month, day, and time" time)))
3248 (defcustom org-agenda-jump-prefer-future 'org-read-date-prefer-future
3249 "Should the agenda jump command prefer the future for incomplete dates?
3250 The default is to do the same as configured in `org-read-date-prefer-future'.
3251 But you can also set a deviating value here.
3252 This may t or nil, or the symbol `org-read-date-prefer-future'."
3253 :group 'org-agenda
3254 :group 'org-time
3255 :version "24.1"
3256 :type '(choice
3257 (const :tag "Use org-read-date-prefer-future"
3258 org-read-date-prefer-future)
3259 (const :tag "Never" nil)
3260 (const :tag "Always" t)))
3262 (defcustom org-read-date-force-compatible-dates t
3263 "Should date/time prompt force dates that are guaranteed to work in Emacs?
3265 Depending on the system Emacs is running on, certain dates cannot
3266 be represented with the type used internally to represent time.
3267 Dates between 1970-1-1 and 2038-1-1 can always be represented
3268 correctly. Some systems allow for earlier dates, some for later,
3269 some for both. One way to find out it to insert any date into an
3270 Org buffer, putting the cursor on the year and hitting S-up and
3271 S-down to test the range.
3273 When this variable is set to t, the date/time prompt will not let
3274 you specify dates outside the 1970-2037 range, so it is certain that
3275 these dates will work in whatever version of Emacs you are
3276 running, and also that you can move a file from one Emacs implementation
3277 to another. WHenever Org is forcing the year for you, it will display
3278 a message and beep.
3280 When this variable is nil, Org will check if the date is
3281 representable in the specific Emacs implementation you are using.
3282 If not, it will force a year, usually the current year, and beep
3283 to remind you. Currently this setting is not recommended because
3284 the likelihood that you will open your Org files in an Emacs that
3285 has limited date range is not negligible.
3287 A workaround for this problem is to use diary sexp dates for time
3288 stamps outside of this range."
3289 :group 'org-time
3290 :version "24.1"
3291 :type 'boolean)
3293 (defcustom org-read-date-display-live t
3294 "Non-nil means display current interpretation of date prompt live.
3295 This display will be in an overlay, in the minibuffer."
3296 :group 'org-time
3297 :type 'boolean)
3299 (defcustom org-read-date-popup-calendar t
3300 "Non-nil means pop up a calendar when prompting for a date.
3301 In the calendar, the date can be selected with mouse-1. However, the
3302 minibuffer will also be active, and you can simply enter the date as well.
3303 When nil, only the minibuffer will be available."
3304 :group 'org-time
3305 :type 'boolean)
3306 (org-defvaralias 'org-popup-calendar-for-date-prompt
3307 'org-read-date-popup-calendar)
3309 (make-obsolete-variable
3310 'org-read-date-minibuffer-setup-hook
3311 "Set `org-read-date-minibuffer-local-map' instead." "24.4")
3312 (defcustom org-read-date-minibuffer-setup-hook nil
3313 "Hook to be used to set up keys for the date/time interface.
3314 Add key definitions to `minibuffer-local-map', which will be a
3315 temporary copy.
3317 WARNING: This option is obsolete, you should use
3318 `org-read-date-minibuffer-local-map' to set up keys."
3319 :group 'org-time
3320 :type 'hook)
3322 (defcustom org-extend-today-until 0
3323 "The hour when your day really ends. Must be an integer.
3324 This has influence for the following applications:
3325 - When switching the agenda to \"today\". It it is still earlier than
3326 the time given here, the day recognized as TODAY is actually yesterday.
3327 - When a date is read from the user and it is still before the time given
3328 here, the current date and time will be assumed to be yesterday, 23:59.
3329 Also, timestamps inserted in capture templates follow this rule.
3331 IMPORTANT: This is a feature whose implementation is and likely will
3332 remain incomplete. Really, it is only here because past midnight seems to
3333 be the favorite working time of John Wiegley :-)"
3334 :group 'org-time
3335 :type 'integer)
3337 (defcustom org-use-effective-time nil
3338 "If non-nil, consider `org-extend-today-until' when creating timestamps.
3339 For example, if `org-extend-today-until' is 8, and it's 4am, then the
3340 \"effective time\" of any timestamps between midnight and 8am will be
3341 23:59 of the previous day."
3342 :group 'org-time
3343 :version "24.1"
3344 :type 'boolean)
3346 (defcustom org-use-last-clock-out-time-as-effective-time nil
3347 "When non-nil, use the last clock out time for `org-todo'.
3348 Note that this option has precedence over the combined use of
3349 `org-use-effective-time' and `org-extend-today-until'."
3350 :group 'org-time
3351 :version "24.4"
3352 :package-version '(Org . "8.0")
3353 :type 'boolean)
3355 (defcustom org-edit-timestamp-down-means-later nil
3356 "Non-nil means S-down will increase the time in a time stamp.
3357 When nil, S-up will increase."
3358 :group 'org-time
3359 :type 'boolean)
3361 (defcustom org-calendar-follow-timestamp-change t
3362 "Non-nil means make the calendar window follow timestamp changes.
3363 When a timestamp is modified and the calendar window is visible, it will be
3364 moved to the new date."
3365 :group 'org-time
3366 :type 'boolean)
3368 (defgroup org-tags nil
3369 "Options concerning tags in Org-mode."
3370 :tag "Org Tags"
3371 :group 'org)
3373 (defcustom org-tag-alist nil
3374 "List of tags allowed in Org-mode files.
3375 When this list is nil, Org-mode will base TAG input on what is already in the
3376 buffer.
3377 The value of this variable is an alist, the car of each entry must be a
3378 keyword as a string, the cdr may be a character that is used to select
3379 that tag through the fast-tag-selection interface.
3380 See the manual for details."
3381 :group 'org-tags
3382 :type '(repeat
3383 (choice
3384 (cons (string :tag "Tag name")
3385 (character :tag "Access char"))
3386 (list :tag "Start radio group"
3387 (const :startgroup)
3388 (option (string :tag "Group description")))
3389 (list :tag "Group tags delimiter"
3390 (const :grouptags))
3391 (list :tag "End radio group"
3392 (const :endgroup)
3393 (option (string :tag "Group description")))
3394 (const :tag "New line" (:newline)))))
3396 (defcustom org-tag-persistent-alist nil
3397 "List of tags that will always appear in all Org-mode files.
3398 This is in addition to any in buffer settings or customizations
3399 of `org-tag-alist'.
3400 When this list is nil, Org-mode will base TAG input on `org-tag-alist'.
3401 The value of this variable is an alist, the car of each entry must be a
3402 keyword as a string, the cdr may be a character that is used to select
3403 that tag through the fast-tag-selection interface.
3404 See the manual for details.
3405 To disable these tags on a per-file basis, insert anywhere in the file:
3406 #+STARTUP: noptag"
3407 :group 'org-tags
3408 :type '(repeat
3409 (choice
3410 (cons (string :tag "Tag name")
3411 (character :tag "Access char"))
3412 (const :tag "Start radio group" (:startgroup))
3413 (const :tag "Group tags delimiter" (:grouptags))
3414 (const :tag "End radio group" (:endgroup))
3415 (const :tag "New line" (:newline)))))
3417 (defcustom org-complete-tags-always-offer-all-agenda-tags nil
3418 "If non-nil, always offer completion for all tags of all agenda files.
3419 Instead of customizing this variable directly, you might want to
3420 set it locally for capture buffers, because there no list of
3421 tags in that file can be created dynamically (there are none).
3423 (add-hook 'org-capture-mode-hook
3424 (lambda ()
3425 (set (make-local-variable
3426 'org-complete-tags-always-offer-all-agenda-tags)
3427 t)))"
3428 :group 'org-tags
3429 :version "24.1"
3430 :type 'boolean)
3432 (defvar org-file-tags nil
3433 "List of tags that can be inherited by all entries in the file.
3434 The tags will be inherited if the variable `org-use-tag-inheritance'
3435 says they should be.
3436 This variable is populated from #+FILETAGS lines.")
3438 (defcustom org-use-fast-tag-selection 'auto
3439 "Non-nil means use fast tag selection scheme.
3440 This is a special interface to select and deselect tags with single keys.
3441 When nil, fast selection is never used.
3442 When the symbol `auto', fast selection is used if and only if selection
3443 characters for tags have been configured, either through the variable
3444 `org-tag-alist' or through a #+TAGS line in the buffer.
3445 When t, fast selection is always used and selection keys are assigned
3446 automatically if necessary."
3447 :group 'org-tags
3448 :type '(choice
3449 (const :tag "Always" t)
3450 (const :tag "Never" nil)
3451 (const :tag "When selection characters are configured" auto)))
3453 (defcustom org-fast-tag-selection-single-key nil
3454 "Non-nil means fast tag selection exits after first change.
3455 When nil, you have to press RET to exit it.
3456 During fast tag selection, you can toggle this flag with `C-c'.
3457 This variable can also have the value `expert'. In this case, the window
3458 displaying the tags menu is not even shown, until you press C-c again."
3459 :group 'org-tags
3460 :type '(choice
3461 (const :tag "No" nil)
3462 (const :tag "Yes" t)
3463 (const :tag "Expert" expert)))
3465 (defvar org-fast-tag-selection-include-todo nil
3466 "Non-nil means fast tags selection interface will also offer TODO states.
3467 This is an undocumented feature, you should not rely on it.")
3469 (defcustom org-tags-column (if (featurep 'xemacs) -76 -77)
3470 "The column to which tags should be indented in a headline.
3471 If this number is positive, it specifies the column. If it is negative,
3472 it means that the tags should be flushright to that column. For example,
3473 -80 works well for a normal 80 character screen.
3474 When 0, place tags directly after headline text, with only one space in
3475 between."
3476 :group 'org-tags
3477 :type 'integer)
3479 (defcustom org-auto-align-tags t
3480 "Non-nil keeps tags aligned when modifying headlines.
3481 Some operations (i.e. demoting) change the length of a headline and
3482 therefore shift the tags around. With this option turned on, after
3483 each such operation the tags are again aligned to `org-tags-column'."
3484 :group 'org-tags
3485 :type 'boolean)
3487 (defcustom org-use-tag-inheritance t
3488 "Non-nil means tags in levels apply also for sublevels.
3489 When nil, only the tags directly given in a specific line apply there.
3490 This may also be a list of tags that should be inherited, or a regexp that
3491 matches tags that should be inherited. Additional control is possible
3492 with the variable `org-tags-exclude-from-inheritance' which gives an
3493 explicit list of tags to be excluded from inheritance, even if the value of
3494 `org-use-tag-inheritance' would select it for inheritance.
3496 If this option is t, a match early-on in a tree can lead to a large
3497 number of matches in the subtree when constructing the agenda or creating
3498 a sparse tree. If you only want to see the first match in a tree during
3499 a search, check out the variable `org-tags-match-list-sublevels'."
3500 :group 'org-tags
3501 :type '(choice
3502 (const :tag "Not" nil)
3503 (const :tag "Always" t)
3504 (repeat :tag "Specific tags" (string :tag "Tag"))
3505 (regexp :tag "Tags matched by regexp")))
3507 (defcustom org-tags-exclude-from-inheritance nil
3508 "List of tags that should never be inherited.
3509 This is a way to exclude a few tags from inheritance. For way to do
3510 the opposite, to actively allow inheritance for selected tags,
3511 see the variable `org-use-tag-inheritance'."
3512 :group 'org-tags
3513 :type '(repeat (string :tag "Tag")))
3515 (defun org-tag-inherit-p (tag)
3516 "Check if TAG is one that should be inherited."
3517 (cond
3518 ((member tag org-tags-exclude-from-inheritance) nil)
3519 ((eq org-use-tag-inheritance t) t)
3520 ((not org-use-tag-inheritance) nil)
3521 ((stringp org-use-tag-inheritance)
3522 (string-match org-use-tag-inheritance tag))
3523 ((listp org-use-tag-inheritance)
3524 (member tag org-use-tag-inheritance))
3525 (t (error "Invalid setting of `org-use-tag-inheritance'"))))
3527 (defcustom org-tags-match-list-sublevels t
3528 "Non-nil means list also sublevels of headlines matching a search.
3529 This variable applies to tags/property searches, and also to stuck
3530 projects because this search is based on a tags match as well.
3532 When set to the symbol `indented', sublevels are indented with
3533 leading dots.
3535 Because of tag inheritance (see variable `org-use-tag-inheritance'),
3536 the sublevels of a headline matching a tag search often also match
3537 the same search. Listing all of them can create very long lists.
3538 Setting this variable to nil causes subtrees of a match to be skipped.
3540 This variable is semi-obsolete and probably should always be true. It
3541 is better to limit inheritance to certain tags using the variables
3542 `org-use-tag-inheritance' and `org-tags-exclude-from-inheritance'."
3543 :group 'org-tags
3544 :type '(choice
3545 (const :tag "No, don't list them" nil)
3546 (const :tag "Yes, do list them" t)
3547 (const :tag "List them, indented with leading dots" indented)))
3549 (defcustom org-tags-sort-function nil
3550 "When set, tags are sorted using this function as a comparator."
3551 :group 'org-tags
3552 :type '(choice
3553 (const :tag "No sorting" nil)
3554 (const :tag "Alphabetical" string<)
3555 (const :tag "Reverse alphabetical" string>)
3556 (function :tag "Custom function" nil)))
3558 (defvar org-tags-history nil
3559 "History of minibuffer reads for tags.")
3560 (defvar org-last-tags-completion-table nil
3561 "The last used completion table for tags.")
3562 (defvar org-after-tags-change-hook nil
3563 "Hook that is run after the tags in a line have changed.")
3565 (defgroup org-properties nil
3566 "Options concerning properties in Org-mode."
3567 :tag "Org Properties"
3568 :group 'org)
3570 (defcustom org-property-format "%-10s %s"
3571 "How property key/value pairs should be formatted by `indent-line'.
3572 When `indent-line' hits a property definition, it will format the line
3573 according to this format, mainly to make sure that the values are
3574 lined-up with respect to each other."
3575 :group 'org-properties
3576 :type 'string)
3578 (defcustom org-properties-postprocess-alist nil
3579 "Alist of properties and functions to adjust inserted values.
3580 Elements of this alist must be of the form
3582 ([string] [function])
3584 where [string] must be a property name and [function] must be a
3585 lambda expression: this lambda expression must take one argument,
3586 the value to adjust, and return the new value as a string.
3588 For example, this element will allow the property \"Remaining\"
3589 to be updated wrt the relation between the \"Effort\" property
3590 and the clock summary:
3592 ((\"Remaining\" (lambda(value)
3593 (let ((clocksum (org-clock-sum-current-item))
3594 (effort (org-duration-string-to-minutes
3595 (org-entry-get (point) \"Effort\"))))
3596 (org-minutes-to-clocksum-string (- effort clocksum))))))"
3597 :group 'org-properties
3598 :version "24.1"
3599 :type '(alist :key-type (string :tag "Property")
3600 :value-type (function :tag "Function")))
3602 (defcustom org-use-property-inheritance nil
3603 "Non-nil means properties apply also for sublevels.
3605 This setting is chiefly used during property searches. Turning it on can
3606 cause significant overhead when doing a search, which is why it is not
3607 on by default.
3609 When nil, only the properties directly given in the current entry count.
3610 When t, every property is inherited. The value may also be a list of
3611 properties that should have inheritance, or a regular expression matching
3612 properties that should be inherited.
3614 However, note that some special properties use inheritance under special
3615 circumstances (not in searches). Examples are CATEGORY, ARCHIVE, COLUMNS,
3616 and the properties ending in \"_ALL\" when they are used as descriptor
3617 for valid values of a property.
3619 Note for programmers:
3620 When querying an entry with `org-entry-get', you can control if inheritance
3621 should be used. By default, `org-entry-get' looks only at the local
3622 properties. You can request inheritance by setting the inherit argument
3623 to t (to force inheritance) or to `selective' (to respect the setting
3624 in this variable)."
3625 :group 'org-properties
3626 :type '(choice
3627 (const :tag "Not" nil)
3628 (const :tag "Always" t)
3629 (repeat :tag "Specific properties" (string :tag "Property"))
3630 (regexp :tag "Properties matched by regexp")))
3632 (defun org-property-inherit-p (property)
3633 "Check if PROPERTY is one that should be inherited."
3634 (cond
3635 ((eq org-use-property-inheritance t) t)
3636 ((not org-use-property-inheritance) nil)
3637 ((stringp org-use-property-inheritance)
3638 (string-match org-use-property-inheritance property))
3639 ((listp org-use-property-inheritance)
3640 (member property org-use-property-inheritance))
3641 (t (error "Invalid setting of `org-use-property-inheritance'"))))
3643 (defcustom org-columns-default-format "%25ITEM %TODO %3PRIORITY %TAGS"
3644 "The default column format, if no other format has been defined.
3645 This variable can be set on the per-file basis by inserting a line
3647 #+COLUMNS: %25ITEM ....."
3648 :group 'org-properties
3649 :type 'string)
3651 (defcustom org-columns-ellipses ".."
3652 "The ellipses to be used when a field in column view is truncated.
3653 When this is the empty string, as many characters as possible are shown,
3654 but then there will be no visual indication that the field has been truncated.
3655 When this is a string of length N, the last N characters of a truncated
3656 field are replaced by this string. If the column is narrower than the
3657 ellipses string, only part of the ellipses string will be shown."
3658 :group 'org-properties
3659 :type 'string)
3661 (defcustom org-columns-modify-value-for-display-function nil
3662 "Function that modifies values for display in column view.
3663 For example, it can be used to cut out a certain part from a time stamp.
3664 The function must take 2 arguments:
3666 column-title The title of the column (*not* the property name)
3667 value The value that should be modified.
3669 The function should return the value that should be displayed,
3670 or nil if the normal value should be used."
3671 :group 'org-properties
3672 :type '(choice (const nil) (function)))
3674 (defconst org-global-properties-fixed
3675 '(("VISIBILITY_ALL" . "folded children content all")
3676 ("CLOCK_MODELINE_TOTAL_ALL" . "current today repeat all auto"))
3677 "List of property/value pairs that can be inherited by any entry.
3679 These are fixed values, for the preset properties. The user variable
3680 that can be used to add to this list is `org-global-properties'.
3682 The entries in this list are cons cells where the car is a property
3683 name and cdr is a string with the value. If the value represents
3684 multiple items like an \"_ALL\" property, separate the items by
3685 spaces.")
3687 (defcustom org-global-properties nil
3688 "List of property/value pairs that can be inherited by any entry.
3690 This list will be combined with the constant `org-global-properties-fixed'.
3692 The entries in this list are cons cells where the car is a property
3693 name and cdr is a string with the value.
3695 You can set buffer-local values for the same purpose in the variable
3696 `org-file-properties' this by adding lines like
3698 #+PROPERTY: NAME VALUE"
3699 :group 'org-properties
3700 :type '(repeat
3701 (cons (string :tag "Property")
3702 (string :tag "Value"))))
3704 (defvar org-file-properties nil
3705 "List of property/value pairs that can be inherited by any entry.
3706 Valid for the current buffer.
3707 This variable is populated from #+PROPERTY lines.")
3708 (make-variable-buffer-local 'org-file-properties)
3710 (defgroup org-agenda nil
3711 "Options concerning agenda views in Org-mode."
3712 :tag "Org Agenda"
3713 :group 'org)
3715 (defvar org-category nil
3716 "Variable used by org files to set a category for agenda display.
3717 Such files should use a file variable to set it, for example
3719 # -*- mode: org; org-category: \"ELisp\"
3721 or contain a special line
3723 #+CATEGORY: ELisp
3725 If the file does not specify a category, then file's base name
3726 is used instead.")
3727 (make-variable-buffer-local 'org-category)
3728 (put 'org-category 'safe-local-variable #'(lambda (x) (or (symbolp x) (stringp x))))
3730 (defcustom org-agenda-files nil
3731 "The files to be used for agenda display.
3732 Entries may be added to this list with \\[org-agenda-file-to-front] and removed with
3733 \\[org-remove-file]. You can also use customize to edit the list.
3735 If an entry is a directory, all files in that directory that are matched by
3736 `org-agenda-file-regexp' will be part of the file list.
3738 If the value of the variable is not a list but a single file name, then
3739 the list of agenda files is actually stored and maintained in that file, one
3740 agenda file per line. In this file paths can be given relative to
3741 `org-directory'. Tilde expansion and environment variable substitution
3742 are also made."
3743 :group 'org-agenda
3744 :type '(choice
3745 (repeat :tag "List of files and directories" file)
3746 (file :tag "Store list in a file\n" :value "~/.agenda_files")))
3748 (defcustom org-agenda-file-regexp "\\`[^.].*\\.org\\'"
3749 "Regular expression to match files for `org-agenda-files'.
3750 If any element in the list in that variable contains a directory instead
3751 of a normal file, all files in that directory that are matched by this
3752 regular expression will be included."
3753 :group 'org-agenda
3754 :type 'regexp)
3756 (defcustom org-agenda-text-search-extra-files nil
3757 "List of extra files to be searched by text search commands.
3758 These files will be searched in addition to the agenda files by the
3759 commands `org-search-view' (`C-c a s') and `org-occur-in-agenda-files'.
3760 Note that these files will only be searched for text search commands,
3761 not for the other agenda views like todo lists, tag searches or the weekly
3762 agenda. This variable is intended to list notes and possibly archive files
3763 that should also be searched by these two commands.
3764 In fact, if the first element in the list is the symbol `agenda-archives',
3765 then all archive files of all agenda files will be added to the search
3766 scope."
3767 :group 'org-agenda
3768 :type '(set :greedy t
3769 (const :tag "Agenda Archives" agenda-archives)
3770 (repeat :inline t (file))))
3772 (org-defvaralias 'org-agenda-multi-occur-extra-files
3773 'org-agenda-text-search-extra-files)
3775 (defcustom org-agenda-skip-unavailable-files nil
3776 "Non-nil means to just skip non-reachable files in `org-agenda-files'.
3777 A nil value means to remove them, after a query, from the list."
3778 :group 'org-agenda
3779 :type 'boolean)
3781 (defcustom org-calendar-to-agenda-key [?c]
3782 "The key to be installed in `calendar-mode-map' for switching to the agenda.
3783 The command `org-calendar-goto-agenda' will be bound to this key. The
3784 default is the character `c' because then `c' can be used to switch back and
3785 forth between agenda and calendar."
3786 :group 'org-agenda
3787 :type 'sexp)
3789 (defcustom org-calendar-insert-diary-entry-key [?i]
3790 "The key to be installed in `calendar-mode-map' for adding diary entries.
3791 This option is irrelevant until `org-agenda-diary-file' has been configured
3792 to point to an Org-mode file. When that is the case, the command
3793 `org-agenda-diary-entry' will be bound to the key given here, by default
3794 `i'. In the calendar, `i' normally adds entries to `diary-file'. So
3795 if you want to continue doing this, you need to change this to a different
3796 key."
3797 :group 'org-agenda
3798 :type 'sexp)
3800 (defcustom org-agenda-diary-file 'diary-file
3801 "File to which to add new entries with the `i' key in agenda and calendar.
3802 When this is the symbol `diary-file', the functionality in the Emacs
3803 calendar will be used to add entries to the `diary-file'. But when this
3804 points to a file, `org-agenda-diary-entry' will be used instead."
3805 :group 'org-agenda
3806 :type '(choice
3807 (const :tag "The standard Emacs diary file" diary-file)
3808 (file :tag "Special Org file diary entries")))
3810 (eval-after-load "calendar"
3811 '(progn
3812 (org-defkey calendar-mode-map org-calendar-to-agenda-key
3813 'org-calendar-goto-agenda)
3814 (add-hook 'calendar-mode-hook
3815 (lambda ()
3816 (unless (eq org-agenda-diary-file 'diary-file)
3817 (define-key calendar-mode-map
3818 org-calendar-insert-diary-entry-key
3819 'org-agenda-diary-entry))))))
3821 (defgroup org-latex nil
3822 "Options for embedding LaTeX code into Org-mode."
3823 :tag "Org LaTeX"
3824 :group 'org)
3826 (defcustom org-format-latex-options
3827 '(:foreground default :background default :scale 1.0
3828 :html-foreground "Black" :html-background "Transparent"
3829 :html-scale 1.0 :matchers ("begin" "$1" "$" "$$" "\\(" "\\["))
3830 "Options for creating images from LaTeX fragments.
3831 This is a property list with the following properties:
3832 :foreground the foreground color for images embedded in Emacs, e.g. \"Black\".
3833 `default' means use the foreground of the default face.
3834 `auto' means use the foreground from the text face.
3835 :background the background color, or \"Transparent\".
3836 `default' means use the background of the default face.
3837 `auto' means use the background from the text face.
3838 :scale a scaling factor for the size of the images, to get more pixels
3839 :html-foreground, :html-background, :html-scale
3840 the same numbers for HTML export.
3841 :matchers a list indicating which matchers should be used to
3842 find LaTeX fragments. Valid members of this list are:
3843 \"begin\" find environments
3844 \"$1\" find single characters surrounded by $.$
3845 \"$\" find math expressions surrounded by $...$
3846 \"$$\" find math expressions surrounded by $$....$$
3847 \"\\(\" find math expressions surrounded by \\(...\\)
3848 \"\\=\\[\" find math expressions surrounded by \\=\\[...\\]"
3849 :group 'org-latex
3850 :type 'plist)
3852 (defcustom org-format-latex-signal-error t
3853 "Non-nil means signal an error when image creation of LaTeX snippets fails.
3854 When nil, just push out a message."
3855 :group 'org-latex
3856 :version "24.1"
3857 :type 'boolean)
3859 (defcustom org-latex-to-mathml-jar-file nil
3860 "Value of\"%j\" in `org-latex-to-mathml-convert-command'.
3861 Use this to specify additional executable file say a jar file.
3863 When using MathToWeb as the converter, specify the full-path to
3864 your mathtoweb.jar file."
3865 :group 'org-latex
3866 :version "24.1"
3867 :type '(choice
3868 (const :tag "None" nil)
3869 (file :tag "JAR file" :must-match t)))
3871 (defcustom org-latex-to-mathml-convert-command nil
3872 "Command to convert LaTeX fragments to MathML.
3873 Replace format-specifiers in the command as noted below and use
3874 `shell-command' to convert LaTeX to MathML.
3875 %j: Executable file in fully expanded form as specified by
3876 `org-latex-to-mathml-jar-file'.
3877 %I: Input LaTeX file in fully expanded form
3878 %o: Output MathML file
3879 This command is used by `org-create-math-formula'.
3881 When using MathToWeb as the converter, set this to
3882 \"java -jar %j -unicode -force -df %o %I\"."
3883 :group 'org-latex
3884 :version "24.1"
3885 :type '(choice
3886 (const :tag "None" nil)
3887 (string :tag "\nShell command")))
3889 (defcustom org-latex-create-formula-image-program 'dvipng
3890 "Program to convert LaTeX fragments with.
3892 dvipng Process the LaTeX fragments to dvi file, then convert
3893 dvi files to png files using dvipng.
3894 This will also include processing of non-math environments.
3895 imagemagick Convert the LaTeX fragments to pdf files and use imagemagick
3896 to convert pdf files to png files"
3897 :group 'org-latex
3898 :version "24.1"
3899 :type '(choice
3900 (const :tag "dvipng" dvipng)
3901 (const :tag "imagemagick" imagemagick)))
3903 (defcustom org-latex-preview-ltxpng-directory "ltxpng/"
3904 "Path to store latex preview images.
3905 A relative path here creates many directories relative to the
3906 processed org files paths. An absolute path puts all preview
3907 images at the same place."
3908 :group 'org-latex
3909 :version "24.3"
3910 :type 'string)
3912 (defun org-format-latex-mathml-available-p ()
3913 "Return t if `org-latex-to-mathml-convert-command' is usable."
3914 (save-match-data
3915 (when (and (boundp 'org-latex-to-mathml-convert-command)
3916 org-latex-to-mathml-convert-command)
3917 (let ((executable (car (split-string
3918 org-latex-to-mathml-convert-command))))
3919 (when (executable-find executable)
3920 (if (string-match
3921 "%j" org-latex-to-mathml-convert-command)
3922 (file-readable-p org-latex-to-mathml-jar-file)
3923 t))))))
3925 (defcustom org-format-latex-header "\\documentclass{article}
3926 \\usepackage[usenames]{color}
3927 \[PACKAGES]
3928 \[DEFAULT-PACKAGES]
3929 \\pagestyle{empty} % do not remove
3930 % The settings below are copied from fullpage.sty
3931 \\setlength{\\textwidth}{\\paperwidth}
3932 \\addtolength{\\textwidth}{-3cm}
3933 \\setlength{\\oddsidemargin}{1.5cm}
3934 \\addtolength{\\oddsidemargin}{-2.54cm}
3935 \\setlength{\\evensidemargin}{\\oddsidemargin}
3936 \\setlength{\\textheight}{\\paperheight}
3937 \\addtolength{\\textheight}{-\\headheight}
3938 \\addtolength{\\textheight}{-\\headsep}
3939 \\addtolength{\\textheight}{-\\footskip}
3940 \\addtolength{\\textheight}{-3cm}
3941 \\setlength{\\topmargin}{1.5cm}
3942 \\addtolength{\\topmargin}{-2.54cm}"
3943 "The document header used for processing LaTeX fragments.
3944 It is imperative that this header make sure that no page number
3945 appears on the page. The package defined in the variables
3946 `org-latex-default-packages-alist' and `org-latex-packages-alist'
3947 will either replace the placeholder \"[PACKAGES]\" in this
3948 header, or they will be appended."
3949 :group 'org-latex
3950 :type 'string)
3952 (defun org-set-packages-alist (var val)
3953 "Set the packages alist and make sure it has 3 elements per entry."
3954 (set var (mapcar (lambda (x)
3955 (if (and (consp x) (= (length x) 2))
3956 (list (car x) (nth 1 x) t)
3958 val)))
3960 (defun org-get-packages-alist (var)
3961 "Get the packages alist and make sure it has 3 elements per entry."
3962 (mapcar (lambda (x)
3963 (if (and (consp x) (= (length x) 2))
3964 (list (car x) (nth 1 x) t)
3966 (default-value var)))
3968 (defcustom org-latex-default-packages-alist
3969 '(("AUTO" "inputenc" t)
3970 ("T1" "fontenc" t)
3971 ("" "fixltx2e" nil)
3972 ("" "graphicx" t)
3973 ("" "longtable" nil)
3974 ("" "float" nil)
3975 ("" "wrapfig" nil)
3976 ("" "rotating" nil)
3977 ("normalem" "ulem" t)
3978 ("" "amsmath" t)
3979 ("" "textcomp" t)
3980 ("" "marvosym" t)
3981 ("" "wasysym" t)
3982 ("" "amssymb" t)
3983 ("" "hyperref" nil)
3984 "\\tolerance=1000")
3985 "Alist of default packages to be inserted in the header.
3987 Change this only if one of the packages here causes an
3988 incompatibility with another package you are using.
3990 The packages in this list are needed by one part or another of
3991 Org mode to function properly:
3993 - inputenc, fontenc: for basic font and character selection
3994 - fixltx2e: Important patches of LaTeX itself
3995 - graphicx: for including images
3996 - longtable: For multipage tables
3997 - float, wrapfig: for figure placement
3998 - rotating: for sideways figures and tables
3999 - ulem: for underline and strike-through
4000 - amsmath: for subscript and superscript and math environments
4001 - textcomp, marvosymb, wasysym, amssymb: for various symbols used
4002 for interpreting the entities in `org-entities'. You can skip
4003 some of these packages if you don't use any of their symbols.
4004 - hyperref: for cross references
4006 Therefore you should not modify this variable unless you know
4007 what you are doing. The one reason to change it anyway is that
4008 you might be loading some other package that conflicts with one
4009 of the default packages. Each cell is of the format
4010 \( \"options\" \"package\" snippet-flag). If SNIPPET-FLAG is t,
4011 the package also needs to be included when compiling LaTeX
4012 snippets into images for inclusion into non-LaTeX output."
4013 :group 'org-latex
4014 :group 'org-export-latex
4015 :set 'org-set-packages-alist
4016 :get 'org-get-packages-alist
4017 :version "24.1"
4018 :type '(repeat
4019 (choice
4020 (list :tag "options/package pair"
4021 (string :tag "options")
4022 (string :tag "package")
4023 (boolean :tag "Snippet"))
4024 (string :tag "A line of LaTeX"))))
4026 (defcustom org-latex-packages-alist nil
4027 "Alist of packages to be inserted in every LaTeX header.
4029 These will be inserted after `org-latex-default-packages-alist'.
4030 Each cell is of the format:
4032 \(\"options\" \"package\" snippet-flag)
4034 SNIPPET-FLAG, when t, indicates that this package is also needed
4035 when turning LaTeX snippets into images for inclusion into
4036 non-LaTeX output.
4038 Make sure that you only list packages here which:
4040 - you want in every file
4041 - do not conflict with the setup in `org-format-latex-header'.
4042 - do not conflict with the default packages in
4043 `org-latex-default-packages-alist'."
4044 :group 'org-latex
4045 :group 'org-export-latex
4046 :set 'org-set-packages-alist
4047 :get 'org-get-packages-alist
4048 :type '(repeat
4049 (choice
4050 (list :tag "options/package pair"
4051 (string :tag "options")
4052 (string :tag "package")
4053 (boolean :tag "Snippet"))
4054 (string :tag "A line of LaTeX"))))
4056 (defgroup org-appearance nil
4057 "Settings for Org-mode appearance."
4058 :tag "Org Appearance"
4059 :group 'org)
4061 (defcustom org-level-color-stars-only nil
4062 "Non-nil means fontify only the stars in each headline.
4063 When nil, the entire headline is fontified.
4064 Changing it requires restart of `font-lock-mode' to become effective
4065 also in regions already fontified."
4066 :group 'org-appearance
4067 :type 'boolean)
4069 (defcustom org-hide-leading-stars nil
4070 "Non-nil means hide the first N-1 stars in a headline.
4071 This works by using the face `org-hide' for these stars. This
4072 face is white for a light background, and black for a dark
4073 background. You may have to customize the face `org-hide' to
4074 make this work.
4075 Changing it requires restart of `font-lock-mode' to become effective
4076 also in regions already fontified.
4077 You may also set this on a per-file basis by adding one of the following
4078 lines to the buffer:
4080 #+STARTUP: hidestars
4081 #+STARTUP: showstars"
4082 :group 'org-appearance
4083 :type 'boolean)
4085 (defcustom org-hidden-keywords nil
4086 "List of symbols corresponding to keywords to be hidden the org buffer.
4087 For example, a value '(title) for this list will make the document's title
4088 appear in the buffer without the initial #+TITLE: keyword."
4089 :group 'org-appearance
4090 :version "24.1"
4091 :type '(set (const :tag "#+AUTHOR" author)
4092 (const :tag "#+DATE" date)
4093 (const :tag "#+EMAIL" email)
4094 (const :tag "#+TITLE" title)))
4096 (defcustom org-custom-properties nil
4097 "List of properties (as strings) with a special meaning.
4098 The default use of these custom properties is to let the user
4099 hide them with `org-toggle-custom-properties-visibility'."
4100 :group 'org-properties
4101 :group 'org-appearance
4102 :version "24.3"
4103 :type '(repeat (string :tag "Property Name")))
4105 (defcustom org-fontify-done-headline nil
4106 "Non-nil means change the face of a headline if it is marked DONE.
4107 Normally, only the TODO/DONE keyword indicates the state of a headline.
4108 When this is non-nil, the headline after the keyword is set to the
4109 `org-headline-done' as an additional indication."
4110 :group 'org-appearance
4111 :type 'boolean)
4113 (defcustom org-fontify-emphasized-text t
4114 "Non-nil means fontify *bold*, /italic/ and _underlined_ text.
4115 Changing this variable requires a restart of Emacs to take effect."
4116 :group 'org-appearance
4117 :type 'boolean)
4119 (defcustom org-fontify-whole-heading-line nil
4120 "Non-nil means fontify the whole line for headings.
4121 This is useful when setting a background color for the
4122 org-level-* faces."
4123 :group 'org-appearance
4124 :type 'boolean)
4126 (defcustom org-highlight-latex-and-related nil
4127 "Non-nil means highlight LaTeX related syntax in the buffer.
4128 When non nil, the value should be a list containing any of the
4129 following symbols:
4130 `latex' Highlight LaTeX snippets and environments.
4131 `script' Highlight subscript and superscript.
4132 `entities' Highlight entities."
4133 :group 'org-appearance
4134 :version "24.4"
4135 :package-version '(Org . "8.0")
4136 :type '(choice
4137 (const :tag "No highlighting" nil)
4138 (set :greedy t :tag "Highlight"
4139 (const :tag "LaTeX snippets and environments" latex)
4140 (const :tag "Subscript and superscript" script)
4141 (const :tag "Entities" entities))))
4143 (defcustom org-hide-emphasis-markers nil
4144 "Non-nil mean font-lock should hide the emphasis marker characters."
4145 :group 'org-appearance
4146 :type 'boolean)
4148 (defcustom org-hide-macro-markers nil
4149 "Non-nil mean font-lock should hide the brackets marking macro calls."
4150 :group 'org-appearance
4151 :type 'boolean)
4153 (defcustom org-pretty-entities nil
4154 "Non-nil means show entities as UTF8 characters.
4155 When nil, the \\name form remains in the buffer."
4156 :group 'org-appearance
4157 :version "24.1"
4158 :type 'boolean)
4160 (defcustom org-pretty-entities-include-sub-superscripts t
4161 "Non-nil means, pretty entity display includes formatting sub/superscripts."
4162 :group 'org-appearance
4163 :version "24.1"
4164 :type 'boolean)
4166 (defvar org-emph-re nil
4167 "Regular expression for matching emphasis.
4168 After a match, the match groups contain these elements:
4169 0 The match of the full regular expression, including the characters
4170 before and after the proper match
4171 1 The character before the proper match, or empty at beginning of line
4172 2 The proper match, including the leading and trailing markers
4173 3 The leading marker like * or /, indicating the type of highlighting
4174 4 The text between the emphasis markers, not including the markers
4175 5 The character after the match, empty at the end of a line")
4176 (defvar org-verbatim-re nil
4177 "Regular expression for matching verbatim text.")
4178 (defvar org-emphasis-regexp-components) ; defined just below
4179 (defvar org-emphasis-alist) ; defined just below
4180 (defun org-set-emph-re (var val)
4181 "Set variable and compute the emphasis regular expression."
4182 (set var val)
4183 (when (and (boundp 'org-emphasis-alist)
4184 (boundp 'org-emphasis-regexp-components)
4185 org-emphasis-alist org-emphasis-regexp-components)
4186 (let* ((e org-emphasis-regexp-components)
4187 (pre (car e))
4188 (post (nth 1 e))
4189 (border (nth 2 e))
4190 (body (nth 3 e))
4191 (nl (nth 4 e))
4192 (body1 (concat body "*?"))
4193 (markers (mapconcat 'car org-emphasis-alist ""))
4194 (vmarkers (mapconcat
4195 (lambda (x) (if (eq (nth 2 x) 'verbatim) (car x) ""))
4196 org-emphasis-alist "")))
4197 ;; make sure special characters appear at the right position in the class
4198 (if (string-match "\\^" markers)
4199 (setq markers (concat (replace-match "" t t markers) "^")))
4200 (if (string-match "-" markers)
4201 (setq markers (concat (replace-match "" t t markers) "-")))
4202 (if (string-match "\\^" vmarkers)
4203 (setq vmarkers (concat (replace-match "" t t vmarkers) "^")))
4204 (if (string-match "-" vmarkers)
4205 (setq vmarkers (concat (replace-match "" t t vmarkers) "-")))
4206 (if (> nl 0)
4207 (setq body1 (concat body1 "\\(?:\n" body "*?\\)\\{0,"
4208 (int-to-string nl) "\\}")))
4209 ;; Make the regexp
4210 (setq org-emph-re
4211 (concat "\\([" pre "]\\|^\\)"
4212 "\\("
4213 "\\([" markers "]\\)"
4214 "\\("
4215 "[^" border "]\\|"
4216 "[^" border "]"
4217 body1
4218 "[^" border "]"
4219 "\\)"
4220 "\\3\\)"
4221 "\\([" post "]\\|$\\)"))
4222 (setq org-verbatim-re
4223 (concat "\\([" pre "]\\|^\\)"
4224 "\\("
4225 "\\([" vmarkers "]\\)"
4226 "\\("
4227 "[^" border "]\\|"
4228 "[^" border "]"
4229 body1
4230 "[^" border "]"
4231 "\\)"
4232 "\\3\\)"
4233 "\\([" post "]\\|$\\)")))))
4235 ;; This used to be a defcustom (Org <8.0) but allowing the users to
4236 ;; set this option proved cumbersome. See this message/thread:
4237 ;; http://article.gmane.org/gmane.emacs.orgmode/68681
4238 (defvar org-emphasis-regexp-components
4239 '(" \t('\"{" "- \t.,:!?;'\")}\\" " \t\r\n,\"'" "." 1)
4240 "Components used to build the regular expression for emphasis.
4241 This is a list with five entries. Terminology: In an emphasis string
4242 like \" *strong word* \", we call the initial space PREMATCH, the final
4243 space POSTMATCH, the stars MARKERS, \"s\" and \"d\" are BORDER characters
4244 and \"trong wor\" is the body. The different components in this variable
4245 specify what is allowed/forbidden in each part:
4247 pre Chars allowed as prematch. Beginning of line will be allowed too.
4248 post Chars allowed as postmatch. End of line will be allowed too.
4249 border The chars *forbidden* as border characters.
4250 body-regexp A regexp like \".\" to match a body character. Don't use
4251 non-shy groups here, and don't allow newline here.
4252 newline The maximum number of newlines allowed in an emphasis exp.
4254 You need to reload Org or to restart Emacs after customizing this.")
4256 (defcustom org-emphasis-alist
4257 `(("*" bold)
4258 ("/" italic)
4259 ("_" underline)
4260 ("=" org-code verbatim)
4261 ("~" org-verbatim verbatim)
4262 ("+" ,(if (featurep 'xemacs) 'org-table '(:strike-through t))))
4263 "Alist of characters and faces to emphasize text.
4264 Text starting and ending with a special character will be emphasized,
4265 for example *bold*, _underlined_ and /italic/. This variable sets the
4266 marker characters and the face to be used by font-lock for highlighting
4267 in Org-mode Emacs buffers.
4269 You need to reload Org or to restart Emacs after customizing this."
4270 :group 'org-appearance
4271 :set 'org-set-emph-re
4272 :version "24.4"
4273 :package-version '(Org . "8.0")
4274 :type '(repeat
4275 (list
4276 (string :tag "Marker character")
4277 (choice
4278 (face :tag "Font-lock-face")
4279 (plist :tag "Face property list"))
4280 (option (const verbatim)))))
4282 (defvar org-protecting-blocks
4283 '("src" "example" "latex" "ascii" "html" "ditaa" "dot" "r" "R")
4284 "Blocks that contain text that is quoted, i.e. not processed as Org syntax.
4285 This is needed for font-lock setup.")
4287 ;;; Miscellaneous options
4289 (defgroup org-completion nil
4290 "Completion in Org-mode."
4291 :tag "Org Completion"
4292 :group 'org)
4294 (defcustom org-completion-use-ido nil
4295 "Non-nil means use ido completion wherever possible.
4296 Note that `ido-mode' must be active for this variable to be relevant.
4297 If you decide to turn this variable on, you might well want to turn off
4298 `org-outline-path-complete-in-steps'.
4299 See also `org-completion-use-iswitchb'."
4300 :group 'org-completion
4301 :type 'boolean)
4303 (defcustom org-completion-use-iswitchb nil
4304 "Non-nil means use iswitchb completion wherever possible.
4305 Note that `iswitchb-mode' must be active for this variable to be relevant.
4306 If you decide to turn this variable on, you might well want to turn off
4307 `org-outline-path-complete-in-steps'.
4308 Note that this variable has only an effect if `org-completion-use-ido' is nil."
4309 :group 'org-completion
4310 :type 'boolean)
4312 (defcustom org-completion-fallback-command 'hippie-expand
4313 "The expansion command called by \\[pcomplete] in normal context.
4314 Normal means, no org-mode-specific context."
4315 :group 'org-completion
4316 :type 'function)
4318 ;;; Functions and variables from their packages
4319 ;; Declared here to avoid compiler warnings
4321 ;; XEmacs only
4322 (defvar outline-mode-menu-heading)
4323 (defvar outline-mode-menu-show)
4324 (defvar outline-mode-menu-hide)
4325 (defvar zmacs-regions) ; XEmacs regions
4327 ;; Emacs only
4328 (defvar mark-active)
4330 ;; Various packages
4331 (declare-function calendar-absolute-from-iso "cal-iso" (date))
4332 (declare-function calendar-forward-day "cal-move" (arg))
4333 (declare-function calendar-goto-date "cal-move" (date))
4334 (declare-function calendar-goto-today "cal-move" ())
4335 (declare-function calendar-iso-from-absolute "cal-iso" (date))
4336 (defvar calc-embedded-close-formula)
4337 (defvar calc-embedded-open-formula)
4338 (declare-function cdlatex-tab "ext:cdlatex" ())
4339 (declare-function cdlatex-compute-tables "ext:cdlatex" ())
4340 (declare-function dired-get-filename "dired" (&optional localp no-error-if-not-filep))
4341 (defvar font-lock-unfontify-region-function)
4342 (declare-function iswitchb-read-buffer "iswitchb"
4343 (prompt &optional default require-match start matches-set))
4344 (defvar iswitchb-temp-buflist)
4345 (declare-function org-gnus-follow-link "org-gnus" (&optional group article))
4346 (defvar org-agenda-tags-todo-honor-ignore-options)
4347 (declare-function org-agenda-skip "org-agenda" ())
4348 (declare-function
4349 org-agenda-format-item "org-agenda"
4350 (extra txt &optional level category tags dotime noprefix remove-re habitp))
4351 (declare-function org-agenda-new-marker "org-agenda" (&optional pos))
4352 (declare-function org-agenda-change-all-lines "org-agenda"
4353 (newhead hdmarker &optional fixface just-this))
4354 (declare-function org-agenda-set-restriction-lock "org-agenda" (&optional type))
4355 (declare-function org-agenda-maybe-redo "org-agenda" ())
4356 (declare-function org-agenda-save-markers-for-cut-and-paste "org-agenda"
4357 (beg end))
4358 (declare-function org-agenda-copy-local-variable "org-agenda" (var))
4359 (declare-function org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item
4360 "org-agenda" (&optional end))
4361 (declare-function org-inlinetask-remove-END-maybe "org-inlinetask" ())
4362 (declare-function org-inlinetask-in-task-p "org-inlinetask" ())
4363 (declare-function org-inlinetask-goto-beginning "org-inlinetask" ())
4364 (declare-function org-inlinetask-goto-end "org-inlinetask" ())
4365 (declare-function org-indent-mode "org-indent" (&optional arg))
4366 (declare-function parse-time-string "parse-time" (string))
4367 (declare-function org-attach-reveal "org-attach" (&optional if-exists))
4368 (declare-function orgtbl-send-table "org-table" (&optional maybe))
4369 (defvar remember-data-file)
4370 (defvar texmathp-why)
4371 (declare-function speedbar-line-directory "speedbar" (&optional depth))
4372 (declare-function table--at-cell-p "table" (position &optional object at-column))
4374 ;;;###autoload
4375 (defun turn-on-orgtbl ()
4376 "Unconditionally turn on `orgtbl-mode'."
4377 (require 'org-table)
4378 (orgtbl-mode 1))
4380 (defun org-at-table-p (&optional table-type)
4381 "Return t if the cursor is inside an org-type table.
4382 If TABLE-TYPE is non-nil, also check for table.el-type tables."
4383 (if org-enable-table-editor
4384 (save-excursion
4385 (beginning-of-line 1)
4386 (looking-at (if table-type org-table-any-line-regexp
4387 org-table-line-regexp)))
4388 nil))
4389 (defsubst org-table-p () (org-at-table-p))
4391 (defun org-at-table.el-p ()
4392 "Return t if and only if we are at a table.el table."
4393 (and (org-at-table-p 'any)
4394 (save-excursion
4395 (goto-char (org-table-begin 'any))
4396 (looking-at org-table1-hline-regexp))))
4398 (defun org-table-recognize-table.el ()
4399 "If there is a table.el table nearby, recognize it and move into it."
4400 (if org-table-tab-recognizes-table.el
4401 (if (org-at-table.el-p)
4402 (progn
4403 (beginning-of-line 1)
4404 (if (looking-at org-table-dataline-regexp)
4406 (if (looking-at org-table1-hline-regexp)
4407 (progn
4408 (beginning-of-line 2)
4409 (if (looking-at org-table-any-border-regexp)
4410 (beginning-of-line -1)))))
4411 (if (re-search-forward "|" (org-table-end t) t)
4412 (progn
4413 (require 'table)
4414 (if (table--at-cell-p (point))
4416 (message "recognizing table.el table...")
4417 (table-recognize-table)
4418 (message "recognizing table.el table...done")))
4419 (error "This should not happen"))
4421 nil)
4422 nil))
4424 (defun org-at-table-hline-p ()
4425 "Return t if the cursor is inside a hline in a table."
4426 (if org-enable-table-editor
4427 (save-excursion
4428 (beginning-of-line 1)
4429 (looking-at org-table-hline-regexp))
4430 nil))
4432 (defun org-table-map-tables (function &optional quietly)
4433 "Apply FUNCTION to the start of all tables in the buffer."
4434 (save-excursion
4435 (save-restriction
4436 (widen)
4437 (goto-char (point-min))
4438 (while (re-search-forward org-table-any-line-regexp nil t)
4439 (unless quietly
4440 (message "Mapping tables: %d%%" (/ (* 100.0 (point)) (buffer-size))))
4441 (beginning-of-line 1)
4442 (when (and (looking-at org-table-line-regexp)
4443 ;; Exclude tables in src/example/verbatim/clocktable blocks
4444 (not (org-in-block-p '("src" "example" "verbatim" "clocktable"))))
4445 (save-excursion (funcall function))
4446 (or (looking-at org-table-line-regexp)
4447 (forward-char 1)))
4448 (re-search-forward org-table-any-border-regexp nil 1))))
4449 (unless quietly (message "Mapping tables: done")))
4451 (declare-function org-clock-save-markers-for-cut-and-paste "org-clock" (beg end))
4452 (declare-function org-clock-update-mode-line "org-clock" ())
4453 (declare-function org-resolve-clocks "org-clock"
4454 (&optional also-non-dangling-p prompt last-valid))
4456 (defun org-at-TBLFM-p (&optional pos)
4457 "Return t when point (or POS) is in #+TBLFM line."
4458 (save-excursion
4459 (let ((pos pos)))
4460 (goto-char (or pos (point)))
4461 (beginning-of-line 1)
4462 (looking-at org-TBLFM-regexp)))
4464 (defvar org-clock-start-time)
4465 (defvar org-clock-marker (make-marker)
4466 "Marker recording the last clock-in.")
4467 (defvar org-clock-hd-marker (make-marker)
4468 "Marker recording the last clock-in, but the headline position.")
4469 (defvar org-clock-heading ""
4470 "The heading of the current clock entry.")
4471 (defun org-clock-is-active ()
4472 "Return the buffer where the clock is currently running.
4473 Return nil if no clock is running."
4474 (marker-buffer org-clock-marker))
4476 (defun org-check-running-clock ()
4477 "Check if the current buffer contains the running clock.
4478 If yes, offer to stop it and to save the buffer with the changes."
4479 (when (and (equal (marker-buffer org-clock-marker) (current-buffer))
4480 (y-or-n-p (format "Clock-out in buffer %s before killing it? "
4481 (buffer-name))))
4482 (org-clock-out)
4483 (when (y-or-n-p "Save changed buffer?")
4484 (save-buffer))))
4486 (defun org-clocktable-try-shift (dir n)
4487 "Check if this line starts a clock table, if yes, shift the time block."
4488 (when (org-match-line "^[ \t]*#\\+BEGIN:[ \t]+clocktable\\>")
4489 (org-clocktable-shift dir n)))
4491 ;;;###autoload
4492 (defun org-clock-persistence-insinuate ()
4493 "Set up hooks for clock persistence."
4494 (require 'org-clock)
4495 (add-hook 'org-mode-hook 'org-clock-load)
4496 (add-hook 'kill-emacs-hook 'org-clock-save))
4498 (defgroup org-archive nil
4499 "Options concerning archiving in Org-mode."
4500 :tag "Org Archive"
4501 :group 'org-structure)
4503 (defcustom org-archive-location "%s_archive::"
4504 "The location where subtrees should be archived.
4506 The value of this variable is a string, consisting of two parts,
4507 separated by a double-colon. The first part is a filename and
4508 the second part is a headline.
4510 When the filename is omitted, archiving happens in the same file.
4511 %s in the filename will be replaced by the current file
4512 name (without the directory part). Archiving to a different file
4513 is useful to keep archived entries from contributing to the
4514 Org-mode Agenda.
4516 The archived entries will be filed as subtrees of the specified
4517 headline. When the headline is omitted, the subtrees are simply
4518 filed away at the end of the file, as top-level entries. Also in
4519 the heading you can use %s to represent the file name, this can be
4520 useful when using the same archive for a number of different files.
4522 Here are a few examples:
4523 \"%s_archive::\"
4524 If the current file is Projects.org, archive in file
4525 Projects.org_archive, as top-level trees. This is the default.
4527 \"::* Archived Tasks\"
4528 Archive in the current file, under the top-level headline
4529 \"* Archived Tasks\".
4531 \"~/org/archive.org::\"
4532 Archive in file ~/org/archive.org (absolute path), as top-level trees.
4534 \"~/org/archive.org::* From %s\"
4535 Archive in file ~/org/archive.org (absolute path), under headlines
4536 \"From FILENAME\" where file name is the current file name.
4538 \"~/org/datetree.org::datetree/* Finished Tasks\"
4539 The \"datetree/\" string is special, signifying to archive
4540 items to the datetree. Items are placed in either the CLOSED
4541 date of the item, or the current date if there is no CLOSED date.
4542 The heading will be a subentry to the current date. There doesn't
4543 need to be a heading, but there always needs to be a slash after
4544 datetree. For example, to store archived items directly in the
4545 datetree, use \"~/org/datetree.org::datetree/\".
4547 \"basement::** Finished Tasks\"
4548 Archive in file ./basement (relative path), as level 3 trees
4549 below the level 2 heading \"** Finished Tasks\".
4551 You may set this option on a per-file basis by adding to the buffer a
4552 line like
4554 #+ARCHIVE: basement::** Finished Tasks
4556 You may also define it locally for a subtree by setting an ARCHIVE property
4557 in the entry. If such a property is found in an entry, or anywhere up
4558 the hierarchy, it will be used."
4559 :group 'org-archive
4560 :type 'string)
4562 (defcustom org-agenda-skip-archived-trees t
4563 "Non-nil means the agenda will skip any items located in archived trees.
4564 An archived tree is a tree marked with the tag ARCHIVE. The use of this
4565 variable is no longer recommended, you should leave it at the value t.
4566 Instead, use the key `v' to cycle the archives-mode in the agenda."
4567 :group 'org-archive
4568 :group 'org-agenda-skip
4569 :type 'boolean)
4571 (defcustom org-columns-skip-archived-trees t
4572 "Non-nil means ignore archived trees when creating column view."
4573 :group 'org-archive
4574 :group 'org-properties
4575 :type 'boolean)
4577 (defcustom org-cycle-open-archived-trees nil
4578 "Non-nil means `org-cycle' will open archived trees.
4579 An archived tree is a tree marked with the tag ARCHIVE.
4580 When nil, archived trees will stay folded. You can still open them with
4581 normal outline commands like `show-all', but not with the cycling commands."
4582 :group 'org-archive
4583 :group 'org-cycle
4584 :type 'boolean)
4586 (defcustom org-sparse-tree-open-archived-trees nil
4587 "Non-nil means sparse tree construction shows matches in archived trees.
4588 When nil, matches in these trees are highlighted, but the trees are kept in
4589 collapsed state."
4590 :group 'org-archive
4591 :group 'org-sparse-trees
4592 :type 'boolean)
4594 (defcustom org-sparse-tree-default-date-type 'scheduled-or-deadline
4595 "The default date type when building a sparse tree.
4596 When this is nil, a date is a scheduled or a deadline timestamp.
4597 Otherwise, these types are allowed:
4599 all: all timestamps
4600 active: only active timestamps (<...>)
4601 inactive: only inactive timestamps (<...)
4602 scheduled: only scheduled timestamps
4603 deadline: only deadline timestamps"
4604 :type '(choice (const :tag "Scheduled or deadline" scheduled-or-deadline)
4605 (const :tag "All timestamps" all)
4606 (const :tag "Only active timestamps" active)
4607 (const :tag "Only inactive timestamps" inactive)
4608 (const :tag "Only scheduled timestamps" scheduled)
4609 (const :tag "Only deadline timestamps" deadline)
4610 (const :tag "Only closed timestamps" closed))
4611 :version "24.3"
4612 :group 'org-sparse-trees)
4614 (defun org-cycle-hide-archived-subtrees (state)
4615 "Re-hide all archived subtrees after a visibility state change."
4616 (when (and (not org-cycle-open-archived-trees)
4617 (not (memq state '(overview folded))))
4618 (save-excursion
4619 (let* ((globalp (memq state '(contents all)))
4620 (beg (if globalp (point-min) (point)))
4621 (end (if globalp (point-max) (org-end-of-subtree t))))
4622 (org-hide-archived-subtrees beg end)
4623 (goto-char beg)
4624 (if (looking-at (concat ".*:" org-archive-tag ":"))
4625 (message "%s" (substitute-command-keys
4626 "Subtree is archived and stays closed. Use \\[org-force-cycle-archived] to cycle it anyway.")))))))
4628 (defun org-force-cycle-archived ()
4629 "Cycle subtree even if it is archived."
4630 (interactive)
4631 (setq this-command 'org-cycle)
4632 (let ((org-cycle-open-archived-trees t))
4633 (call-interactively 'org-cycle)))
4635 (defun org-hide-archived-subtrees (beg end)
4636 "Re-hide all archived subtrees after a visibility state change."
4637 (save-excursion
4638 (let* ((re (concat ":" org-archive-tag ":")))
4639 (goto-char beg)
4640 (while (re-search-forward re end t)
4641 (when (org-at-heading-p)
4642 (org-flag-subtree t)
4643 (org-end-of-subtree t))))))
4645 (declare-function outline-end-of-heading "outline" ())
4646 (declare-function outline-flag-region "outline" (from to flag))
4647 (defun org-flag-subtree (flag)
4648 (save-excursion
4649 (org-back-to-heading t)
4650 (outline-end-of-heading)
4651 (outline-flag-region (point)
4652 (progn (org-end-of-subtree t) (point))
4653 flag)))
4655 (defalias 'org-advertized-archive-subtree 'org-archive-subtree)
4657 ;; Declare Column View Code
4659 (declare-function org-columns-number-to-string "org-colview" (n fmt &optional printf))
4660 (declare-function org-columns-get-format-and-top-level "org-colview" ())
4661 (declare-function org-columns-compute "org-colview" (property))
4663 ;; Declare ID code
4665 (declare-function org-id-store-link "org-id")
4666 (declare-function org-id-locations-load "org-id")
4667 (declare-function org-id-locations-save "org-id")
4668 (defvar org-id-track-globally)
4670 ;;; Variables for pre-computed regular expressions, all buffer local
4672 (defvar org-todo-regexp nil
4673 "Matches any of the TODO state keywords.")
4674 (make-variable-buffer-local 'org-todo-regexp)
4675 (defvar org-not-done-regexp nil
4676 "Matches any of the TODO state keywords except the last one.")
4677 (make-variable-buffer-local 'org-not-done-regexp)
4678 (defvar org-not-done-heading-regexp nil
4679 "Matches a TODO headline that is not done.")
4680 (make-variable-buffer-local 'org-not-done-regexp)
4681 (defvar org-todo-line-regexp nil
4682 "Matches a headline and puts TODO state into group 2 if present.")
4683 (make-variable-buffer-local 'org-todo-line-regexp)
4684 (defvar org-complex-heading-regexp nil
4685 "Matches a headline and puts everything into groups:
4686 group 1: the stars
4687 group 2: The todo keyword, maybe
4688 group 3: Priority cookie
4689 group 4: True headline
4690 group 5: Tags")
4691 (make-variable-buffer-local 'org-complex-heading-regexp)
4692 (defvar org-complex-heading-regexp-format nil
4693 "Printf format to make regexp to match an exact headline.
4694 This regexp will match the headline of any node which has the
4695 exact headline text that is put into the format, but may have any
4696 TODO state, priority and tags.")
4697 (make-variable-buffer-local 'org-complex-heading-regexp-format)
4698 (defvar org-todo-line-tags-regexp nil
4699 "Matches a headline and puts TODO state into group 2 if present.
4700 Also put tags into group 4 if tags are present.")
4701 (make-variable-buffer-local 'org-todo-line-tags-regexp)
4702 (defvar org-ds-keyword-length 12
4703 "Maximum length of the DEADLINE and SCHEDULED keywords.")
4704 (make-variable-buffer-local 'org-ds-keyword-length)
4705 (defvar org-deadline-regexp nil
4706 "Matches the DEADLINE keyword.")
4707 (make-variable-buffer-local 'org-deadline-regexp)
4708 (defvar org-deadline-time-regexp nil
4709 "Matches the DEADLINE keyword together with a time stamp.")
4710 (make-variable-buffer-local 'org-deadline-time-regexp)
4711 (defvar org-deadline-time-hour-regexp nil
4712 "Matches the DEADLINE keyword together with a time-and-hour stamp.")
4713 (make-variable-buffer-local 'org-deadline-time-hour-regexp)
4714 (defvar org-deadline-line-regexp nil
4715 "Matches the DEADLINE keyword and the rest of the line.")
4716 (make-variable-buffer-local 'org-deadline-line-regexp)
4717 (defvar org-scheduled-regexp nil
4718 "Matches the SCHEDULED keyword.")
4719 (make-variable-buffer-local 'org-scheduled-regexp)
4720 (defvar org-scheduled-time-regexp nil
4721 "Matches the SCHEDULED keyword together with a time stamp.")
4722 (make-variable-buffer-local 'org-scheduled-time-regexp)
4723 (defvar org-scheduled-time-hour-regexp nil
4724 "Matches the SCHEDULED keyword together with a time-and-hour stamp.")
4725 (make-variable-buffer-local 'org-scheduled-time-hour-regexp)
4726 (defvar org-closed-time-regexp nil
4727 "Matches the CLOSED keyword together with a time stamp.")
4728 (make-variable-buffer-local 'org-closed-time-regexp)
4730 (defvar org-keyword-time-regexp nil
4731 "Matches any of the 4 keywords, together with the time stamp.")
4732 (make-variable-buffer-local 'org-keyword-time-regexp)
4733 (defvar org-keyword-time-not-clock-regexp nil
4734 "Matches any of the 3 keywords, together with the time stamp.")
4735 (make-variable-buffer-local 'org-keyword-time-not-clock-regexp)
4736 (defvar org-maybe-keyword-time-regexp nil
4737 "Matches a timestamp, possibly preceded by a keyword.")
4738 (make-variable-buffer-local 'org-maybe-keyword-time-regexp)
4739 (defvar org-all-time-keywords nil
4740 "List of time keywords.")
4741 (make-variable-buffer-local 'org-all-time-keywords)
4743 (defconst org-plain-time-of-day-regexp
4744 (concat
4745 "\\(\\<[012]?[0-9]"
4746 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4747 "\\(--?"
4748 "\\(\\<[012]?[0-9]"
4749 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4750 "\\)?")
4751 "Regular expression to match a plain time or time range.
4752 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4753 groups carry important information:
4754 0 the full match
4755 1 the first time, range or not
4756 8 the second time, if it is a range.")
4758 (defconst org-plain-time-extension-regexp
4759 (concat
4760 "\\(\\<[012]?[0-9]"
4761 "\\(\\(:\\([0-5][0-9]\\([AaPp][Mm]\\)?\\)\\)\\|\\([AaPp][Mm]\\)\\)\\>\\)"
4762 "\\+\\([0-9]+\\)\\(:\\([0-5][0-9]\\)\\)?")
4763 "Regular expression to match a time range like 13:30+2:10 = 13:30-15:40.
4764 Examples: 11:45 or 8am-13:15 or 2:45-2:45pm. After a match, the following
4765 groups carry important information:
4766 0 the full match
4767 7 hours of duration
4768 9 minutes of duration")
4770 (defconst org-stamp-time-of-day-regexp
4771 (concat
4772 "<\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} +\\sw+ +\\)"
4773 "\\([012][0-9]:[0-5][0-9]\\(-\\([012][0-9]:[0-5][0-9]\\)\\)?[^\n\r>]*?\\)>"
4774 "\\(--?"
4775 "<\\1\\([012][0-9]:[0-5][0-9]\\)>\\)?")
4776 "Regular expression to match a timestamp time or time range.
4777 After a match, the following groups carry important information:
4778 0 the full match
4779 1 date plus weekday, for back referencing to make sure both times are on the same day
4780 2 the first time, range or not
4781 4 the second time, if it is a range.")
4783 (defconst org-startup-options
4784 '(("fold" org-startup-folded t)
4785 ("overview" org-startup-folded t)
4786 ("nofold" org-startup-folded nil)
4787 ("showall" org-startup-folded nil)
4788 ("showeverything" org-startup-folded showeverything)
4789 ("content" org-startup-folded content)
4790 ("indent" org-startup-indented t)
4791 ("noindent" org-startup-indented nil)
4792 ("hidestars" org-hide-leading-stars t)
4793 ("showstars" org-hide-leading-stars nil)
4794 ("odd" org-odd-levels-only t)
4795 ("oddeven" org-odd-levels-only nil)
4796 ("align" org-startup-align-all-tables t)
4797 ("noalign" org-startup-align-all-tables nil)
4798 ("inlineimages" org-startup-with-inline-images t)
4799 ("noinlineimages" org-startup-with-inline-images nil)
4800 ("latexpreview" org-startup-with-latex-preview t)
4801 ("nolatexpreview" org-startup-with-latex-preview nil)
4802 ("customtime" org-display-custom-times t)
4803 ("logdone" org-log-done time)
4804 ("lognotedone" org-log-done note)
4805 ("nologdone" org-log-done nil)
4806 ("lognoteclock-out" org-log-note-clock-out t)
4807 ("nolognoteclock-out" org-log-note-clock-out nil)
4808 ("logrepeat" org-log-repeat state)
4809 ("lognoterepeat" org-log-repeat note)
4810 ("logdrawer" org-log-into-drawer t)
4811 ("nologdrawer" org-log-into-drawer nil)
4812 ("logstatesreversed" org-log-states-order-reversed t)
4813 ("nologstatesreversed" org-log-states-order-reversed nil)
4814 ("nologrepeat" org-log-repeat nil)
4815 ("logreschedule" org-log-reschedule time)
4816 ("lognotereschedule" org-log-reschedule note)
4817 ("nologreschedule" org-log-reschedule nil)
4818 ("logredeadline" org-log-redeadline time)
4819 ("lognoteredeadline" org-log-redeadline note)
4820 ("nologredeadline" org-log-redeadline nil)
4821 ("logrefile" org-log-refile time)
4822 ("lognoterefile" org-log-refile note)
4823 ("nologrefile" org-log-refile nil)
4824 ("fninline" org-footnote-define-inline t)
4825 ("nofninline" org-footnote-define-inline nil)
4826 ("fnlocal" org-footnote-section nil)
4827 ("fnauto" org-footnote-auto-label t)
4828 ("fnprompt" org-footnote-auto-label nil)
4829 ("fnconfirm" org-footnote-auto-label confirm)
4830 ("fnplain" org-footnote-auto-label plain)
4831 ("fnadjust" org-footnote-auto-adjust t)
4832 ("nofnadjust" org-footnote-auto-adjust nil)
4833 ("constcgs" constants-unit-system cgs)
4834 ("constSI" constants-unit-system SI)
4835 ("noptag" org-tag-persistent-alist nil)
4836 ("hideblocks" org-hide-block-startup t)
4837 ("nohideblocks" org-hide-block-startup nil)
4838 ("beamer" org-startup-with-beamer-mode t)
4839 ("entitiespretty" org-pretty-entities t)
4840 ("entitiesplain" org-pretty-entities nil))
4841 "Variable associated with STARTUP options for org-mode.
4842 Each element is a list of three items: the startup options (as written
4843 in the #+STARTUP line), the corresponding variable, and the value to set
4844 this variable to if the option is found. An optional forth element PUSH
4845 means to push this value onto the list in the variable.")
4847 (defun org-update-property-plist (key val props)
4848 "Update PROPS with KEY and VAL."
4849 (let* ((appending (string= "+" (substring key (- (length key) 1))))
4850 (key (if appending (substring key 0 (- (length key) 1)) key))
4851 (remainder (org-remove-if (lambda (p) (string= (car p) key)) props))
4852 (previous (cdr (assoc key props))))
4853 (if appending
4854 (cons (cons key (if previous (concat previous " " val) val)) remainder)
4855 (cons (cons key val) remainder))))
4857 (defcustom org-group-tags t
4858 "When non-nil (the default), use group tags.
4859 This can be turned on/off through `org-toggle-tags-groups'."
4860 :group 'org-tags
4861 :group 'org-startup
4862 :type 'boolean)
4864 (defvar org-inhibit-startup nil) ; Dynamically-scoped param.
4866 (defun org-toggle-tags-groups ()
4867 "Toggle support for group tags.
4868 Support for group tags is controlled by the option
4869 `org-group-tags', which is non-nil by default."
4870 (interactive)
4871 (setq org-group-tags (not org-group-tags))
4872 (cond ((and (derived-mode-p 'org-agenda-mode)
4873 org-group-tags)
4874 (org-agenda-redo))
4875 ((derived-mode-p 'org-mode)
4876 (let ((org-inhibit-startup t)) (org-mode))))
4877 (message "Groups tags support has been turned %s"
4878 (if org-group-tags "on" "off")))
4880 (defun org-set-regexps-and-options-for-tags ()
4881 "Precompute variables used for tags."
4882 (when (derived-mode-p 'org-mode)
4883 (org-set-local 'org-file-tags nil)
4884 (let ((re (org-make-options-regexp '("FILETAGS" "TAGS")))
4885 (splitre "[ \t]+")
4886 (start 0)
4887 tags ftags key value)
4888 (save-excursion
4889 (save-restriction
4890 (widen)
4891 (goto-char (point-min))
4892 (while (re-search-forward re nil t)
4893 (setq key (upcase (org-match-string-no-properties 1))
4894 value (org-match-string-no-properties 2))
4895 (if (stringp value) (setq value (org-trim value)))
4896 (cond
4897 ((equal key "TAGS")
4898 (setq tags (append tags (if tags '("\\n") nil)
4899 (org-split-string value splitre))))
4900 ((equal key "FILETAGS")
4901 (when (string-match "\\S-" value)
4902 (setq ftags
4903 (append
4904 ftags
4905 (apply 'append
4906 (mapcar (lambda (x) (org-split-string x ":"))
4907 (org-split-string value)))))))))))
4908 ;; Process the file tags.
4909 (and ftags (org-set-local 'org-file-tags
4910 (mapcar 'org-add-prop-inherited ftags)))
4911 (org-set-local 'org-tag-groups-alist nil)
4912 ;; Process the tags.
4913 (when (and (not tags) org-tag-alist)
4914 (setq tags
4915 (mapcar
4916 (lambda (tg) (cond ((eq (car tg) :startgroup) "{")
4917 ((eq (car tg) :endgroup) "}")
4918 ((eq (car tg) :grouptags) ":")
4919 ((eq (car tg) :newline) "\n")
4920 (t (concat (car tg)
4921 (if (characterp (cdr tg))
4922 (format "(%s)" (char-to-string (cdr tg))) "")))))
4923 org-tag-alist)))
4924 (let (e tgs g)
4925 (while (setq e (pop tags))
4926 (cond
4927 ((equal e "{")
4928 (progn (push '(:startgroup) tgs)
4929 (when (equal (nth 1 tags) ":")
4930 (push (list (replace-regexp-in-string
4931 "(.+)$" "" (nth 0 tags)))
4932 org-tag-groups-alist)
4933 (setq g 0))))
4934 ((equal e ":") (push '(:grouptags) tgs))
4935 ((equal e "}") (push '(:endgroup) tgs) (if g (setq g nil)))
4936 ((equal e "\\n") (push '(:newline) tgs))
4937 ((string-match (org-re "^\\([[:alnum:]_@#%]+\\)(\\(.\\))$") e)
4938 (push (cons (match-string 1 e)
4939 (string-to-char (match-string 2 e))) tgs)
4940 (if (and g (> g 0))
4941 (setcar org-tag-groups-alist
4942 (append (car org-tag-groups-alist)
4943 (list (match-string 1 e)))))
4944 (if g (setq g (1+ g))))
4945 (t (push (list e) tgs)
4946 (if (and g (> g 0))
4947 (setcar org-tag-groups-alist
4948 (append (car org-tag-groups-alist) (list e))))
4949 (if g (setq g (1+ g))))))
4950 (org-set-local 'org-tag-alist nil)
4951 (while (setq e (pop tgs))
4952 (or (and (stringp (car e))
4953 (assoc (car e) org-tag-alist))
4954 (push e org-tag-alist)))
4955 ;; Return a list with tag variables
4956 (list org-file-tags org-tag-alist org-tag-groups-alist)))))
4958 (defvar org-ota nil)
4959 (defun org-set-regexps-and-options ()
4960 "Precompute regular expressions used in the current buffer."
4961 (when (derived-mode-p 'org-mode)
4962 (org-set-local 'org-todo-kwd-alist nil)
4963 (org-set-local 'org-todo-key-alist nil)
4964 (org-set-local 'org-todo-key-trigger nil)
4965 (org-set-local 'org-todo-keywords-1 nil)
4966 (org-set-local 'org-done-keywords nil)
4967 (org-set-local 'org-todo-heads nil)
4968 (org-set-local 'org-todo-sets nil)
4969 (org-set-local 'org-todo-log-states nil)
4970 (org-set-local 'org-file-properties nil)
4971 (let ((re (org-make-options-regexp
4972 '("CATEGORY" "TODO" "COLUMNS" "STARTUP" "ARCHIVE"
4973 "LINK" "PRIORITIES" "CONSTANTS" "PROPERTY" "DRAWERS"
4974 "SETUPFILE" "OPTIONS")
4975 "\\(?:[a-zA-Z][0-9a-zA-Z_]*_TODO\\)"))
4976 (splitre "[ \t]+")
4977 (scripts org-use-sub-superscripts)
4978 kwds kws0 kwsa key log value cat arch const links hw dws
4979 tail sep kws1 prio props drawers ext-setup-or-nil setup-contents
4980 (start 0))
4981 (save-excursion
4982 (save-restriction
4983 (widen)
4984 (goto-char (point-min))
4985 (while
4986 (or (and
4987 ext-setup-or-nil
4988 (not org-ota)
4989 (let (ret)
4990 (with-temp-buffer
4991 (insert ext-setup-or-nil)
4992 (let ((major-mode 'org-mode) org-ota)
4993 (setq ret (save-match-data
4994 (org-set-regexps-and-options-for-tags)))))
4995 ;; Append setupfile tags to existing tags
4996 (setq org-ota t)
4997 (setq org-file-tags
4998 (delq nil (append org-file-tags (nth 0 ret)))
4999 org-tag-alist
5000 (delq nil (append org-tag-alist (nth 1 ret)))
5001 org-tag-groups-alist
5002 (delq nil (append org-tag-groups-alist (nth 2 ret))))))
5003 (and ext-setup-or-nil
5004 (string-match re ext-setup-or-nil start)
5005 (setq start (match-end 0)))
5006 (and (setq ext-setup-or-nil nil start 0)
5007 (re-search-forward re nil t)))
5008 (setq key (upcase (match-string 1 ext-setup-or-nil))
5009 value (org-match-string-no-properties 2 ext-setup-or-nil))
5010 (if (stringp value) (setq value (org-trim value)))
5011 (cond
5012 ((equal key "CATEGORY")
5013 (setq cat value))
5014 ((member key '("SEQ_TODO" "TODO"))
5015 (push (cons 'sequence (org-split-string value splitre)) kwds))
5016 ((equal key "TYP_TODO")
5017 (push (cons 'type (org-split-string value splitre)) kwds))
5018 ((string-match "\\`\\([a-zA-Z][0-9a-zA-Z_]*\\)_TODO\\'" key)
5019 ;; general TODO-like setup
5020 (push (cons (intern (downcase (match-string 1 key)))
5021 (org-split-string value splitre)) kwds))
5022 ((equal key "COLUMNS")
5023 (org-set-local 'org-columns-default-format value))
5024 ((equal key "LINK")
5025 (when (string-match "^\\(\\S-+\\)[ \t]+\\(.+\\)" value)
5026 (push (cons (match-string 1 value)
5027 (org-trim (match-string 2 value)))
5028 links)))
5029 ((equal key "PRIORITIES")
5030 (setq prio (org-split-string value " +")))
5031 ((equal key "PROPERTY")
5032 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5033 (setq props (org-update-property-plist (match-string 1 value)
5034 (match-string 2 value)
5035 props))))
5036 ((equal key "CONSTANTS")
5037 (org-table-set-constants))
5038 ((equal key "STARTUP")
5039 (let ((opts (org-split-string value splitre))
5040 l var val)
5041 (while (setq l (pop opts))
5042 (when (setq l (assoc l org-startup-options))
5043 (setq var (nth 1 l) val (nth 2 l))
5044 (if (not (nth 3 l))
5045 (set (make-local-variable var) val)
5046 (if (not (listp (symbol-value var)))
5047 (set (make-local-variable var) nil))
5048 (set (make-local-variable var) (symbol-value var))
5049 (add-to-list var val))))))
5050 ((equal key "ARCHIVE")
5051 (setq arch value)
5052 (remove-text-properties 0 (length arch)
5053 '(face t fontified t) arch))
5054 ((equal key "OPTIONS")
5055 (if (string-match "\\([ \t]\\|\\`\\)\\^:\\(t\\|nil\\|{}\\)" value)
5056 (setq scripts (read (match-string 2 value)))))
5057 ((and (equal key "SETUPFILE")
5058 ;; Prevent checking in Gnus messages
5059 (not buffer-read-only))
5060 (setq setup-contents (org-file-contents
5061 (expand-file-name
5062 (org-remove-double-quotes value))
5063 'noerror))
5064 (if (not ext-setup-or-nil)
5065 (setq ext-setup-or-nil setup-contents start 0)
5066 (setq ext-setup-or-nil
5067 (concat (substring ext-setup-or-nil 0 start)
5068 "\n" setup-contents "\n"
5069 (substring ext-setup-or-nil start)))))))
5070 ;; search for property blocks
5071 (goto-char (point-min))
5072 (while (re-search-forward org-block-regexp nil t)
5073 (when (equal "PROPERTY" (upcase (match-string 1)))
5074 (setq value (replace-regexp-in-string
5075 "[\n\r]" " " (match-string 4)))
5076 (when (string-match "\\(\\S-+\\)\\s-+\\(.*\\)" value)
5077 (setq props (org-update-property-plist (match-string 1 value)
5078 (match-string 2 value)
5079 props)))))))
5080 (org-set-local 'org-use-sub-superscripts scripts)
5081 (when cat
5082 (org-set-local 'org-category (intern cat))
5083 (push (cons "CATEGORY" cat) props))
5084 (when prio
5085 (if (< (length prio) 3) (setq prio '("A" "C" "B")))
5086 (setq prio (mapcar 'string-to-char prio))
5087 (org-set-local 'org-highest-priority (nth 0 prio))
5088 (org-set-local 'org-lowest-priority (nth 1 prio))
5089 (org-set-local 'org-default-priority (nth 2 prio)))
5090 (and props (org-set-local 'org-file-properties (nreverse props)))
5091 (and arch (org-set-local 'org-archive-location arch))
5092 (and links (setq org-link-abbrev-alist-local (nreverse links)))
5093 ;; Process the TODO keywords
5094 (unless kwds
5095 ;; Use the global values as if they had been given locally.
5096 (setq kwds (default-value 'org-todo-keywords))
5097 (if (stringp (car kwds))
5098 (setq kwds (list (cons org-todo-interpretation
5099 (default-value 'org-todo-keywords)))))
5100 (setq kwds (reverse kwds)))
5101 (setq kwds (nreverse kwds))
5102 (let (inter kws kw)
5103 (while (setq kws (pop kwds))
5104 (let ((kws (or
5105 (run-hook-with-args-until-success
5106 'org-todo-setup-filter-hook kws)
5107 kws)))
5108 (setq inter (pop kws) sep (member "|" kws)
5109 kws0 (delete "|" (copy-sequence kws))
5110 kwsa nil
5111 kws1 (mapcar
5112 (lambda (x)
5113 ;; 1 2
5114 (if (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?.*?)\\)?$" x)
5115 (progn
5116 (setq kw (match-string 1 x)
5117 key (and (match-end 2) (match-string 2 x))
5118 log (org-extract-log-state-settings x))
5119 (push (cons kw (and key (string-to-char key))) kwsa)
5120 (and log (push log org-todo-log-states))
5122 (error "Invalid TODO keyword %s" x)))
5123 kws0)
5124 kwsa (if kwsa (append '((:startgroup))
5125 (nreverse kwsa)
5126 '((:endgroup))))
5127 hw (car kws1)
5128 dws (if sep (org-remove-keyword-keys (cdr sep)) (last kws1))
5129 tail (list inter hw (car dws) (org-last dws))))
5130 (add-to-list 'org-todo-heads hw 'append)
5131 (push kws1 org-todo-sets)
5132 (setq org-done-keywords (append org-done-keywords dws nil))
5133 (setq org-todo-key-alist (append org-todo-key-alist kwsa))
5134 (mapc (lambda (x) (push (cons x tail) org-todo-kwd-alist)) kws1)
5135 (setq org-todo-keywords-1 (append org-todo-keywords-1 kws1 nil)))
5136 (setq org-todo-sets (nreverse org-todo-sets)
5137 org-todo-kwd-alist (nreverse org-todo-kwd-alist)
5138 org-todo-key-trigger (delq nil (mapcar 'cdr org-todo-key-alist))
5139 org-todo-key-alist (org-assign-fast-keys org-todo-key-alist)))
5140 ;; Compute the regular expressions and other local variables.
5141 ;; Using `org-outline-regexp-bol' would complicate them much,
5142 ;; because of the fixed white space at the end of that string.
5143 (if (not org-done-keywords)
5144 (setq org-done-keywords (and org-todo-keywords-1
5145 (list (org-last org-todo-keywords-1)))))
5146 (setq org-ds-keyword-length (+ 2 (max (length org-deadline-string)
5147 (length org-scheduled-string)
5148 (length org-clock-string)
5149 (length org-closed-string)))
5150 org-not-done-keywords
5151 (org-delete-all org-done-keywords (copy-sequence org-todo-keywords-1))
5152 org-todo-regexp
5153 (concat "\\("
5154 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
5155 "\\)")
5156 org-not-done-regexp
5157 (concat "\\("
5158 (mapconcat 'regexp-quote org-not-done-keywords "\\|")
5159 "\\)")
5160 org-not-done-heading-regexp
5161 (format org-heading-keyword-regexp-format org-not-done-regexp)
5162 org-todo-line-regexp
5163 (format org-heading-keyword-maybe-regexp-format org-todo-regexp)
5164 org-complex-heading-regexp
5165 (concat "^\\(\\*+\\)"
5166 "\\(?: +" org-todo-regexp "\\)?"
5167 "\\(?: +\\(\\[#.\\]\\)\\)?"
5168 "\\(?: +\\(.*?\\)\\)??"
5169 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)?")
5170 "[ \t]*$")
5171 org-complex-heading-regexp-format
5172 (concat "^\\(\\*+\\)"
5173 "\\(?: +" org-todo-regexp "\\)?"
5174 "\\(?: +\\(\\[#.\\]\\)\\)?"
5175 "\\(?: +"
5176 ;; Stats cookies can be stuck to body.
5177 "\\(?:\\[[0-9%%/]+\\] *\\)?"
5178 "\\(%s\\)"
5179 "\\(?: *\\[[0-9%%/]+\\]\\)?"
5180 "\\)"
5181 (org-re "\\(?:[ \t]+\\(:[[:alnum:]_@#%%:]+:\\)\\)?")
5182 "[ \t]*$")
5183 org-todo-line-tags-regexp
5184 (concat "^\\(\\*+\\)"
5185 "\\(?: +" org-todo-regexp "\\)?"
5186 "\\(?: +\\(.*?\\)\\)??"
5187 (org-re "\\(?:[ \t]+\\(:[[:alnum:]:_@#%]+:\\)\\)?")
5188 "[ \t]*$")
5189 org-deadline-regexp (concat "\\<" org-deadline-string)
5190 org-deadline-time-regexp
5191 (concat "\\<" org-deadline-string " *<\\([^>]+\\)>")
5192 org-deadline-time-hour-regexp
5193 (concat "\\<" org-deadline-string
5194 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5195 org-deadline-line-regexp
5196 (concat "\\<\\(" org-deadline-string "\\).*")
5197 org-scheduled-regexp
5198 (concat "\\<" org-scheduled-string)
5199 org-scheduled-time-regexp
5200 (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>")
5201 org-scheduled-time-hour-regexp
5202 (concat "\\<" org-scheduled-string
5203 " *<\\([^>]+[0-9]\\{1,2\\}:[0-9]\\{2\\}[0-9-+:hdwmy \t.]*\\)>")
5204 org-closed-time-regexp
5205 (concat "\\<" org-closed-string " *\\[\\([^]]+\\)\\]")
5206 org-keyword-time-regexp
5207 (concat "\\<\\(" org-scheduled-string
5208 "\\|" org-deadline-string
5209 "\\|" org-closed-string
5210 "\\|" org-clock-string "\\)"
5211 " *[[<]\\([^]>]+\\)[]>]")
5212 org-keyword-time-not-clock-regexp
5213 (concat "\\<\\(" org-scheduled-string
5214 "\\|" org-deadline-string
5215 "\\|" org-closed-string
5216 "\\)"
5217 " *[[<]\\([^]>]+\\)[]>]")
5218 org-maybe-keyword-time-regexp
5219 (concat "\\(\\<\\(" org-scheduled-string
5220 "\\|" org-deadline-string
5221 "\\|" org-closed-string
5222 "\\|" org-clock-string "\\)\\)?"
5223 " *\\([[<][0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^]\r\n>]*?[]>]\\|<%%([^\r\n>]*>\\)")
5224 org-all-time-keywords
5225 (mapcar (lambda (w) (substring w 0 -1))
5226 (list org-scheduled-string org-deadline-string
5227 org-clock-string org-closed-string)))
5228 (setq org-ota nil)
5229 (org-compute-latex-and-related-regexp))))
5231 (defun org-file-contents (file &optional noerror)
5232 "Return the contents of FILE, as a string."
5233 (if (and file (file-readable-p file))
5234 (with-temp-buffer
5235 (insert-file-contents file)
5236 (buffer-string))
5237 (funcall (if noerror #'message #'error)
5238 "Cannot read file \"%s\"%s"
5239 file
5240 (let ((from (buffer-file-name (buffer-base-buffer))))
5241 (if from (concat " (referenced in file \"" from "\")") "")))))
5243 (defun org-extract-log-state-settings (x)
5244 "Extract the log state setting from a TODO keyword string.
5245 This will extract info from a string like \"WAIT(w@/!)\"."
5246 (let (kw key log1 log2)
5247 (when (string-match "^\\(.*?\\)\\(?:(\\([^!@/]\\)?\\([!@]\\)?\\(?:/\\([!@]\\)\\)?)\\)?$" x)
5248 (setq kw (match-string 1 x)
5249 key (and (match-end 2) (match-string 2 x))
5250 log1 (and (match-end 3) (match-string 3 x))
5251 log2 (and (match-end 4) (match-string 4 x)))
5252 (and (or log1 log2)
5253 (list kw
5254 (and log1 (if (equal log1 "!") 'time 'note))
5255 (and log2 (if (equal log2 "!") 'time 'note)))))))
5257 (defun org-remove-keyword-keys (list)
5258 "Remove a pair of parenthesis at the end of each string in LIST."
5259 (mapcar (lambda (x)
5260 (if (string-match "(.*)$" x)
5261 (substring x 0 (match-beginning 0))
5263 list))
5265 (defun org-assign-fast-keys (alist)
5266 "Assign fast keys to a keyword-key alist.
5267 Respect keys that are already there."
5268 (let (new e (alt ?0))
5269 (while (setq e (pop alist))
5270 (if (or (memq (car e) '(:newline :grouptags :endgroup :startgroup))
5271 (cdr e)) ;; Key already assigned.
5272 (push e new)
5273 (let ((clist (string-to-list (downcase (car e))))
5274 (used (append new alist)))
5275 (when (= (car clist) ?@)
5276 (pop clist))
5277 (while (and clist (rassoc (car clist) used))
5278 (pop clist))
5279 (unless clist
5280 (while (rassoc alt used)
5281 (incf alt)))
5282 (push (cons (car e) (or (car clist) alt)) new))))
5283 (nreverse new)))
5285 ;;; Some variables used in various places
5287 (defvar org-window-configuration nil
5288 "Used in various places to store a window configuration.")
5289 (defvar org-selected-window nil
5290 "Used in various places to store a window configuration.")
5291 (defvar org-finish-function nil
5292 "Function to be called when `C-c C-c' is used.
5293 This is for getting out of special buffers like capture.")
5296 ;; FIXME: Occasionally check by commenting these, to make sure
5297 ;; no other functions uses these, forgetting to let-bind them.
5298 (org-no-warnings (defvar entry)) ;; unprefixed, from calendar.el
5299 (defvar org-last-state)
5300 (org-no-warnings (defvar date)) ;; unprefixed, from calendar.el
5302 ;; Defined somewhere in this file, but used before definition.
5303 (defvar org-entities) ;; defined in org-entities.el
5304 (defvar org-struct-menu)
5305 (defvar org-org-menu)
5306 (defvar org-tbl-menu)
5308 ;;;; Define the Org-mode
5310 ;; We use a before-change function to check if a table might need
5311 ;; an update.
5312 (defvar org-table-may-need-update t
5313 "Indicates that a table might need an update.
5314 This variable is set by `org-before-change-function'.
5315 `org-table-align' sets it back to nil.")
5316 (defun org-before-change-function (beg end)
5317 "Every change indicates that a table might need an update."
5318 (setq org-table-may-need-update t))
5319 (defvar org-mode-map)
5320 (defvar org-inhibit-startup-visibility-stuff nil) ; Dynamically-scoped param.
5321 (defvar org-agenda-keep-modes nil) ; Dynamically-scoped param.
5322 (defvar org-inhibit-logging nil) ; Dynamically-scoped param.
5323 (defvar org-inhibit-blocking nil) ; Dynamically-scoped param.
5324 (defvar org-table-buffer-is-an nil)
5326 (defvar bidi-paragraph-direction)
5327 (defvar buffer-face-mode-face)
5329 (require 'outline)
5330 (if (and (not (keymapp outline-mode-map)) (featurep 'allout))
5331 (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"))
5332 (require 'noutline "noutline" 'noerror) ;; stock XEmacs does not have it
5334 ;; Other stuff we need.
5335 (require 'time-date)
5336 (unless (fboundp 'time-subtract) (defalias 'time-subtract 'subtract-time))
5337 (require 'easymenu)
5338 (require 'overlay)
5340 ;; (require 'org-macs) moved higher up in the file before it is first used
5341 (require 'org-entities)
5342 ;; (require 'org-compat) moved higher up in the file before it is first used
5343 (require 'org-faces)
5344 (require 'org-list)
5345 (require 'org-pcomplete)
5346 (require 'org-src)
5347 (require 'org-footnote)
5348 (require 'org-macro)
5350 ;; babel
5351 (require 'ob)
5353 ;;;###autoload
5354 (define-derived-mode org-mode outline-mode "Org"
5355 "Outline-based notes management and organizer, alias
5356 \"Carsten's outline-mode for keeping track of everything.\"
5358 Org-mode develops organizational tasks around a NOTES file which
5359 contains information about projects as plain text. Org-mode is
5360 implemented on top of outline-mode, which is ideal to keep the content
5361 of large files well structured. It supports ToDo items, deadlines and
5362 time stamps, which magically appear in the diary listing of the Emacs
5363 calendar. Tables are easily created with a built-in table editor.
5364 Plain text URL-like links connect to websites, emails (VM), Usenet
5365 messages (Gnus), BBDB entries, and any files related to the project.
5366 For printing and sharing of notes, an Org-mode file (or a part of it)
5367 can be exported as a structured ASCII or HTML file.
5369 The following commands are available:
5371 \\{org-mode-map}"
5373 ;; Get rid of Outline menus, they are not needed
5374 ;; Need to do this here because define-derived-mode sets up
5375 ;; the keymap so late. Still, it is a waste to call this each time
5376 ;; we switch another buffer into org-mode.
5377 (if (featurep 'xemacs)
5378 (when (boundp 'outline-mode-menu-heading)
5379 ;; Assume this is Greg's port, it uses easymenu
5380 (easy-menu-remove outline-mode-menu-heading)
5381 (easy-menu-remove outline-mode-menu-show)
5382 (easy-menu-remove outline-mode-menu-hide))
5383 (define-key org-mode-map [menu-bar headings] 'undefined)
5384 (define-key org-mode-map [menu-bar hide] 'undefined)
5385 (define-key org-mode-map [menu-bar show] 'undefined))
5387 (org-load-modules-maybe)
5388 (easy-menu-add org-org-menu)
5389 (easy-menu-add org-tbl-menu)
5390 (org-install-agenda-files-menu)
5391 (if org-descriptive-links (add-to-invisibility-spec '(org-link)))
5392 (add-to-invisibility-spec '(org-cwidth))
5393 (add-to-invisibility-spec '(org-hide-block . t))
5394 (when (featurep 'xemacs)
5395 (org-set-local 'line-move-ignore-invisible t))
5396 (org-set-local 'outline-regexp org-outline-regexp)
5397 (org-set-local 'outline-level 'org-outline-level)
5398 (setq bidi-paragraph-direction 'left-to-right)
5399 (when (and org-ellipsis
5400 (fboundp 'set-display-table-slot) (boundp 'buffer-display-table)
5401 (fboundp 'make-glyph-code))
5402 (unless org-display-table
5403 (setq org-display-table (make-display-table)))
5404 (set-display-table-slot
5405 org-display-table 4
5406 (vconcat (mapcar
5407 (lambda (c) (make-glyph-code c (and (not (stringp org-ellipsis))
5408 org-ellipsis)))
5409 (if (stringp org-ellipsis) org-ellipsis "..."))))
5410 (setq buffer-display-table org-display-table))
5411 (org-set-regexps-and-options-for-tags)
5412 (org-set-regexps-and-options)
5413 (org-set-font-lock-defaults)
5414 (when (and org-tag-faces (not org-tags-special-faces-re))
5415 ;; tag faces set outside customize.... force initialization.
5416 (org-set-tag-faces 'org-tag-faces org-tag-faces))
5417 ;; Calc embedded
5418 (org-set-local 'calc-embedded-open-mode "# ")
5419 ;; Modify a few syntax entries
5420 (modify-syntax-entry ?@ "w")
5421 (modify-syntax-entry ?\" "\"")
5422 (if org-startup-truncated (setq truncate-lines t))
5423 (when org-startup-indented (require 'org-indent) (org-indent-mode 1))
5424 (org-set-local 'font-lock-unfontify-region-function
5425 'org-unfontify-region)
5426 ;; Activate before-change-function
5427 (org-set-local 'org-table-may-need-update t)
5428 (org-add-hook 'before-change-functions 'org-before-change-function nil
5429 'local)
5430 ;; Check for running clock before killing a buffer
5431 (org-add-hook 'kill-buffer-hook 'org-check-running-clock nil 'local)
5432 ;; Initialize macros templates.
5433 (org-macro-initialize-templates)
5434 ;; Initialize radio targets.
5435 (org-update-radio-target-regexp)
5436 ;; Indentation.
5437 (org-set-local 'indent-line-function 'org-indent-line)
5438 (org-set-local 'indent-region-function 'org-indent-region)
5439 ;; Filling and auto-filling.
5440 (org-setup-filling)
5441 ;; Comments.
5442 (org-setup-comments-handling)
5443 ;; Initialize cache.
5444 (org-element-cache-reset)
5445 ;; Beginning/end of defun
5446 (org-set-local 'beginning-of-defun-function 'org-backward-element)
5447 (org-set-local 'end-of-defun-function 'org-forward-element)
5448 ;; Next error for sparse trees
5449 (org-set-local 'next-error-function 'org-occur-next-match)
5450 ;; Make sure dependence stuff works reliably, even for users who set it
5451 ;; too late :-(
5452 (if org-enforce-todo-dependencies
5453 (add-hook 'org-blocker-hook
5454 'org-block-todo-from-children-or-siblings-or-parent)
5455 (remove-hook 'org-blocker-hook
5456 'org-block-todo-from-children-or-siblings-or-parent))
5457 (if org-enforce-todo-checkbox-dependencies
5458 (add-hook 'org-blocker-hook
5459 'org-block-todo-from-checkboxes)
5460 (remove-hook 'org-blocker-hook
5461 'org-block-todo-from-checkboxes))
5463 ;; Align options lines
5464 (org-set-local
5465 'align-mode-rules-list
5466 '((org-in-buffer-settings
5467 (regexp . "^#\\+[A-Z_]+:\\(\\s-*\\)\\S-+")
5468 (modes . '(org-mode)))))
5470 ;; Imenu
5471 (org-set-local 'imenu-create-index-function
5472 'org-imenu-get-tree)
5474 ;; Make isearch reveal context
5475 (if (or (featurep 'xemacs)
5476 (not (boundp 'outline-isearch-open-invisible-function)))
5477 ;; Emacs 21 and XEmacs make use of the hook
5478 (org-add-hook 'isearch-mode-end-hook 'org-isearch-end 'append 'local)
5479 ;; Emacs 22 deals with this through a special variable
5480 (org-set-local 'outline-isearch-open-invisible-function
5481 (lambda (&rest ignore) (org-show-context 'isearch)))
5482 (org-add-hook 'isearch-mode-end-hook 'org-fix-ellipsis-at-bol 'append 'local))
5484 ;; Setup the pcomplete hooks
5485 (set (make-local-variable 'pcomplete-command-completion-function)
5486 'org-pcomplete-initial)
5487 (set (make-local-variable 'pcomplete-command-name-function)
5488 'org-command-at-point)
5489 (set (make-local-variable 'pcomplete-default-completion-function)
5490 'ignore)
5491 (set (make-local-variable 'pcomplete-parse-arguments-function)
5492 'org-parse-arguments)
5493 (set (make-local-variable 'pcomplete-termination-string) "")
5494 (when (>= emacs-major-version 23)
5495 (set (make-local-variable 'buffer-face-mode-face) 'org-default))
5497 ;; If empty file that did not turn on org-mode automatically, make it to.
5498 (if (and org-insert-mode-line-in-empty-file
5499 (org-called-interactively-p 'any)
5500 (= (point-min) (point-max)))
5501 (insert "# -*- mode: org -*-\n\n"))
5502 (unless org-inhibit-startup
5503 (org-unmodified
5504 (and org-startup-with-beamer-mode (org-beamer-mode))
5505 (when org-startup-align-all-tables
5506 (org-table-map-tables 'org-table-align 'quietly))
5507 (when org-startup-with-inline-images
5508 (org-display-inline-images))
5509 (when org-startup-with-latex-preview
5510 (org-preview-latex-fragment))
5511 (unless org-inhibit-startup-visibility-stuff
5512 (org-set-startup-visibility))))
5513 ;; Try to set org-hide correctly
5514 (set-face-foreground 'org-hide (org-find-invisible-foreground)))
5516 ;; Update `customize-package-emacs-version-alist'
5517 (add-to-list 'customize-package-emacs-version-alist
5518 '(Org ("6.21b" . "23.1") ("6.33x" . "23.2")
5519 ("7.8.11" . "24.1") ("7.9.4" . "24.3")
5520 ("8.2.6" . "24.4")))
5522 (defvar org-mode-transpose-word-syntax-table
5523 (let ((st (make-syntax-table)))
5524 (mapc (lambda(c) (modify-syntax-entry
5525 (string-to-char (car c)) "w p" st))
5526 org-emphasis-alist)
5527 st))
5529 (when (fboundp 'abbrev-table-put)
5530 (abbrev-table-put org-mode-abbrev-table
5531 :parents (list text-mode-abbrev-table)))
5533 (defsubst org-fix-ellipsis-at-bol ()
5534 (save-excursion (goto-char (window-start)) (recenter 0)))
5536 (defun org-find-invisible-foreground ()
5537 (let ((candidates (remove
5538 "unspecified-bg"
5539 (nconc
5540 (list (face-background 'default)
5541 (face-background 'org-default))
5542 (mapcar
5543 (lambda (alist)
5544 (when (boundp alist)
5545 (cdr (assoc 'background-color (symbol-value alist)))))
5546 '(default-frame-alist initial-frame-alist window-system-default-frame-alist))
5547 (list (face-foreground 'org-hide))))))
5548 (car (remove nil candidates))))
5550 (defun org-current-time (&optional rounding-minutes past)
5551 "Current time, possibly rounded to ROUNDING-MINUTES.
5552 When ROUNDING-MINUTES is not an integer, fall back on the car of
5553 `org-time-stamp-rounding-minutes'. When PAST is non-nil, ensure
5554 the rounding returns a past time."
5555 (let ((r (or (and (integerp rounding-minutes) rounding-minutes)
5556 (car org-time-stamp-rounding-minutes)))
5557 (time (decode-time)) res)
5558 (if (< r 1)
5559 (current-time)
5560 (setq res
5561 (apply 'encode-time
5562 (append (list 0 (* r (floor (+ .5 (/ (float (nth 1 time)) r)))))
5563 (nthcdr 2 time))))
5564 (if (and past (< (org-float-time (time-subtract (current-time) res)) 0))
5565 (seconds-to-time (- (org-float-time res) (* r 60)))
5566 res))))
5568 (defun org-today ()
5569 "Return today date, considering `org-extend-today-until'."
5570 (time-to-days
5571 (time-subtract (current-time)
5572 (list 0 (* 3600 org-extend-today-until) 0))))
5574 ;;;; Font-Lock stuff, including the activators
5576 (defvar org-mouse-map (make-sparse-keymap))
5577 (org-defkey org-mouse-map [mouse-2] 'org-open-at-mouse)
5578 (org-defkey org-mouse-map [mouse-3] 'org-find-file-at-mouse)
5579 (when org-mouse-1-follows-link
5580 (org-defkey org-mouse-map [follow-link] 'mouse-face))
5581 (when org-tab-follows-link
5582 (org-defkey org-mouse-map [(tab)] 'org-open-at-point)
5583 (org-defkey org-mouse-map "\C-i" 'org-open-at-point))
5585 (require 'font-lock)
5587 (defconst org-non-link-chars "]\t\n\r<>")
5588 (defvar org-link-types '("http" "https" "ftp" "mailto" "file" "news"
5589 "shell" "elisp" "doi" "message" "help"))
5590 (defvar org-link-types-re nil
5591 "Matches a link that has a url-like prefix like \"http:\"")
5592 (defvar org-link-re-with-space nil
5593 "Matches a link with spaces, optional angular brackets around it.")
5594 (defvar org-link-re-with-space2 nil
5595 "Matches a link with spaces, optional angular brackets around it.")
5596 (defvar org-link-re-with-space3 nil
5597 "Matches a link with spaces, only for internal part in bracket links.")
5598 (defvar org-angle-link-re nil
5599 "Matches link with angular brackets, spaces are allowed.")
5600 (defvar org-plain-link-re nil
5601 "Matches plain link, without spaces.")
5602 (defvar org-bracket-link-regexp nil
5603 "Matches a link in double brackets.")
5604 (defvar org-bracket-link-analytic-regexp nil
5605 "Regular expression used to analyze links.
5606 Here is what the match groups contain after a match:
5607 1: http:
5608 2: http
5609 3: path
5610 4: [desc]
5611 5: desc")
5612 (defvar org-bracket-link-analytic-regexp++ nil
5613 "Like `org-bracket-link-analytic-regexp', but include coderef internal type.")
5614 (defvar org-any-link-re nil
5615 "Regular expression matching any link.")
5617 (defconst org-match-sexp-depth 3
5618 "Number of stacked braces for sub/superscript matching.")
5620 (defun org-create-multibrace-regexp (left right n)
5621 "Create a regular expression which will match a balanced sexp.
5622 Opening delimiter is LEFT, and closing delimiter is RIGHT, both given
5623 as single character strings.
5624 The regexp returned will match the entire expression including the
5625 delimiters. It will also define a single group which contains the
5626 match except for the outermost delimiters. The maximum depth of
5627 stacked delimiters is N. Escaping delimiters is not possible."
5628 (let* ((nothing (concat "[^" left right "]*?"))
5629 (or "\\|")
5630 (re nothing)
5631 (next (concat "\\(?:" nothing left nothing right "\\)+" nothing)))
5632 (while (> n 1)
5633 (setq n (1- n)
5634 re (concat re or next)
5635 next (concat "\\(?:" nothing left next right "\\)+" nothing)))
5636 (concat left "\\(" re "\\)" right)))
5638 (defconst org-match-substring-regexp
5639 (concat
5640 "\\(\\S-\\)\\([_^]\\)\\("
5641 "\\(?:" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)"
5642 "\\|"
5643 "\\(?:" (org-create-multibrace-regexp "(" ")" org-match-sexp-depth) "\\)"
5644 "\\|"
5645 "\\(?:\\*\\|[+-]?[[:alnum:].,\\]*[[:alnum:]]\\)\\)")
5646 "The regular expression matching a sub- or superscript.")
5648 (defconst org-match-substring-with-braces-regexp
5649 (concat
5650 "\\(\\S-\\)\\([_^]\\)"
5651 "\\(" (org-create-multibrace-regexp "{" "}" org-match-sexp-depth) "\\)")
5652 "The regular expression matching a sub- or superscript, forcing braces.")
5654 (defun org-make-link-regexps ()
5655 "Update the link regular expressions.
5656 This should be called after the variable `org-link-types' has changed."
5657 (setq org-link-types-re
5658 (concat
5659 "\\`\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):")
5660 org-link-re-with-space
5661 (concat
5662 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5663 "\\([^" org-non-link-chars " ]"
5664 "[^" org-non-link-chars "]*"
5665 "[^" org-non-link-chars " ]\\)>?")
5666 org-link-re-with-space2
5667 (concat
5668 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5669 "\\([^" org-non-link-chars " ]"
5670 "[^\t\n\r]*"
5671 "[^" org-non-link-chars " ]\\)>?")
5672 org-link-re-with-space3
5673 (concat
5674 "<?\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5675 "\\([^" org-non-link-chars " ]"
5676 "[^\t\n\r]*\\)")
5677 org-angle-link-re
5678 (concat
5679 "<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5680 "\\([^" org-non-link-chars " ]"
5681 "[^" org-non-link-chars "]*"
5682 "\\)>")
5683 org-plain-link-re
5684 (concat
5685 "\\<\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):"
5686 (org-re "\\([^ \t\n()<>]+\\(?:([[:word:]0-9_]+)\\|\\([^[:punct:] \t\n]\\|/\\)\\)\\)"))
5687 ;; "\\([^]\t\n\r<>() ]+[^]\t\n\r<>,.;() ]\\)")
5688 org-bracket-link-regexp
5689 "\\[\\[\\([^][]+\\)\\]\\(\\[\\([^][]+\\)\\]\\)?\\]"
5690 org-bracket-link-analytic-regexp
5691 (concat
5692 "\\[\\["
5693 "\\(\\(" (mapconcat 'regexp-quote org-link-types "\\|") "\\):\\)?"
5694 "\\([^]]+\\)"
5695 "\\]"
5696 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5697 "\\]")
5698 org-bracket-link-analytic-regexp++
5699 (concat
5700 "\\[\\["
5701 "\\(\\(" (mapconcat 'regexp-quote (cons "coderef" org-link-types) "\\|") "\\):\\)?"
5702 "\\([^]]+\\)"
5703 "\\]"
5704 "\\(\\[" "\\([^]]+\\)" "\\]\\)?"
5705 "\\]")
5706 org-any-link-re
5707 (concat "\\(" org-bracket-link-regexp "\\)\\|\\("
5708 org-angle-link-re "\\)\\|\\("
5709 org-plain-link-re "\\)")))
5711 (org-make-link-regexps)
5713 (defvar org-emph-face nil)
5715 (defun org-do-emphasis-faces (limit)
5716 "Run through the buffer and add overlays to emphasized strings."
5717 (let (rtn a)
5718 (while (and (not rtn) (re-search-forward org-emph-re limit t))
5719 (if (not (= (char-after (match-beginning 3))
5720 (char-after (match-beginning 4))))
5721 (progn
5722 (setq rtn t)
5723 (setq a (assoc (match-string 3) org-emphasis-alist))
5724 (font-lock-prepend-text-property (match-beginning 2) (match-end 2)
5725 'face
5726 (nth 1 a))
5727 (and (nth 2 a)
5728 (org-remove-flyspell-overlays-in
5729 (match-beginning 0) (match-end 0)))
5730 (add-text-properties (match-beginning 2) (match-end 2)
5731 '(font-lock-multiline t org-emphasis t))
5732 (when org-hide-emphasis-markers
5733 (add-text-properties (match-end 4) (match-beginning 5)
5734 '(invisible org-link))
5735 (add-text-properties (match-beginning 3) (match-end 3)
5736 '(invisible org-link)))))
5737 (goto-char (1+ (match-beginning 0))))
5738 rtn))
5740 (defun org-emphasize (&optional char)
5741 "Insert or change an emphasis, i.e. a font like bold or italic.
5742 If there is an active region, change that region to a new emphasis.
5743 If there is no region, just insert the marker characters and position
5744 the cursor between them.
5745 CHAR should be the marker character. If it is a space, it means to
5746 remove the emphasis of the selected region.
5747 If CHAR is not given (for example in an interactive call) it will be
5748 prompted for."
5749 (interactive)
5750 (let ((erc org-emphasis-regexp-components)
5751 (prompt "")
5752 (string "") beg end move c s)
5753 (if (org-region-active-p)
5754 (setq beg (region-beginning) end (region-end)
5755 string (buffer-substring beg end))
5756 (setq move t))
5758 (unless char
5759 (message "Emphasis marker or tag: [%s]"
5760 (mapconcat (lambda(e) (car e)) org-emphasis-alist ""))
5761 (setq char (read-char-exclusive)))
5762 (if (equal char ?\ )
5763 (setq s "" move nil)
5764 (unless (assoc (char-to-string char) org-emphasis-alist)
5765 (user-error "No such emphasis marker: \"%c\"" char))
5766 (setq s (char-to-string char)))
5767 (while (and (> (length string) 1)
5768 (equal (substring string 0 1) (substring string -1))
5769 (assoc (substring string 0 1) org-emphasis-alist))
5770 (setq string (substring string 1 -1)))
5771 (setq string (concat s string s))
5772 (if beg (delete-region beg end))
5773 (unless (or (bolp)
5774 (string-match (concat "[" (nth 0 erc) "\n]")
5775 (char-to-string (char-before (point)))))
5776 (insert " "))
5777 (unless (or (eobp)
5778 (string-match (concat "[" (nth 1 erc) "\n]")
5779 (char-to-string (char-after (point)))))
5780 (insert " ") (backward-char 1))
5781 (insert string)
5782 (and move (backward-char 1))))
5784 (defconst org-nonsticky-props
5785 '(mouse-face highlight keymap invisible intangible help-echo org-linked-text htmlize-link))
5787 (defsubst org-rear-nonsticky-at (pos)
5788 (add-text-properties (1- pos) pos (list 'rear-nonsticky org-nonsticky-props)))
5790 (defun org-activate-plain-links (limit)
5791 "Run through the buffer and add overlays to links."
5792 (let (f hl)
5793 (when (and (re-search-forward (concat org-plain-link-re) limit t)
5794 (not (org-in-src-block-p)))
5795 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5796 (setq f (get-text-property (match-beginning 0) 'face))
5797 (setq hl (org-match-string-no-properties 0))
5798 (if (or (eq f 'org-tag)
5799 (and (listp f) (memq 'org-tag f)))
5801 (add-text-properties (match-beginning 0) (match-end 0)
5802 (list 'mouse-face 'highlight
5803 'face 'org-link
5804 'htmlize-link `(:uri ,hl)
5805 'keymap org-mouse-map))
5806 (org-rear-nonsticky-at (match-end 0)))
5807 t)))
5809 (defun org-activate-code (limit)
5810 (if (re-search-forward "^[ \t]*\\(:\\(?: .*\\|$\\)\n?\\)" limit t)
5811 (progn
5812 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5813 (remove-text-properties (match-beginning 0) (match-end 0)
5814 '(display t invisible t intangible t))
5815 t)))
5817 (defcustom org-src-fontify-natively t
5818 "When non-nil, fontify code in code blocks."
5819 :type 'boolean
5820 :version "24.4"
5821 :package-version '(Org . "8.3")
5822 :group 'org-appearance
5823 :group 'org-babel)
5825 (defcustom org-allow-promoting-top-level-subtree nil
5826 "When non-nil, allow promoting a top level subtree.
5827 The leading star of the top level headline will be replaced
5828 by a #."
5829 :type 'boolean
5830 :version "24.1"
5831 :group 'org-appearance)
5833 (defun org-fontify-meta-lines-and-blocks (limit)
5834 (condition-case nil
5835 (org-fontify-meta-lines-and-blocks-1 limit)
5836 (error (message "org-mode fontification error"))))
5838 (defun org-fontify-meta-lines-and-blocks-1 (limit)
5839 "Fontify #+ lines and blocks."
5840 (let ((case-fold-search t))
5841 (if (re-search-forward
5842 "^\\([ \t]*#\\(\\(\\+[a-zA-Z]+:?\\| \\|$\\)\\(_\\([a-zA-Z]+\\)\\)?\\)[ \t]*\\(\\([^ \t\n]*\\)[ \t]*\\(.*\\)\\)\\)"
5843 limit t)
5844 (let ((beg (match-beginning 0))
5845 (block-start (match-end 0))
5846 (block-end nil)
5847 (lang (match-string 7))
5848 (beg1 (line-beginning-position 2))
5849 (dc1 (downcase (match-string 2)))
5850 (dc3 (downcase (match-string 3)))
5851 end end1 quoting block-type ovl)
5852 (cond
5853 ((member dc1 '("+html:" "+ascii:" "+latex:"))
5854 ;; a single line of backend-specific content
5855 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5856 (remove-text-properties (match-beginning 0) (match-end 0)
5857 '(display t invisible t intangible t))
5858 (add-text-properties (match-beginning 1) (match-end 3)
5859 '(font-lock-fontified t face org-meta-line))
5860 (add-text-properties (match-beginning 6) (+ (match-end 6) 1)
5861 '(font-lock-fontified t face org-block))
5862 ; for backend-specific code
5864 ((and (match-end 4) (equal dc3 "+begin"))
5865 ;; Truly a block
5866 (setq block-type (downcase (match-string 5))
5867 quoting (member block-type org-protecting-blocks))
5868 (when (re-search-forward
5869 (concat "^[ \t]*#\\+end" (match-string 4) "\\>.*")
5870 nil t) ;; on purpose, we look further than LIMIT
5871 (setq end (min (point-max) (match-end 0))
5872 end1 (min (point-max) (1- (match-beginning 0))))
5873 (setq block-end (match-beginning 0))
5874 (when quoting
5875 (org-remove-flyspell-overlays-in beg1 end1)
5876 (remove-text-properties beg end
5877 '(display t invisible t intangible t)))
5878 (add-text-properties
5879 beg end '(font-lock-fontified t font-lock-multiline t))
5880 (add-text-properties beg beg1 '(face org-meta-line))
5881 (org-remove-flyspell-overlays-in beg beg1)
5882 (add-text-properties ; For end_src
5883 end1 (min (point-max) (1+ end)) '(face org-meta-line))
5884 (org-remove-flyspell-overlays-in end1 end)
5885 (cond
5886 ((and lang (not (string= lang "")) org-src-fontify-natively)
5887 (org-src-font-lock-fontify-block lang block-start block-end)
5888 ;; remove old background overlays
5889 (mapc (lambda (ov)
5890 (if (eq (overlay-get ov 'face) 'org-block-background)
5891 (delete-overlay ov)))
5892 (overlays-at (/ (+ beg1 block-end) 2)))
5893 ;; add a background overlay
5894 (setq ovl (make-overlay beg1 block-end))
5895 (overlay-put ovl 'face 'org-block-background)
5896 (overlay-put ovl 'evaporate t)) ; make it go away when empty
5897 (quoting
5898 (add-text-properties beg1 (min (point-max) (1+ end1))
5899 '(face org-block))) ; end of source block
5900 ((not org-fontify-quote-and-verse-blocks))
5901 ((string= block-type "quote")
5902 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-quote)))
5903 ((string= block-type "verse")
5904 (add-text-properties beg1 (min (point-max) (1+ end1)) '(face org-verse))))
5905 (add-text-properties beg beg1 '(face org-block-begin-line))
5906 (add-text-properties (min (point-max) (1+ end)) (min (point-max) (1+ end1))
5907 '(face org-block-end-line))
5909 ((member dc1 '("+title:" "+author:" "+email:" "+date:"))
5910 (org-remove-flyspell-overlays-in
5911 (match-beginning 0)
5912 (if (equal "+title:" dc1) (match-end 2) (match-end 0)))
5913 (add-text-properties
5914 beg (match-end 3)
5915 (if (member (intern (substring dc1 0 -1)) org-hidden-keywords)
5916 '(font-lock-fontified t invisible t)
5917 '(font-lock-fontified t face org-document-info-keyword)))
5918 (add-text-properties
5919 (match-beginning 6) (min (point-max) (1+ (match-end 6)))
5920 (if (string-equal dc1 "+title:")
5921 '(font-lock-fontified t face org-document-title)
5922 '(font-lock-fontified t face org-document-info))))
5923 ((or (equal dc1 "+results")
5924 (member dc1 '("+begin:" "+end:" "+caption:" "+label:"
5925 "+orgtbl:" "+tblfm:" "+tblname:" "+results:"
5926 "+call:" "+header:" "+headers:" "+name:"))
5927 (and (match-end 4) (equal dc3 "+attr")))
5928 (org-remove-flyspell-overlays-in
5929 (match-beginning 0)
5930 (if (equal "+caption:" dc1) (match-end 2) (match-end 0)))
5931 (add-text-properties
5932 beg (match-end 0)
5933 '(font-lock-fontified t face org-meta-line))
5935 ((member dc3 '(" " ""))
5936 (org-remove-flyspell-overlays-in beg (match-end 0))
5937 (add-text-properties
5938 beg (match-end 0)
5939 '(font-lock-fontified t face font-lock-comment-face)))
5940 ((not (member (char-after beg) '(?\ ?\t)))
5941 ;; just any other in-buffer setting, but not indented
5942 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5943 (add-text-properties
5944 beg (match-end 0)
5945 '(font-lock-fontified t face org-meta-line))
5947 (t nil))))))
5949 (defun org-fontify-drawers (limit)
5950 "Fontify drawers."
5951 (when (re-search-forward org-drawer-regexp limit t)
5952 (add-text-properties
5953 (match-beginning 0) (match-end 0)
5954 '(font-lock-fontified t face org-special-keyword))
5955 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5958 (defun org-fontify-macros (limit)
5959 "Fontify macros."
5960 (when (re-search-forward "\\({{{\\).+?\\(}}}\\)" limit t)
5961 (add-text-properties
5962 (match-beginning 0) (match-end 0)
5963 '(font-lock-fontified t face org-macro))
5964 (when org-hide-macro-markers
5965 (add-text-properties (match-end 2) (match-beginning 2)
5966 '(invisible t))
5967 (add-text-properties (match-beginning 1) (match-end 1)
5968 '(invisible t)))
5969 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5972 (defun org-activate-angle-links (limit)
5973 "Run through the buffer and add overlays to links."
5974 (if (and (re-search-forward org-angle-link-re limit t)
5975 (not (org-in-src-block-p)))
5976 (progn
5977 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
5978 (add-text-properties (match-beginning 0) (match-end 0)
5979 (list 'mouse-face 'highlight
5980 'keymap org-mouse-map))
5981 (org-rear-nonsticky-at (match-end 0))
5982 t)))
5984 (defun org-activate-footnote-links (limit)
5985 "Run through the buffer and add overlays to footnotes."
5986 (let ((fn (org-footnote-next-reference-or-definition limit)))
5987 (when fn
5988 (let* ((beg (nth 1 fn))
5989 (end (nth 2 fn))
5990 (label (car fn))
5991 (referencep (/= (line-beginning-position) beg)))
5992 (when (and referencep (nth 3 fn))
5993 (save-excursion
5994 (goto-char beg)
5995 (search-forward (or label "fn:"))
5996 (org-remove-flyspell-overlays-in beg (match-end 0))))
5997 (add-text-properties beg end
5998 (list 'mouse-face 'highlight
5999 'keymap org-mouse-map
6000 'help-echo
6001 (if referencep "Footnote reference"
6002 "Footnote definition")
6003 'font-lock-fontified t
6004 'font-lock-multiline t
6005 'face 'org-footnote))))))
6007 (defun org-activate-bracket-links (limit)
6008 "Run through the buffer and add overlays to bracketed links."
6009 (if (and (re-search-forward org-bracket-link-regexp limit t)
6010 (not (org-in-src-block-p)))
6011 (let* ((hl (org-match-string-no-properties 1))
6012 (help (concat "LINK: " (save-match-data (org-link-unescape hl))))
6013 (ip (org-maybe-intangible
6014 (list 'invisible 'org-link
6015 'keymap org-mouse-map 'mouse-face 'highlight
6016 'font-lock-multiline t 'help-echo help
6017 'htmlize-link `(:uri ,hl))))
6018 (vp (list 'keymap org-mouse-map 'mouse-face 'highlight
6019 'font-lock-multiline t 'help-echo help
6020 'htmlize-link `(:uri ,hl))))
6021 ;; We need to remove the invisible property here. Table narrowing
6022 ;; may have made some of this invisible.
6023 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6024 (remove-text-properties (match-beginning 0) (match-end 0)
6025 '(invisible nil))
6026 (if (match-end 3)
6027 (progn
6028 (add-text-properties (match-beginning 0) (match-beginning 3) ip)
6029 (org-rear-nonsticky-at (match-beginning 3))
6030 (add-text-properties (match-beginning 3) (match-end 3) vp)
6031 (org-rear-nonsticky-at (match-end 3))
6032 (add-text-properties (match-end 3) (match-end 0) ip)
6033 (org-rear-nonsticky-at (match-end 0)))
6034 (add-text-properties (match-beginning 0) (match-beginning 1) ip)
6035 (org-rear-nonsticky-at (match-beginning 1))
6036 (add-text-properties (match-beginning 1) (match-end 1) vp)
6037 (org-rear-nonsticky-at (match-end 1))
6038 (add-text-properties (match-end 1) (match-end 0) ip)
6039 (org-rear-nonsticky-at (match-end 0)))
6040 t)))
6042 (defun org-activate-dates (limit)
6043 "Run through the buffer and add overlays to dates."
6044 (if (and (re-search-forward org-tsr-regexp-both limit t)
6045 (not (equal (char-before (match-beginning 0)) 91)))
6046 (progn
6047 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6048 (add-text-properties (match-beginning 0) (match-end 0)
6049 (list 'mouse-face 'highlight
6050 'keymap org-mouse-map))
6051 (org-rear-nonsticky-at (match-end 0))
6052 (when org-display-custom-times
6053 (if (match-end 3)
6054 (org-display-custom-time (match-beginning 3) (match-end 3)))
6055 (org-display-custom-time (match-beginning 1) (match-end 1)))
6056 t)))
6058 (defvar org-target-link-regexp nil
6059 "Regular expression matching radio targets in plain text.")
6060 (make-variable-buffer-local 'org-target-link-regexp)
6061 (defvar org-target-regexp "<<\\([^<>\n\r]+\\)>>"
6062 "Regular expression matching a link target.")
6063 (defvar org-radio-target-regexp "<<<\\([^<>\n\r]+\\)>>>"
6064 "Regular expression matching a radio target.")
6065 (defvar org-any-target-regexp "<<<?\\([^<>\n\r]+\\)>>>?" ; FIXME, not exact, would match <<<aaa>> as a radio target.
6066 "Regular expression matching any target.")
6068 (defun org-activate-target-links (limit)
6069 "Run through the buffer and add overlays to target matches."
6070 (when org-target-link-regexp
6071 (let ((case-fold-search t))
6072 (if (re-search-forward org-target-link-regexp limit t)
6073 (progn
6074 (org-remove-flyspell-overlays-in (match-beginning 0) (match-end 0))
6075 (add-text-properties (match-beginning 0) (match-end 0)
6076 (list 'mouse-face 'highlight
6077 'keymap org-mouse-map
6078 'help-echo "Radio target link"
6079 'org-linked-text t))
6080 (org-rear-nonsticky-at (match-end 0))
6081 t)))))
6083 (defun org-update-radio-target-regexp ()
6084 "Find all radio targets in this file and update the regular expression."
6085 (interactive)
6086 (when (memq 'radio org-activate-links)
6087 (setq org-target-link-regexp
6088 (org-make-target-link-regexp (org-all-targets 'radio)))
6089 (org-restart-font-lock)))
6091 (defun org-hide-wide-columns (limit)
6092 (let (s e)
6093 (setq s (text-property-any (point) (or limit (point-max))
6094 'org-cwidth t))
6095 (when s
6096 (setq e (next-single-property-change s 'org-cwidth))
6097 (add-text-properties s e (org-maybe-intangible '(invisible org-cwidth)))
6098 (goto-char e)
6099 t)))
6101 (defvar org-latex-and-related-regexp nil
6102 "Regular expression for highlighting LaTeX, entities and sub/superscript.")
6104 (defun org-compute-latex-and-related-regexp ()
6105 "Compute regular expression for LaTeX, entities and sub/superscript.
6106 Result depends on variable `org-highlight-latex-and-related'."
6107 (org-set-local
6108 'org-latex-and-related-regexp
6109 (let* ((re-sub
6110 (cond ((not (memq 'script org-highlight-latex-and-related)) nil)
6111 ((eq org-use-sub-superscripts '{})
6112 (list org-match-substring-with-braces-regexp))
6113 (org-use-sub-superscripts (list org-match-substring-regexp))))
6114 (re-latex
6115 (when (memq 'latex org-highlight-latex-and-related)
6116 (let ((matchers (plist-get org-format-latex-options :matchers)))
6117 (delq nil
6118 (mapcar (lambda (x)
6119 (and (member (car x) matchers) (nth 1 x)))
6120 org-latex-regexps)))))
6121 (re-entities
6122 (when (memq 'entities org-highlight-latex-and-related)
6123 (list "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]]\\)"))))
6124 (mapconcat 'identity (append re-latex re-entities re-sub) "\\|"))))
6126 (defun org-do-latex-and-related (limit)
6127 "Highlight LaTeX snippets and environments, entities and sub/superscript.
6128 LIMIT bounds the search for syntax to highlight. Stop at first
6129 highlighted object, if any. Return t if some highlighting was
6130 done, nil otherwise."
6131 (when (org-string-nw-p org-latex-and-related-regexp)
6132 (catch 'found
6133 (while (re-search-forward org-latex-and-related-regexp limit t)
6134 (unless (memq (car-safe (get-text-property (1+ (match-beginning 0))
6135 'face))
6136 '(org-code org-verbatim underline))
6137 (let ((offset (if (memq (char-after (1+ (match-beginning 0)))
6138 '(?_ ?^))
6140 0)))
6141 (font-lock-prepend-text-property
6142 (+ offset (match-beginning 0)) (match-end 0)
6143 'face 'org-latex-and-related)
6144 (add-text-properties (+ offset (match-beginning 0)) (match-end 0)
6145 '(font-lock-multiline t)))
6146 (throw 'found t)))
6147 nil)))
6149 (defun org-restart-font-lock ()
6150 "Restart `font-lock-mode', to force refontification."
6151 (when (and (boundp 'font-lock-mode) font-lock-mode)
6152 (font-lock-mode -1)
6153 (font-lock-mode 1)))
6155 (defun org-all-targets (&optional radio)
6156 "Return a list of all targets in this file.
6157 When optional argument RADIO is non-nil, only find radio
6158 targets."
6159 (let ((re (if radio org-radio-target-regexp org-target-regexp)) rtn)
6160 (save-excursion
6161 (goto-char (point-min))
6162 (while (re-search-forward re nil t)
6163 ;; Make sure point is really within the object.
6164 (backward-char)
6165 (let ((obj (org-element-context)))
6166 (when (memq (org-element-type obj) '(radio-target target))
6167 (add-to-list 'rtn (downcase (org-element-property :value obj))))))
6168 rtn)))
6170 (defun org-make-target-link-regexp (targets)
6171 "Make regular expression matching all strings in TARGETS.
6172 The regular expression finds the targets also if there is a line break
6173 between words."
6174 (and targets
6175 (concat
6176 "\\<\\("
6177 (mapconcat
6178 (lambda (x)
6179 (setq x (regexp-quote x))
6180 (while (string-match " +" x)
6181 (setq x (replace-match "\\s-+" t t x)))
6183 targets
6184 "\\|")
6185 "\\)\\>")))
6187 (defun org-activate-tags (limit)
6188 (if (re-search-forward (org-re "^\\*+.*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \r\n]") limit t)
6189 (progn
6190 (org-remove-flyspell-overlays-in (match-beginning 1) (match-end 1))
6191 (add-text-properties (match-beginning 1) (match-end 1)
6192 (list 'mouse-face 'highlight
6193 'keymap org-mouse-map))
6194 (org-rear-nonsticky-at (match-end 1))
6195 t)))
6197 (defun org-outline-level ()
6198 "Compute the outline level of the heading at point.
6199 If this is called at a normal headline, the level is the number of stars.
6200 Use `org-reduced-level' to remove the effect of `org-odd-levels'."
6201 (save-excursion
6202 (if (not (condition-case nil
6203 (org-back-to-heading t)
6204 (error nil)))
6206 (looking-at org-outline-regexp)
6207 (1- (- (match-end 0) (match-beginning 0))))))
6209 (defvar org-font-lock-keywords nil)
6211 (defsubst org-re-property (property &optional literal)
6212 "Return a regexp matching a PROPERTY line.
6213 Match group 3 will be set to the value if it exists."
6214 (concat "^\\(?4:[ \t]*\\)\\(?1::\\(?2:"
6215 (if literal property (regexp-quote property))
6216 "\\):\\)[ \t]+\\(?3:[^ \t\r\n].*?\\)\\(?5:[ \t]*\\)$"))
6218 (defconst org-property-re
6219 (org-re-property ".*?" 'literal)
6220 "Regular expression matching a property line.
6221 There are four matching groups:
6222 1: :PROPKEY: including the leading and trailing colon,
6223 2: PROPKEY without the leading and trailing colon,
6224 3: PROPVAL without leading or trailing spaces,
6225 4: the indentation of the current line,
6226 5: trailing whitespace.")
6228 (defvar org-font-lock-hook nil
6229 "Functions to be called for special font lock stuff.")
6231 (defvar org-font-lock-set-keywords-hook nil
6232 "Functions that can manipulate `org-font-lock-extra-keywords'.
6233 This is called after `org-font-lock-extra-keywords' is defined, but before
6234 it is installed to be used by font lock. This can be useful if something
6235 needs to be inserted at a specific position in the font-lock sequence.")
6237 (defun org-font-lock-hook (limit)
6238 "Run `org-font-lock-hook' within LIMIT."
6239 (run-hook-with-args 'org-font-lock-hook limit))
6241 (defun org-set-font-lock-defaults ()
6242 "Set font lock defaults for the current buffer."
6243 (let* ((em org-fontify-emphasized-text)
6244 (lk org-activate-links)
6245 (org-font-lock-extra-keywords
6246 (list
6247 ;; Call the hook
6248 '(org-font-lock-hook)
6249 ;; Headlines
6250 `(,(if org-fontify-whole-heading-line
6251 "^\\(\\**\\)\\(\\* \\)\\(.*\n?\\)"
6252 "^\\(\\**\\)\\(\\* \\)\\(.*\\)")
6253 (1 (org-get-level-face 1))
6254 (2 (org-get-level-face 2))
6255 (3 (org-get-level-face 3)))
6256 ;; Table lines
6257 '("^[ \t]*\\(\\(|\\|\\+-[-+]\\).*\\S-\\)"
6258 (1 'org-table t))
6259 ;; Table internals
6260 '("^[ \t]*|\\(?:.*?|\\)? *\\(:?=[^|\n]*\\)" (1 'org-formula t))
6261 '("^[ \t]*| *\\([#*]\\) *|" (1 'org-formula t))
6262 '("^[ \t]*|\\( *\\([$!_^/]\\) *|.*\\)|" (1 'org-formula t))
6263 '("| *\\(<[lrc]?[0-9]*>\\)" (1 'org-formula t))
6264 ;; Drawers
6265 '(org-fontify-drawers)
6266 ;; Properties
6267 (list org-property-re
6268 '(1 'org-special-keyword t)
6269 '(3 'org-property-value t))
6270 ;; Links
6271 (if (memq 'tag lk) '(org-activate-tags (1 'org-tag prepend)))
6272 (if (memq 'angle lk) '(org-activate-angle-links (0 'org-link t)))
6273 (if (memq 'plain lk) '(org-activate-plain-links (0 'org-link t)))
6274 (if (memq 'bracket lk) '(org-activate-bracket-links (0 'org-link t)))
6275 (if (memq 'radio lk) '(org-activate-target-links (0 'org-link t)))
6276 (if (memq 'date lk) '(org-activate-dates (0 'org-date t)))
6277 (if (memq 'footnote lk) '(org-activate-footnote-links))
6278 ;; Targets.
6279 (list org-any-target-regexp '(0 'org-target t))
6280 ;; Diary sexps.
6281 '("^&?%%(.*\\|<%%([^>\n]*?>" (0 'org-sexp-date t))
6282 ;; Macro
6283 '(org-fontify-macros)
6284 '(org-hide-wide-columns (0 nil append))
6285 ;; TODO keyword
6286 (list (format org-heading-keyword-regexp-format
6287 org-todo-regexp)
6288 '(2 (org-get-todo-face 2) t))
6289 ;; DONE
6290 (if org-fontify-done-headline
6291 (list (format org-heading-keyword-regexp-format
6292 (concat
6293 "\\(?:"
6294 (mapconcat 'regexp-quote org-done-keywords "\\|")
6295 "\\)"))
6296 '(2 'org-headline-done t))
6297 nil)
6298 ;; Priorities
6299 '(org-font-lock-add-priority-faces)
6300 ;; Tags
6301 '(org-font-lock-add-tag-faces)
6302 ;; Tags groups
6303 (if (and org-group-tags org-tag-groups-alist)
6304 (list (concat org-outline-regexp-bol ".+\\(:"
6305 (regexp-opt (mapcar 'car org-tag-groups-alist))
6306 ":\\).*$")
6307 '(1 'org-tag-group prepend)))
6308 ;; Special keywords
6309 (list (concat "\\<" org-deadline-string) '(0 'org-special-keyword t))
6310 (list (concat "\\<" org-scheduled-string) '(0 'org-special-keyword t))
6311 (list (concat "\\<" org-closed-string) '(0 'org-special-keyword t))
6312 (list (concat "\\<" org-clock-string) '(0 'org-special-keyword t))
6313 ;; Emphasis
6314 (if em
6315 (if (featurep 'xemacs)
6316 '(org-do-emphasis-faces (0 nil append))
6317 '(org-do-emphasis-faces)))
6318 ;; Checkboxes
6319 '("^[ \t]*\\(?:[-+*]\\|[0-9]+[.)]\\)[ \t]+\\(?:\\[@\\(?:start:\\)?[0-9]+\\][ \t]*\\)?\\(\\[[- X]\\]\\)"
6320 1 'org-checkbox prepend)
6321 (if (cdr (assq 'checkbox org-list-automatic-rules))
6322 '("\\[\\([0-9]*%\\)\\]\\|\\[\\([0-9]*\\)/\\([0-9]*\\)\\]"
6323 (0 (org-get-checkbox-statistics-face) t)))
6324 ;; Description list items
6325 '("^[ \t]*[-+*][ \t]+\\(.*?[ \t]+::\\)\\([ \t]+\\|$\\)"
6326 1 'org-list-dt prepend)
6327 ;; ARCHIVEd headings
6328 (list (concat
6329 org-outline-regexp-bol
6330 "\\(.*:" org-archive-tag ":.*\\)")
6331 '(1 'org-archived prepend))
6332 ;; Specials
6333 '(org-do-latex-and-related)
6334 '(org-fontify-entities)
6335 '(org-raise-scripts)
6336 ;; Code
6337 '(org-activate-code (1 'org-code t))
6338 ;; COMMENT
6339 (list (format org-heading-keyword-regexp-format
6340 (concat "\\(" org-comment-string "\\)"))
6341 '(2 'org-special-keyword t))
6342 ;; Blocks and meta lines
6343 '(org-fontify-meta-lines-and-blocks))))
6344 (setq org-font-lock-extra-keywords (delq nil org-font-lock-extra-keywords))
6345 (run-hooks 'org-font-lock-set-keywords-hook)
6346 ;; Now set the full font-lock-keywords
6347 (org-set-local 'org-font-lock-keywords org-font-lock-extra-keywords)
6348 (org-set-local 'font-lock-defaults
6349 '(org-font-lock-keywords t nil nil backward-paragraph))
6350 (kill-local-variable 'font-lock-keywords) nil))
6352 (defun org-toggle-pretty-entities ()
6353 "Toggle the composition display of entities as UTF8 characters."
6354 (interactive)
6355 (org-set-local 'org-pretty-entities (not org-pretty-entities))
6356 (org-restart-font-lock)
6357 (if org-pretty-entities
6358 (message "Entities are now displayed as UTF8 characters")
6359 (save-restriction
6360 (widen)
6361 (org-decompose-region (point-min) (point-max))
6362 (message "Entities are now displayed as plain text"))))
6364 (defvar org-custom-properties-overlays nil
6365 "List of overlays used for custom properties.")
6366 (make-variable-buffer-local 'org-custom-properties-overlays)
6368 (defun org-toggle-custom-properties-visibility ()
6369 "Display or hide properties in `org-custom-properties'."
6370 (interactive)
6371 (if org-custom-properties-overlays
6372 (progn (mapc 'delete-overlay org-custom-properties-overlays)
6373 (setq org-custom-properties-overlays nil))
6374 (unless (not org-custom-properties)
6375 (save-excursion
6376 (save-restriction
6377 (widen)
6378 (goto-char (point-min))
6379 (while (re-search-forward org-property-re nil t)
6380 (mapc (lambda(p)
6381 (when (equal p (substring (match-string 1) 1 -1))
6382 (let ((o (make-overlay (match-beginning 0) (1+ (match-end 0)))))
6383 (overlay-put o 'invisible t)
6384 (overlay-put o 'org-custom-property t)
6385 (push o org-custom-properties-overlays))))
6386 org-custom-properties)))))))
6388 (defun org-fontify-entities (limit)
6389 "Find an entity to fontify."
6390 (let (ee)
6391 (when org-pretty-entities
6392 (catch 'match
6393 (while (re-search-forward
6394 "\\\\\\(there4\\|sup[123]\\|frac[13][24]\\|[a-zA-Z]+\\)\\($\\|{}\\|[^[:alpha:]\n]\\)"
6395 limit t)
6396 (if (and (not (org-in-indented-comment-line))
6397 (setq ee (org-entity-get (match-string 1)))
6398 (= (length (nth 6 ee)) 1))
6399 (let*
6400 ((end (if (equal (match-string 2) "{}")
6401 (match-end 2)
6402 (match-end 1))))
6403 (add-text-properties
6404 (match-beginning 0) end
6405 (list 'font-lock-fontified t))
6406 (compose-region (match-beginning 0) end
6407 (nth 6 ee) nil)
6408 (backward-char 1)
6409 (throw 'match t))))
6410 nil))))
6412 (defun org-fontify-like-in-org-mode (s &optional odd-levels)
6413 "Fontify string S like in Org-mode."
6414 (with-temp-buffer
6415 (insert s)
6416 (let ((org-odd-levels-only odd-levels))
6417 (org-mode)
6418 (font-lock-fontify-buffer)
6419 (buffer-string))))
6421 (defvar org-m nil)
6422 (defvar org-l nil)
6423 (defvar org-f nil)
6424 (defun org-get-level-face (n)
6425 "Get the right face for match N in font-lock matching of headlines."
6426 (setq org-l (- (match-end 2) (match-beginning 1) 1))
6427 (if org-odd-levels-only (setq org-l (1+ (/ org-l 2))))
6428 (if org-cycle-level-faces
6429 (setq org-f (nth (% (1- org-l) org-n-level-faces) org-level-faces))
6430 (setq org-f (nth (1- (min org-l org-n-level-faces)) org-level-faces)))
6431 (cond
6432 ((eq n 1) (if org-hide-leading-stars 'org-hide org-f))
6433 ((eq n 2) org-f)
6434 (t (if org-level-color-stars-only nil org-f))))
6437 (defun org-get-todo-face (kwd)
6438 "Get the right face for a TODO keyword KWD.
6439 If KWD is a number, get the corresponding match group."
6440 (if (numberp kwd) (setq kwd (match-string kwd)))
6441 (or (org-face-from-face-or-color
6442 'todo 'org-todo (cdr (assoc kwd org-todo-keyword-faces)))
6443 (and (member kwd org-done-keywords) 'org-done)
6444 'org-todo))
6446 (defun org-face-from-face-or-color (context inherit face-or-color)
6447 "Create a face list that inherits INHERIT, but sets the foreground color.
6448 When FACE-OR-COLOR is not a string, just return it."
6449 (if (stringp face-or-color)
6450 (list :inherit inherit
6451 (cdr (assoc context org-faces-easy-properties))
6452 face-or-color)
6453 face-or-color))
6455 (defun org-font-lock-add-tag-faces (limit)
6456 "Add the special tag faces."
6457 (when (and org-tag-faces org-tags-special-faces-re)
6458 (while (re-search-forward org-tags-special-faces-re limit t)
6459 (add-text-properties (match-beginning 1) (match-end 1)
6460 (list 'face (org-get-tag-face 1)
6461 'font-lock-fontified t))
6462 (backward-char 1))))
6464 (defun org-font-lock-add-priority-faces (limit)
6465 "Add the special priority faces."
6466 (while (re-search-forward "\\[#\\([A-Z0-9]\\)\\]" limit t)
6467 (when (save-match-data (org-at-heading-p))
6468 (add-text-properties
6469 (match-beginning 0) (match-end 0)
6470 (list 'face (or (org-face-from-face-or-color
6471 'priority 'org-priority
6472 (cdr (assoc (char-after (match-beginning 1))
6473 org-priority-faces)))
6474 'org-priority)
6475 'font-lock-fontified t)))))
6477 (defun org-get-tag-face (kwd)
6478 "Get the right face for a TODO keyword KWD.
6479 If KWD is a number, get the corresponding match group."
6480 (if (numberp kwd) (setq kwd (match-string kwd)))
6481 (or (org-face-from-face-or-color
6482 'tag 'org-tag (cdr (assoc kwd org-tag-faces)))
6483 'org-tag))
6485 (defun org-unfontify-region (beg end &optional maybe_loudly)
6486 "Remove fontification and activation overlays from links."
6487 (font-lock-default-unfontify-region beg end)
6488 (let* ((buffer-undo-list t)
6489 (inhibit-read-only t) (inhibit-point-motion-hooks t)
6490 (inhibit-modification-hooks t)
6491 deactivate-mark buffer-file-name buffer-file-truename)
6492 (org-decompose-region beg end)
6493 (remove-text-properties beg end
6494 '(mouse-face t keymap t org-linked-text t
6495 invisible t intangible t
6496 org-emphasis t))
6497 (org-remove-font-lock-display-properties beg end)))
6499 (defconst org-script-display '(((raise -0.3) (height 0.7))
6500 ((raise 0.3) (height 0.7))
6501 ((raise -0.5))
6502 ((raise 0.5)))
6503 "Display properties for showing superscripts and subscripts.")
6505 (defun org-remove-font-lock-display-properties (beg end)
6506 "Remove specific display properties that have been added by font lock.
6507 The will remove the raise properties that are used to show superscripts
6508 and subscripts."
6509 (let (next prop)
6510 (while (< beg end)
6511 (setq next (next-single-property-change beg 'display nil end)
6512 prop (get-text-property beg 'display))
6513 (if (member prop org-script-display)
6514 (put-text-property beg next 'display nil))
6515 (setq beg next))))
6517 (defun org-raise-scripts (limit)
6518 "Add raise properties to sub/superscripts."
6519 (when (and org-pretty-entities org-pretty-entities-include-sub-superscripts)
6520 (if (re-search-forward
6521 (if (eq org-use-sub-superscripts t)
6522 org-match-substring-regexp
6523 org-match-substring-with-braces-regexp)
6524 limit t)
6525 (let* ((pos (point)) table-p comment-p
6526 (mpos (match-beginning 3))
6527 (emph-p (get-text-property mpos 'org-emphasis))
6528 (link-p (get-text-property mpos 'mouse-face))
6529 (keyw-p (eq 'org-special-keyword (get-text-property mpos 'face))))
6530 (goto-char (point-at-bol))
6531 (setq table-p (org-looking-at-p org-table-dataline-regexp)
6532 comment-p (org-looking-at-p "^[ \t]*#[ +]"))
6533 (goto-char pos)
6534 ;; Handle a_b^c
6535 (if (member (char-after) '(?_ ?^)) (goto-char (1- pos)))
6536 (if (or comment-p emph-p link-p keyw-p)
6538 (put-text-property (match-beginning 3) (match-end 0)
6539 'display
6540 (if (equal (char-after (match-beginning 2)) ?^)
6541 (nth (if table-p 3 1) org-script-display)
6542 (nth (if table-p 2 0) org-script-display)))
6543 (add-text-properties (match-beginning 2) (match-end 2)
6544 (list 'invisible t
6545 'org-dwidth t 'org-dwidth-n 1))
6546 (if (and (eq (char-after (match-beginning 3)) ?{)
6547 (eq (char-before (match-end 3)) ?}))
6548 (progn
6549 (add-text-properties
6550 (match-beginning 3) (1+ (match-beginning 3))
6551 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))
6552 (add-text-properties
6553 (1- (match-end 3)) (match-end 3)
6554 (list 'invisible t 'org-dwidth t 'org-dwidth-n 1))))
6555 t)))))
6557 ;;;; Visibility cycling, including org-goto and indirect buffer
6559 ;;; Cycling
6561 (defvar org-cycle-global-status nil)
6562 (make-variable-buffer-local 'org-cycle-global-status)
6563 (put 'org-cycle-global-status 'org-state t)
6564 (defvar org-cycle-subtree-status nil)
6565 (make-variable-buffer-local 'org-cycle-subtree-status)
6566 (put 'org-cycle-subtree-status 'org-state t)
6568 (defvar org-inlinetask-min-level)
6570 (defun org-unlogged-message (&rest args)
6571 "Display a message, but avoid logging it in the *Messages* buffer."
6572 (let ((message-log-max nil))
6573 (apply 'message args)))
6575 ;;;###autoload
6576 (defun org-cycle (&optional arg)
6577 "TAB-action and visibility cycling for Org-mode.
6579 This is the command invoked in Org-mode by the TAB key. Its main purpose
6580 is outline visibility cycling, but it also invokes other actions
6581 in special contexts.
6583 - When this function is called with a prefix argument, rotate the entire
6584 buffer through 3 states (global cycling)
6585 1. OVERVIEW: Show only top-level headlines.
6586 2. CONTENTS: Show all headlines of all levels, but no body text.
6587 3. SHOW ALL: Show everything.
6588 When called with two `C-u C-u' prefixes, switch to the startup visibility,
6589 determined by the variable `org-startup-folded', and by any VISIBILITY
6590 properties in the buffer.
6591 When called with three `C-u C-u C-u' prefixed, show the entire buffer,
6592 including any drawers.
6594 - When inside a table, re-align the table and move to the next field.
6596 - When point is at the beginning of a headline, rotate the subtree started
6597 by this line through 3 different states (local cycling)
6598 1. FOLDED: Only the main headline is shown.
6599 2. CHILDREN: The main headline and the direct children are shown.
6600 From this state, you can move to one of the children
6601 and zoom in further.
6602 3. SUBTREE: Show the entire subtree, including body text.
6603 If there is no subtree, switch directly from CHILDREN to FOLDED.
6605 - When point is at the beginning of an empty headline and the variable
6606 `org-cycle-level-after-item/entry-creation' is set, cycle the level
6607 of the headline by demoting and promoting it to likely levels. This
6608 speeds up creation document structure by pressing TAB once or several
6609 times right after creating a new headline.
6611 - When there is a numeric prefix, go up to a heading with level ARG, do
6612 a `show-subtree' and return to the previous cursor position. If ARG
6613 is negative, go up that many levels.
6615 - When point is not at the beginning of a headline, execute the global
6616 binding for TAB, which is re-indenting the line. See the option
6617 `org-cycle-emulate-tab' for details.
6619 - Special case: if point is at the beginning of the buffer and there is
6620 no headline in line 1, this function will act as if called with prefix arg
6621 (C-u TAB, same as S-TAB) also when called without prefix arg.
6622 But only if also the variable `org-cycle-global-at-bob' is t."
6623 (interactive "P")
6624 (org-load-modules-maybe)
6625 (unless (or (run-hook-with-args-until-success 'org-tab-first-hook)
6626 (and org-cycle-level-after-item/entry-creation
6627 (or (org-cycle-level)
6628 (org-cycle-item-indentation))))
6629 (let* ((limit-level
6630 (or org-cycle-max-level
6631 (and (boundp 'org-inlinetask-min-level)
6632 org-inlinetask-min-level
6633 (1- org-inlinetask-min-level))))
6634 (nstars (and limit-level
6635 (if org-odd-levels-only
6636 (and limit-level (1- (* limit-level 2)))
6637 limit-level)))
6638 (org-outline-regexp
6639 (if (not (derived-mode-p 'org-mode))
6640 outline-regexp
6641 (concat "\\*" (if nstars (format "\\{1,%d\\} " nstars) "+ "))))
6642 (bob-special (and org-cycle-global-at-bob (not arg) (bobp)
6643 (not (looking-at org-outline-regexp))))
6644 (org-cycle-hook
6645 (if bob-special
6646 (delq 'org-optimize-window-after-visibility-change
6647 (copy-sequence org-cycle-hook))
6648 org-cycle-hook))
6649 (pos (point)))
6651 (if (or bob-special (equal arg '(4)))
6652 ;; special case: use global cycling
6653 (setq arg t))
6655 (cond
6657 ((equal arg '(16))
6658 (setq last-command 'dummy)
6659 (org-set-startup-visibility)
6660 (org-unlogged-message "Startup visibility, plus VISIBILITY properties"))
6662 ((equal arg '(64))
6663 (show-all)
6664 (org-unlogged-message "Entire buffer visible, including drawers"))
6666 ;; Table: enter it or move to the next field.
6667 ((org-at-table-p 'any)
6668 (if (org-at-table.el-p)
6669 (message "Use C-c ' to edit table.el tables")
6670 (if arg (org-table-edit-field t)
6671 (org-table-justify-field-maybe)
6672 (call-interactively 'org-table-next-field))))
6674 ((run-hook-with-args-until-success
6675 'org-tab-after-check-for-table-hook))
6677 ;; Global cycling: delegate to `org-cycle-internal-global'.
6678 ((eq arg t) (org-cycle-internal-global))
6680 ;; Drawers: delegate to `org-flag-drawer'.
6681 ((save-excursion
6682 (beginning-of-line 1)
6683 (looking-at org-drawer-regexp))
6684 (org-flag-drawer ; toggle block visibility
6685 (not (get-char-property (match-end 0) 'invisible))))
6687 ;; Show-subtree, ARG levels up from here.
6688 ((integerp arg)
6689 (save-excursion
6690 (org-back-to-heading)
6691 (outline-up-heading (if (< arg 0) (- arg)
6692 (- (funcall outline-level) arg)))
6693 (org-show-subtree)))
6695 ;; Inline task: delegate to `org-inlinetask-toggle-visibility'.
6696 ((and (featurep 'org-inlinetask)
6697 (org-inlinetask-at-task-p)
6698 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6699 (org-inlinetask-toggle-visibility))
6701 ((org-try-cdlatex-tab))
6703 ;; At an item/headline: delegate to `org-cycle-internal-local'.
6704 ((and (or (and org-cycle-include-plain-lists (org-at-item-p))
6705 (save-excursion (beginning-of-line 1)
6706 (looking-at org-outline-regexp)))
6707 (or (bolp) (not (eq org-cycle-emulate-tab 'exc-hl-bol))))
6708 (org-cycle-internal-local))
6710 ;; From there: TAB emulation and template completion.
6711 (buffer-read-only (org-back-to-heading))
6713 ((run-hook-with-args-until-success
6714 'org-tab-after-check-for-cycling-hook))
6716 ((org-try-structure-completion))
6718 ((run-hook-with-args-until-success
6719 'org-tab-before-tab-emulation-hook))
6721 ((and (eq org-cycle-emulate-tab 'exc-hl-bol)
6722 (or (not (bolp))
6723 (not (looking-at org-outline-regexp))))
6724 (call-interactively (global-key-binding "\t")))
6726 ((if (and (memq org-cycle-emulate-tab '(white whitestart))
6727 (save-excursion (beginning-of-line 1) (looking-at "[ \t]*"))
6728 (or (and (eq org-cycle-emulate-tab 'white)
6729 (= (match-end 0) (point-at-eol)))
6730 (and (eq org-cycle-emulate-tab 'whitestart)
6731 (>= (match-end 0) pos))))
6733 (eq org-cycle-emulate-tab t))
6734 (call-interactively (global-key-binding "\t")))
6736 (t (save-excursion
6737 (org-back-to-heading)
6738 (org-cycle)))))))
6740 (defun org-cycle-internal-global ()
6741 "Do the global cycling action."
6742 ;; Hack to avoid display of messages for .org attachments in Gnus
6743 (let ((ga (string-match "\\*fontification" (buffer-name))))
6744 (cond
6745 ((and (eq last-command this-command)
6746 (eq org-cycle-global-status 'overview))
6747 ;; We just created the overview - now do table of contents
6748 ;; This can be slow in very large buffers, so indicate action
6749 (run-hook-with-args 'org-pre-cycle-hook 'contents)
6750 (unless ga (org-unlogged-message "CONTENTS..."))
6751 (org-content)
6752 (unless ga (org-unlogged-message "CONTENTS...done"))
6753 (setq org-cycle-global-status 'contents)
6754 (run-hook-with-args 'org-cycle-hook 'contents))
6756 ((and (eq last-command this-command)
6757 (eq org-cycle-global-status 'contents))
6758 ;; We just showed the table of contents - now show everything
6759 (run-hook-with-args 'org-pre-cycle-hook 'all)
6760 (show-all)
6761 (unless ga (org-unlogged-message "SHOW ALL"))
6762 (setq org-cycle-global-status 'all)
6763 (run-hook-with-args 'org-cycle-hook 'all))
6766 ;; Default action: go to overview
6767 (run-hook-with-args 'org-pre-cycle-hook 'overview)
6768 (org-overview)
6769 (unless ga (org-unlogged-message "OVERVIEW"))
6770 (setq org-cycle-global-status 'overview)
6771 (run-hook-with-args 'org-cycle-hook 'overview)))))
6773 (defvar org-called-with-limited-levels);Dyn-bound in ̀org-with-limited-levels'.
6775 (defun org-cycle-internal-local ()
6776 "Do the local cycling action."
6777 (let ((goal-column 0) eoh eol eos has-children children-skipped struct)
6778 ;; First, determine end of headline (EOH), end of subtree or item
6779 ;; (EOS), and if item or heading has children (HAS-CHILDREN).
6780 (save-excursion
6781 (if (org-at-item-p)
6782 (progn
6783 (beginning-of-line)
6784 (setq struct (org-list-struct))
6785 (setq eoh (point-at-eol))
6786 (setq eos (org-list-get-item-end-before-blank (point) struct))
6787 (setq has-children (org-list-has-child-p (point) struct)))
6788 (org-back-to-heading)
6789 (setq eoh (save-excursion (outline-end-of-heading) (point)))
6790 (setq eos (save-excursion (1- (org-end-of-subtree t t))))
6791 (setq has-children
6792 (or (save-excursion
6793 (let ((level (funcall outline-level)))
6794 (outline-next-heading)
6795 (and (org-at-heading-p t)
6796 (> (funcall outline-level) level))))
6797 (save-excursion
6798 (org-list-search-forward (org-item-beginning-re) eos t)))))
6799 ;; Determine end invisible part of buffer (EOL)
6800 (beginning-of-line 2)
6801 ;; XEmacs doesn't have `next-single-char-property-change'
6802 (if (featurep 'xemacs)
6803 (while (and (not (eobp)) ;; this is like `next-line'
6804 (get-char-property (1- (point)) 'invisible))
6805 (beginning-of-line 2))
6806 (while (and (not (eobp)) ;; this is like `next-line'
6807 (get-char-property (1- (point)) 'invisible))
6808 (goto-char (next-single-char-property-change (point) 'invisible))
6809 (and (eolp) (beginning-of-line 2))))
6810 (setq eol (point)))
6811 ;; Find out what to do next and set `this-command'
6812 (cond
6813 ((= eos eoh)
6814 ;; Nothing is hidden behind this heading
6815 (unless (org-before-first-heading-p)
6816 (run-hook-with-args 'org-pre-cycle-hook 'empty))
6817 (org-unlogged-message "EMPTY ENTRY")
6818 (setq org-cycle-subtree-status nil)
6819 (save-excursion
6820 (goto-char eos)
6821 (outline-next-heading)
6822 (if (outline-invisible-p) (org-flag-heading nil))))
6823 ((and (or (>= eol eos)
6824 (not (string-match "\\S-" (buffer-substring eol eos))))
6825 (or has-children
6826 (not (setq children-skipped
6827 org-cycle-skip-children-state-if-no-children))))
6828 ;; Entire subtree is hidden in one line: children view
6829 (unless (org-before-first-heading-p)
6830 (run-hook-with-args 'org-pre-cycle-hook 'children))
6831 (if (org-at-item-p)
6832 (org-list-set-item-visibility (point-at-bol) struct 'children)
6833 (org-show-entry)
6834 (org-with-limited-levels (show-children))
6835 ;; FIXME: This slows down the func way too much.
6836 ;; How keep drawers hidden in subtree anyway?
6837 ;; (when (memq 'org-cycle-hide-drawers org-cycle-hook)
6838 ;; (org-cycle-hide-drawers 'subtree))
6840 ;; Fold every list in subtree to top-level items.
6841 (when (eq org-cycle-include-plain-lists 'integrate)
6842 (save-excursion
6843 (org-back-to-heading)
6844 (while (org-list-search-forward (org-item-beginning-re) eos t)
6845 (beginning-of-line 1)
6846 (let* ((struct (org-list-struct))
6847 (prevs (org-list-prevs-alist struct))
6848 (end (org-list-get-bottom-point struct)))
6849 (mapc (lambda (e) (org-list-set-item-visibility e struct 'folded))
6850 (org-list-get-all-items (point) struct prevs))
6851 (goto-char (if (< end eos) end eos)))))))
6852 (org-unlogged-message "CHILDREN")
6853 (save-excursion
6854 (goto-char eos)
6855 (outline-next-heading)
6856 (if (outline-invisible-p) (org-flag-heading nil)))
6857 (setq org-cycle-subtree-status 'children)
6858 (unless (org-before-first-heading-p)
6859 (run-hook-with-args 'org-cycle-hook 'children)))
6860 ((or children-skipped
6861 (and (eq last-command this-command)
6862 (eq org-cycle-subtree-status 'children)))
6863 ;; We just showed the children, or no children are there,
6864 ;; now show everything.
6865 (unless (org-before-first-heading-p)
6866 (run-hook-with-args 'org-pre-cycle-hook 'subtree))
6867 (outline-flag-region eoh eos nil)
6868 (org-unlogged-message
6869 (if children-skipped "SUBTREE (NO CHILDREN)" "SUBTREE"))
6870 (setq org-cycle-subtree-status 'subtree)
6871 (unless (org-before-first-heading-p)
6872 (run-hook-with-args 'org-cycle-hook 'subtree)))
6874 ;; Default action: hide the subtree.
6875 (run-hook-with-args 'org-pre-cycle-hook 'folded)
6876 (outline-flag-region eoh eos t)
6877 (org-unlogged-message "FOLDED")
6878 (setq org-cycle-subtree-status 'folded)
6879 (unless (org-before-first-heading-p)
6880 (run-hook-with-args 'org-cycle-hook 'folded))))))
6882 ;;;###autoload
6883 (defun org-global-cycle (&optional arg)
6884 "Cycle the global visibility. For details see `org-cycle'.
6885 With \\[universal-argument] prefix arg, switch to startup visibility.
6886 With a numeric prefix, show all headlines up to that level."
6887 (interactive "P")
6888 (let ((org-cycle-include-plain-lists
6889 (if (derived-mode-p 'org-mode) org-cycle-include-plain-lists nil)))
6890 (cond
6891 ((integerp arg)
6892 (show-all)
6893 (hide-sublevels arg)
6894 (setq org-cycle-global-status 'contents))
6895 ((equal arg '(4))
6896 (org-set-startup-visibility)
6897 (org-unlogged-message "Startup visibility, plus VISIBILITY properties."))
6899 (org-cycle '(4))))))
6901 (defun org-set-startup-visibility ()
6902 "Set the visibility required by startup options and properties."
6903 (cond
6904 ((eq org-startup-folded t)
6905 (org-overview))
6906 ((eq org-startup-folded 'content)
6907 (org-content))
6908 ((or (eq org-startup-folded 'showeverything)
6909 (eq org-startup-folded nil))
6910 (show-all)))
6911 (unless (eq org-startup-folded 'showeverything)
6912 (if org-hide-block-startup (org-hide-block-all))
6913 (org-set-visibility-according-to-property 'no-cleanup)
6914 (org-cycle-hide-archived-subtrees 'all)
6915 (org-cycle-hide-drawers 'all)
6916 (org-cycle-show-empty-lines t)))
6918 (defun org-set-visibility-according-to-property (&optional no-cleanup)
6919 "Switch subtree visibilities according to :VISIBILITY: property."
6920 (interactive)
6921 (let (org-show-entry-below state)
6922 (save-excursion
6923 (goto-char (point-min))
6924 (while (re-search-forward
6925 "^[ \t]*:VISIBILITY:[ \t]+\\([a-z]+\\)"
6926 nil t)
6927 (setq state (match-string 1))
6928 (save-excursion
6929 (org-back-to-heading t)
6930 (hide-subtree)
6931 (org-reveal)
6932 (cond
6933 ((equal state '("fold" "folded"))
6934 (hide-subtree))
6935 ((equal state "children")
6936 (org-show-hidden-entry)
6937 (show-children))
6938 ((equal state "content")
6939 (save-excursion
6940 (save-restriction
6941 (org-narrow-to-subtree)
6942 (org-content))))
6943 ((member state '("all" "showall"))
6944 (show-subtree)))))
6945 (unless no-cleanup
6946 (org-cycle-hide-archived-subtrees 'all)
6947 (org-cycle-hide-drawers 'all)
6948 (org-cycle-show-empty-lines 'all)))))
6950 ;; This function uses outline-regexp instead of the more fundamental
6951 ;; org-outline-regexp so that org-cycle-global works outside of Org
6952 ;; buffers, where outline-regexp is needed.
6953 (defun org-overview ()
6954 "Switch to overview mode, showing only top-level headlines.
6955 Really, this shows all headlines with level equal or greater than the level
6956 of the first headline in the buffer. This is important, because if the
6957 first headline is not level one, then (hide-sublevels 1) gives confusing
6958 results."
6959 (interactive)
6960 (let ((pos (point))
6961 (level (save-excursion
6962 (goto-char (point-min))
6963 (if (re-search-forward (concat "^" outline-regexp) nil t)
6964 (progn
6965 (goto-char (match-beginning 0))
6966 (funcall outline-level))))))
6967 (and level (hide-sublevels level))
6968 (recenter '(4))
6969 (goto-char pos)))
6971 (defun org-content (&optional arg)
6972 "Show all headlines in the buffer, like a table of contents.
6973 With numerical argument N, show content up to level N."
6974 (interactive "P")
6975 (org-overview)
6976 (save-excursion
6977 ;; Visit all headings and show their offspring
6978 (and (integerp arg) (org-overview))
6979 (goto-char (point-max))
6980 (catch 'exit
6981 (while (and (progn (condition-case nil
6982 (outline-previous-visible-heading 1)
6983 (error (goto-char (point-min))))
6985 (looking-at org-outline-regexp))
6986 (if (integerp arg)
6987 (show-children (1- arg))
6988 (show-branches))
6989 (if (bobp) (throw 'exit nil))))))
6991 (defun org-optimize-window-after-visibility-change (state)
6992 "Adjust the window after a change in outline visibility.
6993 This function is the default value of the hook `org-cycle-hook'."
6994 (when (get-buffer-window (current-buffer))
6995 (cond
6996 ((eq state 'content) nil)
6997 ((eq state 'all) nil)
6998 ((eq state 'folded) nil)
6999 ((eq state 'children) (or (org-subtree-end-visible-p) (recenter 1)))
7000 ((eq state 'subtree) (or (org-subtree-end-visible-p) (recenter 1))))))
7002 (defun org-remove-empty-overlays-at (pos)
7003 "Remove outline overlays that do not contain non-white stuff."
7004 (mapc
7005 (lambda (o)
7006 (and (eq 'outline (overlay-get o 'invisible))
7007 (not (string-match "\\S-" (buffer-substring (overlay-start o)
7008 (overlay-end o))))
7009 (delete-overlay o)))
7010 (overlays-at pos)))
7012 (defun org-clean-visibility-after-subtree-move ()
7013 "Fix visibility issues after moving a subtree."
7014 ;; First, find a reasonable region to look at:
7015 ;; Start two siblings above, end three below
7016 (let* ((beg (save-excursion
7017 (and (org-get-last-sibling)
7018 (org-get-last-sibling))
7019 (point)))
7020 (end (save-excursion
7021 (and (org-get-next-sibling)
7022 (org-get-next-sibling)
7023 (org-get-next-sibling))
7024 (if (org-at-heading-p)
7025 (point-at-eol)
7026 (point))))
7027 (level (looking-at "\\*+"))
7028 (re (if level (concat "^" (regexp-quote (match-string 0)) " "))))
7029 (save-excursion
7030 (save-restriction
7031 (narrow-to-region beg end)
7032 (when re
7033 ;; Properly fold already folded siblings
7034 (goto-char (point-min))
7035 (while (re-search-forward re nil t)
7036 (if (and (not (outline-invisible-p))
7037 (save-excursion
7038 (goto-char (point-at-eol)) (outline-invisible-p)))
7039 (hide-entry))))
7040 (org-cycle-show-empty-lines 'overview)
7041 (org-cycle-hide-drawers 'overview)))))
7043 (defun org-cycle-show-empty-lines (state)
7044 "Show empty lines above all visible headlines.
7045 The region to be covered depends on STATE when called through
7046 `org-cycle-hook'. Lisp program can use t for STATE to get the
7047 entire buffer covered. Note that an empty line is only shown if there
7048 are at least `org-cycle-separator-lines' empty lines before the headline."
7049 (when (not (= org-cycle-separator-lines 0))
7050 (save-excursion
7051 (let* ((n (abs org-cycle-separator-lines))
7052 (re (cond
7053 ((= n 1) "\\(\n[ \t]*\n\\*+\\) ")
7054 ((= n 2) "^[ \t]*\\(\n[ \t]*\n\\*+\\) ")
7055 (t (let ((ns (number-to-string (- n 2))))
7056 (concat "^\\(?:[ \t]*\n\\)\\{" ns "," ns "\\}"
7057 "[ \t]*\\(\n[ \t]*\n\\*+\\) ")))))
7058 beg end b e)
7059 (cond
7060 ((memq state '(overview contents t))
7061 (setq beg (point-min) end (point-max)))
7062 ((memq state '(children folded))
7063 (setq beg (point) end (progn (org-end-of-subtree t t)
7064 (beginning-of-line 2)
7065 (point)))))
7066 (when beg
7067 (goto-char beg)
7068 (while (re-search-forward re end t)
7069 (unless (get-char-property (match-end 1) 'invisible)
7070 (setq e (match-end 1))
7071 (if (< org-cycle-separator-lines 0)
7072 (setq b (save-excursion
7073 (goto-char (match-beginning 0))
7074 (org-back-over-empty-lines)
7075 (if (save-excursion
7076 (goto-char (max (point-min) (1- (point))))
7077 (org-at-heading-p))
7078 (1- (point))
7079 (point))))
7080 (setq b (match-beginning 1)))
7081 (outline-flag-region b e nil)))))))
7082 ;; Never hide empty lines at the end of the file.
7083 (save-excursion
7084 (goto-char (point-max))
7085 (outline-previous-heading)
7086 (outline-end-of-heading)
7087 (if (and (looking-at "[ \t\n]+")
7088 (= (match-end 0) (point-max)))
7089 (outline-flag-region (point) (match-end 0) nil))))
7091 (defun org-show-empty-lines-in-parent ()
7092 "Move to the parent and re-show empty lines before visible headlines."
7093 (save-excursion
7094 (let ((context (if (org-up-heading-safe) 'children 'overview)))
7095 (org-cycle-show-empty-lines context))))
7097 (defun org-files-list ()
7098 "Return `org-agenda-files' list, plus all open org-mode files.
7099 This is useful for operations that need to scan all of a user's
7100 open and agenda-wise Org files."
7101 (let ((files (mapcar 'expand-file-name (org-agenda-files))))
7102 (dolist (buf (buffer-list))
7103 (with-current-buffer buf
7104 (if (and (derived-mode-p 'org-mode) (buffer-file-name))
7105 (let ((file (expand-file-name (buffer-file-name))))
7106 (unless (member file files)
7107 (push file files))))))
7108 files))
7110 (defsubst org-entry-beginning-position ()
7111 "Return the beginning position of the current entry."
7112 (save-excursion (outline-back-to-heading t) (point)))
7114 (defsubst org-entry-end-position ()
7115 "Return the end position of the current entry."
7116 (save-excursion (outline-next-heading) (point)))
7118 (defun org-cycle-hide-drawers (state &optional exceptions)
7119 "Re-hide all drawers after a visibility state change.
7120 When non-nil, optional argument EXCEPTIONS is a list of strings
7121 specifying which drawers should not be hidden."
7122 (when (and (derived-mode-p 'org-mode)
7123 (not (memq state '(overview folded contents))))
7124 (save-excursion
7125 (let* ((globalp (memq state '(contents all)))
7126 (beg (if globalp (point-min) (point)))
7127 (end (if globalp (point-max)
7128 (if (eq state 'children)
7129 (save-excursion (outline-next-heading) (point))
7130 (org-end-of-subtree t)))))
7131 (goto-char beg)
7132 (while (re-search-forward org-drawer-regexp (max end (point)) t)
7133 (unless (member-ignore-case (match-string 1) exceptions)
7134 (let ((drawer (org-element-at-point)))
7135 (when (memq (org-element-type drawer) '(drawer property-drawer))
7136 (org-flag-drawer t drawer)
7137 ;; Make sure to skip drawer entirely or we might flag
7138 ;; it another time when matching its ending line with
7139 ;; `org-drawer-regexp'.
7140 (goto-char (org-element-property :end drawer))))))))))
7142 (defun org-cycle-hide-inline-tasks (state)
7143 "Re-hide inline tasks when switching to 'contents or 'children
7144 visibility state."
7145 (case state
7146 (contents
7147 (when (org-bound-and-true-p org-inlinetask-min-level)
7148 (hide-sublevels (1- org-inlinetask-min-level))))
7149 (children
7150 (when (featurep 'org-inlinetask)
7151 (save-excursion
7152 (while (and (outline-next-heading)
7153 (org-inlinetask-at-task-p))
7154 (org-inlinetask-toggle-visibility)
7155 (org-inlinetask-goto-end)))))))
7157 (defun org-flag-drawer (flag &optional element)
7158 "When FLAG is non-nil, hide the drawer we are at.
7159 Otherwise make it visible. When optional argument ELEMENT is
7160 a parsed drawer, as returned by `org-element-at-point', hide or
7161 show that drawer instead."
7162 (let ((drawer (or element (org-element-at-point))))
7163 (when (memq (org-element-type drawer) '(drawer property-drawer))
7164 (save-excursion
7165 (goto-char (org-element-property :post-affiliated drawer))
7166 (outline-flag-region
7167 (line-end-position)
7168 (progn (goto-char (org-element-property :end drawer))
7169 (skip-chars-backward " \r\t\n")
7170 (line-end-position))
7171 flag)))))
7173 (defun org-subtree-end-visible-p ()
7174 "Is the end of the current subtree visible?"
7175 (pos-visible-in-window-p
7176 (save-excursion (org-end-of-subtree t) (point))))
7178 (defun org-first-headline-recenter (&optional N)
7179 "Move cursor to the first headline and recenter the headline.
7180 Optional argument N means put the headline into the Nth line of the window."
7181 (goto-char (point-min))
7182 (when (re-search-forward (concat "^\\(" org-outline-regexp "\\)") nil t)
7183 (beginning-of-line)
7184 (recenter (prefix-numeric-value N))))
7186 ;;; Saving and restoring visibility
7188 (defun org-outline-overlay-data (&optional use-markers)
7189 "Return a list of the locations of all outline overlays.
7190 These are overlays with the `invisible' property value `outline'.
7191 The return value is a list of cons cells, with start and stop
7192 positions for each overlay.
7193 If USE-MARKERS is set, return the positions as markers."
7194 (let (beg end)
7195 (save-excursion
7196 (save-restriction
7197 (widen)
7198 (delq nil
7199 (mapcar (lambda (o)
7200 (when (eq (overlay-get o 'invisible) 'outline)
7201 (setq beg (overlay-start o)
7202 end (overlay-end o))
7203 (and beg end (> end beg)
7204 (if use-markers
7205 (cons (copy-marker beg)
7206 (copy-marker end t))
7207 (cons beg end)))))
7208 (overlays-in (point-min) (point-max))))))))
7210 (defun org-set-outline-overlay-data (data)
7211 "Create visibility overlays for all positions in DATA.
7212 DATA should have been made by `org-outline-overlay-data'."
7213 (let (o)
7214 (save-excursion
7215 (save-restriction
7216 (widen)
7217 (show-all)
7218 (mapc (lambda (c)
7219 (outline-flag-region (car c) (cdr c) t))
7220 data)))))
7222 ;;; Folding of blocks
7224 (defvar org-hide-block-overlays nil
7225 "Overlays hiding blocks.")
7226 (make-variable-buffer-local 'org-hide-block-overlays)
7228 (defun org-block-map (function &optional start end)
7229 "Call FUNCTION at the head of all source blocks in the current buffer.
7230 Optional arguments START and END can be used to limit the range."
7231 (let ((start (or start (point-min)))
7232 (end (or end (point-max))))
7233 (save-excursion
7234 (goto-char start)
7235 (while (and (< (point) end) (re-search-forward org-block-regexp end t))
7236 (save-excursion
7237 (save-match-data
7238 (goto-char (match-beginning 0))
7239 (funcall function)))))))
7241 (defun org-hide-block-toggle-all ()
7242 "Toggle the visibility of all blocks in the current buffer."
7243 (org-block-map #'org-hide-block-toggle))
7245 (defun org-hide-block-all ()
7246 "Fold all blocks in the current buffer."
7247 (interactive)
7248 (org-show-block-all)
7249 (org-block-map #'org-hide-block-toggle-maybe))
7251 (defun org-show-block-all ()
7252 "Unfold all blocks in the current buffer."
7253 (interactive)
7254 (mapc 'delete-overlay org-hide-block-overlays)
7255 (setq org-hide-block-overlays nil))
7257 (defun org-hide-block-toggle-maybe ()
7258 "Toggle visibility of block at point."
7259 (interactive)
7260 (let ((case-fold-search t))
7261 (if (save-excursion
7262 (beginning-of-line 1)
7263 (looking-at org-block-regexp))
7264 (progn (org-hide-block-toggle)
7265 t) ;; to signal that we took action
7266 nil))) ;; to signal that we did not
7268 (defun org-hide-block-toggle (&optional force)
7269 "Toggle the visibility of the current block."
7270 (interactive)
7271 (save-excursion
7272 (beginning-of-line)
7273 (if (re-search-forward org-block-regexp nil t)
7274 (let ((start (- (match-beginning 4) 1)) ;; beginning of body
7275 (end (match-end 0)) ;; end of entire body
7277 (if (memq t (mapcar (lambda (overlay)
7278 (eq (overlay-get overlay 'invisible)
7279 'org-hide-block))
7280 (overlays-at start)))
7281 (if (or (not force) (eq force 'off))
7282 (mapc (lambda (ov)
7283 (when (member ov org-hide-block-overlays)
7284 (setq org-hide-block-overlays
7285 (delq ov org-hide-block-overlays)))
7286 (when (eq (overlay-get ov 'invisible)
7287 'org-hide-block)
7288 (delete-overlay ov)))
7289 (overlays-at start)))
7290 (setq ov (make-overlay start end))
7291 (overlay-put ov 'invisible 'org-hide-block)
7292 ;; make the block accessible to isearch
7293 (overlay-put
7294 ov 'isearch-open-invisible
7295 (lambda (ov)
7296 (when (member ov org-hide-block-overlays)
7297 (setq org-hide-block-overlays
7298 (delq ov org-hide-block-overlays)))
7299 (when (eq (overlay-get ov 'invisible)
7300 'org-hide-block)
7301 (delete-overlay ov))))
7302 (push ov org-hide-block-overlays)))
7303 (user-error "Not looking at a source block"))))
7305 ;; org-tab-after-check-for-cycling-hook
7306 (add-hook 'org-tab-first-hook 'org-hide-block-toggle-maybe)
7307 ;; Remove overlays when changing major mode
7308 (add-hook 'org-mode-hook
7309 (lambda () (org-add-hook 'change-major-mode-hook
7310 'org-show-block-all 'append 'local)))
7312 ;;; Org-goto
7314 (defvar org-goto-window-configuration nil)
7315 (defvar org-goto-marker nil)
7316 (defvar org-goto-map)
7317 (defun org-goto-map ()
7318 "Set the keymap `org-goto'."
7319 (setq org-goto-map
7320 (let ((map (make-sparse-keymap)))
7321 (let ((cmds '(isearch-forward isearch-backward kill-ring-save set-mark-command
7322 mouse-drag-region universal-argument org-occur))
7323 cmd)
7324 (while (setq cmd (pop cmds))
7325 (substitute-key-definition cmd cmd map global-map)))
7326 (suppress-keymap map)
7327 (org-defkey map "\C-m" 'org-goto-ret)
7328 (org-defkey map [(return)] 'org-goto-ret)
7329 (org-defkey map [(left)] 'org-goto-left)
7330 (org-defkey map [(right)] 'org-goto-right)
7331 (org-defkey map [(control ?g)] 'org-goto-quit)
7332 (org-defkey map "\C-i" 'org-cycle)
7333 (org-defkey map [(tab)] 'org-cycle)
7334 (org-defkey map [(down)] 'outline-next-visible-heading)
7335 (org-defkey map [(up)] 'outline-previous-visible-heading)
7336 (if org-goto-auto-isearch
7337 (if (fboundp 'define-key-after)
7338 (define-key-after map [t] 'org-goto-local-auto-isearch)
7339 nil)
7340 (org-defkey map "q" 'org-goto-quit)
7341 (org-defkey map "n" 'outline-next-visible-heading)
7342 (org-defkey map "p" 'outline-previous-visible-heading)
7343 (org-defkey map "f" 'outline-forward-same-level)
7344 (org-defkey map "b" 'outline-backward-same-level)
7345 (org-defkey map "u" 'outline-up-heading))
7346 (org-defkey map "/" 'org-occur)
7347 (org-defkey map "\C-c\C-n" 'outline-next-visible-heading)
7348 (org-defkey map "\C-c\C-p" 'outline-previous-visible-heading)
7349 (org-defkey map "\C-c\C-f" 'outline-forward-same-level)
7350 (org-defkey map "\C-c\C-b" 'outline-backward-same-level)
7351 (org-defkey map "\C-c\C-u" 'outline-up-heading)
7352 map)))
7354 (defconst org-goto-help
7355 "Browse buffer copy, to find location or copy text.%s
7356 RET=jump to location C-g=quit and return to previous location
7357 \[Up]/[Down]=next/prev headline TAB=cycle visibility [/] org-occur")
7359 (defvar org-goto-start-pos) ; dynamically scoped parameter
7361 (defun org-goto (&optional alternative-interface)
7362 "Look up a different location in the current file, keeping current visibility.
7364 When you want look-up or go to a different location in a
7365 document, the fastest way is often to fold the entire buffer and
7366 then dive into the tree. This method has the disadvantage, that
7367 the previous location will be folded, which may not be what you
7368 want.
7370 This command works around this by showing a copy of the current
7371 buffer in an indirect buffer, in overview mode. You can dive
7372 into the tree in that copy, use org-occur and incremental search
7373 to find a location. When pressing RET or `Q', the command
7374 returns to the original buffer in which the visibility is still
7375 unchanged. After RET it will also jump to the location selected
7376 in the indirect buffer and expose the headline hierarchy above.
7378 With a prefix argument, use the alternative interface: e.g. if
7379 `org-goto-interface' is 'outline use 'outline-path-completion."
7380 (interactive "P")
7381 (org-goto-map)
7382 (let* ((org-refile-targets `((nil . (:maxlevel . ,org-goto-max-level))))
7383 (org-refile-use-outline-path t)
7384 (org-refile-target-verify-function nil)
7385 (interface
7386 (if (not alternative-interface)
7387 org-goto-interface
7388 (if (eq org-goto-interface 'outline)
7389 'outline-path-completion
7390 'outline)))
7391 (org-goto-start-pos (point))
7392 (selected-point
7393 (if (eq interface 'outline)
7394 (car (org-get-location (current-buffer) org-goto-help))
7395 (let ((pa (org-refile-get-location "Goto" nil nil t)))
7396 (org-refile-check-position pa)
7397 (nth 3 pa)))))
7398 (if selected-point
7399 (progn
7400 (org-mark-ring-push org-goto-start-pos)
7401 (goto-char selected-point)
7402 (if (or (outline-invisible-p) (org-invisible-p2))
7403 (org-show-context 'org-goto)))
7404 (message "Quit"))))
7406 (defvar org-goto-selected-point nil) ; dynamically scoped parameter
7407 (defvar org-goto-exit-command nil) ; dynamically scoped parameter
7408 (defvar org-goto-local-auto-isearch-map) ; defined below
7410 (defun org-get-location (buf help)
7411 "Let the user select a location in the Org-mode buffer BUF.
7412 This function uses a recursive edit. It returns the selected position
7413 or nil."
7414 (org-no-popups
7415 (let ((isearch-mode-map org-goto-local-auto-isearch-map)
7416 (isearch-hide-immediately nil)
7417 (isearch-search-fun-function
7418 (lambda () 'org-goto-local-search-headings))
7419 (org-goto-selected-point org-goto-exit-command))
7420 (save-excursion
7421 (save-window-excursion
7422 (delete-other-windows)
7423 (and (get-buffer "*org-goto*") (kill-buffer "*org-goto*"))
7424 (org-pop-to-buffer-same-window
7425 (condition-case nil
7426 (make-indirect-buffer (current-buffer) "*org-goto*")
7427 (error (make-indirect-buffer (current-buffer) "*org-goto*"))))
7428 (with-output-to-temp-buffer "*Org Help*"
7429 (princ (format help (if org-goto-auto-isearch
7430 " Just type for auto-isearch."
7431 " n/p/f/b/u to navigate, q to quit."))))
7432 (org-fit-window-to-buffer (get-buffer-window "*Org Help*"))
7433 (setq buffer-read-only nil)
7434 (let ((org-startup-truncated t)
7435 (org-startup-folded nil)
7436 (org-startup-align-all-tables nil))
7437 (org-mode)
7438 (org-overview))
7439 (setq buffer-read-only t)
7440 (if (and (boundp 'org-goto-start-pos)
7441 (integer-or-marker-p org-goto-start-pos))
7442 (let ((org-show-hierarchy-above t)
7443 (org-show-siblings t)
7444 (org-show-following-heading t))
7445 (goto-char org-goto-start-pos)
7446 (and (outline-invisible-p) (org-show-context)))
7447 (goto-char (point-min)))
7448 (let (org-special-ctrl-a/e) (org-beginning-of-line))
7449 (message "Select location and press RET")
7450 (use-local-map org-goto-map)
7451 (recursive-edit)))
7452 (kill-buffer "*org-goto*")
7453 (cons org-goto-selected-point org-goto-exit-command))))
7455 (defvar org-goto-local-auto-isearch-map (make-sparse-keymap))
7456 (set-keymap-parent org-goto-local-auto-isearch-map isearch-mode-map)
7457 (define-key org-goto-local-auto-isearch-map "\C-i" 'isearch-other-control-char)
7458 (define-key org-goto-local-auto-isearch-map "\C-m" 'isearch-other-control-char)
7460 (defun org-goto-local-search-headings (string bound noerror)
7461 "Search and make sure that any matches are in headlines."
7462 (catch 'return
7463 (while (if isearch-forward
7464 (search-forward string bound noerror)
7465 (search-backward string bound noerror))
7466 (when (let ((context (mapcar 'car (save-match-data (org-context)))))
7467 (and (member :headline context)
7468 (not (member :tags context))))
7469 (throw 'return (point))))))
7471 (defun org-goto-local-auto-isearch ()
7472 "Start isearch."
7473 (interactive)
7474 (goto-char (point-min))
7475 (let ((keys (this-command-keys)))
7476 (when (eq (lookup-key isearch-mode-map keys) 'isearch-printing-char)
7477 (isearch-mode t)
7478 (isearch-process-search-char (string-to-char keys)))))
7480 (defun org-goto-ret (&optional arg)
7481 "Finish `org-goto' by going to the new location."
7482 (interactive "P")
7483 (setq org-goto-selected-point (point)
7484 org-goto-exit-command 'return)
7485 (throw 'exit nil))
7487 (defun org-goto-left ()
7488 "Finish `org-goto' by going to the new location."
7489 (interactive)
7490 (if (org-at-heading-p)
7491 (progn
7492 (beginning-of-line 1)
7493 (setq org-goto-selected-point (point)
7494 org-goto-exit-command 'left)
7495 (throw 'exit nil))
7496 (user-error "Not on a heading")))
7498 (defun org-goto-right ()
7499 "Finish `org-goto' by going to the new location."
7500 (interactive)
7501 (if (org-at-heading-p)
7502 (progn
7503 (setq org-goto-selected-point (point)
7504 org-goto-exit-command 'right)
7505 (throw 'exit nil))
7506 (user-error "Not on a heading")))
7508 (defun org-goto-quit ()
7509 "Finish `org-goto' without cursor motion."
7510 (interactive)
7511 (setq org-goto-selected-point nil)
7512 (setq org-goto-exit-command 'quit)
7513 (throw 'exit nil))
7515 ;;; Indirect buffer display of subtrees
7517 (defvar org-indirect-dedicated-frame nil
7518 "This is the frame being used for indirect tree display.")
7519 (defvar org-last-indirect-buffer nil)
7521 (defun org-tree-to-indirect-buffer (&optional arg)
7522 "Create indirect buffer and narrow it to current subtree.
7523 With a numerical prefix ARG, go up to this level and then take that tree.
7524 If ARG is negative, go up that many levels.
7526 If `org-indirect-buffer-display' is not `new-frame', the command removes the
7527 indirect buffer previously made with this command, to avoid proliferation of
7528 indirect buffers. However, when you call the command with a \
7529 \\[universal-argument] prefix, or
7530 when `org-indirect-buffer-display' is `new-frame', the last buffer
7531 is kept so that you can work with several indirect buffers at the same time.
7532 If `org-indirect-buffer-display' is `dedicated-frame', the \
7533 \\[universal-argument] prefix also
7534 requests that a new frame be made for the new buffer, so that the dedicated
7535 frame is not changed."
7536 (interactive "P")
7537 (let ((cbuf (current-buffer))
7538 (cwin (selected-window))
7539 (pos (point))
7540 beg end level heading ibuf)
7541 (save-excursion
7542 (org-back-to-heading t)
7543 (when (numberp arg)
7544 (setq level (org-outline-level))
7545 (if (< arg 0) (setq arg (+ level arg)))
7546 (while (> (setq level (org-outline-level)) arg)
7547 (org-up-heading-safe)))
7548 (setq beg (point)
7549 heading (org-get-heading))
7550 (org-end-of-subtree t t)
7551 (if (org-at-heading-p) (backward-char 1))
7552 (setq end (point)))
7553 (if (and (buffer-live-p org-last-indirect-buffer)
7554 (not (eq org-indirect-buffer-display 'new-frame))
7555 (not arg))
7556 (kill-buffer org-last-indirect-buffer))
7557 (setq ibuf (org-get-indirect-buffer cbuf heading)
7558 org-last-indirect-buffer ibuf)
7559 (cond
7560 ((or (eq org-indirect-buffer-display 'new-frame)
7561 (and arg (eq org-indirect-buffer-display 'dedicated-frame)))
7562 (select-frame (make-frame))
7563 (delete-other-windows)
7564 (org-pop-to-buffer-same-window ibuf)
7565 (org-set-frame-title heading))
7566 ((eq org-indirect-buffer-display 'dedicated-frame)
7567 (raise-frame
7568 (select-frame (or (and org-indirect-dedicated-frame
7569 (frame-live-p org-indirect-dedicated-frame)
7570 org-indirect-dedicated-frame)
7571 (setq org-indirect-dedicated-frame (make-frame)))))
7572 (delete-other-windows)
7573 (org-pop-to-buffer-same-window ibuf)
7574 (org-set-frame-title (concat "Indirect: " heading)))
7575 ((eq org-indirect-buffer-display 'current-window)
7576 (org-pop-to-buffer-same-window ibuf))
7577 ((eq org-indirect-buffer-display 'other-window)
7578 (pop-to-buffer ibuf))
7579 (t (error "Invalid value")))
7580 (if (featurep 'xemacs)
7581 (save-excursion (org-mode) (turn-on-font-lock)))
7582 (narrow-to-region beg end)
7583 (show-all)
7584 (goto-char pos)
7585 (run-hook-with-args 'org-cycle-hook 'all)
7586 (and (window-live-p cwin) (select-window cwin))))
7588 (defun org-get-indirect-buffer (&optional buffer heading)
7589 (setq buffer (or buffer (current-buffer)))
7590 (let ((n 1) (base (buffer-name buffer)) bname)
7591 (while (buffer-live-p
7592 (get-buffer
7593 (setq bname
7594 (concat base "-"
7595 (if heading (concat heading "-" (number-to-string n))
7596 (number-to-string n))))))
7597 (setq n (1+ n)))
7598 (condition-case nil
7599 (make-indirect-buffer buffer bname 'clone)
7600 (error (make-indirect-buffer buffer bname)))))
7602 (defun org-set-frame-title (title)
7603 "Set the title of the current frame to the string TITLE."
7604 ;; FIXME: how to name a single frame in XEmacs???
7605 (unless (featurep 'xemacs)
7606 (modify-frame-parameters (selected-frame) (list (cons 'name title)))))
7608 ;;;; Structure editing
7610 ;;; Inserting headlines
7612 (defun org-previous-line-empty-p (&optional next)
7613 "Is the previous line a blank line?
7614 When NEXT is non-nil, check the next line instead."
7615 (save-excursion
7616 (and (not (bobp))
7617 (or (beginning-of-line (if next 2 0)) t)
7618 (save-match-data
7619 (looking-at "[ \t]*$")))))
7621 (defun org-insert-heading (&optional arg invisible-ok)
7622 "Insert a new heading or item with same depth at point.
7623 If point is in a plain list and ARG is nil, create a new list item.
7624 With one universal prefix argument, insert a heading even in lists.
7625 With two universal prefix arguments, insert the heading at the end
7626 of the parent subtree.
7628 If point is at the beginning of a headline, insert a sibling before
7629 the current headline. If point is not at the beginning, split the line
7630 and create a new headline with the text in the current line after point
7631 \(see `org-M-RET-may-split-line' on how to modify this behavior).
7633 If point is at the beginning of a normal line, turn this line into
7634 a heading.
7636 When INVISIBLE-OK is set, stop at invisible headlines when going back.
7637 This is important for non-interactive uses of the command."
7638 (interactive "P")
7639 (if (org-called-interactively-p 'any) (org-reveal))
7640 (let ((itemp (org-in-item-p))
7641 (may-split (org-get-alist-option org-M-RET-may-split-line 'headline))
7642 (respect-content (or org-insert-heading-respect-content
7643 (equal arg '(16))))
7644 (initial-content "")
7645 (adjust-empty-lines t))
7647 (cond
7649 ((or (= (buffer-size) 0)
7650 (and (not (save-excursion
7651 (and (ignore-errors (org-back-to-heading invisible-ok))
7652 (org-at-heading-p))))
7653 (or arg (not itemp))))
7654 ;; At beginning of buffer or so high up that only a heading
7655 ;; makes sense.
7656 (insert
7657 (if (or (bobp) (org-previous-line-empty-p)) "" "\n")
7658 (if (org-in-src-block-p) ",* " "* "))
7659 (run-hooks 'org-insert-heading-hook))
7661 ((and itemp (not (equal arg '(4))))
7662 ;; Insert an item
7663 (org-insert-item))
7666 ;; Insert a heading
7667 (save-restriction
7668 (widen)
7669 (let* ((level nil)
7670 (on-heading (org-at-heading-p))
7671 (empty-line-p (if on-heading
7672 (org-previous-line-empty-p)
7673 ;; We will decide later
7674 nil))
7675 ;; Get a level string to fall back on
7676 (fix-level
7677 (save-excursion
7678 (org-back-to-heading t)
7679 (if (org-previous-line-empty-p) (setq empty-line-p t))
7680 (looking-at org-outline-regexp)
7681 (make-string (1- (length (match-string 0))) ?*)))
7682 (stars
7683 (save-excursion
7684 (condition-case nil
7685 (progn
7686 (org-back-to-heading invisible-ok)
7687 (when (and (not on-heading)
7688 (featurep 'org-inlinetask)
7689 (integerp org-inlinetask-min-level)
7690 (>= (length (match-string 0))
7691 org-inlinetask-min-level))
7692 ;; Find a heading level before the inline task
7693 (while (and (setq level (org-up-heading-safe))
7694 (>= level org-inlinetask-min-level)))
7695 (if (org-at-heading-p)
7696 (org-back-to-heading invisible-ok)
7697 (error "This should not happen")))
7698 (unless (and (save-excursion
7699 (save-match-data
7700 (org-backward-heading-same-level
7701 1 invisible-ok))
7702 (= (point) (match-beginning 0)))
7703 (not (org-previous-line-empty-p t)))
7704 (setq empty-line-p (or empty-line-p
7705 (org-previous-line-empty-p))))
7706 (match-string 0))
7707 (error (or fix-level "* ")))))
7708 (blank-a (cdr (assq 'heading org-blank-before-new-entry)))
7709 (blank (if (eq blank-a 'auto) empty-line-p blank-a))
7710 pos hide-previous previous-pos)
7712 ;; If we insert after content, move there and clean up whitespace
7713 (when respect-content
7714 (org-end-of-subtree nil t)
7715 (skip-chars-backward " \r\n")
7716 (and (looking-at "[ \t]+") (replace-match ""))
7717 (unless (eobp) (forward-char 1))
7718 (when (looking-at "^\\*")
7719 (unless (bobp) (backward-char 1))
7720 (insert "\n")))
7722 ;; If we are splitting, grab the text that should be moved to the new headline
7723 (when may-split
7724 (if (org-on-heading-p)
7725 ;; This is a heading, we split intelligently (keeping tags)
7726 (let ((pos (point)))
7727 (goto-char (point-at-bol))
7728 (unless (looking-at org-complex-heading-regexp)
7729 (error "This should not happen"))
7730 (when (and (match-beginning 4)
7731 (> pos (match-beginning 4))
7732 (< pos (match-end 4)))
7733 (setq initial-content (buffer-substring pos (match-end 4)))
7734 (goto-char pos)
7735 (delete-region (point) (match-end 4))
7736 (if (looking-at "[ \t]*$")
7737 (replace-match "")
7738 (insert (make-string (length initial-content) ?\ )))
7739 (setq initial-content (org-trim initial-content)))
7740 (goto-char pos))
7741 ;; a normal line
7742 (unless (bolp)
7743 (setq initial-content (buffer-substring (point) (point-at-eol)))
7744 (delete-region (point) (point-at-eol))
7745 (setq initial-content (org-trim initial-content)))))
7747 ;; If we are at the beginning of the line, insert before it. Else after
7748 (cond
7749 ((and (bolp) (looking-at "[ \t]*$")))
7750 ((and (bolp) (not (looking-at "[ \t]*$")))
7751 (open-line 1))
7753 (goto-char (point-at-eol))
7754 (insert "\n")))
7756 ;; Insert the new heading
7757 (insert stars)
7758 (just-one-space)
7759 (insert initial-content)
7760 (when adjust-empty-lines
7761 (if (or (not blank)
7762 (and blank (not (org-previous-line-empty-p))))
7763 (org-N-empty-lines-before-current (if blank 1 0))))
7764 (run-hooks 'org-insert-heading-hook)))))))
7766 (defun org-N-empty-lines-before-current (N)
7767 "Make the number of empty lines before current exactly N.
7768 So this will delete or add empty lines."
7769 (save-excursion
7770 (goto-char (point-at-bol))
7771 (if (looking-back "\\s-+" nil 'greedy)
7772 (replace-match ""))
7773 (or (bobp) (insert "\n"))
7774 (while (> N 0)
7775 (insert "\n")
7776 (setq N (1- N)))))
7778 (defun org-get-heading (&optional no-tags no-todo)
7779 "Return the heading of the current entry, without the stars.
7780 When NO-TAGS is non-nil, don't include tags.
7781 When NO-TODO is non-nil, don't include TODO keywords."
7782 (save-excursion
7783 (org-back-to-heading t)
7784 (cond
7785 ((and no-tags no-todo)
7786 (looking-at org-complex-heading-regexp)
7787 (match-string 4))
7788 (no-tags
7789 (looking-at (concat org-outline-regexp
7790 "\\(.*?\\)"
7791 "\\(?:[ \t]+:[[:alnum:]:_@#%]+:\\)?[ \t]*$"))
7792 (match-string 1))
7793 (no-todo
7794 (looking-at org-todo-line-regexp)
7795 (match-string 3))
7796 (t (looking-at org-heading-regexp)
7797 (match-string 2)))))
7799 (defvar orgstruct-mode) ; defined below
7801 (defun org-heading-components ()
7802 "Return the components of the current heading.
7803 This is a list with the following elements:
7804 - the level as an integer
7805 - the reduced level, different if `org-odd-levels-only' is set.
7806 - the TODO keyword, or nil
7807 - the priority character, like ?A, or nil if no priority is given
7808 - the headline text itself, or the tags string if no headline text
7809 - the tags string, or nil."
7810 (save-excursion
7811 (org-back-to-heading t)
7812 (if (let (case-fold-search)
7813 (looking-at
7814 (if orgstruct-mode
7815 org-heading-regexp
7816 org-complex-heading-regexp)))
7817 (if orgstruct-mode
7818 (list (length (match-string 1))
7819 (org-reduced-level (length (match-string 1)))
7822 (match-string 2)
7823 nil)
7824 (list (length (match-string 1))
7825 (org-reduced-level (length (match-string 1)))
7826 (org-match-string-no-properties 2)
7827 (and (match-end 3) (aref (match-string 3) 2))
7828 (org-match-string-no-properties 4)
7829 (org-match-string-no-properties 5))))))
7831 (defun org-get-entry ()
7832 "Get the entry text, after heading, entire subtree."
7833 (save-excursion
7834 (org-back-to-heading t)
7835 (buffer-substring (point-at-bol 2) (org-end-of-subtree t))))
7837 (defun org-insert-heading-after-current ()
7838 "Insert a new heading with same level as current, after current subtree."
7839 (interactive)
7840 (org-back-to-heading)
7841 (org-insert-heading)
7842 (org-move-subtree-down)
7843 (end-of-line 1))
7845 (defun org-insert-heading-respect-content (&optional arg invisible-ok)
7846 "Insert heading with `org-insert-heading-respect-content' set to t."
7847 (interactive "P")
7848 (let ((org-insert-heading-respect-content t))
7849 (org-insert-heading '(4) invisible-ok)))
7851 (defun org-insert-todo-heading-respect-content (&optional force-state)
7852 "Insert TODO heading with `org-insert-heading-respect-content' set to t."
7853 (interactive "P")
7854 (let ((org-insert-heading-respect-content t))
7855 (org-insert-todo-heading force-state '(4))))
7857 (defun org-insert-todo-heading (arg &optional force-heading)
7858 "Insert a new heading with the same level and TODO state as current heading.
7859 If the heading has no TODO state, or if the state is DONE, use the first
7860 state (TODO by default). Also one prefix arg, force first state. With two
7861 prefix args, force inserting at the end of the parent subtree."
7862 (interactive "P")
7863 (when (or force-heading (not (org-insert-item 'checkbox)))
7864 (org-insert-heading (or (and (equal arg '(16)) '(16))
7865 force-heading))
7866 (save-excursion
7867 (org-back-to-heading)
7868 (outline-previous-heading)
7869 (looking-at org-todo-line-regexp))
7870 (let*
7871 ((new-mark-x
7872 (if (or arg
7873 (not (match-beginning 2))
7874 (member (match-string 2) org-done-keywords))
7875 (car org-todo-keywords-1)
7876 (match-string 2)))
7877 (new-mark
7879 (run-hook-with-args-until-success
7880 'org-todo-get-default-hook new-mark-x nil)
7881 new-mark-x)))
7882 (beginning-of-line 1)
7883 (and (looking-at org-outline-regexp) (goto-char (match-end 0))
7884 (if org-treat-insert-todo-heading-as-state-change
7885 (org-todo new-mark)
7886 (insert new-mark " "))))
7887 (when org-provide-todo-statistics
7888 (org-update-parent-todo-statistics))))
7890 (defun org-insert-subheading (arg)
7891 "Insert a new subheading and demote it.
7892 Works for outline headings and for plain lists alike."
7893 (interactive "P")
7894 (org-insert-heading arg)
7895 (cond
7896 ((org-at-heading-p) (org-do-demote))
7897 ((org-at-item-p) (org-indent-item))))
7899 (defun org-insert-todo-subheading (arg)
7900 "Insert a new subheading with TODO keyword or checkbox and demote it.
7901 Works for outline headings and for plain lists alike."
7902 (interactive "P")
7903 (org-insert-todo-heading arg)
7904 (cond
7905 ((org-at-heading-p) (org-do-demote))
7906 ((org-at-item-p) (org-indent-item))))
7908 ;;; Promotion and Demotion
7910 (defvar org-after-demote-entry-hook nil
7911 "Hook run after an entry has been demoted.
7912 The cursor will be at the beginning of the entry.
7913 When a subtree is being demoted, the hook will be called for each node.")
7915 (defvar org-after-promote-entry-hook nil
7916 "Hook run after an entry has been promoted.
7917 The cursor will be at the beginning of the entry.
7918 When a subtree is being promoted, the hook will be called for each node.")
7920 (defun org-promote-subtree ()
7921 "Promote the entire subtree.
7922 See also `org-promote'."
7923 (interactive)
7924 (save-excursion
7925 (org-with-limited-levels (org-map-tree 'org-promote)))
7926 (org-fix-position-after-promote))
7928 (defun org-demote-subtree ()
7929 "Demote the entire subtree. See `org-demote'.
7930 See also `org-promote'."
7931 (interactive)
7932 (save-excursion
7933 (org-with-limited-levels (org-map-tree 'org-demote)))
7934 (org-fix-position-after-promote))
7937 (defun org-do-promote ()
7938 "Promote the current heading higher up the tree.
7939 If the region is active in `transient-mark-mode', promote all headings
7940 in the region."
7941 (interactive)
7942 (save-excursion
7943 (if (org-region-active-p)
7944 (org-map-region 'org-promote (region-beginning) (region-end))
7945 (org-promote)))
7946 (org-fix-position-after-promote))
7948 (defun org-do-demote ()
7949 "Demote the current heading lower down the tree.
7950 If the region is active in `transient-mark-mode', demote all headings
7951 in the region."
7952 (interactive)
7953 (save-excursion
7954 (if (org-region-active-p)
7955 (org-map-region 'org-demote (region-beginning) (region-end))
7956 (org-demote)))
7957 (org-fix-position-after-promote))
7959 (defun org-fix-position-after-promote ()
7960 "Make sure that after pro/demotion cursor position is right."
7961 (let ((pos (point)))
7962 (when (save-excursion
7963 (beginning-of-line 1)
7964 (looking-at org-todo-line-regexp)
7965 (or (equal pos (match-end 1)) (equal pos (match-end 2))))
7966 (cond ((eobp) (insert " "))
7967 ((eolp) (insert " "))
7968 ((equal (char-after) ?\ ) (forward-char 1))))))
7970 (defun org-current-level ()
7971 "Return the level of the current entry, or nil if before the first headline.
7972 The level is the number of stars at the beginning of the headline."
7973 (save-excursion
7974 (org-with-limited-levels
7975 (if (ignore-errors (org-back-to-heading t))
7976 (funcall outline-level)))))
7978 (defun org-get-previous-line-level ()
7979 "Return the outline depth of the last headline before the current line.
7980 Returns 0 for the first headline in the buffer, and nil if before the
7981 first headline."
7982 (and (org-current-level)
7983 (or (and (/= (line-beginning-position) (point-min))
7984 (save-excursion (beginning-of-line 0) (org-current-level)))
7985 0)))
7987 (defun org-reduced-level (l)
7988 "Compute the effective level of a heading.
7989 This takes into account the setting of `org-odd-levels-only'."
7990 (cond
7991 ((zerop l) 0)
7992 (org-odd-levels-only (1+ (floor (/ l 2))))
7993 (t l)))
7995 (defun org-level-increment ()
7996 "Return the number of stars that will be added or removed at a
7997 time to headlines when structure editing, based on the value of
7998 `org-odd-levels-only'."
7999 (if org-odd-levels-only 2 1))
8001 (defun org-get-valid-level (level &optional change)
8002 "Rectify a level change under the influence of `org-odd-levels-only'
8003 LEVEL is a current level, CHANGE is by how much the level should be
8004 modified. Even if CHANGE is nil, LEVEL may be returned modified because
8005 even level numbers will become the next higher odd number."
8006 (if org-odd-levels-only
8007 (cond ((or (not change) (= 0 change)) (1+ (* 2 (/ level 2))))
8008 ((> change 0) (1+ (* 2 (/ (+ level (* 2 change)) 2))))
8009 ((< change 0) (max 1 (1+ (* 2 (/ (+ level (* 2 change)) 2))))))
8010 (max 1 (+ level (or change 0)))))
8012 (if (boundp 'define-obsolete-function-alias)
8013 (if (or (featurep 'xemacs) (< emacs-major-version 23))
8014 (define-obsolete-function-alias 'org-get-legal-level
8015 'org-get-valid-level)
8016 (define-obsolete-function-alias 'org-get-legal-level
8017 'org-get-valid-level "23.1")))
8019 (defun org-promote ()
8020 "Promote the current heading higher up the tree.
8021 If the region is active in `transient-mark-mode', promote all headings
8022 in the region."
8023 (org-back-to-heading t)
8024 (let* ((level (save-match-data (funcall outline-level)))
8025 (after-change-functions (remove 'flyspell-after-change-function
8026 after-change-functions))
8027 (up-head (concat (make-string (org-get-valid-level level -1) ?*) " "))
8028 (diff (abs (- level (length up-head) -1))))
8029 (cond ((and (= level 1) org-called-with-limited-levels
8030 org-allow-promoting-top-level-subtree)
8031 (replace-match "# " nil t))
8032 ((= level 1)
8033 (user-error "Cannot promote to level 0. UNDO to recover if necessary"))
8034 (t (replace-match up-head nil t)))
8035 ;; Fixup tag positioning
8036 (unless (= level 1)
8037 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8038 (if org-adapt-indentation (org-fixup-indentation (- diff))))
8039 (run-hooks 'org-after-promote-entry-hook)))
8041 (defun org-demote ()
8042 "Demote the current heading lower down the tree.
8043 If the region is active in `transient-mark-mode', demote all headings
8044 in the region."
8045 (org-back-to-heading t)
8046 (let* ((level (save-match-data (funcall outline-level)))
8047 (after-change-functions (remove 'flyspell-after-change-function
8048 after-change-functions))
8049 (down-head (concat (make-string (org-get-valid-level level 1) ?*) " "))
8050 (diff (abs (- level (length down-head) -1))))
8051 (replace-match down-head nil t)
8052 ;; Fixup tag positioning
8053 (and org-auto-align-tags (org-set-tags nil 'ignore-column))
8054 (if org-adapt-indentation (org-fixup-indentation diff))
8055 (run-hooks 'org-after-demote-entry-hook)))
8057 (defun org-cycle-level ()
8058 "Cycle the level of an empty headline through possible states.
8059 This goes first to child, then to parent, level, then up the hierarchy.
8060 After top level, it switches back to sibling level."
8061 (interactive)
8062 (let ((org-adapt-indentation nil))
8063 (when (org-point-at-end-of-empty-headline)
8064 (setq this-command 'org-cycle-level) ; Only needed for caching
8065 (let ((cur-level (org-current-level))
8066 (prev-level (org-get-previous-line-level)))
8067 (cond
8068 ;; If first headline in file, promote to top-level.
8069 ((= prev-level 0)
8070 (loop repeat (/ (- cur-level 1) (org-level-increment))
8071 do (org-do-promote)))
8072 ;; If same level as prev, demote one.
8073 ((= prev-level cur-level)
8074 (org-do-demote))
8075 ;; If parent is top-level, promote to top level if not already.
8076 ((= prev-level 1)
8077 (loop repeat (/ (- cur-level 1) (org-level-increment))
8078 do (org-do-promote)))
8079 ;; If top-level, return to prev-level.
8080 ((= cur-level 1)
8081 (loop repeat (/ (- prev-level 1) (org-level-increment))
8082 do (org-do-demote)))
8083 ;; If less than prev-level, promote one.
8084 ((< cur-level prev-level)
8085 (org-do-promote))
8086 ;; If deeper than prev-level, promote until higher than
8087 ;; prev-level.
8088 ((> cur-level prev-level)
8089 (loop repeat (+ 1 (/ (- cur-level prev-level) (org-level-increment)))
8090 do (org-do-promote))))
8091 t))))
8093 (defun org-map-tree (fun)
8094 "Call FUN for every heading underneath the current one."
8095 (org-back-to-heading)
8096 (let ((level (funcall outline-level)))
8097 (save-excursion
8098 (funcall fun)
8099 (while (and (progn
8100 (outline-next-heading)
8101 (> (funcall outline-level) level))
8102 (not (eobp)))
8103 (funcall fun)))))
8105 (defun org-map-region (fun beg end)
8106 "Call FUN for every heading between BEG and END."
8107 (let ((org-ignore-region t))
8108 (save-excursion
8109 (setq end (copy-marker end))
8110 (goto-char beg)
8111 (if (and (re-search-forward org-outline-regexp-bol nil t)
8112 (< (point) end))
8113 (funcall fun))
8114 (while (and (progn
8115 (outline-next-heading)
8116 (< (point) end))
8117 (not (eobp)))
8118 (funcall fun)))))
8120 (defvar org-property-end-re) ; silence byte-compiler
8121 (defun org-fixup-indentation (diff)
8122 "Change the indentation in the current entry by DIFF.
8123 However, if any line in the current entry has no indentation, or if it
8124 would end up with no indentation after the change, nothing at all is done."
8125 (save-excursion
8126 (let ((end (save-excursion (outline-next-heading)
8127 (point-marker)))
8128 (prohibit (if (> diff 0)
8129 "^\\S-"
8130 (concat "^ \\{0," (int-to-string (- diff)) "\\}\\S-")))
8131 col)
8132 (unless (save-excursion (end-of-line 1)
8133 (re-search-forward prohibit end t))
8134 (while (and (< (point) end)
8135 (re-search-forward "^[ \t]+" end t))
8136 (goto-char (match-end 0))
8137 (setq col (current-column))
8138 (if (< diff 0) (replace-match ""))
8139 (org-indent-to-column (+ diff col))))
8140 (move-marker end nil))))
8142 (defun org-convert-to-odd-levels ()
8143 "Convert an org-mode file with all levels allowed to one with odd levels.
8144 This will leave level 1 alone, convert level 2 to level 3, level 3 to
8145 level 5 etc."
8146 (interactive)
8147 (when (yes-or-no-p "Are you sure you want to globally change levels to odd? ")
8148 (let ((outline-level 'org-outline-level)
8149 (org-odd-levels-only nil) n)
8150 (save-excursion
8151 (goto-char (point-min))
8152 (while (re-search-forward "^\\*\\*+ " nil t)
8153 (setq n (- (length (match-string 0)) 2))
8154 (while (>= (setq n (1- n)) 0)
8155 (org-demote))
8156 (end-of-line 1))))))
8158 (defun org-convert-to-oddeven-levels ()
8159 "Convert an org-mode file with only odd levels to one with odd/even levels.
8160 This promotes level 3 to level 2, level 5 to level 3 etc. If the
8161 file contains a section with an even level, conversion would
8162 destroy the structure of the file. An error is signaled in this
8163 case."
8164 (interactive)
8165 (goto-char (point-min))
8166 ;; First check if there are no even levels
8167 (when (re-search-forward "^\\(\\*\\*\\)+ " nil t)
8168 (org-show-context t)
8169 (error "Not all levels are odd in this file. Conversion not possible"))
8170 (when (yes-or-no-p "Are you sure you want to globally change levels to odd-even? ")
8171 (let ((outline-regexp org-outline-regexp)
8172 (outline-level 'org-outline-level)
8173 (org-odd-levels-only nil) n)
8174 (save-excursion
8175 (goto-char (point-min))
8176 (while (re-search-forward "^\\*\\*+ " nil t)
8177 (setq n (/ (1- (length (match-string 0))) 2))
8178 (while (>= (setq n (1- n)) 0)
8179 (org-promote))
8180 (end-of-line 1))))))
8182 (defun org-tr-level (n)
8183 "Make N odd if required."
8184 (if org-odd-levels-only (1+ (/ n 2)) n))
8186 ;;; Vertical tree motion, cutting and pasting of subtrees
8188 (defun org-move-subtree-up (&optional arg)
8189 "Move the current subtree up past ARG headlines of the same level."
8190 (interactive "p")
8191 (org-move-subtree-down (- (prefix-numeric-value arg))))
8193 (defun org-move-subtree-down (&optional arg)
8194 "Move the current subtree down past ARG headlines of the same level."
8195 (interactive "p")
8196 (setq arg (prefix-numeric-value arg))
8197 (let ((movfunc (if (> arg 0) 'org-get-next-sibling
8198 'org-get-last-sibling))
8199 (ins-point (make-marker))
8200 (cnt (abs arg))
8201 (col (current-column))
8202 beg beg0 end txt folded ne-beg ne-end ne-ins ins-end)
8203 ;; Select the tree
8204 (org-back-to-heading)
8205 (setq beg0 (point))
8206 (save-excursion
8207 (setq ne-beg (org-back-over-empty-lines))
8208 (setq beg (point)))
8209 (save-match-data
8210 (save-excursion (outline-end-of-heading)
8211 (setq folded (outline-invisible-p)))
8212 (outline-end-of-subtree))
8213 (outline-next-heading)
8214 (setq ne-end (org-back-over-empty-lines))
8215 (setq end (point))
8216 (goto-char beg0)
8217 (when (and (> arg 0) (org-first-sibling-p) (< ne-end ne-beg))
8218 ;; include less whitespace
8219 (save-excursion
8220 (goto-char beg)
8221 (forward-line (- ne-beg ne-end))
8222 (setq beg (point))))
8223 ;; Find insertion point, with error handling
8224 (while (> cnt 0)
8225 (or (and (funcall movfunc) (looking-at org-outline-regexp))
8226 (progn (goto-char beg0)
8227 (user-error "Cannot move past superior level or buffer limit")))
8228 (setq cnt (1- cnt)))
8229 (if (> arg 0)
8230 ;; Moving forward - still need to move over subtree
8231 (progn (org-end-of-subtree t t)
8232 (save-excursion
8233 (org-back-over-empty-lines)
8234 (or (bolp) (newline)))))
8235 (setq ne-ins (org-back-over-empty-lines))
8236 (move-marker ins-point (point))
8237 (setq txt (buffer-substring beg end))
8238 (org-save-markers-in-region beg end)
8239 (delete-region beg end)
8240 (org-remove-empty-overlays-at beg)
8241 (or (= beg (point-min)) (outline-flag-region (1- beg) beg nil))
8242 (or (bobp) (outline-flag-region (1- (point)) (point) nil))
8243 (and (not (bolp)) (looking-at "\n") (forward-char 1))
8244 (let ((bbb (point)))
8245 (insert-before-markers txt)
8246 (org-reinstall-markers-in-region bbb)
8247 (move-marker ins-point bbb))
8248 (or (bolp) (insert "\n"))
8249 (setq ins-end (point))
8250 (goto-char ins-point)
8251 (org-skip-whitespace)
8252 (when (and (< arg 0)
8253 (org-first-sibling-p)
8254 (> ne-ins ne-beg))
8255 ;; Move whitespace back to beginning
8256 (save-excursion
8257 (goto-char ins-end)
8258 (let ((kill-whole-line t))
8259 (kill-line (- ne-ins ne-beg)) (point)))
8260 (insert (make-string (- ne-ins ne-beg) ?\n)))
8261 (move-marker ins-point nil)
8262 (if folded
8263 (hide-subtree)
8264 (org-show-entry)
8265 (show-children)
8266 (org-cycle-hide-drawers 'children))
8267 (org-clean-visibility-after-subtree-move)
8268 ;; move back to the initial column we were at
8269 (move-to-column col)))
8271 (defvar org-subtree-clip ""
8272 "Clipboard for cut and paste of subtrees.
8273 This is actually only a copy of the kill, because we use the normal kill
8274 ring. We need it to check if the kill was created by `org-copy-subtree'.")
8276 (defvar org-subtree-clip-folded nil
8277 "Was the last copied subtree folded?
8278 This is used to fold the tree back after pasting.")
8280 (defun org-cut-subtree (&optional n)
8281 "Cut the current subtree into the clipboard.
8282 With prefix arg N, cut this many sequential subtrees.
8283 This is a short-hand for marking the subtree and then cutting it."
8284 (interactive "p")
8285 (org-copy-subtree n 'cut))
8287 (defun org-copy-subtree (&optional n cut force-store-markers nosubtrees)
8288 "Copy the current subtree it in the clipboard.
8289 With prefix arg N, copy this many sequential subtrees.
8290 This is a short-hand for marking the subtree and then copying it.
8291 If CUT is non-nil, actually cut the subtree.
8292 If FORCE-STORE-MARKERS is non-nil, store the relative locations
8293 of some markers in the region, even if CUT is non-nil. This is
8294 useful if the caller implements cut-and-paste as copy-then-paste-then-cut."
8295 (interactive "p")
8296 (let (beg end folded (beg0 (point)))
8297 (if (org-called-interactively-p 'any)
8298 (org-back-to-heading nil) ; take what looks like a subtree
8299 (org-back-to-heading t)) ; take what is really there
8300 (setq beg (point))
8301 (skip-chars-forward " \t\r\n")
8302 (save-match-data
8303 (if nosubtrees
8304 (outline-next-heading)
8305 (save-excursion (outline-end-of-heading)
8306 (setq folded (outline-invisible-p)))
8307 (condition-case nil
8308 (org-forward-heading-same-level (1- n) t)
8309 (error nil))
8310 (org-end-of-subtree t t)))
8311 (setq end (point))
8312 (goto-char beg0)
8313 (when (> end beg)
8314 (setq org-subtree-clip-folded folded)
8315 (when (or cut force-store-markers)
8316 (org-save-markers-in-region beg end))
8317 (if cut (kill-region beg end) (copy-region-as-kill beg end))
8318 (setq org-subtree-clip (current-kill 0))
8319 (message "%s: Subtree(s) with %d characters"
8320 (if cut "Cut" "Copied")
8321 (length org-subtree-clip)))))
8323 (defun org-paste-subtree (&optional level tree for-yank)
8324 "Paste the clipboard as a subtree, with modification of headline level.
8325 The entire subtree is promoted or demoted in order to match a new headline
8326 level.
8328 If the cursor is at the beginning of a headline, the same level as
8329 that headline is used to paste the tree.
8331 If not, the new level is derived from the *visible* headings
8332 before and after the insertion point, and taken to be the inferior headline
8333 level of the two. So if the previous visible heading is level 3 and the
8334 next is level 4 (or vice versa), level 4 will be used for insertion.
8335 This makes sure that the subtree remains an independent subtree and does
8336 not swallow low level entries.
8338 You can also force a different level, either by using a numeric prefix
8339 argument, or by inserting the heading marker by hand. For example, if the
8340 cursor is after \"*****\", then the tree will be shifted to level 5.
8342 If optional TREE is given, use this text instead of the kill ring.
8344 When FOR-YANK is set, this is called by `org-yank'. In this case, do not
8345 move back over whitespace before inserting, and move point to the end of
8346 the inserted text when done."
8347 (interactive "P")
8348 (setq tree (or tree (and kill-ring (current-kill 0))))
8349 (unless (org-kill-is-subtree-p tree)
8350 (user-error "%s"
8351 (substitute-command-keys
8352 "The kill is not a (set of) tree(s) - please use \\[yank] to yank anyway")))
8353 (org-with-limited-levels
8354 (let* ((visp (not (outline-invisible-p)))
8355 (txt tree)
8356 (^re_ "\\(\\*+\\)[ \t]*")
8357 (old-level (if (string-match org-outline-regexp-bol txt)
8358 (- (match-end 0) (match-beginning 0) 1)
8359 -1))
8360 (force-level (cond (level (prefix-numeric-value level))
8361 ((and (looking-at "[ \t]*$")
8362 (string-match
8363 "^\\*+$" (buffer-substring
8364 (point-at-bol) (point))))
8365 (- (match-end 1) (match-beginning 1)))
8366 ((and (bolp)
8367 (looking-at org-outline-regexp))
8368 (- (match-end 0) (point) 1))))
8369 (previous-level (save-excursion
8370 (condition-case nil
8371 (progn
8372 (outline-previous-visible-heading 1)
8373 (if (looking-at ^re_)
8374 (- (match-end 0) (match-beginning 0) 1)
8376 (error 1))))
8377 (next-level (save-excursion
8378 (condition-case nil
8379 (progn
8380 (or (looking-at org-outline-regexp)
8381 (outline-next-visible-heading 1))
8382 (if (looking-at ^re_)
8383 (- (match-end 0) (match-beginning 0) 1)
8385 (error 1))))
8386 (new-level (or force-level (max previous-level next-level)))
8387 (shift (if (or (= old-level -1)
8388 (= new-level -1)
8389 (= old-level new-level))
8391 (- new-level old-level)))
8392 (delta (if (> shift 0) -1 1))
8393 (func (if (> shift 0) 'org-demote 'org-promote))
8394 (org-odd-levels-only nil)
8395 beg end newend)
8396 ;; Remove the forced level indicator
8397 (if force-level
8398 (delete-region (point-at-bol) (point)))
8399 ;; Paste
8400 (beginning-of-line (if (bolp) 1 2))
8401 (setq beg (point))
8402 (and (fboundp 'org-id-paste-tracker) (org-id-paste-tracker txt))
8403 (insert-before-markers txt)
8404 (unless (string-match "\n\\'" txt) (insert "\n"))
8405 (setq newend (point))
8406 (org-reinstall-markers-in-region beg)
8407 (setq end (point))
8408 (goto-char beg)
8409 (skip-chars-forward " \t\n\r")
8410 (setq beg (point))
8411 (if (and (outline-invisible-p) visp)
8412 (save-excursion (outline-show-heading)))
8413 ;; Shift if necessary
8414 (unless (= shift 0)
8415 (save-restriction
8416 (narrow-to-region beg end)
8417 (while (not (= shift 0))
8418 (org-map-region func (point-min) (point-max))
8419 (setq shift (+ delta shift)))
8420 (goto-char (point-min))
8421 (setq newend (point-max))))
8422 (when (or (org-called-interactively-p 'interactive) for-yank)
8423 (message "Clipboard pasted as level %d subtree" new-level))
8424 (if (and (not for-yank) ; in this case, org-yank will decide about folding
8425 kill-ring
8426 (eq org-subtree-clip (current-kill 0))
8427 org-subtree-clip-folded)
8428 ;; The tree was folded before it was killed/copied
8429 (hide-subtree))
8430 (and for-yank (goto-char newend)))))
8432 (defun org-kill-is-subtree-p (&optional txt)
8433 "Check if the current kill is an outline subtree, or a set of trees.
8434 Returns nil if kill does not start with a headline, or if the first
8435 headline level is not the largest headline level in the tree.
8436 So this will actually accept several entries of equal levels as well,
8437 which is OK for `org-paste-subtree'.
8438 If optional TXT is given, check this string instead of the current kill."
8439 (let* ((kill (or txt (and kill-ring (current-kill 0)) ""))
8440 (re (org-get-limited-outline-regexp))
8441 (^re (concat "^" re))
8442 (start-level (and kill
8443 (string-match
8444 (concat "\\`\\([ \t\n\r]*?\n\\)?\\(" re "\\)")
8445 kill)
8446 (- (match-end 2) (match-beginning 2) 1)))
8447 (start (1+ (or (match-beginning 2) -1))))
8448 (if (not start-level)
8449 (progn
8450 nil) ;; does not even start with a heading
8451 (catch 'exit
8452 (while (setq start (string-match ^re kill (1+ start)))
8453 (when (< (- (match-end 0) (match-beginning 0) 1) start-level)
8454 (throw 'exit nil)))
8455 t))))
8457 (defvar org-markers-to-move nil
8458 "Markers that should be moved with a cut-and-paste operation.
8459 Those markers are stored together with their positions relative to
8460 the start of the region.")
8462 (defun org-save-markers-in-region (beg end)
8463 "Check markers in region.
8464 If these markers are between BEG and END, record their position relative
8465 to BEG, so that after moving the block of text, we can put the markers back
8466 into place.
8467 This function gets called just before an entry or tree gets cut from the
8468 buffer. After re-insertion, `org-reinstall-markers-in-region' must be
8469 called immediately, to move the markers with the entries."
8470 (setq org-markers-to-move nil)
8471 (when (featurep 'org-clock)
8472 (org-clock-save-markers-for-cut-and-paste beg end))
8473 (when (featurep 'org-agenda)
8474 (org-agenda-save-markers-for-cut-and-paste beg end)))
8476 (defun org-check-and-save-marker (marker beg end)
8477 "Check if MARKER is between BEG and END.
8478 If yes, remember the marker and the distance to BEG."
8479 (when (and (marker-buffer marker)
8480 (equal (marker-buffer marker) (current-buffer)))
8481 (if (and (>= marker beg) (< marker end))
8482 (push (cons marker (- marker beg)) org-markers-to-move))))
8484 (defun org-reinstall-markers-in-region (beg)
8485 "Move all remembered markers to their position relative to BEG."
8486 (mapc (lambda (x)
8487 (move-marker (car x) (+ beg (cdr x))))
8488 org-markers-to-move)
8489 (setq org-markers-to-move nil))
8491 (defun org-narrow-to-subtree ()
8492 "Narrow buffer to the current subtree."
8493 (interactive)
8494 (save-excursion
8495 (save-match-data
8496 (org-with-limited-levels
8497 (narrow-to-region
8498 (progn (org-back-to-heading t) (point))
8499 (progn (org-end-of-subtree t t)
8500 (if (and (org-at-heading-p) (not (eobp))) (backward-char 1))
8501 (point)))))))
8503 (defun org-narrow-to-block ()
8504 "Narrow buffer to the current block."
8505 (interactive)
8506 (let* ((case-fold-search t)
8507 (blockp (org-between-regexps-p "^[ \t]*#\\+begin_.*"
8508 "^[ \t]*#\\+end_.*")))
8509 (if blockp
8510 (narrow-to-region (car blockp) (cdr blockp))
8511 (user-error "Not in a block"))))
8513 (eval-when-compile
8514 (defvar org-property-drawer-re))
8516 (defvar org-property-start-re) ;; defined below
8517 (defun org-clone-subtree-with-time-shift (n &optional shift)
8518 "Clone the task (subtree) at point N times.
8519 The clones will be inserted as siblings.
8521 In interactive use, the user will be prompted for the number of
8522 clones to be produced. If the entry has a timestamp, the user
8523 will also be prompted for a time shift, which may be a repeater
8524 as used in time stamps, for example `+3d'. To disable this,
8525 you can call the function with a universal prefix argument.
8527 When a valid repeater is given and the entry contains any time
8528 stamps, the clones will become a sequence in time, with time
8529 stamps in the subtree shifted for each clone produced. If SHIFT
8530 is nil or the empty string, time stamps will be left alone. The
8531 ID property of the original subtree is removed.
8533 If the original subtree did contain time stamps with a repeater,
8534 the following will happen:
8535 - the repeater will be removed in each clone
8536 - an additional clone will be produced, with the current, unshifted
8537 date(s) in the entry.
8538 - the original entry will be placed *after* all the clones, with
8539 repeater intact.
8540 - the start days in the repeater in the original entry will be shifted
8541 to past the last clone.
8542 In this way you can spell out a number of instances of a repeating task,
8543 and still retain the repeater to cover future instances of the task."
8544 (interactive "nNumber of clones to produce: ")
8545 (let ((shift
8546 (or shift
8547 (if (and (not (equal current-prefix-arg '(4)))
8548 (save-excursion
8549 (re-search-forward org-ts-regexp-both
8550 (save-excursion
8551 (org-end-of-subtree t)
8552 (point)) t)))
8553 (read-from-minibuffer
8554 "Date shift per clone (e.g. +1w, empty to copy unchanged): ")
8555 ""))) ;; No time shift
8556 (n-no-remove -1)
8557 (drawer-re org-drawer-regexp)
8558 beg end template task idprop
8559 shift-n shift-what doshift nmin nmax)
8560 (if (not (and (integerp n) (> n 0)))
8561 (error "Invalid number of replications %s" n))
8562 (if (and (setq doshift (and (stringp shift) (string-match "\\S-" shift)))
8563 (not (string-match "\\`[ \t]*\\+?\\([0-9]+\\)\\([hdwmy]\\)[ \t]*\\'"
8564 shift)))
8565 (error "Invalid shift specification %s" shift))
8566 (when doshift
8567 (setq shift-n (string-to-number (match-string 1 shift))
8568 shift-what (cdr (assoc (match-string 2 shift)
8569 '(("d" . day) ("w" . week)
8570 ("m" . month) ("y" . year))))))
8571 (if (eq shift-what 'week) (setq shift-n (* 7 shift-n) shift-what 'day))
8572 (setq nmin 1 nmax n)
8573 (org-back-to-heading t)
8574 (setq beg (point))
8575 (setq idprop (org-entry-get nil "ID"))
8576 (org-end-of-subtree t t)
8577 (or (bolp) (insert "\n"))
8578 (setq end (point))
8579 (setq template (buffer-substring beg end))
8580 (when (and doshift
8581 (string-match "<[^<>\n]+ [.+]?\\+[0-9]+[hdwmy][^<>\n]*>" template))
8582 (delete-region beg end)
8583 (setq end beg)
8584 (setq nmin 0 nmax (1+ nmax) n-no-remove nmax))
8585 (goto-char end)
8586 (loop for n from nmin to nmax do
8587 ;; prepare clone
8588 (with-temp-buffer
8589 (insert template)
8590 (org-mode)
8591 (goto-char (point-min))
8592 (org-show-subtree)
8593 (and idprop (if org-clone-delete-id
8594 (org-entry-delete nil "ID")
8595 (org-id-get-create t)))
8596 (unless (= n 0)
8597 (while (re-search-forward "^[ \t]*CLOCK:.*$" nil t)
8598 (kill-whole-line))
8599 (goto-char (point-min))
8600 (while (re-search-forward drawer-re nil t)
8601 (org-remove-empty-drawer-at (point))))
8602 (goto-char (point-min))
8603 (when doshift
8604 (while (re-search-forward org-ts-regexp-both nil t)
8605 (org-timestamp-change (* n shift-n) shift-what))
8606 (unless (= n n-no-remove)
8607 (goto-char (point-min))
8608 (while (re-search-forward org-ts-regexp nil t)
8609 (save-excursion
8610 (goto-char (match-beginning 0))
8611 (if (looking-at "<[^<>\n]+\\( +[.+]?\\+[0-9]+[hdwmy]\\)")
8612 (delete-region (match-beginning 1) (match-end 1)))))))
8613 (setq task (buffer-string)))
8614 (insert task))
8615 (goto-char beg)))
8617 ;;; Outline Sorting
8619 (defun org-sort (with-case)
8620 "Call `org-sort-entries', `org-table-sort-lines' or `org-sort-list'.
8621 Optional argument WITH-CASE means sort case-sensitively."
8622 (interactive "P")
8623 (cond
8624 ((org-at-table-p) (org-call-with-arg 'org-table-sort-lines with-case))
8625 ((org-at-item-p) (org-call-with-arg 'org-sort-list with-case))
8627 (org-call-with-arg 'org-sort-entries with-case))))
8629 (defun org-sort-remove-invisible (s)
8630 "Remove invisible links from string S."
8631 (remove-text-properties 0 (length s) org-rm-props s)
8632 (while (string-match org-bracket-link-regexp s)
8633 (setq s (replace-match (if (match-end 2)
8634 (match-string 3 s)
8635 (match-string 1 s)) t t s)))
8636 (let ((st (format " %s " s)))
8637 (while (string-match org-emph-re st)
8638 (setq st (replace-match (format " %s " (match-string 4 st)) t t st)))
8639 (setq s (substring st 1 -1)))
8642 (defvar org-priority-regexp) ; defined later in the file
8644 (defvar org-after-sorting-entries-or-items-hook nil
8645 "Hook that is run after a bunch of entries or items have been sorted.
8646 When children are sorted, the cursor is in the parent line when this
8647 hook gets called. When a region or a plain list is sorted, the cursor
8648 will be in the first entry of the sorted region/list.")
8650 (defun org-sort-entries
8651 (&optional with-case sorting-type getkey-func compare-func property)
8652 "Sort entries on a certain level of an outline tree.
8653 If there is an active region, the entries in the region are sorted.
8654 Else, if the cursor is before the first entry, sort the top-level items.
8655 Else, the children of the entry at point are sorted.
8657 Sorting can be alphabetically, numerically, by date/time as given by
8658 a time stamp, by a property, by priority order, or by a custom function.
8660 The command prompts for the sorting type unless it has been given to the
8661 function through the SORTING-TYPE argument, which needs to be a character,
8662 \(?n ?N ?a ?A ?t ?T ?s ?S ?d ?D ?p ?P ?o ?O ?r ?R ?f ?F). Here is the
8663 precise meaning of each character:
8665 n Numerically, by converting the beginning of the entry/item to a number.
8666 a Alphabetically, ignoring the TODO keyword and the priority, if any.
8667 o By order of TODO keywords.
8668 t By date/time, either the first active time stamp in the entry, or, if
8669 none exist, by the first inactive one.
8670 s By the scheduled date/time.
8671 d By deadline date/time.
8672 c By creation time, which is assumed to be the first inactive time stamp
8673 at the beginning of a line.
8674 p By priority according to the cookie.
8675 r By the value of a property.
8677 Capital letters will reverse the sort order.
8679 If the SORTING-TYPE is ?f or ?F, then GETKEY-FUNC specifies a function to be
8680 called with point at the beginning of the record. It must return either
8681 a string or a number that should serve as the sorting key for that record.
8683 Comparing entries ignores case by default. However, with an optional argument
8684 WITH-CASE, the sorting considers case as well.
8686 Sorting is done against the visible part of the headlines, it ignores hidden
8687 links.
8689 When sorting is done, call `org-after-sorting-entries-or-items-hook'."
8690 (interactive "P")
8691 (let ((case-func (if with-case 'identity 'downcase))
8692 (cmstr
8693 ;; The clock marker is lost when using `sort-subr', let's
8694 ;; store the clocking string.
8695 (when (equal (marker-buffer org-clock-marker) (current-buffer))
8696 (save-excursion
8697 (goto-char org-clock-marker)
8698 (looking-back "^.*") (match-string-no-properties 0))))
8699 start beg end stars re re2
8700 txt what tmp)
8701 ;; Find beginning and end of region to sort
8702 (cond
8703 ((org-region-active-p)
8704 ;; we will sort the region
8705 (setq end (region-end)
8706 what "region")
8707 (goto-char (region-beginning))
8708 (if (not (org-at-heading-p)) (outline-next-heading))
8709 (setq start (point)))
8710 ((or (org-at-heading-p)
8711 (condition-case nil (progn (org-back-to-heading) t) (error nil)))
8712 ;; we will sort the children of the current headline
8713 (org-back-to-heading)
8714 (setq start (point)
8715 end (progn (org-end-of-subtree t t)
8716 (or (bolp) (insert "\n"))
8717 (org-back-over-empty-lines)
8718 (point))
8719 what "children")
8720 (goto-char start)
8721 (show-subtree)
8722 (outline-next-heading))
8724 ;; we will sort the top-level entries in this file
8725 (goto-char (point-min))
8726 (or (org-at-heading-p) (outline-next-heading))
8727 (setq start (point))
8728 (goto-char (point-max))
8729 (beginning-of-line 1)
8730 (when (looking-at ".*?\\S-")
8731 ;; File ends in a non-white line
8732 (end-of-line 1)
8733 (insert "\n"))
8734 (setq end (point-max))
8735 (setq what "top-level")
8736 (goto-char start)
8737 (show-all)))
8739 (setq beg (point))
8740 (when (>= beg end) (goto-char start) (user-error "Nothing to sort"))
8742 (looking-at "\\(\\*+\\)")
8743 (setq stars (match-string 1)
8744 re (concat "^" (regexp-quote stars) " +")
8745 re2 (concat "^" (regexp-quote (substring stars 0 -1)) "[ \t\n]")
8746 txt (buffer-substring beg end))
8747 (if (not (equal (substring txt -1) "\n")) (setq txt (concat txt "\n")))
8748 (if (and (not (equal stars "*")) (string-match re2 txt))
8749 (user-error "Region to sort contains a level above the first entry"))
8751 (unless sorting-type
8752 (message
8753 "Sort %s: [a]lpha [n]umeric [p]riority p[r]operty todo[o]rder [f]unc
8754 [t]ime [s]cheduled [d]eadline [c]reated
8755 A/N/P/R/O/F/T/S/D/C means reversed:"
8756 what)
8757 (setq sorting-type (read-char-exclusive))
8759 (unless getkey-func
8760 (and (= (downcase sorting-type) ?f)
8761 (setq getkey-func
8762 (org-icompleting-read "Sort using function: "
8763 obarray 'fboundp t nil nil))
8764 (setq getkey-func (intern getkey-func))))
8766 (and (= (downcase sorting-type) ?r)
8767 (not property)
8768 (setq property
8769 (org-icompleting-read "Property: "
8770 (mapcar 'list (org-buffer-property-keys t))
8771 nil t))))
8773 (message "Sorting entries...")
8775 (save-restriction
8776 (narrow-to-region start end)
8777 (let ((dcst (downcase sorting-type))
8778 (case-fold-search nil)
8779 (now (current-time)))
8780 (sort-subr
8781 (/= dcst sorting-type)
8782 ;; This function moves to the beginning character of the "record" to
8783 ;; be sorted.
8784 (lambda nil
8785 (if (re-search-forward re nil t)
8786 (goto-char (match-beginning 0))
8787 (goto-char (point-max))))
8788 ;; This function moves to the last character of the "record" being
8789 ;; sorted.
8790 (lambda nil
8791 (save-match-data
8792 (condition-case nil
8793 (outline-forward-same-level 1)
8794 (error
8795 (goto-char (point-max))))))
8796 ;; This function returns the value that gets sorted against.
8797 (lambda nil
8798 (cond
8799 ((= dcst ?n)
8800 (if (looking-at org-complex-heading-regexp)
8801 (string-to-number (org-sort-remove-invisible (match-string 4)))
8802 nil))
8803 ((= dcst ?a)
8804 (if (looking-at org-complex-heading-regexp)
8805 (funcall case-func (org-sort-remove-invisible (match-string 4)))
8806 nil))
8807 ((= dcst ?t)
8808 (let ((end (save-excursion (outline-next-heading) (point))))
8809 (if (or (re-search-forward org-ts-regexp end t)
8810 (re-search-forward org-ts-regexp-both end t))
8811 (org-time-string-to-seconds (match-string 0))
8812 (org-float-time now))))
8813 ((= dcst ?c)
8814 (let ((end (save-excursion (outline-next-heading) (point))))
8815 (if (re-search-forward
8816 (concat "^[ \t]*\\[" org-ts-regexp1 "\\]")
8817 end t)
8818 (org-time-string-to-seconds (match-string 0))
8819 (org-float-time now))))
8820 ((= dcst ?s)
8821 (let ((end (save-excursion (outline-next-heading) (point))))
8822 (if (re-search-forward org-scheduled-time-regexp end t)
8823 (org-time-string-to-seconds (match-string 1))
8824 (org-float-time now))))
8825 ((= dcst ?d)
8826 (let ((end (save-excursion (outline-next-heading) (point))))
8827 (if (re-search-forward org-deadline-time-regexp end t)
8828 (org-time-string-to-seconds (match-string 1))
8829 (org-float-time now))))
8830 ((= dcst ?p)
8831 (if (re-search-forward org-priority-regexp (point-at-eol) t)
8832 (string-to-char (match-string 2))
8833 org-default-priority))
8834 ((= dcst ?r)
8835 (or (org-entry-get nil property) ""))
8836 ((= dcst ?o)
8837 (if (looking-at org-complex-heading-regexp)
8838 (- 9999 (length (member (match-string 2)
8839 org-todo-keywords-1)))))
8840 ((= dcst ?f)
8841 (if getkey-func
8842 (progn
8843 (setq tmp (funcall getkey-func))
8844 (if (stringp tmp) (setq tmp (funcall case-func tmp)))
8845 tmp)
8846 (error "Invalid key function `%s'" getkey-func)))
8847 (t (error "Invalid sorting type `%c'" sorting-type))))
8849 (cond
8850 ((= dcst ?a) 'string<)
8851 ((= dcst ?f) compare-func)
8852 ((member dcst '(?p ?t ?s ?d ?c)) '<)))))
8853 (run-hooks 'org-after-sorting-entries-or-items-hook)
8854 ;; Reset the clock marker if needed
8855 (when cmstr
8856 (save-excursion
8857 (goto-char start)
8858 (search-forward cmstr nil t)
8859 (move-marker org-clock-marker (point))))
8860 (message "Sorting entries...done")))
8862 (defun org-do-sort (table what &optional with-case sorting-type)
8863 "Sort TABLE of WHAT according to SORTING-TYPE.
8864 The user will be prompted for the SORTING-TYPE if the call to this
8865 function does not specify it. WHAT is only for the prompt, to indicate
8866 what is being sorted. The sorting key will be extracted from
8867 the car of the elements of the table.
8868 If WITH-CASE is non-nil, the sorting will be case-sensitive."
8869 (unless sorting-type
8870 (message
8871 "Sort %s: [a]lphabetic, [n]umeric, [t]ime. A/N/T means reversed:"
8872 what)
8873 (setq sorting-type (read-char-exclusive)))
8874 (let ((dcst (downcase sorting-type))
8875 extractfun comparefun)
8876 ;; Define the appropriate functions
8877 (cond
8878 ((= dcst ?n)
8879 (setq extractfun 'string-to-number
8880 comparefun (if (= dcst sorting-type) '< '>)))
8881 ((= dcst ?a)
8882 (setq extractfun (if with-case (lambda(x) (org-sort-remove-invisible x))
8883 (lambda(x) (downcase (org-sort-remove-invisible x))))
8884 comparefun (if (= dcst sorting-type)
8885 'string<
8886 (lambda (a b) (and (not (string< a b))
8887 (not (string= a b)))))))
8888 ((= dcst ?t)
8889 (setq extractfun
8890 (lambda (x)
8891 (if (or (string-match org-ts-regexp x)
8892 (string-match org-ts-regexp-both x))
8893 (org-float-time
8894 (org-time-string-to-time (match-string 0 x)))
8896 comparefun (if (= dcst sorting-type) '< '>)))
8897 (t (error "Invalid sorting type `%c'" sorting-type)))
8899 (sort (mapcar (lambda (x) (cons (funcall extractfun (car x)) (cdr x)))
8900 table)
8901 (lambda (a b) (funcall comparefun (car a) (car b))))))
8904 ;;; The orgstruct minor mode
8906 ;; Define a minor mode which can be used in other modes in order to
8907 ;; integrate the org-mode structure editing commands.
8909 ;; This is really a hack, because the org-mode structure commands use
8910 ;; keys which normally belong to the major mode. Here is how it
8911 ;; works: The minor mode defines all the keys necessary to operate the
8912 ;; structure commands, but wraps the commands into a function which
8913 ;; tests if the cursor is currently at a headline or a plain list
8914 ;; item. If that is the case, the structure command is used,
8915 ;; temporarily setting many Org-mode variables like regular
8916 ;; expressions for filling etc. However, when any of those keys is
8917 ;; used at a different location, function uses `key-binding' to look
8918 ;; up if the key has an associated command in another currently active
8919 ;; keymap (minor modes, major mode, global), and executes that
8920 ;; command. There might be problems if any of the keys is otherwise
8921 ;; used as a prefix key.
8923 (defcustom orgstruct-heading-prefix-regexp ""
8924 "Regexp that matches the custom prefix of Org headlines in
8925 orgstruct(++)-mode."
8926 :group 'org
8927 :version "24.4"
8928 :package-version '(Org . "8.3")
8929 :type 'regexp)
8930 ;;;###autoload(put 'orgstruct-heading-prefix-regexp 'safe-local-variable 'stringp)
8932 (defcustom orgstruct-setup-hook nil
8933 "Hook run after orgstruct-mode-map is filled."
8934 :group 'org
8935 :version "24.4"
8936 :package-version '(Org . "8.0")
8937 :type 'hook)
8939 (defvar orgstruct-initialized nil)
8941 (defvar org-local-vars nil
8942 "List of local variables, for use by `orgstruct-mode'.")
8944 ;;;###autoload
8945 (define-minor-mode orgstruct-mode
8946 "Toggle the minor mode `orgstruct-mode'.
8947 This mode is for using Org-mode structure commands in other
8948 modes. The following keys behave as if Org-mode were active, if
8949 the cursor is on a headline, or on a plain list item (both as
8950 defined by Org-mode)."
8951 nil " OrgStruct" (make-sparse-keymap)
8952 (funcall (if orgstruct-mode
8953 'add-to-invisibility-spec
8954 'remove-from-invisibility-spec)
8955 '(outline . t))
8956 (when orgstruct-mode
8957 (org-load-modules-maybe)
8958 (unless orgstruct-initialized
8959 (orgstruct-setup)
8960 (setq orgstruct-initialized t))))
8962 ;;;###autoload
8963 (defun turn-on-orgstruct ()
8964 "Unconditionally turn on `orgstruct-mode'."
8965 (orgstruct-mode 1))
8967 (defvar org-fb-vars nil)
8968 (make-variable-buffer-local 'org-fb-vars)
8969 (defun orgstruct++-mode (&optional arg)
8970 "Toggle `orgstruct-mode', the enhanced version of it.
8971 In addition to setting orgstruct-mode, this also exports all
8972 indentation and autofilling variables from org-mode into the
8973 buffer. It will also recognize item context in multiline items."
8974 (interactive "P")
8975 (setq arg (prefix-numeric-value (or arg (if orgstruct-mode -1 1))))
8976 (if (< arg 1)
8977 (progn (orgstruct-mode -1)
8978 (mapc (lambda(v)
8979 (org-set-local (car v)
8980 (if (eq (car-safe (cadr v)) 'quote) (cadadr v) (cadr v))))
8981 org-fb-vars))
8982 (orgstruct-mode 1)
8983 (setq org-fb-vars nil)
8984 (unless org-local-vars
8985 (setq org-local-vars (org-get-local-variables)))
8986 (let (var val)
8987 (mapc
8988 (lambda (x)
8989 (when (string-match
8990 "^\\(paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|fill-prefix\\|indent-\\)"
8991 (symbol-name (car x)))
8992 (setq var (car x) val (nth 1 x))
8993 (push (list var `(quote ,(eval var))) org-fb-vars)
8994 (org-set-local var (if (eq (car-safe val) 'quote) (nth 1 val) val))))
8995 org-local-vars)
8996 (org-set-local 'orgstruct-is-++ t))))
8998 (defvar orgstruct-is-++ nil
8999 "Is `orgstruct-mode' in ++ version in the current-buffer?")
9000 (make-variable-buffer-local 'orgstruct-is-++)
9002 ;;;###autoload
9003 (defun turn-on-orgstruct++ ()
9004 "Unconditionally turn on `orgstruct++-mode'."
9005 (orgstruct++-mode 1))
9007 (defun orgstruct-error ()
9008 "Error when there is no default binding for a structure key."
9009 (interactive)
9010 (funcall (if (fboundp 'user-error)
9011 'user-error
9012 'error)
9013 "This key has no function outside structure elements"))
9015 (defun orgstruct-setup ()
9016 "Setup orgstruct keymap."
9017 (dolist (cell '((org-demote . t)
9018 (org-metaleft . t)
9019 (org-metaright . t)
9020 (org-promote . t)
9021 (org-shiftmetaleft . t)
9022 (org-shiftmetaright . t)
9023 org-backward-element
9024 org-backward-heading-same-level
9025 org-ctrl-c-ret
9026 org-ctrl-c-minus
9027 org-ctrl-c-star
9028 org-cycle
9029 org-forward-heading-same-level
9030 org-insert-heading
9031 org-insert-heading-respect-content
9032 org-kill-note-or-show-branches
9033 org-mark-subtree
9034 org-meta-return
9035 org-metadown
9036 org-metaup
9037 org-narrow-to-subtree
9038 org-promote-subtree
9039 org-reveal
9040 org-shiftdown
9041 org-shiftleft
9042 org-shiftmetadown
9043 org-shiftmetaup
9044 org-shiftright
9045 org-shifttab
9046 org-shifttab
9047 org-shiftup
9048 org-show-subtree
9049 org-sort
9050 org-up-element
9051 outline-demote
9052 outline-next-visible-heading
9053 outline-previous-visible-heading
9054 outline-promote
9055 outline-up-heading
9056 show-children))
9057 (let ((f (or (car-safe cell) cell))
9058 (disable-when-heading-prefix (cdr-safe cell)))
9059 (when (fboundp f)
9060 (let ((new-bindings))
9061 (dolist (binding (nconc (where-is-internal f org-mode-map)
9062 (where-is-internal f outline-mode-map)))
9063 (push binding new-bindings)
9064 ;; TODO use local-function-key-map
9065 (dolist (rep '(("<tab>" . "TAB")
9066 ("<return>" . "RET")
9067 ("<escape>" . "ESC")
9068 ("<delete>" . "DEL")))
9069 (setq binding (read-kbd-macro
9070 (let ((case-fold-search))
9071 (replace-regexp-in-string
9072 (regexp-quote (cdr rep))
9073 (car rep)
9074 (key-description binding)))))
9075 (pushnew binding new-bindings :test 'equal)))
9076 (dolist (binding new-bindings)
9077 (let ((key (lookup-key orgstruct-mode-map binding)))
9078 (when (or (not key) (numberp key))
9079 (condition-case nil
9080 (org-defkey orgstruct-mode-map
9081 binding
9082 (orgstruct-make-binding f binding disable-when-heading-prefix))
9083 (error nil)))))))))
9084 (run-hooks 'orgstruct-setup-hook))
9086 (defun orgstruct-make-binding (fun key disable-when-heading-prefix)
9087 "Create a function for binding in the structure minor mode.
9088 FUN is the command to call inside a table. KEY is the key that
9089 should be checked in for a command to execute outside of tables.
9090 Non-nil `disable-when-heading-prefix' means to disable the command
9091 if `orgstruct-heading-prefix-regexp' is not empty."
9092 (let ((name (concat "orgstruct-hijacker-" (symbol-name fun))))
9093 (let ((nname name)
9094 (i 0))
9095 (while (fboundp (intern nname))
9096 (setq nname (format "%s-%d" name (setq i (1+ i)))))
9097 (setq name (intern nname)))
9098 (eval
9099 (let ((bindings '((org-heading-regexp
9100 (concat "^"
9101 orgstruct-heading-prefix-regexp
9102 "\\(\\*+\\)\\(?: +\\(.*?\\)\\)?[ ]*$"))
9103 (org-outline-regexp
9104 (concat orgstruct-heading-prefix-regexp "\\*+ "))
9105 (org-outline-regexp-bol
9106 (concat "^" org-outline-regexp))
9107 (outline-regexp org-outline-regexp)
9108 (outline-heading-end-regexp "\n")
9109 (outline-level 'org-outline-level)
9110 (outline-heading-alist))))
9111 `(defun ,name (arg)
9112 ,(concat "In Structure, run `" (symbol-name fun) "'.\n"
9113 "Outside of structure, run the binding of `"
9114 (key-description key) "'."
9115 (when disable-when-heading-prefix
9116 (concat
9117 "\nIf `orgstruct-heading-prefix-regexp' is not empty, this command will always fall\n"
9118 "back to the default binding due to limitations of Org's implementation of\n"
9119 "`" (symbol-name fun) "'.")))
9120 (interactive "p")
9121 (let* ((disable
9122 ,(and disable-when-heading-prefix
9123 '(not (string= orgstruct-heading-prefix-regexp ""))))
9124 (fallback
9125 (or disable
9126 (not
9127 (let* ,bindings
9128 (org-context-p 'headline 'item
9129 ,(when (memq fun
9130 '(org-insert-heading
9131 org-insert-heading-respect-content
9132 org-meta-return))
9133 '(when orgstruct-is-++
9134 'item-body))))))))
9135 (if fallback
9136 (let* ((orgstruct-mode)
9137 (binding
9138 (loop with key = ,key
9139 for rep in
9140 '(nil
9141 ("<\\([^>]*\\)tab>" . "\\1TAB")
9142 ("<\\([^>]*\\)return>" . "\\1RET")
9143 ("<\\([^>]*\\)escape>" . "\\1ESC")
9144 ("<\\([^>]*\\)delete>" . "\\1DEL"))
9146 (when rep
9147 (setq key (read-kbd-macro
9148 (let ((case-fold-search))
9149 (replace-regexp-in-string
9150 (car rep)
9151 (cdr rep)
9152 (key-description key))))))
9153 thereis (key-binding key))))
9154 (if (keymapp binding)
9155 (org-set-transient-map binding)
9156 (let ((func (or binding
9157 (unless disable
9158 'orgstruct-error))))
9159 (when func
9160 (call-interactively func)))))
9161 (org-run-like-in-org-mode
9162 (lambda ()
9163 (interactive)
9164 (let* ,bindings
9165 (call-interactively ',fun)))))))))
9166 name))
9168 (defun org-contextualize-keys (alist contexts)
9169 "Return valid elements in ALIST depending on CONTEXTS.
9171 `org-agenda-custom-commands' or `org-capture-templates' are the
9172 values used for ALIST, and `org-agenda-custom-commands-contexts'
9173 or `org-capture-templates-contexts' are the associated contexts
9174 definitions."
9175 (let ((contexts
9176 ;; normalize contexts
9177 (mapcar
9178 (lambda(c) (cond ((listp (cadr c))
9179 (list (car c) (car c) (cadr c)))
9180 ((string= "" (cadr c))
9181 (list (car c) (car c) (caddr c)))
9182 (t c))) contexts))
9183 (a alist) c r s)
9184 ;; loop over all commands or templates
9185 (while (setq c (pop a))
9186 (let (vrules repl)
9187 (cond
9188 ((not (assoc (car c) contexts))
9189 (push c r))
9190 ((and (assoc (car c) contexts)
9191 (setq vrules (org-contextualize-validate-key
9192 (car c) contexts)))
9193 (mapc (lambda (vr)
9194 (when (not (equal (car vr) (cadr vr)))
9195 (setq repl vr))) vrules)
9196 (if (not repl) (push c r)
9197 (push (cadr repl) s)
9198 (push
9199 (cons (car c)
9200 (cdr (or (assoc (cadr repl) alist)
9201 (error "Undefined key `%s' as contextual replacement for `%s'"
9202 (cadr repl) (car c)))))
9203 r))))))
9204 ;; Return limited ALIST, possibly with keys modified, and deduplicated
9205 (delq
9207 (delete-dups
9208 (mapcar (lambda (x)
9209 (let ((tpl (car x)))
9210 (when (not (delq
9212 (mapcar (lambda(y)
9213 (equal y tpl)) s))) x)))
9214 (reverse r))))))
9216 (defun org-contextualize-validate-key (key contexts)
9217 "Check CONTEXTS for agenda or capture KEY."
9218 (let (r rr res)
9219 (while (setq r (pop contexts))
9220 (mapc
9221 (lambda (rr)
9222 (when
9223 (and (equal key (car r))
9224 (if (functionp rr) (funcall rr)
9225 (or (and (eq (car rr) 'in-file)
9226 (buffer-file-name)
9227 (string-match (cdr rr) (buffer-file-name)))
9228 (and (eq (car rr) 'in-mode)
9229 (string-match (cdr rr) (symbol-name major-mode)))
9230 (and (eq (car rr) 'in-buffer)
9231 (string-match (cdr rr) (buffer-name)))
9232 (when (and (eq (car rr) 'not-in-file)
9233 (buffer-file-name))
9234 (not (string-match (cdr rr) (buffer-file-name))))
9235 (when (eq (car rr) 'not-in-mode)
9236 (not (string-match (cdr rr) (symbol-name major-mode))))
9237 (when (eq (car rr) 'not-in-buffer)
9238 (not (string-match (cdr rr) (buffer-name)))))))
9239 (push r res)))
9240 (car (last r))))
9241 (delete-dups (delq nil res))))
9243 (defun org-context-p (&rest contexts)
9244 "Check if local context is any of CONTEXTS.
9245 Possible values in the list of contexts are `table', `headline', and `item'."
9246 (let ((pos (point)))
9247 (goto-char (point-at-bol))
9248 (prog1 (or (and (memq 'table contexts)
9249 (looking-at "[ \t]*|"))
9250 (and (memq 'headline contexts)
9251 (looking-at org-outline-regexp))
9252 (and (memq 'item contexts)
9253 (looking-at "[ \t]*\\([-+*] \\|[0-9]+[.)] \\)"))
9254 (and (memq 'item-body contexts)
9255 (org-in-item-p)))
9256 (goto-char pos))))
9258 (defun org-get-local-variables ()
9259 "Return a list of all local variables in an Org mode buffer."
9260 (let (varlist)
9261 (with-current-buffer (get-buffer-create "*Org tmp*")
9262 (erase-buffer)
9263 (org-mode)
9264 (setq varlist (buffer-local-variables)))
9265 (kill-buffer "*Org tmp*")
9266 (delq nil
9267 (mapcar
9268 (lambda (x)
9269 (setq x
9270 (if (symbolp x)
9271 (list x)
9272 (list (car x) (cdr x))))
9273 (if (and (not (get (car x) 'org-state))
9274 (string-match
9275 "^\\(org-\\|orgtbl-\\|outline-\\|comment-\\|paragraph-\\|auto-fill\\|normal-auto-fill\\|fill-paragraph\\|indent-\\)"
9276 (symbol-name (car x))))
9277 x nil))
9278 varlist))))
9280 (defun org-clone-local-variables (from-buffer &optional regexp)
9281 "Clone local variables from FROM-BUFFER.
9282 Optional argument REGEXP selects variables to clone."
9283 (mapc
9284 (lambda (pair)
9285 (and (symbolp (car pair))
9286 (or (null regexp)
9287 (string-match regexp (symbol-name (car pair))))
9288 (set (make-local-variable (car pair))
9289 (cdr pair))))
9290 (buffer-local-variables from-buffer)))
9292 ;;;###autoload
9293 (defun org-run-like-in-org-mode (cmd)
9294 "Run a command, pretending that the current buffer is in Org-mode.
9295 This will temporarily bind local variables that are typically bound in
9296 Org-mode to the values they have in Org-mode, and then interactively
9297 call CMD."
9298 (org-load-modules-maybe)
9299 (unless org-local-vars
9300 (setq org-local-vars (org-get-local-variables)))
9301 (let (binds)
9302 (dolist (var org-local-vars)
9303 (when (or (not (boundp (car var)))
9304 (eq (symbol-value (car var))
9305 (default-value (car var))))
9306 (push (list (car var) `(quote ,(cadr var))) binds)))
9307 (eval `(let ,binds
9308 (call-interactively (quote ,cmd))))))
9310 ;;;; Archiving
9312 (defun org-get-category (&optional pos force-refresh)
9313 "Get the category applying to position POS."
9314 (save-match-data
9315 (if force-refresh (org-refresh-category-properties))
9316 (let ((pos (or pos (point))))
9317 (or (get-text-property pos 'org-category)
9318 (progn (org-refresh-category-properties)
9319 (get-text-property pos 'org-category))))))
9321 (defun org-refresh-category-properties ()
9322 "Refresh category text properties in the buffer."
9323 (let ((case-fold-search t)
9324 (inhibit-read-only t)
9325 (def-cat (cond
9326 ((null org-category)
9327 (if buffer-file-name
9328 (file-name-sans-extension
9329 (file-name-nondirectory buffer-file-name))
9330 "???"))
9331 ((symbolp org-category) (symbol-name org-category))
9332 (t org-category)))
9333 beg end cat pos optionp)
9334 (org-with-silent-modifications
9335 (save-excursion
9336 (save-restriction
9337 (widen)
9338 (goto-char (point-min))
9339 (put-text-property (point) (point-max) 'org-category def-cat)
9340 (while (re-search-forward
9341 "^\\(#\\+CATEGORY:\\|[ \t]*:CATEGORY:\\)\\(.*\\)" nil t)
9342 (setq pos (match-end 0)
9343 optionp (equal (char-after (match-beginning 0)) ?#)
9344 cat (org-trim (match-string 2)))
9345 (if optionp
9346 (setq beg (point-at-bol) end (point-max))
9347 (org-back-to-heading t)
9348 (setq beg (point) end (org-end-of-subtree t t)))
9349 (put-text-property beg end 'org-category cat)
9350 (put-text-property beg end 'org-category-position beg)
9351 (goto-char pos)))))))
9353 (defun org-refresh-properties (dprop tprop)
9354 "Refresh buffer text properties.
9355 DPROP is the drawer property and TPROP is the corresponding text
9356 property to set."
9357 (let ((case-fold-search t)
9358 (inhibit-read-only t) p)
9359 (org-with-silent-modifications
9360 (save-excursion
9361 (save-restriction
9362 (widen)
9363 (goto-char (point-min))
9364 (while (re-search-forward (concat "^[ \t]*:" dprop ": +\\(.*\\)[ \t]*$") nil t)
9365 (setq p (org-match-string-no-properties 1))
9366 (save-excursion
9367 (org-back-to-heading t)
9368 (put-text-property
9369 (point-at-bol) (org-end-of-subtree t t) tprop p))))))))
9372 ;;;; Link Stuff
9374 ;;; Link abbreviations
9376 (defun org-link-expand-abbrev (link)
9377 "Apply replacements as defined in `org-link-abbrev-alist'."
9378 (if (string-match "^\\([^:]*\\)\\(::?\\(.*\\)\\)?$" link)
9379 (let* ((key (match-string 1 link))
9380 (as (or (assoc key org-link-abbrev-alist-local)
9381 (assoc key org-link-abbrev-alist)))
9382 (tag (and (match-end 2) (match-string 3 link)))
9383 rpl)
9384 (if (not as)
9385 link
9386 (setq rpl (cdr as))
9387 (cond
9388 ((symbolp rpl) (funcall rpl tag))
9389 ((string-match "%(\\([^)]+\\))" rpl)
9390 (replace-match
9391 (save-match-data
9392 (funcall (intern-soft (match-string 1 rpl)) tag)) t t rpl))
9393 ((string-match "%s" rpl) (replace-match (or tag "") t t rpl))
9394 ((string-match "%h" rpl)
9395 (replace-match (url-hexify-string (or tag "")) t t rpl))
9396 (t (concat rpl tag)))))
9397 link))
9399 ;;; Storing and inserting links
9401 (defvar org-insert-link-history nil
9402 "Minibuffer history for links inserted with `org-insert-link'.")
9404 (defvar org-stored-links nil
9405 "Contains the links stored with `org-store-link'.")
9407 (defvar org-store-link-plist nil
9408 "Plist with info about the most recently link created with `org-store-link'.")
9410 (defvar org-link-protocols nil
9411 "Link protocols added to Org-mode using `org-add-link-type'.")
9413 (defvar org-store-link-functions nil
9414 "List of functions that are called to create and store a link.
9415 Each function will be called in turn until one returns a non-nil
9416 value. Each function should check if it is responsible for creating
9417 this link (for example by looking at the major mode).
9418 If not, it must exit and return nil.
9419 If yes, it should return a non-nil value after a calling
9420 `org-store-link-props' with a list of properties and values.
9421 Special properties are:
9423 :type The link prefix, like \"http\". This must be given.
9424 :link The link, like \"http://www.astro.uva.nl/~dominik\".
9425 This is obligatory as well.
9426 :description Optional default description for the second pair
9427 of brackets in an Org-mode link. The user can still change
9428 this when inserting this link into an Org-mode buffer.
9430 In addition to these, any additional properties can be specified
9431 and then used in capture templates.")
9433 (defun org-add-link-type (type &optional follow export)
9434 "Add TYPE to the list of `org-link-types'.
9435 Re-compute all regular expressions depending on `org-link-types'
9437 FOLLOW and EXPORT are two functions.
9439 FOLLOW should take the link path as the single argument and do whatever
9440 is necessary to follow the link, for example find a file or display
9441 a mail message.
9443 EXPORT should format the link path for export to one of the export formats.
9444 It should be a function accepting three arguments:
9446 path the path of the link, the text after the prefix (like \"http:\")
9447 desc the description of the link, if any, or a description added by
9448 org-export-normalize-links if there is none
9449 format the export format, a symbol like `html' or `latex' or `ascii'..
9451 The function may use the FORMAT information to return different values
9452 depending on the format. The return value will be put literally into
9453 the exported file. If the return value is nil, this means Org should
9454 do what it normally does with links which do not have EXPORT defined.
9456 Org-mode has a built-in default for exporting links. If you are happy with
9457 this default, there is no need to define an export function for the link
9458 type. For a simple example of an export function, see `org-bbdb.el'."
9459 (add-to-list 'org-link-types type t)
9460 (org-make-link-regexps)
9461 (if (assoc type org-link-protocols)
9462 (setcdr (assoc type org-link-protocols) (list follow export))
9463 (push (list type follow export) org-link-protocols)))
9465 (defvar org-agenda-buffer-name) ; Defined in org-agenda.el
9466 (defvar org-id-link-to-org-use-id) ; Defined in org-id.el
9468 ;;;###autoload
9469 (defun org-store-link (arg)
9470 "\\<org-mode-map>Store an org-link to the current location.
9471 This link is added to `org-stored-links' and can later be inserted
9472 into an org-buffer with \\[org-insert-link].
9474 For some link types, a prefix arg is interpreted.
9475 For links to Usenet articles, arg negates `org-gnus-prefer-web-links'.
9476 For file links, arg negates `org-context-in-file-links'.
9478 A double prefix arg force skipping storing functions that are not
9479 part of Org's core.
9481 A triple prefix arg force storing a link for each line in the
9482 active region."
9483 (interactive "P")
9484 (org-load-modules-maybe)
9485 (if (and (equal arg '(64)) (org-region-active-p))
9486 (save-excursion
9487 (let ((end (region-end)))
9488 (goto-char (region-beginning))
9489 (set-mark (point))
9490 (while (< (point-at-eol) end)
9491 (move-end-of-line 1) (activate-mark)
9492 (let (current-prefix-arg)
9493 (call-interactively 'org-store-link))
9494 (move-beginning-of-line 2)
9495 (set-mark (point)))))
9496 (org-with-limited-levels
9497 (setq org-store-link-plist nil)
9498 (let (link cpltxt desc description search
9499 txt custom-id agenda-link sfuns sfunsn)
9500 (cond
9502 ;; Store a link using an external link type
9503 ((and (not (equal arg '(16)))
9504 (setq sfuns
9505 (delq
9506 nil (mapcar (lambda (f)
9507 (let (fs) (if (funcall f) (push f fs))))
9508 org-store-link-functions))
9509 sfunsn (mapcar (lambda (fu) (symbol-name (car fu))) sfuns))
9510 (or (and (cdr sfuns)
9511 (funcall (intern
9512 (completing-read
9513 "Which function for creating the link? "
9514 sfunsn nil t (car sfunsn)))))
9515 (funcall (caar sfuns)))
9516 (setq link (plist-get org-store-link-plist :link)
9517 desc (or (plist-get org-store-link-plist
9518 :description) link))))
9520 ;; Store a link from a source code buffer
9521 ((org-src-edit-buffer-p)
9522 (let (label gc)
9523 (while (or (not label)
9524 (save-excursion
9525 (save-restriction
9526 (widen)
9527 (goto-char (point-min))
9528 (re-search-forward
9529 (regexp-quote (format org-coderef-label-format label))
9530 nil t))))
9531 (when label (message "Label exists already") (sit-for 2))
9532 (setq label (read-string "Code line label: " label)))
9533 (end-of-line 1)
9534 (setq link (format org-coderef-label-format label))
9535 (setq gc (- 79 (length link)))
9536 (if (< (current-column) gc) (org-move-to-column gc t) (insert " "))
9537 (insert link)
9538 (setq link (concat "(" label ")") desc nil)))
9540 ;; We are in the agenda, link to referenced location
9541 ((equal (org-bound-and-true-p org-agenda-buffer-name) (buffer-name))
9542 (let ((m (or (get-text-property (point) 'org-hd-marker)
9543 (get-text-property (point) 'org-marker))))
9544 (when m
9545 (org-with-point-at m
9546 (setq agenda-link
9547 (if (org-called-interactively-p 'any)
9548 (call-interactively 'org-store-link)
9549 (org-store-link nil)))))))
9551 ((eq major-mode 'calendar-mode)
9552 (let ((cd (calendar-cursor-to-date)))
9553 (setq link
9554 (format-time-string
9555 (car org-time-stamp-formats)
9556 (apply 'encode-time
9557 (list 0 0 0 (nth 1 cd) (nth 0 cd) (nth 2 cd)
9558 nil nil nil))))
9559 (org-store-link-props :type "calendar" :date cd)))
9561 ((eq major-mode 'help-mode)
9562 (setq link (concat "help:" (save-excursion
9563 (goto-char (point-min))
9564 (looking-at "^[^ ]+")
9565 (match-string 0))))
9566 (org-store-link-props :type "help"))
9568 ((eq major-mode 'w3-mode)
9569 (setq cpltxt (if (and (buffer-name)
9570 (not (string-match "Untitled" (buffer-name))))
9571 (buffer-name)
9572 (url-view-url t))
9573 link (url-view-url t))
9574 (org-store-link-props :type "w3" :url (url-view-url t)))
9576 ((eq major-mode 'image-mode)
9577 (setq cpltxt (concat "file:"
9578 (abbreviate-file-name buffer-file-name))
9579 link cpltxt)
9580 (org-store-link-props :type "image" :file buffer-file-name))
9582 ;; In dired, store a link to the file of the current line
9583 ((eq major-mode 'dired-mode)
9584 (let ((file (dired-get-filename nil t)))
9585 (setq file (if file
9586 (abbreviate-file-name
9587 (expand-file-name (dired-get-filename nil t)))
9588 ;; otherwise, no file so use current directory.
9589 default-directory))
9590 (setq cpltxt (concat "file:" file)
9591 link cpltxt)))
9593 ((setq search (run-hook-with-args-until-success
9594 'org-create-file-search-functions))
9595 (setq link (concat "file:" (abbreviate-file-name buffer-file-name)
9596 "::" search))
9597 (setq cpltxt (or description link)))
9599 ((and (buffer-file-name (buffer-base-buffer)) (derived-mode-p 'org-mode))
9600 (setq custom-id (org-entry-get nil "CUSTOM_ID"))
9601 (cond
9602 ;; Store a link using the target at point
9603 ((org-in-regexp "[^<]<<\\([^<>]+\\)>>[^>]" 1)
9604 (setq cpltxt
9605 (concat "file:"
9606 (abbreviate-file-name
9607 (buffer-file-name (buffer-base-buffer)))
9608 "::" (match-string 1))
9609 link cpltxt))
9610 ((and (featurep 'org-id)
9611 (or (eq org-id-link-to-org-use-id t)
9612 (and (org-called-interactively-p 'any)
9613 (or (eq org-id-link-to-org-use-id 'create-if-interactive)
9614 (and (eq org-id-link-to-org-use-id
9615 'create-if-interactive-and-no-custom-id)
9616 (not custom-id))))
9617 (and org-id-link-to-org-use-id (org-entry-get nil "ID"))))
9618 ;; Store a link using the ID at point
9619 (setq link (condition-case nil
9620 (prog1 (org-id-store-link)
9621 (setq desc (plist-get org-store-link-plist
9622 :description)))
9623 (error
9624 ;; Probably before first headline, link only to file
9625 (concat "file:"
9626 (abbreviate-file-name
9627 (buffer-file-name (buffer-base-buffer))))))))
9629 ;; Just link to current headline
9630 (setq cpltxt (concat "file:"
9631 (abbreviate-file-name
9632 (buffer-file-name (buffer-base-buffer)))))
9633 ;; Add a context search string
9634 (when (org-xor org-context-in-file-links arg)
9635 (let* ((ee (org-element-at-point))
9636 (et (org-element-type ee))
9637 (ev (plist-get (cadr ee) :value))
9638 (ek (plist-get (cadr ee) :key))
9639 (eok (and (stringp ek) (string-match "name" ek))))
9640 (setq txt (cond
9641 ((org-at-heading-p) nil)
9642 ((and (eq et 'keyword) eok) ev)
9643 ((org-region-active-p)
9644 (buffer-substring (region-beginning) (region-end)))))
9645 (when (or (null txt) (string-match "\\S-" txt))
9646 (setq cpltxt
9647 (concat cpltxt "::"
9648 (condition-case nil
9649 (org-make-org-heading-search-string txt)
9650 (error "")))
9651 desc (or (and (eq et 'keyword) eok ev)
9652 (nth 4 (ignore-errors (org-heading-components)))
9653 "NONE")))))
9654 (if (string-match "::\\'" cpltxt)
9655 (setq cpltxt (substring cpltxt 0 -2)))
9656 (setq link cpltxt))))
9658 ((buffer-file-name (buffer-base-buffer))
9659 ;; Just link to this file here.
9660 (setq cpltxt (concat "file:"
9661 (abbreviate-file-name
9662 (buffer-file-name (buffer-base-buffer)))))
9663 ;; Add a context string.
9664 (when (org-xor org-context-in-file-links arg)
9665 (setq txt (if (org-region-active-p)
9666 (buffer-substring (region-beginning) (region-end))
9667 (buffer-substring (point-at-bol) (point-at-eol))))
9668 ;; Only use search option if there is some text.
9669 (when (string-match "\\S-" txt)
9670 (setq cpltxt
9671 (concat cpltxt "::" (org-make-org-heading-search-string txt))
9672 desc "NONE")))
9673 (setq link cpltxt))
9675 ((org-called-interactively-p 'interactive)
9676 (user-error "No method for storing a link from this buffer"))
9678 (t (setq link nil)))
9680 ;; We're done setting link and desc, clean up
9681 (if (consp link) (setq cpltxt (car link) link (cdr link)))
9682 (setq link (or link cpltxt)
9683 desc (or desc cpltxt))
9684 (cond ((equal desc "NONE") (setq desc nil))
9685 ((string-match org-bracket-link-analytic-regexp desc)
9686 (let ((d0 (match-string 3 desc))
9687 (p0 (match-string 5 desc)))
9688 (setq desc
9689 (replace-regexp-in-string
9690 org-bracket-link-regexp
9691 (concat (or p0 d0)
9692 (if (equal (length (match-string 0 desc))
9693 (length desc)) "*" "")) desc)))))
9695 ;; Return the link
9696 (if (not (and (or (org-called-interactively-p 'any)
9697 executing-kbd-macro) link))
9698 (or agenda-link (and link (org-make-link-string link desc)))
9699 (push (list link desc) org-stored-links)
9700 (message "Stored: %s" (or desc link))
9701 (when custom-id
9702 (setq link (concat "file:" (abbreviate-file-name
9703 (buffer-file-name)) "::#" custom-id))
9704 (push (list link desc) org-stored-links))
9705 (car org-stored-links))))))
9707 (defun org-store-link-props (&rest plist)
9708 "Store link properties, extract names and addresses."
9709 (let (x adr)
9710 (when (setq x (plist-get plist :from))
9711 (setq adr (mail-extract-address-components x))
9712 (setq plist (plist-put plist :fromname (car adr)))
9713 (setq plist (plist-put plist :fromaddress (nth 1 adr))))
9714 (when (setq x (plist-get plist :to))
9715 (setq adr (mail-extract-address-components x))
9716 (setq plist (plist-put plist :toname (car adr)))
9717 (setq plist (plist-put plist :toaddress (nth 1 adr)))))
9718 (let ((from (plist-get plist :from))
9719 (to (plist-get plist :to)))
9720 (when (and from to org-from-is-user-regexp)
9721 (setq plist
9722 (plist-put plist :fromto
9723 (if (string-match org-from-is-user-regexp from)
9724 (concat "to %t")
9725 (concat "from %f"))))))
9726 (setq org-store-link-plist plist))
9728 (defun org-add-link-props (&rest plist)
9729 "Add these properties to the link property list."
9730 (let (key value)
9731 (while plist
9732 (setq key (pop plist) value (pop plist))
9733 (setq org-store-link-plist
9734 (plist-put org-store-link-plist key value)))))
9736 (defun org-email-link-description (&optional fmt)
9737 "Return the description part of an email link.
9738 This takes information from `org-store-link-plist' and formats it
9739 according to FMT (default from `org-email-link-description-format')."
9740 (setq fmt (or fmt org-email-link-description-format))
9741 (let* ((p org-store-link-plist)
9742 (to (plist-get p :toaddress))
9743 (from (plist-get p :fromaddress))
9744 (table
9745 (list
9746 (cons "%c" (plist-get p :fromto))
9747 (cons "%F" (plist-get p :from))
9748 (cons "%f" (or (plist-get p :fromname) (plist-get p :fromaddress) "?"))
9749 (cons "%T" (plist-get p :to))
9750 (cons "%t" (or (plist-get p :toname) (plist-get p :toaddress) "?"))
9751 (cons "%s" (plist-get p :subject))
9752 (cons "%d" (plist-get p :date))
9753 (cons "%m" (plist-get p :message-id)))))
9754 (when (string-match "%c" fmt)
9755 ;; Check if the user wrote this message
9756 (if (and org-from-is-user-regexp from to
9757 (save-match-data (string-match org-from-is-user-regexp from)))
9758 (setq fmt (replace-match "to %t" t t fmt))
9759 (setq fmt (replace-match "from %f" t t fmt))))
9760 (org-replace-escapes fmt table)))
9762 (defun org-make-org-heading-search-string (&optional string)
9763 "Make search string for the current headline or STRING."
9764 (let ((s (or string
9765 (and (derived-mode-p 'org-mode)
9766 (save-excursion
9767 (org-back-to-heading t)
9768 (org-element-property :raw-value (org-element-at-point))))))
9769 (lines org-context-in-file-links))
9770 (or string (setq s (concat "*" s))) ; Add * for headlines
9771 (setq s (replace-regexp-in-string "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" "" s))
9772 (when (and string (integerp lines) (> lines 0))
9773 (let ((slines (org-split-string s "\n")))
9774 (when (< lines (length slines))
9775 (setq s (mapconcat
9776 'identity
9777 (reverse (nthcdr (- (length slines) lines)
9778 (reverse slines))) "\n")))))
9779 (mapconcat 'identity (org-split-string s "[ \t]+") " ")))
9781 (defun org-make-link-string (link &optional description)
9782 "Make a link with brackets, consisting of LINK and DESCRIPTION."
9783 (unless (string-match "\\S-" link)
9784 (error "Empty link"))
9785 (when (and description
9786 (stringp description)
9787 (not (string-match "\\S-" description)))
9788 (setq description nil))
9789 (when (stringp description)
9790 ;; Remove brackets from the description, they are fatal.
9791 (while (string-match "\\[" description)
9792 (setq description (replace-match "{" t t description)))
9793 (while (string-match "\\]" description)
9794 (setq description (replace-match "}" t t description))))
9795 (when (equal link description)
9796 ;; No description needed, it is identical
9797 (setq description nil))
9798 (when (and (not description)
9799 (not (string-match (org-image-file-name-regexp) link))
9800 (not (equal link (org-link-escape link))))
9801 (setq description (org-extract-attributes link)))
9802 (setq link
9803 (cond ((string-match (org-image-file-name-regexp) link) link)
9804 ((string-match org-link-types-re link)
9805 (concat (match-string 1 link)
9806 (org-link-escape (substring link (match-end 1)))))
9807 (t (org-link-escape link))))
9808 (concat "[[" link "]"
9809 (if description (concat "[" description "]") "")
9810 "]"))
9812 (defconst org-link-escape-chars
9813 ;;%20 %2B %3B %3D %5B %5D
9814 '(?\ ?\+ ?\; ?\= ?\[ ?\])
9815 "List of characters that should be escaped in a link when stored to Org.
9816 This is the list that is used for internal purposes.")
9818 (defconst org-link-escape-chars-browser
9819 ;;%20 %22
9820 '(?\ ?\")
9821 "List of characters to be escaped before handing over to the browser.
9822 If you consider using this constant then you probably want to use
9823 the function `org-link-escape-browser' instead. See there why
9824 this constant is a candidate to be removed once Org drops support
9825 for Emacs 24.1 and 24.2.")
9827 (defun org-link-escape (text &optional table merge)
9828 "Return percent escaped representation of TEXT.
9829 TEXT is a string with the text to escape.
9830 Optional argument TABLE is a list with characters that should be
9831 escaped. When nil, `org-link-escape-chars' is used.
9832 If optional argument MERGE is set, merge TABLE into
9833 `org-link-escape-chars'."
9834 (cond
9835 ((and table merge)
9836 (mapc (lambda (defchr)
9837 (unless (member defchr table)
9838 (setq table (cons defchr table)))) org-link-escape-chars))
9839 ((null table)
9840 (setq table org-link-escape-chars)))
9841 (mapconcat
9842 (lambda (char)
9843 (if (or (member char table)
9844 (and (or (< char 32) (= char ?\%) (> char 126))
9845 org-url-hexify-p))
9846 (mapconcat (lambda (sequence-element)
9847 (format "%%%.2X" sequence-element))
9848 (or (encode-coding-char char 'utf-8)
9849 (error "Unable to percent escape character: %s"
9850 (char-to-string char))) "")
9851 (char-to-string char))) text ""))
9853 (defun org-link-escape-browser (text)
9854 "Escape some characters before handing over to the browser.
9855 This function is a candidate to be removed together with the
9856 constant `org-link-escape-chars-browser' once Org drops support
9857 for Emacs 24.1 and 24.2. All calls to this function will have to
9858 be replaced with `url-encode-url' which is available since Emacs
9859 24.3.1."
9860 ;; Example with the Org link
9861 ;; [[http://lists.gnu.org/archive/cgi-bin/namazu.cgi?idxname=emacs-orgmode&query=%252Bsubject:"Release+8.2"]]
9862 ;; to open the browser with +subject:"Release 8.2" filled into the
9863 ;; query field: In this case the variable TEXT contains the
9864 ;; unescaped [...]=%2Bsubject:"Release+8.2". Then `url-encode-url'
9865 ;; converts correctly to [...]=%2Bsubject:%22Release+8.2%22 or
9866 ;; `org-link-escape' with `org-link-escape-chars-browser' converts
9867 ;; wrongly to [...]=%252Bsubject:%22Release+8.2%22.
9868 (if (fboundp 'url-encode-url)
9869 (url-encode-url text)
9870 (if (org-string-match-p
9871 (concat "[[:nonascii:]" org-link-escape-chars-browser "]")
9872 text)
9873 (org-link-escape text org-link-escape-chars-browser)
9874 text)))
9876 (defun org-link-unescape (str)
9877 "Unhex hexified Unicode strings as returned from the JavaScript function
9878 encodeURIComponent. E.g. `%C3%B6' is the german o-Umlaut."
9879 (unless (and (null str) (string= "" str))
9880 (let ((pos 0) (case-fold-search t) unhexed)
9881 (while (setq pos (string-match "\\(%[0-9a-f][0-9a-f]\\)+" str pos))
9882 (setq unhexed (org-link-unescape-compound (match-string 0 str)))
9883 (setq str (replace-match unhexed t t str))
9884 (setq pos (+ pos (length unhexed))))))
9885 str)
9887 (defun org-link-unescape-compound (hex)
9888 "Unhexify Unicode hex-chars. E.g. `%C3%B6' is the German o-Umlaut.
9889 Note: this function also decodes single byte encodings like
9890 `%E1' (a-acute) if not followed by another `%[A-F0-9]{2}' group."
9891 (save-match-data
9892 (let* ((bytes (cdr (split-string hex "%")))
9893 (ret "")
9894 (eat 0)
9895 (sum 0))
9896 (while bytes
9897 (let* ((val (string-to-number (pop bytes) 16))
9898 (shift-xor
9899 (if (= 0 eat)
9900 (cond
9901 ((>= val 252) (cons 6 252))
9902 ((>= val 248) (cons 5 248))
9903 ((>= val 240) (cons 4 240))
9904 ((>= val 224) (cons 3 224))
9905 ((>= val 192) (cons 2 192))
9906 (t (cons 0 0)))
9907 (cons 6 128))))
9908 (if (>= val 192) (setq eat (car shift-xor)))
9909 (setq val (logxor val (cdr shift-xor)))
9910 (setq sum (+ (lsh sum (car shift-xor)) val))
9911 (if (> eat 0) (setq eat (- eat 1)))
9912 (cond
9913 ((= 0 eat) ;multi byte
9914 (setq ret (concat ret (org-char-to-string sum)))
9915 (setq sum 0))
9916 ((not bytes) ; single byte(s)
9917 (setq ret (org-link-unescape-single-byte-sequence hex))))
9918 )) ;; end (while bytes
9919 ret )))
9921 (defun org-link-unescape-single-byte-sequence (hex)
9922 "Unhexify hex-encoded single byte character sequences."
9923 (mapconcat (lambda (byte)
9924 (char-to-string (string-to-number byte 16)))
9925 (cdr (split-string hex "%")) ""))
9927 (defun org-xor (a b)
9928 "Exclusive or."
9929 (if a (not b) b))
9931 (defun org-fixup-message-id-for-http (s)
9932 "Replace special characters in a message id, so it can be used in an http query."
9933 (when (string-match "%" s)
9934 (setq s (mapconcat (lambda (c)
9935 (if (eq c ?%)
9936 "%25"
9937 (char-to-string c)))
9938 s "")))
9939 (while (string-match "<" s)
9940 (setq s (replace-match "%3C" t t s)))
9941 (while (string-match ">" s)
9942 (setq s (replace-match "%3E" t t s)))
9943 (while (string-match "@" s)
9944 (setq s (replace-match "%40" t t s)))
9947 (defun org-link-prettify (link)
9948 "Return a human-readable representation of LINK.
9949 The car of LINK must be a raw link the cdr of LINK must be either
9950 a link description or nil."
9951 (let ((desc (or (cadr link) "<no description>")))
9952 (concat (format "%-45s" (substring desc 0 (min (length desc) 40)))
9953 "<" (car link) ">")))
9955 ;;;###autoload
9956 (defun org-insert-link-global ()
9957 "Insert a link like Org-mode does.
9958 This command can be called in any mode to insert a link in Org-mode syntax."
9959 (interactive)
9960 (org-load-modules-maybe)
9961 (org-run-like-in-org-mode 'org-insert-link))
9963 (defun org-insert-all-links (arg &optional pre post)
9964 "Insert all links in `org-stored-links'.
9965 When a universal prefix, do not delete the links from `org-stored-links'.
9966 When `ARG' is a number, insert the last N link(s).
9967 `PRE' and `POST' are optional arguments to define a string to
9968 prepend or to append."
9969 (interactive "P")
9970 (let ((org-keep-stored-link-after-insertion (equal arg '(4)))
9971 (links (copy-seq org-stored-links))
9972 (pr (or pre "- "))
9973 (po (or post "\n"))
9974 (cnt 1) l)
9975 (if (null org-stored-links)
9976 (message "No link to insert")
9977 (while (and (or (listp arg) (>= arg cnt))
9978 (setq l (if (listp arg)
9979 (pop links)
9980 (pop org-stored-links))))
9981 (setq cnt (1+ cnt))
9982 (insert pr)
9983 (org-insert-link nil (car l) (or (cadr l) "<no description>"))
9984 (insert po)))))
9986 (defun org-insert-last-stored-link (arg)
9987 "Insert the last link stored in `org-stored-links'."
9988 (interactive "p")
9989 (org-insert-all-links arg "" "\n"))
9991 (defun org-link-fontify-links-to-this-file ()
9992 "Fontify links to the current file in `org-stored-links'."
9993 (let ((f (buffer-file-name)) a b)
9994 (setq a (mapcar (lambda(l)
9995 (let ((ll (car l)))
9996 (when (and (string-match "^file:\\(.+\\)::" ll)
9997 (equal f (expand-file-name (match-string 1 ll))))
9998 ll)))
9999 org-stored-links))
10000 (when (featurep 'org-id)
10001 (setq b (mapcar (lambda(l)
10002 (let ((ll (car l)))
10003 (when (and (string-match "^id:\\(.+\\)$" ll)
10004 (equal f (expand-file-name
10005 (or (org-id-find-id-file
10006 (match-string 1 ll)) ""))))
10007 ll)))
10008 org-stored-links)))
10009 (mapcar (lambda(l)
10010 (put-text-property 0 (length l) 'face 'font-lock-comment-face l))
10011 (delq nil (append a b)))))
10013 (defvar org-link-links-in-this-file nil)
10014 (defun org-insert-link (&optional complete-file link-location default-description)
10015 "Insert a link. At the prompt, enter the link.
10017 Completion can be used to insert any of the link protocol prefixes like
10018 http or ftp in use.
10020 The history can be used to select a link previously stored with
10021 `org-store-link'. When the empty string is entered (i.e. if you just
10022 press RET at the prompt), the link defaults to the most recently
10023 stored link. As SPC triggers completion in the minibuffer, you need to
10024 use M-SPC or C-q SPC to force the insertion of a space character.
10026 You will also be prompted for a description, and if one is given, it will
10027 be displayed in the buffer instead of the link.
10029 If there is already a link at point, this command will allow you to edit link
10030 and description parts.
10032 With a \\[universal-argument] prefix, prompts for a file to link to. The file name can
10033 be selected using completion. The path to the file will be relative to the
10034 current directory if the file is in the current directory or a subdirectory.
10035 Otherwise, the link will be the absolute path as completed in the minibuffer
10036 \(i.e. normally ~/path/to/file). You can configure this behavior using the
10037 option `org-link-file-path-type'.
10039 With two \\[universal-argument] prefixes, enforce an absolute path even if the file is in
10040 the current directory or below.
10042 With three \\[universal-argument] prefixes, negate the meaning of
10043 `org-keep-stored-link-after-insertion'.
10045 If `org-make-link-description-function' is non-nil, this function will be
10046 called with the link target, and the result will be the default
10047 link description.
10049 If the LINK-LOCATION parameter is non-nil, this value will be
10050 used as the link location instead of reading one interactively.
10052 If the DEFAULT-DESCRIPTION parameter is non-nil, this value will
10053 be used as the default description."
10054 (interactive "P")
10055 (let* ((wcf (current-window-configuration))
10056 (origbuf (current-buffer))
10057 (region (if (org-region-active-p)
10058 (buffer-substring (region-beginning) (region-end))))
10059 (remove (and region (list (region-beginning) (region-end))))
10060 (desc region)
10061 tmphist ; byte-compile incorrectly complains about this
10062 (link link-location)
10063 (abbrevs org-link-abbrev-alist-local)
10064 entry file all-prefixes auto-desc)
10065 (cond
10066 (link-location) ; specified by arg, just use it.
10067 ((org-in-regexp org-bracket-link-regexp 1)
10068 ;; We do have a link at point, and we are going to edit it.
10069 (setq remove (list (match-beginning 0) (match-end 0)))
10070 (setq desc (if (match-end 3) (org-match-string-no-properties 3)))
10071 (setq link (read-string "Link: "
10072 (org-link-unescape
10073 (org-match-string-no-properties 1)))))
10074 ((or (org-in-regexp org-angle-link-re)
10075 (org-in-regexp org-plain-link-re))
10076 ;; Convert to bracket link
10077 (setq remove (list (match-beginning 0) (match-end 0))
10078 link (read-string "Link: "
10079 (org-remove-angle-brackets (match-string 0)))))
10080 ((member complete-file '((4) (16)))
10081 ;; Completing read for file names.
10082 (setq link (org-file-complete-link complete-file)))
10084 ;; Read link, with completion for stored links.
10085 (org-link-fontify-links-to-this-file)
10086 (org-switch-to-buffer-other-window "*Org Links*")
10087 (with-current-buffer "*Org Links*"
10088 (erase-buffer)
10089 (insert "Insert a link.
10090 Use TAB to complete link prefixes, then RET for type-specific completion support\n")
10091 (when org-stored-links
10092 (insert "\nStored links are available with <up>/<down> or M-p/n (most recent with RET):\n\n")
10093 (insert (mapconcat 'org-link-prettify
10094 (reverse org-stored-links) "\n")))
10095 (goto-char (point-min)))
10096 (let ((cw (selected-window)))
10097 (select-window (get-buffer-window "*Org Links*" 'visible))
10098 (with-current-buffer "*Org Links*" (setq truncate-lines t))
10099 (unless (pos-visible-in-window-p (point-max))
10100 (org-fit-window-to-buffer))
10101 (and (window-live-p cw) (select-window cw)))
10102 ;; Fake a link history, containing the stored links.
10103 (setq tmphist (append (mapcar 'car org-stored-links)
10104 org-insert-link-history))
10105 (setq all-prefixes (append (mapcar 'car abbrevs)
10106 (mapcar 'car org-link-abbrev-alist)
10107 org-link-types))
10108 (unwind-protect
10109 (progn
10110 (setq link
10111 (org-completing-read
10112 "Link: "
10113 (append
10114 (mapcar (lambda (x) (concat x ":"))
10115 all-prefixes)
10116 (mapcar 'car org-stored-links))
10117 nil nil nil
10118 'tmphist
10119 (caar org-stored-links)))
10120 (if (not (string-match "\\S-" link))
10121 (user-error "No link selected"))
10122 (mapc (lambda(l)
10123 (when (equal link (cadr l)) (setq link (car l) auto-desc t)))
10124 org-stored-links)
10125 (if (or (member link all-prefixes)
10126 (and (equal ":" (substring link -1))
10127 (member (substring link 0 -1) all-prefixes)
10128 (setq link (substring link 0 -1))))
10129 (setq link (with-current-buffer origbuf
10130 (org-link-try-special-completion link)))))
10131 (set-window-configuration wcf)
10132 (kill-buffer "*Org Links*"))
10133 (setq entry (assoc link org-stored-links))
10134 (or entry (push link org-insert-link-history))
10135 (setq desc (or desc (nth 1 entry)))))
10137 (if (funcall (if (equal complete-file '(64)) 'not 'identity)
10138 (not org-keep-stored-link-after-insertion))
10139 (setq org-stored-links (delq (assoc link org-stored-links)
10140 org-stored-links)))
10142 (if (and (string-match org-plain-link-re link)
10143 (not (string-match org-ts-regexp link)))
10144 ;; URL-like link, normalize the use of angular brackets.
10145 (setq link (org-remove-angle-brackets link)))
10147 ;; Check if we are linking to the current file with a search
10148 ;; option If yes, simplify the link by using only the search
10149 ;; option.
10150 (when (and buffer-file-name
10151 (string-match "^file:\\(.+?\\)::\\(.+\\)" link))
10152 (let* ((path (match-string 1 link))
10153 (case-fold-search nil)
10154 (search (match-string 2 link)))
10155 (save-match-data
10156 (if (equal (file-truename buffer-file-name) (file-truename path))
10157 ;; We are linking to this same file, with a search option
10158 (setq link search)))))
10160 ;; Check if we can/should use a relative path. If yes, simplify the link
10161 (when (string-match "^\\(file:\\|docview:\\)\\(.*\\)" link)
10162 (let* ((type (match-string 1 link))
10163 (path (match-string 2 link))
10164 (origpath path)
10165 (case-fold-search nil))
10166 (cond
10167 ((or (eq org-link-file-path-type 'absolute)
10168 (equal complete-file '(16)))
10169 (setq path (abbreviate-file-name (expand-file-name path))))
10170 ((eq org-link-file-path-type 'noabbrev)
10171 (setq path (expand-file-name path)))
10172 ((eq org-link-file-path-type 'relative)
10173 (setq path (file-relative-name path)))
10175 (save-match-data
10176 (if (string-match (concat "^" (regexp-quote
10177 (expand-file-name
10178 (file-name-as-directory
10179 default-directory))))
10180 (expand-file-name path))
10181 ;; We are linking a file with relative path name.
10182 (setq path (substring (expand-file-name path)
10183 (match-end 0)))
10184 (setq path (abbreviate-file-name (expand-file-name path)))))))
10185 (setq link (concat type path))
10186 (if (equal desc origpath)
10187 (setq desc path))))
10189 (if org-make-link-description-function
10190 (setq desc
10191 (or (condition-case nil
10192 (funcall org-make-link-description-function link desc)
10193 (error (progn (message "Can't get link description from `%s'"
10194 (symbol-name org-make-link-description-function))
10195 (sit-for 2) nil)))
10196 (read-string "Description: " default-description)))
10197 (if default-description (setq desc default-description)
10198 (setq desc (or (and auto-desc desc)
10199 (read-string "Description: " desc)))))
10201 (unless (string-match "\\S-" desc) (setq desc nil))
10202 (if remove (apply 'delete-region remove))
10203 (insert (org-make-link-string link desc))))
10205 (defun org-link-try-special-completion (type)
10206 "If there is completion support for link type TYPE, offer it."
10207 (let ((fun (intern (concat "org-" type "-complete-link"))))
10208 (if (functionp fun)
10209 (funcall fun)
10210 (read-string "Link (no completion support): " (concat type ":")))))
10212 (defun org-file-complete-link (&optional arg)
10213 "Create a file link using completion."
10214 (let (file link)
10215 (setq file (org-iread-file-name "File: "))
10216 (let ((pwd (file-name-as-directory (expand-file-name ".")))
10217 (pwd1 (file-name-as-directory (abbreviate-file-name
10218 (expand-file-name ".")))))
10219 (cond
10220 ((equal arg '(16))
10221 (setq link (concat
10222 "file:"
10223 (abbreviate-file-name (expand-file-name file)))))
10224 ((string-match (concat "^" (regexp-quote pwd1) "\\(.+\\)") file)
10225 (setq link (concat "file:" (match-string 1 file))))
10226 ((string-match (concat "^" (regexp-quote pwd) "\\(.+\\)")
10227 (expand-file-name file))
10228 (setq link (concat
10229 "file:" (match-string 1 (expand-file-name file)))))
10230 (t (setq link (concat "file:" file)))))
10231 link))
10233 (defun org-iread-file-name (&rest args)
10234 "Read-file-name using `ido-mode' speedup if available.
10235 ARGS are arguments that may be passed to `ido-read-file-name' or `read-file-name'.
10236 See `read-file-name' for a description of parameters."
10237 (org-without-partial-completion
10238 (if (and org-completion-use-ido
10239 (fboundp 'ido-read-file-name)
10240 (boundp 'ido-mode) ido-mode
10241 (listp (second args)))
10242 (let ((ido-enter-matching-directory nil))
10243 (apply 'ido-read-file-name args))
10244 (apply 'read-file-name args))))
10246 (defun org-completing-read (&rest args)
10247 "Completing-read with SPACE being a normal character."
10248 (let ((enable-recursive-minibuffers t)
10249 (minibuffer-local-completion-map
10250 (copy-keymap minibuffer-local-completion-map)))
10251 (org-defkey minibuffer-local-completion-map " " 'self-insert-command)
10252 (org-defkey minibuffer-local-completion-map "?" 'self-insert-command)
10253 (org-defkey minibuffer-local-completion-map (kbd "C-c !") 'org-time-stamp-inactive)
10254 (apply 'org-icompleting-read args)))
10256 (defun org-completing-read-no-i (&rest args)
10257 (let (org-completion-use-ido org-completion-use-iswitchb)
10258 (apply 'org-completing-read args)))
10260 (defun org-iswitchb-completing-read (prompt choices &rest args)
10261 "Use iswitch as a completing-read replacement to choose from choices.
10262 PROMPT is a string to prompt with. CHOICES is a list of strings to choose
10263 from."
10264 (let* ((iswitchb-use-virtual-buffers nil)
10265 (iswitchb-make-buflist-hook
10266 (lambda ()
10267 (setq iswitchb-temp-buflist choices))))
10268 (iswitchb-read-buffer prompt)))
10270 (defun org-icompleting-read (&rest args)
10271 "Completing-read using `ido-mode' or `iswitchb' speedups if available."
10272 (org-without-partial-completion
10273 (if (and org-completion-use-ido
10274 (fboundp 'ido-completing-read)
10275 (boundp 'ido-mode) ido-mode
10276 (listp (second args)))
10277 (let ((ido-enter-matching-directory nil))
10278 (apply 'ido-completing-read (concat (car args))
10279 (if (consp (car (nth 1 args)))
10280 (mapcar 'car (nth 1 args))
10281 (nth 1 args))
10282 (cddr args)))
10283 (if (and org-completion-use-iswitchb
10284 (boundp 'iswitchb-mode) iswitchb-mode
10285 (listp (second args)))
10286 (apply 'org-iswitchb-completing-read (concat (car args))
10287 (if (consp (car (nth 1 args)))
10288 (mapcar 'car (nth 1 args))
10289 (nth 1 args))
10290 (cddr args))
10291 (apply 'completing-read args)))))
10293 (defun org-extract-attributes (s)
10294 "Extract the attributes cookie from a string and set as text property."
10295 (let (a attr (start 0) key value)
10296 (save-match-data
10297 (when (string-match "{{\\([^}]+\\)}}$" s)
10298 (setq a (match-string 1 s) s (substring s 0 (match-beginning 0)))
10299 (while (string-match "\\([a-zA-Z]+\\)=\"\\([^\"]*\\)\"" a start)
10300 (setq key (match-string 1 a) value (match-string 2 a)
10301 start (match-end 0)
10302 attr (plist-put attr (intern key) value))))
10303 (org-add-props s nil 'org-attr attr))
10306 ;;; Opening/following a link
10308 (defvar org-link-search-failed nil)
10310 (defvar org-open-link-functions nil
10311 "Hook for functions finding a plain text link.
10312 These functions must take a single argument, the link content.
10313 They will be called for links that look like [[link text][description]]
10314 when LINK TEXT does not have a protocol like \"http:\" and does not look
10315 like a filename (e.g. \"./blue.png\").
10317 These functions will be called *before* Org attempts to resolve the
10318 link by doing text searches in the current buffer - so if you want a
10319 link \"[[target]]\" to still find \"<<target>>\", your function should
10320 handle this as a special case.
10322 When the function does handle the link, it must return a non-nil value.
10323 If it decides that it is not responsible for this link, it must return
10324 nil to indicate that that Org-mode can continue with other options
10325 like exact and fuzzy text search.")
10327 (defun org-next-link (&optional search-backward)
10328 "Move forward to the next link.
10329 If the link is in hidden text, expose it."
10330 (interactive "P")
10331 (when (and org-link-search-failed (eq this-command last-command))
10332 (goto-char (point-min))
10333 (message "Link search wrapped back to beginning of buffer"))
10334 (setq org-link-search-failed nil)
10335 (let* ((pos (point))
10336 (ct (org-context))
10337 (a (assoc :link ct))
10338 (srch-fun (if search-backward 're-search-backward 're-search-forward)))
10339 (cond (a (goto-char (nth (if search-backward 1 2) a)))
10340 ((looking-at org-any-link-re)
10341 ;; Don't stay stuck at link without an org-link face
10342 (forward-char (if search-backward -1 1))))
10343 (if (funcall srch-fun org-any-link-re nil t)
10344 (progn
10345 (goto-char (match-beginning 0))
10346 (if (outline-invisible-p) (org-show-context)))
10347 (goto-char pos)
10348 (setq org-link-search-failed t)
10349 (message "No further link found"))))
10351 (defun org-previous-link ()
10352 "Move backward to the previous link.
10353 If the link is in hidden text, expose it."
10354 (interactive)
10355 (funcall 'org-next-link t))
10357 (defun org-translate-link (s)
10358 "Translate a link string if a translation function has been defined."
10359 (if (and org-link-translation-function
10360 (fboundp org-link-translation-function)
10361 (string-match "\\([a-zA-Z0-9]+\\):\\(.*\\)" s))
10362 (progn
10363 (setq s (funcall org-link-translation-function
10364 (match-string 1 s) (match-string 2 s)))
10365 (concat (car s) ":" (cdr s)))
10368 (defun org-translate-link-from-planner (type path)
10369 "Translate a link from Emacs Planner syntax so that Org can follow it.
10370 This is still an experimental function, your mileage may vary."
10371 (cond
10372 ((member type '("http" "https" "news" "ftp"))
10373 ;; standard Internet links are the same.
10374 nil)
10375 ((and (equal type "irc") (string-match "^//" path))
10376 ;; Planner has two / at the beginning of an irc link, we have 1.
10377 ;; We should have zero, actually....
10378 (setq path (substring path 1)))
10379 ((and (equal type "lisp") (string-match "^/" path))
10380 ;; Planner has a slash, we do not.
10381 (setq type "elisp" path (substring path 1)))
10382 ((string-match "^//\\(.?*\\)/\\(<.*>\\)$" path)
10383 ;; A typical message link. Planner has the id after the final slash,
10384 ;; we separate it with a hash mark
10385 (setq path (concat (match-string 1 path) "#"
10386 (org-remove-angle-brackets (match-string 2 path))))))
10387 (cons type path))
10389 (defun org-find-file-at-mouse (ev)
10390 "Open file link or URL at mouse."
10391 (interactive "e")
10392 (mouse-set-point ev)
10393 (org-open-at-point 'in-emacs))
10395 (defun org-open-at-mouse (ev)
10396 "Open file link or URL at mouse.
10397 See the docstring of `org-open-file' for details."
10398 (interactive "e")
10399 (mouse-set-point ev)
10400 (if (eq major-mode 'org-agenda-mode)
10401 (org-agenda-copy-local-variable 'org-link-abbrev-alist-local))
10402 (org-open-at-point))
10404 (defvar org-window-config-before-follow-link nil
10405 "The window configuration before following a link.
10406 This is saved in case the need arises to restore it.")
10408 (defvar org-open-link-marker (make-marker)
10409 "Marker pointing to the location where `org-open-at-point' was called.")
10411 ;;;###autoload
10412 (defun org-open-at-point-global ()
10413 "Follow a link like Org-mode does.
10414 This command can be called in any mode to follow a link that has
10415 Org-mode syntax."
10416 (interactive)
10417 (org-run-like-in-org-mode 'org-open-at-point))
10419 ;;;###autoload
10420 (defun org-open-link-from-string (s &optional arg reference-buffer)
10421 "Open a link in the string S, as if it was in Org-mode."
10422 (interactive "sLink: \nP")
10423 (let ((reference-buffer (or reference-buffer (current-buffer))))
10424 (with-temp-buffer
10425 (let ((org-inhibit-startup (not reference-buffer)))
10426 (org-mode)
10427 (insert s)
10428 (goto-char (point-min))
10429 (when reference-buffer
10430 (setq org-link-abbrev-alist-local
10431 (with-current-buffer reference-buffer
10432 org-link-abbrev-alist-local)))
10433 (org-open-at-point arg reference-buffer)))))
10435 (defvar org-open-at-point-functions nil
10436 "Hook that is run when following a link at point.
10438 Functions in this hook must return t if they identify and follow
10439 a link at point. If they don't find anything interesting at point,
10440 they must return nil.")
10442 (defvar org-link-search-inhibit-query nil) ;; dynamically scoped
10443 (defvar clean-buffer-list-kill-buffer-names) ; Defined in midnight.el
10444 (defun org-open-at-point (&optional arg reference-buffer)
10445 "Open link, timestamp, footnote or tags at point.
10447 When point is on a link, follow it. Normally, files will be
10448 opened by an appropriate application. If the optional prefix
10449 argument ARG is non-nil, Emacs will visit the file. With
10450 a double prefix argument, try to open outside of Emacs, in the
10451 application the system uses for this file type.
10453 When point is on a timestamp, open the agenda at the day
10454 specified.
10456 When point is a footnote definition, move to the first reference
10457 found. If it is on a reference, move to the associated
10458 definition.
10460 When point is on a headline, display a list of every link in the
10461 entry, so it is possible to pick one, or all, of them. If point
10462 is on a tag, call `org-tags-view' instead.
10464 When optional argument REFERENCE-BUFFER is non-nil, it should
10465 specify a buffer from where the link search should happen. This
10466 is used internally by `org-open-link-from-string'."
10467 (interactive "P")
10468 ;; On a code block, open block's results.
10469 (unless (call-interactively #'org-babel-open-src-block-result)
10470 (org-load-modules-maybe)
10471 (move-marker org-open-link-marker (point))
10472 (setq org-window-config-before-follow-link (current-window-configuration))
10473 (org-remove-occur-highlights nil nil t)
10474 (unless (run-hook-with-args-until-success 'org-open-at-point-functions)
10475 (let* ((context (org-element-context)) type)
10476 ;; On an unsupported type, check if point is contained within
10477 ;; a support one.
10478 (while (and (not (memq (setq type (org-element-type context))
10479 '(headline inlinetask link footnote-definition
10480 footnote-reference timestamp)))
10481 (setq context (org-element-property :parent context))))
10482 (cond
10483 ;; On a headline or an inlinetask, but not on a timestamp,
10484 ;; a link, a footnote reference or on tags.
10485 ((and (memq type '(headline inlinetask))
10486 ;; Not on tags.
10487 (progn (save-excursion (beginning-of-line)
10488 (looking-at org-complex-heading-regexp))
10489 (or (not (match-beginning 5))
10490 (< (point) (match-beginning 5)))))
10491 (let* ((data (org-offer-links-in-entry (current-buffer) (point) arg))
10492 (links (car data))
10493 (links-end (cdr data)))
10494 (if links
10495 (dolist (link (if (stringp links) (list links) links))
10496 (search-forward link nil links-end)
10497 (goto-char (match-beginning 0))
10498 (org-open-at-point))
10499 (require 'org-attach)
10500 (org-attach-reveal 'if-exists))))
10501 ;; Do nothing on white spaces after an object.
10502 ((let ((end (org-element-property :end context)))
10503 (= (save-excursion
10504 ;; Make sure we're not on invisible text, as it would
10505 ;; make the check unpredictable on object's borders.
10506 (when (invisible-p (point))
10507 (goto-char
10508 (next-single-property-change (point) 'invisible nil end)))
10509 (skip-chars-forward " \t" end) (point))
10510 end))
10511 (user-error "No link found"))
10512 ((eq type 'timestamp) (org-follow-timestamp-link))
10513 ;; On tags within a headline or an inlinetask.
10514 ((and (memq type '(headline inlinetask))
10515 (progn (save-excursion (beginning-of-line)
10516 (looking-at org-complex-heading-regexp))
10517 (and (match-beginning 5)
10518 (>= (point) (match-beginning 5)))))
10519 (org-tags-view arg (substring (match-string 5) 0 -1)))
10520 ((eq type 'link)
10521 (let ((type (org-element-property :type context))
10522 (path (org-element-property :path context)))
10523 ;; Switch back to REFERENCE-BUFFER needed when called in
10524 ;; a temporary buffer through `org-open-link-from-string'.
10525 (with-current-buffer (or reference-buffer (current-buffer))
10526 (cond
10527 ((equal type "file")
10528 (if (string-match "[*?{]" (file-name-nondirectory path))
10529 (dired path)
10530 (apply
10531 (or (let ((app (org-element-property :application context)))
10532 (nth 1 (assoc (concat "file" (and app (concat "+" app)))
10533 org-link-protocols)))
10534 #'org-open-file)
10535 path arg
10536 (let ((option (org-element-property :search-option context)))
10537 (cond ((not option) nil)
10538 ((org-string-match-p "\\`[0-9]+\\'" option)
10539 (list (string-to-number option)))
10540 (t (list nil option)))))))
10541 ((assoc type org-link-protocols)
10542 (funcall (nth 1 (assoc type org-link-protocols)) path))
10543 ((equal type "help")
10544 (let ((f-or-v (intern path)))
10545 (cond ((fboundp f-or-v) (describe-function f-or-v))
10546 ((boundp f-or-v) (describe-variable f-or-v))
10547 (t (error "Not a known function or variable")))))
10548 ((equal type "mailto")
10549 (let ((cmd (car org-link-mailto-program))
10550 (args (cdr org-link-mailto-program))
10551 (spec
10552 (format-spec-make
10553 ?a path ; %a is address.
10554 ?s (let ((option ; %s is subject.
10555 (org-element-property
10556 :search-option context)))
10557 (if (not option) "" (org-link-escape option)))))
10558 final-args)
10559 (apply cmd
10560 (dolist (arg args (nreverse final-args))
10561 (if (not (stringp arg)) (push arg final-args)
10562 (push (format-spec arg spec) final-args))))))
10563 ((member type '("http" "https" "ftp" "news"))
10564 (browse-url (org-link-escape-browser (concat type ":" path))))
10565 ((equal type "doi")
10566 (browse-url
10567 (org-link-escape-browser (concat org-doi-server-url path))))
10568 ((equal type "message") (browse-url (concat type ":" path)))
10569 ((equal type "shell")
10570 (let ((buf (generate-new-buffer "*Org Shell Output"))
10571 (cmd path))
10572 (if (or (and (org-string-nw-p
10573 org-confirm-shell-link-not-regexp)
10574 (string-match
10575 org-confirm-shell-link-not-regexp cmd))
10576 (not org-confirm-shell-link-function)
10577 (funcall org-confirm-shell-link-function
10578 (format "Execute \"%s\" in shell? "
10579 (org-add-props cmd nil
10580 'face 'org-warning))))
10581 (progn
10582 (message "Executing %s" cmd)
10583 (shell-command cmd buf)
10584 (when (featurep 'midnight)
10585 (setq clean-buffer-list-kill-buffer-names
10586 (cons buf
10587 clean-buffer-list-kill-buffer-names))))
10588 (error "Abort"))))
10589 ((equal type "elisp")
10590 (let ((cmd path))
10591 (if (or (and (org-string-nw-p
10592 org-confirm-elisp-link-not-regexp)
10593 (org-string-match-p
10594 org-confirm-elisp-link-not-regexp cmd))
10595 (not org-confirm-elisp-link-function)
10596 (funcall org-confirm-elisp-link-function
10597 (format "Execute \"%s\" as elisp? "
10598 (org-add-props cmd nil
10599 'face 'org-warning))))
10600 (message "%s => %s" cmd
10601 (if (eq (string-to-char cmd) ?\()
10602 (eval (read cmd))
10603 (call-interactively (read cmd))))
10604 (error "Abort"))))
10605 ((equal type "id")
10606 (require 'ord-id)
10607 (funcall (nth 1 (assoc "id" org-link-protocols)) path))
10608 ((member type '("coderef" "custom-id" "fuzzy" "radio"))
10609 (unless (run-hook-with-args-until-success
10610 'org-open-link-functions path)
10611 (if (not arg) (org-mark-ring-push)
10612 (switch-to-buffer-other-window
10613 (org-get-buffer-for-internal-link (current-buffer))))
10614 (let ((cmd `(org-link-search
10615 ,(org-element-property :raw-link context)
10616 ,(cond ((equal arg '(4)) ''occur)
10617 ((equal arg '(16)) ''org-occur))
10618 ,(org-element-property :begin context))))
10619 (condition-case nil
10620 (let ((org-link-search-inhibit-query t))
10621 (eval cmd))
10622 (error (progn (widen) (eval cmd)))))))
10623 (t (browse-url-at-point))))))
10624 ;; On a footnote reference or at a footnote definition's label.
10625 ((or (eq type 'footnote-reference)
10626 (and (eq type 'footnote-definition)
10627 (save-excursion
10628 ;; Do not validate action when point is on the
10629 ;; spaces right after the footnote label, in
10630 ;; order to be on par with behaviour on links.
10631 (skip-chars-forward " \t")
10632 (let ((begin
10633 (org-element-property :contents-begin context)))
10634 (if begin (< (point) begin)
10635 (= (org-element-property :post-affiliated context)
10636 (line-beginning-position)))))))
10637 (org-footnote-action))
10638 (t (user-error "No link found")))))
10639 (move-marker org-open-link-marker nil)
10640 (run-hook-with-args 'org-follow-link-hook)))
10642 (defun org-offer-links-in-entry (buffer marker &optional nth zero)
10643 "Offer links in the current entry and return the selected link.
10644 If there is only one link, return it.
10645 If NTH is an integer, return the NTH link found.
10646 If ZERO is a string, check also this string for a link, and if
10647 there is one, return it."
10648 (with-current-buffer buffer
10649 (save-excursion
10650 (save-restriction
10651 (widen)
10652 (goto-char marker)
10653 (let ((re (concat "\\(" org-bracket-link-regexp "\\)\\|"
10654 "\\(" org-angle-link-re "\\)\\|"
10655 "\\(" org-plain-link-re "\\)"))
10656 (cnt ?0)
10657 (in-emacs (if (integerp nth) nil nth))
10658 have-zero end links link c)
10659 (when (and (stringp zero) (string-match org-bracket-link-regexp zero))
10660 (push (match-string 0 zero) links)
10661 (setq cnt (1- cnt) have-zero t))
10662 (save-excursion
10663 (org-back-to-heading t)
10664 (setq end (save-excursion (outline-next-heading) (point)))
10665 (while (re-search-forward re end t)
10666 (push (match-string 0) links))
10667 (setq links (org-uniquify (reverse links))))
10668 (cond
10669 ((null links)
10670 (message "No links"))
10671 ((equal (length links) 1)
10672 (setq link (car links)))
10673 ((and (integerp nth) (>= (length links) (if have-zero (1+ nth) nth)))
10674 (setq link (nth (if have-zero nth (1- nth)) links)))
10675 (t ; we have to select a link
10676 (save-excursion
10677 (save-window-excursion
10678 (delete-other-windows)
10679 (with-output-to-temp-buffer "*Select Link*"
10680 (mapc (lambda (l)
10681 (if (not (string-match org-bracket-link-regexp l))
10682 (princ (format "[%c] %s\n" (incf cnt)
10683 (org-remove-angle-brackets l)))
10684 (if (match-end 3)
10685 (princ (format "[%c] %s (%s)\n" (incf cnt)
10686 (match-string 3 l) (match-string 1 l)))
10687 (princ (format "[%c] %s\n" (incf cnt)
10688 (match-string 1 l))))))
10689 links))
10690 (org-fit-window-to-buffer (get-buffer-window "*Select Link*"))
10691 (message "Select link to open, RET to open all:")
10692 (setq c (read-char-exclusive))
10693 (and (get-buffer "*Select Link*") (kill-buffer "*Select Link*"))))
10694 (when (equal c ?q) (error "Abort"))
10695 (if (equal c ?\C-m)
10696 (setq link links)
10697 (setq nth (- c ?0))
10698 (if have-zero (setq nth (1+ nth)))
10699 (unless (and (integerp nth) (>= (length links) nth))
10700 (user-error "Invalid link selection"))
10701 (setq link (nth (1- nth) links)))))
10702 (cons link end))))))
10704 ;; Add special file links that specify the way of opening
10706 (org-add-link-type "file+sys" 'org-open-file-with-system)
10707 (org-add-link-type "file+emacs" 'org-open-file-with-emacs)
10708 (defun org-open-file-with-system (path &optional arg line search)
10709 "Open file at PATH using the system way of opening it.
10710 Optional argument ARG is ignored. See `org-open-file' for LINE
10711 and SEARCH arguments."
10712 (org-open-file path 'system line search))
10713 (defun org-open-file-with-emacs (path &optional arg line search)
10714 "Open file at PATH in Emacs.
10715 Optional argument ARG is ignored. See `org-open-file' for LINE
10716 and SEARCH arguments."
10717 (org-open-file path 'emacs line search))
10720 ;;; File search
10722 (defvar org-create-file-search-functions nil
10723 "List of functions to construct the right search string for a file link.
10724 These functions are called in turn with point at the location to
10725 which the link should point.
10727 A function in the hook should first test if it would like to
10728 handle this file type, for example by checking the `major-mode'
10729 or the file extension. If it decides not to handle this file, it
10730 should just return nil to give other functions a chance. If it
10731 does handle the file, it must return the search string to be used
10732 when following the link. The search string will be part of the
10733 file link, given after a double colon, and `org-open-at-point'
10734 will automatically search for it. If special measures must be
10735 taken to make the search successful, another function should be
10736 added to the companion hook `org-execute-file-search-functions',
10737 which see.
10739 A function in this hook may also use `setq' to set the variable
10740 `description' to provide a suggestion for the descriptive text to
10741 be used for this link when it gets inserted into an Org-mode
10742 buffer with \\[org-insert-link].")
10744 (defvar org-execute-file-search-functions nil
10745 "List of functions to execute a file search triggered by a link.
10747 Functions added to this hook must accept a single argument, the
10748 search string that was part of the file link, the part after the
10749 double colon. The function must first check if it would like to
10750 handle this search, for example by checking the `major-mode' or
10751 the file extension. If it decides not to handle this search, it
10752 should just return nil to give other functions a chance. If it
10753 does handle the search, it must return a non-nil value to keep
10754 other functions from trying.
10756 Each function can access the current prefix argument through the
10757 variable `current-prefix-arg'. Note that a single prefix is used
10758 to force opening a link in Emacs, so it may be good to only use a
10759 numeric or double prefix to guide the search function.
10761 In case this is needed, a function in this hook can also restore
10762 the window configuration before `org-open-at-point' was called using:
10764 (set-window-configuration org-window-config-before-follow-link)")
10766 (defun org-link-search (s &optional type avoid-pos stealth)
10767 "Search for a link search option.
10768 If S is surrounded by forward slashes, it is interpreted as a
10769 regular expression. In org-mode files, this will create an `org-occur'
10770 sparse tree. In ordinary files, `occur' will be used to list matches.
10771 If the current buffer is in `dired-mode', grep will be used to search
10772 in all files. If AVOID-POS is given, ignore matches near that position.
10774 When optional argument STEALTH is non-nil, do not modify
10775 visibility around point, thus ignoring
10776 `org-show-hierarchy-above', `org-show-following-heading' and
10777 `org-show-siblings' variables."
10778 (let ((case-fold-search t)
10779 (s0 (mapconcat 'identity (org-split-string s "[ \t\r\n]+") " "))
10780 (markers (concat "\\(?:" (mapconcat (lambda (x) (regexp-quote (car x)))
10781 (append '(("") (" ") ("\t") ("\n"))
10782 org-emphasis-alist)
10783 "\\|") "\\)"))
10784 (pos (point))
10785 (pre nil) (post nil)
10786 words re0 re1 re2 re3 re4_ re4 re5 re2a re2a_ reall)
10787 (cond
10788 ;; First check if there are any special search functions
10789 ((run-hook-with-args-until-success 'org-execute-file-search-functions s))
10790 ;; Now try the builtin stuff
10791 ((and (equal (string-to-char s0) ?#)
10792 (> (length s0) 1)
10793 (save-excursion
10794 (goto-char (point-min))
10795 (and
10796 (re-search-forward
10797 (concat "^[ \t]*:CUSTOM_ID:[ \t]+"
10798 (regexp-quote (substring s0 1)) "[ \t]*$") nil t)
10799 (setq type 'dedicated
10800 pos (match-beginning 0))))
10801 ;; There is an exact target for this
10802 (goto-char pos)
10803 (org-back-to-heading t)))
10804 ((save-excursion
10805 (goto-char (point-min))
10806 (and
10807 (re-search-forward
10808 (concat "<<" (regexp-quote s0) ">>") nil t)
10809 (setq type 'dedicated
10810 pos (match-beginning 0))))
10811 ;; There is an exact target for this
10812 (goto-char pos))
10813 ((save-excursion
10814 (goto-char (point-min))
10815 (and
10816 (re-search-forward
10817 (format "^[ \t]*#\\+NAME: %s" (regexp-quote s0)) nil t)
10818 (setq type 'dedicated pos (match-beginning 0))))
10819 ;; Found an element with a matching #+name affiliated keyword.
10820 (goto-char pos))
10821 ((and (string-match "^(\\(.*\\))$" s0)
10822 (save-excursion
10823 (goto-char (point-min))
10824 (and
10825 (re-search-forward
10826 (concat "[^[]" (regexp-quote
10827 (format org-coderef-label-format
10828 (match-string 1 s0))))
10829 nil t)
10830 (setq type 'dedicated
10831 pos (1+ (match-beginning 0))))))
10832 ;; There is a coderef target for this
10833 (goto-char pos))
10834 ((string-match "^/\\(.*\\)/$" s)
10835 ;; A regular expression
10836 (cond
10837 ((derived-mode-p 'org-mode)
10838 (org-occur (match-string 1 s)))
10839 (t (org-do-occur (match-string 1 s)))))
10840 ((and (derived-mode-p 'org-mode) org-link-search-must-match-exact-headline)
10841 (and (equal (string-to-char s) ?*) (setq s (substring s 1)))
10842 (goto-char (point-min))
10843 (cond
10844 ((let (case-fold-search)
10845 (re-search-forward (format org-complex-heading-regexp-format
10846 (regexp-quote s))
10847 nil t))
10848 ;; OK, found a match
10849 (setq type 'dedicated)
10850 (goto-char (match-beginning 0)))
10851 ((and (not org-link-search-inhibit-query)
10852 (eq org-link-search-must-match-exact-headline 'query-to-create)
10853 (y-or-n-p "No match - create this as a new heading? "))
10854 (goto-char (point-max))
10855 (or (bolp) (newline))
10856 (insert "* " s "\n")
10857 (beginning-of-line 0))
10859 (goto-char pos)
10860 (error "No match"))))
10862 ;; A normal search string
10863 (when (equal (string-to-char s) ?*)
10864 ;; Anchor on headlines, post may include tags.
10865 (setq pre "^\\*+[ \t]+\\(?:\\sw+\\)?[ \t]*"
10866 post (org-re "[ \t]*\\(?:[ \t]+:[[:alnum:]_@#%:+]:[ \t]*\\)?$")
10867 s (substring s 1)))
10868 (remove-text-properties
10869 0 (length s)
10870 '(face nil mouse-face nil keymap nil fontified nil) s)
10871 ;; Make a series of regular expressions to find a match
10872 (setq words (org-split-string s "[ \n\r\t]+")
10874 re0 (concat "\\(<<" (regexp-quote s0) ">>\\)")
10875 re2 (concat markers "\\(" (mapconcat 'downcase words "[ \t]+")
10876 "\\)" markers)
10877 re2a_ (concat "\\(" (mapconcat 'downcase words
10878 "[ \t\r\n]+") "\\)[ \t\r\n]")
10879 re2a (concat "[ \t\r\n]" re2a_)
10880 re4_ (concat "\\(" (mapconcat 'downcase words
10881 "[^a-zA-Z_\r\n]+") "\\)[^a-zA-Z_]")
10882 re4 (concat "[^a-zA-Z_]" re4_)
10884 re1 (concat pre re2 post)
10885 re3 (concat pre (if pre re4_ re4) post)
10886 re5 (concat pre ".*" re4)
10887 re2 (concat pre re2)
10888 re2a (concat pre (if pre re2a_ re2a))
10889 re4 (concat pre (if pre re4_ re4))
10890 reall (concat "\\(" re0 "\\)\\|\\(" re1 "\\)\\|\\(" re2
10891 "\\)\\|\\(" re3 "\\)\\|\\(" re4 "\\)\\|\\("
10892 re5 "\\)"))
10893 (cond
10894 ((eq type 'org-occur) (org-occur reall))
10895 ((eq type 'occur) (org-do-occur (downcase reall) 'cleanup))
10896 (t (goto-char (point-min))
10897 (setq type 'fuzzy)
10898 (if (or (and (org-search-not-self 1 re0 nil t)
10899 (setq type 'dedicated))
10900 (org-search-not-self 1 re1 nil t)
10901 (org-search-not-self 1 re2 nil t)
10902 (org-search-not-self 1 re2a nil t)
10903 (org-search-not-self 1 re3 nil t)
10904 (org-search-not-self 1 re4 nil t)
10905 (org-search-not-self 1 re5 nil t))
10906 (goto-char (match-beginning 1))
10907 (goto-char pos)
10908 (error "No match"))))))
10909 (and (derived-mode-p 'org-mode)
10910 (not stealth)
10911 (org-show-context 'link-search))
10912 type))
10914 (defun org-search-not-self (group &rest args)
10915 "Execute `re-search-forward', but only accept matches that do not
10916 enclose the position of `org-open-link-marker'."
10917 (let ((m org-open-link-marker))
10918 (catch 'exit
10919 (while (apply 're-search-forward args)
10920 (unless (get-text-property (match-end group) 'intangible) ; Emacs 21
10921 (goto-char (match-end group))
10922 (if (and (or (not (eq (marker-buffer m) (current-buffer)))
10923 (> (match-beginning 0) (marker-position m))
10924 (< (match-end 0) (marker-position m)))
10925 (save-match-data
10926 (or (not (org-in-regexp
10927 org-bracket-link-analytic-regexp 1))
10928 (not (match-end 4)) ; no description
10929 (and (<= (match-beginning 4) (point))
10930 (>= (match-end 4) (point))))))
10931 (throw 'exit (point))))))))
10933 (defun org-get-buffer-for-internal-link (buffer)
10934 "Return a buffer to be used for displaying the link target of internal links."
10935 (cond
10936 ((not org-display-internal-link-with-indirect-buffer)
10937 buffer)
10938 ((string-match "(Clone)$" (buffer-name buffer))
10939 (message "Buffer is already a clone, not making another one")
10940 ;; we also do not modify visibility in this case
10941 buffer)
10942 (t ; make a new indirect buffer for displaying the link
10943 (let* ((bn (buffer-name buffer))
10944 (ibn (concat bn "(Clone)"))
10945 (ib (or (get-buffer ibn) (make-indirect-buffer buffer ibn 'clone))))
10946 (with-current-buffer ib (org-overview))
10947 ib))))
10949 (defun org-do-occur (regexp &optional cleanup)
10950 "Call the Emacs command `occur'.
10951 If CLEANUP is non-nil, remove the printout of the regular expression
10952 in the *Occur* buffer. This is useful if the regex is long and not useful
10953 to read."
10954 (occur regexp)
10955 (when cleanup
10956 (let ((cwin (selected-window)) win beg end)
10957 (when (setq win (get-buffer-window "*Occur*"))
10958 (select-window win))
10959 (goto-char (point-min))
10960 (when (re-search-forward "match[a-z]+" nil t)
10961 (setq beg (match-end 0))
10962 (if (re-search-forward "^[ \t]*[0-9]+" nil t)
10963 (setq end (1- (match-beginning 0)))))
10964 (and beg end (let ((inhibit-read-only t)) (delete-region beg end)))
10965 (goto-char (point-min))
10966 (select-window cwin))))
10968 ;;; The mark ring for links jumps
10970 (defvar org-mark-ring nil
10971 "Mark ring for positions before jumps in Org-mode.")
10972 (defvar org-mark-ring-last-goto nil
10973 "Last position in the mark ring used to go back.")
10974 ;; Fill and close the ring
10975 (setq org-mark-ring nil org-mark-ring-last-goto nil) ;; in case file is reloaded
10976 (loop for i from 1 to org-mark-ring-length do
10977 (push (make-marker) org-mark-ring))
10978 (setcdr (nthcdr (1- org-mark-ring-length) org-mark-ring)
10979 org-mark-ring)
10981 (defun org-mark-ring-push (&optional pos buffer)
10982 "Put the current position or POS into the mark ring and rotate it."
10983 (interactive)
10984 (setq pos (or pos (point)))
10985 (setq org-mark-ring (nthcdr (1- org-mark-ring-length) org-mark-ring))
10986 (move-marker (car org-mark-ring)
10987 (or pos (point))
10988 (or buffer (current-buffer)))
10989 (message "%s"
10990 (substitute-command-keys
10991 "Position saved to mark ring, go back with \\[org-mark-ring-goto].")))
10993 (defun org-mark-ring-goto (&optional n)
10994 "Jump to the previous position in the mark ring.
10995 With prefix arg N, jump back that many stored positions. When
10996 called several times in succession, walk through the entire ring.
10997 Org-mode commands jumping to a different position in the current file,
10998 or to another Org-mode file, automatically push the old position
10999 onto the ring."
11000 (interactive "p")
11001 (let (p m)
11002 (if (eq last-command this-command)
11003 (setq p (nthcdr n (or org-mark-ring-last-goto org-mark-ring)))
11004 (setq p org-mark-ring))
11005 (setq org-mark-ring-last-goto p)
11006 (setq m (car p))
11007 (org-pop-to-buffer-same-window (marker-buffer m))
11008 (goto-char m)
11009 (if (or (outline-invisible-p) (org-invisible-p2)) (org-show-context 'mark-goto))))
11011 (defun org-remove-angle-brackets (s)
11012 (if (equal (substring s 0 1) "<") (setq s (substring s 1)))
11013 (if (equal (substring s -1) ">") (setq s (substring s 0 -1)))
11015 (defun org-add-angle-brackets (s)
11016 (if (equal (substring s 0 1) "<") nil (setq s (concat "<" s)))
11017 (if (equal (substring s -1) ">") nil (setq s (concat s ">")))
11019 (defun org-remove-double-quotes (s)
11020 (if (equal (substring s 0 1) "\"") (setq s (substring s 1)))
11021 (if (equal (substring s -1) "\"") (setq s (substring s 0 -1)))
11024 ;;; Following specific links
11026 (defun org-follow-timestamp-link ()
11027 "Open an agenda view for the time-stamp date/range at point."
11028 (cond
11029 ((org-at-date-range-p t)
11030 (let ((org-agenda-start-on-weekday)
11031 (t1 (match-string 1))
11032 (t2 (match-string 2)) tt1 tt2)
11033 (setq tt1 (time-to-days (org-time-string-to-time t1))
11034 tt2 (time-to-days (org-time-string-to-time t2)))
11035 (let ((org-agenda-buffer-tmp-name
11036 (format "*Org Agenda(a:%s)"
11037 (concat (substring t1 0 10) "--" (substring t2 0 10)))))
11038 (org-agenda-list nil tt1 (1+ (- tt2 tt1))))))
11039 ((org-at-timestamp-p t)
11040 (let ((org-agenda-buffer-tmp-name
11041 (format "*Org Agenda(a:%s)" (substring (match-string 1) 0 10))))
11042 (org-agenda-list nil (time-to-days (org-time-string-to-time
11043 (substring (match-string 1) 0 10)))
11044 1)))
11045 (t (error "This should not happen"))))
11048 ;;; Following file links
11049 (declare-function mailcap-parse-mailcaps "mailcap" (&optional path force))
11050 (declare-function mailcap-extension-to-mime "mailcap" (extn))
11051 (declare-function mailcap-mime-info
11052 "mailcap" (string &optional request no-decode))
11053 (defvar org-wait nil)
11054 (defun org-open-file (path &optional in-emacs line search)
11055 "Open the file at PATH.
11056 First, this expands any special file name abbreviations. Then the
11057 configuration variable `org-file-apps' is checked if it contains an
11058 entry for this file type, and if yes, the corresponding command is launched.
11060 If no application is found, Emacs simply visits the file.
11062 With optional prefix argument IN-EMACS, Emacs will visit the file.
11063 With a double \\[universal-argument] \\[universal-argument] \
11064 prefix arg, Org tries to avoid opening in Emacs
11065 and to use an external application to visit the file.
11067 Optional LINE specifies a line to go to, optional SEARCH a string
11068 to search for. If LINE or SEARCH is given, the file will be
11069 opened in Emacs, unless an entry from org-file-apps that makes
11070 use of groups in a regexp matches.
11072 If you want to change the way frames are used when following a
11073 link, please customize `org-link-frame-setup'.
11075 If the file does not exist, an error is thrown."
11076 (let* ((file (if (equal path "")
11077 buffer-file-name
11078 (substitute-in-file-name (expand-file-name path))))
11079 (file-apps (append org-file-apps (org-default-apps)))
11080 (apps (org-remove-if
11081 'org-file-apps-entry-match-against-dlink-p file-apps))
11082 (apps-dlink (org-remove-if-not
11083 'org-file-apps-entry-match-against-dlink-p file-apps))
11084 (remp (and (assq 'remote apps) (org-file-remote-p file)))
11085 (dirp (if remp nil (file-directory-p file)))
11086 (file (if (and dirp org-open-directory-means-index-dot-org)
11087 (concat (file-name-as-directory file) "index.org")
11088 file))
11089 (a-m-a-p (assq 'auto-mode apps))
11090 (dfile (downcase file))
11091 ;; reconstruct the original file: link from the PATH, LINE and SEARCH args
11092 (link (cond ((and (eq line nil)
11093 (eq search nil))
11094 file)
11095 (line
11096 (concat file "::" (number-to-string line)))
11097 (search
11098 (concat file "::" search))))
11099 (dlink (downcase link))
11100 (old-buffer (current-buffer))
11101 (old-pos (point))
11102 (old-mode major-mode)
11103 ext cmd link-match-data)
11104 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\.gz\\)$" dfile)
11105 (setq ext (match-string 1 dfile))
11106 (if (string-match "^.*\\.\\([a-zA-Z0-9]+\\)$" dfile)
11107 (setq ext (match-string 1 dfile))))
11108 (cond
11109 ((member in-emacs '((16) system))
11110 (setq cmd (cdr (assoc 'system apps))))
11111 (in-emacs (setq cmd 'emacs))
11113 (setq cmd (or (and remp (cdr (assoc 'remote apps)))
11114 (and dirp (cdr (assoc 'directory apps)))
11115 ; first, try matching against apps-dlink
11116 ; if we get a match here, store the match data for later
11117 (let ((match (assoc-default dlink apps-dlink
11118 'string-match)))
11119 (if match
11120 (progn (setq link-match-data (match-data))
11121 match)
11122 (progn (setq in-emacs (or in-emacs line search))
11123 nil))) ; if we have no match in apps-dlink,
11124 ; always open the file in emacs if line or search
11125 ; is given (for backwards compatibility)
11126 (assoc-default dfile (org-apps-regexp-alist apps a-m-a-p)
11127 'string-match)
11128 (cdr (assoc ext apps))
11129 (cdr (assoc t apps))))))
11130 (when (eq cmd 'system)
11131 (setq cmd (cdr (assoc 'system apps))))
11132 (when (eq cmd 'default)
11133 (setq cmd (cdr (assoc t apps))))
11134 (when (eq cmd 'mailcap)
11135 (require 'mailcap)
11136 (mailcap-parse-mailcaps)
11137 (let* ((mime-type (mailcap-extension-to-mime (or ext "")))
11138 (command (mailcap-mime-info mime-type)))
11139 (if (stringp command)
11140 (setq cmd command)
11141 (setq cmd 'emacs))))
11142 (if (and (not (eq cmd 'emacs)) ; Emacs has no problems with non-ex files
11143 (not (file-exists-p file))
11144 (not org-open-non-existing-files))
11145 (user-error "No such file: %s" file))
11146 (cond
11147 ((and (stringp cmd) (not (string-match "^\\s-*$" cmd)))
11148 ;; Remove quotes around the file name - we'll use shell-quote-argument.
11149 (while (string-match "['\"]%s['\"]" cmd)
11150 (setq cmd (replace-match "%s" t t cmd)))
11151 (while (string-match "%s" cmd)
11152 (setq cmd (replace-match
11153 (save-match-data
11154 (shell-quote-argument
11155 (convert-standard-filename file)))
11156 t t cmd)))
11158 ;; Replace "%1", "%2" etc. in command with group matches from regex
11159 (save-match-data
11160 (let ((match-index 1)
11161 (number-of-groups (- (/ (length link-match-data) 2) 1)))
11162 (set-match-data link-match-data)
11163 (while (<= match-index number-of-groups)
11164 (let ((regex (concat "%" (number-to-string match-index)))
11165 (replace-with (match-string match-index dlink)))
11166 (while (string-match regex cmd)
11167 (setq cmd (replace-match replace-with t t cmd))))
11168 (setq match-index (+ match-index 1)))))
11170 (save-window-excursion
11171 (message "Running %s...done" cmd)
11172 (start-process-shell-command cmd nil cmd)
11173 (and (boundp 'org-wait) (numberp org-wait) (sit-for org-wait))))
11174 ((or (stringp cmd)
11175 (eq cmd 'emacs))
11176 (funcall (cdr (assq 'file org-link-frame-setup)) file)
11177 (widen)
11178 (if line (progn (org-goto-line line)
11179 (if (derived-mode-p 'org-mode)
11180 (org-reveal)))
11181 (if search (org-link-search search))))
11182 ((consp cmd)
11183 (let ((file (convert-standard-filename file)))
11184 (save-match-data
11185 (set-match-data link-match-data)
11186 (eval cmd))))
11187 (t (funcall (cdr (assq 'file org-link-frame-setup)) file)))
11188 (and (derived-mode-p 'org-mode) (eq old-mode 'org-mode)
11189 (or (not (equal old-buffer (current-buffer)))
11190 (not (equal old-pos (point))))
11191 (org-mark-ring-push old-pos old-buffer))))
11193 (defun org-file-apps-entry-match-against-dlink-p (entry)
11194 "This function returns non-nil if `entry' uses a regular
11195 expression which should be matched against the whole link by
11196 org-open-file.
11198 It assumes that is the case when the entry uses a regular
11199 expression which has at least one grouping construct and the
11200 action is either a lisp form or a command string containing
11201 '%1', i.e. using at least one subexpression match as a
11202 parameter."
11203 (let ((selector (car entry))
11204 (action (cdr entry)))
11205 (if (stringp selector)
11206 (and (> (regexp-opt-depth selector) 0)
11207 (or (and (stringp action)
11208 (string-match "%[0-9]" action))
11209 (consp action)))
11210 nil)))
11212 (defun org-default-apps ()
11213 "Return the default applications for this operating system."
11214 (cond
11215 ((eq system-type 'darwin)
11216 org-file-apps-defaults-macosx)
11217 ((eq system-type 'windows-nt)
11218 org-file-apps-defaults-windowsnt)
11219 (t org-file-apps-defaults-gnu)))
11221 (defun org-apps-regexp-alist (list &optional add-auto-mode)
11222 "Convert extensions to regular expressions in the cars of LIST.
11223 Also, weed out any non-string entries, because the return value is used
11224 only for regexp matching.
11225 When ADD-AUTO-MODE is set, make all matches in `auto-mode-alist'
11226 point to the symbol `emacs', indicating that the file should
11227 be opened in Emacs."
11228 (append
11229 (delq nil
11230 (mapcar (lambda (x)
11231 (if (not (stringp (car x)))
11233 (if (string-match "\\W" (car x))
11235 (cons (concat "\\." (car x) "\\'") (cdr x)))))
11236 list))
11237 (if add-auto-mode
11238 (mapcar (lambda (x) (cons (car x) 'emacs)) auto-mode-alist))))
11240 (defvar ange-ftp-name-format) ; to silence the XEmacs compiler.
11241 (defun org-file-remote-p (file)
11242 "Test whether FILE specifies a location on a remote system.
11243 Return non-nil if the location is indeed remote.
11245 For example, the filename \"/user@host:/foo\" specifies a location
11246 on the system \"/user@host:\"."
11247 (cond ((fboundp 'file-remote-p)
11248 (file-remote-p file))
11249 ((fboundp 'tramp-handle-file-remote-p)
11250 (tramp-handle-file-remote-p file))
11251 ((and (boundp 'ange-ftp-name-format)
11252 (string-match (car ange-ftp-name-format) file))
11253 t)))
11256 ;;;; Refiling
11258 (defun org-get-org-file ()
11259 "Read a filename, with default directory `org-directory'."
11260 (let ((default (or org-default-notes-file remember-data-file)))
11261 (read-file-name (format "File name [%s]: " default)
11262 (file-name-as-directory org-directory)
11263 default)))
11265 (defun org-notes-order-reversed-p ()
11266 "Check if the current file should receive notes in reversed order."
11267 (cond
11268 ((not org-reverse-note-order) nil)
11269 ((eq t org-reverse-note-order) t)
11270 ((not (listp org-reverse-note-order)) nil)
11271 (t (catch 'exit
11272 (let ((all org-reverse-note-order)
11273 entry)
11274 (while (setq entry (pop all))
11275 (if (string-match (car entry) buffer-file-name)
11276 (throw 'exit (cdr entry))))
11277 nil)))))
11279 (defvar org-refile-target-table nil
11280 "The list of refile targets, created by `org-refile'.")
11282 (defvar org-agenda-new-buffers nil
11283 "Buffers created to visit agenda files.")
11285 (defvar org-refile-cache nil
11286 "Cache for refile targets.")
11288 (defvar org-refile-markers nil
11289 "All the markers used for caching refile locations.")
11291 (defun org-refile-marker (pos)
11292 "Get a new refile marker, but only if caching is in use."
11293 (if (not org-refile-use-cache)
11295 (let ((m (make-marker)))
11296 (move-marker m pos)
11297 (push m org-refile-markers)
11298 m)))
11300 (defun org-refile-cache-clear ()
11301 "Clear the refile cache and disable all the markers."
11302 (mapc (lambda (m) (move-marker m nil)) org-refile-markers)
11303 (setq org-refile-markers nil)
11304 (setq org-refile-cache nil)
11305 (message "Refile cache has been cleared"))
11307 (defun org-refile-cache-check-set (set)
11308 "Check if all the markers in the cache still have live buffers."
11309 (let (marker)
11310 (catch 'exit
11311 (while (and set (setq marker (nth 3 (pop set))))
11312 ;; If `org-refile-use-outline-path' is 'file, marker may be nil
11313 (when (and marker (null (marker-buffer marker)))
11314 (message "Please regenerate the refile cache with `C-0 C-c C-w'")
11315 (sit-for 3)
11316 (throw 'exit nil)))
11317 t)))
11319 (defun org-refile-cache-put (set &rest identifiers)
11320 "Push the refile targets SET into the cache, under IDENTIFIERS."
11321 (let* ((key (sha1 (prin1-to-string identifiers)))
11322 (entry (assoc key org-refile-cache)))
11323 (if entry
11324 (setcdr entry set)
11325 (push (cons key set) org-refile-cache))))
11327 (defun org-refile-cache-get (&rest identifiers)
11328 "Retrieve the cached value for refile targets given by IDENTIFIERS."
11329 (cond
11330 ((not org-refile-cache) nil)
11331 ((not org-refile-use-cache) (org-refile-cache-clear) nil)
11333 (let ((set (cdr (assoc (sha1 (prin1-to-string identifiers))
11334 org-refile-cache))))
11335 (and set (org-refile-cache-check-set set) set)))))
11337 (defun org-refile-get-targets (&optional default-buffer excluded-entries)
11338 "Produce a table with refile targets."
11339 (let ((case-fold-search nil)
11340 ;; otherwise org confuses "TODO" as a kw and "Todo" as a word
11341 (entries (or org-refile-targets '((nil . (:level . 1)))))
11342 targets tgs txt re files f desc descre fast-path-p level pos0)
11343 (message "Getting targets...")
11344 (with-current-buffer (or default-buffer (current-buffer))
11345 (while (setq entry (pop entries))
11346 (setq files (car entry) desc (cdr entry))
11347 (setq fast-path-p nil)
11348 (cond
11349 ((null files) (setq files (list (current-buffer))))
11350 ((eq files 'org-agenda-files)
11351 (setq files (org-agenda-files 'unrestricted)))
11352 ((and (symbolp files) (fboundp files))
11353 (setq files (funcall files)))
11354 ((and (symbolp files) (boundp files))
11355 (setq files (symbol-value files))))
11356 (if (stringp files) (setq files (list files)))
11357 (cond
11358 ((eq (car desc) :tag)
11359 (setq descre (concat "^\\*+[ \t]+.*?:" (regexp-quote (cdr desc)) ":")))
11360 ((eq (car desc) :todo)
11361 (setq descre (concat "^\\*+[ \t]+" (regexp-quote (cdr desc)) "[ \t]")))
11362 ((eq (car desc) :regexp)
11363 (setq descre (cdr desc)))
11364 ((eq (car desc) :level)
11365 (setq descre (concat "^\\*\\{" (number-to-string
11366 (if org-odd-levels-only
11367 (1- (* 2 (cdr desc)))
11368 (cdr desc)))
11369 "\\}[ \t]")))
11370 ((eq (car desc) :maxlevel)
11371 (setq fast-path-p t)
11372 (setq descre (concat "^\\*\\{1," (number-to-string
11373 (if org-odd-levels-only
11374 (1- (* 2 (cdr desc)))
11375 (cdr desc)))
11376 "\\}[ \t]")))
11377 (t (error "Bad refiling target description %s" desc)))
11378 (while (setq f (pop files))
11379 (with-current-buffer
11380 (if (bufferp f) f (org-get-agenda-file-buffer f))
11382 (setq tgs (org-refile-cache-get (buffer-file-name) descre))
11383 (progn
11384 (if (bufferp f) (setq f (buffer-file-name
11385 (buffer-base-buffer f))))
11386 (setq f (and f (expand-file-name f)))
11387 (if (eq org-refile-use-outline-path 'file)
11388 (push (list (file-name-nondirectory f) f nil nil) tgs))
11389 (save-excursion
11390 (save-restriction
11391 (widen)
11392 (goto-char (point-min))
11393 (while (re-search-forward descre nil t)
11394 (goto-char (setq pos0 (point-at-bol)))
11395 (catch 'next
11396 (when org-refile-target-verify-function
11397 (save-match-data
11398 (or (funcall org-refile-target-verify-function)
11399 (throw 'next t))))
11400 (when (and (looking-at org-complex-heading-regexp)
11401 (not (member (match-string 4) excluded-entries))
11402 (match-string 4))
11403 (setq level (org-reduced-level
11404 (- (match-end 1) (match-beginning 1)))
11405 txt (org-link-display-format (match-string 4))
11406 txt (replace-regexp-in-string "\\( *\[[0-9]+/?[0-9]*%?\]\\)+$" "" txt)
11407 re (format org-complex-heading-regexp-format
11408 (regexp-quote (match-string 4))))
11409 (when org-refile-use-outline-path
11410 (setq txt (mapconcat
11411 'org-protect-slash
11412 (append
11413 (if (eq org-refile-use-outline-path
11414 'file)
11415 (list (file-name-nondirectory
11416 (buffer-file-name
11417 (buffer-base-buffer))))
11418 (if (eq org-refile-use-outline-path
11419 'full-file-path)
11420 (list (buffer-file-name
11421 (buffer-base-buffer)))))
11422 (org-get-outline-path fast-path-p
11423 level txt)
11424 (list txt))
11425 "/")))
11426 (push (list txt f re (org-refile-marker (point)))
11427 tgs)))
11428 (when (= (point) pos0)
11429 ;; verification function has not moved point
11430 (goto-char (point-at-eol))))))))
11431 (when org-refile-use-cache
11432 (org-refile-cache-put tgs (buffer-file-name) descre))
11433 (setq targets (append tgs targets))))))
11434 (message "Getting targets...done")
11435 (nreverse targets)))
11437 (defun org-protect-slash (s)
11438 (while (string-match "/" s)
11439 (setq s (replace-match "\\" t t s)))
11442 (defvar org-olpa (make-vector 20 nil))
11444 (defun org-get-outline-path (&optional fastp level heading)
11445 "Return the outline path to the current entry, as a list.
11447 The parameters FASTP, LEVEL, and HEADING are for use by a scanner
11448 routine which makes outline path derivations for an entire file,
11449 avoiding backtracing. Refile target collection makes use of that."
11450 (if fastp
11451 (progn
11452 (if (> level 19)
11453 (error "Outline path failure, more than 19 levels"))
11454 (loop for i from level upto 19 do
11455 (aset org-olpa i nil))
11456 (prog1
11457 (delq nil (append org-olpa nil))
11458 (aset org-olpa level heading)))
11459 (let (rtn case-fold-search)
11460 (save-excursion
11461 (save-restriction
11462 (widen)
11463 (while (org-up-heading-safe)
11464 (when (looking-at org-complex-heading-regexp)
11465 (push (org-trim
11466 (replace-regexp-in-string
11467 ;; Remove statistical/checkboxes cookies
11468 "\\[[0-9]+%\\]\\|\\[[0-9]+/[0-9]+\\]" ""
11469 (org-match-string-no-properties 4)))
11470 rtn)))
11471 rtn)))))
11473 (defun org-format-outline-path (path &optional width prefix separator)
11474 "Format the outline path PATH for display.
11475 WIDTH is the maximum number of characters that is available.
11476 PREFIX is a prefix to be included in the returned string,
11477 such as the file name.
11478 SEPARATOR is inserted between the different parts of the path,
11479 the default is \"/\"."
11480 (setq width (or width 79))
11481 (if prefix (setq width (- width (length prefix))))
11482 (if (not path)
11483 (or prefix "")
11484 (let* ((nsteps (length path))
11485 (total-width (+ nsteps (apply '+ (mapcar 'length path))))
11486 (maxwidth (if (<= total-width width)
11487 10000 ;; everything fits
11488 ;; we need to shorten the level headings
11489 (/ (- width nsteps) nsteps)))
11490 (org-odd-levels-only nil)
11491 (n 0)
11492 (total (1+ (length prefix))))
11493 (setq maxwidth (max maxwidth 10))
11494 (concat prefix
11495 (if prefix (or separator "/"))
11496 (mapconcat
11497 (lambda (h)
11498 (setq n (1+ n))
11499 (if (and (= n nsteps) (< maxwidth 10000))
11500 (setq maxwidth (- total-width total)))
11501 (if (< (length h) maxwidth)
11502 (progn (setq total (+ total (length h) 1)) h)
11503 (setq h (substring h 0 (- maxwidth 2))
11504 total (+ total maxwidth 1))
11505 (if (string-match "[ \t]+\\'" h)
11506 (setq h (substring h 0 (match-beginning 0))))
11507 (setq h (concat h "..")))
11508 (org-add-props h nil 'face
11509 (nth (% (1- n) org-n-level-faces)
11510 org-level-faces))
11512 path (or separator "/"))))))
11514 (defun org-display-outline-path (&optional file current separator just-return-string)
11515 "Display the current outline path in the echo area.
11517 If FILE is non-nil, prepend the output with the file name.
11518 If CURRENT is non-nil, append the current heading to the output.
11519 SEPARATOR is passed through to `org-format-outline-path'. It separates
11520 the different parts of the path and defaults to \"/\".
11521 If JUST-RETURN-STRING is non-nil, return a string, don't display a message."
11522 (interactive "P")
11523 (let* (case-fold-search
11524 (bfn (buffer-file-name (buffer-base-buffer)))
11525 (path (and (derived-mode-p 'org-mode) (org-get-outline-path)))
11526 res)
11527 (if current (setq path (append path
11528 (save-excursion
11529 (org-back-to-heading t)
11530 (if (looking-at org-complex-heading-regexp)
11531 (list (match-string 4)))))))
11532 (setq res
11533 (org-format-outline-path
11534 path
11535 (1- (frame-width))
11536 (and file bfn (concat (file-name-nondirectory bfn) separator))
11537 separator))
11538 (if just-return-string
11539 (org-no-properties res)
11540 (org-unlogged-message "%s" res))))
11542 (defvar org-refile-history nil
11543 "History for refiling operations.")
11545 (defvar org-after-refile-insert-hook nil
11546 "Hook run after `org-refile' has inserted its stuff at the new location.
11547 Note that this is still *before* the stuff will be removed from
11548 the *old* location.")
11550 (defvar org-capture-last-stored-marker)
11551 (defvar org-refile-keep nil
11552 "Non-nil means `org-refile' will copy instead of refile.")
11554 (defun org-copy ()
11555 "Like `org-refile', but copy."
11556 (interactive)
11557 (let ((org-refile-keep t))
11558 (funcall 'org-refile nil nil nil "Copy")))
11560 (defun org-refile (&optional goto default-buffer rfloc msg)
11561 "Move the entry or entries at point to another heading.
11562 The list of target headings is compiled using the information in
11563 `org-refile-targets', which see.
11565 At the target location, the entry is filed as a subitem of the target
11566 heading. Depending on `org-reverse-note-order', the new subitem will
11567 either be the first or the last subitem.
11569 If there is an active region, all entries in that region will be moved.
11570 However, the region must fulfill the requirement that the first heading
11571 is the first one sets the top-level of the moved text - at most siblings
11572 below it are allowed.
11574 With prefix arg GOTO, the command will only visit the target location
11575 and not actually move anything.
11577 With a double prefix arg \\[universal-argument] \\[universal-argument], \
11578 go to the location where the last refiling operation has put the subtree.
11580 With a numeric prefix argument of `2', refile to the running clock.
11582 With a numeric prefix argument of `3', emulate `org-refile-keep'
11583 being set to `t' and copy to the target location, don't move it.
11584 Beware that keeping refiled entries may result in duplicated ID
11585 properties.
11587 RFLOC can be a refile location obtained in a different way.
11589 MSG is a string to replace \"Refile\" in the default prompt with
11590 another verb. E.g. `org-copy' sets this parameter to \"Copy\".
11592 See also `org-refile-use-outline-path' and `org-completion-use-ido'.
11594 If you are using target caching (see `org-refile-use-cache'),
11595 you have to clear the target cache in order to find new targets.
11596 This can be done with a 0 prefix (`C-0 C-c C-w') or a triple
11597 prefix argument (`C-u C-u C-u C-c C-w')."
11599 (interactive "P")
11600 (if (member goto '(0 (64)))
11601 (org-refile-cache-clear)
11602 (let* ((actionmsg (or msg "Refile"))
11603 (cbuf (current-buffer))
11604 (regionp (org-region-active-p))
11605 (region-start (and regionp (region-beginning)))
11606 (region-end (and regionp (region-end)))
11607 (filename (buffer-file-name (buffer-base-buffer cbuf)))
11608 (org-refile-keep (if (equal goto 3) t org-refile-keep))
11609 pos it nbuf file re level reversed)
11610 (setq last-command nil)
11611 (when regionp
11612 (goto-char region-start)
11613 (or (bolp) (goto-char (point-at-bol)))
11614 (setq region-start (point))
11615 (unless (or (org-kill-is-subtree-p
11616 (buffer-substring region-start region-end))
11617 (prog1 org-refile-active-region-within-subtree
11618 (let ((s (point-at-eol)))
11619 (org-toggle-heading)
11620 (setq region-end (+ (- (point-at-eol) s) region-end)))))
11621 (user-error "The region is not a (sequence of) subtree(s)")))
11622 (if (equal goto '(16))
11623 (org-refile-goto-last-stored)
11624 (when (or
11625 (and (equal goto 2)
11626 org-clock-hd-marker (marker-buffer org-clock-hd-marker)
11627 (prog1
11628 (setq it (list (or org-clock-heading "running clock")
11629 (buffer-file-name
11630 (marker-buffer org-clock-hd-marker))
11632 (marker-position org-clock-hd-marker)))
11633 (setq goto nil)))
11634 (setq it (or rfloc
11635 (let (heading-text)
11636 (save-excursion
11637 (unless goto
11638 (org-back-to-heading t)
11639 (setq heading-text
11640 (nth 4 (org-heading-components))))
11642 (org-refile-get-location
11643 (cond (goto "Goto")
11644 (regionp (concat actionmsg " region to"))
11645 (t (concat actionmsg " subtree \""
11646 heading-text "\" to")))
11647 default-buffer
11648 (and (not (equal '(4) goto))
11649 org-refile-allow-creating-parent-nodes)
11650 goto))))))
11651 (setq file (nth 1 it)
11652 re (nth 2 it)
11653 pos (nth 3 it))
11654 (if (and (not goto)
11656 (equal (buffer-file-name) file)
11657 (if regionp
11658 (and (>= pos region-start)
11659 (<= pos region-end))
11660 (and (>= pos (point))
11661 (< pos (save-excursion
11662 (org-end-of-subtree t t))))))
11663 (error "Cannot refile to position inside the tree or region"))
11665 (setq nbuf (or (find-buffer-visiting file)
11666 (find-file-noselect file)))
11667 (if (and goto (not (equal goto 3)))
11668 (progn
11669 (org-pop-to-buffer-same-window nbuf)
11670 (goto-char pos)
11671 (org-show-context 'org-goto))
11672 (if regionp
11673 (progn
11674 (org-kill-new (buffer-substring region-start region-end))
11675 (org-save-markers-in-region region-start region-end))
11676 (org-copy-subtree 1 nil t))
11677 (with-current-buffer (setq nbuf (or (find-buffer-visiting file)
11678 (find-file-noselect file)))
11679 (setq reversed (org-notes-order-reversed-p))
11680 (save-excursion
11681 (save-restriction
11682 (widen)
11683 (if pos
11684 (progn
11685 (goto-char pos)
11686 (looking-at org-outline-regexp)
11687 (setq level (org-get-valid-level (funcall outline-level) 1))
11688 (goto-char
11689 (if reversed
11690 (or (outline-next-heading) (point-max))
11691 (or (save-excursion (org-get-next-sibling))
11692 (org-end-of-subtree t t)
11693 (point-max)))))
11694 (setq level 1)
11695 (if (not reversed)
11696 (goto-char (point-max))
11697 (goto-char (point-min))
11698 (or (outline-next-heading) (goto-char (point-max)))))
11699 (if (not (bolp)) (newline))
11700 (org-paste-subtree level)
11701 (when org-log-refile
11702 (org-add-log-setup 'refile nil nil 'findpos org-log-refile)
11703 (unless (eq org-log-refile 'note)
11704 (save-excursion (org-add-log-note))))
11705 (and org-auto-align-tags
11706 (let ((org-loop-over-headlines-in-active-region nil))
11707 (org-set-tags nil t)))
11708 (let ((bookmark-name (plist-get org-bookmark-names-plist
11709 :last-refile)))
11710 (when bookmark-name
11711 (with-demoted-errors
11712 (bookmark-set bookmark-name))))
11713 ;; If we are refiling for capture, make sure that the
11714 ;; last-capture pointers point here
11715 (when (org-bound-and-true-p org-refile-for-capture)
11716 (let ((bookmark-name (plist-get org-bookmark-names-plist
11717 :last-capture-marker)))
11718 (when bookmark-name
11719 (with-demoted-errors
11720 (bookmark-set bookmark-name))))
11721 (move-marker org-capture-last-stored-marker (point)))
11722 (if (fboundp 'deactivate-mark) (deactivate-mark))
11723 (run-hooks 'org-after-refile-insert-hook))))
11724 (unless org-refile-keep
11725 (if regionp
11726 (delete-region (point) (+ (point) (- region-end region-start)))
11727 (delete-region
11728 (and (org-back-to-heading t) (point))
11729 (min (1+ (buffer-size)) (org-end-of-subtree t t) (point)))))
11730 (when (featurep 'org-inlinetask)
11731 (org-inlinetask-remove-END-maybe))
11732 (setq org-markers-to-move nil)
11733 (message (concat actionmsg " to \"%s\" in file %s: done") (car it) file)))))))
11735 (defun org-refile-goto-last-stored ()
11736 "Go to the location where the last refile was stored."
11737 (interactive)
11738 (bookmark-jump "org-refile-last-stored")
11739 (message "This is the location of the last refile"))
11741 (defun org-refile--get-location (refloc tbl)
11742 "When user refile to REFLOC, find the associated target in TBL.
11743 Also check `org-refile-target-table'."
11744 (car (delq
11746 (mapcar
11747 (lambda (r) (or (assoc r tbl)
11748 (assoc r org-refile-target-table)))
11749 (list (replace-regexp-in-string "/$" "" refloc)
11750 (replace-regexp-in-string "\\([^/]\\)$" "\\1/" refloc))))))
11752 (defun org-refile-get-location (&optional prompt default-buffer new-nodes
11753 no-exclude)
11754 "Prompt the user for a refile location, using PROMPT.
11755 PROMPT should not be suffixed with a colon and a space, because
11756 this function appends the default value from
11757 `org-refile-history' automatically, if that is not empty.
11758 When NO-EXCLUDE is set, do not exclude headlines in the current subtree,
11759 this is used for the GOTO interface."
11760 (let ((org-refile-targets org-refile-targets)
11761 (org-refile-use-outline-path org-refile-use-outline-path)
11762 excluded-entries)
11763 (when (and (derived-mode-p 'org-mode)
11764 (not org-refile-use-cache)
11765 (not no-exclude))
11766 (org-map-tree
11767 (lambda()
11768 (setq excluded-entries
11769 (append excluded-entries (list (org-get-heading t t)))))))
11770 (setq org-refile-target-table
11771 (org-refile-get-targets default-buffer excluded-entries)))
11772 (unless org-refile-target-table
11773 (user-error "No refile targets"))
11774 (let* ((cbuf (current-buffer))
11775 (partial-completion-mode nil)
11776 (cfn (buffer-file-name (buffer-base-buffer cbuf)))
11777 (cfunc (if (and org-refile-use-outline-path
11778 org-outline-path-complete-in-steps)
11779 'org-olpath-completing-read
11780 'org-icompleting-read))
11781 (extra (if org-refile-use-outline-path "/" ""))
11782 (cbnex (concat (buffer-name) extra))
11783 (filename (and cfn (expand-file-name cfn)))
11784 (tbl (mapcar
11785 (lambda (x)
11786 (if (and (not (member org-refile-use-outline-path
11787 '(file full-file-path)))
11788 (not (equal filename (nth 1 x))))
11789 (cons (concat (car x) extra " ("
11790 (file-name-nondirectory (nth 1 x)) ")")
11791 (cdr x))
11792 (cons (concat (car x) extra) (cdr x))))
11793 org-refile-target-table))
11794 (completion-ignore-case t)
11795 cdef
11796 (prompt (concat prompt
11797 (or (and (car org-refile-history)
11798 (concat " (default " (car org-refile-history) ")"))
11799 (and (assoc cbnex tbl) (setq cdef cbnex)
11800 (concat " (default " cbnex ")"))) ": "))
11801 pa answ parent-target child parent old-hist)
11802 (setq old-hist org-refile-history)
11803 (setq answ (funcall cfunc prompt tbl nil (not new-nodes)
11804 nil 'org-refile-history (or cdef (car org-refile-history))))
11805 (if (setq pa (org-refile--get-location answ tbl))
11806 (progn
11807 (org-refile-check-position pa)
11808 (when (or (not org-refile-history)
11809 (not (eq old-hist org-refile-history))
11810 (not (equal (car pa) (car org-refile-history))))
11811 (setq org-refile-history
11812 (cons (car pa) (if (assoc (car org-refile-history) tbl)
11813 org-refile-history
11814 (cdr org-refile-history))))
11815 (if (equal (car org-refile-history) (nth 1 org-refile-history))
11816 (pop org-refile-history)))
11818 (if (string-match "\\`\\(.*\\)/\\([^/]+\\)\\'" answ)
11819 (progn
11820 (setq parent (match-string 1 answ)
11821 child (match-string 2 answ))
11822 (setq parent-target (org-refile--get-location parent tbl))
11823 (when (and parent-target
11824 (or (eq new-nodes t)
11825 (and (eq new-nodes 'confirm)
11826 (y-or-n-p (format "Create new node \"%s\"? "
11827 child)))))
11828 (org-refile-new-child parent-target child)))
11829 (user-error "Invalid target location")))))
11831 (declare-function org-string-nw-p "org-macs" (s))
11832 (defun org-refile-check-position (refile-pointer)
11833 "Check if the refile pointer matches the headline to which it points."
11834 (let* ((file (nth 1 refile-pointer))
11835 (re (nth 2 refile-pointer))
11836 (pos (nth 3 refile-pointer))
11837 buffer)
11838 (if (and (not (markerp pos)) (not file))
11839 (if file
11840 (user-error "Please save the buffer to a file before refiling")
11841 (user-error "Please indicate a target file in the refile path"))
11842 (when (org-string-nw-p re)
11843 (setq buffer (if (markerp pos)
11844 (marker-buffer pos)
11845 (or (find-buffer-visiting file)
11846 (find-file-noselect file))))
11847 (with-current-buffer buffer
11848 (save-excursion
11849 (save-restriction
11850 (widen)
11851 (goto-char pos)
11852 (beginning-of-line 1)
11853 (unless (org-looking-at-p re)
11854 (user-error "Invalid refile position, please clear the cache with `C-0 C-c C-w' before refiling")))))))))
11856 (defun org-refile-new-child (parent-target child)
11857 "Use refile target PARENT-TARGET to add new CHILD below it."
11858 (unless parent-target
11859 (error "Cannot find parent for new node"))
11860 (let ((file (nth 1 parent-target))
11861 (pos (nth 3 parent-target))
11862 level)
11863 (with-current-buffer (or (find-buffer-visiting file)
11864 (find-file-noselect file))
11865 (save-excursion
11866 (save-restriction
11867 (widen)
11868 (if pos
11869 (goto-char pos)
11870 (goto-char (point-max))
11871 (if (not (bolp)) (newline)))
11872 (when (looking-at org-outline-regexp)
11873 (setq level (funcall outline-level))
11874 (org-end-of-subtree t t))
11875 (org-back-over-empty-lines)
11876 (insert "\n" (make-string
11877 (if pos (org-get-valid-level level 1) 1) ?*)
11878 " " child "\n")
11879 (beginning-of-line 0)
11880 (list (concat (car parent-target) "/" child) file "" (point)))))))
11882 (defun org-olpath-completing-read (prompt collection &rest args)
11883 "Read an outline path like a file name."
11884 (let ((thetable collection)
11885 (org-completion-use-ido nil) ; does not work with ido.
11886 (org-completion-use-iswitchb nil)) ; or iswitchb
11887 (apply
11888 'org-icompleting-read prompt
11889 (lambda (string predicate &optional flag)
11890 (let (rtn r f (l (length string)))
11891 (cond
11892 ((eq flag nil)
11893 ;; try completion
11894 (try-completion string thetable))
11895 ((eq flag t)
11896 ;; all-completions
11897 (setq rtn (all-completions string thetable predicate))
11898 (mapcar
11899 (lambda (x)
11900 (setq r (substring x l))
11901 (if (string-match " ([^)]*)$" x)
11902 (setq f (match-string 0 x))
11903 (setq f ""))
11904 (if (string-match "/" r)
11905 (concat string (substring r 0 (match-end 0)) f)
11907 rtn))
11908 ((eq flag 'lambda)
11909 ;; exact match?
11910 (assoc string thetable)))))
11911 args)))
11913 ;;;; Dynamic blocks
11915 (defun org-find-dblock (name)
11916 "Find the first dynamic block with name NAME in the buffer.
11917 If not found, stay at current position and return nil."
11918 (let ((case-fold-search t) pos)
11919 (save-excursion
11920 (goto-char (point-min))
11921 (setq pos (and (re-search-forward
11922 (concat "^[ \t]*#\\+\\(?:BEGIN\\|begin\\):[ \t]+" name "\\>") nil t)
11923 (match-beginning 0))))
11924 (if pos (goto-char pos))
11925 pos))
11927 (defun org-create-dblock (plist)
11928 "Create a dynamic block section, with parameters taken from PLIST.
11929 PLIST must contain a :name entry which is used as name of the block."
11930 (when (string-match "\\S-" (buffer-substring (point-at-bol) (point-at-eol)))
11931 (end-of-line 1)
11932 (newline))
11933 (let ((col (current-column))
11934 (name (plist-get plist :name)))
11935 (insert "#+BEGIN: " name)
11936 (while plist
11937 (if (eq (car plist) :name)
11938 (setq plist (cddr plist))
11939 (insert " " (prin1-to-string (pop plist)))))
11940 (insert "\n\n" (make-string col ?\ ) "#+END:\n")
11941 (beginning-of-line -2)))
11943 (defun org-prepare-dblock ()
11944 "Prepare dynamic block for refresh.
11945 This empties the block, puts the cursor at the insert position and returns
11946 the property list including an extra property :name with the block name."
11947 (unless (looking-at org-dblock-start-re)
11948 (user-error "Not at a dynamic block"))
11949 (let* ((begdel (1+ (match-end 0)))
11950 (name (org-no-properties (match-string 1)))
11951 (params (append (list :name name)
11952 (read (concat "(" (match-string 3) ")")))))
11953 (save-excursion
11954 (beginning-of-line 1)
11955 (skip-chars-forward " \t")
11956 (setq params (plist-put params :indentation-column (current-column))))
11957 (unless (re-search-forward org-dblock-end-re nil t)
11958 (error "Dynamic block not terminated"))
11959 (setq params
11960 (append params
11961 (list :content (buffer-substring
11962 begdel (match-beginning 0)))))
11963 (delete-region begdel (match-beginning 0))
11964 (goto-char begdel)
11965 (open-line 1)
11966 params))
11968 (defun org-map-dblocks (&optional command)
11969 "Apply COMMAND to all dynamic blocks in the current buffer.
11970 If COMMAND is not given, use `org-update-dblock'."
11971 (let ((cmd (or command 'org-update-dblock)))
11972 (save-excursion
11973 (goto-char (point-min))
11974 (while (re-search-forward org-dblock-start-re nil t)
11975 (goto-char (match-beginning 0))
11976 (save-excursion
11977 (condition-case nil
11978 (funcall cmd)
11979 (error (message "Error during update of dynamic block"))))
11980 (unless (re-search-forward org-dblock-end-re nil t)
11981 (error "Dynamic block not terminated"))))))
11983 (defun org-dblock-update (&optional arg)
11984 "User command for updating dynamic blocks.
11985 Update the dynamic block at point. With prefix ARG, update all dynamic
11986 blocks in the buffer."
11987 (interactive "P")
11988 (if arg
11989 (org-update-all-dblocks)
11990 (or (looking-at org-dblock-start-re)
11991 (org-beginning-of-dblock))
11992 (org-update-dblock)))
11994 (defun org-update-dblock ()
11995 "Update the dynamic block at point.
11996 This means to empty the block, parse for parameters and then call
11997 the correct writing function."
11998 (interactive)
11999 (save-window-excursion
12000 (let* ((pos (point))
12001 (line (org-current-line))
12002 (params (org-prepare-dblock))
12003 (name (plist-get params :name))
12004 (indent (plist-get params :indentation-column))
12005 (cmd (intern (concat "org-dblock-write:" name))))
12006 (message "Updating dynamic block `%s' at line %d..." name line)
12007 (funcall cmd params)
12008 (message "Updating dynamic block `%s' at line %d...done" name line)
12009 (goto-char pos)
12010 (when (and indent (> indent 0))
12011 (setq indent (make-string indent ?\ ))
12012 (save-excursion
12013 (org-beginning-of-dblock)
12014 (forward-line 1)
12015 (while (not (looking-at org-dblock-end-re))
12016 (insert indent)
12017 (beginning-of-line 2))
12018 (when (looking-at org-dblock-end-re)
12019 (and (looking-at "[ \t]+")
12020 (replace-match ""))
12021 (insert indent)))))))
12023 (defun org-beginning-of-dblock ()
12024 "Find the beginning of the dynamic block at point.
12025 Error if there is no such block at point."
12026 (let ((pos (point))
12027 beg)
12028 (end-of-line 1)
12029 (if (and (re-search-backward org-dblock-start-re nil t)
12030 (setq beg (match-beginning 0))
12031 (re-search-forward org-dblock-end-re nil t)
12032 (> (match-end 0) pos))
12033 (goto-char beg)
12034 (goto-char pos)
12035 (error "Not in a dynamic block"))))
12037 (defun org-update-all-dblocks ()
12038 "Update all dynamic blocks in the buffer.
12039 This function can be used in a hook."
12040 (interactive)
12041 (when (derived-mode-p 'org-mode)
12042 (org-map-dblocks 'org-update-dblock)))
12045 ;;;; Completion
12047 (declare-function org-export-backend-name "org-export" (cl-x))
12048 (declare-function org-export-backend-options "org-export" (cl-x))
12049 (defun org-get-export-keywords ()
12050 "Return a list of all currently understood export keywords.
12051 Export keywords include options, block names, attributes and
12052 keywords relative to each registered export back-end."
12053 (let (keywords)
12054 (dolist (backend
12055 (org-bound-and-true-p org-export--registered-backends)
12056 (delq nil keywords))
12057 ;; Back-end name (for keywords, like #+LATEX:)
12058 (push (upcase (symbol-name (org-export-backend-name backend))) keywords)
12059 (dolist (option-entry (org-export-backend-options backend))
12060 ;; Back-end options.
12061 (push (nth 1 option-entry) keywords)))))
12063 (defconst org-options-keywords
12064 '("ARCHIVE:" "AUTHOR:" "BIND:" "CATEGORY:" "COLUMNS:" "CREATOR:" "DATE:"
12065 "DESCRIPTION:" "DRAWERS:" "EMAIL:" "EXCLUDE_TAGS:" "FILETAGS:" "INCLUDE:"
12066 "INDEX:" "KEYWORDS:" "LANGUAGE:" "MACRO:" "OPTIONS:" "PROPERTY:"
12067 "PRIORITIES:" "SELECT_TAGS:" "SEQ_TODO:" "SETUPFILE:" "STARTUP:" "TAGS:"
12068 "TITLE:" "TODO:" "TYP_TODO:" "SELECT_TAGS:" "EXCLUDE_TAGS:"))
12070 (defcustom org-structure-template-alist
12071 '(("s" "#+BEGIN_SRC ?\n\n#+END_SRC" "<src lang=\"?\">\n\n</src>")
12072 ("e" "#+BEGIN_EXAMPLE\n?\n#+END_EXAMPLE" "<example>\n?\n</example>")
12073 ("q" "#+BEGIN_QUOTE\n?\n#+END_QUOTE" "<quote>\n?\n</quote>")
12074 ("v" "#+BEGIN_VERSE\n?\n#+END_VERSE" "<verse>\n?\n</verse>")
12075 ("V" "#+BEGIN_VERBATIM\n?\n#+END_VERBATIM" "<verbatim>\n?\n</verbatim>")
12076 ("c" "#+BEGIN_CENTER\n?\n#+END_CENTER" "<center>\n?\n</center>")
12077 ("l" "#+BEGIN_LaTeX\n?\n#+END_LaTeX"
12078 "<literal style=\"latex\">\n?\n</literal>")
12079 ("L" "#+LaTeX: " "<literal style=\"latex\">?</literal>")
12080 ("h" "#+BEGIN_HTML\n?\n#+END_HTML"
12081 "<literal style=\"html\">\n?\n</literal>")
12082 ("H" "#+HTML: " "<literal style=\"html\">?</literal>")
12083 ("a" "#+BEGIN_ASCII\n?\n#+END_ASCII" "")
12084 ("A" "#+ASCII: " "")
12085 ("i" "#+INDEX: ?" "#+INDEX: ?")
12086 ("I" "#+INCLUDE: %file ?"
12087 "<include file=%file markup=\"?\">"))
12088 "Structure completion elements.
12089 This is a list of abbreviation keys and values. The value gets inserted
12090 if you type `<' followed by the key and then press the completion key,
12091 usually `M-TAB'. %file will be replaced by a file name after prompting
12092 for the file using completion. The cursor will be placed at the position
12093 of the `?` in the template.
12094 There are two templates for each key, the first uses the original Org syntax,
12095 the second uses Emacs Muse-like syntax tags. These Muse-like tags become
12096 the default when the /org-mtags.el/ module has been loaded. See also the
12097 variable `org-mtags-prefer-muse-templates'."
12098 :group 'org-completion
12099 :type '(repeat
12100 (list
12101 (string :tag "Key")
12102 (string :tag "Template")
12103 (string :tag "Muse Template"))))
12105 (defun org-try-structure-completion ()
12106 "Try to complete a structure template before point.
12107 This looks for strings like \"<e\" on an otherwise empty line and
12108 expands them."
12109 (let ((l (buffer-substring (point-at-bol) (point)))
12111 (when (and (looking-at "[ \t]*$")
12112 (string-match "^[ \t]*<\\([a-zA-Z]+\\)$" l)
12113 (setq a (assoc (match-string 1 l) org-structure-template-alist)))
12114 (org-complete-expand-structure-template (+ -1 (point-at-bol)
12115 (match-beginning 1)) a)
12116 t)))
12118 (defun org-complete-expand-structure-template (start cell)
12119 "Expand a structure template."
12120 (let* ((musep (org-bound-and-true-p org-mtags-prefer-muse-templates))
12121 (rpl (nth (if musep 2 1) cell))
12122 (ind ""))
12123 (delete-region start (point))
12124 (when (string-match "\\`#\\+" rpl)
12125 (cond
12126 ((bolp))
12127 ((not (string-match "\\S-" (buffer-substring (point-at-bol) (point))))
12128 (setq ind (buffer-substring (point-at-bol) (point))))
12129 (t (newline))))
12130 (setq start (point))
12131 (if (string-match "%file" rpl)
12132 (setq rpl (replace-match
12133 (concat
12134 "\""
12135 (save-match-data
12136 (abbreviate-file-name (read-file-name "Include file: ")))
12137 "\"")
12138 t t rpl)))
12139 (setq rpl (mapconcat 'identity (split-string rpl "\n")
12140 (concat "\n" ind)))
12141 (insert rpl)
12142 (if (re-search-backward "\\?" start t) (delete-char 1))))
12144 ;;;; TODO, DEADLINE, Comments
12146 (defun org-toggle-comment ()
12147 "Change the COMMENT state of an entry."
12148 (interactive)
12149 (save-excursion
12150 (org-back-to-heading)
12151 (let (case-fold-search)
12152 (cond
12153 ((looking-at (format org-heading-keyword-regexp-format
12154 org-comment-string))
12155 (goto-char (match-end 1))
12156 (looking-at (concat " +" org-comment-string))
12157 (replace-match "" t t)
12158 (when (eolp) (insert " ")))
12159 ((looking-at org-outline-regexp)
12160 (goto-char (match-end 0))
12161 (insert org-comment-string " "))))))
12163 (defvar org-last-todo-state-is-todo nil
12164 "This is non-nil when the last TODO state change led to a TODO state.
12165 If the last change removed the TODO tag or switched to DONE, then
12166 this is nil.")
12168 (defvar org-setting-tags nil) ; dynamically skipped
12170 (defvar org-todo-setup-filter-hook nil
12171 "Hook for functions that pre-filter todo specs.
12172 Each function takes a todo spec and returns either nil or the spec
12173 transformed into canonical form." )
12175 (defvar org-todo-get-default-hook nil
12176 "Hook for functions that get a default item for todo.
12177 Each function takes arguments (NEW-MARK OLD-MARK) and returns either
12178 nil or a string to be used for the todo mark." )
12180 (defvar org-agenda-headline-snapshot-before-repeat)
12182 (defun org-current-effective-time ()
12183 "Return current time adjusted for `org-extend-today-until' variable."
12184 (let* ((ct (org-current-time))
12185 (dct (decode-time ct))
12186 (ct1
12187 (cond
12188 (org-use-last-clock-out-time-as-effective-time
12189 (or (org-clock-get-last-clock-out-time) ct))
12190 ((and org-use-effective-time (< (nth 2 dct) org-extend-today-until))
12191 (encode-time 0 59 23 (1- (nth 3 dct)) (nth 4 dct) (nth 5 dct)))
12192 (t ct))))
12193 ct1))
12195 (defun org-todo-yesterday (&optional arg)
12196 "Like `org-todo' but the time of change will be 23:59 of yesterday."
12197 (interactive "P")
12198 (if (eq major-mode 'org-agenda-mode)
12199 (apply 'org-agenda-todo-yesterday arg)
12200 (let* ((hour (third (decode-time
12201 (org-current-time))))
12202 (org-extend-today-until (1+ hour)))
12203 (org-todo arg))))
12205 (defvar org-block-entry-blocking ""
12206 "First entry preventing the TODO state change.")
12208 (defun org-cancel-repeater ()
12209 "Cancel a repeater by setting its numeric value to zero."
12210 (interactive)
12211 (save-excursion
12212 (org-back-to-heading t)
12213 (let ((bound1 (point))
12214 (bound0 (save-excursion (outline-next-heading) (point))))
12215 (when (re-search-forward
12216 (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12217 org-deadline-time-regexp "\\)\\|\\("
12218 org-ts-regexp "\\)")
12219 bound0 t)
12220 (if (re-search-backward "[ \t]+\\(?:[.+]\\)?\\+\\([0-9]+\\)[hdwmy]" bound1 t)
12221 (replace-match "0" t nil nil 1))))))
12223 (defun org-todo (&optional arg)
12224 "Change the TODO state of an item.
12225 The state of an item is given by a keyword at the start of the heading,
12226 like
12227 *** TODO Write paper
12228 *** DONE Call mom
12230 The different keywords are specified in the variable `org-todo-keywords'.
12231 By default the available states are \"TODO\" and \"DONE\".
12232 So for this example: when the item starts with TODO, it is changed to DONE.
12233 When it starts with DONE, the DONE is removed. And when neither TODO nor
12234 DONE are present, add TODO at the beginning of the heading.
12236 With \\[universal-argument] prefix arg, use completion to determine the new \
12237 state.
12238 With numeric prefix arg, switch to that state.
12239 With a double \\[universal-argument] prefix, switch to the next set of TODO \
12240 keywords (nextset).
12241 With a triple \\[universal-argument] prefix, circumvent any state blocking.
12242 With a numeric prefix arg of 0, inhibit note taking for the change.
12243 With a numeric prefix arg of -1, cancel repeater to allow marking as DONE.
12245 When called through ELisp, arg is also interpreted in the following way:
12246 'none -> empty state
12247 \"\"(empty string) -> switch to empty state
12248 'done -> switch to DONE
12249 'nextset -> switch to the next set of keywords
12250 'previousset -> switch to the previous set of keywords
12251 \"WAITING\" -> switch to the specified keyword, but only if it
12252 really is a member of `org-todo-keywords'."
12253 (interactive "P")
12254 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
12255 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
12256 'region-start-level 'region))
12257 org-loop-over-headlines-in-active-region)
12258 (org-map-entries
12259 `(org-todo ,arg)
12260 org-loop-over-headlines-in-active-region
12261 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
12262 (if (equal arg '(16)) (setq arg 'nextset))
12263 (when (equal arg -1) (org-cancel-repeater) (setq arg nil))
12264 (let ((org-blocker-hook org-blocker-hook)
12265 commentp
12266 case-fold-search)
12267 (when (equal arg '(64))
12268 (setq arg nil org-blocker-hook nil))
12269 (when (and org-blocker-hook
12270 (or org-inhibit-blocking
12271 (org-entry-get nil "NOBLOCKING")))
12272 (setq org-blocker-hook nil))
12273 (save-excursion
12274 (catch 'exit
12275 (org-back-to-heading t)
12276 (when (looking-at (concat "^\\*+ " org-comment-string))
12277 (org-toggle-comment)
12278 (setq commentp t))
12279 (if (looking-at org-outline-regexp) (goto-char (1- (match-end 0))))
12280 (or (looking-at (concat " +" org-todo-regexp "\\( +\\|[ \t]*$\\)"))
12281 (looking-at "\\(?: *\\|[ \t]*$\\)"))
12282 (let* ((match-data (match-data))
12283 (startpos (point-at-bol))
12284 (logging (save-match-data (org-entry-get nil "LOGGING" t t)))
12285 (org-log-done org-log-done)
12286 (org-log-repeat org-log-repeat)
12287 (org-todo-log-states org-todo-log-states)
12288 (org-inhibit-logging
12289 (if (equal arg 0)
12290 (progn (setq arg nil) 'note) org-inhibit-logging))
12291 (this (match-string 1))
12292 (hl-pos (match-beginning 0))
12293 (head (org-get-todo-sequence-head this))
12294 (ass (assoc head org-todo-kwd-alist))
12295 (interpret (nth 1 ass))
12296 (done-word (nth 3 ass))
12297 (final-done-word (nth 4 ass))
12298 (org-last-state (or this ""))
12299 (completion-ignore-case t)
12300 (member (member this org-todo-keywords-1))
12301 (tail (cdr member))
12302 (org-state (cond
12303 ((and org-todo-key-trigger
12304 (or (and (equal arg '(4))
12305 (eq org-use-fast-todo-selection 'prefix))
12306 (and (not arg) org-use-fast-todo-selection
12307 (not (eq org-use-fast-todo-selection
12308 'prefix)))))
12309 ;; Use fast selection
12310 (org-fast-todo-selection))
12311 ((and (equal arg '(4))
12312 (or (not org-use-fast-todo-selection)
12313 (not org-todo-key-trigger)))
12314 ;; Read a state with completion
12315 (org-icompleting-read
12316 "State: " (mapcar 'list org-todo-keywords-1)
12317 nil t))
12318 ((eq arg 'right)
12319 (if this
12320 (if tail (car tail) nil)
12321 (car org-todo-keywords-1)))
12322 ((eq arg 'left)
12323 (if (equal member org-todo-keywords-1)
12325 (if this
12326 (nth (- (length org-todo-keywords-1)
12327 (length tail) 2)
12328 org-todo-keywords-1)
12329 (org-last org-todo-keywords-1))))
12330 ((and (eq org-use-fast-todo-selection t) (equal arg '(4))
12331 (setq arg nil))) ; hack to fall back to cycling
12332 (arg
12333 ;; user or caller requests a specific state
12334 (cond
12335 ((equal arg "") nil)
12336 ((eq arg 'none) nil)
12337 ((eq arg 'done) (or done-word (car org-done-keywords)))
12338 ((eq arg 'nextset)
12339 (or (car (cdr (member head org-todo-heads)))
12340 (car org-todo-heads)))
12341 ((eq arg 'previousset)
12342 (let ((org-todo-heads (reverse org-todo-heads)))
12343 (or (car (cdr (member head org-todo-heads)))
12344 (car org-todo-heads))))
12345 ((car (member arg org-todo-keywords-1)))
12346 ((stringp arg)
12347 (user-error "State `%s' not valid in this file" arg))
12348 ((nth (1- (prefix-numeric-value arg))
12349 org-todo-keywords-1))))
12350 ((null member) (or head (car org-todo-keywords-1)))
12351 ((equal this final-done-word) nil) ;; -> make empty
12352 ((null tail) nil) ;; -> first entry
12353 ((memq interpret '(type priority))
12354 (if (eq this-command last-command)
12355 (car tail)
12356 (if (> (length tail) 0)
12357 (or done-word (car org-done-keywords))
12358 nil)))
12360 (car tail))))
12361 (org-state (or
12362 (run-hook-with-args-until-success
12363 'org-todo-get-default-hook org-state org-last-state)
12364 org-state))
12365 (next (if org-state (concat " " org-state " ") " "))
12366 (change-plist (list :type 'todo-state-change :from this :to org-state
12367 :position startpos))
12368 dolog now-done-p)
12369 (when org-blocker-hook
12370 (setq org-last-todo-state-is-todo
12371 (not (member this org-done-keywords)))
12372 (unless (save-excursion
12373 (save-match-data
12374 (org-with-wide-buffer
12375 (run-hook-with-args-until-failure
12376 'org-blocker-hook change-plist))))
12377 (if (org-called-interactively-p 'interactive)
12378 (user-error "TODO state change from %s to %s blocked (by \"%s\")"
12379 this org-state org-block-entry-blocking)
12380 ;; fail silently
12381 (message "TODO state change from %s to %s blocked (by \"%s\")"
12382 this org-state org-block-entry-blocking)
12383 (throw 'exit nil))))
12384 (store-match-data match-data)
12385 (replace-match next t t)
12386 (unless (pos-visible-in-window-p hl-pos)
12387 (message "TODO state changed to %s" (org-trim next)))
12388 (unless head
12389 (setq head (org-get-todo-sequence-head org-state)
12390 ass (assoc head org-todo-kwd-alist)
12391 interpret (nth 1 ass)
12392 done-word (nth 3 ass)
12393 final-done-word (nth 4 ass)))
12394 (when (memq arg '(nextset previousset))
12395 (message "Keyword-Set %d/%d: %s"
12396 (- (length org-todo-sets) -1
12397 (length (memq (assoc org-state org-todo-sets) org-todo-sets)))
12398 (length org-todo-sets)
12399 (mapconcat 'identity (assoc org-state org-todo-sets) " ")))
12400 (setq org-last-todo-state-is-todo
12401 (not (member org-state org-done-keywords)))
12402 (setq now-done-p (and (member org-state org-done-keywords)
12403 (not (member this org-done-keywords))))
12404 (and logging (org-local-logging logging))
12405 (when (and (or org-todo-log-states org-log-done)
12406 (not (eq org-inhibit-logging t))
12407 (not (memq arg '(nextset previousset))))
12408 ;; we need to look at recording a time and note
12409 (setq dolog (or (nth 1 (assoc org-state org-todo-log-states))
12410 (nth 2 (assoc this org-todo-log-states))))
12411 (if (and (eq dolog 'note) (eq org-inhibit-logging 'note))
12412 (setq dolog 'time))
12413 (when (or (and (not org-state) (not org-closed-keep-when-no-todo))
12414 (and org-state
12415 (member org-state org-not-done-keywords)
12416 (not (member this org-not-done-keywords))))
12417 ;; This is now a todo state and was not one before
12418 ;; If there was a CLOSED time stamp, get rid of it.
12419 (org-add-planning-info nil nil 'closed))
12420 (when (and now-done-p org-log-done)
12421 ;; It is now done, and it was not done before
12422 (org-add-planning-info 'closed (org-current-effective-time))
12423 (if (and (not dolog) (eq 'note org-log-done))
12424 (org-add-log-setup 'done org-state this 'findpos 'note)))
12425 (when (and org-state dolog)
12426 ;; This is a non-nil state, and we need to log it
12427 (org-add-log-setup 'state org-state this 'findpos dolog)))
12428 ;; Fixup tag positioning
12429 (org-todo-trigger-tag-changes org-state)
12430 (and org-auto-align-tags (not org-setting-tags) (org-set-tags nil t))
12431 (when org-provide-todo-statistics
12432 (org-update-parent-todo-statistics))
12433 (run-hooks 'org-after-todo-state-change-hook)
12434 (if (and arg (not (member org-state org-done-keywords)))
12435 (setq head (org-get-todo-sequence-head org-state)))
12436 (put-text-property (point-at-bol) (point-at-eol) 'org-todo-head head)
12437 ;; Do we need to trigger a repeat?
12438 (when now-done-p
12439 (when (boundp 'org-agenda-headline-snapshot-before-repeat)
12440 ;; This is for the agenda, take a snapshot of the headline.
12441 (save-match-data
12442 (setq org-agenda-headline-snapshot-before-repeat
12443 (org-get-heading))))
12444 (org-auto-repeat-maybe org-state))
12445 ;; Fixup cursor location if close to the keyword
12446 (if (and (outline-on-heading-p)
12447 (not (bolp))
12448 (save-excursion (beginning-of-line 1)
12449 (looking-at org-todo-line-regexp))
12450 (< (point) (+ 2 (or (match-end 2) (match-end 1)))))
12451 (progn
12452 (goto-char (or (match-end 2) (match-end 1)))
12453 (and (looking-at " ") (just-one-space))))
12454 (when org-trigger-hook
12455 (save-excursion
12456 (run-hook-with-args 'org-trigger-hook change-plist)))
12457 (when commentp (org-toggle-comment))))))))
12459 (defun org-block-todo-from-children-or-siblings-or-parent (change-plist)
12460 "Block turning an entry into a TODO, using the hierarchy.
12461 This checks whether the current task should be blocked from state
12462 changes. Such blocking occurs when:
12464 1. The task has children which are not all in a completed state.
12466 2. A task has a parent with the property :ORDERED:, and there
12467 are siblings prior to the current task with incomplete
12468 status.
12470 3. The parent of the task is blocked because it has siblings that should
12471 be done first, or is child of a block grandparent TODO entry."
12473 (if (not org-enforce-todo-dependencies)
12474 t ; if locally turned off don't block
12475 (catch 'dont-block
12476 ;; If this is not a todo state change, or if this entry is already DONE,
12477 ;; do not block
12478 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12479 (member (plist-get change-plist :from)
12480 (cons 'done org-done-keywords))
12481 (member (plist-get change-plist :to)
12482 (cons 'todo org-not-done-keywords))
12483 (not (plist-get change-plist :to)))
12484 (throw 'dont-block t))
12485 ;; If this task has children, and any are undone, it's blocked
12486 (save-excursion
12487 (org-back-to-heading t)
12488 (let ((this-level (funcall outline-level)))
12489 (outline-next-heading)
12490 (let ((child-level (funcall outline-level)))
12491 (while (and (not (eobp))
12492 (> child-level this-level))
12493 ;; this todo has children, check whether they are all
12494 ;; completed
12495 (if (and (not (org-entry-is-done-p))
12496 (org-entry-is-todo-p))
12497 (progn (setq org-block-entry-blocking (org-get-heading))
12498 (throw 'dont-block nil)))
12499 (outline-next-heading)
12500 (setq child-level (funcall outline-level))))))
12501 ;; Otherwise, if the task's parent has the :ORDERED: property, and
12502 ;; any previous siblings are undone, it's blocked
12503 (save-excursion
12504 (org-back-to-heading t)
12505 (let* ((pos (point))
12506 (parent-pos (and (org-up-heading-safe) (point))))
12507 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12508 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12509 (forward-line 1)
12510 (re-search-forward org-not-done-heading-regexp pos t))
12511 (setq org-block-entry-blocking (match-string 0))
12512 (throw 'dont-block nil)) ; block, there is an older sibling not done.
12513 ;; Search further up the hierarchy, to see if an ancestor is blocked
12514 (while t
12515 (goto-char parent-pos)
12516 (if (not (looking-at org-not-done-heading-regexp))
12517 (throw 'dont-block t)) ; do not block, parent is not a TODO
12518 (setq pos (point))
12519 (setq parent-pos (and (org-up-heading-safe) (point)))
12520 (if (not parent-pos) (throw 'dont-block t)) ; no parent
12521 (when (and (org-not-nil (org-entry-get (point) "ORDERED"))
12522 (forward-line 1)
12523 (re-search-forward org-not-done-heading-regexp pos t)
12524 (setq org-block-entry-blocking (org-get-heading)))
12525 (throw 'dont-block nil)))))))) ; block, older sibling not done.
12527 (defcustom org-track-ordered-property-with-tag nil
12528 "Should the ORDERED property also be shown as a tag?
12529 The ORDERED property decides if an entry should require subtasks to be
12530 completed in sequence. Since a property is not very visible, setting
12531 this option means that toggling the ORDERED property with the command
12532 `org-toggle-ordered-property' will also toggle a tag ORDERED. That tag is
12533 not relevant for the behavior, but it makes things more visible.
12535 Note that toggling the tag with tags commands will not change the property
12536 and therefore not influence behavior!
12538 This can be t, meaning the tag ORDERED should be used, It can also be a
12539 string to select a different tag for this task."
12540 :group 'org-todo
12541 :type '(choice
12542 (const :tag "No tracking" nil)
12543 (const :tag "Track with ORDERED tag" t)
12544 (string :tag "Use other tag")))
12546 (defun org-toggle-ordered-property ()
12547 "Toggle the ORDERED property of the current entry.
12548 For better visibility, you can track the value of this property with a tag.
12549 See variable `org-track-ordered-property-with-tag'."
12550 (interactive)
12551 (let* ((t1 org-track-ordered-property-with-tag)
12552 (tag (and t1 (if (stringp t1) t1 "ORDERED"))))
12553 (save-excursion
12554 (org-back-to-heading)
12555 (if (org-entry-get nil "ORDERED")
12556 (progn
12557 (org-delete-property "ORDERED")
12558 (and tag (org-toggle-tag tag 'off))
12559 (message "Subtasks can be completed in arbitrary order"))
12560 (org-entry-put nil "ORDERED" "t")
12561 (and tag (org-toggle-tag tag 'on))
12562 (message "Subtasks must be completed in sequence")))))
12564 (defvar org-blocked-by-checkboxes) ; dynamically scoped
12565 (defun org-block-todo-from-checkboxes (change-plist)
12566 "Block turning an entry into a TODO, using checkboxes.
12567 This checks whether the current task should be blocked from state
12568 changes because there are unchecked boxes in this entry."
12569 (if (not org-enforce-todo-checkbox-dependencies)
12570 t ; if locally turned off don't block
12571 (catch 'dont-block
12572 ;; If this is not a todo state change, or if this entry is already DONE,
12573 ;; do not block
12574 (when (or (not (eq (plist-get change-plist :type) 'todo-state-change))
12575 (member (plist-get change-plist :from)
12576 (cons 'done org-done-keywords))
12577 (member (plist-get change-plist :to)
12578 (cons 'todo org-not-done-keywords))
12579 (not (plist-get change-plist :to)))
12580 (throw 'dont-block t))
12581 ;; If this task has checkboxes that are not checked, it's blocked
12582 (save-excursion
12583 (org-back-to-heading t)
12584 (let ((beg (point)) end)
12585 (outline-next-heading)
12586 (setq end (point))
12587 (goto-char beg)
12588 (if (org-list-search-forward
12589 (concat (org-item-beginning-re)
12590 "\\(?:\\[@\\(?:start:\\)?\\([0-9]+\\|[A-Za-z]\\)\\][ \t]*\\)?"
12591 "\\[[- ]\\]")
12592 end t)
12593 (progn
12594 (if (boundp 'org-blocked-by-checkboxes)
12595 (setq org-blocked-by-checkboxes t))
12596 (throw 'dont-block nil)))))
12597 t))) ; do not block
12599 (defun org-entry-blocked-p ()
12600 "Is the current entry blocked?"
12601 (org-with-silent-modifications
12602 (if (org-entry-get nil "NOBLOCKING")
12603 nil ;; Never block this entry
12604 (not (run-hook-with-args-until-failure
12605 'org-blocker-hook
12606 (list :type 'todo-state-change
12607 :position (point)
12608 :from 'todo
12609 :to 'done))))))
12611 (defun org-update-statistics-cookies (all)
12612 "Update the statistics cookie, either from TODO or from checkboxes.
12613 This should be called with the cursor in a line with a statistics cookie."
12614 (interactive "P")
12615 (if all
12616 (progn
12617 (org-update-checkbox-count 'all)
12618 (org-map-entries 'org-update-parent-todo-statistics))
12619 (if (not (org-at-heading-p))
12620 (org-update-checkbox-count)
12621 (let ((pos (point-marker))
12622 end l1 l2)
12623 (ignore-errors (org-back-to-heading t))
12624 (if (not (org-at-heading-p))
12625 (org-update-checkbox-count)
12626 (setq l1 (org-outline-level))
12627 (setq end (save-excursion
12628 (outline-next-heading)
12629 (if (org-at-heading-p) (setq l2 (org-outline-level)))
12630 (point)))
12631 (if (and (save-excursion
12632 (re-search-forward
12633 "^[ \t]*\\([-+*]\\|[0-9]+[.)]\\) \\[[- X]\\]" end t))
12634 (not (save-excursion (re-search-forward
12635 ":COOKIE_DATA:.*\\<todo\\>" end t))))
12636 (org-update-checkbox-count)
12637 (if (and l2 (> l2 l1))
12638 (progn
12639 (goto-char end)
12640 (org-update-parent-todo-statistics))
12641 (goto-char pos)
12642 (beginning-of-line 1)
12643 (while (re-search-forward
12644 "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)"
12645 (point-at-eol) t)
12646 (replace-match (if (match-end 2) "[100%]" "[0/0]") t t)))))
12647 (goto-char pos)
12648 (move-marker pos nil)))))
12650 (defvar org-entry-property-inherited-from) ;; defined below
12651 (defun org-update-parent-todo-statistics ()
12652 "Update any statistics cookie in the parent of the current headline.
12653 When `org-hierarchical-todo-statistics' is nil, statistics will cover
12654 the entire subtree and this will travel up the hierarchy and update
12655 statistics everywhere."
12656 (let* ((prop (save-excursion (org-up-heading-safe)
12657 (org-entry-get nil "COOKIE_DATA" 'inherit)))
12658 (recursive (or (not org-hierarchical-todo-statistics)
12659 (and prop (string-match "\\<recursive\\>" prop))))
12660 (lim (or (and prop (marker-position org-entry-property-inherited-from))
12662 (first t)
12663 (box-re "\\(\\(\\[[0-9]*%\\]\\)\\|\\(\\[[0-9]*/[0-9]*\\]\\)\\)")
12664 level ltoggle l1 new ndel
12665 (cnt-all 0) (cnt-done 0) is-percent kwd
12666 checkbox-beg ov ovs ove cookie-present)
12667 (catch 'exit
12668 (save-excursion
12669 (beginning-of-line 1)
12670 (setq ltoggle (funcall outline-level))
12671 ;; Three situations are to consider:
12673 ;; 1. if `org-hierarchical-todo-statistics' is nil, repeat up
12674 ;; to the top-level ancestor on the headline;
12676 ;; 2. If parent has "recursive" property, repeat up to the
12677 ;; headline setting that property, taking inheritance into
12678 ;; account;
12680 ;; 3. Else, move up to direct parent and proceed only once.
12681 (while (and (setq level (org-up-heading-safe))
12682 (or recursive first)
12683 (>= (point) lim))
12684 (setq first nil cookie-present nil)
12685 (unless (and level
12686 (not (string-match
12687 "\\<checkbox\\>"
12688 (downcase (or (org-entry-get nil "COOKIE_DATA")
12689 "")))))
12690 (throw 'exit nil))
12691 (while (re-search-forward box-re (point-at-eol) t)
12692 (setq cnt-all 0 cnt-done 0 cookie-present t)
12693 (setq is-percent (match-end 2) checkbox-beg (match-beginning 0))
12694 (save-match-data
12695 (unless (outline-next-heading) (throw 'exit nil))
12696 (while (and (looking-at org-complex-heading-regexp)
12697 (> (setq l1 (length (match-string 1))) level))
12698 (setq kwd (and (or recursive (= l1 ltoggle))
12699 (match-string 2)))
12700 (if (or (eq org-provide-todo-statistics 'all-headlines)
12701 (and (eq org-provide-todo-statistics t)
12702 (or (member kwd org-done-keywords)))
12703 (and (listp org-provide-todo-statistics)
12704 (stringp (car org-provide-todo-statistics))
12705 (or (member kwd org-provide-todo-statistics)
12706 (member kwd org-done-keywords)))
12707 (and (listp org-provide-todo-statistics)
12708 (listp (car org-provide-todo-statistics))
12709 (or (member kwd (car org-provide-todo-statistics))
12710 (and (member kwd org-done-keywords)
12711 (member kwd (cadr org-provide-todo-statistics))))))
12712 (setq cnt-all (1+ cnt-all))
12713 (if (eq org-provide-todo-statistics t)
12714 (and kwd (setq cnt-all (1+ cnt-all)))))
12715 (when (or (and (member org-provide-todo-statistics '(t all-headlines))
12716 (member kwd org-done-keywords))
12717 (and (listp org-provide-todo-statistics)
12718 (listp (car org-provide-todo-statistics))
12719 (member kwd org-done-keywords)
12720 (member kwd (cadr org-provide-todo-statistics)))
12721 (and (listp org-provide-todo-statistics)
12722 (stringp (car org-provide-todo-statistics))
12723 (member kwd org-done-keywords)))
12724 (setq cnt-done (1+ cnt-done)))
12725 (outline-next-heading)))
12726 (setq new
12727 (if is-percent
12728 (format "[%d%%]" (/ (* 100 cnt-done) (max 1 cnt-all)))
12729 (format "[%d/%d]" cnt-done cnt-all))
12730 ndel (- (match-end 0) checkbox-beg))
12731 ;; handle overlays when updating cookie from column view
12732 (when (setq ov (car (overlays-at checkbox-beg)))
12733 (setq ovs (overlay-start ov) ove (overlay-end ov))
12734 (delete-overlay ov))
12735 (goto-char checkbox-beg)
12736 (insert new)
12737 (delete-region (point) (+ (point) ndel))
12738 (when org-auto-align-tags (org-fix-tags-on-the-fly))
12739 (when ov (move-overlay ov ovs ove)))
12740 (when cookie-present
12741 (run-hook-with-args 'org-after-todo-statistics-hook
12742 cnt-done (- cnt-all cnt-done))))))
12743 (run-hooks 'org-todo-statistics-hook)))
12745 (defvar org-after-todo-statistics-hook nil
12746 "Hook that is called after a TODO statistics cookie has been updated.
12747 Each function is called with two arguments: the number of not-done entries
12748 and the number of done entries.
12750 For example, the following function, when added to this hook, will switch
12751 an entry to DONE when all children are done, and back to TODO when new
12752 entries are set to a TODO status. Note that this hook is only called
12753 when there is a statistics cookie in the headline!
12755 (defun org-summary-todo (n-done n-not-done)
12756 \"Switch entry to DONE when all subentries are done, to TODO otherwise.\"
12757 (let (org-log-done org-log-states) ; turn off logging
12758 (org-todo (if (= n-not-done 0) \"DONE\" \"TODO\"))))
12761 (defvar org-todo-statistics-hook nil
12762 "Hook that is run whenever Org thinks TODO statistics should be updated.
12763 This hook runs even if there is no statistics cookie present, in which case
12764 `org-after-todo-statistics-hook' would not run.")
12766 (defun org-todo-trigger-tag-changes (state)
12767 "Apply the changes defined in `org-todo-state-tags-triggers'."
12768 (let ((l org-todo-state-tags-triggers)
12769 changes)
12770 (when (or (not state) (equal state ""))
12771 (setq changes (append changes (cdr (assoc "" l)))))
12772 (when (and (stringp state) (> (length state) 0))
12773 (setq changes (append changes (cdr (assoc state l)))))
12774 (when (member state org-not-done-keywords)
12775 (setq changes (append changes (cdr (assoc 'todo l)))))
12776 (when (member state org-done-keywords)
12777 (setq changes (append changes (cdr (assoc 'done l)))))
12778 (dolist (c changes)
12779 (org-toggle-tag (car c) (if (cdr c) 'on 'off)))))
12781 (defun org-local-logging (value)
12782 "Get logging settings from a property VALUE."
12783 (let* (words w a)
12784 ;; directly set the variables, they are already local.
12785 (setq org-log-done nil
12786 org-log-repeat nil
12787 org-todo-log-states nil)
12788 (setq words (org-split-string value))
12789 (while (setq w (pop words))
12790 (cond
12791 ((setq a (assoc w org-startup-options))
12792 (and (member (nth 1 a) '(org-log-done org-log-repeat))
12793 (set (nth 1 a) (nth 2 a))))
12794 ((setq a (org-extract-log-state-settings w))
12795 (and (member (car a) org-todo-keywords-1)
12796 (push a org-todo-log-states)))))))
12798 (defun org-get-todo-sequence-head (kwd)
12799 "Return the head of the TODO sequence to which KWD belongs.
12800 If KWD is not set, check if there is a text property remembering the
12801 right sequence."
12802 (let (p)
12803 (cond
12804 ((not kwd)
12805 (or (get-text-property (point-at-bol) 'org-todo-head)
12806 (progn
12807 (setq p (next-single-property-change (point-at-bol) 'org-todo-head
12808 nil (point-at-eol)))
12809 (get-text-property p 'org-todo-head))))
12810 ((not (member kwd org-todo-keywords-1))
12811 (car org-todo-keywords-1))
12812 (t (nth 2 (assoc kwd org-todo-kwd-alist))))))
12814 (defun org-fast-todo-selection ()
12815 "Fast TODO keyword selection with single keys.
12816 Returns the new TODO keyword, or nil if no state change should occur."
12817 (let* ((fulltable org-todo-key-alist)
12818 (done-keywords org-done-keywords) ;; needed for the faces.
12819 (maxlen (apply 'max (mapcar
12820 (lambda (x)
12821 (if (stringp (car x)) (string-width (car x)) 0))
12822 fulltable)))
12823 (expert nil)
12824 (fwidth (+ maxlen 3 1 3))
12825 (ncol (/ (- (window-width) 4) fwidth))
12826 tg cnt e c tbl
12827 groups ingroup)
12828 (save-excursion
12829 (save-window-excursion
12830 (if expert
12831 (set-buffer (get-buffer-create " *Org todo*"))
12832 (org-switch-to-buffer-other-window (get-buffer-create " *Org todo*")))
12833 (erase-buffer)
12834 (org-set-local 'org-done-keywords done-keywords)
12835 (setq tbl fulltable cnt 0)
12836 (while (setq e (pop tbl))
12837 (cond
12838 ((equal e '(:startgroup))
12839 (push '() groups) (setq ingroup t)
12840 (when (not (= cnt 0))
12841 (setq cnt 0)
12842 (insert "\n"))
12843 (insert "{ "))
12844 ((equal e '(:endgroup))
12845 (setq ingroup nil cnt 0)
12846 (insert "}\n"))
12847 ((equal e '(:newline))
12848 (when (not (= cnt 0))
12849 (setq cnt 0)
12850 (insert "\n")
12851 (setq e (car tbl))
12852 (while (equal (car tbl) '(:newline))
12853 (insert "\n")
12854 (setq tbl (cdr tbl)))))
12856 (setq tg (car e) c (cdr e))
12857 (if ingroup (push tg (car groups)))
12858 (setq tg (org-add-props tg nil 'face
12859 (org-get-todo-face tg)))
12860 (if (and (= cnt 0) (not ingroup)) (insert " "))
12861 (insert "[" c "] " tg (make-string
12862 (- fwidth 4 (length tg)) ?\ ))
12863 (when (= (setq cnt (1+ cnt)) ncol)
12864 (insert "\n")
12865 (if ingroup (insert " "))
12866 (setq cnt 0)))))
12867 (insert "\n")
12868 (goto-char (point-min))
12869 (if (not expert) (org-fit-window-to-buffer))
12870 (message "[a-z..]:Set [SPC]:clear")
12871 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
12872 (cond
12873 ((or (= c ?\C-g)
12874 (and (= c ?q) (not (rassoc c fulltable))))
12875 (setq quit-flag t))
12876 ((= c ?\ ) nil)
12877 ((setq e (rassoc c fulltable) tg (car e))
12879 (t (setq quit-flag t)))))))
12881 (defun org-entry-is-todo-p ()
12882 (member (org-get-todo-state) org-not-done-keywords))
12884 (defun org-entry-is-done-p ()
12885 (member (org-get-todo-state) org-done-keywords))
12887 (defun org-get-todo-state ()
12888 "Return the TODO keyword of the current subtree."
12889 (save-excursion
12890 (org-back-to-heading t)
12891 (and (looking-at org-todo-line-regexp)
12892 (match-end 2)
12893 (match-string 2))))
12895 (defun org-at-date-range-p (&optional inactive-ok)
12896 "Is the cursor inside a date range?"
12897 (interactive)
12898 (save-excursion
12899 (catch 'exit
12900 (let ((pos (point)))
12901 (skip-chars-backward "^[<\r\n")
12902 (skip-chars-backward "<[")
12903 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12904 (>= (match-end 0) pos)
12905 (throw 'exit t))
12906 (skip-chars-backward "^<[\r\n")
12907 (skip-chars-backward "<[")
12908 (and (looking-at (if inactive-ok org-tr-regexp-both org-tr-regexp))
12909 (>= (match-end 0) pos)
12910 (throw 'exit t)))
12911 nil)))
12913 (defun org-get-repeat (&optional tagline)
12914 "Check if there is a deadline/schedule with repeater in this entry."
12915 (save-match-data
12916 (save-excursion
12917 (org-back-to-heading t)
12918 (and (re-search-forward (if tagline
12919 (concat tagline "\\s-*" org-repeat-re)
12920 org-repeat-re)
12921 (org-entry-end-position) t)
12922 (match-string-no-properties 1)))))
12924 (defvar org-last-changed-timestamp)
12925 (defvar org-last-inserted-timestamp)
12926 (defvar org-log-post-message)
12927 (defvar org-log-note-purpose)
12928 (defvar org-log-note-how)
12929 (defvar org-log-note-extra)
12930 (defun org-auto-repeat-maybe (done-word)
12931 "Check if the current headline contains a repeated deadline/schedule.
12932 If yes, set TODO state back to what it was and change the base date
12933 of repeating deadline/scheduled time stamps to new date.
12934 This function is run automatically after each state change to a DONE state."
12935 ;; last-state is dynamically scoped into this function
12936 (let* ((repeat (org-get-repeat))
12937 (aa (assoc org-last-state org-todo-kwd-alist))
12938 (interpret (nth 1 aa))
12939 (head (nth 2 aa))
12940 (whata '(("h" . hour) ("d" . day) ("m" . month) ("y" . year)))
12941 (msg "Entry repeats: ")
12942 (org-log-done nil)
12943 (org-todo-log-states nil)
12944 re type n what ts time to-state)
12945 (when (and repeat (not (zerop (string-to-number (substring repeat 1)))))
12946 (if (eq org-log-repeat t) (setq org-log-repeat 'state))
12947 (setq to-state (or (org-entry-get nil "REPEAT_TO_STATE")
12948 org-todo-repeat-to-state))
12949 (unless (and to-state (member to-state org-todo-keywords-1))
12950 (setq to-state (if (eq interpret 'type) org-last-state head)))
12951 (org-todo to-state)
12952 (when (or org-log-repeat (org-entry-get nil "CLOCK"))
12953 (org-entry-put nil "LAST_REPEAT" (format-time-string
12954 (org-time-stamp-format t t))))
12955 (when org-log-repeat
12956 (if (or (memq 'org-add-log-note (default-value 'post-command-hook))
12957 (memq 'org-add-log-note post-command-hook))
12958 ;; OK, we are already setup for some record
12959 (if (eq org-log-repeat 'note)
12960 ;; make sure we take a note, not only a time stamp
12961 (setq org-log-note-how 'note))
12962 ;; Set up for taking a record
12963 (org-add-log-setup 'state (or done-word (car org-done-keywords))
12964 org-last-state
12965 'findpos org-log-repeat)))
12966 (org-back-to-heading t)
12967 (org-add-planning-info nil nil 'closed)
12968 (setq re (concat "\\(" org-scheduled-time-regexp "\\)\\|\\("
12969 org-deadline-time-regexp "\\)\\|\\("
12970 org-ts-regexp "\\)"))
12971 (while (re-search-forward
12972 re (save-excursion (outline-next-heading) (point)) t)
12973 (setq type (if (match-end 1) org-scheduled-string
12974 (if (match-end 3) org-deadline-string "Plain:"))
12975 ts (match-string (if (match-end 2) 2 (if (match-end 4) 4 0))))
12976 (when (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts)
12977 (setq n (string-to-number (match-string 2 ts))
12978 what (match-string 3 ts))
12979 (if (equal what "w") (setq n (* n 7) what "d"))
12980 (if (and (equal what "h") (not (string-match "[0-9]\\{1,2\\}:[0-9]\\{2\\}" ts)))
12981 (user-error "Cannot repeat in Repeat in %d hour(s) because no hour has been set" n))
12982 ;; Preparation, see if we need to modify the start date for the change
12983 (when (match-end 1)
12984 (setq time (save-match-data (org-time-string-to-time ts)))
12985 (cond
12986 ((equal (match-string 1 ts) ".")
12987 ;; Shift starting date to today
12988 (org-timestamp-change
12989 (- (org-today) (time-to-days time))
12990 'day))
12991 ((equal (match-string 1 ts) "+")
12992 (let ((nshiftmax 10) (nshift 0))
12993 (while (or (= nshift 0)
12994 (<= (time-to-days time)
12995 (time-to-days (current-time))))
12996 (when (= (incf nshift) nshiftmax)
12997 (or (y-or-n-p (message "%d repeater intervals were not enough to shift date past today. Continue? " nshift))
12998 (error "Abort")))
12999 (org-timestamp-change n (cdr (assoc what whata)))
13000 (org-at-timestamp-p t)
13001 (setq ts (match-string 1))
13002 (setq time (save-match-data (org-time-string-to-time ts)))))
13003 (org-timestamp-change (- n) (cdr (assoc what whata)))
13004 ;; rematch, so that we have everything in place for the real shift
13005 (org-at-timestamp-p t)
13006 (setq ts (match-string 1))
13007 (string-match "\\([.+]\\)?\\(\\+[0-9]+\\)\\([hdwmy]\\)" ts))))
13008 (save-excursion (org-timestamp-change n (cdr (assoc what whata)) nil t))
13009 (setq msg (concat msg type " " org-last-changed-timestamp " "))))
13010 (setq org-log-post-message msg)
13011 (message "%s" msg))))
13013 (defun org-show-todo-tree (arg)
13014 "Make a compact tree which shows all headlines marked with TODO.
13015 The tree will show the lines where the regexp matches, and all higher
13016 headlines above the match.
13017 With a \\[universal-argument] prefix, prompt for a regexp to match.
13018 With a numeric prefix N, construct a sparse tree for the Nth element
13019 of `org-todo-keywords-1'."
13020 (interactive "P")
13021 (let ((case-fold-search nil)
13022 (kwd-re
13023 (cond ((null arg) org-not-done-regexp)
13024 ((equal arg '(4))
13025 (let ((kwd (org-icompleting-read "Keyword (or KWD1|KWD2|...): "
13026 (mapcar 'list org-todo-keywords-1))))
13027 (concat "\\("
13028 (mapconcat 'identity (org-split-string kwd "|") "\\|")
13029 "\\)\\>")))
13030 ((<= (prefix-numeric-value arg) (length org-todo-keywords-1))
13031 (regexp-quote (nth (1- (prefix-numeric-value arg))
13032 org-todo-keywords-1)))
13033 (t (user-error "Invalid prefix argument: %s" arg)))))
13034 (message "%d TODO entries found"
13035 (org-occur (concat "^" org-outline-regexp " *" kwd-re )))))
13037 (defun org-deadline (arg &optional time)
13038 "Insert the \"DEADLINE:\" string with a timestamp to make a deadline.
13039 With one universal prefix argument, remove any deadline from the item.
13040 With two universal prefix arguments, prompt for a warning delay.
13041 With argument TIME, set the deadline at the corresponding date. TIME
13042 can either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13043 (interactive "P")
13044 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13045 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13046 'region-start-level 'region))
13047 org-loop-over-headlines-in-active-region)
13048 (org-map-entries
13049 `(org-deadline ',arg ,time)
13050 org-loop-over-headlines-in-active-region
13051 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13052 (let* ((old-date (org-entry-get nil "DEADLINE"))
13053 (old-date-time (if old-date (org-time-string-to-time old-date)))
13054 (repeater (and old-date
13055 (string-match
13056 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13057 old-date)
13058 (match-string 1 old-date))))
13059 (cond
13060 ((equal arg '(4))
13061 (when (and old-date org-log-redeadline)
13062 (org-add-log-setup 'deldeadline nil old-date 'findpos
13063 org-log-redeadline))
13064 (org-remove-timestamp-with-keyword org-deadline-string)
13065 (message "Item no longer has a deadline."))
13066 ((equal arg '(16))
13067 (save-excursion
13068 (org-back-to-heading t)
13069 (if (re-search-forward
13070 org-deadline-time-regexp
13071 (save-excursion (outline-next-heading) (point)) t)
13072 (let* ((rpl0 (match-string 1))
13073 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13074 (replace-match
13075 (concat org-deadline-string
13076 " <" rpl
13077 (format " -%dd"
13078 (abs
13079 (- (time-to-days
13080 (save-match-data
13081 (org-read-date nil t nil "Warn starting from" old-date-time)))
13082 (time-to-days old-date-time))))
13083 ">") t t))
13084 (user-error "No deadline information to update"))))
13086 (org-add-planning-info 'deadline time 'closed)
13087 (when (and old-date org-log-redeadline
13088 (not (equal old-date
13089 (substring org-last-inserted-timestamp 1 -1))))
13090 (org-add-log-setup 'redeadline nil old-date 'findpos
13091 org-log-redeadline))
13092 (when repeater
13093 (save-excursion
13094 (org-back-to-heading t)
13095 (when (re-search-forward (concat org-deadline-string " "
13096 org-last-inserted-timestamp)
13097 (save-excursion
13098 (outline-next-heading) (point)) t)
13099 (goto-char (1- (match-end 0)))
13100 (insert " " repeater)
13101 (setq org-last-inserted-timestamp
13102 (concat (substring org-last-inserted-timestamp 0 -1)
13103 " " repeater
13104 (substring org-last-inserted-timestamp -1))))))
13105 (message "Deadline on %s" org-last-inserted-timestamp))))))
13107 (defun org-schedule (arg &optional time)
13108 "Insert the SCHEDULED: string with a timestamp to schedule a TODO item.
13109 With one universal prefix argument, remove any scheduling date from the item.
13110 With two universal prefix arguments, prompt for a delay cookie.
13111 With argument TIME, scheduled at the corresponding date. TIME can
13112 either be an Org date like \"2011-07-24\" or a delta like \"+2d\"."
13113 (interactive "P")
13114 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
13115 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
13116 'region-start-level 'region))
13117 org-loop-over-headlines-in-active-region)
13118 (org-map-entries
13119 `(org-schedule ',arg ,time)
13120 org-loop-over-headlines-in-active-region
13121 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
13122 (let* ((old-date (org-entry-get nil "SCHEDULED"))
13123 (old-date-time (if old-date (org-time-string-to-time old-date)))
13124 (repeater (and old-date
13125 (string-match
13126 "\\([.+-]+[0-9]+[hdwmy]\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
13127 old-date)
13128 (match-string 1 old-date))))
13129 (cond
13130 ((equal arg '(4))
13131 (progn
13132 (when (and old-date org-log-reschedule)
13133 (org-add-log-setup 'delschedule nil old-date 'findpos
13134 org-log-reschedule))
13135 (org-remove-timestamp-with-keyword org-scheduled-string)
13136 (message "Item is no longer scheduled.")))
13137 ((equal arg '(16))
13138 (save-excursion
13139 (org-back-to-heading t)
13140 (if (re-search-forward
13141 org-scheduled-time-regexp
13142 (save-excursion (outline-next-heading) (point)) t)
13143 (let* ((rpl0 (match-string 1))
13144 (rpl (replace-regexp-in-string " -[0-9]+[hdwmy]" "" rpl0)))
13145 (replace-match
13146 (concat org-scheduled-string
13147 " <" rpl
13148 (format " -%dd"
13149 (abs
13150 (- (time-to-days
13151 (save-match-data
13152 (org-read-date nil t nil "Delay until" old-date-time)))
13153 (time-to-days old-date-time))))
13154 ">") t t))
13155 (user-error "No scheduled information to update"))))
13157 (org-add-planning-info 'scheduled time 'closed)
13158 (when (and old-date org-log-reschedule
13159 (not (equal old-date
13160 (substring org-last-inserted-timestamp 1 -1))))
13161 (org-add-log-setup 'reschedule nil old-date 'findpos
13162 org-log-reschedule))
13163 (when repeater
13164 (save-excursion
13165 (org-back-to-heading t)
13166 (when (re-search-forward (concat org-scheduled-string " "
13167 org-last-inserted-timestamp)
13168 (save-excursion
13169 (outline-next-heading) (point)) t)
13170 (goto-char (1- (match-end 0)))
13171 (insert " " repeater)
13172 (setq org-last-inserted-timestamp
13173 (concat (substring org-last-inserted-timestamp 0 -1)
13174 " " repeater
13175 (substring org-last-inserted-timestamp -1))))))
13176 (message "Scheduled to %s" org-last-inserted-timestamp))))))
13178 (defun org-get-scheduled-time (pom &optional inherit)
13179 "Get the scheduled time as a time tuple, of a format suitable
13180 for calling org-schedule with, or if there is no scheduling,
13181 returns nil."
13182 (let ((time (org-entry-get pom "SCHEDULED" inherit)))
13183 (when time
13184 (apply 'encode-time (org-parse-time-string time)))))
13186 (defun org-get-deadline-time (pom &optional inherit)
13187 "Get the deadline as a time tuple, of a format suitable for
13188 calling org-deadline with, or if there is no scheduling, returns
13189 nil."
13190 (let ((time (org-entry-get pom "DEADLINE" inherit)))
13191 (when time
13192 (apply 'encode-time (org-parse-time-string time)))))
13194 (defun org-remove-timestamp-with-keyword (keyword)
13195 "Remove all time stamps with KEYWORD in the current entry."
13196 (let ((re (concat "\\<" (regexp-quote keyword) " +<[^>\n]+>[ \t]*"))
13197 beg)
13198 (save-excursion
13199 (org-back-to-heading t)
13200 (setq beg (point))
13201 (outline-next-heading)
13202 (while (re-search-backward re beg t)
13203 (replace-match "")
13204 (if (and (string-match "\\S-" (buffer-substring (point-at-bol) (point)))
13205 (equal (char-before) ?\ ))
13206 (backward-delete-char 1)
13207 (if (string-match "^[ \t]*$" (buffer-substring
13208 (point-at-bol) (point-at-eol)))
13209 (delete-region (point-at-bol)
13210 (min (point-max) (1+ (point-at-eol))))))))))
13212 (defvar org-time-was-given) ; dynamically scoped parameter
13213 (defvar org-end-time-was-given) ; dynamically scoped parameter
13215 (defun org-add-planning-info (what &optional time &rest remove)
13216 "Insert new timestamp with keyword in the line directly after the headline.
13217 WHAT indicates what kind of time stamp to add. TIME indicates the time to use.
13218 If non is given, the user is prompted for a date.
13219 REMOVE indicates what kind of entries to remove. An old WHAT entry will also
13220 be removed."
13221 (interactive)
13222 (let (org-time-was-given org-end-time-was-given ts
13223 end default-time default-input)
13225 (catch 'exit
13226 (when (and (memq what '(scheduled deadline))
13227 (or (not time)
13228 (and (stringp time)
13229 (string-match "^[-+]+[0-9]" time))))
13230 ;; Try to get a default date/time from existing timestamp
13231 (save-excursion
13232 (org-back-to-heading t)
13233 (setq end (save-excursion (outline-next-heading) (point)))
13234 (when (re-search-forward (if (eq what 'scheduled)
13235 org-scheduled-time-regexp
13236 org-deadline-time-regexp)
13237 end t)
13238 (setq ts (match-string 1)
13239 default-time
13240 (apply 'encode-time (org-parse-time-string ts))
13241 default-input (and ts (org-get-compact-tod ts))))))
13242 (when what
13243 (setq time
13244 (if (stringp time)
13245 ;; This is a string (relative or absolute), set proper date
13246 (apply 'encode-time
13247 (org-read-date-analyze
13248 time default-time (decode-time default-time)))
13249 ;; If necessary, get the time from the user
13250 (or time (org-read-date nil 'to-time nil nil
13251 default-time default-input)))))
13253 (when (and org-insert-labeled-timestamps-at-point
13254 (member what '(scheduled deadline)))
13255 (insert
13256 (if (eq what 'scheduled) org-scheduled-string org-deadline-string) " ")
13257 (org-insert-time-stamp time org-time-was-given
13258 nil nil nil (list org-end-time-was-given))
13259 (setq what nil))
13260 (save-excursion
13261 (save-restriction
13262 (let (col list elt ts buffer-invisibility-spec)
13263 (org-back-to-heading t)
13264 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"))
13265 (goto-char (match-end 1))
13266 (setq col (current-column))
13267 (goto-char (match-end 0))
13268 (if (eobp) (insert "\n") (forward-char 1))
13269 (when (and (not what)
13270 (not (looking-at
13271 (concat "[ \t]*"
13272 org-keyword-time-not-clock-regexp))))
13273 ;; Nothing to add, nothing to remove...... :-)
13274 (throw 'exit nil))
13275 (if (and (not (looking-at org-outline-regexp))
13276 (looking-at (concat "[^\r\n]*?" org-keyword-time-regexp
13277 "[^\r\n]*"))
13278 (not (equal (match-string 1) org-clock-string)))
13279 (narrow-to-region (match-beginning 0) (match-end 0))
13280 (insert-before-markers "\n")
13281 (backward-char 1)
13282 (narrow-to-region (point) (point))
13283 (and org-adapt-indentation (org-indent-to-column col)))
13284 ;; Check if we have to remove something.
13285 (setq list (cons what remove))
13286 (while list
13287 (setq elt (pop list))
13288 (when (or (and (eq elt 'scheduled)
13289 (re-search-forward org-scheduled-time-regexp nil t))
13290 (and (eq elt 'deadline)
13291 (re-search-forward org-deadline-time-regexp nil t))
13292 (and (eq elt 'closed)
13293 (re-search-forward org-closed-time-regexp nil t)))
13294 (replace-match "")
13295 (if (looking-at "--+<[^>]+>") (replace-match ""))))
13296 (and (looking-at "[ \t]+") (replace-match ""))
13297 (and org-adapt-indentation (bolp) (org-indent-to-column col))
13298 (when what
13299 (insert
13300 (if (not (or (bolp) (eq (char-before) ?\ ))) " " "")
13301 (cond ((eq what 'scheduled) org-scheduled-string)
13302 ((eq what 'deadline) org-deadline-string)
13303 ((eq what 'closed) org-closed-string))
13304 " ")
13305 (setq ts (org-insert-time-stamp
13306 time
13307 (or org-time-was-given
13308 (and (eq what 'closed) org-log-done-with-time))
13309 (eq what 'closed)
13310 nil nil (list org-end-time-was-given)))
13311 (insert
13312 (if (not (or (bolp) (eq (char-before) ?\ )
13313 (memq (char-after) '(32 10))
13314 (eobp))) " " ""))
13315 (end-of-line 1))
13316 (goto-char (point-min))
13317 (widen)
13318 (if (and (looking-at "[ \t]*\n")
13319 (equal (char-before) ?\n))
13320 (delete-region (1- (point)) (point-at-eol)))
13321 ts))))))
13323 (defvar org-log-note-marker (make-marker))
13324 (defvar org-log-note-purpose nil)
13325 (defvar org-log-note-state nil)
13326 (defvar org-log-note-previous-state nil)
13327 (defvar org-log-note-how nil)
13328 (defvar org-log-note-extra nil)
13329 (defvar org-log-note-window-configuration nil)
13330 (defvar org-log-note-return-to (make-marker))
13331 (defvar org-log-note-effective-time nil
13332 "Remembered current time so that dynamically scoped
13333 `org-extend-today-until' affects tha timestamps in state change
13334 log")
13336 (defvar org-log-post-message nil
13337 "Message to be displayed after a log note has been stored.
13338 The auto-repeater uses this.")
13340 (defun org-add-note ()
13341 "Add a note to the current entry.
13342 This is done in the same way as adding a state change note."
13343 (interactive)
13344 (org-add-log-setup 'note nil nil 'findpos nil))
13346 (defvar org-property-end-re)
13347 (defun org-add-log-setup (&optional purpose state prev-state
13348 findpos how extra)
13349 "Set up the post command hook to take a note.
13350 If this is about to TODO state change, the new state is expected in STATE.
13351 When FINDPOS is non-nil, find the correct position for the note in
13352 the current entry. If not, assume that it can be inserted at point.
13353 HOW is an indicator what kind of note should be created.
13354 EXTRA is additional text that will be inserted into the notes buffer."
13355 (let* ((org-log-into-drawer (org-log-into-drawer))
13356 (drawer (cond ((stringp org-log-into-drawer)
13357 org-log-into-drawer)
13358 (org-log-into-drawer "LOGBOOK"))))
13359 (save-restriction
13360 (save-excursion
13361 (when findpos
13362 (org-back-to-heading t)
13363 (narrow-to-region (point) (save-excursion
13364 (outline-next-heading) (point)))
13365 (looking-at (concat org-outline-regexp "\\( *\\)[^\r\n]*"
13366 "\\(\n[^\r\n]*?" org-keyword-time-not-clock-regexp
13367 "[^\r\n]*\\)?"))
13368 (goto-char (match-end 0))
13369 (cond
13370 (drawer
13371 (if (re-search-forward (concat "^[ \t]*:" drawer ":[ \t]*$")
13372 nil t)
13373 (progn
13374 (goto-char (match-end 0))
13375 (or org-log-states-order-reversed
13376 (and (re-search-forward org-property-end-re nil t)
13377 (goto-char (1- (match-beginning 0))))))
13378 (insert "\n:" drawer ":\n:END:")
13379 (beginning-of-line 0)
13380 (org-indent-line)
13381 (beginning-of-line 2)
13382 (org-indent-line)
13383 (end-of-line 0)))
13384 ((and org-log-state-notes-insert-after-drawers
13385 (save-excursion
13386 (forward-line) (looking-at org-drawer-regexp)))
13387 (forward-line)
13388 (while (looking-at org-drawer-regexp)
13389 (goto-char (match-end 0))
13390 (re-search-forward org-property-end-re (point-max) t)
13391 (forward-line))
13392 (forward-line -1)))
13393 (unless org-log-states-order-reversed
13394 (and (= (char-after) ?\n) (forward-char 1))
13395 (org-skip-over-state-notes)
13396 (skip-chars-backward " \t\n\r")))
13397 (move-marker org-log-note-marker (point))
13398 (setq org-log-note-purpose purpose
13399 org-log-note-state state
13400 org-log-note-previous-state prev-state
13401 org-log-note-how how
13402 org-log-note-extra extra
13403 org-log-note-effective-time (org-current-effective-time))
13404 (add-hook 'post-command-hook 'org-add-log-note 'append)))))
13406 (defun org-skip-over-state-notes ()
13407 "Skip past the list of State notes in an entry."
13408 (if (looking-at "\n[ \t]*- State") (forward-char 1))
13409 (when (ignore-errors (goto-char (org-in-item-p)))
13410 (let* ((struct (org-list-struct))
13411 (prevs (org-list-prevs-alist struct)))
13412 (while (looking-at "[ \t]*- State")
13413 (goto-char (or (org-list-get-next-item (point) struct prevs)
13414 (org-list-get-item-end (point) struct)))))))
13416 (defun org-add-log-note (&optional purpose)
13417 "Pop up a window for taking a note, and add this note later at point."
13418 (remove-hook 'post-command-hook 'org-add-log-note)
13419 (setq org-log-note-window-configuration (current-window-configuration))
13420 (delete-other-windows)
13421 (move-marker org-log-note-return-to (point))
13422 (org-pop-to-buffer-same-window (marker-buffer org-log-note-marker))
13423 (goto-char org-log-note-marker)
13424 (org-switch-to-buffer-other-window "*Org Note*")
13425 (erase-buffer)
13426 (if (memq org-log-note-how '(time state))
13427 (let (current-prefix-arg) (org-store-log-note))
13428 (let ((org-inhibit-startup t)) (org-mode))
13429 (insert (format "# Insert note for %s.
13430 # Finish with C-c C-c, or cancel with C-c C-k.\n\n"
13431 (cond
13432 ((eq org-log-note-purpose 'clock-out) "stopped clock")
13433 ((eq org-log-note-purpose 'done) "closed todo item")
13434 ((eq org-log-note-purpose 'state)
13435 (format "state change from \"%s\" to \"%s\""
13436 (or org-log-note-previous-state "")
13437 (or org-log-note-state "")))
13438 ((eq org-log-note-purpose 'reschedule)
13439 "rescheduling")
13440 ((eq org-log-note-purpose 'delschedule)
13441 "no longer scheduled")
13442 ((eq org-log-note-purpose 'redeadline)
13443 "changing deadline")
13444 ((eq org-log-note-purpose 'deldeadline)
13445 "removing deadline")
13446 ((eq org-log-note-purpose 'refile)
13447 "refiling")
13448 ((eq org-log-note-purpose 'note)
13449 "this entry")
13450 (t (error "This should not happen")))))
13451 (if org-log-note-extra (insert org-log-note-extra))
13452 (org-set-local 'org-finish-function 'org-store-log-note)
13453 (run-hooks 'org-log-buffer-setup-hook)))
13455 (defvar org-note-abort nil) ; dynamically scoped
13456 (defun org-store-log-note ()
13457 "Finish taking a log note, and insert it to where it belongs."
13458 (let ((txt (buffer-string)))
13459 (kill-buffer (current-buffer))
13460 (let ((note (cdr (assq org-log-note-purpose org-log-note-headings)))
13461 lines ind bul)
13462 (while (string-match "\\`# .*\n[ \t\n]*" txt)
13463 (setq txt (replace-match "" t t txt)))
13464 (if (string-match "\\s-+\\'" txt)
13465 (setq txt (replace-match "" t t txt)))
13466 (setq lines (org-split-string txt "\n"))
13467 (when (and note (string-match "\\S-" note))
13468 (setq note
13469 (org-replace-escapes
13470 note
13471 (list (cons "%u" (user-login-name))
13472 (cons "%U" user-full-name)
13473 (cons "%t" (format-time-string
13474 (org-time-stamp-format 'long 'inactive)
13475 org-log-note-effective-time))
13476 (cons "%T" (format-time-string
13477 (org-time-stamp-format 'long nil)
13478 org-log-note-effective-time))
13479 (cons "%d" (format-time-string
13480 (org-time-stamp-format nil 'inactive)
13481 org-log-note-effective-time))
13482 (cons "%D" (format-time-string
13483 (org-time-stamp-format nil nil)
13484 org-log-note-effective-time))
13485 (cons "%s" (if org-log-note-state
13486 (concat "\"" org-log-note-state "\"")
13487 ""))
13488 (cons "%S" (if org-log-note-previous-state
13489 (concat "\"" org-log-note-previous-state "\"")
13490 "\"\"")))))
13491 (if lines (setq note (concat note " \\\\")))
13492 (push note lines))
13493 (when (or current-prefix-arg org-note-abort)
13494 (when org-log-into-drawer
13495 (org-remove-empty-drawer-at org-log-note-marker))
13496 (setq lines nil))
13497 (when lines
13498 (with-current-buffer (marker-buffer org-log-note-marker)
13499 (save-excursion
13500 (goto-char org-log-note-marker)
13501 (move-marker org-log-note-marker nil)
13502 (end-of-line 1)
13503 (if (not (bolp)) (let ((inhibit-read-only t)) (insert "\n")))
13504 (setq ind (save-excursion
13505 (if (ignore-errors (goto-char (org-in-item-p)))
13506 (let ((struct (org-list-struct)))
13507 (org-list-get-ind
13508 (org-list-get-top-point struct) struct))
13509 (skip-chars-backward " \r\t\n")
13510 (cond
13511 ((and (org-at-heading-p)
13512 org-adapt-indentation)
13513 (1+ (org-current-level)))
13514 ((org-at-heading-p) 0)
13515 (t (org-get-indentation))))))
13516 (setq bul (org-list-bullet-string "-"))
13517 (org-indent-line-to ind)
13518 (insert bul (pop lines))
13519 (let ((ind-body (+ (length bul) ind)))
13520 (while lines
13521 (insert "\n")
13522 (org-indent-line-to ind-body)
13523 (insert (pop lines))))
13524 (message "Note stored")
13525 (org-back-to-heading t)
13526 (org-cycle-hide-drawers 'children))
13527 ;; Fix `buffer-undo-list' when `org-store-log-note' is called
13528 ;; from within `org-add-log-note' because `buffer-undo-list'
13529 ;; is then modified outside of `org-with-remote-undo'.
13530 (when (eq this-command 'org-agenda-todo)
13531 (setcdr buffer-undo-list (cddr buffer-undo-list)))))))
13532 ;; Don't add undo information when called from `org-agenda-todo'
13533 (let ((buffer-undo-list (eq this-command 'org-agenda-todo)))
13534 (set-window-configuration org-log-note-window-configuration)
13535 (with-current-buffer (marker-buffer org-log-note-return-to)
13536 (goto-char org-log-note-return-to))
13537 (move-marker org-log-note-return-to nil)
13538 (and org-log-post-message (message "%s" org-log-post-message))))
13540 (defun org-remove-empty-drawer-at (pos)
13541 "Remove an empty drawer at position POS.
13542 POS may also be a marker."
13543 (with-current-buffer (if (markerp pos) (marker-buffer pos) (current-buffer))
13544 (org-with-wide-buffer
13545 (goto-char pos)
13546 (let ((drawer (org-element-at-point)))
13547 (when (and (memq (org-element-type drawer) '(drawer property-drawer))
13548 (not (org-element-property :contents-begin drawer)))
13549 (delete-region (org-element-property :begin drawer)
13550 (progn (goto-char (org-element-property :end drawer))
13551 (skip-chars-backward " \r\t\n")
13552 (forward-line)
13553 (point))))))))
13555 (defvar org-ts-type nil)
13556 (defun org-sparse-tree (&optional arg type)
13557 "Create a sparse tree, prompt for the details.
13558 This command can create sparse trees. You first need to select the type
13559 of match used to create the tree:
13561 t Show all TODO entries.
13562 T Show entries with a specific TODO keyword.
13563 m Show entries selected by a tags/property match.
13564 p Enter a property name and its value (both with completion on existing
13565 names/values) and show entries with that property.
13566 r Show entries matching a regular expression (`/' can be used as well).
13567 b Show deadlines and scheduled items before a date.
13568 a Show deadlines and scheduled items after a date.
13569 d Show deadlines due within `org-deadline-warning-days'.
13570 D Show deadlines and scheduled items between a date range."
13571 (interactive "P")
13572 (let (ans kwd value ts-type)
13573 (setq type (or type org-sparse-tree-default-date-type))
13574 (setq org-ts-type type)
13575 (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"
13576 (cond ((eq type 'all) "all timestamps")
13577 ((eq type 'scheduled) "only scheduled")
13578 ((eq type 'deadline) "only deadline")
13579 ((eq type 'active) "only active timestamps")
13580 ((eq type 'inactive) "only inactive timestamps")
13581 ((eq type 'scheduled-or-deadline) "scheduled/deadline")
13582 ((eq type 'closed) "with a closed time-stamp")
13583 (t "scheduled/deadline")))
13584 (setq ans (read-char-exclusive))
13585 (cond
13586 ((equal ans ?c)
13587 (org-sparse-tree
13588 arg (cadr (member type '(scheduled-or-deadline
13589 all scheduled deadline active inactive closed)))))
13590 ((equal ans ?d)
13591 (call-interactively 'org-check-deadlines))
13592 ((equal ans ?b)
13593 (call-interactively 'org-check-before-date))
13594 ((equal ans ?a)
13595 (call-interactively 'org-check-after-date))
13596 ((equal ans ?D)
13597 (call-interactively 'org-check-dates-range))
13598 ((equal ans ?t)
13599 (call-interactively 'org-show-todo-tree))
13600 ((equal ans ?T)
13601 (org-show-todo-tree '(4)))
13602 ((member ans '(?T ?m))
13603 (call-interactively 'org-match-sparse-tree))
13604 ((member ans '(?p ?P))
13605 (setq kwd (org-icompleting-read "Property: "
13606 (mapcar 'list (org-buffer-property-keys))))
13607 (setq value (org-icompleting-read "Value: "
13608 (mapcar 'list (org-property-values kwd))))
13609 (unless (string-match "\\`{.*}\\'" value)
13610 (setq value (concat "\"" value "\"")))
13611 (org-match-sparse-tree arg (concat kwd "=" value)))
13612 ((member ans '(?r ?R ?/))
13613 (call-interactively 'org-occur))
13614 (t (user-error "No such sparse tree command \"%c\"" ans)))))
13616 (defvar org-occur-highlights nil
13617 "List of overlays used for occur matches.")
13618 (make-variable-buffer-local 'org-occur-highlights)
13619 (defvar org-occur-parameters nil
13620 "Parameters of the active org-occur calls.
13621 This is a list, each call to org-occur pushes as cons cell,
13622 containing the regular expression and the callback, onto the list.
13623 The list can contain several entries if `org-occur' has been called
13624 several time with the KEEP-PREVIOUS argument. Otherwise, this list
13625 will only contain one set of parameters. When the highlights are
13626 removed (for example with `C-c C-c', or with the next edit (depending
13627 on `org-remove-highlights-with-change'), this variable is emptied
13628 as well.")
13629 (make-variable-buffer-local 'org-occur-parameters)
13631 (defun org-occur (regexp &optional keep-previous callback)
13632 "Make a compact tree which shows all matches of REGEXP.
13633 The tree will show the lines where the regexp matches, and all higher
13634 headlines above the match. It will also show the heading after the match,
13635 to make sure editing the matching entry is easy.
13636 If KEEP-PREVIOUS is non-nil, highlighting and exposing done by a previous
13637 call to `org-occur' will be kept, to allow stacking of calls to this
13638 command.
13639 If CALLBACK is non-nil, it is a function which is called to confirm
13640 that the match should indeed be shown."
13641 (interactive "sRegexp: \nP")
13642 (when (equal regexp "")
13643 (user-error "Regexp cannot be empty"))
13644 (unless keep-previous
13645 (org-remove-occur-highlights nil nil t))
13646 (push (cons regexp callback) org-occur-parameters)
13647 (let ((cnt 0))
13648 (save-excursion
13649 (goto-char (point-min))
13650 (if (or (not keep-previous) ; do not want to keep
13651 (not org-occur-highlights)) ; no previous matches
13652 ;; hide everything
13653 (org-overview))
13654 (while (re-search-forward regexp nil t)
13655 (when (or (not callback)
13656 (save-match-data (funcall callback)))
13657 (setq cnt (1+ cnt))
13658 (when org-highlight-sparse-tree-matches
13659 (org-highlight-new-match (match-beginning 0) (match-end 0)))
13660 (org-show-context 'occur-tree))))
13661 (when org-remove-highlights-with-change
13662 (org-add-hook 'before-change-functions 'org-remove-occur-highlights
13663 nil 'local))
13664 (unless org-sparse-tree-open-archived-trees
13665 (org-hide-archived-subtrees (point-min) (point-max)))
13666 (run-hooks 'org-occur-hook)
13667 (if (org-called-interactively-p 'interactive)
13668 (message "%d match(es) for regexp %s" cnt regexp))
13669 cnt))
13671 (defun org-occur-next-match (&optional n reset)
13672 "Function for `next-error-function' to find sparse tree matches.
13673 N is the number of matches to move, when negative move backwards.
13674 RESET is entirely ignored - this function always goes back to the
13675 starting point when no match is found."
13676 (let* ((limit (if (< n 0) (point-min) (point-max)))
13677 (search-func (if (< n 0)
13678 'previous-single-char-property-change
13679 'next-single-char-property-change))
13680 (n (abs n))
13681 (pos (point))
13683 (catch 'exit
13684 (while (setq p1 (funcall search-func (point) 'org-type))
13685 (when (equal p1 limit)
13686 (goto-char pos)
13687 (error "No more matches"))
13688 (when (equal (get-char-property p1 'org-type) 'org-occur)
13689 (setq n (1- n))
13690 (when (= n 0)
13691 (goto-char p1)
13692 (throw 'exit (point))))
13693 (goto-char p1))
13694 (goto-char p1)
13695 (error "No more matches"))))
13697 (defun org-show-context (&optional key)
13698 "Make sure point and context are visible.
13699 How much context is shown depends upon the variables
13700 `org-show-hierarchy-above', `org-show-following-heading',
13701 `org-show-entry-below' and `org-show-siblings'."
13702 (let ((heading-p (org-at-heading-p t))
13703 (hierarchy-p (org-get-alist-option org-show-hierarchy-above key))
13704 (following-p (org-get-alist-option org-show-following-heading key))
13705 (entry-p (org-get-alist-option org-show-entry-below key))
13706 (siblings-p (org-get-alist-option org-show-siblings key)))
13707 ;; Show heading or entry text
13708 (if (and heading-p (not entry-p))
13709 (org-flag-heading nil) ; only show the heading
13710 (and (or entry-p (outline-invisible-p) (org-invisible-p2))
13711 (org-show-hidden-entry))) ; show entire entry
13712 (when following-p
13713 ;; Show next sibling, or heading below text
13714 (save-excursion
13715 (and (if heading-p (org-goto-sibling) (outline-next-heading))
13716 (org-flag-heading nil))))
13717 (when siblings-p (org-show-siblings))
13718 (when hierarchy-p
13719 ;; show all higher headings, possibly with siblings
13720 (save-excursion
13721 (while (and (condition-case nil
13722 (progn (org-up-heading-all 1) t)
13723 (error nil))
13724 (not (bobp)))
13725 (org-flag-heading nil)
13726 (when siblings-p (org-show-siblings)))))
13727 (unless (eq key 'agenda) (org-fix-ellipsis-at-bol))))
13729 (defvar org-reveal-start-hook nil
13730 "Hook run before revealing a location.")
13732 (defun org-reveal (&optional siblings)
13733 "Show current entry, hierarchy above it, and the following headline.
13734 This can be used to show a consistent set of context around locations
13735 exposed with `org-show-hierarchy-above' or `org-show-following-heading'
13736 not t for the search context.
13738 With optional argument SIBLINGS, on each level of the hierarchy all
13739 siblings are shown. This repairs the tree structure to what it would
13740 look like when opened with hierarchical calls to `org-cycle'.
13741 With double optional argument \\[universal-argument] \\[universal-argument], \
13742 go to the parent and show the
13743 entire tree."
13744 (interactive "P")
13745 (run-hooks 'org-reveal-start-hook)
13746 (let ((org-show-hierarchy-above t)
13747 (org-show-following-heading t)
13748 (org-show-siblings (if siblings t org-show-siblings)))
13749 (org-show-context nil))
13750 (when (equal siblings '(16))
13751 (save-excursion
13752 (when (org-up-heading-safe)
13753 (org-show-subtree)
13754 (run-hook-with-args 'org-cycle-hook 'subtree)))))
13756 (defun org-highlight-new-match (beg end)
13757 "Highlight from BEG to END and mark the highlight is an occur headline."
13758 (let ((ov (make-overlay beg end)))
13759 (overlay-put ov 'face 'secondary-selection)
13760 (overlay-put ov 'org-type 'org-occur)
13761 (push ov org-occur-highlights)))
13763 (defun org-remove-occur-highlights (&optional beg end noremove)
13764 "Remove the occur highlights from the buffer.
13765 BEG and END are ignored. If NOREMOVE is nil, remove this function
13766 from the `before-change-functions' in the current buffer."
13767 (interactive)
13768 (unless org-inhibit-highlight-removal
13769 (mapc 'delete-overlay org-occur-highlights)
13770 (setq org-occur-highlights nil)
13771 (setq org-occur-parameters nil)
13772 (unless noremove
13773 (remove-hook 'before-change-functions
13774 'org-remove-occur-highlights 'local))))
13776 ;;;; Priorities
13778 (defvar org-priority-regexp ".*?\\(\\[#\\([A-Z0-9]\\)\\] ?\\)"
13779 "Regular expression matching the priority indicator.")
13781 (defvar org-remove-priority-next-time nil)
13783 (defun org-priority-up ()
13784 "Increase the priority of the current item."
13785 (interactive)
13786 (org-priority 'up))
13788 (defun org-priority-down ()
13789 "Decrease the priority of the current item."
13790 (interactive)
13791 (org-priority 'down))
13793 (defun org-priority (&optional action show)
13794 "Change the priority of an item.
13795 ACTION can be `set', `up', `down', or a character."
13796 (interactive "P")
13797 (if (equal action '(4))
13798 (org-show-priority)
13799 (unless org-enable-priority-commands
13800 (user-error "Priority commands are disabled"))
13801 (setq action (or action 'set))
13802 (let (current new news have remove)
13803 (save-excursion
13804 (org-back-to-heading t)
13805 (if (looking-at org-priority-regexp)
13806 (setq current (string-to-char (match-string 2))
13807 have t))
13808 (cond
13809 ((eq action 'remove)
13810 (setq remove t new ?\ ))
13811 ((or (eq action 'set)
13812 (if (featurep 'xemacs) (characterp action) (integerp action)))
13813 (if (not (eq action 'set))
13814 (setq new action)
13815 (message "Priority %c-%c, SPC to remove: "
13816 org-highest-priority org-lowest-priority)
13817 (save-match-data
13818 (setq new (read-char-exclusive))))
13819 (if (and (= (upcase org-highest-priority) org-highest-priority)
13820 (= (upcase org-lowest-priority) org-lowest-priority))
13821 (setq new (upcase new)))
13822 (cond ((equal new ?\ ) (setq remove t))
13823 ((or (< (upcase new) org-highest-priority) (> (upcase new) org-lowest-priority))
13824 (user-error "Priority must be between `%c' and `%c'"
13825 org-highest-priority org-lowest-priority))))
13826 ((eq action 'up)
13827 (setq new (if have
13828 (1- current) ; normal cycling
13829 ;; last priority was empty
13830 (if (eq last-command this-command)
13831 org-lowest-priority ; wrap around empty to lowest
13832 ;; default
13833 (if org-priority-start-cycle-with-default
13834 org-default-priority
13835 (1- org-default-priority))))))
13836 ((eq action 'down)
13837 (setq new (if have
13838 (1+ current) ; normal cycling
13839 ;; last priority was empty
13840 (if (eq last-command this-command)
13841 org-highest-priority ; wrap around empty to highest
13842 ;; default
13843 (if org-priority-start-cycle-with-default
13844 org-default-priority
13845 (1+ org-default-priority))))))
13846 (t (user-error "Invalid action")))
13847 (if (or (< (upcase new) org-highest-priority)
13848 (> (upcase new) org-lowest-priority))
13849 (if (and (memq action '(up down))
13850 (not have) (not (eq last-command this-command)))
13851 ;; `new' is from default priority
13852 (error
13853 "The default can not be set, see `org-default-priority' why")
13854 ;; normal cycling: `new' is beyond highest/lowest priority
13855 ;; and is wrapped around to the empty priority
13856 (setq remove t)))
13857 (setq news (format "%c" new))
13858 (if have
13859 (if remove
13860 (replace-match "" t t nil 1)
13861 (replace-match news t t nil 2))
13862 (if remove
13863 (user-error "No priority cookie found in line")
13864 (let ((case-fold-search nil))
13865 (looking-at org-todo-line-regexp))
13866 (if (match-end 2)
13867 (progn
13868 (goto-char (match-end 2))
13869 (insert " [#" news "]"))
13870 (goto-char (match-beginning 3))
13871 (insert "[#" news "] "))))
13872 (org-set-tags nil 'align))
13873 (if remove
13874 (message "Priority removed")
13875 (message "Priority of current item set to %s" news)))))
13877 (defun org-show-priority ()
13878 "Show the priority of the current item.
13879 This priority is composed of the main priority given with the [#A] cookies,
13880 and by additional input from the age of a schedules or deadline entry."
13881 (interactive)
13882 (let ((pri (if (eq major-mode 'org-agenda-mode)
13883 (org-get-at-bol 'priority)
13884 (save-excursion
13885 (save-match-data
13886 (beginning-of-line)
13887 (and (looking-at org-heading-regexp)
13888 (org-get-priority (match-string 0))))))))
13889 (message "Priority is %d" (if pri pri -1000))))
13891 (defun org-get-priority (s)
13892 "Find priority cookie and return priority."
13893 (save-match-data
13894 (if (functionp org-get-priority-function)
13895 (funcall org-get-priority-function)
13896 (if (not (string-match org-priority-regexp s))
13897 (* 1000 (- org-lowest-priority org-default-priority))
13898 (* 1000 (- org-lowest-priority
13899 (string-to-char (match-string 2 s))))))))
13901 ;;;; Tags
13903 (defvar org-agenda-archives-mode)
13904 (defvar org-map-continue-from nil
13905 "Position from where mapping should continue.
13906 Can be set by the action argument to `org-scan-tags' and `org-map-entries'.")
13908 (defvar org-scanner-tags nil
13909 "The current tag list while the tags scanner is running.")
13910 (defvar org-trust-scanner-tags nil
13911 "Should `org-get-tags-at' use the tags for the scanner.
13912 This is for internal dynamical scoping only.
13913 When this is non-nil, the function `org-get-tags-at' will return the value
13914 of `org-scanner-tags' instead of building the list by itself. This
13915 can lead to large speed-ups when the tags scanner is used in a file with
13916 many entries, and when the list of tags is retrieved, for example to
13917 obtain a list of properties. Building the tags list for each entry in such
13918 a file becomes an N^2 operation - but with this variable set, it scales
13919 as N.")
13921 (defun org-scan-tags (action matcher todo-only &optional start-level)
13922 "Sca headline tags with inheritance and produce output ACTION.
13924 ACTION can be `sparse-tree' to produce a sparse tree in the current buffer,
13925 or `agenda' to produce an entry list for an agenda view. It can also be
13926 a Lisp form or a function that should be called at each matched headline, in
13927 this case the return value is a list of all return values from these calls.
13929 MATCHER is a Lisp form to be evaluated, testing if a given set of tags
13930 qualifies a headline for inclusion. When TODO-ONLY is non-nil,
13931 only lines with a not-done TODO keyword are included in the output.
13932 This should be the same variable that was scoped into
13933 and set by `org-make-tags-matcher' when it constructed MATCHER.
13935 START-LEVEL can be a string with asterisks, reducing the scope to
13936 headlines matching this string."
13937 (require 'org-agenda)
13938 (let* ((re (concat "^"
13939 (if start-level
13940 ;; Get the correct level to match
13941 (concat "\\*\\{" (number-to-string start-level) "\\} ")
13942 org-outline-regexp)
13943 " *\\(\\<\\("
13944 (mapconcat 'regexp-quote org-todo-keywords-1 "\\|")
13945 (org-re "\\)\\>\\)? *\\(.*?\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*$")))
13946 (props (list 'face 'default
13947 'done-face 'org-agenda-done
13948 'undone-face 'default
13949 'mouse-face 'highlight
13950 'org-not-done-regexp org-not-done-regexp
13951 'org-todo-regexp org-todo-regexp
13952 'org-complex-heading-regexp org-complex-heading-regexp
13953 'help-echo
13954 (format "mouse-2 or RET jump to org file %s"
13955 (abbreviate-file-name
13956 (or (buffer-file-name (buffer-base-buffer))
13957 (buffer-name (buffer-base-buffer)))))))
13958 (org-map-continue-from nil)
13959 lspos tags tags-list
13960 (tags-alist (list (cons 0 org-file-tags)))
13961 (llast 0) rtn rtn1 level category i txt
13962 todo marker entry priority)
13963 (when (not (or (member action '(agenda sparse-tree)) (functionp action)))
13964 (setq action (list 'lambda nil action)))
13965 (save-excursion
13966 (goto-char (point-min))
13967 (when (eq action 'sparse-tree)
13968 (org-overview)
13969 (org-remove-occur-highlights))
13970 (while (let (case-fold-search)
13971 (re-search-forward re nil t))
13972 (setq org-map-continue-from nil)
13973 (catch :skip
13974 (setq todo (if (match-end 1) (org-match-string-no-properties 2))
13975 tags (if (match-end 4) (org-match-string-no-properties 4)))
13976 (goto-char (setq lspos (match-beginning 0)))
13977 (setq level (org-reduced-level (org-outline-level))
13978 category (org-get-category))
13979 (setq i llast llast level)
13980 ;; remove tag lists from same and sublevels
13981 (while (>= i level)
13982 (when (setq entry (assoc i tags-alist))
13983 (setq tags-alist (delete entry tags-alist)))
13984 (setq i (1- i)))
13985 ;; add the next tags
13986 (when tags
13987 (setq tags (org-split-string tags ":")
13988 tags-alist
13989 (cons (cons level tags) tags-alist)))
13990 ;; compile tags for current headline
13991 (setq tags-list
13992 (if org-use-tag-inheritance
13993 (apply 'append (mapcar 'cdr (reverse tags-alist)))
13994 tags)
13995 org-scanner-tags tags-list)
13996 (when org-use-tag-inheritance
13997 (setcdr (car tags-alist)
13998 (mapcar (lambda (x)
13999 (setq x (copy-sequence x))
14000 (org-add-prop-inherited x))
14001 (cdar tags-alist))))
14002 (when (and tags org-use-tag-inheritance
14003 (or (not (eq t org-use-tag-inheritance))
14004 org-tags-exclude-from-inheritance))
14005 ;; selective inheritance, remove uninherited ones
14006 (setcdr (car tags-alist)
14007 (org-remove-uninherited-tags (cdar tags-alist))))
14008 (when (and
14010 ;; eval matcher only when the todo condition is OK
14011 (and (or (not todo-only) (member todo org-not-done-keywords))
14012 (let ((case-fold-search t) (org-trust-scanner-tags t))
14013 (eval matcher)))
14015 ;; Call the skipper, but return t if it does not skip,
14016 ;; so that the `and' form continues evaluating
14017 (progn
14018 (unless (eq action 'sparse-tree) (org-agenda-skip))
14021 ;; Check if timestamps are deselecting this entry
14022 (or (not todo-only)
14023 (and (member todo org-not-done-keywords)
14024 (or (not org-agenda-tags-todo-honor-ignore-options)
14025 (not (org-agenda-check-for-timestamp-as-reason-to-ignore-todo-item))))))
14027 ;; select this headline
14028 (cond
14029 ((eq action 'sparse-tree)
14030 (and org-highlight-sparse-tree-matches
14031 (org-get-heading) (match-end 0)
14032 (org-highlight-new-match
14033 (match-beginning 1) (match-end 1)))
14034 (org-show-context 'tags-tree))
14035 ((eq action 'agenda)
14036 (setq txt (org-agenda-format-item
14038 (concat
14039 (if (eq org-tags-match-list-sublevels 'indented)
14040 (make-string (1- level) ?.) "")
14041 (org-get-heading))
14042 level category
14043 tags-list)
14044 priority (org-get-priority txt))
14045 (goto-char lspos)
14046 (setq marker (org-agenda-new-marker))
14047 (org-add-props txt props
14048 'org-marker marker 'org-hd-marker marker 'org-category category
14049 'todo-state todo
14050 'priority priority 'type "tagsmatch")
14051 (push txt rtn))
14052 ((functionp action)
14053 (setq org-map-continue-from nil)
14054 (save-excursion
14055 (setq rtn1 (funcall action))
14056 (push rtn1 rtn)))
14057 (t (user-error "Invalid action")))
14059 ;; if we are to skip sublevels, jump to end of subtree
14060 (unless org-tags-match-list-sublevels
14061 (org-end-of-subtree t)
14062 (backward-char 1))))
14063 ;; Get the correct position from where to continue
14064 (if org-map-continue-from
14065 (goto-char org-map-continue-from)
14066 (and (= (point) lspos) (end-of-line 1)))))
14067 (when (and (eq action 'sparse-tree)
14068 (not org-sparse-tree-open-archived-trees))
14069 (org-hide-archived-subtrees (point-min) (point-max)))
14070 (nreverse rtn)))
14072 (defun org-remove-uninherited-tags (tags)
14073 "Remove all tags that are not inherited from the list TAGS."
14074 (cond
14075 ((eq org-use-tag-inheritance t)
14076 (if org-tags-exclude-from-inheritance
14077 (org-delete-all org-tags-exclude-from-inheritance tags)
14078 tags))
14079 ((not org-use-tag-inheritance) nil)
14080 ((stringp org-use-tag-inheritance)
14081 (delq nil (mapcar
14082 (lambda (x)
14083 (if (and (string-match org-use-tag-inheritance x)
14084 (not (member x org-tags-exclude-from-inheritance)))
14085 x nil))
14086 tags)))
14087 ((listp org-use-tag-inheritance)
14088 (delq nil (mapcar
14089 (lambda (x)
14090 (if (member x org-use-tag-inheritance) x nil))
14091 tags)))))
14093 (defun org-match-sparse-tree (&optional todo-only match)
14094 "Create a sparse tree according to tags string MATCH.
14095 MATCH can contain positive and negative selection of tags, like
14096 \"+WORK+URGENT-WITHBOSS\".
14097 If optional argument TODO-ONLY is non-nil, only select lines that are
14098 also TODO lines."
14099 (interactive "P")
14100 (org-agenda-prepare-buffers (list (current-buffer)))
14101 (org-scan-tags 'sparse-tree (cdr (org-make-tags-matcher match)) todo-only))
14103 (defalias 'org-tags-sparse-tree 'org-match-sparse-tree)
14105 (defvar org-cached-props nil)
14106 (defun org-cached-entry-get (pom property)
14107 (if (or (eq t org-use-property-inheritance)
14108 (and (stringp org-use-property-inheritance)
14109 (string-match org-use-property-inheritance property))
14110 (and (listp org-use-property-inheritance)
14111 (member property org-use-property-inheritance)))
14112 ;; Caching is not possible, check it directly
14113 (org-entry-get pom property 'inherit)
14114 ;; Get all properties, so that we can do complicated checks easily
14115 (cdr (assoc property (or org-cached-props
14116 (setq org-cached-props
14117 (org-entry-properties pom)))))))
14119 (defun org-global-tags-completion-table (&optional files)
14120 "Return the list of all tags in all agenda buffer/files.
14121 Optional FILES argument is a list of files which can be used
14122 instead of the agenda files."
14123 (save-excursion
14124 (org-uniquify
14125 (delq nil
14126 (apply 'append
14127 (mapcar
14128 (lambda (file)
14129 (set-buffer (find-file-noselect file))
14130 (append (org-get-buffer-tags)
14131 (mapcar (lambda (x) (if (stringp (car-safe x))
14132 (list (car-safe x)) nil))
14133 org-tag-alist)))
14134 (if (and files (car files))
14135 files
14136 (org-agenda-files))))))))
14138 (defun org-make-tags-matcher (match)
14139 "Create the TAGS/TODO matcher form for the selection string MATCH.
14141 The variable `todo-only' is scoped dynamically into this function.
14142 It will be set to t if the matcher restricts matching to TODO entries,
14143 otherwise will not be touched.
14145 Returns a cons of the selection string MATCH and the constructed
14146 lisp form implementing the matcher. The matcher is to be evaluated
14147 at an Org entry, with point on the headline, and returns t if the
14148 entry matches the selection string MATCH. The returned lisp form
14149 references two variables with information about the entry, which
14150 must be bound around the form's evaluation: todo, the TODO keyword
14151 at the entry (or nil of none); and tags-list, the list of all tags
14152 at the entry including inherited ones. Additionally, the category
14153 of the entry (if any) must be specified as the text property
14154 'org-category on the headline.
14156 See also `org-scan-tags'.
14158 (declare (special todo-only))
14159 (unless (boundp 'todo-only)
14160 (error "`org-make-tags-matcher' expects todo-only to be scoped in"))
14161 (unless match
14162 ;; Get a new match request, with completion against the global
14163 ;; tags table and the local tags in current buffer
14164 (let ((org-last-tags-completion-table
14165 (org-uniquify
14166 (delq nil (append (org-get-buffer-tags)
14167 (org-global-tags-completion-table))))))
14168 (setq match (org-completing-read-no-i
14169 "Match: " 'org-tags-completion-function nil nil nil
14170 'org-tags-history))))
14172 ;; Parse the string and create a lisp form
14173 (let ((match0 match)
14174 (re (org-re "^&?\\([-+:]\\)?\\({[^}]+}\\|LEVEL\\([<=>]\\{1,2\\}\\)\\([0-9]+\\)\\|\\(\\(?:[[:alnum:]_]+\\(?:\\\\-\\)*\\)+\\)\\([<>=]\\{1,2\\}\\)\\({[^}]+}\\|\"[^\"]*\"\\|-?[.0-9]+\\(?:[eE][-+]?[0-9]+\\)?\\)\\|[[:alnum:]_@#%]+\\)"))
14175 minus tag mm
14176 tagsmatch todomatch tagsmatcher todomatcher kwd matcher
14177 orterms term orlist re-p str-p level-p level-op time-p
14178 prop-p pn pv po gv rest (start 0) (ss 0))
14179 ;; Expand group tags
14180 (setq match (org-tags-expand match))
14182 ;; Check if there is a TODO part of this match, which would be the
14183 ;; part after a "/". TO make sure that this slash is not part of
14184 ;; a property value to be matched against, we also check that there
14185 ;; is no " after that slash.
14186 ;; First, find the last slash
14187 (while (string-match "/+" match ss)
14188 (setq start (match-beginning 0) ss (match-end 0)))
14189 (if (and (string-match "/+" match start)
14190 (not (save-match-data (string-match "\"" match start))))
14191 ;; match contains also a todo-matching request
14192 (progn
14193 (setq tagsmatch (substring match 0 (match-beginning 0))
14194 todomatch (substring match (match-end 0)))
14195 (if (string-match "^!" todomatch)
14196 (setq todo-only t todomatch (substring todomatch 1)))
14197 (if (string-match "^\\s-*$" todomatch)
14198 (setq todomatch nil)))
14199 ;; only matching tags
14200 (setq tagsmatch match todomatch nil))
14202 ;; Make the tags matcher
14203 (if (or (not tagsmatch) (not (string-match "\\S-" tagsmatch)))
14204 (setq tagsmatcher t)
14205 (setq orterms (org-split-string tagsmatch "|") orlist nil)
14206 (while (setq term (pop orterms))
14207 (while (and (equal (substring term -1) "\\") orterms)
14208 (setq term (concat term "|" (pop orterms)))) ; repair bad split
14209 (while (string-match re term)
14210 (setq rest (substring term (match-end 0))
14211 minus (and (match-end 1)
14212 (equal (match-string 1 term) "-"))
14213 tag (save-match-data (replace-regexp-in-string
14214 "\\\\-" "-"
14215 (match-string 2 term)))
14216 re-p (equal (string-to-char tag) ?{)
14217 level-p (match-end 4)
14218 prop-p (match-end 5)
14219 mm (cond
14220 (re-p `(org-match-any-p ,(substring tag 1 -1) tags-list))
14221 (level-p
14222 (setq level-op (org-op-to-function (match-string 3 term)))
14223 `(,level-op level ,(string-to-number
14224 (match-string 4 term))))
14225 (prop-p
14226 (setq pn (match-string 5 term)
14227 po (match-string 6 term)
14228 pv (match-string 7 term)
14229 re-p (equal (string-to-char pv) ?{)
14230 str-p (equal (string-to-char pv) ?\")
14231 time-p (save-match-data
14232 (string-match "^\"[[<].*[]>]\"$" pv))
14233 pv (if (or re-p str-p) (substring pv 1 -1) pv))
14234 (if time-p (setq pv (org-matcher-time pv)))
14235 (setq po (org-op-to-function po (if time-p 'time str-p)))
14236 (cond
14237 ((equal pn "CATEGORY")
14238 (setq gv '(get-text-property (point) 'org-category)))
14239 ((equal pn "TODO")
14240 (setq gv 'todo))
14242 (setq gv `(org-cached-entry-get nil ,pn))))
14243 (if re-p
14244 (if (eq po 'org<>)
14245 `(not (string-match ,pv (or ,gv "")))
14246 `(string-match ,pv (or ,gv "")))
14247 (if str-p
14248 `(,po (or ,gv "") ,pv)
14249 `(,po (string-to-number (or ,gv ""))
14250 ,(string-to-number pv) ))))
14251 (t `(member ,tag tags-list)))
14252 mm (if minus (list 'not mm) mm)
14253 term rest)
14254 (push mm tagsmatcher))
14255 (push (if (> (length tagsmatcher) 1)
14256 (cons 'and tagsmatcher)
14257 (car tagsmatcher))
14258 orlist)
14259 (setq tagsmatcher nil))
14260 (setq tagsmatcher (if (> (length orlist) 1) (cons 'or orlist) (car orlist)))
14261 (setq tagsmatcher
14262 (list 'progn '(setq org-cached-props nil) tagsmatcher)))
14263 ;; Make the todo matcher
14264 (if (or (not todomatch) (not (string-match "\\S-" todomatch)))
14265 (setq todomatcher t)
14266 (setq orterms (org-split-string todomatch "|") orlist nil)
14267 (while (setq term (pop orterms))
14268 (while (string-match re term)
14269 (setq minus (and (match-end 1)
14270 (equal (match-string 1 term) "-"))
14271 kwd (match-string 2 term)
14272 re-p (equal (string-to-char kwd) ?{)
14273 term (substring term (match-end 0))
14274 mm (if re-p
14275 `(string-match ,(substring kwd 1 -1) todo)
14276 (list 'equal 'todo kwd))
14277 mm (if minus (list 'not mm) mm))
14278 (push mm todomatcher))
14279 (push (if (> (length todomatcher) 1)
14280 (cons 'and todomatcher)
14281 (car todomatcher))
14282 orlist)
14283 (setq todomatcher nil))
14284 (setq todomatcher (if (> (length orlist) 1)
14285 (cons 'or orlist) (car orlist))))
14287 ;; Return the string and lisp forms of the matcher
14288 (setq matcher (if todomatcher
14289 (list 'and tagsmatcher todomatcher)
14290 tagsmatcher))
14291 (when todo-only
14292 (setq matcher (list 'and '(member todo org-not-done-keywords)
14293 matcher)))
14294 (cons match0 matcher)))
14296 (defun org-tags-expand (match &optional single-as-list downcased)
14297 "Expand group tags in MATCH.
14299 This replaces every group tag in MATCH with a regexp tag search.
14300 For example, a group tag \"Work\" defined as { Work : Lab Conf }
14301 will be replaced like this:
14303 Work => {\\(?:Work\\|Lab\\|Conf\\)}
14304 +Work => +{\\(?:Work\\|Lab\\|Conf\\)}
14305 -Work => -{\\(?:Work\\|Lab\\|Conf\\)}
14307 Replacing by a regexp preserves the structure of the match.
14308 E.g., this expansion
14310 Work|Home => {\\(?:Work\\|Lab\\|Conf\\}|Home
14312 will match anything tagged with \"Lab\" and \"Home\", or tagged
14313 with \"Conf\" and \"Home\" or tagged with \"Work\" and \"home\".
14315 When the optional argument SINGLE-AS-LIST is non-nil, MATCH is
14316 assumed to be a single group tag, and the function will return
14317 the list of tags in this group.
14319 When DOWNCASE is non-nil, expand downcased TAGS."
14320 (if org-group-tags
14321 (let* ((case-fold-search t)
14322 (stable org-mode-syntax-table)
14323 (tal (or org-tag-groups-alist-for-agenda
14324 org-tag-groups-alist))
14325 (tal (if downcased
14326 (mapcar (lambda(tg) (mapcar 'downcase tg)) tal) tal))
14327 (tml (mapcar 'car tal))
14328 (rtnmatch match) rpl)
14329 ;; @ and _ are allowed as word-components in tags
14330 (modify-syntax-entry ?@ "w" stable)
14331 (modify-syntax-entry ?_ "w" stable)
14332 (while (and tml
14333 (with-syntax-table stable
14334 (string-match
14335 (concat "\\(?1:[+-]?\\)\\(?2:\\<"
14336 (regexp-opt tml) "\\>\\)") rtnmatch)))
14337 (let* ((dir (match-string 1 rtnmatch))
14338 (tag (match-string 2 rtnmatch))
14339 (tag (if downcased (downcase tag) tag)))
14340 (setq tml (delete tag tml))
14341 (when (not (get-text-property 0 'grouptag (match-string 2 rtnmatch)))
14342 (setq rpl (append (org-uniquify rpl) (assoc tag tal)))
14343 (setq rpl (concat dir "{\\<" (regexp-opt rpl) "\\>}"))
14344 (if (stringp rpl) (org-add-props rpl '(grouptag t)))
14345 (setq rtnmatch (replace-match rpl t t rtnmatch)))))
14346 (if single-as-list
14347 (or (reverse rpl) (list rtnmatch))
14348 rtnmatch))
14349 (if single-as-list (list (if downcased (downcase match) match))
14350 match)))
14352 (defun org-op-to-function (op &optional stringp)
14353 "Turn an operator into the appropriate function."
14354 (setq op
14355 (cond
14356 ((equal op "<" ) '(< string< org-time<))
14357 ((equal op ">" ) '(> org-string> org-time>))
14358 ((member op '("<=" "=<")) '(<= org-string<= org-time<=))
14359 ((member op '(">=" "=>")) '(>= org-string>= org-time>=))
14360 ((member op '("=" "==")) '(= string= org-time=))
14361 ((member op '("<>" "!=")) '(org<> org-string<> org-time<>))))
14362 (nth (if (eq stringp 'time) 2 (if stringp 1 0)) op))
14364 (defun org<> (a b) (not (= a b)))
14365 (defun org-string<= (a b) (or (string= a b) (string< a b)))
14366 (defun org-string>= (a b) (not (string< a b)))
14367 (defun org-string> (a b) (and (not (string= a b)) (not (string< a b))))
14368 (defun org-string<> (a b) (not (string= a b)))
14369 (defun org-time= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (= a b)))
14370 (defun org-time< (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (< a b)))
14371 (defun org-time<= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (<= a b)))
14372 (defun org-time> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (> a b)))
14373 (defun org-time>= (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (>= a b)))
14374 (defun org-time<> (a b) (setq a (org-2ft a) b (org-2ft b)) (and (> a 0) (> b 0) (org<> a b)))
14375 (defun org-2ft (s)
14376 "Convert S to a floating point time.
14377 If S is already a number, just return it. If it is a string, parse
14378 it as a time string and apply `float-time' to it. If S is nil, just return 0."
14379 (cond
14380 ((numberp s) s)
14381 ((stringp s)
14382 (condition-case nil
14383 (float-time (apply 'encode-time (org-parse-time-string s)))
14384 (error 0.)))
14385 (t 0.)))
14387 (defun org-time-today ()
14388 "Time in seconds today at 0:00.
14389 Returns the float number of seconds since the beginning of the
14390 epoch to the beginning of today (00:00)."
14391 (float-time (apply 'encode-time
14392 (append '(0 0 0) (nthcdr 3 (decode-time))))))
14394 (defun org-matcher-time (s)
14395 "Interpret a time comparison value."
14396 (save-match-data
14397 (cond
14398 ((string= s "<now>") (float-time))
14399 ((string= s "<today>") (org-time-today))
14400 ((string= s "<tomorrow>") (+ 86400.0 (org-time-today)))
14401 ((string= s "<yesterday>") (- (org-time-today) 86400.0))
14402 ((string-match "^<\\([-+][0-9]+\\)\\([hdwmy]\\)>$" s)
14403 (+ (org-time-today)
14404 (* (string-to-number (match-string 1 s))
14405 (cdr (assoc (match-string 2 s)
14406 '(("d" . 86400.0) ("w" . 604800.0)
14407 ("m" . 2678400.0) ("y" . 31557600.0)))))))
14408 (t (org-2ft s)))))
14410 (defun org-match-any-p (re list)
14411 "Does re match any element of list?"
14412 (setq list (mapcar (lambda (x) (string-match re x)) list))
14413 (delq nil list))
14415 (defvar org-add-colon-after-tag-completion nil) ;; dynamically scoped param
14416 (defvar org-tags-overlay (make-overlay 1 1))
14417 (org-detach-overlay org-tags-overlay)
14419 (defun org-get-local-tags-at (&optional pos)
14420 "Get a list of tags defined in the current headline."
14421 (org-get-tags-at pos 'local))
14423 (defun org-get-local-tags ()
14424 "Get a list of tags defined in the current headline."
14425 (org-get-tags-at nil 'local))
14427 (defun org-get-tags-at (&optional pos local)
14428 "Get a list of all headline tags applicable at POS.
14429 POS defaults to point. If tags are inherited, the list contains
14430 the targets in the same sequence as the headlines appear, i.e.
14431 the tags of the current headline come last.
14432 When LOCAL is non-nil, only return tags from the current headline,
14433 ignore inherited ones."
14434 (interactive)
14435 (if (and org-trust-scanner-tags
14436 (or (not pos) (equal pos (point)))
14437 (not local))
14438 org-scanner-tags
14439 (let (tags ltags lastpos parent)
14440 (save-excursion
14441 (save-restriction
14442 (widen)
14443 (goto-char (or pos (point)))
14444 (save-match-data
14445 (catch 'done
14446 (condition-case nil
14447 (progn
14448 (org-back-to-heading t)
14449 (while (not (equal lastpos (point)))
14450 (setq lastpos (point))
14451 (when (looking-at
14452 (org-re "[^\r\n]+?:\\([[:alnum:]_@#%:]+\\):[ \t]*$"))
14453 (setq ltags (org-split-string
14454 (org-match-string-no-properties 1) ":"))
14455 (when parent
14456 (setq ltags (mapcar 'org-add-prop-inherited ltags)))
14457 (setq tags (append
14458 (if parent
14459 (org-remove-uninherited-tags ltags)
14460 ltags)
14461 tags)))
14462 (or org-use-tag-inheritance (throw 'done t))
14463 (if local (throw 'done t))
14464 (or (org-up-heading-safe) (error nil))
14465 (setq parent t)))
14466 (error nil)))))
14467 (if local
14468 tags
14469 (reverse (delete-dups
14470 (reverse (append
14471 (org-remove-uninherited-tags
14472 org-file-tags) tags)))))))))
14474 (defun org-add-prop-inherited (s)
14475 (add-text-properties 0 (length s) '(inherited t) s)
14478 (defun org-toggle-tag (tag &optional onoff)
14479 "Toggle the tag TAG for the current line.
14480 If ONOFF is `on' or `off', don't toggle but set to this state."
14481 (let (res current)
14482 (save-excursion
14483 (org-back-to-heading t)
14484 (if (re-search-forward (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t]*$")
14485 (point-at-eol) t)
14486 (progn
14487 (setq current (match-string 1))
14488 (replace-match ""))
14489 (setq current ""))
14490 (setq current (nreverse (org-split-string current ":")))
14491 (cond
14492 ((eq onoff 'on)
14493 (setq res t)
14494 (or (member tag current) (push tag current)))
14495 ((eq onoff 'off)
14496 (or (not (member tag current)) (setq current (delete tag current))))
14497 (t (if (member tag current)
14498 (setq current (delete tag current))
14499 (setq res t)
14500 (push tag current))))
14501 (end-of-line 1)
14502 (if current
14503 (progn
14504 (insert " :" (mapconcat 'identity (nreverse current) ":") ":")
14505 (org-set-tags nil t))
14506 (delete-horizontal-space))
14507 (run-hooks 'org-after-tags-change-hook))
14508 res))
14510 (defun org-align-tags-here (to-col)
14511 ;; Assumes that this is a headline
14512 (let ((pos (point)) (col (current-column)) ncol tags-l p)
14513 (beginning-of-line 1)
14514 (if (and (looking-at (org-re ".*?\\([ \t]+\\)\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14515 (< pos (match-beginning 2)))
14516 (progn
14517 (setq tags-l (- (match-end 2) (match-beginning 2)))
14518 (goto-char (match-beginning 1))
14519 (insert " ")
14520 (delete-region (point) (1+ (match-beginning 2)))
14521 (setq ncol (max (current-column)
14522 (1+ col)
14523 (if (> to-col 0)
14524 to-col
14525 (- (abs to-col) tags-l))))
14526 (setq p (point))
14527 (insert (make-string (- ncol (current-column)) ?\ ))
14528 (setq ncol (current-column))
14529 (when indent-tabs-mode (tabify p (point-at-eol)))
14530 (org-move-to-column (min ncol col) t nil t))
14531 (goto-char pos))))
14533 (defun org-set-tags-command (&optional arg just-align)
14534 "Call the set-tags command for the current entry."
14535 (interactive "P")
14536 (if (or (org-at-heading-p) (and arg (org-before-first-heading-p)))
14537 (org-set-tags arg just-align)
14538 (save-excursion
14539 (unless (and (org-region-active-p)
14540 org-loop-over-headlines-in-active-region)
14541 (org-back-to-heading t))
14542 (org-set-tags arg just-align))))
14544 (defun org-set-tags-to (data)
14545 "Set the tags of the current entry to DATA, replacing the current tags.
14546 DATA may be a tags string like :aa:bb:cc:, or a list of tags.
14547 If DATA is nil or the empty string, any tags will be removed."
14548 (interactive "sTags: ")
14549 (setq data
14550 (cond
14551 ((eq data nil) "")
14552 ((equal data "") "")
14553 ((stringp data)
14554 (concat ":" (mapconcat 'identity (org-split-string data ":+") ":")
14555 ":"))
14556 ((listp data)
14557 (concat ":" (mapconcat 'identity data ":") ":"))))
14558 (when data
14559 (save-excursion
14560 (org-back-to-heading t)
14561 (when (looking-at org-complex-heading-regexp)
14562 (if (match-end 5)
14563 (progn
14564 (goto-char (match-beginning 5))
14565 (insert data)
14566 (delete-region (point) (point-at-eol))
14567 (org-set-tags nil 'align))
14568 (goto-char (point-at-eol))
14569 (insert " " data)
14570 (org-set-tags nil 'align)))
14571 (beginning-of-line 1)
14572 (if (looking-at ".*?\\([ \t]+\\)$")
14573 (delete-region (match-beginning 1) (match-end 1))))))
14575 (defun org-align-all-tags ()
14576 "Align the tags i all headings."
14577 (interactive)
14578 (save-excursion
14579 (or (ignore-errors (org-back-to-heading t))
14580 (outline-next-heading))
14581 (if (org-at-heading-p)
14582 (org-set-tags t)
14583 (message "No headings"))))
14585 (defvar org-indent-indentation-per-level)
14586 (defun org-set-tags (&optional arg just-align)
14587 "Set the tags for the current headline.
14588 With prefix ARG, realign all tags in headings in the current buffer.
14589 When JUST-ALIGN is non-nil, only align tags.
14590 When JUST-ALIGN is 'ignore-column, align tags without trying to set
14591 the column by ignoring invisible text."
14592 (interactive "P")
14593 (if (and (org-region-active-p) org-loop-over-headlines-in-active-region)
14594 (let ((cl (if (eq org-loop-over-headlines-in-active-region 'start-level)
14595 'region-start-level 'region))
14596 org-loop-over-headlines-in-active-region)
14597 (org-map-entries
14598 ;; We don't use ARG and JUST-ALIGN here because these args
14599 ;; are not useful when looping over headlines.
14600 `(org-set-tags)
14601 org-loop-over-headlines-in-active-region
14602 cl (if (outline-invisible-p) (org-end-of-subtree nil t))))
14603 (let* ((re org-outline-regexp-bol)
14604 (current (unless arg (org-get-tags-string)))
14605 (col (current-column))
14606 (org-setting-tags t)
14607 table current-tags inherited-tags ; computed below when needed
14608 tags p0 c0 c1 rpl di tc level)
14609 (if arg
14610 (save-excursion
14611 (goto-char (point-min))
14612 (let ((buffer-invisibility-spec (org-inhibit-invisibility)))
14613 (while (re-search-forward re nil t)
14614 (org-set-tags nil t)
14615 (end-of-line 1)))
14616 (message "All tags realigned to column %d" org-tags-column))
14617 (if just-align
14618 (setq tags current)
14619 ;; Get a new set of tags from the user
14620 (save-excursion
14621 (setq table (append org-tag-persistent-alist
14622 (or org-tag-alist (org-get-buffer-tags))
14623 (and
14624 org-complete-tags-always-offer-all-agenda-tags
14625 (org-global-tags-completion-table
14626 (org-agenda-files))))
14627 org-last-tags-completion-table table
14628 current-tags (org-split-string current ":")
14629 inherited-tags (nreverse
14630 (nthcdr (length current-tags)
14631 (nreverse (org-get-tags-at))))
14632 tags
14633 (if (or (eq t org-use-fast-tag-selection)
14634 (and org-use-fast-tag-selection
14635 (delq nil (mapcar 'cdr table))))
14636 (org-fast-tag-selection
14637 current-tags inherited-tags table
14638 (if org-fast-tag-selection-include-todo
14639 org-todo-key-alist))
14640 (let ((org-add-colon-after-tag-completion (< 1 (length table))))
14641 (org-trim
14642 (org-icompleting-read "Tags: "
14643 'org-tags-completion-function
14644 nil nil current 'org-tags-history))))))
14645 (while (string-match "[-+&]+" tags)
14646 ;; No boolean logic, just a list
14647 (setq tags (replace-match ":" t t tags))))
14649 (setq tags (replace-regexp-in-string "[,]" ":" tags))
14651 (if org-tags-sort-function
14652 (setq tags (mapconcat 'identity
14653 (sort (org-split-string
14654 tags (org-re "[^[:alnum:]_@#%]+"))
14655 org-tags-sort-function) ":")))
14657 (if (string-match "\\`[\t ]*\\'" tags)
14658 (setq tags "")
14659 (unless (string-match ":$" tags) (setq tags (concat tags ":")))
14660 (unless (string-match "^:" tags) (setq tags (concat ":" tags))))
14662 ;; Insert new tags at the correct column
14663 (beginning-of-line 1)
14664 (setq level (or (and (looking-at org-outline-regexp)
14665 (- (match-end 0) (point) 1))
14667 (cond
14668 ((and (equal current "") (equal tags "")))
14669 ((re-search-forward
14670 (concat "\\([ \t]*" (regexp-quote current) "\\)[ \t]*$")
14671 (point-at-eol) t)
14672 (if (equal tags "")
14673 (setq rpl "")
14674 (goto-char (match-beginning 0))
14675 (setq c0 (current-column)
14676 ;; compute offset for the case of org-indent-mode active
14677 di (if (org-bound-and-true-p org-indent-mode)
14678 (* (1- org-indent-indentation-per-level) (1- level))
14680 p0 (if (equal (char-before) ?*) (1+ (point)) (point))
14681 tc (+ org-tags-column (if (> org-tags-column 0) (- di) di))
14682 c1 (max (1+ c0) (if (> tc 0) tc (- (- tc) (string-width tags))))
14683 rpl (concat (make-string (max 0 (- c1 c0)) ?\ ) tags)))
14684 (replace-match rpl t t)
14685 (and (not (featurep 'xemacs)) c0 indent-tabs-mode (tabify p0 (point)))
14686 tags)
14687 (t (error "Tags alignment failed")))
14688 (org-move-to-column col nil nil (not (eq just-align 'ignore-column)))
14689 (unless just-align
14690 (run-hooks 'org-after-tags-change-hook))))))
14692 (defun org-change-tag-in-region (beg end tag off)
14693 "Add or remove TAG for each entry in the region.
14694 This works in the agenda, and also in an org-mode buffer."
14695 (interactive
14696 (list (region-beginning) (region-end)
14697 (let ((org-last-tags-completion-table
14698 (if (derived-mode-p 'org-mode)
14699 (org-uniquify
14700 (delq nil (append (org-get-buffer-tags)
14701 (org-global-tags-completion-table))))
14702 (org-global-tags-completion-table))))
14703 (org-icompleting-read
14704 "Tag: " 'org-tags-completion-function nil nil nil
14705 'org-tags-history))
14706 (progn
14707 (message "[s]et or [r]emove? ")
14708 (equal (read-char-exclusive) ?r))))
14709 (if (fboundp 'deactivate-mark) (deactivate-mark))
14710 (let ((agendap (equal major-mode 'org-agenda-mode))
14711 l1 l2 m buf pos newhead (cnt 0))
14712 (goto-char end)
14713 (setq l2 (1- (org-current-line)))
14714 (goto-char beg)
14715 (setq l1 (org-current-line))
14716 (loop for l from l1 to l2 do
14717 (org-goto-line l)
14718 (setq m (get-text-property (point) 'org-hd-marker))
14719 (when (or (and (derived-mode-p 'org-mode) (org-at-heading-p))
14720 (and agendap m))
14721 (setq buf (if agendap (marker-buffer m) (current-buffer))
14722 pos (if agendap m (point)))
14723 (with-current-buffer buf
14724 (save-excursion
14725 (save-restriction
14726 (goto-char pos)
14727 (setq cnt (1+ cnt))
14728 (org-toggle-tag tag (if off 'off 'on))
14729 (setq newhead (org-get-heading)))))
14730 (and agendap (org-agenda-change-all-lines newhead m))))
14731 (message "Tag :%s: %s in %d headings" tag (if off "removed" "set") cnt)))
14733 (defun org-tags-completion-function (string predicate &optional flag)
14734 (let (s1 s2 rtn (ctable org-last-tags-completion-table)
14735 (confirm (lambda (x) (stringp (car x)))))
14736 (if (string-match "^\\(.*[-+:&,|]\\)\\([^-+:&,|]*\\)$" string)
14737 (setq s1 (match-string 1 string)
14738 s2 (match-string 2 string))
14739 (setq s1 "" s2 string))
14740 (cond
14741 ((eq flag nil)
14742 ;; try completion
14743 (setq rtn (try-completion s2 ctable confirm))
14744 (if (stringp rtn)
14745 (setq rtn
14746 (concat s1 s2 (substring rtn (length s2))
14747 (if (and org-add-colon-after-tag-completion
14748 (assoc rtn ctable))
14749 ":" ""))))
14750 rtn)
14751 ((eq flag t)
14752 ;; all-completions
14753 (all-completions s2 ctable confirm))
14754 ((eq flag 'lambda)
14755 ;; exact match?
14756 (assoc s2 ctable)))))
14758 (defun org-fast-tag-insert (kwd tags face &optional end)
14759 "Insert KDW, and the TAGS, the latter with face FACE.
14760 Also insert END."
14761 (insert (format "%-12s" (concat kwd ":"))
14762 (org-add-props (mapconcat 'identity tags " ") nil 'face face)
14763 (or end "")))
14765 (defun org-fast-tag-show-exit (flag)
14766 (save-excursion
14767 (org-goto-line 3)
14768 (if (re-search-forward "[ \t]+Next change exits" (point-at-eol) t)
14769 (replace-match ""))
14770 (when flag
14771 (end-of-line 1)
14772 (org-move-to-column (- (window-width) 19) t)
14773 (insert (org-add-props " Next change exits" nil 'face 'org-warning)))))
14775 (defun org-set-current-tags-overlay (current prefix)
14776 "Add an overlay to CURRENT tag with PREFIX."
14777 (let ((s (concat ":" (mapconcat 'identity current ":") ":")))
14778 (if (featurep 'xemacs)
14779 (org-overlay-display org-tags-overlay (concat prefix s)
14780 'secondary-selection)
14781 (put-text-property 0 (length s) 'face '(secondary-selection org-tag) s)
14782 (org-overlay-display org-tags-overlay (concat prefix s)))))
14784 (defvar org-last-tag-selection-key nil)
14785 (defun org-fast-tag-selection (current inherited table &optional todo-table)
14786 "Fast tag selection with single keys.
14787 CURRENT is the current list of tags in the headline, INHERITED is the
14788 list of inherited tags, and TABLE is an alist of tags and corresponding keys,
14789 possibly with grouping information. TODO-TABLE is a similar table with
14790 TODO keywords, should these have keys assigned to them.
14791 If the keys are nil, a-z are automatically assigned.
14792 Returns the new tags string, or nil to not change the current settings."
14793 (let* ((fulltable (append table todo-table))
14794 (maxlen (apply 'max (mapcar
14795 (lambda (x)
14796 (if (stringp (car x)) (string-width (car x)) 0))
14797 fulltable)))
14798 (buf (current-buffer))
14799 (expert (eq org-fast-tag-selection-single-key 'expert))
14800 (buffer-tags nil)
14801 (fwidth (+ maxlen 3 1 3))
14802 (ncol (/ (- (window-width) 4) fwidth))
14803 (i-face 'org-done)
14804 (c-face 'org-todo)
14805 tg cnt e c char c1 c2 ntable tbl rtn
14806 ov-start ov-end ov-prefix
14807 (exit-after-next org-fast-tag-selection-single-key)
14808 (done-keywords org-done-keywords)
14809 groups ingroup)
14810 (save-excursion
14811 (beginning-of-line 1)
14812 (if (looking-at
14813 (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14814 (setq ov-start (match-beginning 1)
14815 ov-end (match-end 1)
14816 ov-prefix "")
14817 (setq ov-start (1- (point-at-eol))
14818 ov-end (1+ ov-start))
14819 (skip-chars-forward "^\n\r")
14820 (setq ov-prefix
14821 (concat
14822 (buffer-substring (1- (point)) (point))
14823 (if (> (current-column) org-tags-column)
14825 (make-string (- org-tags-column (current-column)) ?\ ))))))
14826 (move-overlay org-tags-overlay ov-start ov-end)
14827 (save-window-excursion
14828 (if expert
14829 (set-buffer (get-buffer-create " *Org tags*"))
14830 (delete-other-windows)
14831 (split-window-vertically)
14832 (org-switch-to-buffer-other-window (get-buffer-create " *Org tags*")))
14833 (erase-buffer)
14834 (org-set-local 'org-done-keywords done-keywords)
14835 (org-fast-tag-insert "Inherited" inherited i-face "\n")
14836 (org-fast-tag-insert "Current" current c-face "\n\n")
14837 (org-fast-tag-show-exit exit-after-next)
14838 (org-set-current-tags-overlay current ov-prefix)
14839 (setq tbl fulltable char ?a cnt 0)
14840 (while (setq e (pop tbl))
14841 (cond
14842 ((equal (car e) :startgroup)
14843 (push '() groups) (setq ingroup t)
14844 (when (not (= cnt 0))
14845 (setq cnt 0)
14846 (insert "\n"))
14847 (insert (if (cdr e) (format "%s: " (cdr e)) "") "{ "))
14848 ((equal (car e) :endgroup)
14849 (setq ingroup nil cnt 0)
14850 (insert "}" (if (cdr e) (format " (%s) " (cdr e)) "") "\n"))
14851 ((equal e '(:newline))
14852 (when (not (= cnt 0))
14853 (setq cnt 0)
14854 (insert "\n")
14855 (setq e (car tbl))
14856 (while (equal (car tbl) '(:newline))
14857 (insert "\n")
14858 (setq tbl (cdr tbl)))))
14859 ((equal e '(:grouptags)) nil)
14861 (setq tg (copy-sequence (car e)) c2 nil)
14862 (if (cdr e)
14863 (setq c (cdr e))
14864 ;; automatically assign a character.
14865 (setq c1 (string-to-char
14866 (downcase (substring
14867 tg (if (= (string-to-char tg) ?@) 1 0)))))
14868 (if (or (rassoc c1 ntable) (rassoc c1 table))
14869 (while (or (rassoc char ntable) (rassoc char table))
14870 (setq char (1+ char)))
14871 (setq c2 c1))
14872 (setq c (or c2 char)))
14873 (if ingroup (push tg (car groups)))
14874 (setq tg (org-add-props tg nil 'face
14875 (cond
14876 ((not (assoc tg table))
14877 (org-get-todo-face tg))
14878 ((member tg current) c-face)
14879 ((member tg inherited) i-face))))
14880 (if (equal (caar tbl) :grouptags)
14881 (org-add-props tg nil 'face 'org-tag-group))
14882 (if (and (= cnt 0) (not ingroup)) (insert " "))
14883 (insert "[" c "] " tg (make-string
14884 (- fwidth 4 (length tg)) ?\ ))
14885 (push (cons tg c) ntable)
14886 (when (= (setq cnt (1+ cnt)) ncol)
14887 (insert "\n")
14888 (if ingroup (insert " "))
14889 (setq cnt 0)))))
14890 (setq ntable (nreverse ntable))
14891 (insert "\n")
14892 (goto-char (point-min))
14893 (if (not expert) (org-fit-window-to-buffer))
14894 (setq rtn
14895 (catch 'exit
14896 (while t
14897 (message "[a-z..]:Toggle [SPC]:clear [RET]:accept [TAB]:free [!] %sgroups%s"
14898 (if (not groups) "no " "")
14899 (if expert " [C-c]:window" (if exit-after-next " [C-c]:single" " [C-c]:multi")))
14900 (setq c (let ((inhibit-quit t)) (read-char-exclusive)))
14901 (setq org-last-tag-selection-key c)
14902 (cond
14903 ((= c ?\r) (throw 'exit t))
14904 ((= c ?!)
14905 (setq groups (not groups))
14906 (goto-char (point-min))
14907 (while (re-search-forward "[{}]" nil t) (replace-match " ")))
14908 ((= c ?\C-c)
14909 (if (not expert)
14910 (org-fast-tag-show-exit
14911 (setq exit-after-next (not exit-after-next)))
14912 (setq expert nil)
14913 (delete-other-windows)
14914 (set-window-buffer (split-window-vertically) " *Org tags*")
14915 (org-switch-to-buffer-other-window " *Org tags*")
14916 (org-fit-window-to-buffer)))
14917 ((or (= c ?\C-g)
14918 (and (= c ?q) (not (rassoc c ntable))))
14919 (org-detach-overlay org-tags-overlay)
14920 (setq quit-flag t))
14921 ((= c ?\ )
14922 (setq current nil)
14923 (if exit-after-next (setq exit-after-next 'now)))
14924 ((= c ?\t)
14925 (condition-case nil
14926 (setq tg (org-icompleting-read
14927 "Tag: "
14928 (or buffer-tags
14929 (with-current-buffer buf
14930 (org-get-buffer-tags)))))
14931 (quit (setq tg "")))
14932 (when (string-match "\\S-" tg)
14933 (add-to-list 'buffer-tags (list tg))
14934 (if (member tg current)
14935 (setq current (delete tg current))
14936 (push tg current)))
14937 (if exit-after-next (setq exit-after-next 'now)))
14938 ((setq e (rassoc c todo-table) tg (car e))
14939 (with-current-buffer buf
14940 (save-excursion (org-todo tg)))
14941 (if exit-after-next (setq exit-after-next 'now)))
14942 ((setq e (rassoc c ntable) tg (car e))
14943 (if (member tg current)
14944 (setq current (delete tg current))
14945 (loop for g in groups do
14946 (if (member tg g)
14947 (mapc (lambda (x)
14948 (setq current (delete x current)))
14949 g)))
14950 (push tg current))
14951 (if exit-after-next (setq exit-after-next 'now))))
14953 ;; Create a sorted list
14954 (setq current
14955 (sort current
14956 (lambda (a b)
14957 (assoc b (cdr (memq (assoc a ntable) ntable))))))
14958 (if (eq exit-after-next 'now) (throw 'exit t))
14959 (goto-char (point-min))
14960 (beginning-of-line 2)
14961 (delete-region (point) (point-at-eol))
14962 (org-fast-tag-insert "Current" current c-face)
14963 (org-set-current-tags-overlay current ov-prefix)
14964 (while (re-search-forward
14965 (org-re "\\[.\\] \\([[:alnum:]_@#%]+\\)") nil t)
14966 (setq tg (match-string 1))
14967 (add-text-properties
14968 (match-beginning 1) (match-end 1)
14969 (list 'face
14970 (cond
14971 ((member tg current) c-face)
14972 ((member tg inherited) i-face)
14973 (t (get-text-property (match-beginning 1) 'face))))))
14974 (goto-char (point-min)))))
14975 (org-detach-overlay org-tags-overlay)
14976 (if rtn
14977 (mapconcat 'identity current ":")
14978 nil))))
14980 (defun org-get-tags-string ()
14981 "Get the TAGS string in the current headline."
14982 (unless (org-at-heading-p t)
14983 (user-error "Not on a heading"))
14984 (save-excursion
14985 (beginning-of-line 1)
14986 (if (looking-at (org-re ".*[ \t]\\(:[[:alnum:]_@#%:]+:\\)[ \t]*$"))
14987 (org-match-string-no-properties 1)
14988 "")))
14990 (defun org-get-tags ()
14991 "Get the list of tags specified in the current headline."
14992 (org-split-string (org-get-tags-string) ":"))
14994 (defun org-get-buffer-tags ()
14995 "Get a table of all tags used in the buffer, for completion."
14996 (let (tags)
14997 (save-excursion
14998 (goto-char (point-min))
14999 (while (re-search-forward
15000 (org-re "[ \t]:\\([[:alnum:]_@#%:]+\\):[ \t\r\n]") nil t)
15001 (when (equal (char-after (point-at-bol 0)) ?*)
15002 (mapc (lambda (x) (add-to-list 'tags x))
15003 (org-split-string (org-match-string-no-properties 1) ":")))))
15004 (mapc (lambda (s) (add-to-list 'tags s)) org-file-tags)
15005 (mapcar 'list tags)))
15007 ;;;; The mapping API
15009 (defun org-map-entries (func &optional match scope &rest skip)
15010 "Call FUNC at each headline selected by MATCH in SCOPE.
15012 FUNC is a function or a lisp form. The function will be called without
15013 arguments, with the cursor positioned at the beginning of the headline.
15014 The return values of all calls to the function will be collected and
15015 returned as a list.
15017 The call to FUNC will be wrapped into a save-excursion form, so FUNC
15018 does not need to preserve point. After evaluation, the cursor will be
15019 moved to the end of the line (presumably of the headline of the
15020 processed entry) and search continues from there. Under some
15021 circumstances, this may not produce the wanted results. For example,
15022 if you have removed (e.g. archived) the current (sub)tree it could
15023 mean that the next entry will be skipped entirely. In such cases, you
15024 can specify the position from where search should continue by making
15025 FUNC set the variable `org-map-continue-from' to the desired buffer
15026 position.
15028 MATCH is a tags/property/todo match as it is used in the agenda tags view.
15029 Only headlines that are matched by this query will be considered during
15030 the iteration. When MATCH is nil or t, all headlines will be
15031 visited by the iteration.
15033 SCOPE determines the scope of this command. It can be any of:
15035 nil The current buffer, respecting the restriction if any
15036 tree The subtree started with the entry at point
15037 region The entries within the active region, if any
15038 region-start-level
15039 The entries within the active region, but only those at
15040 the same level than the first one.
15041 file The current buffer, without restriction
15042 file-with-archives
15043 The current buffer, and any archives associated with it
15044 agenda All agenda files
15045 agenda-with-archives
15046 All agenda files with any archive files associated with them
15047 \(file1 file2 ...)
15048 If this is a list, all files in the list will be scanned
15050 The remaining args are treated as settings for the skipping facilities of
15051 the scanner. The following items can be given here:
15053 archive skip trees with the archive tag
15054 comment skip trees with the COMMENT keyword
15055 function or Emacs Lisp form:
15056 will be used as value for `org-agenda-skip-function', so
15057 whenever the function returns a position, FUNC will not be
15058 called for that entry and search will continue from the
15059 position returned
15061 If your function needs to retrieve the tags including inherited tags
15062 at the *current* entry, you can use the value of the variable
15063 `org-scanner-tags' which will be much faster than getting the value
15064 with `org-get-tags-at'. If your function gets properties with
15065 `org-entry-properties' at the *current* entry, bind `org-trust-scanner-tags'
15066 to t around the call to `org-entry-properties' to get the same speedup.
15067 Note that if your function moves around to retrieve tags and properties at
15068 a *different* entry, you cannot use these techniques."
15069 (unless (and (or (eq scope 'region) (eq scope 'region-start-level))
15070 (not (org-region-active-p)))
15071 (let* ((org-agenda-archives-mode nil) ; just to make sure
15072 (org-agenda-skip-archived-trees (memq 'archive skip))
15073 (org-agenda-skip-comment-trees (memq 'comment skip))
15074 (org-agenda-skip-function
15075 (car (org-delete-all '(comment archive) skip)))
15076 (org-tags-match-list-sublevels t)
15077 (start-level (eq scope 'region-start-level))
15078 matcher file res
15079 org-todo-keywords-for-agenda
15080 org-done-keywords-for-agenda
15081 org-todo-keyword-alist-for-agenda
15082 org-tag-alist-for-agenda
15083 todo-only)
15085 (cond
15086 ((eq match t) (setq matcher t))
15087 ((eq match nil) (setq matcher t))
15088 (t (setq matcher (if match (cdr (org-make-tags-matcher match)) t))))
15090 (save-excursion
15091 (save-restriction
15092 (cond ((eq scope 'tree)
15093 (org-back-to-heading t)
15094 (org-narrow-to-subtree)
15095 (setq scope nil))
15096 ((and (or (eq scope 'region) (eq scope 'region-start-level))
15097 (org-region-active-p))
15098 ;; If needed, set start-level to a string like "2"
15099 (when start-level
15100 (save-excursion
15101 (goto-char (region-beginning))
15102 (unless (org-at-heading-p) (outline-next-heading))
15103 (setq start-level (org-current-level))))
15104 (narrow-to-region (region-beginning)
15105 (save-excursion
15106 (goto-char (region-end))
15107 (unless (and (bolp) (org-at-heading-p))
15108 (outline-next-heading))
15109 (point)))
15110 (setq scope nil)))
15112 (if (not scope)
15113 (progn
15114 (org-agenda-prepare-buffers
15115 (list (buffer-file-name (current-buffer))))
15116 (setq res (org-scan-tags func matcher todo-only start-level)))
15117 ;; Get the right scope
15118 (cond
15119 ((and scope (listp scope) (symbolp (car scope)))
15120 (setq scope (eval scope)))
15121 ((eq scope 'agenda)
15122 (setq scope (org-agenda-files t)))
15123 ((eq scope 'agenda-with-archives)
15124 (setq scope (org-agenda-files t))
15125 (setq scope (org-add-archive-files scope)))
15126 ((eq scope 'file)
15127 (setq scope (list (buffer-file-name))))
15128 ((eq scope 'file-with-archives)
15129 (setq scope (org-add-archive-files (list (buffer-file-name))))))
15130 (org-agenda-prepare-buffers scope)
15131 (while (setq file (pop scope))
15132 (with-current-buffer (org-find-base-buffer-visiting file)
15133 (save-excursion
15134 (save-restriction
15135 (widen)
15136 (goto-char (point-min))
15137 (setq res (append res (org-scan-tags func matcher todo-only))))))))))
15138 res)))
15140 ;;;; Properties
15142 ;;; Setting and retrieving properties
15144 (defconst org-special-properties
15145 '("TODO" "TAGS" "ALLTAGS" "DEADLINE" "SCHEDULED" "CLOCK" "CLOSED" "PRIORITY"
15146 "TIMESTAMP" "TIMESTAMP_IA" "BLOCKED" "FILE" "CLOCKSUM" "CLOCKSUM_T")
15147 "The special properties valid in Org-mode.
15149 These are properties that are not defined in the property drawer,
15150 but in some other way.")
15152 (defconst org-default-properties
15153 '("ARCHIVE" "CATEGORY" "SUMMARY" "DESCRIPTION" "CUSTOM_ID"
15154 "LOCATION" "LOGGING" "COLUMNS" "VISIBILITY"
15155 "TABLE_EXPORT_FORMAT" "TABLE_EXPORT_FILE"
15156 "EXPORT_OPTIONS" "EXPORT_TEXT" "EXPORT_FILE_NAME"
15157 "EXPORT_TITLE" "EXPORT_AUTHOR" "EXPORT_DATE"
15158 "ORDERED" "NOBLOCKING" "COOKIE_DATA" "LOG_INTO_DRAWER" "REPEAT_TO_STATE"
15159 "CLOCK_MODELINE_TOTAL" "STYLE" "HTML_CONTAINER_CLASS")
15160 "Some properties that are used by Org-mode for various purposes.
15161 Being in this list makes sure that they are offered for completion.")
15163 (defun org-property-action ()
15164 "Do an action on properties."
15165 (interactive)
15166 (let (c)
15167 (org-at-property-p)
15168 (message "Property Action: [s]et [d]elete [D]elete globally [c]ompute")
15169 (setq c (read-char-exclusive))
15170 (cond
15171 ((equal c ?s)
15172 (call-interactively 'org-set-property))
15173 ((equal c ?d)
15174 (call-interactively 'org-delete-property))
15175 ((equal c ?D)
15176 (call-interactively 'org-delete-property-globally))
15177 ((equal c ?c)
15178 (call-interactively 'org-compute-property-at-point))
15179 (t (user-error "No such property action %c" c)))))
15181 (defun org-inc-effort ()
15182 "Increment the value of the effort property in the current entry."
15183 (interactive)
15184 (org-set-effort nil t))
15186 (defvar org-clock-effort) ;; Defined in org-clock.el
15187 (defvar org-clock-current-task) ;; Defined in org-clock.el
15188 (defun org-set-effort (&optional value increment)
15189 "Set the effort property of the current entry.
15190 With numerical prefix arg, use the nth allowed value, 0 stands for the
15191 10th allowed value.
15193 When INCREMENT is non-nil, set the property to the next allowed value."
15194 (interactive "P")
15195 (if (equal value 0) (setq value 10))
15196 (let* ((completion-ignore-case t)
15197 (prop org-effort-property)
15198 (cur (org-entry-get nil prop))
15199 (allowed (org-property-get-allowed-values nil prop 'table))
15200 (existing (mapcar 'list (org-property-values prop)))
15201 (heading (nth 4 (org-heading-components)))
15203 (val (cond
15204 ((stringp value) value)
15205 ((and allowed (integerp value))
15206 (or (car (nth (1- value) allowed))
15207 (car (org-last allowed))))
15208 ((and allowed increment)
15209 (or (caadr (member (list cur) allowed))
15210 (user-error "Allowed effort values are not set")))
15211 (allowed
15212 (message "Select 1-9,0, [RET%s]: %s"
15213 (if cur (concat "=" cur) "")
15214 (mapconcat 'car allowed " "))
15215 (setq rpl (read-char-exclusive))
15216 (if (equal rpl ?\r)
15218 (setq rpl (- rpl ?0))
15219 (if (equal rpl 0) (setq rpl 10))
15220 (if (and (> rpl 0) (<= rpl (length allowed)))
15221 (car (nth (1- rpl) allowed))
15222 (org-completing-read "Effort: " allowed nil))))
15224 (let (org-completion-use-ido org-completion-use-iswitchb)
15225 (org-completing-read
15226 (concat "Effort " (if (and cur (string-match "\\S-" cur))
15227 (concat "[" cur "]") "")
15228 ": ")
15229 existing nil nil "" nil cur))))))
15230 (unless (equal (org-entry-get nil prop) val)
15231 (org-entry-put nil prop val))
15232 (save-excursion
15233 (org-back-to-heading t)
15234 (put-text-property (point-at-bol) (point-at-eol) 'org-effort val))
15235 (when (string= heading org-clock-current-task)
15236 (setq org-clock-effort (get-text-property (point-at-bol) 'org-effort))
15237 (org-clock-update-mode-line))
15238 (message "%s is now %s" prop val)))
15240 (defun org-at-property-p ()
15241 "Is cursor inside a property drawer?"
15242 (save-excursion
15243 (when (equal 'node-property (car (org-element-at-point)))
15244 (beginning-of-line 1)
15245 (looking-at org-property-re))))
15247 (defun org-get-property-block (&optional beg end force)
15248 "Return the (beg . end) range of the body of the property drawer.
15249 BEG and END are the beginning and end of the current subtree, or of
15250 the part before the first headline. If they are not given, they will
15251 be found. If the drawer does not exist and FORCE is non-nil, create
15252 the drawer."
15253 (catch 'exit
15254 (save-excursion
15255 (let* ((beg (or beg (and (org-before-first-heading-p) (point-min))
15256 (progn (org-back-to-heading t) (point))))
15257 (end (or end (and (not (outline-next-heading)) (point-max))
15258 (point))))
15259 (goto-char beg)
15260 (if (re-search-forward org-property-start-re end t)
15261 (setq beg (1+ (match-end 0)))
15262 (if force
15263 (save-excursion
15264 (org-insert-property-drawer)
15265 (setq end (progn (outline-next-heading) (point))))
15266 (throw 'exit nil))
15267 (goto-char beg)
15268 (if (re-search-forward org-property-start-re end t)
15269 (setq beg (1+ (match-end 0)))))
15270 (if (re-search-forward org-property-end-re end t)
15271 (setq end (match-beginning 0))
15272 (or force (throw 'exit nil))
15273 (goto-char beg)
15274 (setq end beg)
15275 (org-indent-line)
15276 (insert ":END:\n"))
15277 (cons beg end)))))
15279 (defun org-entry-properties (&optional pom which specific)
15280 "Get all properties of the entry at point-or-marker POM.
15281 This includes the TODO keyword, the tags, time strings for deadline,
15282 scheduled, and clocking, and any additional properties defined in the
15283 entry. The return value is an alist, keys may occur multiple times
15284 if the property key was used several times.
15285 POM may also be nil, in which case the current entry is used.
15286 If WHICH is nil or `all', get all properties. If WHICH is
15287 `special' or `standard', only get that subclass. If WHICH
15288 is a string only get exactly this property. SPECIFIC can be a string, the
15289 specific property we are interested in. Specifying it can speed
15290 things up because then unnecessary parsing is avoided."
15291 (setq which (or which 'all))
15292 (org-with-wide-buffer
15293 (org-with-point-at pom
15294 (let ((clockstr (substring org-clock-string 0 -1))
15295 (excluded '("TODO" "TAGS" "ALLTAGS" "PRIORITY" "BLOCKED"))
15296 (case-fold-search nil)
15297 beg end range props sum-props key key1 value string clocksum clocksumt)
15298 (when (and (derived-mode-p 'org-mode)
15299 (ignore-errors (org-back-to-heading t)))
15300 (setq beg (point))
15301 (setq sum-props (get-text-property (point) 'org-summaries))
15302 (setq clocksum (get-text-property (point) :org-clock-minutes)
15303 clocksumt (get-text-property (point) :org-clock-minutes-today))
15304 (outline-next-heading)
15305 (setq end (point))
15306 (when (memq which '(all special))
15307 ;; Get the special properties, like TODO and tags
15308 (goto-char beg)
15309 (when (and (or (not specific) (string= specific "TODO"))
15310 (looking-at org-todo-line-regexp) (match-end 2))
15311 (push (cons "TODO" (org-match-string-no-properties 2)) props))
15312 (when (and (or (not specific) (string= specific "PRIORITY"))
15313 (looking-at org-priority-regexp))
15314 (push (cons "PRIORITY" (org-match-string-no-properties 2)) props))
15315 (when (or (not specific) (string= specific "FILE"))
15316 (push (cons "FILE" buffer-file-name) props))
15317 (when (and (or (not specific) (string= specific "TAGS"))
15318 (setq value (org-get-tags-string))
15319 (string-match "\\S-" value))
15320 (push (cons "TAGS" value) props))
15321 (when (and (or (not specific) (string= specific "ALLTAGS"))
15322 (setq value (org-get-tags-at)))
15323 (push (cons "ALLTAGS" (concat ":" (mapconcat 'identity value ":")
15324 ":"))
15325 props))
15326 (when (or (not specific) (string= specific "BLOCKED"))
15327 (push (cons "BLOCKED" (if (org-entry-blocked-p) "t" "")) props))
15328 (when (or (not specific)
15329 (member specific
15330 '("SCHEDULED" "DEADLINE" "CLOCK" "CLOSED"
15331 "TIMESTAMP" "TIMESTAMP_IA")))
15332 (catch 'match
15333 (while (re-search-forward org-maybe-keyword-time-regexp end t)
15334 (setq key (if (match-end 1)
15335 (substring (org-match-string-no-properties 1)
15336 0 -1))
15337 string (if (equal key clockstr)
15338 (org-trim
15339 (buffer-substring-no-properties
15340 (match-beginning 3) (goto-char
15341 (point-at-eol))))
15342 (substring (org-match-string-no-properties 3)
15343 1 -1)))
15344 ;; Get the correct property name from the key. This is
15345 ;; necessary if the user has configured time keywords.
15346 (setq key1 (concat key ":"))
15347 (cond
15348 ((not key)
15349 (setq key
15350 (if (= (char-after (match-beginning 3)) ?\[)
15351 "TIMESTAMP_IA" "TIMESTAMP")))
15352 ((equal key1 org-scheduled-string) (setq key "SCHEDULED"))
15353 ((equal key1 org-deadline-string) (setq key "DEADLINE"))
15354 ((equal key1 org-closed-string) (setq key "CLOSED"))
15355 ((equal key1 org-clock-string) (setq key "CLOCK")))
15356 (if (and specific (equal key specific) (not (equal key "CLOCK")))
15357 (progn
15358 (push (cons key string) props)
15359 ;; no need to search further if match is found
15360 (throw 'match t))
15361 (when (or (equal key "CLOCK") (not (assoc key props)))
15362 (push (cons key string) props)))))))
15364 (when (memq which '(all standard))
15365 ;; Get the standard properties, like :PROP: ...
15366 (setq range (org-get-property-block beg end))
15367 (when range
15368 (goto-char (car range))
15369 (while (re-search-forward org-property-re
15370 (cdr range) t)
15371 (setq key (org-match-string-no-properties 2)
15372 value (org-trim (or (org-match-string-no-properties 3) "")))
15373 (unless (member key excluded)
15374 (push (cons key (or value "")) props)))))
15375 (if clocksum
15376 (push (cons "CLOCKSUM"
15377 (org-columns-number-to-string (/ (float clocksum) 60.)
15378 'add_times))
15379 props))
15380 (if clocksumt
15381 (push (cons "CLOCKSUM_T"
15382 (org-columns-number-to-string (/ (float clocksumt) 60.)
15383 'add_times))
15384 props))
15385 (unless (assoc "CATEGORY" props)
15386 (push (cons "CATEGORY" (org-get-category)) props))
15387 (append sum-props (nreverse props)))))))
15389 (defun org-entry-get (pom property &optional inherit literal-nil)
15390 "Get value of PROPERTY for entry or content at point-or-marker POM.
15391 If INHERIT is non-nil and the entry does not have the property,
15392 then also check higher levels of the hierarchy.
15393 If INHERIT is the symbol `selective', use inheritance only if the setting
15394 in `org-use-property-inheritance' selects PROPERTY for inheritance.
15395 If the property is present but empty, the return value is the empty string.
15396 If the property is not present at all, nil is returned.
15398 Return the value as a string.
15400 If LITERAL-NIL is set, return the string value \"nil\" as a string,
15401 do not interpret it as the list atom nil. This is used for inheritance
15402 when a \"nil\" value can supersede a non-nil value higher up the hierarchy."
15403 (org-with-point-at pom
15404 (if (and inherit (if (eq inherit 'selective)
15405 (org-property-inherit-p property)
15407 (org-entry-get-with-inheritance property literal-nil)
15408 (if (member property org-special-properties)
15409 ;; We need a special property. Use `org-entry-properties'
15410 ;; to retrieve it, but specify the wanted property
15411 (cdr (assoc property (org-entry-properties nil 'special property)))
15412 (org-with-wide-buffer
15413 (let ((range (org-get-property-block)))
15414 (when (and range (not (eq (car range) (cdr range))))
15415 (let* ((props
15416 (list (or (assoc property org-file-properties)
15417 (assoc property org-global-properties)
15418 (assoc property org-global-properties-fixed))))
15419 (ap (lambda (key)
15420 (when (re-search-forward
15421 (org-re-property key) (cdr range) t)
15422 (setq props
15423 (org-update-property-plist
15425 (if (match-end 3)
15426 (org-match-string-no-properties 3) "")
15427 props)))))
15428 val)
15429 (goto-char (car range))
15430 (funcall ap property)
15431 (goto-char (car range))
15432 (while (funcall ap (concat property "+")))
15433 (setq val (cdr (assoc property props)))
15434 (when val (if literal-nil val (org-not-nil val)))))))))))
15436 (defun org-property-or-variable-value (var &optional inherit)
15437 "Check if there is a property fixing the value of VAR.
15438 If yes, return this value. If not, return the current value of the variable."
15439 (let ((prop (org-entry-get nil (symbol-name var) inherit)))
15440 (if (and prop (stringp prop) (string-match "\\S-" prop))
15441 (read prop)
15442 (symbol-value var))))
15444 (defun org-entry-delete (pom property)
15445 "Delete the property PROPERTY from entry at point-or-marker POM."
15446 (unless (member property org-special-properties)
15447 (org-with-point-at pom
15448 (let ((range (org-get-property-block)))
15449 (if (and range
15450 (goto-char (car range))
15451 (re-search-forward
15452 (org-re-property property)
15453 (cdr range) t))
15454 (progn
15455 (delete-region (match-beginning 0) (1+ (point-at-eol)))
15456 (org-remove-empty-drawer-at (car range))
15458 nil)))))
15460 ;; Multi-values properties are properties that contain multiple values
15461 ;; These values are assumed to be single words, separated by whitespace.
15462 (defun org-entry-add-to-multivalued-property (pom property value)
15463 "Add VALUE to the words in the PROPERTY in entry at point-or-marker POM."
15464 (let* ((old (org-entry-get pom property))
15465 (values (and old (org-split-string old "[ \t]"))))
15466 (setq value (org-entry-protect-space value))
15467 (unless (member value values)
15468 (setq values (append values (list value)))
15469 (org-entry-put pom property
15470 (mapconcat 'identity values " ")))))
15472 (defun org-entry-remove-from-multivalued-property (pom property value)
15473 "Remove VALUE from words in the PROPERTY in entry at point-or-marker POM."
15474 (let* ((old (org-entry-get pom property))
15475 (values (and old (org-split-string old "[ \t]"))))
15476 (setq value (org-entry-protect-space value))
15477 (when (member value values)
15478 (setq values (delete value values))
15479 (org-entry-put pom property
15480 (mapconcat 'identity values " ")))))
15482 (defun org-entry-member-in-multivalued-property (pom property value)
15483 "Is VALUE one of the words in the PROPERTY in entry at point-or-marker POM?"
15484 (let* ((old (org-entry-get pom property))
15485 (values (and old (org-split-string old "[ \t]"))))
15486 (setq value (org-entry-protect-space value))
15487 (member value values)))
15489 (defun org-entry-get-multivalued-property (pom property)
15490 "Return a list of values in a multivalued property."
15491 (let* ((value (org-entry-get pom property))
15492 (values (and value (org-split-string value "[ \t]"))))
15493 (mapcar 'org-entry-restore-space values)))
15495 (defun org-entry-put-multivalued-property (pom property &rest values)
15496 "Set multivalued PROPERTY at point-or-marker POM to VALUES.
15497 VALUES should be a list of strings. Spaces will be protected."
15498 (org-entry-put pom property
15499 (mapconcat 'org-entry-protect-space values " "))
15500 (let* ((value (org-entry-get pom property))
15501 (values (and value (org-split-string value "[ \t]"))))
15502 (mapcar 'org-entry-restore-space values)))
15504 (defun org-entry-protect-space (s)
15505 "Protect spaces and newline in string S."
15506 (while (string-match " " s)
15507 (setq s (replace-match "%20" t t s)))
15508 (while (string-match "\n" s)
15509 (setq s (replace-match "%0A" t t s)))
15512 (defun org-entry-restore-space (s)
15513 "Restore spaces and newline in string S."
15514 (while (string-match "%20" s)
15515 (setq s (replace-match " " t t s)))
15516 (while (string-match "%0A" s)
15517 (setq s (replace-match "\n" t t s)))
15520 (defvar org-entry-property-inherited-from (make-marker)
15521 "Marker pointing to the entry from where a property was inherited.
15522 Each call to `org-entry-get-with-inheritance' will set this marker to the
15523 location of the entry where the inheritance search matched. If there was
15524 no match, the marker will point nowhere.
15525 Note that also `org-entry-get' calls this function, if the INHERIT flag
15526 is set.")
15528 (defun org-entry-get-with-inheritance (property &optional literal-nil)
15529 "Get PROPERTY of entry or content at point, search higher levels if needed.
15530 The search will stop at the first ancestor which has the property defined.
15531 If the value found is \"nil\", return nil to show that the property
15532 should be considered as undefined (this is the meaning of nil here).
15533 However, if LITERAL-NIL is set, return the string value \"nil\" instead."
15534 (move-marker org-entry-property-inherited-from nil)
15535 (let (tmp)
15536 (save-excursion
15537 (save-restriction
15538 (widen)
15539 (catch 'ex
15540 (while t
15541 (when (setq tmp (org-entry-get nil property nil 'literal-nil))
15542 (or (ignore-errors (org-back-to-heading t))
15543 (goto-char (point-min)))
15544 (move-marker org-entry-property-inherited-from (point))
15545 (throw 'ex tmp))
15546 (or (ignore-errors (org-up-heading-safe))
15547 (throw 'ex nil))))))
15548 (setq tmp (or tmp
15549 (cdr (assoc property org-file-properties))
15550 (cdr (assoc property org-global-properties))
15551 (cdr (assoc property org-global-properties-fixed))))
15552 (if literal-nil tmp (org-not-nil tmp))))
15554 (defvar org-property-changed-functions nil
15555 "Hook called when the value of a property has changed.
15556 Each hook function should accept two arguments, the name of the property
15557 and the new value.")
15559 (defun org-entry-put (pom property value)
15560 "Set PROPERTY to VALUE for entry at point-or-marker POM.
15561 If the value is `nil', it is converted to the empty string.
15562 If it is not a string, an error is raised."
15563 (cond ((null value) (setq value ""))
15564 ((not (stringp value))
15565 (error "Properties values should be strings.")))
15566 (org-with-point-at pom
15567 (org-back-to-heading t)
15568 (let ((beg (point)) (end (save-excursion (outline-next-heading) (point)))
15569 range)
15570 (cond
15571 ((equal property "TODO")
15572 (when (and (string-match "\\S-" value)
15573 (not (member value org-todo-keywords-1)))
15574 (user-error "\"%s\" is not a valid TODO state" value))
15575 (if (or (not value)
15576 (not (string-match "\\S-" value)))
15577 (setq value 'none))
15578 (org-todo value)
15579 (org-set-tags nil 'align))
15580 ((equal property "PRIORITY")
15581 (org-priority (if (and value (string-match "\\S-" value))
15582 (string-to-char value) ?\ ))
15583 (org-set-tags nil 'align))
15584 ((equal property "CLOCKSUM")
15585 (if (not (re-search-forward
15586 (concat org-clock-string ".*\\]--\\(\\[[^]]+\\]\\)") nil t))
15587 (error "Cannot find a clock log")
15588 (goto-char (- (match-end 1) 2))
15589 (cond
15590 ((eq value 'earlier) (org-timestamp-down))
15591 ((eq value 'later) (org-timestamp-up)))
15592 (org-clock-sum-current-item)))
15593 ((equal property "SCHEDULED")
15594 (if (re-search-forward org-scheduled-time-regexp end t)
15595 (cond
15596 ((eq value 'earlier) (org-timestamp-change -1 'day))
15597 ((eq value 'later) (org-timestamp-change 1 'day))
15598 (t (call-interactively 'org-schedule)))
15599 (call-interactively 'org-schedule)))
15600 ((equal property "DEADLINE")
15601 (if (re-search-forward org-deadline-time-regexp end t)
15602 (cond
15603 ((eq value 'earlier) (org-timestamp-change -1 'day))
15604 ((eq value 'later) (org-timestamp-change 1 'day))
15605 (t (call-interactively 'org-deadline)))
15606 (call-interactively 'org-deadline)))
15607 ((member property org-special-properties)
15608 (error "The %s property can not yet be set with `org-entry-put'"
15609 property))
15610 (t ; a non-special property
15611 (let ((buffer-invisibility-spec (org-inhibit-invisibility))) ; Emacs 21
15612 (setq range (org-get-property-block beg end 'force))
15613 (goto-char (car range))
15614 (if (re-search-forward
15615 (org-re-property property) (cdr range) t)
15616 (progn
15617 (delete-region (match-beginning 0) (match-end 0))
15618 (goto-char (match-beginning 0)))
15619 (goto-char (cdr range))
15620 (insert "\n")
15621 (backward-char 1)
15622 (org-indent-line))
15623 (insert ":" property ":")
15624 (and value (insert " " value))
15625 (org-indent-line)))))
15626 (run-hook-with-args 'org-property-changed-functions property value)))
15628 (defun org-buffer-property-keys (&optional include-specials include-defaults include-columns)
15629 "Get all property keys in the current buffer.
15630 With INCLUDE-SPECIALS, also list the special properties that reflect things
15631 like tags and TODO state.
15632 With INCLUDE-DEFAULTS, also include properties that has special meaning
15633 internally: ARCHIVE, CATEGORY, SUMMARY, DESCRIPTION, LOCATION, and LOGGING
15634 and others.
15635 With INCLUDE-COLUMNS, also include property names given in COLUMN
15636 formats in the current buffer."
15637 (let (rtn range cfmt s p)
15638 (save-excursion
15639 (save-restriction
15640 (widen)
15641 (goto-char (point-min))
15642 (while (re-search-forward org-property-start-re nil t)
15643 (setq range (org-get-property-block))
15644 (goto-char (car range))
15645 (while (re-search-forward org-property-re
15646 (cdr range) t)
15647 (add-to-list 'rtn (org-match-string-no-properties 2)))
15648 (outline-next-heading))))
15650 (when include-specials
15651 (setq rtn (append org-special-properties rtn)))
15653 (when include-defaults
15654 (mapc (lambda (x) (add-to-list 'rtn x)) org-default-properties)
15655 (add-to-list 'rtn org-effort-property))
15657 (when include-columns
15658 (save-excursion
15659 (save-restriction
15660 (widen)
15661 (goto-char (point-min))
15662 (while (re-search-forward
15663 "^\\(#\\+COLUMNS:\\|[ \t]*:COLUMNS:\\)[ \t]*\\(.*\\)"
15664 nil t)
15665 (setq cfmt (match-string 2) s 0)
15666 (while (string-match (org-re "%[0-9]*\\([-[:alnum:]_]+\\)")
15667 cfmt s)
15668 (setq s (match-end 0)
15669 p (match-string 1 cfmt))
15670 (unless (or (equal p "ITEM")
15671 (member p org-special-properties))
15672 (add-to-list 'rtn (match-string 1 cfmt))))))))
15674 (sort rtn (lambda (a b) (string< (upcase a) (upcase b))))))
15676 (defun org-property-values (key)
15677 "Return a list of all values of property KEY in the current buffer."
15678 (save-excursion
15679 (save-restriction
15680 (widen)
15681 (goto-char (point-min))
15682 (let ((re (org-re-property key))
15683 values)
15684 (while (re-search-forward re nil t)
15685 (add-to-list 'values (org-trim (match-string 3))))
15686 (delete "" values)))))
15688 (defun org-insert-property-drawer ()
15689 "Insert a property drawer into the current entry."
15690 (org-back-to-heading t)
15691 (looking-at org-outline-regexp)
15692 (let ((indent (if org-adapt-indentation
15693 (- (match-end 0) (match-beginning 0))
15695 (beg (point))
15696 (re (concat "^[ \t]*" org-keyword-time-regexp))
15697 end hiddenp)
15698 (outline-next-heading)
15699 (setq end (point))
15700 (goto-char beg)
15701 (while (re-search-forward re end t))
15702 (setq hiddenp (outline-invisible-p))
15703 (end-of-line 1)
15704 (and (equal (char-after) ?\n) (forward-char 1))
15705 (while (looking-at "^[ \t]*\\(:CLOCK:\\|:LOGBOOK:\\|CLOCK:\\|:END:\\)")
15706 (if (member (match-string 1) '("CLOCK:" ":END:"))
15707 ;; just skip this line
15708 (beginning-of-line 2)
15709 ;; Drawer start, find the end
15710 (re-search-forward "^\\*+ \\|^[ \t]*:END:" nil t)
15711 (beginning-of-line 1)))
15712 (org-skip-over-state-notes)
15713 (skip-chars-backward " \t\n\r")
15714 (if (and (eq (char-before) ?*) (not (eq (char-after) ?\n)))
15715 (forward-char 1))
15716 (goto-char (point-at-eol))
15717 (let ((inhibit-read-only t)) (insert "\n:PROPERTIES:\n:END:"))
15718 (beginning-of-line 0)
15719 (org-indent-to-column indent)
15720 (beginning-of-line 2)
15721 (org-indent-to-column indent)
15722 (beginning-of-line 0)
15723 (if hiddenp
15724 (save-excursion
15725 (org-back-to-heading t)
15726 (hide-entry))
15727 (org-flag-drawer t))))
15729 (defun org-insert-drawer (&optional arg drawer)
15730 "Insert a drawer at point.
15732 Optional argument DRAWER, when non-nil, is a string representing
15733 drawer's name. Otherwise, the user is prompted for a name.
15735 If a region is active, insert the drawer around that region
15736 instead.
15738 Point is left between drawer's boundaries."
15739 (interactive "P")
15740 (let* ((drawer (if arg "PROPERTIES"
15741 (or drawer (read-from-minibuffer "Drawer: ")))))
15742 (cond
15743 ;; With C-u, fall back on `org-insert-property-drawer'
15744 (arg (org-insert-property-drawer))
15746 ((not (org-string-match-p org-drawer-regexp (format ":%s:" drawer)))
15747 (user-error "Invalid drawer name"))
15748 ;; With an active region, insert a drawer at point.
15749 ((not (org-region-active-p))
15750 (progn
15751 (unless (bolp) (insert "\n"))
15752 (insert (format ":%s:\n\n:END:\n" drawer))
15753 (forward-line -2)))
15754 ;; Otherwise, insert the drawer at point
15756 (let ((rbeg (region-beginning))
15757 (rend (copy-marker (region-end))))
15758 (unwind-protect
15759 (progn
15760 (goto-char rbeg)
15761 (beginning-of-line)
15762 (when (save-excursion
15763 (re-search-forward org-outline-regexp-bol rend t))
15764 (user-error "Drawers cannot contain headlines"))
15765 ;; Position point at the beginning of the first
15766 ;; non-blank line in region. Insert drawer's opening
15767 ;; there, then indent it.
15768 (org-skip-whitespace)
15769 (beginning-of-line)
15770 (insert ":" drawer ":\n")
15771 (forward-line -1)
15772 (indent-for-tab-command)
15773 ;; Move point to the beginning of the first blank line
15774 ;; after the last non-blank line in region. Insert
15775 ;; drawer's closing, then indent it.
15776 (goto-char rend)
15777 (skip-chars-backward " \r\t\n")
15778 (insert "\n:END:")
15779 (deactivate-mark t)
15780 (indent-for-tab-command)
15781 (unless (eolp) (insert "\n")))
15782 ;; Clear marker, whatever the outcome of insertion is.
15783 (set-marker rend nil)))))))
15785 (defvar org-property-set-functions-alist nil
15786 "Property set function alist.
15787 Each entry should have the following format:
15789 (PROPERTY . READ-FUNCTION)
15791 The read function will be called with the same argument as
15792 `org-completing-read'.")
15794 (defun org-set-property-function (property)
15795 "Get the function that should be used to set PROPERTY.
15796 This is computed according to `org-property-set-functions-alist'."
15797 (or (cdr (assoc property org-property-set-functions-alist))
15798 'org-completing-read))
15800 (defun org-read-property-value (property)
15801 "Read PROPERTY value from user."
15802 (let* ((completion-ignore-case t)
15803 (allowed (org-property-get-allowed-values nil property 'table))
15804 (cur (org-entry-get nil property))
15805 (prompt (concat property " value"
15806 (if (and cur (string-match "\\S-" cur))
15807 (concat " [" cur "]") "") ": "))
15808 (set-function (org-set-property-function property))
15809 (val (if allowed
15810 (funcall set-function prompt allowed nil
15811 (not (get-text-property 0 'org-unrestricted
15812 (caar allowed))))
15813 (let (org-completion-use-ido org-completion-use-iswitchb)
15814 (funcall set-function prompt
15815 (mapcar 'list (org-property-values property))
15816 nil nil "" nil cur)))))
15817 (if (equal val "")
15819 val)))
15821 (defvar org-last-set-property nil)
15822 (defvar org-last-set-property-value nil)
15823 (defun org-read-property-name ()
15824 "Read a property name."
15825 (let* ((completion-ignore-case t)
15826 (keys (org-buffer-property-keys nil t t))
15827 (default-prop (or (save-excursion
15828 (save-match-data
15829 (beginning-of-line)
15830 (and (looking-at "^\\s-*:\\([^:\n]+\\):")
15831 (null (string= (match-string 1) "END"))
15832 (match-string 1))))
15833 org-last-set-property))
15834 (property (org-icompleting-read
15835 (concat "Property"
15836 (if default-prop (concat " [" default-prop "]") "")
15837 ": ")
15838 (mapcar 'list keys)
15839 nil nil nil nil
15840 default-prop)))
15841 (if (member property keys)
15842 property
15843 (or (cdr (assoc (downcase property)
15844 (mapcar (lambda (x) (cons (downcase x) x))
15845 keys)))
15846 property))))
15848 (defun org-set-property-and-value (use-last)
15849 "Allow to set [PROPERTY]: [value] direction from prompt.
15850 When use-default, don't even ask, just use the last
15851 \"[PROPERTY]: [value]\" string from the history."
15852 (interactive "P")
15853 (let* ((completion-ignore-case t)
15854 (pv (or (and use-last org-last-set-property-value)
15855 (org-completing-read
15856 "Enter a \"[Property]: [value]\" pair: "
15857 nil nil nil nil nil
15858 org-last-set-property-value)))
15859 prop val)
15860 (when (string-match "^[ \t]*\\([^:]+\\):[ \t]*\\(.*\\)[ \t]*$" pv)
15861 (setq prop (match-string 1 pv)
15862 val (match-string 2 pv))
15863 (org-set-property prop val))))
15865 (defun org-set-property (property value)
15866 "In the current entry, set PROPERTY to VALUE.
15867 When called interactively, this will prompt for a property name, offering
15868 completion on existing and default properties. And then it will prompt
15869 for a value, offering completion either on allowed values (via an inherited
15870 xxx_ALL property) or on existing values in other instances of this property
15871 in the current file."
15872 (interactive (list nil nil))
15873 (let* ((property (or property (org-read-property-name)))
15874 (value (or value (org-read-property-value property)))
15875 (fn (cdr (assoc property org-properties-postprocess-alist))))
15876 (setq org-last-set-property property)
15877 (setq org-last-set-property-value (concat property ": " value))
15878 ;; Possibly postprocess the inserted value:
15879 (when fn (setq value (funcall fn value)))
15880 (unless (equal (org-entry-get nil property) value)
15881 (org-entry-put nil property value))))
15883 (defun org-delete-property (property)
15884 "In the current entry, delete PROPERTY."
15885 (interactive
15886 (let* ((completion-ignore-case t)
15887 (prop (org-icompleting-read "Property: "
15888 (org-entry-properties nil 'standard))))
15889 (list prop)))
15890 (message "Property %s %s" property
15891 (if (org-entry-delete nil property)
15892 "deleted"
15893 "was not present in the entry")))
15895 (defun org-delete-property-globally (property)
15896 "Remove PROPERTY globally, from all entries."
15897 (interactive
15898 (let* ((completion-ignore-case t)
15899 (prop (org-icompleting-read
15900 "Globally remove property: "
15901 (mapcar 'list (org-buffer-property-keys)))))
15902 (list prop)))
15903 (save-excursion
15904 (save-restriction
15905 (widen)
15906 (goto-char (point-min))
15907 (let ((cnt 0))
15908 (while (re-search-forward
15909 (org-re-property property)
15910 nil t)
15911 (setq cnt (1+ cnt))
15912 (delete-region (match-beginning 0) (1+ (point-at-eol))))
15913 (message "Property \"%s\" removed from %d entries" property cnt)))))
15915 (defvar org-columns-current-fmt-compiled) ; defined in org-colview.el
15917 (defun org-compute-property-at-point ()
15918 "Compute the property at point.
15919 This looks for an enclosing column format, extracts the operator and
15920 then applies it to the property in the column format's scope."
15921 (interactive)
15922 (unless (org-at-property-p)
15923 (user-error "Not at a property"))
15924 (let ((prop (org-match-string-no-properties 2)))
15925 (org-columns-get-format-and-top-level)
15926 (unless (nth 3 (assoc prop org-columns-current-fmt-compiled))
15927 (user-error "No operator defined for property %s" prop))
15928 (org-columns-compute prop)))
15930 (defvar org-property-allowed-value-functions nil
15931 "Hook for functions supplying allowed values for a specific property.
15932 The functions must take a single argument, the name of the property, and
15933 return a flat list of allowed values. If \":ETC\" is one of
15934 the values, this means that these values are intended as defaults for
15935 completion, but that other values should be allowed too.
15936 The functions must return nil if they are not responsible for this
15937 property.")
15939 (defun org-property-get-allowed-values (pom property &optional table)
15940 "Get allowed values for the property PROPERTY.
15941 When TABLE is non-nil, return an alist that can directly be used for
15942 completion."
15943 (let (vals)
15944 (cond
15945 ((equal property "TODO")
15946 (setq vals (org-with-point-at pom
15947 (append org-todo-keywords-1 '("")))))
15948 ((equal property "PRIORITY")
15949 (let ((n org-lowest-priority))
15950 (while (>= n org-highest-priority)
15951 (push (char-to-string n) vals)
15952 (setq n (1- n)))))
15953 ((member property org-special-properties))
15954 ((setq vals (run-hook-with-args-until-success
15955 'org-property-allowed-value-functions property)))
15957 (setq vals (org-entry-get pom (concat property "_ALL") 'inherit))
15958 (when (and vals (string-match "\\S-" vals))
15959 (setq vals (car (read-from-string (concat "(" vals ")"))))
15960 (setq vals (mapcar (lambda (x)
15961 (cond ((stringp x) x)
15962 ((numberp x) (number-to-string x))
15963 ((symbolp x) (symbol-name x))
15964 (t "???")))
15965 vals)))))
15966 (when (member ":ETC" vals)
15967 (setq vals (remove ":ETC" vals))
15968 (org-add-props (car vals) '(org-unrestricted t)))
15969 (if table (mapcar 'list vals) vals)))
15971 (defun org-property-previous-allowed-value (&optional previous)
15972 "Switch to the next allowed value for this property."
15973 (interactive)
15974 (org-property-next-allowed-value t))
15976 (defun org-property-next-allowed-value (&optional previous)
15977 "Switch to the next allowed value for this property."
15978 (interactive)
15979 (unless (org-at-property-p)
15980 (user-error "Not at a property"))
15981 (let* ((prop (car (save-match-data (org-split-string (match-string 1) ":"))))
15982 (key (match-string 2))
15983 (value (match-string 3))
15984 (allowed (or (org-property-get-allowed-values (point) key)
15985 (and (member value '("[ ]" "[-]" "[X]"))
15986 '("[ ]" "[X]"))))
15987 (heading (save-match-data (nth 4 (org-heading-components))))
15988 nval)
15989 (unless allowed
15990 (user-error "Allowed values for this property have not been defined"))
15991 (if previous (setq allowed (reverse allowed)))
15992 (if (member value allowed)
15993 (setq nval (car (cdr (member value allowed)))))
15994 (setq nval (or nval (car allowed)))
15995 (if (equal nval value)
15996 (user-error "Only one allowed value for this property"))
15997 (org-at-property-p)
15998 (replace-match (concat " :" key ": " nval) t t)
15999 (org-indent-line)
16000 (beginning-of-line 1)
16001 (skip-chars-forward " \t")
16002 (when (equal prop org-effort-property)
16003 (save-excursion
16004 (org-back-to-heading t)
16005 (put-text-property (point-at-bol) (point-at-eol) 'org-effort nval))
16006 (when (string= org-clock-current-task heading)
16007 (setq org-clock-effort nval)
16008 (org-clock-update-mode-line)))
16009 (run-hook-with-args 'org-property-changed-functions key nval)))
16011 (defun org-find-olp (path &optional this-buffer)
16012 "Return a marker pointing to the entry at outline path OLP.
16013 If anything goes wrong, throw an error.
16014 You can wrap this call to catch the error like this:
16016 (condition-case msg
16017 (org-mobile-locate-entry (match-string 4))
16018 (error (nth 1 msg)))
16020 The return value will then be either a string with the error message,
16021 or a marker if everything is OK.
16023 If THIS-BUFFER is set, the outline path does not contain a file,
16024 only headings."
16025 (let* ((file (if this-buffer buffer-file-name (pop path)))
16026 (buffer (if this-buffer (current-buffer) (find-file-noselect file)))
16027 (level 1)
16028 (lmin 1)
16029 (lmax 1)
16030 limit re end found pos heading cnt flevel)
16031 (unless buffer (error "File not found :%s" file))
16032 (with-current-buffer buffer
16033 (save-excursion
16034 (save-restriction
16035 (widen)
16036 (setq limit (point-max))
16037 (goto-char (point-min))
16038 (while (setq heading (pop path))
16039 (setq re (format org-complex-heading-regexp-format
16040 (regexp-quote heading)))
16041 (setq cnt 0 pos (point))
16042 (while (re-search-forward re end t)
16043 (setq level (- (match-end 1) (match-beginning 1)))
16044 (if (and (>= level lmin) (<= level lmax))
16045 (setq found (match-beginning 0) flevel level cnt (1+ cnt))))
16046 (when (= cnt 0) (error "Heading not found on level %d: %s"
16047 lmax heading))
16048 (when (> cnt 1) (error "Heading not unique on level %d: %s"
16049 lmax heading))
16050 (goto-char found)
16051 (setq lmin (1+ flevel) lmax (+ lmin (if org-odd-levels-only 1 0)))
16052 (setq end (save-excursion (org-end-of-subtree t t))))
16053 (when (org-at-heading-p)
16054 (point-marker)))))))
16056 (defun org-find-exact-headline-in-buffer (heading &optional buffer pos-only)
16057 "Find node HEADING in BUFFER.
16058 Return a marker to the heading if it was found, or nil if not.
16059 If POS-ONLY is set, return just the position instead of a marker.
16061 The heading text must match exact, but it may have a TODO keyword,
16062 a priority cookie and tags in the standard locations."
16063 (with-current-buffer (or buffer (current-buffer))
16064 (save-excursion
16065 (save-restriction
16066 (widen)
16067 (goto-char (point-min))
16068 (let (case-fold-search)
16069 (if (re-search-forward
16070 (format org-complex-heading-regexp-format
16071 (regexp-quote heading)) nil t)
16072 (if pos-only
16073 (match-beginning 0)
16074 (move-marker (make-marker) (match-beginning 0)))))))))
16076 (defun org-find-exact-heading-in-directory (heading &optional dir)
16077 "Find Org node headline HEADING in all .org files in directory DIR.
16078 When the target headline is found, return a marker to this location."
16079 (let ((files (directory-files (or dir default-directory)
16080 nil "\\`[^.#].*\\.org\\'"))
16081 file visiting m buffer)
16082 (catch 'found
16083 (while (setq file (pop files))
16084 (message "trying %s" file)
16085 (setq visiting (org-find-base-buffer-visiting file))
16086 (setq buffer (or visiting (find-file-noselect file)))
16087 (setq m (org-find-exact-headline-in-buffer
16088 heading buffer))
16089 (when (and (not m) (not visiting)) (kill-buffer buffer))
16090 (and m (throw 'found m))))))
16092 (defun org-find-entry-with-id (ident)
16093 "Locate the entry that contains the ID property with exact value IDENT.
16094 IDENT can be a string, a symbol or a number, this function will search for
16095 the string representation of it.
16096 Return the position where this entry starts, or nil if there is no such entry."
16097 (interactive "sID: ")
16098 (let ((id (cond
16099 ((stringp ident) ident)
16100 ((symbol-name ident) (symbol-name ident))
16101 ((numberp ident) (number-to-string ident))
16102 (t (error "IDENT %s must be a string, symbol or number" ident))))
16103 (case-fold-search nil))
16104 (save-excursion
16105 (save-restriction
16106 (widen)
16107 (goto-char (point-min))
16108 (when (re-search-forward
16109 (concat "^[ \t]*:ID:[ \t]+" (regexp-quote id) "[ \t]*$")
16110 nil t)
16111 (org-back-to-heading t)
16112 (point))))))
16114 ;;;; Timestamps
16116 (defvar org-last-changed-timestamp nil)
16117 (defvar org-last-inserted-timestamp nil
16118 "The last time stamp inserted with `org-insert-time-stamp'.")
16119 (defvar org-ts-what) ; dynamically scoped parameter
16121 (defun org-time-stamp (arg &optional inactive)
16122 "Prompt for a date/time and insert a time stamp.
16123 If the user specifies a time like HH:MM or if this command is
16124 called with at least one prefix argument, the time stamp contains
16125 the date and the time. Otherwise, only the date is be included.
16127 All parts of a date not specified by the user is filled in from
16128 the current date/time. So if you just press return without
16129 typing anything, the time stamp will represent the current
16130 date/time.
16132 If there is already a timestamp at the cursor, it will be
16133 modified.
16135 With two universal prefix arguments, insert an active timestamp
16136 with the current time without prompting the user.
16138 When called from lisp, the timestamp is inactive if INACTIVE is
16139 non-nil."
16140 (interactive "P")
16141 (let* ((ts nil)
16142 (default-time
16143 ;; Default time is either today, or, when entering a range,
16144 ;; the range start.
16145 (if (or (and (org-at-timestamp-p t) (setq ts (match-string 0)))
16146 (save-excursion
16147 (re-search-backward
16148 (concat org-ts-regexp "--?-?\\=") ; 1-3 minuses
16149 (- (point) 20) t)))
16150 (apply 'encode-time (org-parse-time-string (match-string 1)))
16151 (current-time)))
16152 (default-input (and ts (org-get-compact-tod ts)))
16153 (repeater (save-excursion
16154 (save-match-data
16155 (beginning-of-line)
16156 (when (re-search-forward
16157 "\\([.+-]+[0-9]+[hdwmy] ?\\)+" ;;\\(?:[/ ][-+]?[0-9]+[hdwmy]\\)?\\) ?"
16158 (save-excursion (progn (end-of-line) (point))) t)
16159 (match-string 0)))))
16160 org-time-was-given org-end-time-was-given time)
16161 (cond
16162 ((and (org-at-timestamp-p t)
16163 (memq last-command '(org-time-stamp org-time-stamp-inactive))
16164 (memq this-command '(org-time-stamp org-time-stamp-inactive)))
16165 (insert "--")
16166 (setq time (let ((this-command this-command))
16167 (org-read-date arg 'totime nil nil
16168 default-time default-input inactive)))
16169 (org-insert-time-stamp time (or org-time-was-given arg) inactive))
16170 ((org-at-timestamp-p t)
16171 (setq time (let ((this-command this-command))
16172 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16173 (when (org-at-timestamp-p t) ; just to get the match data
16174 ; (setq inactive (eq (char-after (match-beginning 0)) ?\[))
16175 (replace-match "")
16176 (setq org-last-changed-timestamp
16177 (org-insert-time-stamp
16178 time (or org-time-was-given arg)
16179 inactive nil nil (list org-end-time-was-given)))
16180 (when repeater (goto-char (1- (point))) (insert " " repeater)
16181 (setq org-last-changed-timestamp
16182 (concat (substring org-last-inserted-timestamp 0 -1)
16183 " " repeater ">"))))
16184 (message "Timestamp updated"))
16185 ((equal arg '(16))
16186 (org-insert-time-stamp (current-time) t inactive))
16188 (setq time (let ((this-command this-command))
16189 (org-read-date arg 'totime nil nil default-time default-input inactive)))
16190 (org-insert-time-stamp time (or org-time-was-given arg) inactive
16191 nil nil (list org-end-time-was-given))))))
16193 ;; FIXME: can we use this for something else, like computing time differences?
16194 (defun org-get-compact-tod (s)
16195 (when (string-match "\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\(-\\(\\([012]?[0-9]\\):\\([0-5][0-9]\\)\\)\\)?" s)
16196 (let* ((t1 (match-string 1 s))
16197 (h1 (string-to-number (match-string 2 s)))
16198 (m1 (string-to-number (match-string 3 s)))
16199 (t2 (and (match-end 4) (match-string 5 s)))
16200 (h2 (and t2 (string-to-number (match-string 6 s))))
16201 (m2 (and t2 (string-to-number (match-string 7 s))))
16202 dh dm)
16203 (if (not t2)
16205 (setq dh (- h2 h1) dm (- m2 m1))
16206 (if (< dm 0) (setq dm (+ dm 60) dh (1- dh)))
16207 (concat t1 "+" (number-to-string dh)
16208 (and (/= 0 dm) (format ":%02d" dm)))))))
16210 (defun org-time-stamp-inactive (&optional arg)
16211 "Insert an inactive time stamp.
16212 An inactive time stamp is enclosed in square brackets instead of angle
16213 brackets. It is inactive in the sense that it does not trigger agenda entries,
16214 does not link to the calendar and cannot be changed with the S-cursor keys.
16215 So these are more for recording a certain time/date."
16216 (interactive "P")
16217 (org-time-stamp arg 'inactive))
16219 (defvar org-date-ovl (make-overlay 1 1))
16220 (overlay-put org-date-ovl 'face 'org-date-selected)
16221 (org-detach-overlay org-date-ovl)
16223 (defvar org-ans1) ; dynamically scoped parameter
16224 (defvar org-ans2) ; dynamically scoped parameter
16226 (defvar org-plain-time-of-day-regexp) ; defined below
16228 (defvar org-overriding-default-time nil) ; dynamically scoped
16229 (defvar org-read-date-overlay nil)
16230 (defvar org-dcst nil) ; dynamically scoped
16231 (defvar org-read-date-history nil)
16232 (defvar org-read-date-final-answer nil)
16233 (defvar org-read-date-analyze-futurep nil)
16234 (defvar org-read-date-analyze-forced-year nil)
16235 (defvar org-read-date-inactive)
16237 (defvar org-read-date-minibuffer-local-map
16238 (let* ((org-replace-disputed-keys nil)
16239 (map (make-sparse-keymap)))
16240 (set-keymap-parent map minibuffer-local-map)
16241 (org-defkey map (kbd ".")
16242 (lambda () (interactive)
16243 ;; Are we at the beginning of the prompt?
16244 (if (looking-back "^[^:]+: ")
16245 (org-eval-in-calendar '(calendar-goto-today))
16246 (insert "."))))
16247 (org-defkey map (kbd "C-.")
16248 (lambda () (interactive)
16249 (org-eval-in-calendar '(calendar-goto-today))))
16250 (org-defkey map [(meta shift left)]
16251 (lambda () (interactive)
16252 (org-eval-in-calendar '(calendar-backward-month 1))))
16253 (org-defkey map [(meta shift right)]
16254 (lambda () (interactive)
16255 (org-eval-in-calendar '(calendar-forward-month 1))))
16256 (org-defkey map [(meta shift up)]
16257 (lambda () (interactive)
16258 (org-eval-in-calendar '(calendar-backward-year 1))))
16259 (org-defkey map [(meta shift down)]
16260 (lambda () (interactive)
16261 (org-eval-in-calendar '(calendar-forward-year 1))))
16262 (org-defkey map [?\e (shift left)]
16263 (lambda () (interactive)
16264 (org-eval-in-calendar '(calendar-backward-month 1))))
16265 (org-defkey map [?\e (shift right)]
16266 (lambda () (interactive)
16267 (org-eval-in-calendar '(calendar-forward-month 1))))
16268 (org-defkey map [?\e (shift up)]
16269 (lambda () (interactive)
16270 (org-eval-in-calendar '(calendar-backward-year 1))))
16271 (org-defkey map [?\e (shift down)]
16272 (lambda () (interactive)
16273 (org-eval-in-calendar '(calendar-forward-year 1))))
16274 (org-defkey map [(shift up)]
16275 (lambda () (interactive)
16276 (org-eval-in-calendar '(calendar-backward-week 1))))
16277 (org-defkey map [(shift down)]
16278 (lambda () (interactive)
16279 (org-eval-in-calendar '(calendar-forward-week 1))))
16280 (org-defkey map [(shift left)]
16281 (lambda () (interactive)
16282 (org-eval-in-calendar '(calendar-backward-day 1))))
16283 (org-defkey map [(shift right)]
16284 (lambda () (interactive)
16285 (org-eval-in-calendar '(calendar-forward-day 1))))
16286 (org-defkey map "!"
16287 (lambda () (interactive)
16288 (org-eval-in-calendar '(diary-view-entries))
16289 (message "")))
16290 (org-defkey map ">"
16291 (lambda () (interactive)
16292 (org-eval-in-calendar '(scroll-calendar-left 1))))
16293 (org-defkey map "<"
16294 (lambda () (interactive)
16295 (org-eval-in-calendar '(scroll-calendar-right 1))))
16296 (org-defkey map "\C-v"
16297 (lambda () (interactive)
16298 (org-eval-in-calendar
16299 '(calendar-scroll-left-three-months 1))))
16300 (org-defkey map "\M-v"
16301 (lambda () (interactive)
16302 (org-eval-in-calendar
16303 '(calendar-scroll-right-three-months 1))))
16304 map)
16305 "Keymap for minibuffer commands when using `org-read-date'.")
16307 (defvar org-def)
16308 (defvar org-defdecode)
16309 (defvar org-with-time)
16311 (defun org-read-date (&optional org-with-time to-time from-string prompt
16312 default-time default-input inactive)
16313 "Read a date, possibly a time, and make things smooth for the user.
16314 The prompt will suggest to enter an ISO date, but you can also enter anything
16315 which will at least partially be understood by `parse-time-string'.
16316 Unrecognized parts of the date will default to the current day, month, year,
16317 hour and minute. If this command is called to replace a timestamp at point,
16318 or to enter the second timestamp of a range, the default time is taken
16319 from the existing stamp. Furthermore, the command prefers the future,
16320 so if you are giving a date where the year is not given, and the day-month
16321 combination is already past in the current year, it will assume you
16322 mean next year. For details, see the manual. A few examples:
16324 3-2-5 --> 2003-02-05
16325 feb 15 --> currentyear-02-15
16326 2/15 --> currentyear-02-15
16327 sep 12 9 --> 2009-09-12
16328 12:45 --> today 12:45
16329 22 sept 0:34 --> currentyear-09-22 0:34
16330 12 --> currentyear-currentmonth-12
16331 Fri --> nearest Friday after today
16332 -Tue --> last Tuesday
16333 etc.
16335 Furthermore you can specify a relative date by giving, as the *first* thing
16336 in the input: a plus/minus sign, a number and a letter [hdwmy] to indicate
16337 change in days weeks, months, years.
16338 With a single plus or minus, the date is relative to today. With a double
16339 plus or minus, it is relative to the date in DEFAULT-TIME. E.g.
16340 +4d --> four days from today
16341 +4 --> same as above
16342 +2w --> two weeks from today
16343 ++5 --> five days from default date
16345 The function understands only English month and weekday abbreviations.
16347 While prompting, a calendar is popped up - you can also select the
16348 date with the mouse (button 1). The calendar shows a period of three
16349 months. To scroll it to other months, use the keys `>' and `<'.
16350 If you don't like the calendar, turn it off with
16351 \(setq org-read-date-popup-calendar nil)
16353 With optional argument TO-TIME, the date will immediately be converted
16354 to an internal time.
16355 With an optional argument ORG-WITH-TIME, the prompt will suggest to
16356 also insert a time. Note that when ORG-WITH-TIME is not set, you can
16357 still enter a time, and this function will inform the calling routine
16358 about this change. The calling routine may then choose to change the
16359 format used to insert the time stamp into the buffer to include the time.
16360 With optional argument FROM-STRING, read from this string instead from
16361 the user. PROMPT can overwrite the default prompt. DEFAULT-TIME is
16362 the time/date that is used for everything that is not specified by the
16363 user."
16364 (require 'parse-time)
16365 (let* ((org-time-stamp-rounding-minutes
16366 (if (equal org-with-time '(16)) '(0 0) org-time-stamp-rounding-minutes))
16367 (org-dcst org-display-custom-times)
16368 (ct (org-current-time))
16369 (org-def (or org-overriding-default-time default-time ct))
16370 (org-defdecode (decode-time org-def))
16371 (dummy (progn
16372 (when (< (nth 2 org-defdecode) org-extend-today-until)
16373 (setcar (nthcdr 2 org-defdecode) -1)
16374 (setcar (nthcdr 1 org-defdecode) 59)
16375 (setq org-def (apply 'encode-time org-defdecode)
16376 org-defdecode (decode-time org-def)))))
16377 (mouse-autoselect-window nil) ; Don't let the mouse jump
16378 (calendar-frame-setup nil)
16379 (calendar-setup nil)
16380 (calendar-move-hook nil)
16381 (calendar-view-diary-initially-flag nil)
16382 (calendar-view-holidays-initially-flag nil)
16383 (timestr (format-time-string
16384 (if org-with-time "%Y-%m-%d %H:%M" "%Y-%m-%d") org-def))
16385 (prompt (concat (if prompt (concat prompt " ") "")
16386 (format "Date+time [%s]: " timestr)))
16387 ans (org-ans0 "") org-ans1 org-ans2 final)
16389 (cond
16390 (from-string (setq ans from-string))
16391 (org-read-date-popup-calendar
16392 (save-excursion
16393 (save-window-excursion
16394 (calendar)
16395 (org-eval-in-calendar '(setq cursor-type nil) t)
16396 (unwind-protect
16397 (progn
16398 (calendar-forward-day (- (time-to-days org-def)
16399 (calendar-absolute-from-gregorian
16400 (calendar-current-date))))
16401 (org-eval-in-calendar nil t)
16402 (let* ((old-map (current-local-map))
16403 (map (copy-keymap calendar-mode-map))
16404 (minibuffer-local-map
16405 (copy-keymap org-read-date-minibuffer-local-map)))
16406 (org-defkey map (kbd "RET") 'org-calendar-select)
16407 (org-defkey map [mouse-1] 'org-calendar-select-mouse)
16408 (org-defkey map [mouse-2] 'org-calendar-select-mouse)
16409 (unwind-protect
16410 (progn
16411 (use-local-map map)
16412 (setq org-read-date-inactive inactive)
16413 (add-hook 'post-command-hook 'org-read-date-display)
16414 (setq org-ans0 (read-string prompt default-input
16415 'org-read-date-history nil))
16416 ;; org-ans0: from prompt
16417 ;; org-ans1: from mouse click
16418 ;; org-ans2: from calendar motion
16419 (setq ans (concat org-ans0 " " (or org-ans1 org-ans2))))
16420 (remove-hook 'post-command-hook 'org-read-date-display)
16421 (use-local-map old-map)
16422 (when org-read-date-overlay
16423 (delete-overlay org-read-date-overlay)
16424 (setq org-read-date-overlay nil)))))
16425 (bury-buffer "*Calendar*")))))
16427 (t ; Naked prompt only
16428 (unwind-protect
16429 (setq ans (read-string prompt default-input
16430 'org-read-date-history timestr))
16431 (when org-read-date-overlay
16432 (delete-overlay org-read-date-overlay)
16433 (setq org-read-date-overlay nil)))))
16435 (setq final (org-read-date-analyze ans org-def org-defdecode))
16437 (when org-read-date-analyze-forced-year
16438 (message "Year was forced into %s"
16439 (if org-read-date-force-compatible-dates
16440 "compatible range (1970-2037)"
16441 "range representable on this machine"))
16442 (ding))
16444 ;; One round trip to get rid of 34th of August and stuff like that....
16445 (setq final (decode-time (apply 'encode-time final)))
16447 (setq org-read-date-final-answer ans)
16449 (if to-time
16450 (apply 'encode-time final)
16451 (if (and (boundp 'org-time-was-given) org-time-was-given)
16452 (format "%04d-%02d-%02d %02d:%02d"
16453 (nth 5 final) (nth 4 final) (nth 3 final)
16454 (nth 2 final) (nth 1 final))
16455 (format "%04d-%02d-%02d" (nth 5 final) (nth 4 final) (nth 3 final))))))
16457 (defun org-read-date-display ()
16458 "Display the current date prompt interpretation in the minibuffer."
16459 (when org-read-date-display-live
16460 (when org-read-date-overlay
16461 (delete-overlay org-read-date-overlay))
16462 (when (minibufferp (current-buffer))
16463 (save-excursion
16464 (end-of-line 1)
16465 (while (not (equal (buffer-substring
16466 (max (point-min) (- (point) 4)) (point))
16467 " "))
16468 (insert " ")))
16469 (let* ((ans (concat (buffer-substring (point-at-bol) (point-max))
16470 " " (or org-ans1 org-ans2)))
16471 (org-end-time-was-given nil)
16472 (f (org-read-date-analyze ans org-def org-defdecode))
16473 (fmts (if org-dcst
16474 org-time-stamp-custom-formats
16475 org-time-stamp-formats))
16476 (fmt (if (or org-with-time
16477 (and (boundp 'org-time-was-given) org-time-was-given))
16478 (cdr fmts)
16479 (car fmts)))
16480 (txt (format-time-string fmt (apply 'encode-time f)))
16481 (txt (if org-read-date-inactive (concat "[" (substring txt 1 -1) "]") txt))
16482 (txt (concat "=> " txt)))
16483 (when (and org-end-time-was-given
16484 (string-match org-plain-time-of-day-regexp txt))
16485 (setq txt (concat (substring txt 0 (match-end 0)) "-"
16486 org-end-time-was-given
16487 (substring txt (match-end 0)))))
16488 (when org-read-date-analyze-futurep
16489 (setq txt (concat txt " (=>F)")))
16490 (setq org-read-date-overlay
16491 (make-overlay (1- (point-at-eol)) (point-at-eol)))
16492 (org-overlay-display org-read-date-overlay txt 'secondary-selection)))))
16494 (defun org-read-date-analyze (ans org-def org-defdecode)
16495 "Analyze the combined answer of the date prompt."
16496 ;; FIXME: cleanup and comment
16497 (let ((nowdecode (decode-time (current-time)))
16498 delta deltan deltaw deltadef year month day
16499 hour minute second wday pm h2 m2 tl wday1
16500 iso-year iso-weekday iso-week iso-year iso-date futurep kill-year)
16501 (setq org-read-date-analyze-futurep nil
16502 org-read-date-analyze-forced-year nil)
16503 (when (string-match "\\`[ \t]*\\.[ \t]*\\'" ans)
16504 (setq ans "+0"))
16506 (when (setq delta (org-read-date-get-relative ans (current-time) org-def))
16507 (setq ans (replace-match "" t t ans)
16508 deltan (car delta)
16509 deltaw (nth 1 delta)
16510 deltadef (nth 2 delta)))
16512 ;; Check if there is an iso week date in there. If yes, store the
16513 ;; info and postpone interpreting it until the rest of the parsing
16514 ;; is done.
16515 (when (string-match "\\<\\(?:\\([0-9]+\\)-\\)?[wW]\\([0-9]\\{1,2\\}\\)\\(?:-\\([0-6]\\)\\)?\\([ \t]\\|$\\)" ans)
16516 (setq iso-year (if (match-end 1)
16517 (org-small-year-to-year
16518 (string-to-number (match-string 1 ans))))
16519 iso-weekday (if (match-end 3)
16520 (string-to-number (match-string 3 ans)))
16521 iso-week (string-to-number (match-string 2 ans)))
16522 (setq ans (replace-match "" t t ans)))
16524 ;; Help matching ISO dates with single digit month or day, like 2006-8-11.
16525 (when (string-match
16526 "^ *\\(\\([0-9]+\\)-\\)?\\([0-1]?[0-9]\\)-\\([0-3]?[0-9]\\)\\([^-0-9]\\|$\\)" ans)
16527 (setq year (if (match-end 2)
16528 (string-to-number (match-string 2 ans))
16529 (progn (setq kill-year t)
16530 (string-to-number (format-time-string "%Y"))))
16531 month (string-to-number (match-string 3 ans))
16532 day (string-to-number (match-string 4 ans)))
16533 (if (< year 100) (setq year (+ 2000 year)))
16534 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16535 t nil ans)))
16537 ;; Help matching dotted european dates
16538 (when (string-match
16539 "^ *\\(3[01]\\|0?[1-9]\\|[12][0-9]\\)\\. ?\\(0?[1-9]\\|1[012]\\)\\.\\( ?[1-9][0-9]\\{3\\}\\)?" ans)
16540 (setq year (if (match-end 3) (string-to-number (match-string 3 ans))
16541 (setq kill-year t)
16542 (string-to-number (format-time-string "%Y")))
16543 day (string-to-number (match-string 1 ans))
16544 month (string-to-number (match-string 2 ans))
16545 ans (replace-match (format "%04d-%02d-%02d" year month day)
16546 t nil ans)))
16548 ;; Help matching american dates, like 5/30 or 5/30/7
16549 (when (string-match
16550 "^ *\\(0?[1-9]\\|1[012]\\)/\\(0?[1-9]\\|[12][0-9]\\|3[01]\\)\\(/\\([0-9]+\\)\\)?\\([^/0-9]\\|$\\)" ans)
16551 (setq year (if (match-end 4)
16552 (string-to-number (match-string 4 ans))
16553 (progn (setq kill-year t)
16554 (string-to-number (format-time-string "%Y"))))
16555 month (string-to-number (match-string 1 ans))
16556 day (string-to-number (match-string 2 ans)))
16557 (if (< year 100) (setq year (+ 2000 year)))
16558 (setq ans (replace-match (format "%04d-%02d-%02d\\5" year month day)
16559 t nil ans)))
16560 ;; Help matching am/pm times, because `parse-time-string' does not do that.
16561 ;; If there is a time with am/pm, and *no* time without it, we convert
16562 ;; so that matching will be successful.
16563 (loop for i from 1 to 2 do ; twice, for end time as well
16564 (when (and (not (string-match "\\(\\`\\|[^+]\\)[012]?[0-9]:[0-9][0-9]\\([ \t\n]\\|$\\)" ans))
16565 (string-match "\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?\\(am\\|AM\\|pm\\|PM\\)\\>" ans))
16566 (setq hour (string-to-number (match-string 1 ans))
16567 minute (if (match-end 3)
16568 (string-to-number (match-string 3 ans))
16570 pm (equal ?p
16571 (string-to-char (downcase (match-string 4 ans)))))
16572 (if (and (= hour 12) (not pm))
16573 (setq hour 0)
16574 (if (and pm (< hour 12)) (setq hour (+ 12 hour))))
16575 (setq ans (replace-match (format "%02d:%02d" hour minute)
16576 t t ans))))
16578 ;; Check if a time range is given as a duration
16579 (when (string-match "\\([012]?[0-9]\\):\\([0-6][0-9]\\)\\+\\([012]?[0-9]\\)\\(:\\([0-5][0-9]\\)\\)?" ans)
16580 (setq hour (string-to-number (match-string 1 ans))
16581 h2 (+ hour (string-to-number (match-string 3 ans)))
16582 minute (string-to-number (match-string 2 ans))
16583 m2 (+ minute (if (match-end 5) (string-to-number
16584 (match-string 5 ans))0)))
16585 (if (>= m2 60) (setq h2 (1+ h2) m2 (- m2 60)))
16586 (setq ans (replace-match (format "%02d:%02d-%02d:%02d" hour minute h2 m2)
16587 t t ans)))
16589 ;; Check if there is a time range
16590 (when (boundp 'org-end-time-was-given)
16591 (setq org-time-was-given nil)
16592 (when (and (string-match org-plain-time-of-day-regexp ans)
16593 (match-end 8))
16594 (setq org-end-time-was-given (match-string 8 ans))
16595 (setq ans (concat (substring ans 0 (match-beginning 7))
16596 (substring ans (match-end 7))))))
16598 (setq tl (parse-time-string ans)
16599 day (or (nth 3 tl) (nth 3 org-defdecode))
16600 month (or (nth 4 tl)
16601 (if (and org-read-date-prefer-future
16602 (nth 3 tl) (< (nth 3 tl) (nth 3 nowdecode)))
16603 (prog1 (1+ (nth 4 nowdecode)) (setq futurep t))
16604 (nth 4 org-defdecode)))
16605 year (or (and (not kill-year) (nth 5 tl))
16606 (if (and org-read-date-prefer-future
16607 (nth 4 tl) (< (nth 4 tl) (nth 4 nowdecode)))
16608 (prog1 (1+ (nth 5 nowdecode)) (setq futurep t))
16609 (nth 5 org-defdecode)))
16610 hour (or (nth 2 tl) (nth 2 org-defdecode))
16611 minute (or (nth 1 tl) (nth 1 org-defdecode))
16612 second (or (nth 0 tl) 0)
16613 wday (nth 6 tl))
16615 (when (and (eq org-read-date-prefer-future 'time)
16616 (not (nth 3 tl)) (not (nth 4 tl)) (not (nth 5 tl))
16617 (equal day (nth 3 nowdecode))
16618 (equal month (nth 4 nowdecode))
16619 (equal year (nth 5 nowdecode))
16620 (nth 2 tl)
16621 (or (< (nth 2 tl) (nth 2 nowdecode))
16622 (and (= (nth 2 tl) (nth 2 nowdecode))
16623 (nth 1 tl)
16624 (< (nth 1 tl) (nth 1 nowdecode)))))
16625 (setq day (1+ day)
16626 futurep t))
16628 ;; Special date definitions below
16629 (cond
16630 (iso-week
16631 ;; There was an iso week
16632 (require 'cal-iso)
16633 (setq futurep nil)
16634 (setq year (or iso-year year)
16635 day (or iso-weekday wday 1)
16636 wday nil ; to make sure that the trigger below does not match
16637 iso-date (calendar-gregorian-from-absolute
16638 (calendar-absolute-from-iso
16639 (list iso-week day year))))
16640 ; FIXME: Should we also push ISO weeks into the future?
16641 ; (when (and org-read-date-prefer-future
16642 ; (not iso-year)
16643 ; (< (calendar-absolute-from-gregorian iso-date)
16644 ; (time-to-days (current-time))))
16645 ; (setq year (1+ year)
16646 ; iso-date (calendar-gregorian-from-absolute
16647 ; (calendar-absolute-from-iso
16648 ; (list iso-week day year)))))
16649 (setq month (car iso-date)
16650 year (nth 2 iso-date)
16651 day (nth 1 iso-date)))
16652 (deltan
16653 (setq futurep nil)
16654 (unless deltadef
16655 (let ((now (decode-time (current-time))))
16656 (setq day (nth 3 now) month (nth 4 now) year (nth 5 now))))
16657 (cond ((member deltaw '("d" "")) (setq day (+ day deltan)))
16658 ((equal deltaw "w") (setq day (+ day (* 7 deltan))))
16659 ((equal deltaw "m") (setq month (+ month deltan)))
16660 ((equal deltaw "y") (setq year (+ year deltan)))))
16661 ((and wday (not (nth 3 tl)))
16662 ;; Weekday was given, but no day, so pick that day in the week
16663 ;; on or after the derived date.
16664 (setq wday1 (nth 6 (decode-time (encode-time 0 0 0 day month year))))
16665 (unless (equal wday wday1)
16666 (setq day (+ day (% (- wday wday1 -7) 7))))))
16667 (if (and (boundp 'org-time-was-given)
16668 (nth 2 tl))
16669 (setq org-time-was-given t))
16670 (if (< year 100) (setq year (+ 2000 year)))
16671 ;; Check of the date is representable
16672 (if org-read-date-force-compatible-dates
16673 (progn
16674 (if (< year 1970)
16675 (setq year 1970 org-read-date-analyze-forced-year t))
16676 (if (> year 2037)
16677 (setq year 2037 org-read-date-analyze-forced-year t)))
16678 (condition-case nil
16679 (ignore (encode-time second minute hour day month year))
16680 (error
16681 (setq year (nth 5 org-defdecode))
16682 (setq org-read-date-analyze-forced-year t))))
16683 (setq org-read-date-analyze-futurep futurep)
16684 (list second minute hour day month year)))
16686 (defvar parse-time-weekdays)
16687 (defun org-read-date-get-relative (s today default)
16688 "Check string S for special relative date string.
16689 TODAY and DEFAULT are internal times, for today and for a default.
16690 Return shift list (N what def-flag)
16691 WHAT is \"d\", \"w\", \"m\", or \"y\" for day, week, month, year.
16692 N is the number of WHATs to shift.
16693 DEF-FLAG is t when a double ++ or -- indicates shift relative to
16694 the DEFAULT date rather than TODAY."
16695 (require 'parse-time)
16696 (when (and
16697 (string-match
16698 (concat
16699 "\\`[ \t]*\\([-+]\\{0,2\\}\\)"
16700 "\\([0-9]+\\)?"
16701 "\\([hdwmy]\\|\\(" (mapconcat 'car parse-time-weekdays "\\|") "\\)\\)?"
16702 "\\([ \t]\\|$\\)") s)
16703 (or (> (match-end 1) (match-beginning 1)) (match-end 4)))
16704 (let* ((dir (if (> (match-end 1) (match-beginning 1))
16705 (string-to-char (substring (match-string 1 s) -1))
16706 ?+))
16707 (rel (and (match-end 1) (= 2 (- (match-end 1) (match-beginning 1)))))
16708 (n (if (match-end 2) (string-to-number (match-string 2 s)) 1))
16709 (what (if (match-end 3) (match-string 3 s) "d"))
16710 (wday1 (cdr (assoc (downcase what) parse-time-weekdays)))
16711 (date (if rel default today))
16712 (wday (nth 6 (decode-time date)))
16713 delta)
16714 (if wday1
16715 (progn
16716 (setq delta (mod (+ 7 (- wday1 wday)) 7))
16717 (if (= delta 0) (setq delta 7))
16718 (if (= dir ?-)
16719 (progn
16720 (setq delta (- delta 7))
16721 (if (= delta 0) (setq delta -7))))
16722 (if (> n 1) (setq delta (+ delta (* (1- n) (if (= dir ?-) -7 7)))))
16723 (list delta "d" rel))
16724 (list (* n (if (= dir ?-) -1 1)) what rel)))))
16726 (defun org-order-calendar-date-args (arg1 arg2 arg3)
16727 "Turn a user-specified date into the internal representation.
16728 The internal representation needed by the calendar is (month day year).
16729 This is a wrapper to handle the brain-dead convention in calendar that
16730 user function argument order change dependent on argument order."
16731 (if (boundp 'calendar-date-style)
16732 (cond
16733 ((eq calendar-date-style 'american)
16734 (list arg1 arg2 arg3))
16735 ((eq calendar-date-style 'european)
16736 (list arg2 arg1 arg3))
16737 ((eq calendar-date-style 'iso)
16738 (list arg2 arg3 arg1)))
16739 (org-no-warnings ;; european-calendar-style is obsolete as of version 23.1
16740 (if (org-bound-and-true-p european-calendar-style)
16741 (list arg2 arg1 arg3)
16742 (list arg1 arg2 arg3)))))
16744 (defun org-eval-in-calendar (form &optional keepdate)
16745 "Eval FORM in the calendar window and return to current window.
16746 When KEEPDATE is non-nil, update `org-ans2' from the cursor date,
16747 otherwise stick to the current value of `org-ans2'."
16748 (let ((sf (selected-frame))
16749 (sw (selected-window)))
16750 (select-window (get-buffer-window "*Calendar*" t))
16751 (eval form)
16752 (when (and (not keepdate) (calendar-cursor-to-date))
16753 (let* ((date (calendar-cursor-to-date))
16754 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16755 (setq org-ans2 (format-time-string "%Y-%m-%d" time))))
16756 (move-overlay org-date-ovl (1- (point)) (1+ (point)) (current-buffer))
16757 (select-window sw)
16758 (org-select-frame-set-input-focus sf)))
16760 (defun org-calendar-select ()
16761 "Return to `org-read-date' with the date currently selected.
16762 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16763 (interactive)
16764 (when (calendar-cursor-to-date)
16765 (let* ((date (calendar-cursor-to-date))
16766 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16767 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16768 (if (active-minibuffer-window) (exit-minibuffer))))
16770 (defun org-insert-time-stamp (time &optional with-hm inactive pre post extra)
16771 "Insert a date stamp for the date given by the internal TIME.
16772 WITH-HM means use the stamp format that includes the time of the day.
16773 INACTIVE means use square brackets instead of angular ones, so that the
16774 stamp will not contribute to the agenda.
16775 PRE and POST are optional strings to be inserted before and after the
16776 stamp.
16777 The command returns the inserted time stamp."
16778 (let ((fmt (funcall (if with-hm 'cdr 'car) org-time-stamp-formats))
16779 stamp)
16780 (if inactive (setq fmt (concat "[" (substring fmt 1 -1) "]")))
16781 (insert-before-markers (or pre ""))
16782 (when (listp extra)
16783 (setq extra (car extra))
16784 (if (and (stringp extra)
16785 (string-match "\\([0-9]+\\):\\([0-9]+\\)" extra))
16786 (setq extra (format "-%02d:%02d"
16787 (string-to-number (match-string 1 extra))
16788 (string-to-number (match-string 2 extra))))
16789 (setq extra nil)))
16790 (when extra
16791 (setq fmt (concat (substring fmt 0 -1) extra (substring fmt -1))))
16792 (insert-before-markers (setq stamp (format-time-string fmt time)))
16793 (insert-before-markers (or post ""))
16794 (setq org-last-inserted-timestamp stamp)))
16796 (defun org-toggle-time-stamp-overlays ()
16797 "Toggle the use of custom time stamp formats."
16798 (interactive)
16799 (setq org-display-custom-times (not org-display-custom-times))
16800 (unless org-display-custom-times
16801 (let ((p (point-min)) (bmp (buffer-modified-p)))
16802 (while (setq p (next-single-property-change p 'display))
16803 (if (and (get-text-property p 'display)
16804 (eq (get-text-property p 'face) 'org-date))
16805 (remove-text-properties
16806 p (setq p (next-single-property-change p 'display))
16807 '(display t))))
16808 (set-buffer-modified-p bmp)))
16809 (if (featurep 'xemacs)
16810 (remove-text-properties (point-min) (point-max) '(end-glyph t)))
16811 (org-restart-font-lock)
16812 (setq org-table-may-need-update t)
16813 (if org-display-custom-times
16814 (message "Time stamps are overlaid with custom format")
16815 (message "Time stamp overlays removed")))
16817 (defun org-display-custom-time (beg end)
16818 "Overlay modified time stamp format over timestamp between BEG and END."
16819 (let* ((ts (buffer-substring beg end))
16820 t1 w1 with-hm tf time str w2 (off 0))
16821 (save-match-data
16822 (setq t1 (org-parse-time-string ts t))
16823 (if (string-match "\\(-[0-9]+:[0-9]+\\)?\\( [.+]?\\+[0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)?\\'" ts)
16824 (setq off (- (match-end 0) (match-beginning 0)))))
16825 (setq end (- end off))
16826 (setq w1 (- end beg)
16827 with-hm (and (nth 1 t1) (nth 2 t1))
16828 tf (funcall (if with-hm 'cdr 'car) org-time-stamp-custom-formats)
16829 time (org-fix-decoded-time t1)
16830 str (org-add-props
16831 (format-time-string
16832 (substring tf 1 -1) (apply 'encode-time time))
16833 nil 'mouse-face 'highlight)
16834 w2 (length str))
16835 (if (not (= w2 w1))
16836 (add-text-properties (1+ beg) (+ 2 beg)
16837 (list 'org-dwidth t 'org-dwidth-n (- w1 w2))))
16838 (if (featurep 'xemacs)
16839 (progn
16840 (put-text-property beg end 'invisible t)
16841 (put-text-property beg end 'end-glyph (make-glyph str)))
16842 (put-text-property beg end 'display str))))
16844 (defun org-translate-time (string)
16845 "Translate all timestamps in STRING to custom format.
16846 But do this only if the variable `org-display-custom-times' is set."
16847 (when org-display-custom-times
16848 (save-match-data
16849 (let* ((start 0)
16850 (re org-ts-regexp-both)
16851 t1 with-hm inactive tf time str beg end)
16852 (while (setq start (string-match re string start))
16853 (setq beg (match-beginning 0)
16854 end (match-end 0)
16855 t1 (save-match-data
16856 (org-parse-time-string (substring string beg end) t))
16857 with-hm (and (nth 1 t1) (nth 2 t1))
16858 inactive (equal (substring string beg (1+ beg)) "[")
16859 tf (funcall (if with-hm 'cdr 'car)
16860 org-time-stamp-custom-formats)
16861 time (org-fix-decoded-time t1)
16862 str (format-time-string
16863 (concat
16864 (if inactive "[" "<") (substring tf 1 -1)
16865 (if inactive "]" ">"))
16866 (apply 'encode-time time))
16867 string (replace-match str t t string)
16868 start (+ start (length str)))))))
16869 string)
16871 (defun org-fix-decoded-time (time)
16872 "Set 0 instead of nil for the first 6 elements of time.
16873 Don't touch the rest."
16874 (let ((n 0))
16875 (mapcar (lambda (x) (if (< (setq n (1+ n)) 7) (or x 0) x)) time)))
16877 (define-obsolete-function-alias 'org-days-to-time 'org-time-stamp-to-now "24.4")
16879 (defun org-time-stamp-to-now (timestamp-string &optional seconds)
16880 "Difference between TIMESTAMP-STRING and now in days.
16881 If SECONDS is non-nil, return the difference in seconds."
16882 (let ((fdiff (if seconds 'org-float-time 'time-to-days)))
16883 (- (funcall fdiff (org-time-string-to-time timestamp-string))
16884 (funcall fdiff (current-time)))))
16886 (defun org-deadline-close (timestamp-string &optional ndays)
16887 "Is the time in TIMESTAMP-STRING close to the current date?"
16888 (setq ndays (or ndays (org-get-wdays timestamp-string)))
16889 (and (< (org-time-stamp-to-now timestamp-string) ndays)
16890 (not (org-entry-is-done-p))))
16892 (defun org-get-wdays (ts &optional delay zero-delay)
16893 "Get the deadline lead time appropriate for timestring TS.
16894 When DELAY is non-nil, get the delay time for scheduled items
16895 instead of the deadline lead time. When ZERO-DELAY is non-nil
16896 and `org-scheduled-delay-days' is 0, enforce 0 as the delay,
16897 don't try to find the delay cookie in the scheduled timestamp."
16898 (let ((tv (if delay org-scheduled-delay-days
16899 org-deadline-warning-days)))
16900 (cond
16901 ((or (and delay (< tv 0))
16902 (and delay zero-delay (<= tv 0))
16903 (and (not delay) (<= tv 0)))
16904 ;; Enforce this value no matter what
16905 (- tv))
16906 ((string-match "-\\([0-9]+\\)\\([hdwmy]\\)\\(\\'\\|>\\| \\)" ts)
16907 ;; lead time is specified.
16908 (floor (* (string-to-number (match-string 1 ts))
16909 (cdr (assoc (match-string 2 ts)
16910 '(("d" . 1) ("w" . 7)
16911 ("m" . 30.4) ("y" . 365.25)
16912 ("h" . 0.041667)))))))
16913 ;; go for the default.
16914 (t tv))))
16916 (defun org-calendar-select-mouse (ev)
16917 "Return to `org-read-date' with the date currently selected.
16918 This is used by `org-read-date' in a temporary keymap for the calendar buffer."
16919 (interactive "e")
16920 (mouse-set-point ev)
16921 (when (calendar-cursor-to-date)
16922 (let* ((date (calendar-cursor-to-date))
16923 (time (encode-time 0 0 0 (nth 1 date) (nth 0 date) (nth 2 date))))
16924 (setq org-ans1 (format-time-string "%Y-%m-%d" time)))
16925 (if (active-minibuffer-window) (exit-minibuffer))))
16927 (defun org-check-deadlines (ndays)
16928 "Check if there are any deadlines due or past due.
16929 A deadline is considered due if it happens within `org-deadline-warning-days'
16930 days from today's date. If the deadline appears in an entry marked DONE,
16931 it is not shown. The prefix arg NDAYS can be used to test that many
16932 days. If the prefix is a raw \\[universal-argument] prefix, all deadlines are shown."
16933 (interactive "P")
16934 (let* ((org-warn-days
16935 (cond
16936 ((equal ndays '(4)) 100000)
16937 (ndays (prefix-numeric-value ndays))
16938 (t (abs org-deadline-warning-days))))
16939 (case-fold-search nil)
16940 (regexp (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16941 (callback
16942 (lambda () (org-deadline-close (match-string 1) org-warn-days))))
16944 (message "%d deadlines past-due or due within %d days"
16945 (org-occur regexp nil callback)
16946 org-warn-days)))
16948 (defsubst org-re-timestamp (type)
16949 "Return a regexp for timestamp TYPE.
16950 Allowed values for TYPE are:
16952 all: all timestamps
16953 active: only active timestamps (<...>)
16954 inactive: only inactive timestamps ([...])
16955 scheduled: only scheduled timestamps
16956 deadline: only deadline timestamps
16957 closed: only closed time-stamps
16959 When TYPE is nil, fall back on returning a regexp that matches
16960 both scheduled and deadline timestamps."
16961 (cond ((eq type 'all) "\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\}\\(?: +[^]+0-9> \n -]+\\)?\\(?: +[0-9]\\{1,2\\}:[0-9]\\{2\\}\\)?\\)")
16962 ((eq type 'active) org-ts-regexp)
16963 ((eq type 'inactive) "\\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]")
16964 ((eq type 'scheduled) (concat "\\<" org-scheduled-string " *<\\([^>]+\\)>"))
16965 ((eq type 'deadline) (concat "\\<" org-deadline-string " *<\\([^>]+\\)>"))
16966 ((eq type 'closed) (concat org-closed-string " \\[\\([0-9]\\{4\\}-[0-9]\\{2\\}-[0-9]\\{2\\} ?[^ \n>]*?\\)\\]"))
16967 ((eq type 'scheduled-or-deadline)
16968 (concat "\\<\\(?:" org-deadline-string "\\|" org-scheduled-string "\\) *<\\([^>]+\\)>"))))
16970 (defun org-check-before-date (date)
16971 "Check if there are deadlines or scheduled entries before DATE."
16972 (interactive (list (org-read-date)))
16973 (let ((case-fold-search nil)
16974 (regexp (org-re-timestamp org-ts-type))
16975 (callback
16976 (lambda () (time-less-p
16977 (org-time-string-to-time (match-string 1))
16978 (org-time-string-to-time date)))))
16979 (message "%d entries before %s"
16980 (org-occur regexp nil callback) date)))
16982 (defun org-check-after-date (date)
16983 "Check if there are deadlines or scheduled entries after DATE."
16984 (interactive (list (org-read-date)))
16985 (let ((case-fold-search nil)
16986 (regexp (org-re-timestamp org-ts-type))
16987 (callback
16988 (lambda () (not
16989 (time-less-p
16990 (org-time-string-to-time (match-string 1))
16991 (org-time-string-to-time date))))))
16992 (message "%d entries after %s"
16993 (org-occur regexp nil callback) date)))
16995 (defun org-check-dates-range (start-date end-date)
16996 "Check for deadlines/scheduled entries between START-DATE and END-DATE."
16997 (interactive (list (org-read-date nil nil nil "Range starts")
16998 (org-read-date nil nil nil "Range end")))
16999 (let ((case-fold-search nil)
17000 (regexp (org-re-timestamp org-ts-type))
17001 (callback
17002 (lambda ()
17003 (let ((match (match-string 1)))
17004 (and
17005 (not (time-less-p
17006 (org-time-string-to-time match)
17007 (org-time-string-to-time start-date)))
17008 (time-less-p
17009 (org-time-string-to-time match)
17010 (org-time-string-to-time end-date)))))))
17011 (message "%d entries between %s and %s"
17012 (org-occur regexp nil callback) start-date end-date)))
17014 (defun org-evaluate-time-range (&optional to-buffer)
17015 "Evaluate a time range by computing the difference between start and end.
17016 Normally the result is just printed in the echo area, but with prefix arg
17017 TO-BUFFER, the result is inserted just after the date stamp into the buffer.
17018 If the time range is actually in a table, the result is inserted into the
17019 next column.
17020 For time difference computation, a year is assumed to be exactly 365
17021 days in order to avoid rounding problems."
17022 (interactive "P")
17024 (org-clock-update-time-maybe)
17025 (save-excursion
17026 (unless (org-at-date-range-p t)
17027 (goto-char (point-at-bol))
17028 (re-search-forward org-tr-regexp-both (point-at-eol) t))
17029 (if (not (org-at-date-range-p t))
17030 (user-error "Not at a time-stamp range, and none found in current line")))
17031 (let* ((ts1 (match-string 1))
17032 (ts2 (match-string 2))
17033 (havetime (or (> (length ts1) 15) (> (length ts2) 15)))
17034 (match-end (match-end 0))
17035 (time1 (org-time-string-to-time ts1))
17036 (time2 (org-time-string-to-time ts2))
17037 (t1 (org-float-time time1))
17038 (t2 (org-float-time time2))
17039 (diff (abs (- t2 t1)))
17040 (negative (< (- t2 t1) 0))
17041 ;; (ys (floor (* 365 24 60 60)))
17042 (ds (* 24 60 60))
17043 (hs (* 60 60))
17044 (fy "%dy %dd %02d:%02d")
17045 (fy1 "%dy %dd")
17046 (fd "%dd %02d:%02d")
17047 (fd1 "%dd")
17048 (fh "%02d:%02d")
17049 y d h m align)
17050 (if havetime
17051 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17053 d (floor (/ diff ds)) diff (mod diff ds)
17054 h (floor (/ diff hs)) diff (mod diff hs)
17055 m (floor (/ diff 60)))
17056 (setq ; y (floor (/ diff ys)) diff (mod diff ys)
17058 d (floor (+ (/ diff ds) 0.5))
17059 h 0 m 0))
17060 (if (not to-buffer)
17061 (message "%s" (org-make-tdiff-string y d h m))
17062 (if (org-at-table-p)
17063 (progn
17064 (goto-char match-end)
17065 (setq align t)
17066 (and (looking-at " *|") (goto-char (match-end 0))))
17067 (goto-char match-end))
17068 (if (looking-at
17069 "\\( *-? *[0-9]+y\\)?\\( *[0-9]+d\\)? *[0-9][0-9]:[0-9][0-9]")
17070 (replace-match ""))
17071 (if negative (insert " -"))
17072 (if (> y 0) (insert " " (format (if havetime fy fy1) y d h m))
17073 (if (> d 0) (insert " " (format (if havetime fd fd1) d h m))
17074 (insert " " (format fh h m))))
17075 (if align (org-table-align))
17076 (message "Time difference inserted")))))
17078 (defun org-make-tdiff-string (y d h m)
17079 (let ((fmt "")
17080 (l nil))
17081 (if (> y 0) (setq fmt (concat fmt "%d year" (if (> y 1) "s" "") " ")
17082 l (push y l)))
17083 (if (> d 0) (setq fmt (concat fmt "%d day" (if (> d 1) "s" "") " ")
17084 l (push d l)))
17085 (if (> h 0) (setq fmt (concat fmt "%d hour" (if (> h 1) "s" "") " ")
17086 l (push h l)))
17087 (if (> m 0) (setq fmt (concat fmt "%d minute" (if (> m 1) "s" "") " ")
17088 l (push m l)))
17089 (apply 'format fmt (nreverse l))))
17091 (defun org-time-string-to-time (s &optional buffer pos)
17092 "Convert a timestamp string into internal time."
17093 (condition-case errdata
17094 (apply 'encode-time (org-parse-time-string s))
17095 (error (error "Bad timestamp `%s'%s\nError was: %s"
17096 s (if (not (and buffer pos))
17098 (format " at %d in buffer `%s'" pos buffer))
17099 (cdr errdata)))))
17101 (defun org-time-string-to-seconds (s)
17102 "Convert a timestamp string to a number of seconds."
17103 (org-float-time (org-time-string-to-time s)))
17105 (defun org-time-string-to-absolute (s &optional daynr prefer show-all buffer pos)
17106 "Convert a time stamp to an absolute day number.
17107 If there is a specifier for a cyclic time stamp, get the closest
17108 date to DAYNR.
17109 PREFER and SHOW-ALL are passed through to `org-closest-date'.
17110 The variable `date' is bound by the calendar when this is called."
17111 (cond
17112 ((and daynr (string-match "\\`%%\\((.*)\\)" s))
17113 (if (org-diary-sexp-entry (match-string 1 s) "" date)
17114 daynr
17115 (+ daynr 1000)))
17116 ((and daynr (string-match "\\+[0-9]+[hdwmy]" s))
17117 (org-closest-date s (if (and (boundp 'daynr) (integerp daynr)) daynr
17118 (time-to-days (current-time))) (match-string 0 s)
17119 prefer show-all))
17120 (t (time-to-days
17121 (condition-case errdata
17122 (apply 'encode-time (org-parse-time-string s))
17123 (error (error "Bad timestamp `%s'%s\nError was: %s"
17124 s (if (not (and buffer pos))
17126 (format " at %d in buffer `%s'" pos buffer))
17127 (cdr errdata))))))))
17129 (defun org-days-to-iso-week (days)
17130 "Return the iso week number."
17131 (require 'cal-iso)
17132 (car (calendar-iso-from-absolute days)))
17134 (defun org-small-year-to-year (year)
17135 "Convert 2-digit years into 4-digit years.
17136 38-99 are mapped into 1938-1999. 1-37 are mapped into 2001-2037.
17137 The year 2000 cannot be abbreviated. Any year larger than 99
17138 is returned unchanged."
17139 (if (< year 38)
17140 (setq year (+ 2000 year))
17141 (if (< year 100)
17142 (setq year (+ 1900 year))))
17143 year)
17145 (defun org-time-from-absolute (d)
17146 "Return the time corresponding to date D.
17147 D may be an absolute day number, or a calendar-type list (month day year)."
17148 (if (numberp d) (setq d (calendar-gregorian-from-absolute d)))
17149 (encode-time 0 0 0 (nth 1 d) (car d) (nth 2 d)))
17151 (defun org-calendar-holiday ()
17152 "List of holidays, for Diary display in Org-mode."
17153 (require 'holidays)
17154 (let ((hl (funcall
17155 (if (fboundp 'calendar-check-holidays)
17156 'calendar-check-holidays 'check-calendar-holidays) date)))
17157 (if hl (mapconcat 'identity hl "; "))))
17159 (defun org-diary-sexp-entry (sexp entry date)
17160 "Process a SEXP diary ENTRY for DATE."
17161 (require 'diary-lib)
17162 (let ((result (if calendar-debug-sexp
17163 (let ((stack-trace-on-error t))
17164 (eval (car (read-from-string sexp))))
17165 (condition-case nil
17166 (eval (car (read-from-string sexp)))
17167 (error
17168 (beep)
17169 (message "Bad sexp at line %d in %s: %s"
17170 (org-current-line)
17171 (buffer-file-name) sexp)
17172 (sleep-for 2))))))
17173 (cond ((stringp result) (split-string result "; "))
17174 ((and (consp result)
17175 (not (consp (cdr result)))
17176 (stringp (cdr result))) (cdr result))
17177 ((and (consp result)
17178 (stringp (car result))) result)
17179 (result entry))))
17181 (defun org-diary-to-ical-string (frombuf)
17182 "Get iCalendar entries from diary entries in buffer FROMBUF.
17183 This uses the icalendar.el library."
17184 (let* ((tmpdir (if (featurep 'xemacs)
17185 (temp-directory)
17186 temporary-file-directory))
17187 (tmpfile (make-temp-name
17188 (expand-file-name "orgics" tmpdir)))
17189 buf rtn b e)
17190 (with-current-buffer frombuf
17191 (icalendar-export-region (point-min) (point-max) tmpfile)
17192 (setq buf (find-buffer-visiting tmpfile))
17193 (set-buffer buf)
17194 (goto-char (point-min))
17195 (if (re-search-forward "^BEGIN:VEVENT" nil t)
17196 (setq b (match-beginning 0)))
17197 (goto-char (point-max))
17198 (if (re-search-backward "^END:VEVENT" nil t)
17199 (setq e (match-end 0)))
17200 (setq rtn (if (and b e) (concat (buffer-substring b e) "\n") "")))
17201 (kill-buffer buf)
17202 (delete-file tmpfile)
17203 rtn))
17205 (defun org-closest-date (start current change prefer show-all)
17206 "Find the date closest to CURRENT that is consistent with START and CHANGE.
17207 When PREFER is `past', return a date that is either CURRENT or past.
17208 When PREFER is `future', return a date that is either CURRENT or future.
17209 When SHOW-ALL is nil, only return the current occurrence of a time stamp."
17210 ;; Make the proper lists from the dates
17211 (catch 'exit
17212 (let ((a1 '(("h" . hour)
17213 ("d" . day)
17214 ("w" . week)
17215 ("m" . month)
17216 ("y" . year)))
17217 (shour (nth 2 (org-parse-time-string start)))
17218 dn dw sday cday n1 n2 n0
17219 d m y y1 y2 date1 date2 nmonths nm ny m2)
17221 (setq start (org-date-to-gregorian start)
17222 current (org-date-to-gregorian
17223 (if show-all
17224 current
17225 (time-to-days (current-time))))
17226 sday (calendar-absolute-from-gregorian start)
17227 cday (calendar-absolute-from-gregorian current))
17229 (if (<= cday sday) (throw 'exit sday))
17231 (if (string-match "\\(\\+[0-9]+\\)\\([hdwmy]\\)" change)
17232 (setq dn (string-to-number (match-string 1 change))
17233 dw (cdr (assoc (match-string 2 change) a1)))
17234 (user-error "Invalid change specifier: %s" change))
17235 (if (eq dw 'week) (setq dw 'day dn (* 7 dn)))
17236 (cond
17237 ((eq dw 'hour)
17238 (let ((missing-hours
17239 (mod (+ (- (* 24 (- cday sday)) shour) org-extend-today-until)
17240 dn)))
17241 (setq n1 (if (zerop missing-hours) cday
17242 (- cday (1+ (floor (/ missing-hours 24)))))
17243 n2 (+ cday (floor (/ (- dn missing-hours) 24))))))
17244 ((eq dw 'day)
17245 (setq n1 (+ sday (* dn (floor (/ (- cday sday) dn))))
17246 n2 (+ n1 dn)))
17247 ((eq dw 'year)
17248 (setq d (nth 1 start) m (car start) y1 (nth 2 start) y2 (nth 2 current))
17249 (setq y1 (+ (* (floor (/ (- y2 y1) dn)) dn) y1))
17250 (setq date1 (list m d y1)
17251 n1 (calendar-absolute-from-gregorian date1)
17252 date2 (list m d (+ y1 (* (if (< n1 cday) 1 -1) dn)))
17253 n2 (calendar-absolute-from-gregorian date2)))
17254 ((eq dw 'month)
17255 ;; approx number of month between the two dates
17256 (setq nmonths (floor (/ (- cday sday) 30.436875)))
17257 ;; How often does dn fit in there?
17258 (setq d (nth 1 start) m (car start) y (nth 2 start)
17259 nm (* dn (max 0 (1- (floor (/ nmonths dn)))))
17260 m (+ m nm)
17261 ny (floor (/ m 12))
17262 y (+ y ny)
17263 m (- m (* ny 12)))
17264 (while (> m 12) (setq m (- m 12) y (1+ y)))
17265 (setq n1 (calendar-absolute-from-gregorian (list m d y)))
17266 (setq m2 (+ m dn) y2 y)
17267 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17268 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2)))
17269 (while (<= n2 cday)
17270 (setq n1 n2 m m2 y y2)
17271 (setq m2 (+ m dn) y2 y)
17272 (if (> m2 12) (setq y2 (1+ y2) m2 (- m2 12)))
17273 (setq n2 (calendar-absolute-from-gregorian (list m2 d y2))))))
17274 ;; Make sure n1 is the earlier date
17275 (setq n0 n1 n1 (min n1 n2) n2 (max n0 n2))
17276 (if show-all
17277 (cond
17278 ((eq prefer 'past) (if (= cday n2) n2 n1))
17279 ((eq prefer 'future) (if (= cday n1) n1 n2))
17280 (t (if (> (abs (- cday n1)) (abs (- cday n2))) n2 n1)))
17281 (cond
17282 ((eq prefer 'past) (if (= cday n2) n2 n1))
17283 ((eq prefer 'future) (if (= cday n1) n1 n2))
17284 (t (if (= cday n1) n1 n2)))))))
17286 (defun org-date-to-gregorian (date)
17287 "Turn any specification of DATE into a Gregorian date for the calendar."
17288 (cond ((integerp date) (calendar-gregorian-from-absolute date))
17289 ((and (listp date) (= (length date) 3)) date)
17290 ((stringp date)
17291 (setq date (org-parse-time-string date))
17292 (list (nth 4 date) (nth 3 date) (nth 5 date)))
17293 ((listp date)
17294 (list (nth 4 date) (nth 3 date) (nth 5 date)))))
17296 (defun org-parse-time-string (s &optional nodefault)
17297 "Parse the standard Org-mode time string.
17298 This should be a lot faster than the normal `parse-time-string'.
17299 If time is not given, defaults to 0:00. However, with optional NODEFAULT,
17300 hour and minute fields will be nil if not given."
17301 (cond ((string-match org-ts-regexp0 s)
17302 (list 0
17303 (if (or (match-beginning 8) (not nodefault))
17304 (string-to-number (or (match-string 8 s) "0")))
17305 (if (or (match-beginning 7) (not nodefault))
17306 (string-to-number (or (match-string 7 s) "0")))
17307 (string-to-number (match-string 4 s))
17308 (string-to-number (match-string 3 s))
17309 (string-to-number (match-string 2 s))
17310 nil nil nil))
17311 ((string-match "^<[^>]+>$" s)
17312 (decode-time (seconds-to-time (org-matcher-time s))))
17313 (t (error "Not a standard Org-mode time string: %s" s))))
17315 (defun org-timestamp-up (&optional arg)
17316 "Increase the date item at the cursor by one.
17317 If the cursor is on the year, change the year. If it is on the month,
17318 the day or the time, change that.
17319 With prefix ARG, change by that many units."
17320 (interactive "p")
17321 (org-timestamp-change (prefix-numeric-value arg) nil 'updown))
17323 (defun org-timestamp-down (&optional arg)
17324 "Decrease the date item at the cursor by one.
17325 If the cursor is on the year, change the year. If it is on the month,
17326 the day or the time, change that.
17327 With prefix ARG, change by that many units."
17328 (interactive "p")
17329 (org-timestamp-change (- (prefix-numeric-value arg)) nil 'updown))
17331 (defun org-timestamp-up-day (&optional arg)
17332 "Increase the date in the time stamp by one day.
17333 With prefix ARG, change that many days."
17334 (interactive "p")
17335 (if (and (not (org-at-timestamp-p t))
17336 (org-at-heading-p))
17337 (org-todo 'up)
17338 (org-timestamp-change (prefix-numeric-value arg) 'day 'updown)))
17340 (defun org-timestamp-down-day (&optional arg)
17341 "Decrease the date in the time stamp by one day.
17342 With prefix ARG, change that many days."
17343 (interactive "p")
17344 (if (and (not (org-at-timestamp-p t))
17345 (org-at-heading-p))
17346 (org-todo 'down)
17347 (org-timestamp-change (- (prefix-numeric-value arg)) 'day) 'updown))
17349 (defun org-at-timestamp-p (&optional inactive-ok)
17350 "Determine if the cursor is in or at a timestamp."
17351 (interactive)
17352 (let* ((tsr (if inactive-ok org-ts-regexp3 org-ts-regexp2))
17353 (pos (point))
17354 (ans (or (looking-at tsr)
17355 (save-excursion
17356 (skip-chars-backward "^[<\n\r\t")
17357 (if (> (point) (point-min)) (backward-char 1))
17358 (and (looking-at tsr)
17359 (> (- (match-end 0) pos) -1))))))
17360 (and ans
17361 (boundp 'org-ts-what)
17362 (setq org-ts-what
17363 (cond
17364 ((= pos (match-beginning 0)) 'bracket)
17365 ;; Point is considered to be "on the bracket" whether
17366 ;; it's really on it or right after it.
17367 ((= pos (1- (match-end 0))) 'bracket)
17368 ((= pos (match-end 0)) 'after)
17369 ((org-pos-in-match-range pos 2) 'year)
17370 ((org-pos-in-match-range pos 3) 'month)
17371 ((org-pos-in-match-range pos 7) 'hour)
17372 ((org-pos-in-match-range pos 8) 'minute)
17373 ((or (org-pos-in-match-range pos 4)
17374 (org-pos-in-match-range pos 5)) 'day)
17375 ((and (> pos (or (match-end 8) (match-end 5)))
17376 (< pos (match-end 0)))
17377 (- pos (or (match-end 8) (match-end 5))))
17378 (t 'day))))
17379 ans))
17381 (defun org-toggle-timestamp-type ()
17382 "Toggle the type (<active> or [inactive]) of a time stamp."
17383 (interactive)
17384 (when (org-at-timestamp-p t)
17385 (let ((beg (match-beginning 0)) (end (match-end 0))
17386 (map '((?\[ . "<") (?\] . ">") (?< . "[") (?> . "]"))))
17387 (save-excursion
17388 (goto-char beg)
17389 (while (re-search-forward "[][<>]" end t)
17390 (replace-match (cdr (assoc (char-after (match-beginning 0)) map))
17391 t t)))
17392 (message "Timestamp is now %sactive"
17393 (if (equal (char-after beg) ?<) "" "in")))))
17395 (defun org-at-clock-log-p nil
17396 "Is the cursor on the clock log line?"
17397 (save-excursion
17398 (move-beginning-of-line 1)
17399 (looking-at "^[ \t]*CLOCK:")))
17401 (defvar org-clock-history) ; defined in org-clock.el
17402 (defvar org-clock-adjust-closest nil) ; defined in org-clock.el
17403 (defun org-timestamp-change (n &optional what updown suppress-tmp-delay)
17404 "Change the date in the time stamp at point.
17405 The date will be changed by N times WHAT. WHAT can be `day', `month',
17406 `year', `minute', `second'. If WHAT is not given, the cursor position
17407 in the timestamp determines what will be changed.
17408 When SUPPRESS-TMP-DELAY is non-nil, suppress delays like \"--2d\"."
17409 (let ((origin (point)) origin-cat
17410 with-hm inactive
17411 (dm (max (nth 1 org-time-stamp-rounding-minutes) 1))
17412 org-ts-what
17413 extra rem
17414 ts time time0 fixnext clrgx)
17415 (if (not (org-at-timestamp-p t))
17416 (user-error "Not at a timestamp"))
17417 (if (and (not what) (eq org-ts-what 'bracket))
17418 (org-toggle-timestamp-type)
17419 ;; Point isn't on brackets. Remember the part of the time-stamp
17420 ;; the point was in. Indeed, size of time-stamps may change,
17421 ;; but point must be kept in the same category nonetheless.
17422 (setq origin-cat org-ts-what)
17423 (if (and (not what) (not (eq org-ts-what 'day))
17424 org-display-custom-times
17425 (get-text-property (point) 'display)
17426 (not (get-text-property (1- (point)) 'display)))
17427 (setq org-ts-what 'day))
17428 (setq org-ts-what (or what org-ts-what)
17429 inactive (= (char-after (match-beginning 0)) ?\[)
17430 ts (match-string 0))
17431 (replace-match "")
17432 (when (string-match
17433 "\\(\\(-[012][0-9]:[0-5][0-9]\\)?\\( +[.+]?-?[-+][0-9]+[hdwmy]\\(/[0-9]+[hdwmy]\\)?\\)*\\)[]>]"
17435 (setq extra (match-string 1 ts))
17436 (if suppress-tmp-delay
17437 (setq extra (replace-regexp-in-string " --[0-9]+[hdwmy]" "" extra))))
17438 (if (string-match "^.\\{10\\}.*?[0-9]+:[0-9][0-9]" ts)
17439 (setq with-hm t))
17440 (setq time0 (org-parse-time-string ts))
17441 (when (and updown
17442 (eq org-ts-what 'minute)
17443 (not current-prefix-arg))
17444 ;; This looks like s-up and s-down. Change by one rounding step.
17445 (setq n (* dm (cond ((> n 0) 1) ((< n 0) -1) (t 0))))
17446 (when (not (= 0 (setq rem (% (nth 1 time0) dm))))
17447 (setcar (cdr time0) (+ (nth 1 time0)
17448 (if (> n 0) (- rem) (- dm rem))))))
17449 (setq time
17450 (encode-time (or (car time0) 0)
17451 (+ (if (eq org-ts-what 'minute) n 0) (nth 1 time0))
17452 (+ (if (eq org-ts-what 'hour) n 0) (nth 2 time0))
17453 (+ (if (eq org-ts-what 'day) n 0) (nth 3 time0))
17454 (+ (if (eq org-ts-what 'month) n 0) (nth 4 time0))
17455 (+ (if (eq org-ts-what 'year) n 0) (nth 5 time0))
17456 (nthcdr 6 time0)))
17457 (when (and (member org-ts-what '(hour minute))
17458 extra
17459 (string-match "-\\([012][0-9]\\):\\([0-5][0-9]\\)" extra))
17460 (setq extra (org-modify-ts-extra
17461 extra
17462 (if (eq org-ts-what 'hour) 2 5)
17463 n dm)))
17464 (when (integerp org-ts-what)
17465 (setq extra (org-modify-ts-extra extra org-ts-what n dm)))
17466 (if (eq what 'calendar)
17467 (let ((cal-date (org-get-date-from-calendar)))
17468 (setcar (nthcdr 4 time0) (nth 0 cal-date)) ; month
17469 (setcar (nthcdr 3 time0) (nth 1 cal-date)) ; day
17470 (setcar (nthcdr 5 time0) (nth 2 cal-date)) ; year
17471 (setcar time0 (or (car time0) 0))
17472 (setcar (nthcdr 1 time0) (or (nth 1 time0) 0))
17473 (setcar (nthcdr 2 time0) (or (nth 2 time0) 0))
17474 (setq time (apply 'encode-time time0))))
17475 ;; Insert the new time-stamp, and ensure point stays in the same
17476 ;; category as before (i.e. not after the last position in that
17477 ;; category).
17478 (let ((pos (point)))
17479 ;; Stay before inserted string. `save-excursion' is of no use.
17480 (setq org-last-changed-timestamp
17481 (org-insert-time-stamp time with-hm inactive nil nil extra))
17482 (goto-char pos))
17483 (save-match-data
17484 (looking-at org-ts-regexp3)
17485 (goto-char (cond
17486 ;; `day' category ends before `hour' if any, or at
17487 ;; the end of the day name.
17488 ((eq origin-cat 'day)
17489 (min (or (match-beginning 7) (1- (match-end 5))) origin))
17490 ((eq origin-cat 'hour) (min (match-end 7) origin))
17491 ((eq origin-cat 'minute) (min (1- (match-end 8)) origin))
17492 ((integerp origin-cat) (min (1- (match-end 0)) origin))
17493 ;; `year' and `month' have both fixed size: point
17494 ;; couldn't have moved into another part.
17495 (t origin))))
17496 ;; Update clock if on a CLOCK line.
17497 (org-clock-update-time-maybe)
17498 ;; Maybe adjust the closest clock in `org-clock-history'
17499 (when org-clock-adjust-closest
17500 (if (not (and (org-at-clock-log-p)
17501 (< 1 (length (delq nil (mapcar 'marker-position
17502 org-clock-history))))))
17503 (message "No clock to adjust")
17504 (cond ((save-excursion ; fix previous clock?
17505 (re-search-backward org-ts-regexp0 nil t)
17506 (org-looking-back (concat org-clock-string " \\[")))
17507 (setq fixnext 1 clrgx (concat org-ts-regexp0 "\\] =>.*$")))
17508 ((save-excursion ; fix next clock?
17509 (re-search-backward org-ts-regexp0 nil t)
17510 (looking-at (concat org-ts-regexp0 "\\] =>")))
17511 (setq fixnext -1 clrgx (concat org-clock-string " \\[" org-ts-regexp0))))
17512 (save-window-excursion
17513 ;; Find closest clock to point, adjust the previous/next one in history
17514 (let* ((p (save-excursion (org-back-to-heading t)))
17515 (cl (mapcar (lambda(c) (abs (- (marker-position c) p))) org-clock-history))
17516 (clfixnth
17517 (+ fixnext (- (length cl) (or (length (member (apply #'min cl) cl)) 100))))
17518 (clfixpos (if (> 0 clfixnth) nil (nth clfixnth org-clock-history))))
17519 (if (not clfixpos)
17520 (message "No clock to adjust")
17521 (save-excursion
17522 (org-goto-marker-or-bmk clfixpos)
17523 (org-show-subtree)
17524 (when (re-search-forward clrgx nil t)
17525 (goto-char (match-beginning 1))
17526 (let (org-clock-adjust-closest)
17527 (org-timestamp-change n org-ts-what updown))
17528 (message "Clock adjusted in %s for heading: %s"
17529 (file-name-nondirectory (buffer-file-name))
17530 (org-get-heading t t)))))))))
17531 ;; Try to recenter the calendar window, if any.
17532 (if (and org-calendar-follow-timestamp-change
17533 (get-buffer-window "*Calendar*" t)
17534 (memq org-ts-what '(day month year)))
17535 (org-recenter-calendar (time-to-days time))))))
17537 (defun org-modify-ts-extra (s pos n dm)
17538 "Change the different parts of the lead-time and repeat fields in timestamp."
17539 (let ((idx '(("d" . 0) ("w" . 1) ("m" . 2) ("y" . 3) ("d" . -1) ("y" . 4)))
17540 ng h m new rem)
17541 (when (string-match "\\(-\\([012][0-9]\\):\\([0-5][0-9]\\)\\)?\\( +\\+\\([0-9]+\\)\\([dmwy]\\)\\)?\\( +-\\([0-9]+\\)\\([dmwy]\\)\\)?" s)
17542 (cond
17543 ((or (org-pos-in-match-range pos 2)
17544 (org-pos-in-match-range pos 3))
17545 (setq m (string-to-number (match-string 3 s))
17546 h (string-to-number (match-string 2 s)))
17547 (if (org-pos-in-match-range pos 2)
17548 (setq h (+ h n))
17549 (setq n (* dm (org-no-warnings (signum n))))
17550 (when (not (= 0 (setq rem (% m dm))))
17551 (setq m (+ m (if (> n 0) (- rem) (- dm rem)))))
17552 (setq m (+ m n)))
17553 (if (< m 0) (setq m (+ m 60) h (1- h)))
17554 (if (> m 59) (setq m (- m 60) h (1+ h)))
17555 (setq h (min 24 (max 0 h)))
17556 (setq ng 1 new (format "-%02d:%02d" h m)))
17557 ((org-pos-in-match-range pos 6)
17558 (setq ng 6 new (car (rassoc (+ n (cdr (assoc (match-string 6 s) idx))) idx))))
17559 ((org-pos-in-match-range pos 5)
17560 (setq ng 5 new (format "%d" (max 1 (+ n (string-to-number (match-string 5 s)))))))
17562 ((org-pos-in-match-range pos 9)
17563 (setq ng 9 new (car (rassoc (+ n (cdr (assoc (match-string 9 s) idx))) idx))))
17564 ((org-pos-in-match-range pos 8)
17565 (setq ng 8 new (format "%d" (max 0 (+ n (string-to-number (match-string 8 s))))))))
17567 (when ng
17568 (setq s (concat
17569 (substring s 0 (match-beginning ng))
17571 (substring s (match-end ng))))))
17574 (defun org-recenter-calendar (date)
17575 "If the calendar is visible, recenter it to DATE."
17576 (let ((cwin (get-buffer-window "*Calendar*" t)))
17577 (when cwin
17578 (let ((calendar-move-hook nil))
17579 (with-selected-window cwin
17580 (calendar-goto-date (if (listp date) date
17581 (calendar-gregorian-from-absolute date))))))))
17583 (defun org-goto-calendar (&optional arg)
17584 "Go to the Emacs calendar at the current date.
17585 If there is a time stamp in the current line, go to that date.
17586 A prefix ARG can be used to force the current date."
17587 (interactive "P")
17588 (let ((tsr org-ts-regexp) diff
17589 (calendar-move-hook nil)
17590 (calendar-view-holidays-initially-flag nil)
17591 (calendar-view-diary-initially-flag nil))
17592 (if (or (org-at-timestamp-p)
17593 (save-excursion
17594 (beginning-of-line 1)
17595 (looking-at (concat ".*" tsr))))
17596 (let ((d1 (time-to-days (current-time)))
17597 (d2 (time-to-days
17598 (org-time-string-to-time (match-string 1)))))
17599 (setq diff (- d2 d1))))
17600 (calendar)
17601 (calendar-goto-today)
17602 (if (and diff (not arg)) (calendar-forward-day diff))))
17604 (defun org-get-date-from-calendar ()
17605 "Return a list (month day year) of date at point in calendar."
17606 (with-current-buffer "*Calendar*"
17607 (save-match-data
17608 (calendar-cursor-to-date))))
17610 (defun org-date-from-calendar ()
17611 "Insert time stamp corresponding to cursor date in *Calendar* buffer.
17612 If there is already a time stamp at the cursor position, update it."
17613 (interactive)
17614 (if (org-at-timestamp-p t)
17615 (org-timestamp-change 0 'calendar)
17616 (let ((cal-date (org-get-date-from-calendar)))
17617 (org-insert-time-stamp
17618 (encode-time 0 0 0 (nth 1 cal-date) (car cal-date) (nth 2 cal-date))))))
17620 (defcustom org-effort-durations
17621 `(("h" . 60)
17622 ("d" . ,(* 60 8))
17623 ("w" . ,(* 60 8 5))
17624 ("m" . ,(* 60 8 5 4))
17625 ("y" . ,(* 60 8 5 40)))
17626 "Conversion factor to minutes for an effort modifier.
17628 Each entry has the form (MODIFIER . MINUTES).
17630 In an effort string, a number followed by MODIFIER is multiplied
17631 by the specified number of MINUTES to obtain an effort in
17632 minutes.
17634 For example, if the value of this variable is ((\"hours\" . 60)), then an
17635 effort string \"2hours\" is equivalent to 120 minutes."
17636 :group 'org-agenda
17637 :version "24.1"
17638 :type '(alist :key-type (string :tag "Modifier")
17639 :value-type (number :tag "Minutes")))
17641 (defun org-minutes-to-clocksum-string (m)
17642 "Format number of minutes as a clocksum string.
17643 The format is determined by `org-time-clocksum-format',
17644 `org-time-clocksum-use-fractional' and
17645 `org-time-clocksum-fractional-format' and
17646 `org-time-clocksum-use-effort-durations'."
17647 (let ((clocksum "")
17648 (m (round m)) ; Don't allow fractions of minutes
17649 h d w mo y fmt n)
17650 (setq h (if org-time-clocksum-use-effort-durations
17651 (cdr (assoc "h" org-effort-durations)) 60)
17652 d (if org-time-clocksum-use-effort-durations
17653 (/ (cdr (assoc "d" org-effort-durations)) h) 24)
17654 w (if org-time-clocksum-use-effort-durations
17655 (/ (cdr (assoc "w" org-effort-durations)) (* d h)) 7)
17656 mo (if org-time-clocksum-use-effort-durations
17657 (/ (cdr (assoc "m" org-effort-durations)) (* d h)) 30)
17658 y (if org-time-clocksum-use-effort-durations
17659 (/ (cdr (assoc "y" org-effort-durations)) (* d h)) 365))
17660 ;; fractional format
17661 (if org-time-clocksum-use-fractional
17662 (cond
17663 ;; single format string
17664 ((stringp org-time-clocksum-fractional-format)
17665 (format org-time-clocksum-fractional-format (/ m (float h))))
17666 ;; choice of fractional formats for different time units
17667 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :years))
17668 (> (/ (truncate m) (* y d h)) 0))
17669 (format fmt (/ m (* y d (float h)))))
17670 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :months))
17671 (> (/ (truncate m) (* mo d h)) 0))
17672 (format fmt (/ m (* mo d (float h)))))
17673 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17674 (> (/ (truncate m) (* w d h)) 0))
17675 (format fmt (/ m (* w d (float h)))))
17676 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :days))
17677 (> (/ (truncate m) (* d h)) 0))
17678 (format fmt (/ m (* d (float h)))))
17679 ((and (setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17680 (> (/ (truncate m) h) 0))
17681 (format fmt (/ m (float h))))
17682 ((setq fmt (plist-get org-time-clocksum-fractional-format :minutes))
17683 (format fmt m))
17684 ;; fall back to smallest time unit with a format
17685 ((setq fmt (plist-get org-time-clocksum-fractional-format :hours))
17686 (format fmt (/ m (float h))))
17687 ((setq fmt (plist-get org-time-clocksum-fractional-format :days))
17688 (format fmt (/ m (* d (float h)))))
17689 ((setq fmt (plist-get org-time-clocksum-fractional-format :weeks))
17690 (format fmt (/ m (* w d (float h)))))
17691 ((setq fmt (plist-get org-time-clocksum-fractional-format :months))
17692 (format fmt (/ m (* mo d (float h)))))
17693 ((setq fmt (plist-get org-time-clocksum-fractional-format :years))
17694 (format fmt (/ m (* y d (float h))))))
17695 ;; standard (non-fractional) format, with single format string
17696 (if (stringp org-time-clocksum-format)
17697 (format org-time-clocksum-format (setq n (/ m h)) (- m (* h n)))
17698 ;; separate formats components
17699 (and (setq fmt (plist-get org-time-clocksum-format :years))
17700 (or (> (setq n (/ (truncate m) (* y d h))) 0)
17701 (plist-get org-time-clocksum-format :require-years))
17702 (setq clocksum (concat clocksum (format fmt n))
17703 m (- m (* n y d h))))
17704 (and (setq fmt (plist-get org-time-clocksum-format :months))
17705 (or (> (setq n (/ (truncate m) (* mo d h))) 0)
17706 (plist-get org-time-clocksum-format :require-months))
17707 (setq clocksum (concat clocksum (format fmt n))
17708 m (- m (* n mo d h))))
17709 (and (setq fmt (plist-get org-time-clocksum-format :weeks))
17710 (or (> (setq n (/ (truncate m) (* w d h))) 0)
17711 (plist-get org-time-clocksum-format :require-weeks))
17712 (setq clocksum (concat clocksum (format fmt n))
17713 m (- m (* n w d h))))
17714 (and (setq fmt (plist-get org-time-clocksum-format :days))
17715 (or (> (setq n (/ (truncate m) (* d h))) 0)
17716 (plist-get org-time-clocksum-format :require-days))
17717 (setq clocksum (concat clocksum (format fmt n))
17718 m (- m (* n d h))))
17719 (and (setq fmt (plist-get org-time-clocksum-format :hours))
17720 (or (> (setq n (/ (truncate m) h)) 0)
17721 (plist-get org-time-clocksum-format :require-hours))
17722 (setq clocksum (concat clocksum (format fmt n))
17723 m (- m (* n h))))
17724 (and (setq fmt (plist-get org-time-clocksum-format :minutes))
17725 (or (> m 0) (plist-get org-time-clocksum-format :require-minutes))
17726 (setq clocksum (concat clocksum (format fmt m))))
17727 ;; return formatted time duration
17728 clocksum))))
17730 (defalias 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string)
17731 (make-obsolete 'org-minutes-to-hh:mm-string 'org-minutes-to-clocksum-string
17732 "Org mode version 8.0")
17734 (defun org-hours-to-clocksum-string (n)
17735 (org-minutes-to-clocksum-string (* n 60)))
17737 (defun org-hh:mm-string-to-minutes (s)
17738 "Convert a string H:MM to a number of minutes.
17739 If the string is just a number, interpret it as minutes.
17740 In fact, the first hh:mm or number in the string will be taken,
17741 there can be extra stuff in the string.
17742 If no number is found, the return value is 0."
17743 (cond
17744 ((integerp s) s)
17745 ((string-match "\\([0-9]+\\):\\([0-9]+\\)" s)
17746 (+ (* (string-to-number (match-string 1 s)) 60)
17747 (string-to-number (match-string 2 s))))
17748 ((string-match "\\([0-9]+\\)" s)
17749 (string-to-number (match-string 1 s)))
17750 (t 0)))
17752 (defcustom org-image-actual-width t
17753 "Should we use the actual width of images when inlining them?
17755 When set to `t', always use the image width.
17757 When set to a number, use imagemagick (when available) to set
17758 the image's width to this value.
17760 When set to a number in a list, try to get the width from any
17761 #+ATTR.* keyword if it matches a width specification like
17763 #+ATTR_HTML: :width 300px
17765 and fall back on that number if none is found.
17767 When set to nil, try to get the width from an #+ATTR.* keyword
17768 and fall back on the original width if none is found.
17770 This requires Emacs >= 24.1, build with imagemagick support."
17771 :group 'org-appearance
17772 :version "24.4"
17773 :package-version '(Org . "8.0")
17774 :type '(choice
17775 (const :tag "Use the image width" t)
17776 (integer :tag "Use a number of pixels")
17777 (list :tag "Use #+ATTR* or a number of pixels" (integer))
17778 (const :tag "Use #+ATTR* or don't resize" nil)))
17780 (defcustom org-agenda-inhibit-startup nil
17781 "Inhibit startup when preparing agenda buffers.
17782 When this variable is `t' (the default), the initialization of
17783 the Org agenda buffers is inhibited: e.g. the visibility state
17784 is not set, the tables are not re-aligned, etc."
17785 :type 'boolean
17786 :version "24.3"
17787 :group 'org-agenda)
17789 (defcustom org-agenda-ignore-drawer-properties nil
17790 "Avoid updating text properties when building the agenda.
17791 Properties are used to prepare buffers for effort estimates, appointments,
17792 and subtree-local categories.
17793 If you don't use these in the agenda, you can add them to this list and
17794 agenda building will be a bit faster.
17795 The value is a list, with zero or more of the symbols `effort', `appt',
17796 or `category'."
17797 :type '(set :greedy t
17798 (const effort)
17799 (const appt)
17800 (const category))
17801 :version "24.3"
17802 :group 'org-agenda)
17804 (defun org-duration-string-to-minutes (s &optional output-to-string)
17805 "Convert a duration string S to minutes.
17807 A bare number is interpreted as minutes, modifiers can be set by
17808 customizing `org-effort-durations' (which see).
17810 Entries containing a colon are interpreted as H:MM by
17811 `org-hh:mm-string-to-minutes'."
17812 (let ((result 0)
17813 (re (concat "\\([0-9.]+\\) *\\("
17814 (regexp-opt (mapcar 'car org-effort-durations))
17815 "\\)")))
17816 (while (string-match re s)
17817 (incf result (* (cdr (assoc (match-string 2 s) org-effort-durations))
17818 (string-to-number (match-string 1 s))))
17819 (setq s (replace-match "" nil t s)))
17820 (setq result (floor result))
17821 (incf result (org-hh:mm-string-to-minutes s))
17822 (if output-to-string (number-to-string result) result)))
17824 ;;;; Files
17826 (defun org-save-all-org-buffers ()
17827 "Save all Org-mode buffers without user confirmation."
17828 (interactive)
17829 (message "Saving all Org-mode buffers...")
17830 (save-some-buffers t (lambda () (derived-mode-p 'org-mode)))
17831 (when (featurep 'org-id) (org-id-locations-save))
17832 (message "Saving all Org-mode buffers... done"))
17834 (defun org-revert-all-org-buffers ()
17835 "Revert all Org-mode buffers.
17836 Prompt for confirmation when there are unsaved changes.
17837 Be sure you know what you are doing before letting this function
17838 overwrite your changes.
17840 This function is useful in a setup where one tracks org files
17841 with a version control system, to revert on one machine after pulling
17842 changes from another. I believe the procedure must be like this:
17844 1. M-x org-save-all-org-buffers
17845 2. Pull changes from the other machine, resolve conflicts
17846 3. M-x org-revert-all-org-buffers"
17847 (interactive)
17848 (unless (yes-or-no-p "Revert all Org buffers from their files? ")
17849 (user-error "Abort"))
17850 (save-excursion
17851 (save-window-excursion
17852 (mapc
17853 (lambda (b)
17854 (when (and (with-current-buffer b (derived-mode-p 'org-mode))
17855 (with-current-buffer b buffer-file-name))
17856 (org-pop-to-buffer-same-window b)
17857 (revert-buffer t 'no-confirm)))
17858 (buffer-list))
17859 (when (and (featurep 'org-id) org-id-track-globally)
17860 (org-id-locations-load)))))
17862 ;;;; Agenda files
17864 ;;;###autoload
17865 (defun org-switchb (&optional arg)
17866 "Switch between Org buffers.
17867 With one prefix argument, restrict available buffers to files.
17868 With two prefix arguments, restrict available buffers to agenda files.
17870 Defaults to `iswitchb' for buffer name completion.
17871 Set `org-completion-use-ido' to make it use ido instead."
17872 (interactive "P")
17873 (let ((blist (cond ((equal arg '(4)) (org-buffer-list 'files))
17874 ((equal arg '(16)) (org-buffer-list 'agenda))
17875 (t (org-buffer-list))))
17876 (org-completion-use-iswitchb org-completion-use-iswitchb)
17877 (org-completion-use-ido org-completion-use-ido))
17878 (unless (or org-completion-use-ido org-completion-use-iswitchb)
17879 (setq org-completion-use-iswitchb t))
17880 (org-pop-to-buffer-same-window
17881 (org-icompleting-read "Org buffer: "
17882 (mapcar 'list (mapcar 'buffer-name blist))
17883 nil t))))
17885 ;;; Define some older names previously used for this functionality
17886 ;;;###autoload
17887 (defalias 'org-ido-switchb 'org-switchb)
17888 ;;;###autoload
17889 (defalias 'org-iswitchb 'org-switchb)
17891 (defun org-buffer-list (&optional predicate exclude-tmp)
17892 "Return a list of Org buffers.
17893 PREDICATE can be `export', `files' or `agenda'.
17895 export restrict the list to Export buffers.
17896 files restrict the list to buffers visiting Org files.
17897 agenda restrict the list to buffers visiting agenda files.
17899 If EXCLUDE-TMP is non-nil, ignore temporary buffers."
17900 (let* ((bfn nil)
17901 (agenda-files (and (eq predicate 'agenda)
17902 (mapcar 'file-truename (org-agenda-files t))))
17903 (filter
17904 (cond
17905 ((eq predicate 'files)
17906 (lambda (b) (with-current-buffer b (derived-mode-p 'org-mode))))
17907 ((eq predicate 'export)
17908 (lambda (b) (string-match "\*Org .*Export" (buffer-name b))))
17909 ((eq predicate 'agenda)
17910 (lambda (b)
17911 (with-current-buffer b
17912 (and (derived-mode-p 'org-mode)
17913 (setq bfn (buffer-file-name b))
17914 (member (file-truename bfn) agenda-files)))))
17915 (t (lambda (b) (with-current-buffer b
17916 (or (derived-mode-p 'org-mode)
17917 (string-match "\*Org .*Export"
17918 (buffer-name b)))))))))
17919 (delq nil
17920 (mapcar
17921 (lambda(b)
17922 (if (and (funcall filter b)
17923 (or (not exclude-tmp)
17924 (not (string-match "tmp" (buffer-name b)))))
17926 nil))
17927 (buffer-list)))))
17929 (defun org-agenda-files (&optional unrestricted archives)
17930 "Get the list of agenda files.
17931 Optional UNRESTRICTED means return the full list even if a restriction
17932 is currently in place.
17933 When ARCHIVES is t, include all archive files that are really being
17934 used by the agenda files. If ARCHIVE is `ifmode', do this only if
17935 `org-agenda-archives-mode' is t."
17936 (let ((files
17937 (cond
17938 ((and (not unrestricted) (get 'org-agenda-files 'org-restrict)))
17939 ((stringp org-agenda-files) (org-read-agenda-file-list))
17940 ((listp org-agenda-files) org-agenda-files)
17941 (t (error "Invalid value of `org-agenda-files'")))))
17942 (setq files (apply 'append
17943 (mapcar (lambda (f)
17944 (if (file-directory-p f)
17945 (directory-files
17946 f t org-agenda-file-regexp)
17947 (list f)))
17948 files)))
17949 (when org-agenda-skip-unavailable-files
17950 (setq files (delq nil
17951 (mapcar (function
17952 (lambda (file)
17953 (and (file-readable-p file) file)))
17954 files))))
17955 (when (or (eq archives t)
17956 (and (eq archives 'ifmode) (eq org-agenda-archives-mode t)))
17957 (setq files (org-add-archive-files files)))
17958 files))
17960 (defun org-agenda-file-p (&optional file)
17961 "Return non-nil, if FILE is an agenda file.
17962 If FILE is omitted, use the file associated with the current
17963 buffer."
17964 (member (or file (buffer-file-name))
17965 (org-agenda-files t)))
17967 (defun org-edit-agenda-file-list ()
17968 "Edit the list of agenda files.
17969 Depending on setup, this either uses customize to edit the variable
17970 `org-agenda-files', or it visits the file that is holding the list. In the
17971 latter case, the buffer is set up in a way that saving it automatically kills
17972 the buffer and restores the previous window configuration."
17973 (interactive)
17974 (if (stringp org-agenda-files)
17975 (let ((cw (current-window-configuration)))
17976 (find-file org-agenda-files)
17977 (org-set-local 'org-window-configuration cw)
17978 (org-add-hook 'after-save-hook
17979 (lambda ()
17980 (set-window-configuration
17981 (prog1 org-window-configuration
17982 (kill-buffer (current-buffer))))
17983 (org-install-agenda-files-menu)
17984 (message "New agenda file list installed"))
17985 nil 'local)
17986 (message "%s" (substitute-command-keys
17987 "Edit list and finish with \\[save-buffer]")))
17988 (customize-variable 'org-agenda-files)))
17990 (defun org-store-new-agenda-file-list (list)
17991 "Set new value for the agenda file list and save it correctly."
17992 (if (stringp org-agenda-files)
17993 (let ((fe (org-read-agenda-file-list t)) b u)
17994 (while (setq b (find-buffer-visiting org-agenda-files))
17995 (kill-buffer b))
17996 (with-temp-file org-agenda-files
17997 (insert
17998 (mapconcat
17999 (lambda (f) ;; Keep un-expanded entries.
18000 (if (setq u (assoc f fe))
18001 (cdr u)
18003 list "\n")
18004 "\n")))
18005 (let ((org-mode-hook nil) (org-inhibit-startup t)
18006 (org-insert-mode-line-in-empty-file nil))
18007 (setq org-agenda-files list)
18008 (customize-save-variable 'org-agenda-files org-agenda-files))))
18010 (defun org-read-agenda-file-list (&optional pair-with-expansion)
18011 "Read the list of agenda files from a file.
18012 If PAIR-WITH-EXPANSION is t return pairs with un-expanded
18013 filenames, used by `org-store-new-agenda-file-list' to write back
18014 un-expanded file names."
18015 (when (file-directory-p org-agenda-files)
18016 (error "`org-agenda-files' cannot be a single directory"))
18017 (when (stringp org-agenda-files)
18018 (with-temp-buffer
18019 (insert-file-contents org-agenda-files)
18020 (mapcar
18021 (lambda (f)
18022 (let ((e (expand-file-name (substitute-in-file-name f)
18023 org-directory)))
18024 (if pair-with-expansion
18025 (cons e f)
18026 e)))
18027 (org-split-string (buffer-string) "[ \t\r\n]*?[\r\n][ \t\r\n]*")))))
18029 ;;;###autoload
18030 (defun org-cycle-agenda-files ()
18031 "Cycle through the files in `org-agenda-files'.
18032 If the current buffer visits an agenda file, find the next one in the list.
18033 If the current buffer does not, find the first agenda file."
18034 (interactive)
18035 (let* ((fs (org-agenda-files t))
18036 (files (append fs (list (car fs))))
18037 (tcf (if buffer-file-name (file-truename buffer-file-name)))
18038 file)
18039 (unless files (user-error "No agenda files"))
18040 (catch 'exit
18041 (while (setq file (pop files))
18042 (if (equal (file-truename file) tcf)
18043 (when (car files)
18044 (find-file (car files))
18045 (throw 'exit t))))
18046 (find-file (car fs)))
18047 (if (buffer-base-buffer) (org-pop-to-buffer-same-window (buffer-base-buffer)))))
18049 (defun org-agenda-file-to-front (&optional to-end)
18050 "Move/add the current file to the top of the agenda file list.
18051 If the file is not present in the list, it is added to the front. If it is
18052 present, it is moved there. With optional argument TO-END, add/move to the
18053 end of the list."
18054 (interactive "P")
18055 (let ((org-agenda-skip-unavailable-files nil)
18056 (file-alist (mapcar (lambda (x)
18057 (cons (file-truename x) x))
18058 (org-agenda-files t)))
18059 (ctf (file-truename
18060 (or buffer-file-name
18061 (user-error "Please save the current buffer to a file"))))
18062 x had)
18063 (setq x (assoc ctf file-alist) had x)
18065 (if (not x) (setq x (cons ctf (abbreviate-file-name buffer-file-name))))
18066 (if to-end
18067 (setq file-alist (append (delq x file-alist) (list x)))
18068 (setq file-alist (cons x (delq x file-alist))))
18069 (org-store-new-agenda-file-list (mapcar 'cdr file-alist))
18070 (org-install-agenda-files-menu)
18071 (message "File %s to %s of agenda file list"
18072 (if had "moved" "added") (if to-end "end" "front"))))
18074 (defun org-remove-file (&optional file)
18075 "Remove current file from the list of files in variable `org-agenda-files'.
18076 These are the files which are being checked for agenda entries.
18077 Optional argument FILE means use this file instead of the current."
18078 (interactive)
18079 (let* ((org-agenda-skip-unavailable-files nil)
18080 (file (or file buffer-file-name
18081 (user-error "Current buffer does not visit a file")))
18082 (true-file (file-truename file))
18083 (afile (abbreviate-file-name file))
18084 (files (delq nil (mapcar
18085 (lambda (x)
18086 (if (equal true-file
18087 (file-truename x))
18088 nil x))
18089 (org-agenda-files t)))))
18090 (if (not (= (length files) (length (org-agenda-files t))))
18091 (progn
18092 (org-store-new-agenda-file-list files)
18093 (org-install-agenda-files-menu)
18094 (message "Removed file: %s" afile))
18095 (message "File was not in list: %s (not removed)" afile))))
18097 (defun org-file-menu-entry (file)
18098 (vector file (list 'find-file file) t))
18100 (defun org-check-agenda-file (file)
18101 "Make sure FILE exists. If not, ask user what to do."
18102 (when (not (file-exists-p file))
18103 (message "Non-existent agenda file %s. [R]emove from list or [A]bort?"
18104 (abbreviate-file-name file))
18105 (let ((r (downcase (read-char-exclusive))))
18106 (cond
18107 ((equal r ?r)
18108 (org-remove-file file)
18109 (throw 'nextfile t))
18110 (t (error "Abort"))))))
18112 (defun org-get-agenda-file-buffer (file)
18113 "Get a buffer visiting FILE. If the buffer needs to be created, add
18114 it to the list of buffers which might be released later."
18115 (let ((buf (org-find-base-buffer-visiting file)))
18116 (if buf
18117 buf ; just return it
18118 ;; Make a new buffer and remember it
18119 (setq buf (find-file-noselect file))
18120 (if buf (push buf org-agenda-new-buffers))
18121 buf)))
18123 (defun org-release-buffers (blist)
18124 "Release all buffers in list, asking the user for confirmation when needed.
18125 When a buffer is unmodified, it is just killed. When modified, it is saved
18126 \(if the user agrees) and then killed."
18127 (let (buf file)
18128 (while (setq buf (pop blist))
18129 (setq file (buffer-file-name buf))
18130 (when (and (buffer-modified-p buf)
18131 file
18132 (y-or-n-p (format "Save file %s? " file)))
18133 (with-current-buffer buf (save-buffer)))
18134 (kill-buffer buf))))
18136 (defun org-agenda-prepare-buffers (files)
18137 "Create buffers for all agenda files, protect archived trees and comments."
18138 (interactive)
18139 (let ((pa '(:org-archived t))
18140 (pc '(:org-comment t))
18141 (pall '(:org-archived t :org-comment t))
18142 (inhibit-read-only t)
18143 (org-inhibit-startup org-agenda-inhibit-startup)
18144 (rea (concat ":" org-archive-tag ":"))
18145 file re pos)
18146 (setq org-tag-alist-for-agenda nil
18147 org-tag-groups-alist-for-agenda nil)
18148 (save-excursion
18149 (save-restriction
18150 (while (setq file (pop files))
18151 (catch 'nextfile
18152 (if (bufferp file)
18153 (set-buffer file)
18154 (org-check-agenda-file file)
18155 (set-buffer (org-get-agenda-file-buffer file)))
18156 (widen)
18157 (org-set-regexps-and-options-for-tags)
18158 (setq pos (point))
18159 (goto-char (point-min))
18160 (let ((case-fold-search t))
18161 (when (search-forward "#+setupfile" nil t)
18162 ;; Don't set all regexps and options systematically as
18163 ;; this is only run for setting agenda tags from setup
18164 ;; file
18165 (org-set-regexps-and-options)))
18166 (or (memq 'category org-agenda-ignore-drawer-properties)
18167 (org-refresh-category-properties))
18168 (or (memq 'effort org-agenda-ignore-drawer-properties)
18169 (org-refresh-properties org-effort-property 'org-effort))
18170 (or (memq 'appt org-agenda-ignore-drawer-properties)
18171 (org-refresh-properties "APPT_WARNTIME" 'org-appt-warntime))
18172 (setq org-todo-keywords-for-agenda
18173 (append org-todo-keywords-for-agenda org-todo-keywords-1))
18174 (setq org-done-keywords-for-agenda
18175 (append org-done-keywords-for-agenda org-done-keywords))
18176 (setq org-todo-keyword-alist-for-agenda
18177 (append org-todo-keyword-alist-for-agenda org-todo-key-alist))
18178 (setq org-tag-alist-for-agenda
18179 (org-uniquify
18180 (append org-tag-alist-for-agenda
18181 org-tag-alist
18182 org-tag-persistent-alist)))
18183 (if org-group-tags
18184 (setq org-tag-groups-alist-for-agenda
18185 (org-uniquify-alist
18186 (append org-tag-groups-alist-for-agenda org-tag-groups-alist))))
18187 (org-with-silent-modifications
18188 (save-excursion
18189 (remove-text-properties (point-min) (point-max) pall)
18190 (when org-agenda-skip-archived-trees
18191 (goto-char (point-min))
18192 (while (re-search-forward rea nil t)
18193 (if (org-at-heading-p t)
18194 (add-text-properties (point-at-bol) (org-end-of-subtree t) pa))))
18195 (goto-char (point-min))
18196 (setq re (format org-heading-keyword-regexp-format
18197 org-comment-string))
18198 (while (re-search-forward re nil t)
18199 (add-text-properties
18200 (match-beginning 0) (org-end-of-subtree t) pc))))
18201 (goto-char pos)))))
18202 (setq org-todo-keywords-for-agenda
18203 (org-uniquify org-todo-keywords-for-agenda))
18204 (setq org-todo-keyword-alist-for-agenda
18205 (org-uniquify org-todo-keyword-alist-for-agenda))))
18208 ;;;; CDLaTeX minor mode
18210 (defvar org-cdlatex-mode-map (make-sparse-keymap)
18211 "Keymap for the minor `org-cdlatex-mode'.")
18213 (org-defkey org-cdlatex-mode-map "_" 'org-cdlatex-underscore-caret)
18214 (org-defkey org-cdlatex-mode-map "^" 'org-cdlatex-underscore-caret)
18215 (org-defkey org-cdlatex-mode-map "`" 'cdlatex-math-symbol)
18216 (org-defkey org-cdlatex-mode-map "'" 'org-cdlatex-math-modify)
18217 (org-defkey org-cdlatex-mode-map "\C-c{" 'cdlatex-environment)
18219 (defvar org-cdlatex-texmathp-advice-is-done nil
18220 "Flag remembering if we have applied the advice to texmathp already.")
18222 (define-minor-mode org-cdlatex-mode
18223 "Toggle the minor `org-cdlatex-mode'.
18224 This mode supports entering LaTeX environment and math in LaTeX fragments
18225 in Org-mode.
18226 \\{org-cdlatex-mode-map}"
18227 nil " OCDL" nil
18228 (when org-cdlatex-mode
18229 (require 'cdlatex)
18230 (run-hooks 'cdlatex-mode-hook)
18231 (cdlatex-compute-tables))
18232 (unless org-cdlatex-texmathp-advice-is-done
18233 (setq org-cdlatex-texmathp-advice-is-done t)
18234 (defadvice texmathp (around org-math-always-on activate)
18235 "Always return t in org-mode buffers.
18236 This is because we want to insert math symbols without dollars even outside
18237 the LaTeX math segments. If Orgmode thinks that point is actually inside
18238 an embedded LaTeX fragment, let texmathp do its job.
18239 \\[org-cdlatex-mode-map]"
18240 (interactive)
18241 (let (p)
18242 (cond
18243 ((not (derived-mode-p 'org-mode)) ad-do-it)
18244 ((eq this-command 'cdlatex-math-symbol)
18245 (setq ad-return-value t
18246 texmathp-why '("cdlatex-math-symbol in org-mode" . 0)))
18248 (let ((p (org-inside-LaTeX-fragment-p)))
18249 (if (and p (member (car p) (plist-get org-format-latex-options :matchers)))
18250 (setq ad-return-value t
18251 texmathp-why '("Org-mode embedded math" . 0))
18252 (if p ad-do-it)))))))))
18254 (defun turn-on-org-cdlatex ()
18255 "Unconditionally turn on `org-cdlatex-mode'."
18256 (org-cdlatex-mode 1))
18258 (defun org-try-cdlatex-tab ()
18259 "Check if it makes sense to execute `cdlatex-tab', and do it if yes.
18260 It makes sense to do so if `org-cdlatex-mode' is active and if the cursor is
18261 - inside a LaTeX fragment, or
18262 - after the first word in a line, where an abbreviation expansion could
18263 insert a LaTeX environment."
18264 (when org-cdlatex-mode
18265 (cond
18266 ;; Before any word on the line: No expansion possible.
18267 ((save-excursion (skip-chars-backward " \t") (bolp)) nil)
18268 ;; Just after first word on the line: Expand it. Make sure it
18269 ;; cannot happen on headlines, though.
18270 ((save-excursion
18271 (skip-chars-backward "a-zA-Z0-9*")
18272 (skip-chars-backward " \t")
18273 (and (bolp) (not (org-at-heading-p))))
18274 (cdlatex-tab) t)
18275 ((org-inside-LaTeX-fragment-p) (cdlatex-tab) t))))
18277 (defun org-cdlatex-underscore-caret (&optional arg)
18278 "Execute `cdlatex-sub-superscript' in LaTeX fragments.
18279 Revert to the normal definition outside of these fragments."
18280 (interactive "P")
18281 (if (org-inside-LaTeX-fragment-p)
18282 (call-interactively 'cdlatex-sub-superscript)
18283 (let (org-cdlatex-mode)
18284 (call-interactively (key-binding (vector last-input-event))))))
18286 (defun org-cdlatex-math-modify (&optional arg)
18287 "Execute `cdlatex-math-modify' in LaTeX fragments.
18288 Revert to the normal definition outside of these fragments."
18289 (interactive "P")
18290 (if (org-inside-LaTeX-fragment-p)
18291 (call-interactively 'cdlatex-math-modify)
18292 (let (org-cdlatex-mode)
18293 (call-interactively (key-binding (vector last-input-event))))))
18297 ;;;; LaTeX fragments
18299 (defun org-inside-LaTeX-fragment-p ()
18300 "Test if point is inside a LaTeX fragment.
18301 I.e. after a \\begin, \\(, \\[, $, or $$, without the corresponding closing
18302 sequence appearing also before point.
18303 Even though the matchers for math are configurable, this function assumes
18304 that \\begin, \\(, \\[, and $$ are always used. Only the single dollar
18305 delimiters are skipped when they have been removed by customization.
18306 The return value is nil, or a cons cell with the delimiter and the
18307 position of this delimiter.
18309 This function does a reasonably good job, but can locally be fooled by
18310 for example currency specifications. For example it will assume being in
18311 inline math after \"$22.34\". The LaTeX fragment formatter will only format
18312 fragments that are properly closed, but during editing, we have to live
18313 with the uncertainty caused by missing closing delimiters. This function
18314 looks only before point, not after."
18315 (catch 'exit
18316 (let ((pos (point))
18317 (dodollar (member "$" (plist-get org-format-latex-options :matchers)))
18318 (lim (progn
18319 (re-search-backward (concat "^\\(" paragraph-start "\\)") nil t)
18320 (point)))
18321 dd-on str (start 0) m re)
18322 (goto-char pos)
18323 (when dodollar
18324 (setq str (concat (buffer-substring lim (point)) "\000 X$.")
18325 re (nth 1 (assoc "$" org-latex-regexps)))
18326 (while (string-match re str start)
18327 (cond
18328 ((= (match-end 0) (length str))
18329 (throw 'exit (cons "$" (+ lim (match-beginning 0) 1))))
18330 ((= (match-end 0) (- (length str) 5))
18331 (throw 'exit nil))
18332 (t (setq start (match-end 0))))))
18333 (when (setq m (re-search-backward "\\(\\\\begin{[^}]*}\\|\\\\(\\|\\\\\\[\\)\\|\\(\\\\end{[^}]*}\\|\\\\)\\|\\\\\\]\\)\\|\\(\\$\\$\\)" lim t))
18334 (goto-char pos)
18335 (and (match-beginning 1) (throw 'exit (cons (match-string 1) m)))
18336 (and (match-beginning 2) (throw 'exit nil))
18337 ;; count $$
18338 (while (re-search-backward "\\$\\$" lim t)
18339 (setq dd-on (not dd-on)))
18340 (goto-char pos)
18341 (if dd-on (cons "$$" m))))))
18343 (defun org-inside-latex-macro-p ()
18344 "Is point inside a LaTeX macro or its arguments?"
18345 (save-match-data
18346 (org-in-regexp
18347 "\\\\[a-zA-Z]+\\*?\\(\\(\\[[^][\n{}]*\\]\\)\\|\\({[^{}\n]*}\\)\\)*")))
18349 (defvar org-latex-fragment-image-overlays nil
18350 "List of overlays carrying the images of latex fragments.")
18351 (make-variable-buffer-local 'org-latex-fragment-image-overlays)
18353 (defun org-remove-latex-fragment-image-overlays ()
18354 "Remove all overlays with LaTeX fragment images in current buffer."
18355 (mapc 'delete-overlay org-latex-fragment-image-overlays)
18356 (setq org-latex-fragment-image-overlays nil))
18358 (defun org-preview-latex-fragment (&optional subtree)
18359 "Preview the LaTeX fragment at point, or all locally or globally.
18360 If the cursor is in a LaTeX fragment, create the image and overlay
18361 it over the source code. If there is no fragment at point, display
18362 all fragments in the current text, from one headline to the next. With
18363 prefix SUBTREE, display all fragments in the current subtree. With a
18364 double prefix arg \\[universal-argument] \\[universal-argument], or when \
18365 the cursor is before the first headline,
18366 display all fragments in the buffer.
18367 The images can be removed again with \\[org-ctrl-c-ctrl-c]."
18368 (interactive "P")
18369 (unless buffer-file-name
18370 (user-error "Can't preview LaTeX fragment in a non-file buffer"))
18371 (when (display-graphic-p)
18372 (org-remove-latex-fragment-image-overlays)
18373 (save-excursion
18374 (save-restriction
18375 (let (beg end at msg)
18376 (cond
18377 ((or (equal subtree '(16))
18378 (not (save-excursion
18379 (re-search-backward org-outline-regexp-bol nil t))))
18380 (setq beg (point-min) end (point-max)
18381 msg "Creating images for buffer...%s"))
18382 ((equal subtree '(4))
18383 (org-back-to-heading)
18384 (setq beg (point) end (org-end-of-subtree t)
18385 msg "Creating images for subtree...%s"))
18387 (if (setq at (org-inside-LaTeX-fragment-p))
18388 (goto-char (max (point-min) (- (cdr at) 2)))
18389 (org-back-to-heading))
18390 (setq beg (point) end (progn (outline-next-heading) (point))
18391 msg (if at "Creating image...%s"
18392 "Creating images for entry...%s"))))
18393 (message msg "")
18394 (narrow-to-region beg end)
18395 (goto-char beg)
18396 (org-format-latex
18397 (concat org-latex-preview-ltxpng-directory (file-name-sans-extension
18398 (file-name-nondirectory
18399 buffer-file-name)))
18400 default-directory 'overlays msg at 'forbuffer
18401 org-latex-create-formula-image-program)
18402 (message msg "done. Use `C-c C-c' to remove images."))))))
18404 (defun org-format-latex (prefix &optional dir overlays msg at
18405 forbuffer processing-type)
18406 "Replace LaTeX fragments with links to an image, and produce images.
18407 Some of the options can be changed using the variable
18408 `org-format-latex-options'."
18409 (if (and overlays (fboundp 'clear-image-cache)) (clear-image-cache))
18410 (let* ((prefixnodir (file-name-nondirectory prefix))
18411 (absprefix (expand-file-name prefix dir))
18412 (todir (file-name-directory absprefix))
18413 (opt org-format-latex-options)
18414 (optnew org-format-latex-options)
18415 (matchers (plist-get opt :matchers))
18416 (re-list org-latex-regexps)
18417 (cnt 0) txt hash link beg end re e checkdir
18418 string
18419 m n block-type block linkfile movefile ov)
18420 ;; Check the different regular expressions
18421 (while (setq e (pop re-list))
18422 (setq m (car e) re (nth 1 e) n (nth 2 e) block-type (nth 3 e)
18423 block (if block-type "\n\n" ""))
18424 (when (member m matchers)
18425 (goto-char (point-min))
18426 (while (re-search-forward re nil t)
18427 (when (and (or (not at) (equal (cdr at) (match-beginning n)))
18428 (or (not overlays)
18429 (not (eq (get-char-property (match-beginning n)
18430 'org-overlay-type)
18431 'org-latex-overlay))))
18432 (cond
18433 ((eq processing-type 'verbatim))
18434 ((eq processing-type 'mathjax)
18435 ;; Prepare for MathJax processing.
18436 (setq string (match-string n))
18437 (when (member m '("$" "$1"))
18438 (save-excursion
18439 (delete-region (match-beginning n) (match-end n))
18440 (goto-char (match-beginning n))
18441 (insert (concat "\\(" (substring string 1 -1) "\\)")))))
18442 ((or (eq processing-type 'dvipng)
18443 (eq processing-type 'imagemagick))
18444 ;; Process to an image.
18445 (setq txt (match-string n)
18446 beg (match-beginning n) end (match-end n)
18447 cnt (1+ cnt))
18448 (let ((face (face-at-point))
18449 (fg (plist-get opt :foreground))
18450 (bg (plist-get opt :background))
18451 ;; Ensure full list is printed.
18452 print-length print-level)
18453 (when forbuffer
18454 ;; Get the colors from the face at point.
18455 (goto-char beg)
18456 (when (eq fg 'auto)
18457 (setq fg (face-attribute face :foreground nil 'default)))
18458 (when (eq bg 'auto)
18459 (setq bg (face-attribute face :background nil 'default)))
18460 (setq optnew (copy-sequence opt))
18461 (plist-put optnew :foreground fg)
18462 (plist-put optnew :background bg))
18463 (setq hash (sha1 (prin1-to-string
18464 (list org-format-latex-header
18465 org-latex-default-packages-alist
18466 org-latex-packages-alist
18467 org-format-latex-options
18468 forbuffer txt fg bg)))
18469 linkfile (format "%s_%s.png" prefix hash)
18470 movefile (format "%s_%s.png" absprefix hash)))
18471 (setq link (concat block "[[file:" linkfile "]]" block))
18472 (if msg (message msg cnt))
18473 (goto-char beg)
18474 (unless checkdir ; Ensure the directory exists.
18475 (setq checkdir t)
18476 (or (file-directory-p todir) (make-directory todir t)))
18477 (unless (file-exists-p movefile)
18478 (org-create-formula-image
18479 txt movefile optnew forbuffer processing-type))
18480 (if overlays
18481 (progn
18482 (mapc (lambda (o)
18483 (if (eq (overlay-get o 'org-overlay-type)
18484 'org-latex-overlay)
18485 (delete-overlay o)))
18486 (overlays-in beg end))
18487 (setq ov (make-overlay beg end))
18488 (overlay-put ov 'org-overlay-type 'org-latex-overlay)
18489 (if (featurep 'xemacs)
18490 (progn
18491 (overlay-put ov 'invisible t)
18492 (overlay-put
18493 ov 'end-glyph
18494 (make-glyph (vector 'png :file movefile))))
18495 (overlay-put
18496 ov 'display
18497 (list 'image :type 'png :file movefile :ascent 'center)))
18498 (push ov org-latex-fragment-image-overlays)
18499 (goto-char end))
18500 (delete-region beg end)
18501 (insert (org-add-props link
18502 (list 'org-latex-src
18503 (replace-regexp-in-string
18504 "\"" "" txt)
18505 'org-latex-src-embed-type
18506 (if block-type 'paragraph 'character))))))
18507 ((eq processing-type 'mathml)
18508 ;; Process to MathML
18509 (unless (save-match-data (org-format-latex-mathml-available-p))
18510 (user-error "LaTeX to MathML converter not configured"))
18511 (setq txt (match-string n)
18512 beg (match-beginning n) end (match-end n)
18513 cnt (1+ cnt))
18514 (if msg (message msg cnt))
18515 (goto-char beg)
18516 (delete-region beg end)
18517 (insert (org-format-latex-as-mathml
18518 txt block-type prefix dir)))
18520 (error "Unknown conversion type %s for LaTeX fragments"
18521 processing-type)))))))))
18523 (defun org-create-math-formula (latex-frag &optional mathml-file)
18524 "Convert LATEX-FRAG to MathML and store it in MATHML-FILE.
18525 Use `org-latex-to-mathml-convert-command'. If the conversion is
18526 sucessful, return the portion between \"<math...> </math>\"
18527 elements otherwise return nil. When MATHML-FILE is specified,
18528 write the results in to that file. When invoked as an
18529 interactive command, prompt for LATEX-FRAG, with initial value
18530 set to the current active region and echo the results for user
18531 inspection."
18532 (interactive (list (let ((frag (when (org-region-active-p)
18533 (buffer-substring-no-properties
18534 (region-beginning) (region-end)))))
18535 (read-string "LaTeX Fragment: " frag nil frag))))
18536 (unless latex-frag (error "Invalid LaTeX fragment"))
18537 (let* ((tmp-in-file (file-relative-name
18538 (make-temp-name (expand-file-name "ltxmathml-in"))))
18539 (ignore (write-region latex-frag nil tmp-in-file))
18540 (tmp-out-file (file-relative-name
18541 (make-temp-name (expand-file-name "ltxmathml-out"))))
18542 (cmd (format-spec
18543 org-latex-to-mathml-convert-command
18544 `((?j . ,(shell-quote-argument
18545 (expand-file-name org-latex-to-mathml-jar-file)))
18546 (?I . ,(shell-quote-argument tmp-in-file))
18547 (?o . ,(shell-quote-argument tmp-out-file)))))
18548 mathml shell-command-output)
18549 (when (org-called-interactively-p 'any)
18550 (unless (org-format-latex-mathml-available-p)
18551 (user-error "LaTeX to MathML converter not configured")))
18552 (message "Running %s" cmd)
18553 (setq shell-command-output (shell-command-to-string cmd))
18554 (setq mathml
18555 (when (file-readable-p tmp-out-file)
18556 (with-current-buffer (find-file-noselect tmp-out-file t)
18557 (goto-char (point-min))
18558 (when (re-search-forward
18559 (concat
18560 (regexp-quote
18561 "<math xmlns=\"http://www.w3.org/1998/Math/MathML\">")
18562 "\\(.\\|\n\\)*"
18563 (regexp-quote "</math>")) nil t)
18564 (prog1 (match-string 0) (kill-buffer))))))
18565 (cond
18566 (mathml
18567 (setq mathml
18568 (concat "<?xml version=\"1.0\" encoding=\"UTF-8\"?>\n" mathml))
18569 (when mathml-file
18570 (write-region mathml nil mathml-file))
18571 (when (org-called-interactively-p 'any)
18572 (message mathml)))
18573 ((message "LaTeX to MathML conversion failed")
18574 (message shell-command-output)))
18575 (delete-file tmp-in-file)
18576 (when (file-exists-p tmp-out-file)
18577 (delete-file tmp-out-file))
18578 mathml))
18580 (defun org-format-latex-as-mathml (latex-frag latex-frag-type
18581 prefix &optional dir)
18582 "Use `org-create-math-formula' but check local cache first."
18583 (let* ((absprefix (expand-file-name prefix dir))
18584 (print-length nil) (print-level nil)
18585 (formula-id (concat
18586 "formula-"
18587 (sha1
18588 (prin1-to-string
18589 (list latex-frag
18590 org-latex-to-mathml-convert-command)))))
18591 (formula-cache (format "%s-%s.mathml" absprefix formula-id))
18592 (formula-cache-dir (file-name-directory formula-cache)))
18594 (unless (file-directory-p formula-cache-dir)
18595 (make-directory formula-cache-dir t))
18597 (unless (file-exists-p formula-cache)
18598 (org-create-math-formula latex-frag formula-cache))
18600 (if (file-exists-p formula-cache)
18601 ;; Successful conversion. Return the link to MathML file.
18602 (org-add-props
18603 (format "[[file:%s]]" (file-relative-name formula-cache dir))
18604 (list 'org-latex-src (replace-regexp-in-string "\"" "" latex-frag)
18605 'org-latex-src-embed-type (if latex-frag-type
18606 'paragraph 'character)))
18607 ;; Failed conversion. Return the LaTeX fragment verbatim
18608 latex-frag)))
18610 (defun org-create-formula-image (string tofile options buffer &optional type)
18611 "Create an image from LaTeX source using dvipng or convert.
18612 This function calls either `org-create-formula-image-with-dvipng'
18613 or `org-create-formula-image-with-imagemagick' depending on the
18614 value of `org-latex-create-formula-image-program' or on the value
18615 of the optional TYPE variable.
18617 Note: ultimately these two function should be combined as they
18618 share a good deal of logic."
18619 (org-check-external-command
18620 "latex" "needed to convert LaTeX fragments to images")
18621 (funcall
18622 (case (or type org-latex-create-formula-image-program)
18623 ('dvipng
18624 (org-check-external-command
18625 "dvipng" "needed to convert LaTeX fragments to images")
18626 #'org-create-formula-image-with-dvipng)
18627 ('imagemagick
18628 (org-check-external-command
18629 "convert" "you need to install imagemagick")
18630 #'org-create-formula-image-with-imagemagick)
18631 (t (error
18632 "Invalid value of `org-latex-create-formula-image-program'")))
18633 string tofile options buffer))
18635 (declare-function org-export-get-backend "ox" (name))
18636 (declare-function org-export--get-global-options "ox" (&optional backend))
18637 (declare-function org-export--get-inbuffer-options "ox" (&optional backend))
18638 (declare-function org-latex-guess-inputenc "ox-latex" (header))
18639 (declare-function org-latex-guess-babel-language "ox-latex" (header info))
18640 (defun org-create-formula--latex-header ()
18641 "Return LaTeX header appropriate for previewing a LaTeX snippet."
18642 (let ((info (org-combine-plists (org-export--get-global-options
18643 (org-export-get-backend 'latex))
18644 (org-export--get-inbuffer-options
18645 (org-export-get-backend 'latex)))))
18646 (org-latex-guess-babel-language
18647 (org-latex-guess-inputenc
18648 (org-splice-latex-header
18649 org-format-latex-header
18650 org-latex-default-packages-alist
18651 org-latex-packages-alist t
18652 (plist-get info :latex-header)))
18653 info)))
18655 ;; This function borrows from Ganesh Swami's latex2png.el
18656 (defun org-create-formula-image-with-dvipng (string tofile options buffer)
18657 "This calls dvipng."
18658 (require 'ox-latex)
18659 (let* ((tmpdir (if (featurep 'xemacs)
18660 (temp-directory)
18661 temporary-file-directory))
18662 (texfilebase (make-temp-name
18663 (expand-file-name "orgtex" tmpdir)))
18664 (texfile (concat texfilebase ".tex"))
18665 (dvifile (concat texfilebase ".dvi"))
18666 (pngfile (concat texfilebase ".png"))
18667 (fnh (if (featurep 'xemacs)
18668 (font-height (face-font 'default))
18669 (face-attribute 'default :height nil)))
18670 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18671 (dpi (number-to-string (* scale (floor (* 0.9 (if buffer fnh 140.))))))
18672 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18673 "Black"))
18674 (bg (or (plist-get options (if buffer :background :html-background))
18675 "Transparent")))
18676 (if (eq fg 'default) (setq fg (org-dvipng-color :foreground))
18677 (unless (string= fg "Transparent") (setq fg (org-dvipng-color-format fg))))
18678 (if (eq bg 'default) (setq bg (org-dvipng-color :background))
18679 (unless (string= bg "Transparent") (setq bg (org-dvipng-color-format bg))))
18680 (let ((latex-header (org-create-formula--latex-header)))
18681 (with-temp-file texfile
18682 (insert latex-header)
18683 (insert "\n\\begin{document}\n" string "\n\\end{document}\n")))
18684 (let ((dir default-directory))
18685 (condition-case nil
18686 (progn
18687 (cd tmpdir)
18688 (call-process "latex" nil nil nil texfile))
18689 (error nil))
18690 (cd dir))
18691 (if (not (file-exists-p dvifile))
18692 (progn (message "Failed to create dvi file from %s" texfile) nil)
18693 (condition-case nil
18694 (if (featurep 'xemacs)
18695 (call-process "dvipng" nil nil nil
18696 "-fg" fg "-bg" bg
18697 "-T" "tight"
18698 "-o" pngfile
18699 dvifile)
18700 (call-process "dvipng" nil nil nil
18701 "-fg" fg "-bg" bg
18702 "-D" dpi
18703 ;;"-x" scale "-y" scale
18704 "-T" "tight"
18705 "-o" pngfile
18706 dvifile))
18707 (error nil))
18708 (if (not (file-exists-p pngfile))
18709 (if org-format-latex-signal-error
18710 (error "Failed to create png file from %s" texfile)
18711 (message "Failed to create png file from %s" texfile)
18712 nil)
18713 ;; Use the requested file name and clean up
18714 (copy-file pngfile tofile 'replace)
18715 (loop for e in '(".dvi" ".tex" ".aux" ".log" ".png" ".out") do
18716 (if (file-exists-p (concat texfilebase e))
18717 (delete-file (concat texfilebase e))))
18718 pngfile))))
18720 (declare-function org-latex-compile "ox-latex" (texfile &optional snippet))
18721 (defun org-create-formula-image-with-imagemagick (string tofile options buffer)
18722 "This calls convert, which is included into imagemagick."
18723 (require 'ox-latex)
18724 (let* ((tmpdir (if (featurep 'xemacs)
18725 (temp-directory)
18726 temporary-file-directory))
18727 (texfilebase (make-temp-name
18728 (expand-file-name "orgtex" tmpdir)))
18729 (texfile (concat texfilebase ".tex"))
18730 (pdffile (concat texfilebase ".pdf"))
18731 (pngfile (concat texfilebase ".png"))
18732 (fnh (if (featurep 'xemacs)
18733 (font-height (face-font 'default))
18734 (face-attribute 'default :height nil)))
18735 (scale (or (plist-get options (if buffer :scale :html-scale)) 1.0))
18736 (dpi (number-to-string (* scale (floor (if buffer fnh 120.)))))
18737 (fg (or (plist-get options (if buffer :foreground :html-foreground))
18738 "black"))
18739 (bg (or (plist-get options (if buffer :background :html-background))
18740 "white")))
18741 (if (eq fg 'default) (setq fg (org-latex-color :foreground))
18742 (setq fg (org-latex-color-format fg)))
18743 (if (eq bg 'default) (setq bg (org-latex-color :background))
18744 (setq bg (org-latex-color-format
18745 (if (string= bg "Transparent") "white" bg))))
18746 (let ((latex-header (org-create-formula--latex-header)))
18747 (with-temp-file texfile
18748 (insert latex-header)
18749 (insert "\n\\begin{document}\n"
18750 "\\definecolor{fg}{rgb}{" fg "}\n"
18751 "\\definecolor{bg}{rgb}{" bg "}\n"
18752 "\n\\pagecolor{bg}\n"
18753 "\n{\\color{fg}\n"
18754 string
18755 "\n}\n"
18756 "\n\\end{document}\n")))
18757 (org-latex-compile texfile t)
18758 (if (not (file-exists-p pdffile))
18759 (progn (message "Failed to create pdf file from %s" texfile) nil)
18760 (condition-case nil
18761 (if (featurep 'xemacs)
18762 (call-process "convert" nil nil nil
18763 "-density" "96"
18764 "-trim"
18765 "-antialias"
18766 pdffile
18767 "-quality" "100"
18768 ;; "-sharpen" "0x1.0"
18769 pngfile)
18770 (call-process "convert" nil nil nil
18771 "-density" dpi
18772 "-trim"
18773 "-antialias"
18774 pdffile
18775 "-quality" "100"
18776 ;; "-sharpen" "0x1.0"
18777 pngfile))
18778 (error nil))
18779 (if (not (file-exists-p pngfile))
18780 (if org-format-latex-signal-error
18781 (error "Failed to create png file from %s" texfile)
18782 (message "Failed to create png file from %s" texfile)
18783 nil)
18784 ;; Use the requested file name and clean up
18785 (copy-file pngfile tofile 'replace)
18786 (loop for e in '(".pdf" ".tex" ".aux" ".log" ".png") do
18787 (if (file-exists-p (concat texfilebase e))
18788 (delete-file (concat texfilebase e))))
18789 pngfile))))
18791 (defun org-splice-latex-header (tpl def-pkg pkg snippets-p &optional extra)
18792 "Fill a LaTeX header template TPL.
18793 In the template, the following place holders will be recognized:
18795 [DEFAULT-PACKAGES] \\usepackage statements for DEF-PKG
18796 [NO-DEFAULT-PACKAGES] do not include DEF-PKG
18797 [PACKAGES] \\usepackage statements for PKG
18798 [NO-PACKAGES] do not include PKG
18799 [EXTRA] the string EXTRA
18800 [NO-EXTRA] do not include EXTRA
18802 For backward compatibility, if both the positive and the negative place
18803 holder is missing, the positive one (without the \"NO-\") will be
18804 assumed to be present at the end of the template.
18805 DEF-PKG and PKG are assumed to be alists of options/packagename lists.
18806 EXTRA is a string.
18807 SNIPPETS-P indicates if this is run to create snippet images for HTML."
18808 (let (rpl (end ""))
18809 (if (string-match "^[ \t]*\\[\\(NO-\\)?DEFAULT-PACKAGES\\][ \t]*\n?" tpl)
18810 (setq rpl (if (or (match-end 1) (not def-pkg))
18811 "" (org-latex-packages-to-string def-pkg snippets-p t))
18812 tpl (replace-match rpl t t tpl))
18813 (if def-pkg (setq end (org-latex-packages-to-string def-pkg snippets-p))))
18815 (if (string-match "\\[\\(NO-\\)?PACKAGES\\][ \t]*\n?" tpl)
18816 (setq rpl (if (or (match-end 1) (not pkg))
18817 "" (org-latex-packages-to-string pkg snippets-p t))
18818 tpl (replace-match rpl t t tpl))
18819 (if pkg (setq end
18820 (concat end "\n"
18821 (org-latex-packages-to-string pkg snippets-p)))))
18823 (if (string-match "\\[\\(NO-\\)?EXTRA\\][ \t]*\n?" tpl)
18824 (setq rpl (if (or (match-end 1) (not extra))
18825 "" (concat extra "\n"))
18826 tpl (replace-match rpl t t tpl))
18827 (if (and extra (string-match "\\S-" extra))
18828 (setq end (concat end "\n" extra))))
18830 (if (string-match "\\S-" end)
18831 (concat tpl "\n" end)
18832 tpl)))
18834 (defun org-latex-packages-to-string (pkg &optional snippets-p newline)
18835 "Turn an alist of packages into a string with the \\usepackage macros."
18836 (setq pkg (mapconcat (lambda(p)
18837 (cond
18838 ((stringp p) p)
18839 ((and snippets-p (>= (length p) 3) (not (nth 2 p)))
18840 (format "%% Package %s omitted" (cadr p)))
18841 ((equal "" (car p))
18842 (format "\\usepackage{%s}" (cadr p)))
18844 (format "\\usepackage[%s]{%s}"
18845 (car p) (cadr p)))))
18847 "\n"))
18848 (if newline (concat pkg "\n") pkg))
18850 (defun org-dvipng-color (attr)
18851 "Return a RGB color specification for dvipng."
18852 (apply 'format "rgb %s %s %s"
18853 (mapcar 'org-normalize-color
18854 (if (featurep 'xemacs)
18855 (color-rgb-components
18856 (face-property 'default
18857 (cond ((eq attr :foreground) 'foreground)
18858 ((eq attr :background) 'background))))
18859 (color-values (face-attribute 'default attr nil))))))
18861 (defun org-dvipng-color-format (color-name)
18862 "Convert COLOR-NAME to a RGB color value for dvipng."
18863 (apply 'format "rgb %s %s %s"
18864 (mapcar 'org-normalize-color
18865 (color-values color-name))))
18867 (defun org-latex-color (attr)
18868 "Return a RGB color for the LaTeX color package."
18869 (apply 'format "%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-latex-color-format (color-name)
18879 "Convert COLOR-NAME to a RGB color value."
18880 (apply 'format "%s,%s,%s"
18881 (mapcar 'org-normalize-color
18882 (color-values color-name))))
18884 (defun org-normalize-color (value)
18885 "Return string to be used as color value for an RGB component."
18886 (format "%g" (/ value 65535.0)))
18890 ;; Image display
18892 (defvar org-inline-image-overlays nil)
18893 (make-variable-buffer-local 'org-inline-image-overlays)
18895 (defun org-toggle-inline-images (&optional include-linked)
18896 "Toggle the display of inline images.
18897 INCLUDE-LINKED is passed to `org-display-inline-images'."
18898 (interactive "P")
18899 (if org-inline-image-overlays
18900 (progn
18901 (org-remove-inline-images)
18902 (message "Inline image display turned off"))
18903 (org-display-inline-images include-linked)
18904 (if (and (org-called-interactively-p)
18905 org-inline-image-overlays)
18906 (message "%d images displayed inline"
18907 (length org-inline-image-overlays))
18908 (message "No images to display inline"))))
18910 (defun org-redisplay-inline-images ()
18911 "Refresh the display of inline images."
18912 (interactive)
18913 (if (not org-inline-image-overlays)
18914 (org-toggle-inline-images)
18915 (org-toggle-inline-images)
18916 (org-toggle-inline-images)))
18918 (defun org-display-inline-images (&optional include-linked refresh beg end)
18919 "Display inline images.
18921 An inline image is a link which follows either of these
18922 conventions:
18924 1. Its path is a file with an extension matching return value
18925 from `image-file-name-regexp' and it has no contents.
18927 2. Its description consists in a single link of the previous
18928 type.
18930 When optional argument INCLUDE-LINKED is non-nil, also links with
18931 a text description part will be inlined. This can be nice for
18932 a quick look at those images, but it does not reflect what
18933 exported files will look like.
18935 When optional argument REFRESH is non-nil, refresh existing
18936 images between BEG and END. This will create new image displays
18937 only if necessary. BEG and END default to the buffer
18938 boundaries."
18939 (interactive "P")
18940 (when (display-graphic-p)
18941 (unless refresh
18942 (org-remove-inline-images)
18943 (when (fboundp 'clear-image-cache) (clear-image-cache)))
18944 (org-with-wide-buffer
18945 (goto-char (or beg (point-min)))
18946 (let ((case-fold-search t)
18947 (file-extension-re (org-image-file-name-regexp)))
18948 (while (re-search-forward "[][]\\[\\(?:file\\|[./~]\\)" end t)
18949 (let ((link (save-match-data (org-element-context))))
18950 ;; Check if we're at an inline image.
18951 (when (and (equal (org-element-property :type link) "file")
18952 (or include-linked
18953 (not (org-element-property :contents-begin link)))
18954 (let ((parent (org-element-property :parent link)))
18955 (or (not (eq (org-element-type parent) 'link))
18956 (not (cdr (org-element-contents parent)))))
18957 (org-string-match-p file-extension-re
18958 (org-element-property :path link)))
18959 (let ((file (expand-file-name (org-element-property :path link))))
18960 (when (file-exists-p file)
18961 (let ((width
18962 ;; Apply `org-image-actual-width' specifications.
18963 (cond
18964 ((not (image-type-available-p 'imagemagick)) nil)
18965 ((eq org-image-actual-width t) nil)
18966 ((listp org-image-actual-width)
18968 ;; First try to find a width among
18969 ;; attributes associated to the paragraph
18970 ;; containing link.
18971 (let ((paragraph
18972 (let ((e link))
18973 (while (and (setq e (org-element-property
18974 :parent e))
18975 (not (eq (org-element-type e)
18976 'paragraph))))
18977 e)))
18978 (when paragraph
18979 (save-excursion
18980 (goto-char (org-element-property :begin paragraph))
18981 (when (save-match-data
18982 (re-search-forward
18983 "^[ \t]*#\\+attr_.*?: +.*?:width +\\(\\S-+\\)"
18984 (org-element-property
18985 :post-affiliated paragraph)
18987 (string-to-number (match-string 1))))))
18988 ;; Otherwise, fall-back to provided number.
18989 (car org-image-actual-width)))
18990 ((numberp org-image-actual-width)
18991 org-image-actual-width)))
18992 (old (get-char-property-and-overlay
18993 (org-element-property :begin link)
18994 'org-image-overlay)))
18995 (if (and (car-safe old) refresh)
18996 (image-refresh (overlay-get (cdr old) 'display))
18997 (let ((image (save-match-data
18998 (create-image file
18999 (and width 'imagemagick)
19001 :width width))))
19002 (when image
19003 (let* ((link
19004 ;; If inline image is the description
19005 ;; of another link, be sure to
19006 ;; consider the latter as the one to
19007 ;; apply the overlay on.
19008 (let ((parent
19009 (org-element-property :parent link)))
19010 (if (eq (org-element-type parent) 'link)
19011 parent
19012 link)))
19013 (ov (make-overlay
19014 (org-element-property :begin link)
19015 (progn
19016 (goto-char
19017 (org-element-property :end link))
19018 (skip-chars-backward " \t")
19019 (point)))))
19020 (overlay-put ov 'display image)
19021 (overlay-put ov 'face 'default)
19022 (overlay-put ov 'org-image-overlay t)
19023 (overlay-put
19024 ov 'modification-hooks
19025 (list 'org-display-inline-remove-overlay))
19026 (push ov org-inline-image-overlays)))))))))))))))
19028 (define-obsolete-function-alias
19029 'org-display-inline-modification-hook 'org-display-inline-remove-overlay "24.3")
19031 (defun org-display-inline-remove-overlay (ov after beg end &optional len)
19032 "Remove inline-display overlay if a corresponding region is modified."
19033 (let ((inhibit-modification-hooks t))
19034 (when (and ov after)
19035 (delete ov org-inline-image-overlays)
19036 (delete-overlay ov))))
19038 (defun org-remove-inline-images ()
19039 "Remove inline display of images."
19040 (interactive)
19041 (mapc 'delete-overlay org-inline-image-overlays)
19042 (setq org-inline-image-overlays nil))
19044 ;;;; Key bindings
19046 ;; Outline functions from `outline-mode-prefix-map'
19047 ;; that can be remapped in Org:
19048 (define-key org-mode-map [remap outline-mark-subtree] 'org-mark-subtree)
19049 (define-key org-mode-map [remap show-subtree] 'org-show-subtree)
19050 (define-key org-mode-map [remap outline-forward-same-level]
19051 'org-forward-heading-same-level)
19052 (define-key org-mode-map [remap outline-backward-same-level]
19053 'org-backward-heading-same-level)
19054 (define-key org-mode-map [remap show-branches]
19055 'org-kill-note-or-show-branches)
19056 (define-key org-mode-map [remap outline-promote] 'org-promote-subtree)
19057 (define-key org-mode-map [remap outline-demote] 'org-demote-subtree)
19058 (define-key org-mode-map [remap outline-insert-heading] 'org-ctrl-c-ret)
19060 ;; Outline functions from `outline-mode-prefix-map' that can not
19061 ;; be remapped in Org:
19063 ;; - the column "key binding" shows whether the Outline function is still
19064 ;; available in Org mode on the same key that it has been bound to in
19065 ;; Outline mode:
19066 ;; - "overridden": key used for a different functionality in Org mode
19067 ;; - else: key still bound to the same Outline function in Org mode
19069 ;; | Outline function | key binding | Org replacement |
19070 ;; |------------------------------------+-------------+-----------------------|
19071 ;; | `outline-next-visible-heading' | `C-c C-n' | still same function |
19072 ;; | `outline-previous-visible-heading' | `C-c C-p' | still same function |
19073 ;; | `outline-up-heading' | `C-c C-u' | still same function |
19074 ;; | `outline-move-subtree-up' | overridden | better: org-shiftup |
19075 ;; | `outline-move-subtree-down' | overridden | better: org-shiftdown |
19076 ;; | `show-entry' | overridden | no replacement |
19077 ;; | `show-children' | `C-c C-i' | visibility cycling |
19078 ;; | `show-branches' | `C-c C-k' | still same function |
19079 ;; | `show-subtree' | overridden | visibility cycling |
19080 ;; | `show-all' | overridden | no replacement |
19081 ;; | `hide-subtree' | overridden | visibility cycling |
19082 ;; | `hide-body' | overridden | no replacement |
19083 ;; | `hide-entry' | overridden | visibility cycling |
19084 ;; | `hide-leaves' | overridden | no replacement |
19085 ;; | `hide-sublevels' | overridden | no replacement |
19086 ;; | `hide-other' | overridden | no replacement |
19088 ;; Make `C-c C-x' a prefix key
19089 (org-defkey org-mode-map "\C-c\C-x" (make-sparse-keymap))
19091 ;; TAB key with modifiers
19092 (org-defkey org-mode-map "\C-i" 'org-cycle)
19093 (org-defkey org-mode-map [(tab)] 'org-cycle)
19094 (org-defkey org-mode-map [(control tab)] 'org-force-cycle-archived)
19095 (org-defkey org-mode-map "\M-\t" 'pcomplete)
19096 ;; The following line is necessary under Suse GNU/Linux
19097 (unless (featurep 'xemacs)
19098 (org-defkey org-mode-map [S-iso-lefttab] 'org-shifttab))
19099 (org-defkey org-mode-map [(shift tab)] 'org-shifttab)
19100 (define-key org-mode-map [backtab] 'org-shifttab)
19102 (org-defkey org-mode-map [(shift return)] 'org-table-copy-down)
19103 (org-defkey org-mode-map [(meta shift return)] 'org-insert-todo-heading)
19104 (org-defkey org-mode-map [(meta return)] 'org-meta-return)
19106 ;; Cursor keys with modifiers
19107 (org-defkey org-mode-map [(meta left)] 'org-metaleft)
19108 (org-defkey org-mode-map [(meta right)] 'org-metaright)
19109 (org-defkey org-mode-map [(meta up)] 'org-metaup)
19110 (org-defkey org-mode-map [(meta down)] 'org-metadown)
19112 (org-defkey org-mode-map [(meta shift left)] 'org-shiftmetaleft)
19113 (org-defkey org-mode-map [(meta shift right)] 'org-shiftmetaright)
19114 (org-defkey org-mode-map [(meta shift up)] 'org-shiftmetaup)
19115 (org-defkey org-mode-map [(meta shift down)] 'org-shiftmetadown)
19117 (org-defkey org-mode-map [(shift up)] 'org-shiftup)
19118 (org-defkey org-mode-map [(shift down)] 'org-shiftdown)
19119 (org-defkey org-mode-map [(shift left)] 'org-shiftleft)
19120 (org-defkey org-mode-map [(shift right)] 'org-shiftright)
19122 (org-defkey org-mode-map [(control shift right)] 'org-shiftcontrolright)
19123 (org-defkey org-mode-map [(control shift left)] 'org-shiftcontrolleft)
19124 (org-defkey org-mode-map [(control shift up)] 'org-shiftcontrolup)
19125 (org-defkey org-mode-map [(control shift down)] 'org-shiftcontroldown)
19127 ;; Babel keys
19128 (define-key org-mode-map org-babel-key-prefix org-babel-map)
19129 (mapc (lambda (pair)
19130 (define-key org-babel-map (car pair) (cdr pair)))
19131 org-babel-key-bindings)
19133 ;;; Extra keys for tty access.
19134 ;; We only set them when really needed because otherwise the
19135 ;; menus don't show the simple keys
19137 (when (or org-use-extra-keys
19138 (featurep 'xemacs) ;; because XEmacs supports multi-device stuff
19139 (not window-system))
19140 (org-defkey org-mode-map "\C-c\C-xc" 'org-table-copy-down)
19141 (org-defkey org-mode-map "\C-c\C-xM" 'org-insert-todo-heading)
19142 (org-defkey org-mode-map "\C-c\C-xm" 'org-meta-return)
19143 (org-defkey org-mode-map [?\e (return)] 'org-meta-return)
19144 (org-defkey org-mode-map [?\e (left)] 'org-metaleft)
19145 (org-defkey org-mode-map "\C-c\C-xl" 'org-metaleft)
19146 (org-defkey org-mode-map [?\e (right)] 'org-metaright)
19147 (org-defkey org-mode-map "\C-c\C-xr" 'org-metaright)
19148 (org-defkey org-mode-map [?\e (up)] 'org-metaup)
19149 (org-defkey org-mode-map "\C-c\C-xu" 'org-metaup)
19150 (org-defkey org-mode-map [?\e (down)] 'org-metadown)
19151 (org-defkey org-mode-map "\C-c\C-xd" 'org-metadown)
19152 (org-defkey org-mode-map "\C-c\C-xL" 'org-shiftmetaleft)
19153 (org-defkey org-mode-map "\C-c\C-xR" 'org-shiftmetaright)
19154 (org-defkey org-mode-map "\C-c\C-xU" 'org-shiftmetaup)
19155 (org-defkey org-mode-map "\C-c\C-xD" 'org-shiftmetadown)
19156 (org-defkey org-mode-map [?\C-c (up)] 'org-shiftup)
19157 (org-defkey org-mode-map [?\C-c (down)] 'org-shiftdown)
19158 (org-defkey org-mode-map [?\C-c (left)] 'org-shiftleft)
19159 (org-defkey org-mode-map [?\C-c (right)] 'org-shiftright)
19160 (org-defkey org-mode-map [?\C-c ?\C-x (right)] 'org-shiftcontrolright)
19161 (org-defkey org-mode-map [?\C-c ?\C-x (left)] 'org-shiftcontrolleft)
19162 (org-defkey org-mode-map [?\e (tab)] 'pcomplete)
19163 (org-defkey org-mode-map [?\e (shift return)] 'org-insert-todo-heading)
19164 (org-defkey org-mode-map [?\e (shift left)] 'org-shiftmetaleft)
19165 (org-defkey org-mode-map [?\e (shift right)] 'org-shiftmetaright)
19166 (org-defkey org-mode-map [?\e (shift up)] 'org-shiftmetaup)
19167 (org-defkey org-mode-map [?\e (shift down)] 'org-shiftmetadown))
19169 ;; All the other keys
19171 (org-defkey org-mode-map "\C-c\C-a" 'show-all) ; in case allout messed up.
19172 (org-defkey org-mode-map "\C-c\C-r" 'org-reveal)
19173 (if (boundp 'narrow-map)
19174 (org-defkey narrow-map "s" 'org-narrow-to-subtree)
19175 (org-defkey org-mode-map "\C-xns" 'org-narrow-to-subtree))
19176 (if (boundp 'narrow-map)
19177 (org-defkey narrow-map "b" 'org-narrow-to-block)
19178 (org-defkey org-mode-map "\C-xnb" 'org-narrow-to-block))
19179 (if (boundp 'narrow-map)
19180 (org-defkey narrow-map "e" 'org-narrow-to-element)
19181 (org-defkey org-mode-map "\C-xne" 'org-narrow-to-element))
19182 (org-defkey org-mode-map "\C-\M-t" 'org-transpose-element)
19183 (org-defkey org-mode-map "\M-}" 'org-forward-element)
19184 (org-defkey org-mode-map "\M-{" 'org-backward-element)
19185 (org-defkey org-mode-map "\C-c\C-^" 'org-up-element)
19186 (org-defkey org-mode-map "\C-c\C-_" 'org-down-element)
19187 (org-defkey org-mode-map "\C-c\C-f" 'org-forward-heading-same-level)
19188 (org-defkey org-mode-map "\C-c\C-b" 'org-backward-heading-same-level)
19189 (org-defkey org-mode-map "\C-c\M-f" 'org-next-block)
19190 (org-defkey org-mode-map "\C-c\M-b" 'org-previous-block)
19191 (org-defkey org-mode-map "\C-c$" 'org-archive-subtree)
19192 (org-defkey org-mode-map "\C-c\C-x\C-s" 'org-advertized-archive-subtree)
19193 (org-defkey org-mode-map "\C-c\C-x\C-a" 'org-archive-subtree-default)
19194 (org-defkey org-mode-map "\C-c\C-xd" 'org-insert-drawer)
19195 (org-defkey org-mode-map "\C-c\C-xa" 'org-toggle-archive-tag)
19196 (org-defkey org-mode-map "\C-c\C-xA" 'org-archive-to-archive-sibling)
19197 (org-defkey org-mode-map "\C-c\C-xb" 'org-tree-to-indirect-buffer)
19198 (org-defkey org-mode-map "\C-c\C-xq" 'org-toggle-tags-groups)
19199 (org-defkey org-mode-map "\C-c\C-j" 'org-goto)
19200 (org-defkey org-mode-map "\C-c\C-t" 'org-todo)
19201 (org-defkey org-mode-map "\C-c\C-q" 'org-set-tags-command)
19202 (org-defkey org-mode-map "\C-c\C-s" 'org-schedule)
19203 (org-defkey org-mode-map "\C-c\C-d" 'org-deadline)
19204 (org-defkey org-mode-map "\C-c;" 'org-toggle-comment)
19205 (org-defkey org-mode-map "\C-c\C-w" 'org-refile)
19206 (org-defkey org-mode-map "\C-c\M-w" 'org-copy)
19207 (org-defkey org-mode-map "\C-c/" 'org-sparse-tree) ; Minor-mode reserved
19208 (org-defkey org-mode-map "\C-c\\" 'org-match-sparse-tree) ; Minor-mode res.
19209 (org-defkey org-mode-map "\C-c\C-m" 'org-ctrl-c-ret)
19210 (org-defkey org-mode-map "\M-\C-m" 'org-insert-heading)
19211 (org-defkey org-mode-map "\C-c\C-xc" 'org-clone-subtree-with-time-shift)
19212 (org-defkey org-mode-map "\C-c\C-xv" 'org-copy-visible)
19213 (org-defkey org-mode-map [(control return)] 'org-insert-heading-respect-content)
19214 (org-defkey org-mode-map [(shift control return)] 'org-insert-todo-heading-respect-content)
19215 (org-defkey org-mode-map "\C-c\C-x\C-n" 'org-next-link)
19216 (org-defkey org-mode-map "\C-c\C-x\C-p" 'org-previous-link)
19217 (org-defkey org-mode-map "\C-c\C-l" 'org-insert-link)
19218 (org-defkey org-mode-map "\C-c\M-l" 'org-insert-last-stored-link)
19219 (org-defkey org-mode-map "\C-c\C-\M-l" 'org-insert-all-links)
19220 (org-defkey org-mode-map "\C-c\C-o" 'org-open-at-point)
19221 (org-defkey org-mode-map "\C-c%" 'org-mark-ring-push)
19222 (org-defkey org-mode-map "\C-c&" 'org-mark-ring-goto)
19223 (org-defkey org-mode-map "\C-c\C-z" 'org-add-note) ; Alternative binding
19224 (org-defkey org-mode-map "\C-c." 'org-time-stamp) ; Minor-mode reserved
19225 (org-defkey org-mode-map "\C-c!" 'org-time-stamp-inactive) ; Minor-mode r.
19226 (org-defkey org-mode-map "\C-c," 'org-priority) ; Minor-mode reserved
19227 (org-defkey org-mode-map "\C-c\C-y" 'org-evaluate-time-range)
19228 (org-defkey org-mode-map "\C-c>" 'org-goto-calendar)
19229 (org-defkey org-mode-map "\C-c<" 'org-date-from-calendar)
19230 (org-defkey org-mode-map [(control ?,)] 'org-cycle-agenda-files)
19231 (org-defkey org-mode-map [(control ?\')] 'org-cycle-agenda-files)
19232 (org-defkey org-mode-map "\C-c[" 'org-agenda-file-to-front)
19233 (org-defkey org-mode-map "\C-c]" 'org-remove-file)
19234 (org-defkey org-mode-map "\C-c\C-x<" 'org-agenda-set-restriction-lock)
19235 (org-defkey org-mode-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
19236 (org-defkey org-mode-map "\C-c-" 'org-ctrl-c-minus)
19237 (org-defkey org-mode-map "\C-c*" 'org-ctrl-c-star)
19238 (org-defkey org-mode-map "\C-c^" 'org-sort)
19239 (org-defkey org-mode-map "\C-c\C-c" 'org-ctrl-c-ctrl-c)
19240 (org-defkey org-mode-map "\C-c\C-k" 'org-kill-note-or-show-branches)
19241 (org-defkey org-mode-map "\C-c#" 'org-update-statistics-cookies)
19242 (org-defkey org-mode-map [remap open-line] 'org-open-line)
19243 (org-defkey org-mode-map [remap comment-dwim] 'org-comment-dwim)
19244 (org-defkey org-mode-map [remap forward-paragraph] 'org-forward-paragraph)
19245 (org-defkey org-mode-map [remap backward-paragraph] 'org-backward-paragraph)
19246 (org-defkey org-mode-map "\C-m" 'org-return)
19247 (org-defkey org-mode-map "\C-j" 'org-return-indent)
19248 (org-defkey org-mode-map "\C-c?" 'org-table-field-info)
19249 (org-defkey org-mode-map "\C-c " 'org-table-blank-field)
19250 (org-defkey org-mode-map "\C-c+" 'org-table-sum)
19251 (org-defkey org-mode-map "\C-c=" 'org-table-eval-formula)
19252 (org-defkey org-mode-map "\C-c'" 'org-edit-special)
19253 (org-defkey org-mode-map "\C-c`" 'org-table-edit-field)
19254 (org-defkey org-mode-map "\C-c|" 'org-table-create-or-convert-from-region)
19255 (org-defkey org-mode-map [(control ?#)] 'org-table-rotate-recalc-marks)
19256 (org-defkey org-mode-map "\C-c~" 'org-table-create-with-table.el)
19257 (org-defkey org-mode-map "\C-c\C-a" 'org-attach)
19258 (org-defkey org-mode-map "\C-c}" 'org-table-toggle-coordinate-overlays)
19259 (org-defkey org-mode-map "\C-c{" 'org-table-toggle-formula-debugger)
19260 (org-defkey org-mode-map "\C-c\C-e" 'org-export-dispatch)
19261 (org-defkey org-mode-map "\C-c:" 'org-toggle-fixed-width)
19262 (org-defkey org-mode-map "\C-c\C-x\C-f" 'org-emphasize)
19263 (org-defkey org-mode-map "\C-c\C-xf" 'org-footnote-action)
19264 (org-defkey org-mode-map "\C-c\C-x\C-mg" 'org-mobile-pull)
19265 (org-defkey org-mode-map "\C-c\C-x\C-mp" 'org-mobile-push)
19266 (org-defkey org-mode-map "\C-c@" 'org-mark-subtree)
19267 (org-defkey org-mode-map "\M-h" 'org-mark-element)
19268 (org-defkey org-mode-map [?\C-c (control ?*)] 'org-list-make-subtree)
19269 ;;(org-defkey org-mode-map [?\C-c (control ?-)] 'org-list-make-list-from-subtree)
19271 (org-defkey org-mode-map "\C-c\C-x\C-w" 'org-cut-special)
19272 (org-defkey org-mode-map "\C-c\C-x\M-w" 'org-copy-special)
19273 (org-defkey org-mode-map "\C-c\C-x\C-y" 'org-paste-special)
19275 (org-defkey org-mode-map "\C-c\C-x\C-t" 'org-toggle-time-stamp-overlays)
19276 (org-defkey org-mode-map "\C-c\C-x\C-i" 'org-clock-in)
19277 (org-defkey org-mode-map "\C-c\C-x\C-x" 'org-clock-in-last)
19278 (org-defkey org-mode-map "\C-c\C-x\C-z" 'org-resolve-clocks)
19279 (org-defkey org-mode-map "\C-c\C-x\C-o" 'org-clock-out)
19280 (org-defkey org-mode-map "\C-c\C-x\C-j" 'org-clock-goto)
19281 (org-defkey org-mode-map "\C-c\C-x\C-q" 'org-clock-cancel)
19282 (org-defkey org-mode-map "\C-c\C-x\C-d" 'org-clock-display)
19283 (org-defkey org-mode-map "\C-c\C-x\C-r" 'org-clock-report)
19284 (org-defkey org-mode-map "\C-c\C-x\C-u" 'org-dblock-update)
19285 (org-defkey org-mode-map "\C-c\C-x\C-l" 'org-preview-latex-fragment)
19286 (org-defkey org-mode-map "\C-c\C-x\C-v" 'org-toggle-inline-images)
19287 (org-defkey org-mode-map "\C-c\C-x\C-\M-v" 'org-redisplay-inline-images)
19288 (org-defkey org-mode-map "\C-c\C-x\\" 'org-toggle-pretty-entities)
19289 (org-defkey org-mode-map "\C-c\C-x\C-b" 'org-toggle-checkbox)
19290 (org-defkey org-mode-map "\C-c\C-xp" 'org-set-property)
19291 (org-defkey org-mode-map "\C-c\C-xP" 'org-set-property-and-value)
19292 (org-defkey org-mode-map "\C-c\C-xe" 'org-set-effort)
19293 (org-defkey org-mode-map "\C-c\C-xE" 'org-inc-effort)
19294 (org-defkey org-mode-map "\C-c\C-xo" 'org-toggle-ordered-property)
19295 (org-defkey org-mode-map "\C-c\C-xi" 'org-insert-columns-dblock)
19296 (org-defkey org-mode-map [(control ?c) (control ?x) ?\;] 'org-timer-set-timer)
19297 (org-defkey org-mode-map [(control ?c) (control ?x) ?\:] 'org-timer-cancel-timer)
19299 (org-defkey org-mode-map "\C-c\C-x." 'org-timer)
19300 (org-defkey org-mode-map "\C-c\C-x-" 'org-timer-item)
19301 (org-defkey org-mode-map "\C-c\C-x0" 'org-timer-start)
19302 (org-defkey org-mode-map "\C-c\C-x_" 'org-timer-stop)
19303 (org-defkey org-mode-map "\C-c\C-x," 'org-timer-pause-or-continue)
19305 (define-key org-mode-map "\C-c\C-x\C-c" 'org-columns)
19307 (define-key org-mode-map "\C-c\C-x!" 'org-reload)
19309 (define-key org-mode-map "\C-c\C-xg" 'org-feed-update-all)
19310 (define-key org-mode-map "\C-c\C-xG" 'org-feed-goto-inbox)
19312 (define-key org-mode-map "\C-c\C-x[" 'org-reftex-citation)
19315 (when (featurep 'xemacs)
19316 (org-defkey org-mode-map 'button3 'popup-mode-menu))
19319 (defconst org-speed-commands-default
19321 ("Outline Navigation")
19322 ("n" . (org-speed-move-safe 'outline-next-visible-heading))
19323 ("p" . (org-speed-move-safe 'outline-previous-visible-heading))
19324 ("f" . (org-speed-move-safe 'org-forward-heading-same-level))
19325 ("b" . (org-speed-move-safe 'org-backward-heading-same-level))
19326 ("F" . org-next-block)
19327 ("B" . org-previous-block)
19328 ("u" . (org-speed-move-safe 'outline-up-heading))
19329 ("j" . org-goto)
19330 ("g" . (org-refile t))
19331 ("Outline Visibility")
19332 ("c" . org-cycle)
19333 ("C" . org-shifttab)
19334 (" " . org-display-outline-path)
19335 ("s" . org-narrow-to-subtree)
19336 ("=" . org-columns)
19337 ("Outline Structure Editing")
19338 ("U" . org-shiftmetaup)
19339 ("D" . org-shiftmetadown)
19340 ("r" . org-metaright)
19341 ("l" . org-metaleft)
19342 ("R" . org-shiftmetaright)
19343 ("L" . org-shiftmetaleft)
19344 ("i" . (progn (forward-char 1) (call-interactively
19345 'org-insert-heading-respect-content)))
19346 ("^" . org-sort)
19347 ("w" . org-refile)
19348 ("a" . org-archive-subtree-default-with-confirmation)
19349 ("@" . org-mark-subtree)
19350 ("#" . org-toggle-comment)
19351 ("Clock Commands")
19352 ("I" . org-clock-in)
19353 ("O" . org-clock-out)
19354 ("Meta Data Editing")
19355 ("t" . org-todo)
19356 ("," . (org-priority))
19357 ("0" . (org-priority ?\ ))
19358 ("1" . (org-priority ?A))
19359 ("2" . (org-priority ?B))
19360 ("3" . (org-priority ?C))
19361 (":" . org-set-tags-command)
19362 ("e" . org-set-effort)
19363 ("E" . org-inc-effort)
19364 ("W" . (lambda(m) (interactive "sMinutes before warning: ")
19365 (org-entry-put (point) "APPT_WARNTIME" m)))
19366 ("Agenda Views etc")
19367 ("v" . org-agenda)
19368 ("/" . org-sparse-tree)
19369 ("Misc")
19370 ("o" . org-open-at-point)
19371 ("?" . org-speed-command-help)
19372 ("<" . (org-agenda-set-restriction-lock 'subtree))
19373 (">" . (org-agenda-remove-restriction-lock))
19375 "The default speed commands.")
19377 (defun org-print-speed-command (e)
19378 (if (> (length (car e)) 1)
19379 (progn
19380 (princ "\n")
19381 (princ (car e))
19382 (princ "\n")
19383 (princ (make-string (length (car e)) ?-))
19384 (princ "\n"))
19385 (princ (car e))
19386 (princ " ")
19387 (if (symbolp (cdr e))
19388 (princ (symbol-name (cdr e)))
19389 (prin1 (cdr e)))
19390 (princ "\n")))
19392 (defun org-speed-command-help ()
19393 "Show the available speed commands."
19394 (interactive)
19395 (if (not org-use-speed-commands)
19396 (user-error "Speed commands are not activated, customize `org-use-speed-commands'")
19397 (with-output-to-temp-buffer "*Help*"
19398 (princ "User-defined Speed commands\n===========================\n")
19399 (mapc 'org-print-speed-command org-speed-commands-user)
19400 (princ "\n")
19401 (princ "Built-in Speed commands\n=======================\n")
19402 (mapc 'org-print-speed-command org-speed-commands-default))
19403 (with-current-buffer "*Help*"
19404 (setq truncate-lines t))))
19406 (defun org-speed-move-safe (cmd)
19407 "Execute CMD, but make sure that the cursor always ends up in a headline.
19408 If not, return to the original position and throw an error."
19409 (interactive)
19410 (let ((pos (point)))
19411 (call-interactively cmd)
19412 (unless (and (bolp) (org-at-heading-p))
19413 (goto-char pos)
19414 (error "Boundary reached while executing %s" cmd))))
19416 (defvar org-self-insert-command-undo-counter 0)
19418 (defvar org-table-auto-blank-field) ; defined in org-table.el
19419 (defvar org-speed-command nil)
19421 (define-obsolete-function-alias
19422 'org-speed-command-default-hook 'org-speed-command-activate "24.3")
19424 (defun org-speed-command-activate (keys)
19425 "Hook for activating single-letter speed commands.
19426 `org-speed-commands-default' specifies a minimal command set.
19427 Use `org-speed-commands-user' for further customization."
19428 (when (or (and (bolp) (looking-at org-outline-regexp))
19429 (and (functionp org-use-speed-commands)
19430 (funcall org-use-speed-commands)))
19431 (cdr (assoc keys (append org-speed-commands-user
19432 org-speed-commands-default)))))
19434 (define-obsolete-function-alias
19435 'org-babel-speed-command-hook 'org-babel-speed-command-activate "24.3")
19437 (defun org-babel-speed-command-activate (keys)
19438 "Hook for activating single-letter code block commands."
19439 (when (and (bolp) (looking-at org-babel-src-block-regexp))
19440 (cdr (assoc keys org-babel-key-bindings))))
19442 (defcustom org-speed-command-hook
19443 '(org-speed-command-default-hook org-babel-speed-command-hook)
19444 "Hook for activating speed commands at strategic locations.
19445 Hook functions are called in sequence until a valid handler is
19446 found.
19448 Each hook takes a single argument, a user-pressed command key
19449 which is also a `self-insert-command' from the global map.
19451 Within the hook, examine the cursor position and the command key
19452 and return nil or a valid handler as appropriate. Handler could
19453 be one of an interactive command, a function, or a form.
19455 Set `org-use-speed-commands' to non-nil value to enable this
19456 hook. The default setting is `org-speed-command-activate'."
19457 :group 'org-structure
19458 :version "24.1"
19459 :type 'hook)
19461 (defun org-self-insert-command (N)
19462 "Like `self-insert-command', use overwrite-mode for whitespace in tables.
19463 If the cursor is in a table looking at whitespace, the whitespace is
19464 overwritten, and the table is not marked as requiring realignment."
19465 (interactive "p")
19466 (org-check-before-invisible-edit 'insert)
19467 (cond
19468 ((and org-use-speed-commands
19469 (setq org-speed-command
19470 (run-hook-with-args-until-success
19471 'org-speed-command-hook (this-command-keys))))
19472 (cond
19473 ((commandp org-speed-command)
19474 (setq this-command org-speed-command)
19475 (call-interactively org-speed-command))
19476 ((functionp org-speed-command)
19477 (funcall org-speed-command))
19478 ((and org-speed-command (listp org-speed-command))
19479 (eval org-speed-command))
19480 (t (let (org-use-speed-commands)
19481 (call-interactively 'org-self-insert-command)))))
19482 ((and
19483 (org-table-p)
19484 (progn
19485 ;; check if we blank the field, and if that triggers align
19486 (and (featurep 'org-table) org-table-auto-blank-field
19487 (member last-command
19488 '(org-cycle org-return org-shifttab org-ctrl-c-ctrl-c yas/expand))
19489 (if (or (equal (char-after) ?\ ) (looking-at "[^|\n]* |"))
19490 ;; got extra space, this field does not determine column width
19491 (let (org-table-may-need-update) (org-table-blank-field))
19492 ;; no extra space, this field may determine column width
19493 (org-table-blank-field)))
19495 (eq N 1)
19496 (looking-at "[^|\n]* |"))
19497 (let (org-table-may-need-update)
19498 (goto-char (1- (match-end 0)))
19499 (backward-delete-char 1)
19500 (goto-char (match-beginning 0))
19501 (self-insert-command N)))
19503 (setq org-table-may-need-update t)
19504 (self-insert-command N)
19505 (org-fix-tags-on-the-fly)
19506 (if org-self-insert-cluster-for-undo
19507 (if (not (eq last-command 'org-self-insert-command))
19508 (setq org-self-insert-command-undo-counter 1)
19509 (if (>= org-self-insert-command-undo-counter 20)
19510 (setq org-self-insert-command-undo-counter 1)
19511 (and (> org-self-insert-command-undo-counter 0)
19512 buffer-undo-list (listp buffer-undo-list)
19513 (not (cadr buffer-undo-list)) ; remove nil entry
19514 (setcdr buffer-undo-list (cddr buffer-undo-list)))
19515 (setq org-self-insert-command-undo-counter
19516 (1+ org-self-insert-command-undo-counter))))))))
19518 (defun org-check-before-invisible-edit (kind)
19519 "Check is editing if kind KIND would be dangerous with invisible text around.
19520 The detailed reaction depends on the user option `org-catch-invisible-edits'."
19521 ;; First, try to get out of here as quickly as possible, to reduce overhead
19522 (if (and org-catch-invisible-edits
19523 (or (not (boundp 'visible-mode)) (not visible-mode))
19524 (or (get-char-property (point) 'invisible)
19525 (get-char-property (max (point-min) (1- (point))) 'invisible)))
19526 ;; OK, we need to take a closer look
19527 (let* ((invisible-at-point (get-char-property (point) 'invisible))
19528 (invisible-before-point (if (bobp) nil (get-char-property
19529 (1- (point)) 'invisible)))
19530 (border-and-ok-direction
19532 ;; Check if we are acting predictably before invisible text
19533 (and invisible-at-point (not invisible-before-point)
19534 (memq kind '(insert delete-backward)))
19535 ;; Check if we are acting predictably after invisible text
19536 ;; This works not well, and I have turned it off. It seems
19537 ;; better to always show and stop after invisible text.
19538 ;; (and (not invisible-at-point) invisible-before-point
19539 ;; (memq kind '(insert delete)))
19541 (when (or (memq invisible-at-point '(outline org-hide-block t))
19542 (memq invisible-before-point '(outline org-hide-block t)))
19543 (if (eq org-catch-invisible-edits 'error)
19544 (user-error "Editing in invisible areas is prohibited, make them visible first"))
19545 (if (and org-custom-properties-overlays
19546 (y-or-n-p "Display invisible properties in this buffer? "))
19547 (org-toggle-custom-properties-visibility)
19548 ;; Make the area visible
19549 (save-excursion
19550 (if invisible-before-point
19551 (goto-char (previous-single-char-property-change
19552 (point) 'invisible)))
19553 (org-cycle))
19554 (cond
19555 ((eq org-catch-invisible-edits 'show)
19556 ;; That's it, we do the edit after showing
19557 (message
19558 "Unfolding invisible region around point before editing")
19559 (sit-for 1))
19560 ((and (eq org-catch-invisible-edits 'smart)
19561 border-and-ok-direction)
19562 (message "Unfolding invisible region around point before editing"))
19564 ;; Don't do the edit, make the user repeat it in full visibility
19565 (user-error "Edit in invisible region aborted, repeat to confirm with text visible"))))))))
19567 (defun org-fix-tags-on-the-fly ()
19568 (when (and (equal (char-after (point-at-bol)) ?*)
19569 (org-at-heading-p))
19570 (org-align-tags-here org-tags-column)))
19572 (defun org-delete-backward-char (N)
19573 "Like `delete-backward-char', insert whitespace at field end in tables.
19574 When deleting backwards, in tables this function will insert whitespace in
19575 front of the next \"|\" separator, to keep the table aligned. The table will
19576 still be marked for re-alignment if the field did fill the entire column,
19577 because, in this case the deletion might narrow the column."
19578 (interactive "p")
19579 (save-match-data
19580 (org-check-before-invisible-edit 'delete-backward)
19581 (if (and (org-table-p)
19582 (eq N 1)
19583 (string-match "|" (buffer-substring (point-at-bol) (point)))
19584 (looking-at ".*?|"))
19585 (let ((pos (point))
19586 (noalign (looking-at "[^|\n\r]* |"))
19587 (c org-table-may-need-update))
19588 (backward-delete-char N)
19589 (if (not overwrite-mode)
19590 (progn
19591 (skip-chars-forward "^|")
19592 (insert " ")
19593 (goto-char (1- pos))))
19594 ;; noalign: if there were two spaces at the end, this field
19595 ;; does not determine the width of the column.
19596 (if noalign (setq org-table-may-need-update c)))
19597 (backward-delete-char N)
19598 (org-fix-tags-on-the-fly))))
19600 (defun org-delete-char (N)
19601 "Like `delete-char', but insert whitespace at field end in tables.
19602 When deleting characters, in tables this function will insert whitespace in
19603 front of the next \"|\" separator, to keep the table aligned. The table will
19604 still be marked for re-alignment if the field did fill the entire column,
19605 because, in this case the deletion might narrow the column."
19606 (interactive "p")
19607 (save-match-data
19608 (org-check-before-invisible-edit 'delete)
19609 (if (and (org-table-p)
19610 (not (bolp))
19611 (not (= (char-after) ?|))
19612 (eq N 1))
19613 (if (looking-at ".*?|")
19614 (let ((pos (point))
19615 (noalign (looking-at "[^|\n\r]* |"))
19616 (c org-table-may-need-update))
19617 (replace-match
19618 (concat (substring (match-string 0) 1 -1) " |") nil t)
19619 (goto-char pos)
19620 ;; noalign: if there were two spaces at the end, this field
19621 ;; does not determine the width of the column.
19622 (if noalign (setq org-table-may-need-update c)))
19623 (delete-char N))
19624 (delete-char N)
19625 (org-fix-tags-on-the-fly))))
19627 ;; Make `delete-selection-mode' work with org-mode and orgtbl-mode
19628 (put 'org-self-insert-command 'delete-selection
19629 (lambda ()
19630 (not (run-hook-with-args-until-success
19631 'self-insert-uses-region-functions))))
19632 (put 'orgtbl-self-insert-command 'delete-selection
19633 (lambda ()
19634 (not (run-hook-with-args-until-success
19635 'self-insert-uses-region-functions))))
19636 (put 'org-delete-char 'delete-selection 'supersede)
19637 (put 'org-delete-backward-char 'delete-selection 'supersede)
19638 (put 'org-yank 'delete-selection 'yank)
19640 ;; Make `flyspell-mode' delay after some commands
19641 (put 'org-self-insert-command 'flyspell-delayed t)
19642 (put 'orgtbl-self-insert-command 'flyspell-delayed t)
19643 (put 'org-delete-char 'flyspell-delayed t)
19644 (put 'org-delete-backward-char 'flyspell-delayed t)
19646 ;; Make pabbrev-mode expand after org-mode commands
19647 (put 'org-self-insert-command 'pabbrev-expand-after-command t)
19648 (put 'orgtbl-self-insert-command 'pabbrev-expand-after-command t)
19650 (defun org-remap (map &rest commands)
19651 "In MAP, remap the functions given in COMMANDS.
19652 COMMANDS is a list of alternating OLDDEF NEWDEF command names."
19653 (let (new old)
19654 (while commands
19655 (setq old (pop commands) new (pop commands))
19656 (if (fboundp 'command-remapping)
19657 (org-defkey map (vector 'remap old) new)
19658 (substitute-key-definition old new map global-map)))))
19660 (defun org-transpose-words ()
19661 "Transpose words for Org.
19662 This uses the `org-mode-transpose-word-syntax-table' syntax
19663 table, which interprets characters in `org-emphasis-alist' as
19664 word constituents."
19665 (interactive)
19666 (with-syntax-table org-mode-transpose-word-syntax-table
19667 (call-interactively 'transpose-words)))
19668 (org-remap org-mode-map 'transpose-words 'org-transpose-words)
19670 (when (eq org-enable-table-editor 'optimized)
19671 ;; If the user wants maximum table support, we need to hijack
19672 ;; some standard editing functions
19673 (org-remap org-mode-map
19674 'self-insert-command 'org-self-insert-command
19675 'delete-char 'org-delete-char
19676 'delete-backward-char 'org-delete-backward-char)
19677 (org-defkey org-mode-map "|" 'org-force-self-insert))
19679 (defvar org-ctrl-c-ctrl-c-hook nil
19680 "Hook for functions attaching themselves to `C-c C-c'.
19682 This can be used to add additional functionality to the C-c C-c
19683 key which executes context-dependent commands. This hook is run
19684 before any other test, while `org-ctrl-c-ctrl-c-final-hook' is
19685 run after the last test.
19687 Each function will be called with no arguments. The function
19688 must check if the context is appropriate for it to act. If yes,
19689 it should do its thing and then return a non-nil value. If the
19690 context is wrong, just do nothing and return nil.")
19692 (defvar org-ctrl-c-ctrl-c-final-hook nil
19693 "Hook for functions attaching themselves to `C-c C-c'.
19695 This can be used to add additional functionality to the C-c C-c
19696 key which executes context-dependent commands. This hook is run
19697 after any other test, while `org-ctrl-c-ctrl-c-hook' is run
19698 before the first test.
19700 Each function will be called with no arguments. The function
19701 must check if the context is appropriate for it to act. If yes,
19702 it should do its thing and then return a non-nil value. If the
19703 context is wrong, just do nothing and return nil.")
19705 (defvar org-tab-first-hook nil
19706 "Hook for functions to attach themselves to TAB.
19707 See `org-ctrl-c-ctrl-c-hook' for more information.
19708 This hook runs as the first action when TAB is pressed, even before
19709 `org-cycle' messes around with the `outline-regexp' to cater for
19710 inline tasks and plain list item folding.
19711 If any function in this hook returns t, any other actions that
19712 would have been caused by TAB (such as table field motion or visibility
19713 cycling) will not occur.")
19715 (defvar org-tab-after-check-for-table-hook nil
19716 "Hook for functions to attach themselves to TAB.
19717 See `org-ctrl-c-ctrl-c-hook' for more information.
19718 This hook runs after it has been established that the cursor is not in a
19719 table, but before checking if the cursor is in a headline or if global cycling
19720 should be done.
19721 If any function in this hook returns t, not other actions like visibility
19722 cycling will be done.")
19724 (defvar org-tab-after-check-for-cycling-hook nil
19725 "Hook for functions to attach themselves to TAB.
19726 See `org-ctrl-c-ctrl-c-hook' for more information.
19727 This hook runs after it has been established that not table field motion and
19728 not visibility should be done because of current context. This is probably
19729 the place where a package like yasnippets can hook in.")
19731 (defvar org-tab-before-tab-emulation-hook nil
19732 "Hook for functions to attach themselves to TAB.
19733 See `org-ctrl-c-ctrl-c-hook' for more information.
19734 This hook runs after every other options for TAB have been exhausted, but
19735 before indentation and \t insertion takes place.")
19737 (defvar org-metaleft-hook nil
19738 "Hook for functions attaching themselves to `M-left'.
19739 See `org-ctrl-c-ctrl-c-hook' for more information.")
19740 (defvar org-metaright-hook nil
19741 "Hook for functions attaching themselves to `M-right'.
19742 See `org-ctrl-c-ctrl-c-hook' for more information.")
19743 (defvar org-metaup-hook nil
19744 "Hook for functions attaching themselves to `M-up'.
19745 See `org-ctrl-c-ctrl-c-hook' for more information.")
19746 (defvar org-metadown-hook nil
19747 "Hook for functions attaching themselves to `M-down'.
19748 See `org-ctrl-c-ctrl-c-hook' for more information.")
19749 (defvar org-shiftmetaleft-hook nil
19750 "Hook for functions attaching themselves to `M-S-left'.
19751 See `org-ctrl-c-ctrl-c-hook' for more information.")
19752 (defvar org-shiftmetaright-hook nil
19753 "Hook for functions attaching themselves to `M-S-right'.
19754 See `org-ctrl-c-ctrl-c-hook' for more information.")
19755 (defvar org-shiftmetaup-hook nil
19756 "Hook for functions attaching themselves to `M-S-up'.
19757 See `org-ctrl-c-ctrl-c-hook' for more information.")
19758 (defvar org-shiftmetadown-hook nil
19759 "Hook for functions attaching themselves to `M-S-down'.
19760 See `org-ctrl-c-ctrl-c-hook' for more information.")
19761 (defvar org-metareturn-hook nil
19762 "Hook for functions attaching themselves to `M-RET'.
19763 See `org-ctrl-c-ctrl-c-hook' for more information.")
19764 (defvar org-shiftup-hook nil
19765 "Hook for functions attaching themselves to `S-up'.
19766 See `org-ctrl-c-ctrl-c-hook' for more information.")
19767 (defvar org-shiftup-final-hook nil
19768 "Hook for functions attaching themselves to `S-up'.
19769 This one runs after all other options except shift-select have been excluded.
19770 See `org-ctrl-c-ctrl-c-hook' for more information.")
19771 (defvar org-shiftdown-hook nil
19772 "Hook for functions attaching themselves to `S-down'.
19773 See `org-ctrl-c-ctrl-c-hook' for more information.")
19774 (defvar org-shiftdown-final-hook nil
19775 "Hook for functions attaching themselves to `S-down'.
19776 This one runs after all other options except shift-select have been excluded.
19777 See `org-ctrl-c-ctrl-c-hook' for more information.")
19778 (defvar org-shiftleft-hook nil
19779 "Hook for functions attaching themselves to `S-left'.
19780 See `org-ctrl-c-ctrl-c-hook' for more information.")
19781 (defvar org-shiftleft-final-hook nil
19782 "Hook for functions attaching themselves to `S-left'.
19783 This one runs after all other options except shift-select have been excluded.
19784 See `org-ctrl-c-ctrl-c-hook' for more information.")
19785 (defvar org-shiftright-hook nil
19786 "Hook for functions attaching themselves to `S-right'.
19787 See `org-ctrl-c-ctrl-c-hook' for more information.")
19788 (defvar org-shiftright-final-hook nil
19789 "Hook for functions attaching themselves to `S-right'.
19790 This one runs after all other options except shift-select have been excluded.
19791 See `org-ctrl-c-ctrl-c-hook' for more information.")
19793 (defun org-modifier-cursor-error ()
19794 "Throw an error, a modified cursor command was applied in wrong context."
19795 (user-error "This command is active in special context like tables, headlines or items"))
19797 (defun org-shiftselect-error ()
19798 "Throw an error because Shift-Cursor command was applied in wrong context."
19799 (if (and (boundp 'shift-select-mode) shift-select-mode)
19800 (user-error "To use shift-selection with Org-mode, customize `org-support-shift-select'")
19801 (user-error "This command works only in special context like headlines or timestamps")))
19803 (defun org-call-for-shift-select (cmd)
19804 (let ((this-command-keys-shift-translated t))
19805 (call-interactively cmd)))
19807 (defun org-shifttab (&optional arg)
19808 "Global visibility cycling or move to previous table field.
19809 Call `org-table-previous-field' within a table.
19810 When ARG is nil, cycle globally through visibility states.
19811 When ARG is a numeric prefix, show contents of this level."
19812 (interactive "P")
19813 (cond
19814 ((org-at-table-p) (call-interactively 'org-table-previous-field))
19815 ((integerp arg)
19816 (let ((arg2 (if org-odd-levels-only (1- (* 2 arg)) arg)))
19817 (message "Content view to level: %d" arg)
19818 (org-content (prefix-numeric-value arg2))
19819 (org-cycle-show-empty-lines t)
19820 (setq org-cycle-global-status 'overview)))
19821 (t (call-interactively 'org-global-cycle))))
19823 (defun org-shiftmetaleft ()
19824 "Promote subtree or delete table column.
19825 Calls `org-promote-subtree', `org-outdent-item-tree', or
19826 `org-table-delete-column', depending on context. See the
19827 individual commands for more information."
19828 (interactive)
19829 (cond
19830 ((run-hook-with-args-until-success 'org-shiftmetaleft-hook))
19831 ((org-at-table-p) (call-interactively 'org-table-delete-column))
19832 ((org-at-heading-p) (call-interactively 'org-promote-subtree))
19833 ((if (not (org-region-active-p)) (org-at-item-p)
19834 (save-excursion (goto-char (region-beginning))
19835 (org-at-item-p)))
19836 (call-interactively 'org-outdent-item-tree))
19837 (t (org-modifier-cursor-error))))
19839 (defun org-shiftmetaright ()
19840 "Demote subtree or insert table column.
19841 Calls `org-demote-subtree', `org-indent-item-tree', or
19842 `org-table-insert-column', depending on context. See the
19843 individual commands for more information."
19844 (interactive)
19845 (cond
19846 ((run-hook-with-args-until-success 'org-shiftmetaright-hook))
19847 ((org-at-table-p) (call-interactively 'org-table-insert-column))
19848 ((org-at-heading-p) (call-interactively 'org-demote-subtree))
19849 ((if (not (org-region-active-p)) (org-at-item-p)
19850 (save-excursion (goto-char (region-beginning))
19851 (org-at-item-p)))
19852 (call-interactively 'org-indent-item-tree))
19853 (t (org-modifier-cursor-error))))
19855 (defun org-shiftmetaup (&optional arg)
19856 "Move subtree up or kill table row.
19857 Calls `org-move-subtree-up' or `org-table-kill-row' or
19858 `org-move-item-up' or `org-timestamp-up', depending on context.
19859 See the individual commands for more information."
19860 (interactive "P")
19861 (cond
19862 ((run-hook-with-args-until-success 'org-shiftmetaup-hook))
19863 ((org-at-table-p) (call-interactively 'org-table-kill-row))
19864 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19865 ((org-at-item-p) (call-interactively 'org-move-item-up))
19866 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19867 (call-interactively 'org-timestamp-up)))
19868 (t (call-interactively 'org-drag-line-backward))))
19870 (defun org-shiftmetadown (&optional arg)
19871 "Move subtree down or insert table row.
19872 Calls `org-move-subtree-down' or `org-table-insert-row' or
19873 `org-move-item-down' or `org-timestamp-up', depending on context.
19874 See the individual commands for more information."
19875 (interactive "P")
19876 (cond
19877 ((run-hook-with-args-until-success 'org-shiftmetadown-hook))
19878 ((org-at-table-p) (call-interactively 'org-table-insert-row))
19879 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
19880 ((org-at-item-p) (call-interactively 'org-move-item-down))
19881 ((org-at-clock-log-p) (let ((org-clock-adjust-closest t))
19882 (call-interactively 'org-timestamp-down)))
19883 (t (call-interactively 'org-drag-line-forward))))
19885 (defsubst org-hidden-tree-error ()
19886 (user-error
19887 "Hidden subtree, open with TAB or use subtree command M-S-<left>/<right>"))
19889 (defun org-metaleft (&optional arg)
19890 "Promote heading or move table column to left.
19891 Calls `org-do-promote' or `org-table-move-column', depending on context.
19892 With no specific context, calls the Emacs default `backward-word'.
19893 See the individual commands for more information."
19894 (interactive "P")
19895 (cond
19896 ((run-hook-with-args-until-success 'org-metaleft-hook))
19897 ((org-at-table-p) (org-call-with-arg 'org-table-move-column 'left))
19898 ((org-with-limited-levels
19899 (or (org-at-heading-p)
19900 (and (org-region-active-p)
19901 (save-excursion
19902 (goto-char (region-beginning))
19903 (org-at-heading-p)))))
19904 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19905 (call-interactively 'org-do-promote))
19906 ;; At an inline task.
19907 ((org-at-heading-p)
19908 (call-interactively 'org-inlinetask-promote))
19909 ((or (org-at-item-p)
19910 (and (org-region-active-p)
19911 (save-excursion
19912 (goto-char (region-beginning))
19913 (org-at-item-p))))
19914 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19915 (call-interactively 'org-outdent-item))
19916 (t (call-interactively 'backward-word))))
19918 (defun org-metaright (&optional arg)
19919 "Demote a subtree, a list item or move table column to right.
19920 In front of a drawer or a block keyword, indent it correctly.
19921 With no specific context, calls the Emacs default `forward-word'.
19922 See the individual commands for more information."
19923 (interactive "P")
19924 (cond
19925 ((run-hook-with-args-until-success 'org-metaright-hook))
19926 ((org-at-table-p) (call-interactively 'org-table-move-column))
19927 ((org-at-drawer-p) (call-interactively 'org-indent-drawer))
19928 ((org-at-block-p) (call-interactively 'org-indent-block))
19929 ((org-with-limited-levels
19930 (or (org-at-heading-p)
19931 (and (org-region-active-p)
19932 (save-excursion
19933 (goto-char (region-beginning))
19934 (org-at-heading-p)))))
19935 (when (org-check-for-hidden 'headlines) (org-hidden-tree-error))
19936 (call-interactively 'org-do-demote))
19937 ;; At an inline task.
19938 ((org-at-heading-p)
19939 (call-interactively 'org-inlinetask-demote))
19940 ((or (org-at-item-p)
19941 (and (org-region-active-p)
19942 (save-excursion
19943 (goto-char (region-beginning))
19944 (org-at-item-p))))
19945 (when (org-check-for-hidden 'items) (org-hidden-tree-error))
19946 (call-interactively 'org-indent-item))
19947 (t (call-interactively 'forward-word))))
19949 (defun org-check-for-hidden (what)
19950 "Check if there are hidden headlines/items in the current visual line.
19951 WHAT can be either `headlines' or `items'. If the current line is
19952 an outline or item heading and it has a folded subtree below it,
19953 this function returns t, nil otherwise."
19954 (let ((re (cond
19955 ((eq what 'headlines) org-outline-regexp-bol)
19956 ((eq what 'items) (org-item-beginning-re))
19957 (t (error "This should not happen"))))
19958 beg end)
19959 (save-excursion
19960 (catch 'exit
19961 (unless (org-region-active-p)
19962 (setq beg (point-at-bol))
19963 (beginning-of-line 2)
19964 (while (and (not (eobp)) ;; this is like `next-line'
19965 (get-char-property (1- (point)) 'invisible))
19966 (beginning-of-line 2))
19967 (setq end (point))
19968 (goto-char beg)
19969 (goto-char (point-at-eol))
19970 (setq end (max end (point)))
19971 (while (re-search-forward re end t)
19972 (if (get-char-property (match-beginning 0) 'invisible)
19973 (throw 'exit t))))
19974 nil))))
19976 (defun org-metaup (&optional arg)
19977 "Move subtree up or move table row up.
19978 Calls `org-move-subtree-up' or `org-table-move-row' or
19979 `org-move-item-up', depending on context. See the individual commands
19980 for more information."
19981 (interactive "P")
19982 (cond
19983 ((run-hook-with-args-until-success 'org-metaup-hook))
19984 ((org-region-active-p)
19985 (let* ((a (min (region-beginning) (region-end)))
19986 (b (1- (max (region-beginning) (region-end))))
19987 (c (save-excursion (goto-char a)
19988 (move-beginning-of-line 0)))
19989 (d (save-excursion (goto-char a)
19990 (move-end-of-line 0) (point))))
19991 (transpose-regions a b c d)
19992 (goto-char c)))
19993 ((org-at-table-p) (org-call-with-arg 'org-table-move-row 'up))
19994 ((org-at-heading-p) (call-interactively 'org-move-subtree-up))
19995 ((org-at-item-p) (call-interactively 'org-move-item-up))
19996 (t (org-drag-element-backward))))
19998 (defun org-metadown (&optional arg)
19999 "Move subtree down or move table row down.
20000 Calls `org-move-subtree-down' or `org-table-move-row' or
20001 `org-move-item-down', depending on context. See the individual
20002 commands for more information."
20003 (interactive "P")
20004 (cond
20005 ((run-hook-with-args-until-success 'org-metadown-hook))
20006 ((org-region-active-p)
20007 (let* ((a (min (region-beginning) (region-end)))
20008 (b (max (region-beginning) (region-end)))
20009 (c (save-excursion (goto-char b)
20010 (move-beginning-of-line 1)))
20011 (d (save-excursion (goto-char b)
20012 (move-end-of-line 1) (1+ (point)))))
20013 (transpose-regions a b c d)
20014 (goto-char d)))
20015 ((org-at-table-p) (call-interactively 'org-table-move-row))
20016 ((org-at-heading-p) (call-interactively 'org-move-subtree-down))
20017 ((org-at-item-p) (call-interactively 'org-move-item-down))
20018 (t (org-drag-element-forward))))
20020 (defun org-shiftup (&optional arg)
20021 "Increase item in timestamp or increase priority of current headline.
20022 Calls `org-timestamp-up' or `org-priority-up', or `org-previous-item',
20023 depending on context. See the individual commands for more information."
20024 (interactive "P")
20025 (cond
20026 ((run-hook-with-args-until-success 'org-shiftup-hook))
20027 ((and org-support-shift-select (org-region-active-p))
20028 (org-call-for-shift-select 'previous-line))
20029 ((org-at-timestamp-p t)
20030 (call-interactively (if org-edit-timestamp-down-means-later
20031 'org-timestamp-down 'org-timestamp-up)))
20032 ((and (not (eq org-support-shift-select 'always))
20033 org-enable-priority-commands
20034 (org-at-heading-p))
20035 (call-interactively 'org-priority-up))
20036 ((and (not org-support-shift-select) (org-at-item-p))
20037 (call-interactively 'org-previous-item))
20038 ((org-clocktable-try-shift 'up arg))
20039 ((run-hook-with-args-until-success 'org-shiftup-final-hook))
20040 (org-support-shift-select
20041 (org-call-for-shift-select 'previous-line))
20042 (t (org-shiftselect-error))))
20044 (defun org-shiftdown (&optional arg)
20045 "Decrease item in timestamp or decrease priority of current headline.
20046 Calls `org-timestamp-down' or `org-priority-down', or `org-next-item'
20047 depending on context. See the individual commands for more information."
20048 (interactive "P")
20049 (cond
20050 ((run-hook-with-args-until-success 'org-shiftdown-hook))
20051 ((and org-support-shift-select (org-region-active-p))
20052 (org-call-for-shift-select 'next-line))
20053 ((org-at-timestamp-p t)
20054 (call-interactively (if org-edit-timestamp-down-means-later
20055 'org-timestamp-up 'org-timestamp-down)))
20056 ((and (not (eq org-support-shift-select 'always))
20057 org-enable-priority-commands
20058 (org-at-heading-p))
20059 (call-interactively 'org-priority-down))
20060 ((and (not org-support-shift-select) (org-at-item-p))
20061 (call-interactively 'org-next-item))
20062 ((org-clocktable-try-shift 'down arg))
20063 ((run-hook-with-args-until-success 'org-shiftdown-final-hook))
20064 (org-support-shift-select
20065 (org-call-for-shift-select 'next-line))
20066 (t (org-shiftselect-error))))
20068 (defun org-shiftright (&optional arg)
20069 "Cycle the thing at point or in the current line, depending on context.
20070 Depending on context, this does one of the following:
20072 - switch a timestamp at point one day into the future
20073 - on a headline, switch to the next TODO keyword.
20074 - on an item, switch entire list to the next bullet type
20075 - on a property line, switch to the next allowed value
20076 - on a clocktable definition line, move time block into the future"
20077 (interactive "P")
20078 (cond
20079 ((run-hook-with-args-until-success 'org-shiftright-hook))
20080 ((and org-support-shift-select (org-region-active-p))
20081 (org-call-for-shift-select 'forward-char))
20082 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-up-day))
20083 ((and (not (eq org-support-shift-select 'always))
20084 (org-at-heading-p))
20085 (let ((org-inhibit-logging
20086 (not org-treat-S-cursor-todo-selection-as-state-change))
20087 (org-inhibit-blocking
20088 (not org-treat-S-cursor-todo-selection-as-state-change)))
20089 (org-call-with-arg 'org-todo 'right)))
20090 ((or (and org-support-shift-select
20091 (not (eq org-support-shift-select 'always))
20092 (org-at-item-bullet-p))
20093 (and (not org-support-shift-select) (org-at-item-p)))
20094 (org-call-with-arg 'org-cycle-list-bullet nil))
20095 ((and (not (eq org-support-shift-select 'always))
20096 (org-at-property-p))
20097 (call-interactively 'org-property-next-allowed-value))
20098 ((org-clocktable-try-shift 'right arg))
20099 ((run-hook-with-args-until-success 'org-shiftright-final-hook))
20100 (org-support-shift-select
20101 (org-call-for-shift-select 'forward-char))
20102 (t (org-shiftselect-error))))
20104 (defun org-shiftleft (&optional arg)
20105 "Cycle the thing at point or in the current line, depending on context.
20106 Depending on context, this does one of the following:
20108 - switch a timestamp at point one day into the past
20109 - on a headline, switch to the previous TODO keyword.
20110 - on an item, switch entire list to the previous bullet type
20111 - on a property line, switch to the previous allowed value
20112 - on a clocktable definition line, move time block into the past"
20113 (interactive "P")
20114 (cond
20115 ((run-hook-with-args-until-success 'org-shiftleft-hook))
20116 ((and org-support-shift-select (org-region-active-p))
20117 (org-call-for-shift-select 'backward-char))
20118 ((org-at-timestamp-p t) (call-interactively 'org-timestamp-down-day))
20119 ((and (not (eq org-support-shift-select 'always))
20120 (org-at-heading-p))
20121 (let ((org-inhibit-logging
20122 (not org-treat-S-cursor-todo-selection-as-state-change))
20123 (org-inhibit-blocking
20124 (not org-treat-S-cursor-todo-selection-as-state-change)))
20125 (org-call-with-arg 'org-todo 'left)))
20126 ((or (and org-support-shift-select
20127 (not (eq org-support-shift-select 'always))
20128 (org-at-item-bullet-p))
20129 (and (not org-support-shift-select) (org-at-item-p)))
20130 (org-call-with-arg 'org-cycle-list-bullet 'previous))
20131 ((and (not (eq org-support-shift-select 'always))
20132 (org-at-property-p))
20133 (call-interactively 'org-property-previous-allowed-value))
20134 ((org-clocktable-try-shift 'left arg))
20135 ((run-hook-with-args-until-success 'org-shiftleft-final-hook))
20136 (org-support-shift-select
20137 (org-call-for-shift-select 'backward-char))
20138 (t (org-shiftselect-error))))
20140 (defun org-shiftcontrolright ()
20141 "Switch to next TODO set."
20142 (interactive)
20143 (cond
20144 ((and org-support-shift-select (org-region-active-p))
20145 (org-call-for-shift-select 'forward-word))
20146 ((and (not (eq org-support-shift-select 'always))
20147 (org-at-heading-p))
20148 (org-call-with-arg 'org-todo 'nextset))
20149 (org-support-shift-select
20150 (org-call-for-shift-select 'forward-word))
20151 (t (org-shiftselect-error))))
20153 (defun org-shiftcontrolleft ()
20154 "Switch to previous TODO set."
20155 (interactive)
20156 (cond
20157 ((and org-support-shift-select (org-region-active-p))
20158 (org-call-for-shift-select 'backward-word))
20159 ((and (not (eq org-support-shift-select 'always))
20160 (org-at-heading-p))
20161 (org-call-with-arg 'org-todo 'previousset))
20162 (org-support-shift-select
20163 (org-call-for-shift-select 'backward-word))
20164 (t (org-shiftselect-error))))
20166 (defun org-shiftcontrolup (&optional n)
20167 "Change timestamps synchronously up in CLOCK log lines.
20168 Optional argument N tells to change by that many units."
20169 (interactive "P")
20170 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20171 (let (org-support-shift-select)
20172 (org-clock-timestamps-up n))
20173 (user-error "Not at a clock log")))
20175 (defun org-shiftcontroldown (&optional n)
20176 "Change timestamps synchronously down in CLOCK log lines.
20177 Optional argument N tells to change by that many units."
20178 (interactive "P")
20179 (if (and (org-at-clock-log-p) (org-at-timestamp-p t))
20180 (let (org-support-shift-select)
20181 (org-clock-timestamps-down n))
20182 (user-error "Not at a clock log")))
20184 (defun org-ctrl-c-ret ()
20185 "Call `org-table-hline-and-move' or `org-insert-heading' dep. on context."
20186 (interactive)
20187 (cond
20188 ((org-at-table-p) (call-interactively 'org-table-hline-and-move))
20189 (t (call-interactively 'org-insert-heading))))
20191 (defun org-find-visible ()
20192 (let ((s (point)))
20193 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20194 (get-char-property s 'invisible)))
20196 (defun org-find-invisible ()
20197 (let ((s (point)))
20198 (while (and (not (= (point-max) (setq s (next-overlay-change s))))
20199 (not (get-char-property s 'invisible))))
20202 (defun org-copy-visible (beg end)
20203 "Copy the visible parts of the region."
20204 (interactive "r")
20205 (let (snippets s)
20206 (save-excursion
20207 (save-restriction
20208 (narrow-to-region beg end)
20209 (setq s (goto-char (point-min)))
20210 (while (not (= (point) (point-max)))
20211 (goto-char (org-find-invisible))
20212 (push (buffer-substring s (point)) snippets)
20213 (setq s (goto-char (org-find-visible))))))
20214 (kill-new (apply 'concat (nreverse snippets)))))
20216 (defun org-copy-special ()
20217 "Copy region in table or copy current subtree.
20218 Calls `org-table-copy' or `org-copy-subtree', depending on context.
20219 See the individual commands for more information."
20220 (interactive)
20221 (call-interactively
20222 (if (org-at-table-p) 'org-table-copy-region 'org-copy-subtree)))
20224 (defun org-cut-special ()
20225 "Cut region in table or cut current subtree.
20226 Calls `org-table-copy' or `org-cut-subtree', depending on context.
20227 See the individual commands for more information."
20228 (interactive)
20229 (call-interactively
20230 (if (org-at-table-p) 'org-table-cut-region 'org-cut-subtree)))
20232 (defun org-paste-special (arg)
20233 "Paste rectangular region into table, or past subtree relative to level.
20234 Calls `org-table-paste-rectangle' or `org-paste-subtree', depending on context.
20235 See the individual commands for more information."
20236 (interactive "P")
20237 (if (org-at-table-p)
20238 (org-table-paste-rectangle)
20239 (org-paste-subtree arg)))
20241 (defsubst org-in-fixed-width-region-p ()
20242 "Is point in a fixed-width region?"
20243 (save-match-data
20244 (eq 'fixed-width (org-element-type (org-element-at-point)))))
20246 (defun org-edit-special (&optional arg)
20247 "Call a special editor for the element at point.
20248 When at a table, call the formula editor with `org-table-edit-formulas'.
20249 When in a source code block, call `org-edit-src-code'.
20250 When in a fixed-width region, call `org-edit-fixed-width-region'.
20251 When at an #+INCLUDE keyword, visit the included file.
20252 On a link, call `ffap' to visit the link at point.
20253 Otherwise, return a user error."
20254 (interactive "P")
20255 (let ((element (org-element-at-point)))
20256 (assert (not buffer-read-only) nil
20257 "Buffer is read-only: %s" (buffer-name))
20258 (case (org-element-type element)
20259 (src-block
20260 (if (not arg) (org-edit-src-code)
20261 (let* ((info (org-babel-get-src-block-info))
20262 (lang (nth 0 info))
20263 (params (nth 2 info))
20264 (session (cdr (assq :session params))))
20265 (if (not session) (org-edit-src-code)
20266 ;; At a src-block with a session and function called with
20267 ;; an ARG: switch to the buffer related to the inferior
20268 ;; process.
20269 (switch-to-buffer
20270 (funcall (intern (concat "org-babel-prep-session:" lang))
20271 session params))))))
20272 (keyword
20273 (if (member (org-element-property :key element) '("INCLUDE" "SETUPFILE"))
20274 (find-file-other-window
20275 (org-remove-double-quotes
20276 (car (org-split-string (org-element-property :value element)))))
20277 (user-error "No special environment to edit here")))
20278 (table
20279 (if (eq (org-element-property :type element) 'table.el)
20280 (org-edit-src-code)
20281 (call-interactively 'org-table-edit-formulas)))
20282 ;; Only Org tables contain `table-row' type elements.
20283 (table-row (call-interactively 'org-table-edit-formulas))
20284 ((example-block export-block) (org-edit-src-code))
20285 (fixed-width (org-edit-fixed-width-region))
20286 (otherwise
20287 ;; No notable element at point. Though, we may be at a link,
20288 ;; which is an object. Thus, scan deeper.
20289 (if (eq (org-element-type (org-element-context element)) 'link)
20290 (call-interactively 'ffap)
20291 (user-error "No special environment to edit here"))))))
20293 (defvar org-table-coordinate-overlays) ; defined in org-table.el
20294 (defun org-ctrl-c-ctrl-c (&optional arg)
20295 "Set tags in headline, or update according to changed information at point.
20297 This command does many different things, depending on context:
20299 - If a function in `org-ctrl-c-ctrl-c-hook' recognizes this location,
20300 this is what we do.
20302 - If the cursor is on a statistics cookie, update it.
20304 - If the cursor is in a headline, prompt for tags and insert them
20305 into the current line, aligned to `org-tags-column'. When called
20306 with prefix arg, realign all tags in the current buffer.
20308 - If the cursor is in one of the special #+KEYWORD lines, this
20309 triggers scanning the buffer for these lines and updating the
20310 information.
20312 - If the cursor is inside a table, realign the table. This command
20313 works even if the automatic table editor has been turned off.
20315 - If the cursor is on a #+TBLFM line, re-apply the formulas to
20316 the entire table.
20318 - If the cursor is at a footnote reference or definition, jump to
20319 the corresponding definition or references, respectively.
20321 - If the cursor is a the beginning of a dynamic block, update it.
20323 - If the current buffer is a capture buffer, close note and file it.
20325 - If the cursor is on a <<<target>>>, update radio targets and
20326 corresponding links in this buffer.
20328 - If the cursor is on a numbered item in a plain list, renumber the
20329 ordered list.
20331 - If the cursor is on a checkbox, toggle it.
20333 - If the cursor is on a code block, evaluate it. The variable
20334 `org-confirm-babel-evaluate' can be used to control prompting
20335 before code block evaluation, by default every code block
20336 evaluation requires confirmation. Code block evaluation can be
20337 inhibited by setting `org-babel-no-eval-on-ctrl-c-ctrl-c'."
20338 (interactive "P")
20339 (cond
20340 ((or (and (boundp 'org-clock-overlays) org-clock-overlays)
20341 org-occur-highlights
20342 org-latex-fragment-image-overlays)
20343 (and (boundp 'org-clock-overlays) (org-clock-remove-overlays))
20344 (org-remove-occur-highlights)
20345 (org-remove-latex-fragment-image-overlays)
20346 (message "Temporary highlights/overlays removed from current buffer"))
20347 ((and (local-variable-p 'org-finish-function (current-buffer))
20348 (fboundp org-finish-function))
20349 (funcall org-finish-function))
20350 ((run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-hook))
20352 (let* ((context (org-element-context)) (type (org-element-type context)))
20353 ;; Test if point is within a blank line.
20354 (if (save-excursion (beginning-of-line) (looking-at "[ \t]*$"))
20355 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20356 (user-error "C-c C-c can do nothing useful at this location"))
20357 (case type
20358 ;; When at a link, act according to the parent instead.
20359 (link (setq context (org-element-property :parent context))
20360 (setq type (org-element-type context)))
20361 ;; Unsupported object types: check parent element instead.
20362 ((bold code entity export-snippet inline-babel-call inline-src-block
20363 italic latex-fragment line-break macro strike-through subscript
20364 superscript underline verbatim)
20365 (while (and (setq context (org-element-property :parent context))
20366 (not (memq (setq type (org-element-type context))
20367 '(paragraph verse-block table-cell)))))))
20368 ;; For convenience: at the first line of a paragraph on the
20369 ;; same line as an item, apply function on that item instead.
20370 (when (eq type 'paragraph)
20371 (let ((parent (org-element-property :parent context)))
20372 (when (and (eq (org-element-type parent) 'item)
20373 (= (point-at-bol) (org-element-property :begin parent)))
20374 (setq context parent type 'item))))
20375 ;; Act according to type of element or object at point.
20376 (case type
20377 (clock (org-clock-update-time-maybe))
20378 (dynamic-block
20379 (save-excursion
20380 (goto-char (org-element-property :post-affiliated context))
20381 (org-update-dblock)))
20382 (footnote-definition
20383 (goto-char (org-element-property :post-affiliated context))
20384 (call-interactively 'org-footnote-action))
20385 (footnote-reference (call-interactively 'org-footnote-action))
20386 ((headline inlinetask)
20387 (save-excursion (goto-char (org-element-property :begin context))
20388 (call-interactively 'org-set-tags)))
20389 (item
20390 ;; At an item: a double C-u set checkbox to "[-]"
20391 ;; unconditionally, whereas a single one will toggle its
20392 ;; presence. Without an universal argument, if the item
20393 ;; has a checkbox, toggle it. Otherwise repair the list.
20394 (let* ((box (org-element-property :checkbox context))
20395 (struct (org-element-property :structure context))
20396 (old-struct (copy-tree struct))
20397 (parents (org-list-parents-alist struct))
20398 (prevs (org-list-prevs-alist struct))
20399 (orderedp (org-not-nil (org-entry-get nil "ORDERED"))))
20400 (org-list-set-checkbox
20401 (org-element-property :begin context) struct
20402 (cond ((equal arg '(16)) "[-]")
20403 ((and (not box) (equal arg '(4))) "[ ]")
20404 ((or (not box) (equal arg '(4))) nil)
20405 ((eq box 'on) "[ ]")
20406 (t "[X]")))
20407 ;; Mimic `org-list-write-struct' but with grabbing
20408 ;; a return value from `org-list-struct-fix-box'.
20409 (org-list-struct-fix-ind struct parents 2)
20410 (org-list-struct-fix-item-end struct)
20411 (org-list-struct-fix-bul struct prevs)
20412 (org-list-struct-fix-ind struct parents)
20413 (let ((block-item
20414 (org-list-struct-fix-box struct parents prevs orderedp)))
20415 (if (and box (equal struct old-struct))
20416 (if (equal arg '(16))
20417 (message "Checkboxes already reset")
20418 (user-error "Cannot toggle this checkbox: %s"
20419 (if (eq box 'on)
20420 "all subitems checked"
20421 "unchecked subitems")))
20422 (org-list-struct-apply-struct struct old-struct)
20423 (org-update-checkbox-count-maybe))
20424 (when block-item
20425 (message "Checkboxes were removed due to empty box at line %d"
20426 (org-current-line block-item))))))
20427 (keyword
20428 (let ((org-inhibit-startup-visibility-stuff t)
20429 (org-startup-align-all-tables nil))
20430 (when (boundp 'org-table-coordinate-overlays)
20431 (mapc 'delete-overlay org-table-coordinate-overlays)
20432 (setq org-table-coordinate-overlays nil))
20433 (org-save-outline-visibility 'use-markers (org-mode-restart)))
20434 (message "Local setup has been refreshed"))
20435 (plain-list
20436 ;; At a plain list, with a double C-u argument, set
20437 ;; checkboxes of each item to "[-]", whereas a single one
20438 ;; will toggle their presence according to the state of the
20439 ;; first item in the list. Without an argument, repair the
20440 ;; list.
20441 (let* ((begin (org-element-property :contents-begin context))
20442 (beginm (move-marker (make-marker) begin))
20443 (struct (org-element-property :structure context))
20444 (old-struct (copy-tree struct))
20445 (first-box (save-excursion
20446 (goto-char begin)
20447 (looking-at org-list-full-item-re)
20448 (match-string-no-properties 3)))
20449 (new-box (cond ((equal arg '(16)) "[-]")
20450 ((equal arg '(4)) (unless first-box "[ ]"))
20451 ((equal first-box "[X]") "[ ]")
20452 (t "[X]"))))
20453 (cond
20454 (arg
20455 (mapc (lambda (pos) (org-list-set-checkbox pos struct new-box))
20456 (org-list-get-all-items
20457 begin struct (org-list-prevs-alist struct))))
20458 ((and first-box (eq (point) begin))
20459 ;; For convenience, when point is at bol on the first
20460 ;; item of the list and no argument is provided, simply
20461 ;; toggle checkbox of that item, if any.
20462 (org-list-set-checkbox begin struct new-box)))
20463 (org-list-write-struct
20464 struct (org-list-parents-alist struct) old-struct)
20465 (org-update-checkbox-count-maybe)
20466 (save-excursion (goto-char beginm) (org-list-send-list 'maybe))))
20467 ((property-drawer node-property)
20468 (call-interactively 'org-property-action))
20469 ((radio-target target)
20470 (call-interactively 'org-update-radio-target-regexp))
20471 (statistics-cookie
20472 (call-interactively 'org-update-statistics-cookies))
20473 ((table table-cell table-row)
20474 ;; At a table, recalculate every field and align it. Also
20475 ;; send the table if necessary. If the table has
20476 ;; a `table.el' type, just give up. At a table row or
20477 ;; cell, maybe recalculate line but always align table.
20478 (if (eq (org-element-property :type context) 'table.el)
20479 (message "Use C-c ' to edit table.el tables")
20480 (let ((org-enable-table-editor t))
20481 (if (or (eq type 'table)
20482 ;; Check if point is at a TBLFM line.
20483 (and (eq type 'table-row)
20484 (= (point) (org-element-property :end context))))
20485 (save-excursion
20486 (if (org-at-TBLFM-p)
20487 (progn (require 'org-table)
20488 (org-table-calc-current-TBLFM))
20489 (goto-char (org-element-property :contents-begin context))
20490 (org-call-with-arg 'org-table-recalculate (or arg t))
20491 (orgtbl-send-table 'maybe)))
20492 (org-table-maybe-eval-formula)
20493 (cond (arg (call-interactively 'org-table-recalculate))
20494 ((org-table-maybe-recalculate-line))
20495 (t (org-table-align)))))))
20496 (timestamp (org-timestamp-change 0 'day))
20497 (otherwise
20498 (or (run-hook-with-args-until-success 'org-ctrl-c-ctrl-c-final-hook)
20499 (user-error
20500 "C-c C-c can do nothing useful at this location")))))))))
20502 (defun org-mode-restart ()
20503 (interactive)
20504 (let ((indent-status (org-bound-and-true-p org-indent-mode)))
20505 (funcall major-mode)
20506 (hack-local-variables)
20507 (when (and indent-status (not (org-bound-and-true-p org-indent-mode)))
20508 (org-indent-mode -1)))
20509 (message "%s restarted" major-mode))
20511 (defun org-kill-note-or-show-branches ()
20512 "If this is a Note buffer, abort storing the note. Else call `show-branches'."
20513 (interactive)
20514 (if (not org-finish-function)
20515 (progn
20516 (hide-subtree)
20517 (call-interactively 'show-branches))
20518 (let ((org-note-abort t))
20519 (funcall org-finish-function))))
20521 (defun org-open-line (n)
20522 "Insert a new row in tables, call `open-line' elsewhere.
20523 If `org-special-ctrl-o' is nil, just call `open-line' everywhere."
20524 (interactive "*p")
20525 (cond
20526 ((not org-special-ctrl-o)
20527 (open-line n))
20528 ((org-at-table-p)
20529 (org-table-insert-row))
20531 (open-line n))))
20533 (defun org-return (&optional indent)
20534 "Goto next table row or insert a newline.
20535 Calls `org-table-next-row' or `newline', depending on context.
20536 See the individual commands for more information."
20537 (interactive)
20538 (let (org-ts-what)
20539 (cond
20540 ((or (bobp) (org-in-src-block-p))
20541 (if indent (newline-and-indent) (newline)))
20542 ((org-at-table-p)
20543 (org-table-justify-field-maybe)
20544 (call-interactively 'org-table-next-row))
20545 ;; when `newline-and-indent' is called within a list, make sure
20546 ;; text moved stays inside the item.
20547 ((and (org-in-item-p) indent)
20548 (if (and (org-at-item-p) (>= (point) (match-end 0)))
20549 (progn
20550 (save-match-data (newline))
20551 (org-indent-line-to (length (match-string 0))))
20552 (let ((ind (org-get-indentation)))
20553 (newline)
20554 (if (org-looking-back org-list-end-re)
20555 (org-indent-line)
20556 (org-indent-line-to ind)))))
20557 ((and org-return-follows-link
20558 (org-at-timestamp-p t)
20559 (not (eq org-ts-what 'after)))
20560 (org-follow-timestamp-link))
20561 ((and org-return-follows-link
20562 (let ((tprop (get-text-property (point) 'face)))
20563 (or (eq tprop 'org-link)
20564 (and (listp tprop) (memq 'org-link tprop)))))
20565 (call-interactively 'org-open-at-point))
20566 ((and (org-at-heading-p)
20567 (looking-at
20568 (org-re "\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$")))
20569 (org-show-entry)
20570 (end-of-line 1)
20571 (newline))
20572 (t (if indent (newline-and-indent) (newline))))))
20574 (defun org-return-indent ()
20575 "Goto next table row or insert a newline and indent.
20576 Calls `org-table-next-row' or `newline-and-indent', depending on
20577 context. See the individual commands for more information."
20578 (interactive)
20579 (org-return t))
20581 (defun org-ctrl-c-star ()
20582 "Compute table, or change heading status of lines.
20583 Calls `org-table-recalculate' or `org-toggle-heading',
20584 depending on context."
20585 (interactive)
20586 (cond
20587 ((org-at-table-p)
20588 (call-interactively 'org-table-recalculate))
20590 ;; Convert all lines in region to list items
20591 (call-interactively 'org-toggle-heading))))
20593 (defun org-ctrl-c-minus ()
20594 "Insert separator line in table or modify bullet status of line.
20595 Also turns a plain line or a region of lines into list items.
20596 Calls `org-table-insert-hline', `org-toggle-item', or
20597 `org-cycle-list-bullet', depending on context."
20598 (interactive)
20599 (cond
20600 ((org-at-table-p)
20601 (call-interactively 'org-table-insert-hline))
20602 ((org-region-active-p)
20603 (call-interactively 'org-toggle-item))
20604 ((org-in-item-p)
20605 (call-interactively 'org-cycle-list-bullet))
20607 (call-interactively 'org-toggle-item))))
20609 (defun org-toggle-item (arg)
20610 "Convert headings or normal lines to items, items to normal lines.
20611 If there is no active region, only the current line is considered.
20613 If the first non blank line in the region is a headline, convert
20614 all headlines to items, shifting text accordingly.
20616 If it is an item, convert all items to normal lines.
20618 If it is normal text, change region into a list of items.
20619 With a prefix argument ARG, change the region in a single item."
20620 (interactive "P")
20621 (let ((shift-text
20622 (function
20623 ;; Shift text in current section to IND, from point to END.
20624 ;; The function leaves point to END line.
20625 (lambda (ind end)
20626 (let ((min-i 1000) (end (copy-marker end)))
20627 ;; First determine the minimum indentation (MIN-I) of
20628 ;; the text.
20629 (save-excursion
20630 (catch 'exit
20631 (while (< (point) end)
20632 (let ((i (org-get-indentation)))
20633 (cond
20634 ;; Skip blank lines and inline tasks.
20635 ((looking-at "^[ \t]*$"))
20636 ((looking-at org-outline-regexp-bol))
20637 ;; We can't find less than 0 indentation.
20638 ((zerop i) (throw 'exit (setq min-i 0)))
20639 ((< i min-i) (setq min-i i))))
20640 (forward-line))))
20641 ;; Then indent each line so that a line indented to
20642 ;; MIN-I becomes indented to IND. Ignore blank lines
20643 ;; and inline tasks in the process.
20644 (let ((delta (- ind min-i)))
20645 (while (< (point) end)
20646 (unless (or (looking-at "^[ \t]*$")
20647 (looking-at org-outline-regexp-bol))
20648 (org-indent-line-to (+ (org-get-indentation) delta)))
20649 (forward-line)))))))
20650 (skip-blanks
20651 (function
20652 ;; Return beginning of first non-blank line, starting from
20653 ;; line at POS.
20654 (lambda (pos)
20655 (save-excursion
20656 (goto-char pos)
20657 (skip-chars-forward " \r\t\n")
20658 (point-at-bol)))))
20659 beg end)
20660 ;; Determine boundaries of changes.
20661 (if (org-region-active-p)
20662 (setq beg (funcall skip-blanks (region-beginning))
20663 end (copy-marker (region-end)))
20664 (setq beg (funcall skip-blanks (point-at-bol))
20665 end (copy-marker (point-at-eol))))
20666 ;; Depending on the starting line, choose an action on the text
20667 ;; between BEG and END.
20668 (org-with-limited-levels
20669 (save-excursion
20670 (goto-char beg)
20671 (cond
20672 ;; Case 1. Start at an item: de-itemize. Note that it only
20673 ;; happens when a region is active: `org-ctrl-c-minus'
20674 ;; would call `org-cycle-list-bullet' otherwise.
20675 ((org-at-item-p)
20676 (while (< (point) end)
20677 (when (org-at-item-p)
20678 (skip-chars-forward " \t")
20679 (delete-region (point) (match-end 0)))
20680 (forward-line)))
20681 ;; Case 2. Start at an heading: convert to items.
20682 ((org-at-heading-p)
20683 (let* ((bul (org-list-bullet-string "-"))
20684 (bul-len (length bul))
20685 (done (org-entry-is-done-p))
20686 (todo (org-entry-is-todo-p))
20687 ;; Indentation of the first heading. It should be
20688 ;; relative to the indentation of its parent, if any.
20689 (start-ind (save-excursion
20690 (cond
20691 ((not org-adapt-indentation) 0)
20692 ((not (outline-previous-heading)) 0)
20693 (t (length (match-string 0))))))
20694 ;; Level of first heading. Further headings will be
20695 ;; compared to it to determine hierarchy in the list.
20696 (ref-level (org-reduced-level (org-outline-level))))
20697 (when (or done todo) (org-todo ""))
20698 (while (< (point) end)
20699 (let* ((level (org-reduced-level (org-outline-level)))
20700 (delta (max 0 (- level ref-level))))
20701 ;; If current headline is less indented than the first
20702 ;; one, set it as reference, in order to preserve
20703 ;; subtrees.
20704 (when (< level ref-level) (setq ref-level level))
20705 (replace-match bul t t)
20706 (org-indent-line-to (+ start-ind (* delta bul-len)))
20707 (when (or done todo)
20708 (let* ((struct (org-list-struct))
20709 (old (copy-tree struct)))
20710 (org-list-set-checkbox (line-beginning-position)
20711 struct
20712 (if done "[X]" "[ ]"))
20713 (org-list-write-struct struct
20714 (org-list-parents-alist struct)
20715 old)))
20716 ;; Ensure all text down to END (or SECTION-END) belongs
20717 ;; to the newly created item.
20718 (let ((section-end (save-excursion
20719 (or (outline-next-heading) (point)))))
20720 (forward-line)
20721 (funcall shift-text
20722 (+ start-ind (* (1+ delta) bul-len))
20723 (min end section-end)))))))
20724 ;; Case 3. Normal line with ARG: make the first line of region
20725 ;; an item, and shift indentation of others lines to
20726 ;; set them as item's body.
20727 (arg (let* ((bul (org-list-bullet-string "-"))
20728 (bul-len (length bul))
20729 (ref-ind (org-get-indentation)))
20730 (skip-chars-forward " \t")
20731 (insert bul)
20732 (forward-line)
20733 (while (< (point) end)
20734 ;; Ensure that lines less indented than first one
20735 ;; still get included in item body.
20736 (funcall shift-text
20737 (+ ref-ind bul-len)
20738 (min end (save-excursion (or (outline-next-heading)
20739 (point)))))
20740 (forward-line))))
20741 ;; Case 4. Normal line without ARG: turn each non-item line
20742 ;; into an item.
20744 (while (< (point) end)
20745 (unless (or (org-at-heading-p) (org-at-item-p))
20746 (if (looking-at "\\([ \t]*\\)\\(\\S-\\)")
20747 (replace-match
20748 (concat "\\1" (org-list-bullet-string "-") "\\2"))))
20749 (forward-line))))))))
20751 (defun org-toggle-heading (&optional nstars)
20752 "Convert headings to normal text, or items or text to headings.
20753 If there is no active region, only convert the current line.
20755 With a \\[universal-argument] prefix, convert the whole list at
20756 point into heading.
20758 In a region:
20760 - If the first non blank line is a headline, remove the stars
20761 from all headlines in the region.
20763 - If it is a normal line, turn each and every normal line (i.e.,
20764 not an heading or an item) in the region into headings. If you
20765 want to convert only the first line of this region, use one
20766 universal prefix argument.
20768 - If it is a plain list item, turn all plain list items into headings.
20770 When converting a line into a heading, the number of stars is chosen
20771 such that the lines become children of the current entry. However,
20772 when a numeric prefix argument is given, its value determines the
20773 number of stars to add."
20774 (interactive "P")
20775 (let ((skip-blanks
20776 (function
20777 ;; Return beginning of first non-blank line, starting from
20778 ;; line at POS.
20779 (lambda (pos)
20780 (save-excursion
20781 (goto-char pos)
20782 (while (org-at-comment-p) (forward-line))
20783 (skip-chars-forward " \r\t\n")
20784 (point-at-bol)))))
20785 beg end toggled)
20786 ;; Determine boundaries of changes. If a universal prefix has
20787 ;; been given, put the list in a region. If region ends at a bol,
20788 ;; do not consider the last line to be in the region.
20790 (when (and current-prefix-arg (org-at-item-p))
20791 (if (listp current-prefix-arg) (setq current-prefix-arg 1))
20792 (org-mark-element))
20794 (if (org-region-active-p)
20795 (setq beg (funcall skip-blanks (region-beginning))
20796 end (copy-marker (save-excursion
20797 (goto-char (region-end))
20798 (if (bolp) (point) (point-at-eol)))))
20799 (setq beg (funcall skip-blanks (point-at-bol))
20800 end (copy-marker (point-at-eol))))
20801 ;; Ensure inline tasks don't count as headings.
20802 (org-with-limited-levels
20803 (save-excursion
20804 (goto-char beg)
20805 (cond
20806 ;; Case 1. Started at an heading: de-star headings.
20807 ((org-at-heading-p)
20808 (while (< (point) end)
20809 (when (org-at-heading-p t)
20810 (looking-at org-outline-regexp) (replace-match "")
20811 (setq toggled t))
20812 (forward-line)))
20813 ;; Case 2. Started at an item: change items into headlines.
20814 ;; One star will be added by `org-list-to-subtree'.
20815 ((org-at-item-p)
20816 (let* ((stars (make-string
20817 ;; subtract the star that will be added again by
20818 ;; `org-list-to-subtree'
20819 (if (numberp nstars) (1- nstars)
20820 (or (org-current-level) 0))
20821 ?*))
20822 (add-stars
20823 (cond (nstars "") ; stars from prefix only
20824 ((equal stars "") "") ; before first heading
20825 (org-odd-levels-only "*") ; inside heading, odd
20826 (t "")))) ; inside heading, oddeven
20827 (while (< (point) end)
20828 (when (org-at-item-p)
20829 ;; Pay attention to cases when region ends before list.
20830 (let* ((struct (org-list-struct))
20831 (list-end (min (org-list-get-bottom-point struct) (1+ end))))
20832 (save-restriction
20833 (narrow-to-region (point) list-end)
20834 (insert
20835 (org-list-to-subtree
20836 (org-list-parse-list t)
20837 '(:istart (concat stars add-stars (funcall get-stars depth))
20838 :icount (concat stars add-stars (funcall get-stars depth)))))))
20839 (setq toggled t))
20840 (forward-line))))
20841 ;; Case 3. Started at normal text: make every line an heading,
20842 ;; skipping headlines and items.
20843 (t (let* ((stars
20844 (make-string
20845 (if (numberp nstars) nstars (or (org-current-level) 0)) ?*))
20846 (add-stars
20847 (cond (nstars "") ; stars from prefix only
20848 ((equal stars "") "*") ; before first heading
20849 (org-odd-levels-only "**") ; inside heading, odd
20850 (t "*"))) ; inside heading, oddeven
20851 (rpl (concat stars add-stars " "))
20852 (lend (if (listp nstars) (save-excursion (end-of-line) (point)))))
20853 (while (< (point) (if (equal nstars '(4)) lend end))
20854 (when (and (not (or (org-at-heading-p) (org-at-item-p) (org-at-comment-p)))
20855 (looking-at "\\([ \t]*\\)\\(\\S-\\)"))
20856 (replace-match (concat rpl (match-string 2))) (setq toggled t))
20857 (forward-line)))))))
20858 (unless toggled (message "Cannot toggle heading from here"))))
20860 (defun org-meta-return (&optional arg)
20861 "Insert a new heading or wrap a region in a table.
20862 Calls `org-insert-heading' or `org-table-wrap-region', depending
20863 on context. See the individual commands for more information."
20864 (interactive "P")
20865 (org-check-before-invisible-edit 'insert)
20866 (or (run-hook-with-args-until-success 'org-metareturn-hook)
20867 (let* ((element (org-element-at-point))
20868 (type (org-element-type element)))
20869 (when (eq type 'table-row)
20870 (setq element (org-element-property :parent element))
20871 (setq type 'table))
20872 (if (and (eq type 'table)
20873 (eq (org-element-property :type element) 'org)
20874 (>= (point) (org-element-property :contents-begin element))
20875 (< (point) (org-element-property :contents-end element)))
20876 (call-interactively 'org-table-wrap-region)
20877 (call-interactively 'org-insert-heading)))))
20879 ;;; Menu entries
20881 (defsubst org-in-subtree-not-table-p ()
20882 "Are we in a subtree and not in a table?"
20883 (and (not (org-before-first-heading-p))
20884 (not (org-at-table-p))))
20886 ;; Define the Org-mode menus
20887 (easy-menu-define org-tbl-menu org-mode-map "Tbl menu"
20888 '("Tbl"
20889 ["Align" org-ctrl-c-ctrl-c :active (org-at-table-p)]
20890 ["Next Field" org-cycle (org-at-table-p)]
20891 ["Previous Field" org-shifttab (org-at-table-p)]
20892 ["Next Row" org-return (org-at-table-p)]
20893 "--"
20894 ["Blank Field" org-table-blank-field (org-at-table-p)]
20895 ["Edit Field" org-table-edit-field (org-at-table-p)]
20896 ["Copy Field from Above" org-table-copy-down (org-at-table-p)]
20897 "--"
20898 ("Column"
20899 ["Move Column Left" org-metaleft (org-at-table-p)]
20900 ["Move Column Right" org-metaright (org-at-table-p)]
20901 ["Delete Column" org-shiftmetaleft (org-at-table-p)]
20902 ["Insert Column" org-shiftmetaright (org-at-table-p)])
20903 ("Row"
20904 ["Move Row Up" org-metaup (org-at-table-p)]
20905 ["Move Row Down" org-metadown (org-at-table-p)]
20906 ["Delete Row" org-shiftmetaup (org-at-table-p)]
20907 ["Insert Row" org-shiftmetadown (org-at-table-p)]
20908 ["Sort lines in region" org-table-sort-lines (org-at-table-p)]
20909 "--"
20910 ["Insert Hline" org-ctrl-c-minus (org-at-table-p)])
20911 ("Rectangle"
20912 ["Copy Rectangle" org-copy-special (org-at-table-p)]
20913 ["Cut Rectangle" org-cut-special (org-at-table-p)]
20914 ["Paste Rectangle" org-paste-special (org-at-table-p)]
20915 ["Fill Rectangle" org-table-wrap-region (org-at-table-p)])
20916 "--"
20917 ("Calculate"
20918 ["Set Column Formula" org-table-eval-formula (org-at-table-p)]
20919 ["Set Field Formula" (org-table-eval-formula '(4)) :active (org-at-table-p) :keys "C-u C-c ="]
20920 ["Edit Formulas" org-edit-special (org-at-table-p)]
20921 "--"
20922 ["Recalculate line" org-table-recalculate (org-at-table-p)]
20923 ["Recalculate all" (lambda () (interactive) (org-table-recalculate '(4))) :active (org-at-table-p) :keys "C-u C-c *"]
20924 ["Iterate all" (lambda () (interactive) (org-table-recalculate '(16))) :active (org-at-table-p) :keys "C-u C-u C-c *"]
20925 "--"
20926 ["Toggle Recalculate Mark" org-table-rotate-recalc-marks (org-at-table-p)]
20927 "--"
20928 ["Sum Column/Rectangle" org-table-sum
20929 (or (org-at-table-p) (org-region-active-p))]
20930 ["Which Column?" org-table-current-column (org-at-table-p)])
20931 ["Debug Formulas"
20932 org-table-toggle-formula-debugger
20933 :style toggle :selected (org-bound-and-true-p org-table-formula-debug)]
20934 ["Show Col/Row Numbers"
20935 org-table-toggle-coordinate-overlays
20936 :style toggle
20937 :selected (org-bound-and-true-p org-table-overlay-coordinates)]
20938 "--"
20939 ["Create" org-table-create (and (not (org-at-table-p))
20940 org-enable-table-editor)]
20941 ["Convert Region" org-table-convert-region (not (org-at-table-p 'any))]
20942 ["Import from File" org-table-import (not (org-at-table-p))]
20943 ["Export to File" org-table-export (org-at-table-p)]
20944 "--"
20945 ["Create/Convert from/to table.el" org-table-create-with-table.el t]))
20947 (easy-menu-define org-org-menu org-mode-map "Org menu"
20948 '("Org"
20949 ("Show/Hide"
20950 ["Cycle Visibility" org-cycle :active (or (bobp) (outline-on-heading-p))]
20951 ["Cycle Global Visibility" org-shifttab :active (not (org-at-table-p))]
20952 ["Sparse Tree..." org-sparse-tree t]
20953 ["Reveal Context" org-reveal t]
20954 ["Show All" show-all t]
20955 "--"
20956 ["Subtree to indirect buffer" org-tree-to-indirect-buffer t])
20957 "--"
20958 ["New Heading" org-insert-heading t]
20959 ("Navigate Headings"
20960 ["Up" outline-up-heading t]
20961 ["Next" outline-next-visible-heading t]
20962 ["Previous" outline-previous-visible-heading t]
20963 ["Next Same Level" outline-forward-same-level t]
20964 ["Previous Same Level" outline-backward-same-level t]
20965 "--"
20966 ["Jump" org-goto t])
20967 ("Edit Structure"
20968 ["Refile Subtree" org-refile (org-in-subtree-not-table-p)]
20969 "--"
20970 ["Move Subtree Up" org-shiftmetaup (org-in-subtree-not-table-p)]
20971 ["Move Subtree Down" org-shiftmetadown (org-in-subtree-not-table-p)]
20972 "--"
20973 ["Copy Subtree" org-copy-special (org-in-subtree-not-table-p)]
20974 ["Cut Subtree" org-cut-special (org-in-subtree-not-table-p)]
20975 ["Paste Subtree" org-paste-special (not (org-at-table-p))]
20976 "--"
20977 ["Clone subtree, shift time" org-clone-subtree-with-time-shift t]
20978 "--"
20979 ["Copy visible text" org-copy-visible t]
20980 "--"
20981 ["Promote Heading" org-metaleft (org-in-subtree-not-table-p)]
20982 ["Promote Subtree" org-shiftmetaleft (org-in-subtree-not-table-p)]
20983 ["Demote Heading" org-metaright (org-in-subtree-not-table-p)]
20984 ["Demote Subtree" org-shiftmetaright (org-in-subtree-not-table-p)]
20985 "--"
20986 ["Sort Region/Children" org-sort t]
20987 "--"
20988 ["Convert to odd levels" org-convert-to-odd-levels t]
20989 ["Convert to odd/even levels" org-convert-to-oddeven-levels t])
20990 ("Editing"
20991 ["Emphasis..." org-emphasize t]
20992 ["Edit Source Example" org-edit-special t]
20993 "--"
20994 ["Footnote new/jump" org-footnote-action t]
20995 ["Footnote extra" (org-footnote-action t) :active t :keys "C-u C-c C-x f"])
20996 ("Archive"
20997 ["Archive (default method)" org-archive-subtree-default (org-in-subtree-not-table-p)]
20998 "--"
20999 ["Move Subtree to Archive file" org-advertized-archive-subtree (org-in-subtree-not-table-p)]
21000 ["Toggle ARCHIVE tag" org-toggle-archive-tag (org-in-subtree-not-table-p)]
21001 ["Move subtree to Archive sibling" org-archive-to-archive-sibling (org-in-subtree-not-table-p)]
21003 "--"
21004 ("Hyperlinks"
21005 ["Store Link (Global)" org-store-link t]
21006 ["Find existing link to here" org-occur-link-in-agenda-files t]
21007 ["Insert Link" org-insert-link t]
21008 ["Follow Link" org-open-at-point t]
21009 "--"
21010 ["Next link" org-next-link t]
21011 ["Previous link" org-previous-link t]
21012 "--"
21013 ["Descriptive Links"
21014 org-toggle-link-display
21015 :style radio
21016 :selected org-descriptive-links
21018 ["Literal Links"
21019 org-toggle-link-display
21020 :style radio
21021 :selected (not org-descriptive-links)])
21022 "--"
21023 ("TODO Lists"
21024 ["TODO/DONE/-" org-todo t]
21025 ("Select keyword"
21026 ["Next keyword" org-shiftright (org-at-heading-p)]
21027 ["Previous keyword" org-shiftleft (org-at-heading-p)]
21028 ["Complete Keyword" pcomplete (assq :todo-keyword (org-context))]
21029 ["Next keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))]
21030 ["Previous keyword set" org-shiftcontrolright (and (> (length org-todo-sets) 1) (org-at-heading-p))])
21031 ["Show TODO Tree" org-show-todo-tree :active t :keys "C-c / t"]
21032 ["Global TODO list" org-todo-list :active t :keys "C-c a t"]
21033 "--"
21034 ["Enforce dependencies" (customize-variable 'org-enforce-todo-dependencies)
21035 :selected org-enforce-todo-dependencies :style toggle :active t]
21036 "Settings for tree at point"
21037 ["Do Children sequentially" org-toggle-ordered-property :style radio
21038 :selected (org-entry-get nil "ORDERED")
21039 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21040 ["Do Children parallel" org-toggle-ordered-property :style radio
21041 :selected (not (org-entry-get nil "ORDERED"))
21042 :active org-enforce-todo-dependencies :keys "C-c C-x o"]
21043 "--"
21044 ["Set Priority" org-priority t]
21045 ["Priority Up" org-shiftup t]
21046 ["Priority Down" org-shiftdown t]
21047 "--"
21048 ["Get news from all feeds" org-feed-update-all t]
21049 ["Go to the inbox of a feed..." org-feed-goto-inbox t]
21050 ["Customize feeds" (customize-variable 'org-feed-alist) t])
21051 ("TAGS and Properties"
21052 ["Set Tags" org-set-tags-command (not (org-before-first-heading-p))]
21053 ["Change tag in region" org-change-tag-in-region (org-region-active-p)]
21054 "--"
21055 ["Set property" org-set-property (not (org-before-first-heading-p))]
21056 ["Column view of properties" org-columns t]
21057 ["Insert Column View DBlock" org-insert-columns-dblock t])
21058 ("Dates and Scheduling"
21059 ["Timestamp" org-time-stamp (not (org-before-first-heading-p))]
21060 ["Timestamp (inactive)" org-time-stamp-inactive (not (org-before-first-heading-p))]
21061 ("Change Date"
21062 ["1 Day Later" org-shiftright (org-at-timestamp-p)]
21063 ["1 Day Earlier" org-shiftleft (org-at-timestamp-p)]
21064 ["1 ... Later" org-shiftup (org-at-timestamp-p)]
21065 ["1 ... Earlier" org-shiftdown (org-at-timestamp-p)])
21066 ["Compute Time Range" org-evaluate-time-range t]
21067 ["Schedule Item" org-schedule (not (org-before-first-heading-p))]
21068 ["Deadline" org-deadline (not (org-before-first-heading-p))]
21069 "--"
21070 ["Custom time format" org-toggle-time-stamp-overlays
21071 :style radio :selected org-display-custom-times]
21072 "--"
21073 ["Goto Calendar" org-goto-calendar t]
21074 ["Date from Calendar" org-date-from-calendar t]
21075 "--"
21076 ["Start/Restart Timer" org-timer-start t]
21077 ["Pause/Continue Timer" org-timer-pause-or-continue t]
21078 ["Stop Timer" org-timer-pause-or-continue :active t :keys "C-u C-c C-x ,"]
21079 ["Insert Timer String" org-timer t]
21080 ["Insert Timer Item" org-timer-item t])
21081 ("Logging work"
21082 ["Clock in" org-clock-in :active t :keys "C-c C-x C-i"]
21083 ["Switch task" (lambda () (interactive) (org-clock-in '(4))) :active t :keys "C-u C-c C-x C-i"]
21084 ["Clock out" org-clock-out t]
21085 ["Clock cancel" org-clock-cancel t]
21086 "--"
21087 ["Mark as default task" org-clock-mark-default-task t]
21088 ["Clock in, mark as default" (lambda () (interactive) (org-clock-in '(16))) :active t :keys "C-u C-u C-c C-x C-i"]
21089 ["Goto running clock" org-clock-goto t]
21090 "--"
21091 ["Display times" org-clock-display t]
21092 ["Create clock table" org-clock-report t]
21093 "--"
21094 ["Record DONE time"
21095 (progn (setq org-log-done (not org-log-done))
21096 (message "Switching to %s will %s record a timestamp"
21097 (car org-done-keywords)
21098 (if org-log-done "automatically" "not")))
21099 :style toggle :selected org-log-done])
21100 "--"
21101 ["Agenda Command..." org-agenda t]
21102 ["Set Restriction Lock" org-agenda-set-restriction-lock t]
21103 ("File List for Agenda")
21104 ("Special views current file"
21105 ["TODO Tree" org-show-todo-tree t]
21106 ["Check Deadlines" org-check-deadlines t]
21107 ["Timeline" org-timeline t]
21108 ["Tags/Property tree" org-match-sparse-tree t])
21109 "--"
21110 ["Export/Publish..." org-export-dispatch t]
21111 ("LaTeX"
21112 ["Org CDLaTeX mode" org-cdlatex-mode :style toggle
21113 :selected org-cdlatex-mode]
21114 ["Insert Environment" cdlatex-environment (fboundp 'cdlatex-environment)]
21115 ["Insert math symbol" cdlatex-math-symbol (fboundp 'cdlatex-math-symbol)]
21116 ["Modify math symbol" org-cdlatex-math-modify
21117 (org-inside-LaTeX-fragment-p)]
21118 ["Insert citation" org-reftex-citation t]
21119 "--"
21120 ["Template for BEAMER" (org-beamer-insert-options-template) t])
21121 "--"
21122 ("MobileOrg"
21123 ["Push Files and Views" org-mobile-push t]
21124 ["Get Captured and Flagged" org-mobile-pull t]
21125 ["Find FLAGGED Tasks" (org-agenda nil "?") :active t :keys "C-c a ?"]
21126 "--"
21127 ["Setup" (progn (require 'org-mobile) (customize-group 'org-mobile)) t])
21128 "--"
21129 ("Documentation"
21130 ["Show Version" org-version t]
21131 ["Info Documentation" org-info t])
21132 ("Customize"
21133 ["Browse Org Group" org-customize t]
21134 "--"
21135 ["Expand This Menu" org-create-customize-menu
21136 (fboundp 'customize-menu-create)])
21137 ["Send bug report" org-submit-bug-report t]
21138 "--"
21139 ("Refresh/Reload"
21140 ["Refresh setup current buffer" org-mode-restart t]
21141 ["Reload Org (after update)" org-reload t]
21142 ["Reload Org uncompiled" (org-reload t) :active t :keys "C-u C-c C-x !"])
21145 (defun org-info (&optional node)
21146 "Read documentation for Org-mode in the info system.
21147 With optional NODE, go directly to that node."
21148 (interactive)
21149 (info (format "(org)%s" (or node ""))))
21151 ;;;###autoload
21152 (defun org-submit-bug-report ()
21153 "Submit a bug report on Org-mode via mail.
21155 Don't hesitate to report any problems or inaccurate documentation.
21157 If you don't have setup sending mail from (X)Emacs, please copy the
21158 output buffer into your mail program, as it gives us important
21159 information about your Org-mode version and configuration."
21160 (interactive)
21161 (require 'reporter)
21162 (org-load-modules-maybe)
21163 (org-require-autoloaded-modules)
21164 (let ((reporter-prompt-for-summary-p "Bug report subject: "))
21165 (reporter-submit-bug-report
21166 "emacs-orgmode@gnu.org"
21167 (org-version nil 'full)
21168 (let (list)
21169 (save-window-excursion
21170 (org-pop-to-buffer-same-window (get-buffer-create "*Warn about privacy*"))
21171 (delete-other-windows)
21172 (erase-buffer)
21173 (insert "You are about to submit a bug report to the Org-mode mailing list.
21175 We would like to add your full Org-mode and Outline configuration to the
21176 bug report. This greatly simplifies the work of the maintainer and
21177 other experts on the mailing list.
21179 HOWEVER, some variables you have customized may contain private
21180 information. The names of customers, colleagues, or friends, might
21181 appear in the form of file names, tags, todo states, or search strings.
21182 If you answer yes to the prompt, you might want to check and remove
21183 such private information before sending the email.")
21184 (add-text-properties (point-min) (point-max) '(face org-warning))
21185 (when (yes-or-no-p "Include your Org-mode configuration ")
21186 (mapatoms
21187 (lambda (v)
21188 (and (boundp v)
21189 (string-match "\\`\\(org-\\|outline-\\)" (symbol-name v))
21190 (or (and (symbol-value v)
21191 (string-match "\\(-hook\\|-function\\)\\'" (symbol-name v)))
21192 (and
21193 (get v 'custom-type) (get v 'standard-value)
21194 (not (equal (symbol-value v) (eval (car (get v 'standard-value)))))))
21195 (push v list)))))
21196 (kill-buffer (get-buffer "*Warn about privacy*"))
21197 list))
21198 nil nil
21199 "Remember to cover the basics, that is, what you expected to happen and
21200 what in fact did happen. You don't know how to make a good report? See
21202 http://orgmode.org/manual/Feedback.html#Feedback
21204 Your bug report will be posted to the Org-mode mailing list.
21205 ------------------------------------------------------------------------")
21206 (save-excursion
21207 (if (re-search-backward "^\\(Subject: \\)Org-mode version \\(.*?\\);[ \t]*\\(.*\\)" nil t)
21208 (replace-match "\\1Bug: \\3 [\\2]")))))
21211 (defun org-install-agenda-files-menu ()
21212 (let ((bl (buffer-list)))
21213 (save-excursion
21214 (while bl
21215 (set-buffer (pop bl))
21216 (if (derived-mode-p 'org-mode) (setq bl nil)))
21217 (when (derived-mode-p 'org-mode)
21218 (easy-menu-change
21219 '("Org") "File List for Agenda"
21220 (append
21221 (list
21222 ["Edit File List" (org-edit-agenda-file-list) t]
21223 ["Add/Move Current File to Front of List" org-agenda-file-to-front t]
21224 ["Remove Current File from List" org-remove-file t]
21225 ["Cycle through agenda files" org-cycle-agenda-files t]
21226 ["Occur in all agenda files" org-occur-in-agenda-files t]
21227 "--")
21228 (mapcar 'org-file-menu-entry (org-agenda-files t))))))))
21230 ;;;; Documentation
21232 (defun org-require-autoloaded-modules ()
21233 (interactive)
21234 (mapc 'require
21235 '(org-agenda org-archive org-attach org-clock org-colview org-id
21236 org-table org-timer)))
21238 ;;;###autoload
21239 (defun org-reload (&optional uncompiled)
21240 "Reload all org lisp files.
21241 With prefix arg UNCOMPILED, load the uncompiled versions."
21242 (interactive "P")
21243 (require 'loadhist)
21244 (let* ((org-dir (org-find-library-dir "org"))
21245 (contrib-dir (or (org-find-library-dir "org-contribdir") org-dir))
21246 (feature-re "^\\(org\\|ob\\|ox\\)\\(-.*\\)?")
21247 (remove-re (mapconcat 'identity
21248 (mapcar (lambda (f) (concat "^" f "$"))
21249 (list (if (featurep 'xemacs)
21250 "org-colview"
21251 "org-colview-xemacs")
21252 "org" "org-loaddefs" "org-version"))
21253 "\\|"))
21254 (feats (delete-dups
21255 (mapcar 'file-name-sans-extension
21256 (mapcar 'file-name-nondirectory
21257 (delq nil
21258 (mapcar 'feature-file
21259 features))))))
21260 (lfeat (append
21261 (sort
21262 (setq feats
21263 (delq nil (mapcar
21264 (lambda (f)
21265 (if (and (string-match feature-re f)
21266 (not (string-match remove-re f)))
21267 f nil))
21268 feats)))
21269 'string-lessp)
21270 (list "org-version" "org")))
21271 (load-suffixes (when (boundp 'load-suffixes) load-suffixes))
21272 (load-suffixes (if uncompiled (reverse load-suffixes) load-suffixes))
21273 load-uncore load-misses)
21274 (setq load-misses
21275 (delq 't
21276 (mapcar (lambda (f)
21277 (or (org-load-noerror-mustsuffix (concat org-dir f))
21278 (and (string= org-dir contrib-dir)
21279 (org-load-noerror-mustsuffix (concat contrib-dir f)))
21280 (and (org-load-noerror-mustsuffix (concat (org-find-library-dir f) f))
21281 (add-to-list 'load-uncore f 'append)
21284 lfeat)))
21285 (if load-uncore
21286 (message "The following feature%s found in load-path, please check if that's correct:\n%s"
21287 (if (> (length load-uncore) 1) "s were" " was") load-uncore))
21288 (if load-misses
21289 (message "Some error occurred while reloading Org feature%s\n%s\nPlease check *Messages*!\n%s"
21290 (if (> (length load-misses) 1) "s" "") load-misses (org-version nil 'full))
21291 (message "Successfully reloaded Org\n%s" (org-version nil 'full)))))
21293 ;;;###autoload
21294 (defun org-customize ()
21295 "Call the customize function with org as argument."
21296 (interactive)
21297 (org-load-modules-maybe)
21298 (org-require-autoloaded-modules)
21299 (customize-browse 'org))
21301 (defun org-create-customize-menu ()
21302 "Create a full customization menu for Org-mode, insert it into the menu."
21303 (interactive)
21304 (org-load-modules-maybe)
21305 (org-require-autoloaded-modules)
21306 (if (fboundp 'customize-menu-create)
21307 (progn
21308 (easy-menu-change
21309 '("Org") "Customize"
21310 `(["Browse Org group" org-customize t]
21311 "--"
21312 ,(customize-menu-create 'org)
21313 ["Set" Custom-set t]
21314 ["Save" Custom-save t]
21315 ["Reset to Current" Custom-reset-current t]
21316 ["Reset to Saved" Custom-reset-saved t]
21317 ["Reset to Standard Settings" Custom-reset-standard t]))
21318 (message "\"Org\"-menu now contains full customization menu"))
21319 (error "Cannot expand menu (outdated version of cus-edit.el)")))
21321 ;;;; Miscellaneous stuff
21323 ;;; Generally useful functions
21325 (defun org-get-at-bol (property)
21326 "Get text property PROPERTY at beginning of line."
21327 (get-text-property (point-at-bol) property))
21329 (defun org-find-text-property-in-string (prop s)
21330 "Return the first non-nil value of property PROP in string S."
21331 (or (get-text-property 0 prop s)
21332 (get-text-property (or (next-single-property-change 0 prop s) 0)
21333 prop s)))
21335 (defun org-display-warning (message) ;; Copied from Emacs-Muse
21336 "Display the given MESSAGE as a warning."
21337 (if (fboundp 'display-warning)
21338 (display-warning 'org message
21339 (if (featurep 'xemacs) 'warning :warning))
21340 (let ((buf (get-buffer-create "*Org warnings*")))
21341 (with-current-buffer buf
21342 (goto-char (point-max))
21343 (insert "Warning (Org): " message)
21344 (unless (bolp)
21345 (newline)))
21346 (display-buffer buf)
21347 (sit-for 0))))
21349 (defun org-eval (form)
21350 "Eval FORM and return result."
21351 (condition-case error
21352 (eval form)
21353 (error (format "%%![Error: %s]" error))))
21355 (defun org-in-clocktable-p ()
21356 "Check if the cursor is in a clocktable."
21357 (let ((pos (point)) start)
21358 (save-excursion
21359 (end-of-line 1)
21360 (and (re-search-backward "^[ \t]*#\\+BEGIN:[ \t]+clocktable" nil t)
21361 (setq start (match-beginning 0))
21362 (re-search-forward "^[ \t]*#\\+END:.*" nil t)
21363 (>= (match-end 0) pos)
21364 start))))
21366 (defun org-in-commented-line ()
21367 "Is point in a line starting with `#'?"
21368 (equal (char-after (point-at-bol)) ?#))
21370 (defun org-in-indented-comment-line ()
21371 "Is point in a line starting with `#' after some white space?"
21372 (save-excursion
21373 (save-match-data
21374 (goto-char (point-at-bol))
21375 (looking-at "[ \t]*#"))))
21377 (defun org-in-verbatim-emphasis ()
21378 (save-match-data
21379 (and (org-in-regexp org-emph-re 2)
21380 (>= (point) (match-beginning 3))
21381 (<= (point) (match-end 4))
21382 (member (match-string 3) '("=" "~")))))
21384 (defun org-goto-marker-or-bmk (marker &optional bookmark)
21385 "Go to MARKER, widen if necessary. When marker is not live, try BOOKMARK."
21386 (if (and marker (marker-buffer marker)
21387 (buffer-live-p (marker-buffer marker)))
21388 (progn
21389 (org-pop-to-buffer-same-window (marker-buffer marker))
21390 (if (or (> marker (point-max)) (< marker (point-min)))
21391 (widen))
21392 (goto-char marker)
21393 (org-show-context 'org-goto))
21394 (if bookmark
21395 (bookmark-jump bookmark)
21396 (error "Cannot find location"))))
21398 (defun org-quote-csv-field (s)
21399 "Quote field for inclusion in CSV material."
21400 (if (string-match "[\",]" s)
21401 (concat "\"" (mapconcat 'identity (split-string s "\"") "\"\"") "\"")
21404 (defun org-force-self-insert (N)
21405 "Needed to enforce self-insert under remapping."
21406 (interactive "p")
21407 (self-insert-command N))
21409 (defun org-string-width (s)
21410 "Compute width of string, ignoring invisible characters.
21411 This ignores character with invisibility property `org-link', and also
21412 characters with property `org-cwidth', because these will become invisible
21413 upon the next fontification round."
21414 (let (b l)
21415 (when (or (eq t buffer-invisibility-spec)
21416 (assq 'org-link buffer-invisibility-spec))
21417 (while (setq b (text-property-any 0 (length s)
21418 'invisible 'org-link s))
21419 (setq s (concat (substring s 0 b)
21420 (substring s (or (next-single-property-change
21421 b 'invisible s) (length s)))))))
21422 (while (setq b (text-property-any 0 (length s) 'org-cwidth t s))
21423 (setq s (concat (substring s 0 b)
21424 (substring s (or (next-single-property-change
21425 b 'org-cwidth s) (length s))))))
21426 (setq l (string-width s) b -1)
21427 (while (setq b (text-property-any (1+ b) (length s) 'org-dwidth t s))
21428 (setq l (- l (get-text-property b 'org-dwidth-n s))))
21431 (defun org-shorten-string (s maxlength)
21432 "Shorten string S so tht it is no longer than MAXLENGTH characters.
21433 If the string is shorter or has length MAXLENGTH, just return the
21434 original string. If it is longer, the functions finds a space in the
21435 string, breaks this string off at that locations and adds three dots
21436 as ellipsis. Including the ellipsis, the string will not be longer
21437 than MAXLENGTH. If finding a good breaking point in the string does
21438 not work, the string is just chopped off in the middle of a word
21439 if necessary."
21440 (if (<= (length s) maxlength)
21442 (let* ((n (max (- maxlength 4) 1))
21443 (re (concat "\\`\\(.\\{1," (int-to-string n) "\\}[^ ]\\)\\([ ]\\|\\'\\)")))
21444 (if (string-match re s)
21445 (concat (match-string 1 s) "...")
21446 (concat (substring s 0 (max (- maxlength 3) 0)) "...")))))
21448 (defun org-get-indentation (&optional line)
21449 "Get the indentation of the current line, interpreting tabs.
21450 When LINE is given, assume it represents a line and compute its indentation."
21451 (if line
21452 (if (string-match "^ *" (org-remove-tabs line))
21453 (match-end 0))
21454 (save-excursion
21455 (beginning-of-line 1)
21456 (skip-chars-forward " \t")
21457 (current-column))))
21459 (defun org-get-string-indentation (s)
21460 "What indentation has S due to SPACE and TAB at the beginning of the string?"
21461 (let ((n -1) (i 0) (w tab-width) c)
21462 (catch 'exit
21463 (while (< (setq n (1+ n)) (length s))
21464 (setq c (aref s n))
21465 (cond ((= c ?\ ) (setq i (1+ i)))
21466 ((= c ?\t) (setq i (* (/ (+ w i) w) w)))
21467 (t (throw 'exit t)))))
21470 (defun org-remove-tabs (s &optional width)
21471 "Replace tabulators in S with spaces.
21472 Assumes that s is a single line, starting in column 0."
21473 (setq width (or width tab-width))
21474 (while (string-match "\t" s)
21475 (setq s (replace-match
21476 (make-string
21477 (- (* width (/ (+ (match-beginning 0) width) width))
21478 (match-beginning 0)) ?\ )
21479 t t s)))
21482 (defun org-fix-indentation (line ind)
21483 "Fix indentation in LINE.
21484 IND is a cons cell with target and minimum indentation.
21485 If the current indentation in LINE is smaller than the minimum,
21486 leave it alone. If it is larger than ind, set it to the target."
21487 (let* ((l (org-remove-tabs line))
21488 (i (org-get-indentation l))
21489 (i1 (car ind)) (i2 (cdr ind)))
21490 (if (>= i i2) (setq l (substring line i2)))
21491 (if (> i1 0)
21492 (concat (make-string i1 ?\ ) l)
21493 l)))
21495 (defun org-remove-indentation (code &optional n)
21496 "Remove the maximum common indentation from the lines in CODE.
21497 N may optionally be the number of spaces to remove."
21498 (with-temp-buffer
21499 (insert code)
21500 (org-do-remove-indentation n)
21501 (buffer-string)))
21503 (defun org-do-remove-indentation (&optional n)
21504 "Remove the maximum common indentation from the buffer."
21505 (untabify (point-min) (point-max))
21506 (let ((min 10000) re)
21507 (if n
21508 (setq min n)
21509 (goto-char (point-min))
21510 (while (re-search-forward "^ *[^ \n]" nil t)
21511 (setq min (min min (1- (- (match-end 0) (match-beginning 0)))))))
21512 (unless (or (= min 0) (= min 10000))
21513 (setq re (format "^ \\{%d\\}" min))
21514 (goto-char (point-min))
21515 (while (re-search-forward re nil t)
21516 (replace-match "")
21517 (end-of-line 1))
21518 min)))
21520 (defun org-fill-template (template alist)
21521 "Find each %key of ALIST in TEMPLATE and replace it."
21522 (let ((case-fold-search nil)
21523 entry key value)
21524 (setq alist (sort (copy-sequence alist)
21525 (lambda (a b) (< (length (car a)) (length (car b))))))
21526 (while (setq entry (pop alist))
21527 (setq template
21528 (replace-regexp-in-string
21529 (concat "%" (regexp-quote (car entry)))
21530 (or (cdr entry) "") template t t)))
21531 template))
21533 (defun org-base-buffer (buffer)
21534 "Return the base buffer of BUFFER, if it has one. Else return the buffer."
21535 (if (not buffer)
21536 buffer
21537 (or (buffer-base-buffer buffer)
21538 buffer)))
21540 (defun org-trim (s)
21541 "Remove whitespace at beginning and end of string."
21542 (if (string-match "\\`[ \t\n\r]+" s) (setq s (replace-match "" t t s)))
21543 (if (string-match "[ \t\n\r]+\\'" s) (setq s (replace-match "" t t s)))
21546 (defun org-wrap (string &optional width lines)
21547 "Wrap string to either a number of lines, or a width in characters.
21548 If WIDTH is non-nil, the string is wrapped to that width, however many lines
21549 that costs. If there is a word longer than WIDTH, the text is actually
21550 wrapped to the length of that word.
21551 IF WIDTH is nil and LINES is non-nil, the string is forced into at most that
21552 many lines, whatever width that takes.
21553 The return value is a list of lines, without newlines at the end."
21554 (let* ((words (org-split-string string "[ \t\n]+"))
21555 (maxword (apply 'max (mapcar 'org-string-width words)))
21556 w ll)
21557 (cond (width
21558 (org-do-wrap words (max maxword width)))
21559 (lines
21560 (setq w maxword)
21561 (setq ll (org-do-wrap words maxword))
21562 (if (<= (length ll) lines)
21564 (setq ll words)
21565 (while (> (length ll) lines)
21566 (setq w (1+ w))
21567 (setq ll (org-do-wrap words w)))
21568 ll))
21569 (t (error "Cannot wrap this")))))
21571 (defun org-do-wrap (words width)
21572 "Create lines of maximum width WIDTH (in characters) from word list WORDS."
21573 (let (lines line)
21574 (while words
21575 (setq line (pop words))
21576 (while (and words (< (+ (length line) (length (car words))) width))
21577 (setq line (concat line " " (pop words))))
21578 (setq lines (push line lines)))
21579 (nreverse lines)))
21581 (defun org-split-string (string &optional separators)
21582 "Splits STRING into substrings at SEPARATORS.
21583 No empty strings are returned if there are matches at the beginning
21584 and end of string."
21585 (let ((rexp (or separators "[ \f\t\n\r\v]+"))
21586 (start 0)
21587 notfirst
21588 (list nil))
21589 (while (and (string-match rexp string
21590 (if (and notfirst
21591 (= start (match-beginning 0))
21592 (< start (length string)))
21593 (1+ start) start))
21594 (< (match-beginning 0) (length string)))
21595 (setq notfirst t)
21596 (or (eq (match-beginning 0) 0)
21597 (and (eq (match-beginning 0) (match-end 0))
21598 (eq (match-beginning 0) start))
21599 (setq list
21600 (cons (substring string start (match-beginning 0))
21601 list)))
21602 (setq start (match-end 0)))
21603 (or (eq start (length string))
21604 (setq list
21605 (cons (substring string start)
21606 list)))
21607 (nreverse list)))
21609 (defun org-quote-vert (s)
21610 "Replace \"|\" with \"\\vert\"."
21611 (while (string-match "|" s)
21612 (setq s (replace-match "\\vert" t t s)))
21615 (defun org-uuidgen-p (s)
21616 "Is S an ID created by UUIDGEN?"
21617 (string-match "\\`[0-9a-f]\\{8\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{4\\}-[0-9a-f]\\{12\\}\\'" (downcase s)))
21619 (defun org-in-src-block-p (&optional inside)
21620 "Whether point is in a code source block.
21621 When INSIDE is non-nil, don't consider we are within a src block
21622 when point is at #+BEGIN_SRC or #+END_SRC."
21623 (let ((case-fold-search t) ov)
21624 (or (and (setq ov (overlays-at (point)))
21625 (memq 'org-block-background
21626 (overlay-properties (car ov))))
21627 (and (not inside)
21628 (save-match-data
21629 (save-excursion
21630 (beginning-of-line)
21631 (looking-at ".*#\\+\\(begin\\|end\\)_src")))))))
21633 (defun org-context ()
21634 "Return a list of contexts of the current cursor position.
21635 If several contexts apply, all are returned.
21636 Each context entry is a list with a symbol naming the context, and
21637 two positions indicating start and end of the context. Possible
21638 contexts are:
21640 :headline anywhere in a headline
21641 :headline-stars on the leading stars in a headline
21642 :todo-keyword on a TODO keyword (including DONE) in a headline
21643 :tags on the TAGS in a headline
21644 :priority on the priority cookie in a headline
21645 :item on the first line of a plain list item
21646 :item-bullet on the bullet/number of a plain list item
21647 :checkbox on the checkbox in a plain list item
21648 :table in an org-mode table
21649 :table-special on a special filed in a table
21650 :table-table in a table.el table
21651 :clocktable in a clocktable
21652 :src-block in a source block
21653 :link on a hyperlink
21654 :keyword on a keyword: SCHEDULED, DEADLINE, CLOSE, COMMENT.
21655 :target on a <<target>>
21656 :radio-target on a <<<radio-target>>>
21657 :latex-fragment on a LaTeX fragment
21658 :latex-preview on a LaTeX fragment with overlaid preview image
21660 This function expects the position to be visible because it uses font-lock
21661 faces as a help to recognize the following contexts: :table-special, :link,
21662 and :keyword."
21663 (let* ((f (get-text-property (point) 'face))
21664 (faces (if (listp f) f (list f)))
21665 (case-fold-search t)
21666 (p (point)) clist o)
21667 ;; First the large context
21668 (cond
21669 ((org-at-heading-p t)
21670 (push (list :headline (point-at-bol) (point-at-eol)) clist)
21671 (when (progn
21672 (beginning-of-line 1)
21673 (looking-at org-todo-line-tags-regexp))
21674 (push (org-point-in-group p 1 :headline-stars) clist)
21675 (push (org-point-in-group p 2 :todo-keyword) clist)
21676 (push (org-point-in-group p 4 :tags) clist))
21677 (goto-char p)
21678 (skip-chars-backward "^[\n\r \t") (or (bobp) (backward-char 1))
21679 (if (looking-at "\\[#[A-Z0-9]\\]")
21680 (push (org-point-in-group p 0 :priority) clist)))
21682 ((org-at-item-p)
21683 (push (org-point-in-group p 2 :item-bullet) clist)
21684 (push (list :item (point-at-bol)
21685 (save-excursion (org-end-of-item) (point)))
21686 clist)
21687 (and (org-at-item-checkbox-p)
21688 (push (org-point-in-group p 0 :checkbox) clist)))
21690 ((org-at-table-p)
21691 (push (list :table (org-table-begin) (org-table-end)) clist)
21692 (if (memq 'org-formula faces)
21693 (push (list :table-special
21694 (previous-single-property-change p 'face)
21695 (next-single-property-change p 'face)) clist)))
21696 ((org-at-table-p 'any)
21697 (push (list :table-table) clist)))
21698 (goto-char p)
21700 (let ((case-fold-search t))
21701 ;; New the "medium" contexts: clocktables, source blocks
21702 (cond ((org-in-clocktable-p)
21703 (push (list :clocktable
21704 (and (or (looking-at "#\\+BEGIN: clocktable")
21705 (search-backward "#+BEGIN: clocktable" nil t))
21706 (match-beginning 0))
21707 (and (re-search-forward "#\\+END:?" nil t)
21708 (match-end 0))) clist))
21709 ((org-in-src-block-p)
21710 (push (list :src-block
21711 (and (or (looking-at "#\\+BEGIN_SRC")
21712 (search-backward "#+BEGIN_SRC" nil t))
21713 (match-beginning 0))
21714 (and (search-forward "#+END_SRC" nil t)
21715 (match-beginning 0))) clist))))
21716 (goto-char p)
21718 ;; Now the small context
21719 (cond
21720 ((org-at-timestamp-p)
21721 (push (org-point-in-group p 0 :timestamp) clist))
21722 ((memq 'org-link faces)
21723 (push (list :link
21724 (previous-single-property-change p 'face)
21725 (next-single-property-change p 'face)) clist))
21726 ((memq 'org-special-keyword faces)
21727 (push (list :keyword
21728 (previous-single-property-change p 'face)
21729 (next-single-property-change p 'face)) clist))
21730 ((org-at-target-p)
21731 (push (org-point-in-group p 0 :target) clist)
21732 (goto-char (1- (match-beginning 0)))
21733 (if (looking-at org-radio-target-regexp)
21734 (push (org-point-in-group p 0 :radio-target) clist))
21735 (goto-char p))
21736 ((setq o (car (delq nil
21737 (mapcar
21738 (lambda (x)
21739 (if (memq x org-latex-fragment-image-overlays) x))
21740 (overlays-at (point))))))
21741 (push (list :latex-fragment
21742 (overlay-start o) (overlay-end o)) clist)
21743 (push (list :latex-preview
21744 (overlay-start o) (overlay-end o)) clist))
21745 ((org-inside-LaTeX-fragment-p)
21746 ;; FIXME: positions wrong.
21747 (push (list :latex-fragment (point) (point)) clist)))
21749 (setq clist (nreverse (delq nil clist)))
21750 clist))
21752 ;; FIXME: Compare with at-regexp-p Do we need both?
21753 (defun org-in-regexp (re &optional nlines visually)
21754 "Check if point is inside a match of regexp.
21755 Normally only the current line is checked, but you can include NLINES extra
21756 lines both before and after point into the search.
21757 If VISUALLY is set, require that the cursor is not after the match but
21758 really on, so that the block visually is on the match."
21759 (catch 'exit
21760 (let ((pos (point))
21761 (eol (point-at-eol (+ 1 (or nlines 0))))
21762 (inc (if visually 1 0)))
21763 (save-excursion
21764 (beginning-of-line (- 1 (or nlines 0)))
21765 (while (re-search-forward re eol t)
21766 (if (and (<= (match-beginning 0) pos)
21767 (>= (+ inc (match-end 0)) pos))
21768 (throw 'exit (cons (match-beginning 0) (match-end 0)))))))))
21770 (defun org-at-regexp-p (regexp)
21771 "Is point inside a match of REGEXP in the current line?"
21772 (catch 'exit
21773 (save-excursion
21774 (let ((pos (point)) (end (point-at-eol)))
21775 (beginning-of-line 1)
21776 (while (re-search-forward regexp end t)
21777 (if (and (<= (match-beginning 0) pos)
21778 (>= (match-end 0) pos))
21779 (throw 'exit t)))
21780 nil))))
21782 (defun org-between-regexps-p (start-re end-re &optional lim-up lim-down)
21783 "Non-nil when point is between matches of START-RE and END-RE.
21785 Also return a non-nil value when point is on one of the matches.
21787 Optional arguments LIM-UP and LIM-DOWN bound the search; they are
21788 buffer positions. Default values are the positions of headlines
21789 surrounding the point.
21791 The functions returns a cons cell whose car (resp. cdr) is the
21792 position before START-RE (resp. after END-RE)."
21793 (save-match-data
21794 (let ((pos (point))
21795 (limit-up (or lim-up (save-excursion (outline-previous-heading))))
21796 (limit-down (or lim-down (save-excursion (outline-next-heading))))
21797 beg end)
21798 (save-excursion
21799 ;; Point is on a block when on START-RE or if START-RE can be
21800 ;; found before it...
21801 (and (or (org-at-regexp-p start-re)
21802 (re-search-backward start-re limit-up t))
21803 (setq beg (match-beginning 0))
21804 ;; ... and END-RE after it...
21805 (goto-char (match-end 0))
21806 (re-search-forward end-re limit-down t)
21807 (> (setq end (match-end 0)) pos)
21808 ;; ... without another START-RE in-between.
21809 (goto-char (match-beginning 0))
21810 (not (re-search-backward start-re (1+ beg) t))
21811 ;; Return value.
21812 (cons beg end))))))
21814 (defun org-in-block-p (names)
21815 "Non-nil when point belongs to a block whose name belongs to NAMES.
21817 NAMES is a list of strings containing names of blocks.
21819 Return first block name matched, or nil. Beware that in case of
21820 nested blocks, the returned name may not belong to the closest
21821 block from point."
21822 (save-match-data
21823 (catch 'exit
21824 (let ((case-fold-search t)
21825 (lim-up (save-excursion (outline-previous-heading)))
21826 (lim-down (save-excursion (outline-next-heading))))
21827 (mapc (lambda (name)
21828 (let ((n (regexp-quote name)))
21829 (when (org-between-regexps-p
21830 (concat "^[ \t]*#\\+begin_" n)
21831 (concat "^[ \t]*#\\+end_" n)
21832 lim-up lim-down)
21833 (throw 'exit n))))
21834 names))
21835 nil)))
21837 (defun org-in-drawer-p ()
21838 "Non-nil if point is within a drawer.
21839 If point is within a drawer, return it, as parsed data."
21840 (let ((element (save-match-data (org-element-at-point))))
21841 (while (and element (not (memq (org-element-type element)
21842 '(drawer property-drawer))))
21843 (setq element (org-element-property :parent element)))
21844 element))
21846 (defun org-occur-in-agenda-files (regexp &optional nlines)
21847 "Call `multi-occur' with buffers for all agenda files."
21848 (interactive "sOrg-files matching: \np")
21849 (let* ((files (org-agenda-files))
21850 (tnames (mapcar 'file-truename files))
21851 (extra org-agenda-text-search-extra-files)
21853 (when (eq (car extra) 'agenda-archives)
21854 (setq extra (cdr extra))
21855 (setq files (org-add-archive-files files)))
21856 (while (setq f (pop extra))
21857 (unless (member (file-truename f) tnames)
21858 (add-to-list 'files f 'append)
21859 (add-to-list 'tnames (file-truename f) 'append)))
21860 (multi-occur
21861 (mapcar (lambda (x)
21862 (with-current-buffer
21863 (or (get-file-buffer x) (find-file-noselect x))
21864 (widen)
21865 (current-buffer)))
21866 files)
21867 regexp)))
21869 (if (boundp 'occur-mode-find-occurrence-hook)
21870 ;; Emacs 23
21871 (add-hook 'occur-mode-find-occurrence-hook
21872 (lambda ()
21873 (when (derived-mode-p 'org-mode)
21874 (org-reveal))))
21875 ;; Emacs 22
21876 (defadvice occur-mode-goto-occurrence
21877 (after org-occur-reveal activate)
21878 (and (derived-mode-p 'org-mode) (org-reveal)))
21879 (defadvice occur-mode-goto-occurrence-other-window
21880 (after org-occur-reveal activate)
21881 (and (derived-mode-p 'org-mode) (org-reveal)))
21882 (defadvice occur-mode-display-occurrence
21883 (after org-occur-reveal activate)
21884 (when (derived-mode-p 'org-mode)
21885 (let ((pos (occur-mode-find-occurrence)))
21886 (with-current-buffer (marker-buffer pos)
21887 (save-excursion
21888 (goto-char pos)
21889 (org-reveal)))))))
21891 (defun org-occur-link-in-agenda-files ()
21892 "Create a link and search for it in the agendas.
21893 The link is not stored in `org-stored-links', it is just created
21894 for the search purpose."
21895 (interactive)
21896 (let ((link (condition-case nil
21897 (org-store-link nil)
21898 (error "Unable to create a link to here"))))
21899 (org-occur-in-agenda-files (regexp-quote link))))
21901 (defun org-reverse-string (string)
21902 "Return the reverse of STRING."
21903 (apply 'string (reverse (string-to-list string))))
21905 (defun org-uniquify-alist (alist)
21906 "Merge elements of ALIST with the same key.
21908 For example, in this alist:
21910 \(org-uniquify-alist '((a 1) (b 2) (a 3)))
21911 => '((a 1 3) (b 2))
21913 merge (a 1) and (a 3) into (a 1 3).
21915 The function returns the new ALIST."
21916 (let (rtn)
21917 (mapc
21918 (lambda (e)
21919 (let (n)
21920 (if (not (assoc (car e) rtn))
21921 (push e rtn)
21922 (setq n (cons (car e) (append (cdr (assoc (car e) rtn)) (cdr e))))
21923 (setq rtn (assq-delete-all (car e) rtn))
21924 (push n rtn))))
21925 alist)
21926 rtn))
21928 (defun org-delete-all (elts list)
21929 "Remove all elements in ELTS from LIST."
21930 (while elts
21931 (setq list (delete (pop elts) list)))
21932 list)
21934 (defun org-count (cl-item cl-seq)
21935 "Count the number of occurrences of ITEM in SEQ.
21936 Taken from `count' in cl-seq.el with all keyword arguments removed."
21937 (let ((cl-end (length cl-seq)) (cl-start 0) (cl-count 0) cl-x)
21938 (when (consp cl-seq) (setq cl-seq (nthcdr cl-start cl-seq)))
21939 (while (< cl-start cl-end)
21940 (setq cl-x (if (consp cl-seq) (pop cl-seq) (aref cl-seq cl-start)))
21941 (if (equal cl-item cl-x) (setq cl-count (1+ cl-count)))
21942 (setq cl-start (1+ cl-start)))
21943 cl-count))
21945 (defun org-remove-if (predicate seq)
21946 "Remove everything from SEQ that fulfills PREDICATE."
21947 (let (res e)
21948 (while seq
21949 (setq e (pop seq))
21950 (if (not (funcall predicate e)) (push e res)))
21951 (nreverse res)))
21953 (defun org-remove-if-not (predicate seq)
21954 "Remove everything from SEQ that does not fulfill PREDICATE."
21955 (let (res e)
21956 (while seq
21957 (setq e (pop seq))
21958 (if (funcall predicate e) (push e res)))
21959 (nreverse res)))
21961 (defun org-reduce (cl-func cl-seq &rest cl-keys)
21962 "Reduce two-argument FUNCTION across SEQ.
21963 Taken from `reduce' in cl-seq.el with all keyword arguments but
21964 \":initial-value\" removed."
21965 (let ((cl-accum (cond ((memq :initial-value cl-keys)
21966 (cadr (memq :initial-value cl-keys)))
21967 (cl-seq (pop cl-seq))
21968 (t (funcall cl-func)))))
21969 (while cl-seq
21970 (setq cl-accum (funcall cl-func cl-accum (pop cl-seq))))
21971 cl-accum))
21973 (defun org-every (pred seq)
21974 "Return true if PREDICATE is true of every element of SEQ.
21975 Adapted from `every' in cl.el."
21976 (catch 'org-every
21977 (mapc (lambda (e) (unless (funcall pred e) (throw 'org-every nil))) seq)
21980 (defun org-some (pred seq)
21981 "Return true if PREDICATE is true of any element of SEQ.
21982 Adapted from `some' in cl.el."
21983 (catch 'org-some
21984 (mapc (lambda (e) (when (funcall pred e) (throw 'org-some t))) seq)
21985 nil))
21987 (defun org-back-over-empty-lines ()
21988 "Move backwards over whitespace, to the beginning of the first empty line.
21989 Returns the number of empty lines passed."
21990 (let ((pos (point)))
21991 (if (cdr (assoc 'heading org-blank-before-new-entry))
21992 (skip-chars-backward " \t\n\r")
21993 (unless (eobp)
21994 (forward-line -1)))
21995 (beginning-of-line 2)
21996 (goto-char (min (point) pos))
21997 (count-lines (point) pos)))
21999 (defun org-skip-whitespace ()
22000 (skip-chars-forward " \t\n\r"))
22002 (defun org-point-in-group (point group &optional context)
22003 "Check if POINT is in match-group GROUP.
22004 If CONTEXT is non-nil, return a list with CONTEXT and the boundaries of the
22005 match. If the match group does not exist or point is not inside it,
22006 return nil."
22007 (and (match-beginning group)
22008 (>= point (match-beginning group))
22009 (<= point (match-end group))
22010 (if context
22011 (list context (match-beginning group) (match-end group))
22012 t)))
22014 (defun org-switch-to-buffer-other-window (&rest args)
22015 "Switch to buffer in a second window on the current frame.
22016 In particular, do not allow pop-up frames.
22017 Returns the newly created buffer."
22018 (org-no-popups
22019 (apply 'switch-to-buffer-other-window args)))
22021 (defun org-combine-plists (&rest plists)
22022 "Create a single property list from all plists in PLISTS.
22023 The process starts by copying the first list, and then setting properties
22024 from the other lists. Settings in the last list are the most significant
22025 ones and overrule settings in the other lists."
22026 (let ((rtn (copy-sequence (pop plists)))
22027 p v ls)
22028 (while plists
22029 (setq ls (pop plists))
22030 (while ls
22031 (setq p (pop ls) v (pop ls))
22032 (setq rtn (plist-put rtn p v))))
22033 rtn))
22035 (defun org-replace-escapes (string table)
22036 "Replace %-escapes in STRING with values in TABLE.
22037 TABLE is an association list with keys like \"%a\" and string values.
22038 The sequences in STRING may contain normal field width and padding information,
22039 for example \"%-5s\". Replacements happen in the sequence given by TABLE,
22040 so values can contain further %-escapes if they are define later in TABLE."
22041 (let ((tbl (copy-alist table))
22042 (case-fold-search nil)
22043 (pchg 0)
22044 e re rpl)
22045 (while (setq e (pop tbl))
22046 (setq re (concat "%-?[0-9.]*" (substring (car e) 1)))
22047 (when (and (cdr e) (string-match re (cdr e)))
22048 (let ((sref (substring (cdr e) (match-beginning 0) (match-end 0)))
22049 (safe "SREF"))
22050 (add-text-properties 0 3 (list 'sref sref) safe)
22051 (setcdr e (replace-match safe t t (cdr e)))))
22052 (while (string-match re string)
22053 (setq rpl (format (concat (substring (match-string 0 string) 0 -1) "s")
22054 (cdr e)))
22055 (setq string (replace-match rpl t t string))))
22056 (while (setq pchg (next-property-change pchg string))
22057 (let ((sref (get-text-property pchg 'sref string)))
22058 (when (and sref (string-match "SREF" string pchg))
22059 (setq string (replace-match sref t t string)))))
22060 string))
22062 (defun org-sublist (list start end)
22063 "Return a section of LIST, from START to END.
22064 Counting starts at 1."
22065 (let (rtn (c start))
22066 (setq list (nthcdr (1- start) list))
22067 (while (and list (<= c end))
22068 (push (pop list) rtn)
22069 (setq c (1+ c)))
22070 (nreverse rtn)))
22072 (defun org-find-base-buffer-visiting (file)
22073 "Like `find-buffer-visiting' but always return the base buffer and
22074 not an indirect buffer."
22075 (let ((buf (or (get-file-buffer file)
22076 (find-buffer-visiting file))))
22077 (if buf
22078 (or (buffer-base-buffer buf) buf)
22079 nil)))
22081 (defun org-image-file-name-regexp (&optional extensions)
22082 "Return regexp matching the file names of images.
22083 If EXTENSIONS is given, only match these."
22084 (if (and (not extensions) (fboundp 'image-file-name-regexp))
22085 (image-file-name-regexp)
22086 (let ((image-file-name-extensions
22087 (or extensions
22088 '("png" "jpeg" "jpg" "gif" "tiff" "tif"
22089 "xbm" "xpm" "pbm" "pgm" "ppm"))))
22090 (concat "\\."
22091 (regexp-opt (nconc (mapcar 'upcase
22092 image-file-name-extensions)
22093 image-file-name-extensions)
22095 "\\'"))))
22097 (defun org-file-image-p (file &optional extensions)
22098 "Return non-nil if FILE is an image."
22099 (save-match-data
22100 (string-match (org-image-file-name-regexp extensions) file)))
22102 (defun org-get-cursor-date (&optional with-time)
22103 "Return the date at cursor in as a time.
22104 This works in the calendar and in the agenda, anywhere else it just
22105 returns the current time.
22106 If WITH-TIME is non-nil, returns the time of the event at point (in
22107 the agenda) or the current time of the day."
22108 (let (date day defd tp tm hod mod)
22109 (when with-time
22110 (setq tp (get-text-property (point) 'time))
22111 (when (and tp (string-match "\\([0-9][0-9]\\):\\([0-9][0-9]\\)" tp))
22112 (setq hod (string-to-number (match-string 1 tp))
22113 mod (string-to-number (match-string 2 tp))))
22114 (or tp (setq hod (nth 2 (decode-time (current-time)))
22115 mod (nth 1 (decode-time (current-time))))))
22116 (cond
22117 ((eq major-mode 'calendar-mode)
22118 (setq date (calendar-cursor-to-date)
22119 defd (encode-time 0 (or mod 0) (or hod 0)
22120 (nth 1 date) (nth 0 date) (nth 2 date))))
22121 ((eq major-mode 'org-agenda-mode)
22122 (setq day (get-text-property (point) 'day))
22123 (if day
22124 (setq date (calendar-gregorian-from-absolute day)
22125 defd (encode-time 0 (or mod 0) (or hod 0)
22126 (nth 1 date) (nth 0 date) (nth 2 date))))))
22127 (or defd (current-time))))
22129 (defun org-mark-subtree (&optional up)
22130 "Mark the current subtree.
22131 This puts point at the start of the current subtree, and mark at
22132 the end. If a numeric prefix UP is given, move up into the
22133 hierarchy of headlines by UP levels before marking the subtree."
22134 (interactive "P")
22135 (org-with-limited-levels
22136 (cond ((org-at-heading-p) (beginning-of-line))
22137 ((org-before-first-heading-p) (user-error "Not in a subtree"))
22138 (t (outline-previous-visible-heading 1))))
22139 (when up (while (and (> up 0) (org-up-heading-safe)) (decf up)))
22140 (if (org-called-interactively-p 'any)
22141 (call-interactively 'org-mark-element)
22142 (org-mark-element)))
22145 ;;; Indentation
22147 (defun org-indent-line ()
22148 "Indent line depending on context."
22149 (interactive)
22150 (let* ((pos (point))
22151 (itemp (org-at-item-p))
22152 (case-fold-search t)
22153 (org-drawer-regexp (or org-drawer-regexp "\000"))
22154 (inline-task-p (and (featurep 'org-inlinetask)
22155 (org-inlinetask-in-task-p)))
22156 (inline-re (and inline-task-p
22157 (org-inlinetask-outline-regexp)))
22158 column)
22159 (if (and orgstruct-is-++ (eq pos (point)))
22160 (let ((indent-line-function (cadadr (assoc 'indent-line-function org-fb-vars))))
22161 (indent-according-to-mode))
22162 (beginning-of-line 1)
22163 (cond
22164 ;; Headings
22165 ((looking-at org-outline-regexp) (setq column 0))
22166 ;; Footnote definition
22167 ((looking-at org-footnote-definition-re) (setq column 0))
22168 ;; Literal examples
22169 ((looking-at "[ \t]*:\\( \\|$\\)")
22170 (setq column (org-get-indentation))) ; do nothing
22171 ;; Lists
22172 ((ignore-errors (goto-char (org-in-item-p)))
22173 (setq column (if itemp
22174 (org-get-indentation)
22175 (org-list-item-body-column (point))))
22176 (goto-char pos))
22177 ;; Drawers
22178 ((and (looking-at "[ \t]*:END:")
22179 (save-excursion (re-search-backward org-drawer-regexp nil t)))
22180 (save-excursion
22181 (goto-char (1- (match-beginning 1)))
22182 (setq column (current-column))))
22183 ;; Special blocks
22184 ((and (looking-at "[ \t]*#\\+end_\\([a-z]+\\)")
22185 (save-excursion
22186 (re-search-backward
22187 (concat "^[ \t]*#\\+begin_" (downcase (match-string 1))) nil t)))
22188 (setq column (org-get-indentation (match-string 0))))
22189 ((and (not (looking-at "[ \t]*#\\+begin_"))
22190 (org-between-regexps-p "^[ \t]*#\\+begin_" "[ \t]*#\\+end_"))
22191 (save-excursion
22192 (re-search-backward "^[ \t]*#\\+begin_\\([a-z]+\\)" nil t))
22193 (setq column
22194 (cond ((equal (downcase (match-string 1)) "src")
22195 ;; src blocks: let `org-edit-src-exit' handle them
22196 (org-get-indentation))
22197 ((equal (downcase (match-string 1)) "example")
22198 (max (org-get-indentation)
22199 (org-get-indentation (match-string 0))))
22201 (org-get-indentation (match-string 0))))))
22202 ;; This line has nothing special, look at the previous relevant
22203 ;; line to compute indentation
22205 (beginning-of-line 0)
22206 (while (and (not (bobp))
22207 (not (looking-at org-table-line-regexp))
22208 (not (looking-at org-drawer-regexp))
22209 ;; When point started in an inline task, do not move
22210 ;; above task starting line.
22211 (not (and inline-task-p (looking-at inline-re)))
22212 ;; Skip drawers, blocks, empty lines, verbatim,
22213 ;; comments, tables, footnotes definitions, lists,
22214 ;; inline tasks.
22215 (or (and (looking-at "[ \t]*:END:")
22216 (re-search-backward org-drawer-regexp nil t))
22217 (and (looking-at "[ \t]*#\\+end_")
22218 (re-search-backward "[ \t]*#\\+begin_"nil t))
22219 (looking-at "[ \t]*[\n:#|]")
22220 (looking-at org-footnote-definition-re)
22221 (and (not inline-task-p)
22222 (featurep 'org-inlinetask)
22223 (org-inlinetask-in-task-p)
22224 (or (org-inlinetask-goto-beginning) t))))
22225 (beginning-of-line 0))
22226 (cond
22227 ;; There was a list item above.
22228 ((ignore-errors (goto-char (org-in-item-p)))
22229 (goto-char (org-list-get-top-point (org-list-struct)))
22230 (setq column (org-get-indentation)))
22231 ;; There was an heading above.
22232 ((looking-at "\\*+[ \t]+")
22233 (if (not org-adapt-indentation)
22234 (setq column 0)
22235 (goto-char (match-end 0))
22236 (setq column (current-column))))
22237 ;; A drawer had started and is unfinished
22238 ((looking-at org-drawer-regexp)
22239 (goto-char (1- (match-beginning 1)))
22240 (setq column (current-column)))
22241 ;; Else, nothing noticeable found: get indentation and go on.
22242 (t (setq column (org-get-indentation))))))
22243 ;; Now apply indentation and move cursor accordingly
22244 (goto-char pos)
22245 (if (<= (current-column) (current-indentation))
22246 (org-indent-line-to column)
22247 (save-excursion (org-indent-line-to column)))
22248 ;; Special polishing for properties, see `org-property-format'
22249 (setq column (current-column))
22250 (beginning-of-line 1)
22251 (if (looking-at org-property-re)
22252 (replace-match (concat (match-string 4)
22253 (format org-property-format
22254 (match-string 1) (match-string 3)))
22255 t t))
22256 (org-move-to-column column))))
22258 (defun org-indent-drawer ()
22259 "Indent the drawer at point."
22260 (interactive)
22261 (let ((p (point))
22262 (e (and (save-excursion (re-search-forward ":END:" nil t))
22263 (match-end 0)))
22264 (folded
22265 (save-excursion
22266 (end-of-line)
22267 (when (overlays-at (point))
22268 (member 'invisible (overlay-properties
22269 (car (overlays-at (point)))))))))
22270 (when folded (org-cycle))
22271 (indent-for-tab-command)
22272 (while (and (move-beginning-of-line 2) (< (point) e))
22273 (indent-for-tab-command))
22274 (goto-char p)
22275 (when folded (org-cycle)))
22276 (message "Drawer at point indented"))
22278 (defun org-indent-block ()
22279 "Indent the block at point."
22280 (interactive)
22281 (let ((p (point))
22282 (case-fold-search t)
22283 (e (and (save-excursion (re-search-forward "#\\+end_?\\(?:[a-z]+\\)?" nil t))
22284 (match-end 0)))
22285 (folded
22286 (save-excursion
22287 (end-of-line)
22288 (when (overlays-at (point))
22289 (member 'invisible (overlay-properties
22290 (car (overlays-at (point)))))))))
22291 (when folded (org-cycle))
22292 (indent-for-tab-command)
22293 (while (and (move-beginning-of-line 2) (< (point) e))
22294 (indent-for-tab-command))
22295 (goto-char p)
22296 (when folded (org-cycle)))
22297 (message "Block at point indented"))
22299 (defun org-indent-region (start end)
22300 "Indent region."
22301 (interactive "r")
22302 (save-excursion
22303 (let ((line-end (org-current-line end)))
22304 (goto-char start)
22305 (while (< (org-current-line) line-end)
22306 (cond ((org-in-src-block-p t) (org-src-native-tab-command-maybe))
22307 (t (call-interactively 'org-indent-line)))
22308 (move-beginning-of-line 2)))))
22311 ;;; Filling
22313 ;; We use our own fill-paragraph and auto-fill functions.
22315 ;; `org-fill-paragraph' relies on adaptive filling and context
22316 ;; checking. Appropriate `fill-prefix' is computed with
22317 ;; `org-adaptive-fill-function'.
22319 ;; `org-auto-fill-function' takes care of auto-filling. It calls
22320 ;; `do-auto-fill' only on valid areas with `fill-prefix' shadowed with
22321 ;; `org-adaptive-fill-function' value. Internally,
22322 ;; `org-comment-line-break-function' breaks the line.
22324 ;; `org-setup-filling' installs filling and auto-filling related
22325 ;; variables during `org-mode' initialization.
22327 (defvar org-element-paragraph-separate) ; org-element.el
22328 (defun org-setup-filling ()
22329 (require 'org-element)
22330 ;; Prevent auto-fill from inserting unwanted new items.
22331 (when (boundp 'fill-nobreak-predicate)
22332 (org-set-local
22333 'fill-nobreak-predicate
22334 (org-uniquify
22335 (append fill-nobreak-predicate
22336 '(org-fill-line-break-nobreak-p
22337 org-fill-paragraph-with-timestamp-nobreak-p)))))
22338 (let ((paragraph-ending (substring org-element-paragraph-separate 1)))
22339 (org-set-local 'paragraph-start paragraph-ending)
22340 (org-set-local 'paragraph-separate paragraph-ending))
22341 (org-set-local 'fill-paragraph-function 'org-fill-paragraph)
22342 (org-set-local 'auto-fill-inhibit-regexp nil)
22343 (org-set-local 'adaptive-fill-function 'org-adaptive-fill-function)
22344 (org-set-local 'normal-auto-fill-function 'org-auto-fill-function)
22345 (org-set-local 'comment-line-break-function 'org-comment-line-break-function))
22347 (defun org-fill-line-break-nobreak-p ()
22348 "Non-nil when a new line at point would create an Org line break."
22349 (save-excursion
22350 (skip-chars-backward "[ \t]")
22351 (skip-chars-backward "\\\\")
22352 (looking-at "\\\\\\\\\\($\\|[^\\\\]\\)")))
22354 (defun org-fill-paragraph-with-timestamp-nobreak-p ()
22355 "Non-nil when a new line at point would split a timestamp."
22356 (and (org-at-timestamp-p t)
22357 (not (looking-at org-ts-regexp-both))))
22359 (declare-function message-in-body-p "message" ())
22360 (defvar orgtbl-line-start-regexp) ; From org-table.el
22361 (defun org-adaptive-fill-function ()
22362 "Compute a fill prefix for the current line.
22363 Return fill prefix, as a string, or nil if current line isn't
22364 meant to be filled. For convenience, if `adaptive-fill-regexp'
22365 matches in paragraphs or comments, use it."
22366 (catch 'exit
22367 (when (derived-mode-p 'message-mode)
22368 (save-excursion
22369 (beginning-of-line)
22370 (cond ((or (not (message-in-body-p))
22371 (looking-at orgtbl-line-start-regexp))
22372 (throw 'exit nil))
22373 ((looking-at message-cite-prefix-regexp)
22374 (throw 'exit (match-string-no-properties 0)))
22375 ((looking-at org-outline-regexp)
22376 (throw 'exit (make-string (length (match-string 0)) ? ))))))
22377 (org-with-wide-buffer
22378 (let* ((p (line-beginning-position))
22379 (element (save-excursion
22380 (beginning-of-line)
22381 (or (ignore-errors (org-element-at-point))
22382 (user-error "An element cannot be parsed line %d"
22383 (line-number-at-pos (point))))))
22384 (type (org-element-type element))
22385 (post-affiliated (org-element-property :post-affiliated element)))
22386 (unless (and post-affiliated (< p post-affiliated))
22387 (case type
22388 (comment
22389 (save-excursion
22390 (beginning-of-line)
22391 (looking-at "[ \t]*")
22392 (concat (match-string 0) "# ")))
22393 (footnote-definition "")
22394 ((item plain-list)
22395 (make-string (org-list-item-body-column
22396 (or post-affiliated
22397 (org-element-property :begin element)))
22398 ? ))
22399 (paragraph
22400 ;; Fill prefix is usually the same as the current line,
22401 ;; unless the paragraph is at the beginning of an item.
22402 (let ((parent (org-element-property :parent element)))
22403 (save-excursion
22404 (beginning-of-line)
22405 (cond ((eq (org-element-type parent) 'item)
22406 (make-string (org-list-item-body-column
22407 (org-element-property :begin parent))
22408 ? ))
22409 ((and adaptive-fill-regexp
22410 ;; Locally disable
22411 ;; `adaptive-fill-function' to let
22412 ;; `fill-context-prefix' handle
22413 ;; `adaptive-fill-regexp' variable.
22414 (let (adaptive-fill-function)
22415 (fill-context-prefix
22416 post-affiliated
22417 (org-element-property :end element)))))
22418 ((looking-at "[ \t]+") (match-string 0))
22419 (t "")))))
22420 (comment-block
22421 ;; Only fill contents if P is within block boundaries.
22422 (let* ((cbeg (save-excursion (goto-char post-affiliated)
22423 (forward-line)
22424 (point)))
22425 (cend (save-excursion
22426 (goto-char (org-element-property :end element))
22427 (skip-chars-backward " \r\t\n")
22428 (line-beginning-position))))
22429 (when (and (>= p cbeg) (< p cend))
22430 (if (save-excursion (beginning-of-line) (looking-at "[ \t]+"))
22431 (match-string 0)
22432 ""))))))))))
22434 (declare-function message-goto-body "message" ())
22435 (defvar message-cite-prefix-regexp) ; From message.el
22436 (defun org-fill-paragraph (&optional justify)
22437 "Fill element at point, when applicable.
22439 This function only applies to comment blocks, comments, example
22440 blocks and paragraphs. Also, as a special case, re-align table
22441 when point is at one.
22443 If JUSTIFY is non-nil (interactively, with prefix argument),
22444 justify as well. If `sentence-end-double-space' is non-nil, then
22445 period followed by one space does not end a sentence, so don't
22446 break a line there. The variable `fill-column' controls the
22447 width for filling.
22449 For convenience, when point is at a plain list, an item or
22450 a footnote definition, try to fill the first paragraph within."
22451 (interactive)
22452 (if (and (derived-mode-p 'message-mode)
22453 (or (not (message-in-body-p))
22454 (save-excursion (move-beginning-of-line 1)
22455 (looking-at message-cite-prefix-regexp))))
22456 ;; First ensure filling is correct in message-mode.
22457 (let ((fill-paragraph-function
22458 (cadadr (assoc 'fill-paragraph-function org-fb-vars)))
22459 (fill-prefix (cadadr (assoc 'fill-prefix org-fb-vars)))
22460 (paragraph-start (cadadr (assoc 'paragraph-start org-fb-vars)))
22461 (paragraph-separate
22462 (cadadr (assoc 'paragraph-separate org-fb-vars))))
22463 (fill-paragraph nil))
22464 (with-syntax-table org-mode-transpose-word-syntax-table
22465 ;; Move to end of line in order to get the first paragraph
22466 ;; within a plain list or a footnote definition.
22467 (let ((element (save-excursion
22468 (end-of-line)
22469 (or (ignore-errors (org-element-at-point))
22470 (user-error "An element cannot be parsed line %d"
22471 (line-number-at-pos (point)))))))
22472 ;; First check if point is in a blank line at the beginning of
22473 ;; the buffer. In that case, ignore filling.
22474 (case (org-element-type element)
22475 ;; Use major mode filling function is src blocks.
22476 (src-block (org-babel-do-key-sequence-in-edit-buffer (kbd "M-q")))
22477 ;; Align Org tables, leave table.el tables as-is.
22478 (table-row (org-table-align) t)
22479 (table
22480 (when (eq (org-element-property :type element) 'org)
22481 (save-excursion
22482 (goto-char (org-element-property :post-affiliated element))
22483 (org-table-align)))
22485 (paragraph
22486 ;; Paragraphs may contain `line-break' type objects.
22487 (let ((beg (max (point-min)
22488 (org-element-property :contents-begin element)))
22489 (end (min (point-max)
22490 (org-element-property :contents-end element))))
22491 ;; Do nothing if point is at an affiliated keyword.
22492 (if (< (line-end-position) beg) t
22493 (when (derived-mode-p 'message-mode)
22494 ;; In `message-mode', do not fill following citation
22495 ;; in current paragraph nor text before message body.
22496 (let ((body-start (save-excursion (message-goto-body))))
22497 (when body-start (setq beg (max body-start beg))))
22498 (when (save-excursion
22499 (re-search-forward
22500 (concat "^" message-cite-prefix-regexp) end t))
22501 (setq end (match-beginning 0))))
22502 ;; Fill paragraph, taking line breaks into account.
22503 ;; For that, slice the paragraph using line breaks as
22504 ;; separators, and fill the parts in reverse order to
22505 ;; avoid messing with markers.
22506 (save-excursion
22507 (goto-char end)
22508 (mapc
22509 (lambda (pos)
22510 (fill-region-as-paragraph pos (point) justify)
22511 (goto-char pos))
22512 ;; Find the list of ending positions for line breaks
22513 ;; in the current paragraph. Add paragraph
22514 ;; beginning to include first slice.
22515 (nreverse
22516 (cons beg
22517 (org-element-map
22518 (org-element--parse-objects
22519 beg end nil (org-element-restriction 'paragraph))
22520 'line-break
22521 (lambda (lb) (org-element-property :end lb)))))))
22522 t)))
22523 ;; Contents of `comment-block' type elements should be
22524 ;; filled as plain text, but only if point is within block
22525 ;; markers.
22526 (comment-block
22527 (let* ((case-fold-search t)
22528 (beg (save-excursion
22529 (goto-char (org-element-property :begin element))
22530 (re-search-forward "^[ \t]*#\\+begin_comment" nil t)
22531 (forward-line)
22532 (point)))
22533 (end (save-excursion
22534 (goto-char (org-element-property :end element))
22535 (re-search-backward "^[ \t]*#\\+end_comment" nil t)
22536 (line-beginning-position))))
22537 (if (or (< (point) beg) (> (point) end)) t
22538 (fill-region-as-paragraph
22539 (save-excursion (end-of-line)
22540 (re-search-backward "^[ \t]*$" beg 'move)
22541 (line-beginning-position))
22542 (save-excursion (beginning-of-line)
22543 (re-search-forward "^[ \t]*$" end 'move)
22544 (line-beginning-position))
22545 justify))))
22546 ;; Fill comments.
22547 (comment
22548 (let ((begin (org-element-property :post-affiliated element))
22549 (end (org-element-property :end element)))
22550 (when (and (>= (point) begin) (<= (point) end))
22551 (let ((begin (save-excursion
22552 (end-of-line)
22553 (if (re-search-backward "^[ \t]*#[ \t]*$" begin t)
22554 (progn (forward-line) (point))
22555 begin)))
22556 (end (save-excursion
22557 (end-of-line)
22558 (if (re-search-forward "^[ \t]*#[ \t]*$" end 'move)
22559 (1- (line-beginning-position))
22560 (skip-chars-backward " \r\t\n")
22561 (line-end-position)))))
22562 ;; Do not fill comments when at a blank line.
22563 (when (> end begin)
22564 (let ((fill-prefix
22565 (save-excursion
22566 (beginning-of-line)
22567 (looking-at "[ \t]*#")
22568 (let ((comment-prefix (match-string 0)))
22569 (goto-char (match-end 0))
22570 (if (looking-at adaptive-fill-regexp)
22571 (concat comment-prefix (match-string 0))
22572 (concat comment-prefix " "))))))
22573 (save-excursion
22574 (fill-region-as-paragraph begin end justify))))))
22576 ;; Ignore every other element.
22577 (otherwise t))))))
22579 (defun org-auto-fill-function ()
22580 "Auto-fill function."
22581 ;; Check if auto-filling is meaningful.
22582 (let ((fc (current-fill-column)))
22583 (when (and fc (> (current-column) fc))
22584 (let* ((fill-prefix (org-adaptive-fill-function))
22585 ;; Enforce empty fill prefix, if required. Otherwise, it
22586 ;; will be computed again.
22587 (adaptive-fill-mode (not (equal fill-prefix ""))))
22588 (when fill-prefix (do-auto-fill))))))
22590 (defun org-comment-line-break-function (&optional soft)
22591 "Break line at point and indent, continuing comment if within one.
22592 The inserted newline is marked hard if variable
22593 `use-hard-newlines' is true, unless optional argument SOFT is
22594 non-nil."
22595 (if soft (insert-and-inherit ?\n) (newline 1))
22596 (save-excursion (forward-char -1) (delete-horizontal-space))
22597 (delete-horizontal-space)
22598 (indent-to-left-margin)
22599 (insert-before-markers-and-inherit fill-prefix))
22602 ;;; Fixed Width Areas
22604 (defun org-toggle-fixed-width ()
22605 "Toggle fixed-width markup.
22607 Add or remove fixed-width markup on current line, whenever it
22608 makes sense. Return an error otherwise.
22610 If a region is active and if it contains only fixed-width areas
22611 or blank lines, remove all fixed-width markup in it. If the
22612 region contains anything else, convert all non-fixed-width lines
22613 to fixed-width ones.
22615 Blank lines at the end of the region are ignored unless the
22616 region only contains such lines."
22617 (interactive)
22618 (if (not (org-region-active-p))
22619 ;; No region:
22621 ;; Remove fixed width marker only in a fixed-with element.
22623 ;; Add fixed width maker in paragraphs, in blank lines after
22624 ;; elements or at the beginning of a headline or an inlinetask,
22625 ;; and before any one-line elements (e.g., a clock).
22626 (progn
22627 (beginning-of-line)
22628 (let* ((element (org-element-at-point))
22629 (type (org-element-type element)))
22630 (cond
22631 ((and (eq type 'fixed-width)
22632 (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)"))
22633 (replace-match
22634 "" nil nil nil (if (= (line-end-position) (match-end 0)) 0 1)))
22635 ((and (memq type '(babel-call clock comment diary-sexp headline
22636 horizontal-rule keyword paragraph
22637 planning))
22638 (or (not (org-element-property :post-affiliated element))
22639 (<= (org-element-property :post-affiliated element)
22640 (point))))
22641 (skip-chars-forward " \t")
22642 (insert ": "))
22643 ((and (org-looking-at-p "[ \t]*$")
22644 (or (eq type 'inlinetask)
22645 (save-excursion
22646 (skip-chars-forward " \r\t\n")
22647 (<= (org-element-property :end element) (point)))))
22648 (delete-region (point) (line-end-position))
22649 (org-indent-line)
22650 (insert ": "))
22651 (t (user-error "Cannot insert a fixed-width line here")))))
22652 ;; Region active.
22653 (let* ((begin (save-excursion
22654 (goto-char (region-beginning))
22655 (line-beginning-position)))
22656 (end (copy-marker
22657 (save-excursion
22658 (goto-char (region-end))
22659 (unless (eolp) (beginning-of-line))
22660 (if (save-excursion (re-search-backward "\\S-" begin t))
22661 (progn (skip-chars-backward " \r\t\n") (point))
22662 (point)))))
22663 (all-fixed-width-p
22664 (catch 'not-all-p
22665 (save-excursion
22666 (goto-char begin)
22667 (skip-chars-forward " \r\t\n")
22668 (when (eobp) (throw 'not-all-p nil))
22669 (while (< (point) end)
22670 (let ((element (org-element-at-point)))
22671 (if (eq (org-element-type element) 'fixed-width)
22672 (goto-char (org-element-property :end element))
22673 (throw 'not-all-p nil))))
22674 t))))
22675 (if all-fixed-width-p
22676 (save-excursion
22677 (goto-char begin)
22678 (while (< (point) end)
22679 (when (looking-at "[ \t]*\\(:\\(?: \\|$\\)\\)")
22680 (replace-match
22681 "" nil nil nil
22682 (if (= (line-end-position) (match-end 0)) 0 1)))
22683 (forward-line)))
22684 (let ((min-ind (point-max)))
22685 ;; Find minimum indentation across all lines.
22686 (save-excursion
22687 (goto-char begin)
22688 (if (not (save-excursion (re-search-forward "\\S-" end t)))
22689 (setq min-ind 0)
22690 (catch 'zerop
22691 (while (< (point) end)
22692 (unless (org-looking-at-p "[ \t]*$")
22693 (let ((ind (org-get-indentation)))
22694 (setq min-ind (min min-ind ind))
22695 (when (zerop ind) (throw 'zerop t))))
22696 (forward-line)))))
22697 ;; Loop over all lines and add fixed-width markup everywhere
22698 ;; but in fixed-width lines.
22699 (save-excursion
22700 (goto-char begin)
22701 (while (< (point) end)
22702 (cond
22703 ((org-at-heading-p)
22704 (insert ": ")
22705 (forward-line)
22706 (while (and (< (point) end) (org-looking-at-p "[ \t]*$"))
22707 (insert ":")
22708 (forward-line)))
22709 ((org-looking-at-p "[ \t]*:\\( \\|$\\)")
22710 (let* ((element (org-element-at-point))
22711 (element-end (org-element-property :end element)))
22712 (if (eq (org-element-type element) 'fixed-width)
22713 (progn (goto-char element-end)
22714 (skip-chars-backward " \r\t\n")
22715 (forward-line))
22716 (let ((limit (min end element-end)))
22717 (while (< (point) limit)
22718 (org-move-to-column min-ind t)
22719 (insert ": ")
22720 (forward-line))))))
22722 (org-move-to-column min-ind t)
22723 (insert ": ")
22724 (forward-line)))))))
22725 (set-marker end nil))))
22728 ;;; Comments
22730 ;; Org comments syntax is quite complex. It requires the entire line
22731 ;; to be just a comment. Also, even with the right syntax at the
22732 ;; beginning of line, some some elements (i.e. verse-block or
22733 ;; example-block) don't accept comments. Usual Emacs comment commands
22734 ;; cannot cope with those requirements. Therefore, Org replaces them.
22736 ;; Org still relies on `comment-dwim', but cannot trust
22737 ;; `comment-only-p'. So, `comment-region-function' and
22738 ;; `uncomment-region-function' both point
22739 ;; to`org-comment-or-uncomment-region'. Eventually,
22740 ;; `org-insert-comment' takes care of insertion of comments at the
22741 ;; beginning of line.
22743 ;; `org-setup-comments-handling' install comments related variables
22744 ;; during `org-mode' initialization.
22746 (defun org-setup-comments-handling ()
22747 (interactive)
22748 (org-set-local 'comment-use-syntax nil)
22749 (org-set-local 'comment-start "# ")
22750 (org-set-local 'comment-start-skip "^\\s-*#\\(?: \\|$\\)")
22751 (org-set-local 'comment-insert-comment-function 'org-insert-comment)
22752 (org-set-local 'comment-region-function 'org-comment-or-uncomment-region)
22753 (org-set-local 'uncomment-region-function 'org-comment-or-uncomment-region))
22755 (defun org-insert-comment ()
22756 "Insert an empty comment above current line.
22757 If the line is empty, insert comment at its beginning. When
22758 point is within a source block, comment according to the related
22759 major mode."
22760 (if (let ((element (org-element-at-point)))
22761 (and (eq (org-element-type element) 'src-block)
22762 (< (save-excursion
22763 (goto-char (org-element-property :post-affiliated element))
22764 (line-end-position))
22765 (point))
22766 (> (save-excursion
22767 (goto-char (org-element-property :end element))
22768 (skip-chars-backward " \r\t\n")
22769 (line-beginning-position))
22770 (point))))
22771 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22772 (beginning-of-line)
22773 (if (looking-at "\\s-*$") (delete-region (point) (point-at-eol))
22774 (open-line 1))
22775 (org-indent-line)
22776 (insert "# ")))
22778 (defvar comment-empty-lines) ; From newcomment.el.
22779 (defun org-comment-or-uncomment-region (beg end &rest ignore)
22780 "Comment or uncomment each non-blank line in the region.
22781 Uncomment each non-blank line between BEG and END if it only
22782 contains commented lines. Otherwise, comment them. If region is
22783 strictly within a source block, use appropriate comment syntax."
22784 (if (let ((element (org-element-at-point)))
22785 (and (eq (org-element-type element) 'src-block)
22786 (< (save-excursion
22787 (goto-char (org-element-property :post-affiliated element))
22788 (line-end-position))
22789 beg)
22790 (>= (save-excursion
22791 (goto-char (org-element-property :end element))
22792 (skip-chars-backward " \r\t\n")
22793 (line-beginning-position))
22794 end)))
22795 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22796 (save-restriction
22797 ;; Restrict region
22798 (narrow-to-region (save-excursion (goto-char beg)
22799 (skip-chars-forward " \r\t\n" end)
22800 (line-beginning-position))
22801 (save-excursion (goto-char end)
22802 (skip-chars-backward " \r\t\n" beg)
22803 (line-end-position)))
22804 (let ((uncommentp
22805 ;; UNCOMMENTP is non-nil when every non blank line between
22806 ;; BEG and END is a comment.
22807 (save-excursion
22808 (goto-char (point-min))
22809 (while (and (not (eobp))
22810 (let ((element (org-element-at-point)))
22811 (and (eq (org-element-type element) 'comment)
22812 (goto-char (min (point-max)
22813 (org-element-property
22814 :end element)))))))
22815 (eobp))))
22816 (if uncommentp
22817 ;; Only blank lines and comments in region: uncomment it.
22818 (save-excursion
22819 (goto-char (point-min))
22820 (while (not (eobp))
22821 (when (looking-at "[ \t]*\\(#\\(?: \\|$\\)\\)")
22822 (replace-match "" nil nil nil 1))
22823 (forward-line)))
22824 ;; Comment each line in region.
22825 (let ((min-indent (point-max)))
22826 ;; First find the minimum indentation across all lines.
22827 (save-excursion
22828 (goto-char (point-min))
22829 (while (and (not (eobp)) (not (zerop min-indent)))
22830 (unless (looking-at "[ \t]*$")
22831 (setq min-indent (min min-indent (current-indentation))))
22832 (forward-line)))
22833 ;; Then loop over all lines.
22834 (save-excursion
22835 (goto-char (point-min))
22836 (while (not (eobp))
22837 (unless (and (not comment-empty-lines) (looking-at "[ \t]*$"))
22838 ;; Don't get fooled by invisible text (e.g. link path)
22839 ;; when moving to column MIN-INDENT.
22840 (let ((buffer-invisibility-spec nil))
22841 (org-move-to-column min-indent t))
22842 (insert comment-start))
22843 (forward-line)))))))))
22845 (defun org-comment-dwim (arg)
22846 (interactive "*P")
22847 "Call `comment-dwim' within a source edit buffer if needed."
22848 (if (org-in-src-block-p)
22849 (org-babel-do-in-edit-buffer (call-interactively #'comment-dwim))
22850 (call-interactively #'comment-dwim)))
22853 ;;; Planning
22855 ;; This section contains tools to operate on timestamp objects, as
22856 ;; returned by, e.g. `org-element-context'.
22858 (defun org-timestamp-has-time-p (timestamp)
22859 "Non-nil when TIMESTAMP has a time specified."
22860 (org-element-property :hour-start timestamp))
22862 (defun org-timestamp-format (timestamp format &optional end utc)
22863 "Format a TIMESTAMP element into a string.
22865 FORMAT is a format specifier to be passed to
22866 `format-time-string'.
22868 When optional argument END is non-nil, use end of date-range or
22869 time-range, if possible.
22871 When optional argument UTC is non-nil, time will be expressed as
22872 Universal Time."
22873 (format-time-string
22874 format
22875 (apply 'encode-time
22876 (cons 0
22877 (mapcar
22878 (lambda (prop) (or (org-element-property prop timestamp) 0))
22879 (if end '(:minute-end :hour-end :day-end :month-end :year-end)
22880 '(:minute-start :hour-start :day-start :month-start
22881 :year-start)))))
22882 utc))
22884 (defun org-timestamp-split-range (timestamp &optional end)
22885 "Extract a timestamp object from a date or time range.
22887 TIMESTAMP is a timestamp object. END, when non-nil, means extract
22888 the end of the range. Otherwise, extract its start.
22890 Return a new timestamp object sharing the same parent as
22891 TIMESTAMP."
22892 (let ((type (org-element-property :type timestamp)))
22893 (if (memq type '(active inactive diary)) timestamp
22894 (let ((split-ts (list 'timestamp (copy-sequence (nth 1 timestamp)))))
22895 ;; Set new type.
22896 (org-element-put-property
22897 split-ts :type (if (eq type 'active-range) 'active 'inactive))
22898 ;; Copy start properties over end properties if END is
22899 ;; non-nil. Otherwise, copy end properties over `start' ones.
22900 (let ((p-alist '((:minute-start . :minute-end)
22901 (:hour-start . :hour-end)
22902 (:day-start . :day-end)
22903 (:month-start . :month-end)
22904 (:year-start . :year-end))))
22905 (dolist (p-cell p-alist)
22906 (org-element-put-property
22907 split-ts
22908 (funcall (if end 'car 'cdr) p-cell)
22909 (org-element-property
22910 (funcall (if end 'cdr 'car) p-cell) split-ts)))
22911 ;; Eventually refresh `:raw-value'.
22912 (org-element-put-property split-ts :raw-value nil)
22913 (org-element-put-property
22914 split-ts :raw-value (org-element-interpret-data split-ts)))))))
22916 (defun org-timestamp-translate (timestamp &optional boundary)
22917 "Apply `org-translate-time' on a TIMESTAMP object.
22918 When optional argument BOUNDARY is non-nil, it is either the
22919 symbol `start' or `end'. In this case, only translate the
22920 starting or ending part of TIMESTAMP if it is a date or time
22921 range. Otherwise, translate both parts."
22922 (if (and (not boundary)
22923 (memq (org-element-property :type timestamp)
22924 '(active-range inactive-range)))
22925 (concat
22926 (org-translate-time
22927 (org-element-property :raw-value
22928 (org-timestamp-split-range timestamp)))
22929 "--"
22930 (org-translate-time
22931 (org-element-property :raw-value
22932 (org-timestamp-split-range timestamp t))))
22933 (org-translate-time
22934 (org-element-property
22935 :raw-value
22936 (if (not boundary) timestamp
22937 (org-timestamp-split-range timestamp (eq boundary 'end)))))))
22941 ;;; Other stuff.
22943 (defun org-reftex-citation ()
22944 "Use reftex-citation to insert a citation into the buffer.
22945 This looks for a line like
22947 #+BIBLIOGRAPHY: foo plain option:-d
22949 and derives from it that foo.bib is the bibliography file relevant
22950 for this document. It then installs the necessary environment for RefTeX
22951 to work in this buffer and calls `reftex-citation' to insert a citation
22952 into the buffer.
22954 Export of such citations to both LaTeX and HTML is handled by the contributed
22955 package ox-bibtex by Taru Karttunen."
22956 (interactive)
22957 (let ((reftex-docstruct-symbol 'rds)
22958 (reftex-cite-format "\\cite{%l}")
22959 rds bib)
22960 (save-excursion
22961 (save-restriction
22962 (widen)
22963 (let ((case-fold-search t)
22964 (re "^#\\+bibliography:[ \t]+\\([^ \t\n]+\\)"))
22965 (if (not (save-excursion
22966 (or (re-search-forward re nil t)
22967 (re-search-backward re nil t))))
22968 (error "No bibliography defined in file")
22969 (setq bib (concat (match-string 1) ".bib")
22970 rds (list (list 'bib bib)))))))
22971 (call-interactively 'reftex-citation)))
22973 ;;;; Functions extending outline functionality
22975 (defun org-beginning-of-line (&optional arg)
22976 "Go to the beginning of the current line. If that is invisible, continue
22977 to a visible line beginning. This makes the function of C-a more intuitive.
22978 If this is a headline, and `org-special-ctrl-a/e' is set, ignore tags on the
22979 first attempt, and only move to after the tags when the cursor is already
22980 beyond the end of the headline."
22981 (interactive "P")
22982 (let ((pos (point))
22983 (special (if (consp org-special-ctrl-a/e)
22984 (car org-special-ctrl-a/e)
22985 org-special-ctrl-a/e))
22986 deactivate-mark refpos)
22987 (if (org-bound-and-true-p visual-line-mode)
22988 (beginning-of-visual-line 1)
22989 (beginning-of-line 1))
22990 (if (and arg (fboundp 'move-beginning-of-line))
22991 (call-interactively 'move-beginning-of-line)
22992 (if (bobp)
22994 (backward-char 1)
22995 (if (org-truely-invisible-p)
22996 (while (and (not (bobp)) (org-truely-invisible-p))
22997 (backward-char 1)
22998 (beginning-of-line 1))
22999 (forward-char 1))))
23000 (when special
23001 (cond
23002 ((and (looking-at org-complex-heading-regexp)
23003 (= (char-after (match-end 1)) ?\ ))
23004 (setq refpos (min (1+ (or (match-end 3) (match-end 2) (match-end 1)))
23005 (point-at-eol)))
23006 (goto-char
23007 (if (eq special t)
23008 (cond ((> pos refpos) refpos)
23009 ((= pos (point)) refpos)
23010 (t (point)))
23011 (cond ((> pos (point)) (point))
23012 ((not (eq last-command this-command)) (point))
23013 (t refpos)))))
23014 ((org-at-item-p)
23015 ;; Being at an item and not looking at an the item means point
23016 ;; was previously moved to beginning of a visual line, which
23017 ;; doesn't contain the item. Therefore, do nothing special,
23018 ;; just stay here.
23019 (when (looking-at org-list-full-item-re)
23020 ;; Set special position at first white space character after
23021 ;; bullet, and check-box, if any.
23022 (let ((after-bullet
23023 (let ((box (match-end 3)))
23024 (if (not box) (match-end 1)
23025 (let ((after (char-after box)))
23026 (if (and after (= after ? )) (1+ box) box))))))
23027 ;; Special case: Move point to special position when
23028 ;; currently after it or at beginning of line.
23029 (if (eq special t)
23030 (when (or (> pos after-bullet) (= (point) pos))
23031 (goto-char after-bullet))
23032 ;; Reversed case: Move point to special position when
23033 ;; point was already at beginning of line and command is
23034 ;; repeated.
23035 (when (and (= (point) pos) (eq last-command this-command))
23036 (goto-char after-bullet))))))))
23037 (org-no-warnings
23038 (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23039 (setq disable-point-adjustment
23040 (or (not (invisible-p (point)))
23041 (not (invisible-p (max (point-min) (1- (point))))))))
23043 (defun org-end-of-line (&optional arg)
23044 "Go to the end of the line.
23045 If this is a headline, and `org-special-ctrl-a/e' is set, ignore
23046 tags on the first attempt, and only move to after the tags when
23047 the cursor is already beyond the end of the headline."
23048 (interactive "P")
23049 (let ((special (if (consp org-special-ctrl-a/e) (cdr org-special-ctrl-a/e)
23050 org-special-ctrl-a/e))
23051 (move-fun (cond ((org-bound-and-true-p visual-line-mode)
23052 'end-of-visual-line)
23053 ((fboundp 'move-end-of-line) 'move-end-of-line)
23054 (t 'end-of-line)))
23055 deactivate-mark)
23056 (if (or (not special) arg) (call-interactively move-fun)
23057 (let* ((element (save-excursion (beginning-of-line)
23058 (org-element-at-point)))
23059 (type (org-element-type element)))
23060 (cond
23061 ((memq type '(headline inlinetask))
23062 (let ((pos (point)))
23063 (beginning-of-line 1)
23064 (if (looking-at (org-re ".*?\\(?:\\([ \t]*\\)\\(:[[:alnum:]_@#%:]+:\\)?[ \t]*\\)?$"))
23065 (if (eq special t)
23066 (if (or (< pos (match-beginning 1)) (= pos (match-end 0)))
23067 (goto-char (match-beginning 1))
23068 (goto-char (match-end 0)))
23069 (if (or (< pos (match-end 0))
23070 (not (eq this-command last-command)))
23071 (goto-char (match-end 0))
23072 (goto-char (match-beginning 1))))
23073 (call-interactively move-fun))))
23074 ((outline-invisible-p (line-end-position))
23075 ;; If element is hidden, `move-end-of-line' would put point
23076 ;; after it. Use `end-of-line' to stay on current line.
23077 (call-interactively 'end-of-line))
23078 (t (call-interactively move-fun)))))
23079 (org-no-warnings (and (featurep 'xemacs) (setq zmacs-region-stays t))))
23080 (setq disable-point-adjustment
23081 (or (not (invisible-p (point)))
23082 (not (invisible-p (max (point-min) (1- (point))))))))
23084 (define-key org-mode-map "\C-a" 'org-beginning-of-line)
23085 (define-key org-mode-map "\C-e" 'org-end-of-line)
23087 (defun org-backward-sentence (&optional arg)
23088 "Go to beginning of sentence, or beginning of table field.
23089 This will call `backward-sentence' or `org-table-beginning-of-field',
23090 depending on context."
23091 (interactive "P")
23092 (cond
23093 ((org-at-table-p) (call-interactively 'org-table-beginning-of-field))
23094 (t (call-interactively 'backward-sentence))))
23096 (defun org-forward-sentence (&optional arg)
23097 "Go to end of sentence, or end of table field.
23098 This will call `forward-sentence' or `org-table-end-of-field',
23099 depending on context."
23100 (interactive "P")
23101 (cond
23102 ((org-at-table-p) (call-interactively 'org-table-end-of-field))
23103 (t (call-interactively 'forward-sentence))))
23105 (define-key org-mode-map "\M-a" 'org-backward-sentence)
23106 (define-key org-mode-map "\M-e" 'org-forward-sentence)
23108 (defun org-kill-line (&optional arg)
23109 "Kill line, to tags or end of line."
23110 (interactive "P")
23111 (cond
23112 ((or (not org-special-ctrl-k)
23113 (bolp)
23114 (not (org-at-heading-p)))
23115 (if (and (get-char-property (min (point-max) (point-at-eol)) 'invisible)
23116 org-ctrl-k-protect-subtree)
23117 (if (or (eq org-ctrl-k-protect-subtree 'error)
23118 (not (y-or-n-p "Kill hidden subtree along with headline? ")))
23119 (user-error "C-k aborted as it would kill a hidden subtree")))
23120 (call-interactively
23121 (if (org-bound-and-true-p visual-line-mode) 'kill-visual-line 'kill-line)))
23122 ((looking-at (org-re ".*?\\S-\\([ \t]+\\(:[[:alnum:]_@#%:]+:\\)\\)[ \t]*$"))
23123 (kill-region (point) (match-beginning 1))
23124 (org-set-tags nil t))
23125 (t (kill-region (point) (point-at-eol)))))
23127 (define-key org-mode-map "\C-k" 'org-kill-line)
23129 (defun org-yank (&optional arg)
23130 "Yank. If the kill is a subtree, treat it specially.
23131 This command will look at the current kill and check if is a single
23132 subtree, or a series of subtrees[1]. If it passes the test, and if the
23133 cursor is at the beginning of a line or after the stars of a currently
23134 empty headline, then the yank is handled specially. How exactly depends
23135 on the value of the following variables, both set by default.
23137 org-yank-folded-subtrees
23138 When set, the subtree(s) will be folded after insertion, but only
23139 if doing so would now swallow text after the yanked text.
23141 org-yank-adjusted-subtrees
23142 When set, the subtree will be promoted or demoted in order to
23143 fit into the local outline tree structure, which means that the level
23144 will be adjusted so that it becomes the smaller one of the two
23145 *visible* surrounding headings.
23147 Any prefix to this command will cause `yank' to be called directly with
23148 no special treatment. In particular, a simple \\[universal-argument] prefix \
23149 will just
23150 plainly yank the text as it is.
23152 \[1] The test checks if the first non-white line is a heading
23153 and if there are no other headings with fewer stars."
23154 (interactive "P")
23155 (org-yank-generic 'yank arg))
23157 (defun org-yank-generic (command arg)
23158 "Perform some yank-like command.
23160 This function implements the behavior described in the `org-yank'
23161 documentation. However, it has been generalized to work for any
23162 interactive command with similar behavior."
23164 ;; pretend to be command COMMAND
23165 (setq this-command command)
23167 (if arg
23168 (call-interactively command)
23170 (let ((subtreep ; is kill a subtree, and the yank position appropriate?
23171 (and (org-kill-is-subtree-p)
23172 (or (bolp)
23173 (and (looking-at "[ \t]*$")
23174 (string-match
23175 "\\`\\*+\\'"
23176 (buffer-substring (point-at-bol) (point)))))))
23177 swallowp)
23178 (cond
23179 ((and subtreep org-yank-folded-subtrees)
23180 (let ((beg (point))
23181 end)
23182 (if (and subtreep org-yank-adjusted-subtrees)
23183 (org-paste-subtree nil nil 'for-yank)
23184 (call-interactively command))
23186 (setq end (point))
23187 (goto-char beg)
23188 (when (and (bolp) subtreep
23189 (not (setq swallowp
23190 (org-yank-folding-would-swallow-text beg end))))
23191 (org-with-limited-levels
23192 (or (looking-at org-outline-regexp)
23193 (re-search-forward org-outline-regexp-bol end t))
23194 (while (and (< (point) end) (looking-at org-outline-regexp))
23195 (hide-subtree)
23196 (org-cycle-show-empty-lines 'folded)
23197 (condition-case nil
23198 (outline-forward-same-level 1)
23199 (error (goto-char end))))))
23200 (when swallowp
23201 (message
23202 "Inserted text not folded because that would swallow text"))
23204 (goto-char end)
23205 (skip-chars-forward " \t\n\r")
23206 (beginning-of-line 1)
23207 (push-mark beg 'nomsg)))
23208 ((and subtreep org-yank-adjusted-subtrees)
23209 (let ((beg (point-at-bol)))
23210 (org-paste-subtree nil nil 'for-yank)
23211 (push-mark beg 'nomsg)))
23213 (call-interactively command))))))
23215 (defun org-yank-folding-would-swallow-text (beg end)
23216 "Would hide-subtree at BEG swallow any text after END?"
23217 (let (level)
23218 (org-with-limited-levels
23219 (save-excursion
23220 (goto-char beg)
23221 (when (or (looking-at org-outline-regexp)
23222 (re-search-forward org-outline-regexp-bol end t))
23223 (setq level (org-outline-level)))
23224 (goto-char end)
23225 (skip-chars-forward " \t\r\n\v\f")
23226 (if (or (eobp)
23227 (and (bolp) (looking-at org-outline-regexp)
23228 (<= (org-outline-level) level)))
23229 nil ; Nothing would be swallowed
23230 t))))) ; something would swallow
23232 (define-key org-mode-map "\C-y" 'org-yank)
23234 (defun org-truely-invisible-p ()
23235 "Check if point is at a character currently not visible.
23236 This version does not only check the character property, but also
23237 `visible-mode'."
23238 ;; Early versions of noutline don't have `outline-invisible-p'.
23239 (if (org-bound-and-true-p visible-mode)
23241 (outline-invisible-p)))
23243 (defun org-invisible-p2 ()
23244 "Check if point is at a character currently not visible."
23245 (save-excursion
23246 (if (and (eolp) (not (bobp))) (backward-char 1))
23247 ;; Early versions of noutline don't have `outline-invisible-p'.
23248 (outline-invisible-p)))
23250 (defun org-back-to-heading (&optional invisible-ok)
23251 "Call `outline-back-to-heading', but provide a better error message."
23252 (condition-case nil
23253 (outline-back-to-heading invisible-ok)
23254 (error (error "Before first headline at position %d in buffer %s"
23255 (point) (current-buffer)))))
23257 (defun org-before-first-heading-p ()
23258 "Before first heading?"
23259 (save-excursion
23260 (end-of-line)
23261 (null (re-search-backward org-outline-regexp-bol nil t))))
23263 (defun org-at-heading-p (&optional ignored)
23264 (outline-on-heading-p t))
23265 ;; Compatibility alias with Org versions < 7.8.03
23266 (defalias 'org-on-heading-p 'org-at-heading-p)
23268 (defun org-at-comment-p nil
23269 "Is cursor in a line starting with a # character?"
23270 (save-excursion
23271 (beginning-of-line)
23272 (looking-at "^#")))
23274 (defun org-at-drawer-p nil
23275 "Is cursor at a drawer keyword?"
23276 (save-excursion
23277 (move-beginning-of-line 1)
23278 (looking-at org-drawer-regexp)))
23280 (defun org-at-block-p nil
23281 "Is cursor at a block keyword?"
23282 (save-excursion
23283 (move-beginning-of-line 1)
23284 (looking-at org-block-regexp)))
23286 (defun org-point-at-end-of-empty-headline ()
23287 "If point is at the end of an empty headline, return t, else nil.
23288 If the heading only contains a TODO keyword, it is still still considered
23289 empty."
23290 (and (looking-at "[ \t]*$")
23291 (when org-todo-line-regexp
23292 (save-excursion
23293 (beginning-of-line 1)
23294 (let ((case-fold-search nil))
23295 (looking-at org-todo-line-regexp)
23296 (string= (match-string 3) ""))))))
23298 (defun org-at-heading-or-item-p ()
23299 (or (org-at-heading-p) (org-at-item-p)))
23301 (defun org-at-target-p ()
23302 (or (org-in-regexp org-radio-target-regexp)
23303 (org-in-regexp org-target-regexp)))
23304 ;; Compatibility alias with Org versions < 7.8.03
23305 (defalias 'org-on-target-p 'org-at-target-p)
23307 (defun org-up-heading-all (arg)
23308 "Move to the heading line of which the present line is a subheading.
23309 This function considers both visible and invisible heading lines.
23310 With argument, move up ARG levels."
23311 (if (fboundp 'outline-up-heading-all)
23312 (outline-up-heading-all arg) ; emacs 21 version of outline.el
23313 (outline-up-heading arg t))) ; emacs 22 version of outline.el
23315 (defun org-up-heading-safe ()
23316 "Move to the heading line of which the present line is a subheading.
23317 This version will not throw an error. It will return the level of the
23318 headline found, or nil if no higher level is found.
23320 Also, this function will be a lot faster than `outline-up-heading',
23321 because it relies on stars being the outline starters. This can really
23322 make a significant difference in outlines with very many siblings."
23323 (let (start-level re)
23324 (org-back-to-heading t)
23325 (setq start-level (funcall outline-level))
23326 (if (equal start-level 1)
23328 (setq re (concat "^\\*\\{1," (number-to-string (1- start-level)) "\\} "))
23329 (if (re-search-backward re nil t)
23330 (funcall outline-level)))))
23332 (defun org-first-sibling-p ()
23333 "Is this heading the first child of its parents?"
23334 (interactive)
23335 (let ((re org-outline-regexp-bol)
23336 level l)
23337 (unless (org-at-heading-p t)
23338 (user-error "Not at a heading"))
23339 (setq level (funcall outline-level))
23340 (save-excursion
23341 (if (not (re-search-backward re nil t))
23343 (setq l (funcall outline-level))
23344 (< l level)))))
23346 (defun org-goto-sibling (&optional previous)
23347 "Goto the next sibling, even if it is invisible.
23348 When PREVIOUS is set, go to the previous sibling instead. Returns t
23349 when a sibling was found. When none is found, return nil and don't
23350 move point."
23351 (let ((fun (if previous 're-search-backward 're-search-forward))
23352 (pos (point))
23353 (re org-outline-regexp-bol)
23354 level l)
23355 (when (condition-case nil (org-back-to-heading t) (error nil))
23356 (setq level (funcall outline-level))
23357 (catch 'exit
23358 (or previous (forward-char 1))
23359 (while (funcall fun re nil t)
23360 (setq l (funcall outline-level))
23361 (when (< l level) (goto-char pos) (throw 'exit nil))
23362 (when (= l level) (goto-char (match-beginning 0)) (throw 'exit t)))
23363 (goto-char pos)
23364 nil))))
23366 (defun org-show-siblings ()
23367 "Show all siblings of the current headline."
23368 (save-excursion
23369 (while (org-goto-sibling) (org-flag-heading nil)))
23370 (save-excursion
23371 (while (org-goto-sibling 'previous)
23372 (org-flag-heading nil))))
23374 (defun org-goto-first-child ()
23375 "Goto the first child, even if it is invisible.
23376 Return t when a child was found. Otherwise don't move point and
23377 return nil."
23378 (let (level (pos (point)) (re org-outline-regexp-bol))
23379 (when (condition-case nil (org-back-to-heading t) (error nil))
23380 (setq level (outline-level))
23381 (forward-char 1)
23382 (if (and (re-search-forward re nil t) (> (outline-level) level))
23383 (progn (goto-char (match-beginning 0)) t)
23384 (goto-char pos) nil))))
23386 (defun org-show-hidden-entry ()
23387 "Show an entry where even the heading is hidden."
23388 (save-excursion
23389 (org-show-entry)))
23391 (defun org-flag-heading (flag &optional entry)
23392 "Flag the current heading. FLAG non-nil means make invisible.
23393 When ENTRY is non-nil, show the entire entry."
23394 (save-excursion
23395 (org-back-to-heading t)
23396 ;; Check if we should show the entire entry
23397 (if entry
23398 (progn
23399 (org-show-entry)
23400 (save-excursion
23401 (and (outline-next-heading)
23402 (org-flag-heading nil))))
23403 (outline-flag-region (max (point-min) (1- (point)))
23404 (save-excursion (outline-end-of-heading) (point))
23405 flag))))
23407 (defun org-get-next-sibling ()
23408 "Move to next heading of the same level, and return point.
23409 If there is no such heading, return nil.
23410 This is like outline-next-sibling, but invisible headings are ok."
23411 (let ((level (funcall outline-level)))
23412 (outline-next-heading)
23413 (while (and (not (eobp)) (> (funcall outline-level) level))
23414 (outline-next-heading))
23415 (if (or (eobp) (< (funcall outline-level) level))
23417 (point))))
23419 (defun org-get-last-sibling ()
23420 "Move to previous heading of the same level, and return point.
23421 If there is no such heading, return nil."
23422 (let ((opoint (point))
23423 (level (funcall outline-level)))
23424 (outline-previous-heading)
23425 (when (and (/= (point) opoint) (outline-on-heading-p t))
23426 (while (and (> (funcall outline-level) level)
23427 (not (bobp)))
23428 (outline-previous-heading))
23429 (if (< (funcall outline-level) level)
23431 (point)))))
23433 (defun org-end-of-subtree (&optional invisible-ok to-heading)
23434 "Goto to the end of a subtree."
23435 ;; This contains an exact copy of the original function, but it uses
23436 ;; `org-back-to-heading', to make it work also in invisible
23437 ;; trees. And is uses an invisible-ok argument.
23438 ;; Under Emacs this is not needed, but the old outline.el needs this fix.
23439 ;; Furthermore, when used inside Org, finding the end of a large subtree
23440 ;; with many children and grandchildren etc, this can be much faster
23441 ;; than the outline version.
23442 (org-back-to-heading invisible-ok)
23443 (let ((first t)
23444 (level (funcall outline-level)))
23445 (if (and (derived-mode-p 'org-mode) (< level 1000))
23446 ;; A true heading (not a plain list item), in Org-mode
23447 ;; This means we can easily find the end by looking
23448 ;; only for the right number of stars. Using a regexp to do
23449 ;; this is so much faster than using a Lisp loop.
23450 (let ((re (concat "^\\*\\{1," (int-to-string level) "\\} ")))
23451 (forward-char 1)
23452 (and (re-search-forward re nil 'move) (beginning-of-line 1)))
23453 ;; something else, do it the slow way
23454 (while (and (not (eobp))
23455 (or first (> (funcall outline-level) level)))
23456 (setq first nil)
23457 (outline-next-heading)))
23458 (unless to-heading
23459 (if (memq (preceding-char) '(?\n ?\^M))
23460 (progn
23461 ;; Go to end of line before heading
23462 (forward-char -1)
23463 (if (memq (preceding-char) '(?\n ?\^M))
23464 ;; leave blank line before heading
23465 (forward-char -1))))))
23466 (point))
23468 (defadvice outline-end-of-subtree (around prefer-org-version activate compile)
23469 "Use Org version in org-mode, for dramatic speed-up."
23470 (if (derived-mode-p 'org-mode)
23471 (progn
23472 (org-end-of-subtree nil t)
23473 (unless (eobp) (backward-char 1)))
23474 ad-do-it))
23476 (defun org-end-of-meta-data-and-drawers ()
23477 "Jump to the first text after meta data and drawers in the current entry.
23478 This will move over empty lines, lines with planning time stamps,
23479 clocking lines, and drawers."
23480 (org-back-to-heading t)
23481 (let ((end (save-excursion (outline-next-heading) (point)))
23482 (re (concat "\\(" org-drawer-regexp "\\)"
23483 "\\|" "[ \t]*" org-keyword-time-regexp)))
23484 (forward-line 1)
23485 (while (re-search-forward re end t)
23486 (if (not (match-end 1))
23487 ;; empty or planning line
23488 (forward-line 1)
23489 ;; a drawer, find the end
23490 (re-search-forward "^[ \t]*:END:" end 'move)
23491 (forward-line 1)))
23492 (and (re-search-forward "[^\n]" nil t) (backward-char 1))
23493 (point)))
23495 (defun org-forward-heading-same-level (arg &optional invisible-ok)
23496 "Move forward to the ARG'th subheading at same level as this one.
23497 Stop at the first and last subheadings of a superior heading.
23498 Normally this only looks at visible headings, but when INVISIBLE-OK is
23499 non-nil it will also look at invisible ones."
23500 (interactive "p")
23501 (if (not (ignore-errors (org-back-to-heading invisible-ok)))
23502 (if (and arg (< arg 0))
23503 (goto-char (point-min))
23504 (outline-next-heading))
23505 (org-at-heading-p)
23506 (let ((level (- (match-end 0) (match-beginning 0) 1))
23507 (f (if (and arg (< arg 0))
23508 're-search-backward
23509 're-search-forward))
23510 (count (if arg (abs arg) 1))
23511 (result (point)))
23512 (while (and (prog1 (> count 0)
23513 (forward-char (if (and arg (< arg 0)) -1 1)))
23514 (funcall f org-outline-regexp-bol nil 'move))
23515 (let ((l (- (match-end 0) (match-beginning 0) 1)))
23516 (cond ((< l level) (setq count 0))
23517 ((and (= l level)
23518 (or invisible-ok
23519 (progn
23520 (goto-char (line-beginning-position))
23521 (not (outline-invisible-p)))))
23522 (setq count (1- count))
23523 (when (eq l level)
23524 (setq result (point)))))))
23525 (goto-char result))
23526 (beginning-of-line 1)))
23528 (defun org-backward-heading-same-level (arg &optional invisible-ok)
23529 "Move backward to the ARG'th subheading at same level as this one.
23530 Stop at the first and last subheadings of a superior heading."
23531 (interactive "p")
23532 (org-forward-heading-same-level (if arg (- arg) -1) invisible-ok))
23534 (defun org-next-block (arg &optional backward block-regexp)
23535 "Jump to the next block.
23536 With a prefix argument ARG, jump forward ARG many source blocks.
23537 When BACKWARD is non-nil, jump to the previous block.
23538 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23539 (interactive "p")
23540 (let ((re (or block-regexp org-block-regexp))
23541 (re-search-fn (or (and backward 're-search-backward)
23542 're-search-forward)))
23543 (if (looking-at re) (forward-char 1))
23544 (condition-case nil
23545 (funcall re-search-fn re nil nil arg)
23546 (error (error "No %s code blocks" (if backward "previous" "further" ))))
23547 (goto-char (match-beginning 0)) (org-show-context)))
23549 (defun org-previous-block (arg &optional block-regexp)
23550 "Jump to the previous block.
23551 With a prefix argument ARG, jump backward ARG many source blocks.
23552 When BLOCK-REGEXP is non-nil, use this regexp to find blocks."
23553 (interactive "p")
23554 (org-next-block arg t block-regexp))
23556 (defun org-forward-paragraph ()
23557 "Move forward to beginning of next paragraph or equivalent.
23559 The function moves point to the beginning of the next visible
23560 structural element, which can be a paragraph, a table, a list
23561 item, etc. It also provides some special moves for convenience:
23563 - On an affiliated keyword, jump to the beginning of the
23564 relative element.
23565 - On an item or a footnote definition, move to the second
23566 element inside, if any.
23567 - On a table or a property drawer, jump after it.
23568 - On a verse or source block, stop after blank lines."
23569 (interactive)
23570 (when (eobp) (user-error "Cannot move further down"))
23571 (let* ((deactivate-mark nil)
23572 (element (org-element-at-point))
23573 (type (org-element-type element))
23574 (post-affiliated (org-element-property :post-affiliated element))
23575 (contents-begin (org-element-property :contents-begin element))
23576 (contents-end (org-element-property :contents-end element))
23577 (end (let ((end (org-element-property :end element)) (parent element))
23578 (while (and (setq parent (org-element-property :parent parent))
23579 (= (org-element-property :contents-end parent) end))
23580 (setq end (org-element-property :end parent)))
23581 end)))
23582 (cond ((not element)
23583 (skip-chars-forward " \r\t\n")
23584 (or (eobp) (beginning-of-line)))
23585 ;; On affiliated keywords, move to element's beginning.
23586 ((and post-affiliated (< (point) post-affiliated))
23587 (goto-char post-affiliated))
23588 ;; At a table row, move to the end of the table. Similarly,
23589 ;; at a node property, move to the end of the property
23590 ;; drawer.
23591 ((memq type '(node-property table-row))
23592 (goto-char (org-element-property
23593 :end (org-element-property :parent element))))
23594 ((memq type '(property-drawer table)) (goto-char end))
23595 ;; Consider blank lines as separators in verse and source
23596 ;; blocks to ease editing.
23597 ((memq type '(src-block verse-block))
23598 (when (eq type 'src-block)
23599 (setq contents-end
23600 (save-excursion (goto-char end)
23601 (skip-chars-backward " \r\t\n")
23602 (line-beginning-position))))
23603 (beginning-of-line)
23604 (when (looking-at "[ \t]*$") (skip-chars-forward " \r\t\n"))
23605 (if (not (re-search-forward "^[ \t]*$" contents-end t))
23606 (goto-char end)
23607 (skip-chars-forward " \r\t\n")
23608 (if (= (point) contents-end) (goto-char end)
23609 (beginning-of-line))))
23610 ;; With no contents, just skip element.
23611 ((not contents-begin) (goto-char end))
23612 ;; If contents are invisible, skip the element altogether.
23613 ((outline-invisible-p (line-end-position))
23614 (case type
23615 (headline
23616 (org-with-limited-levels (outline-next-visible-heading 1)))
23617 ;; At a plain list, make sure we move to the next item
23618 ;; instead of skipping the whole list.
23619 (plain-list (forward-char)
23620 (org-forward-paragraph))
23621 (otherwise (goto-char end))))
23622 ((>= (point) contents-end) (goto-char end))
23623 ((>= (point) contents-begin)
23624 ;; This can only happen on paragraphs and plain lists.
23625 (case type
23626 (paragraph (goto-char end))
23627 ;; At a plain list, try to move to second element in
23628 ;; first item, if possible.
23629 (plain-list (end-of-line)
23630 (org-forward-paragraph))))
23631 ;; When contents start on the middle of a line (e.g. in
23632 ;; items and footnote definitions), try to reach first
23633 ;; element starting after current line.
23634 ((> (line-end-position) contents-begin)
23635 (end-of-line)
23636 (org-forward-paragraph))
23637 (t (goto-char contents-begin)))))
23639 (defun org-backward-paragraph ()
23640 "Move backward to start of previous paragraph or equivalent.
23642 The function moves point to the beginning of the current
23643 structural element, which can be a paragraph, a table, a list
23644 item, etc., or to the beginning of the previous visible one if
23645 point is already there. It also provides some special moves for
23646 convenience:
23648 - On an affiliated keyword, jump to the first one.
23649 - On a table or a property drawer, move to its beginning.
23650 - On a verse or source block, stop before blank lines."
23651 (interactive)
23652 (when (bobp) (user-error "Cannot move further up"))
23653 (let* ((deactivate-mark nil)
23654 (element (org-element-at-point))
23655 (type (org-element-type element))
23656 (contents-begin (org-element-property :contents-begin element))
23657 (contents-end (org-element-property :contents-end element))
23658 (post-affiliated (org-element-property :post-affiliated element))
23659 (begin (org-element-property :begin element)))
23660 (cond
23661 ((not element) (goto-char (point-min)))
23662 ((= (point) begin)
23663 (backward-char)
23664 (org-backward-paragraph))
23665 ((and post-affiliated (<= (point) post-affiliated)) (goto-char begin))
23666 ((memq type '(node-property table-row))
23667 (goto-char (org-element-property
23668 :post-affiliated (org-element-property :parent element))))
23669 ((memq type '(property-drawer table)) (goto-char begin))
23670 ((memq type '(src-block verse-block))
23671 (when (eq type 'src-block)
23672 (setq contents-begin
23673 (save-excursion (goto-char begin) (forward-line) (point))))
23674 (if (= (point) contents-begin) (goto-char post-affiliated)
23675 ;; Inside a verse block, see blank lines as paragraph
23676 ;; separators.
23677 (let ((origin (point)))
23678 (skip-chars-backward " \r\t\n" contents-begin)
23679 (when (re-search-backward "^[ \t]*$" contents-begin 'move)
23680 (skip-chars-forward " \r\t\n" origin)
23681 (if (= (point) origin) (goto-char contents-begin)
23682 (beginning-of-line))))))
23683 ((not contents-begin) (goto-char (or post-affiliated begin)))
23684 ((eq type 'paragraph)
23685 (goto-char contents-begin)
23686 ;; When at first paragraph in an item or a footnote definition,
23687 ;; move directly to beginning of line.
23688 (let ((parent-contents
23689 (org-element-property
23690 :contents-begin (org-element-property :parent element))))
23691 (when (and parent-contents (= parent-contents contents-begin))
23692 (beginning-of-line))))
23693 ;; At the end of a greater element, move to the beginning of the
23694 ;; last element within.
23695 ((>= (point) contents-end)
23696 (goto-char (1- contents-end))
23697 (org-backward-paragraph))
23698 (t (goto-char (or post-affiliated begin))))
23699 ;; Ensure we never leave point invisible.
23700 (when (outline-invisible-p (point)) (beginning-of-visual-line))))
23702 (defun org-forward-element ()
23703 "Move forward by one element.
23704 Move to the next element at the same level, when possible."
23705 (interactive)
23706 (cond ((eobp) (user-error "Cannot move further down"))
23707 ((org-with-limited-levels (org-at-heading-p))
23708 (let ((origin (point)))
23709 (goto-char (org-end-of-subtree nil t))
23710 (unless (org-with-limited-levels (org-at-heading-p))
23711 (goto-char origin)
23712 (user-error "Cannot move further down"))))
23714 (let* ((elem (org-element-at-point))
23715 (end (org-element-property :end elem))
23716 (parent (org-element-property :parent elem)))
23717 (cond ((and parent (= (org-element-property :contents-end parent) end))
23718 (goto-char (org-element-property :end parent)))
23719 ((integer-or-marker-p end) (goto-char end))
23720 (t (message "No element at point")))))))
23722 (defun org-backward-element ()
23723 "Move backward by one element.
23724 Move to the previous element at the same level, when possible."
23725 (interactive)
23726 (cond ((bobp) (user-error "Cannot move further up"))
23727 ((org-with-limited-levels (org-at-heading-p))
23728 ;; At a headline, move to the previous one, if any, or stay
23729 ;; here.
23730 (let ((origin (point)))
23731 (org-with-limited-levels (org-backward-heading-same-level 1))
23732 ;; When current headline has no sibling above, move to its
23733 ;; parent.
23734 (when (= (point) origin)
23735 (or (org-with-limited-levels (org-up-heading-safe))
23736 (progn (goto-char origin)
23737 (user-error "Cannot move further up"))))))
23739 (let* ((elem (org-element-at-point))
23740 (beg (org-element-property :begin elem)))
23741 (cond
23742 ;; Move to beginning of current element if point isn't
23743 ;; there already.
23744 ((null beg) (message "No element at point"))
23745 ((/= (point) beg) (goto-char beg))
23746 (t (goto-char beg)
23747 (skip-chars-backward " \r\t\n")
23748 (unless (bobp)
23749 (let ((prev (org-element-at-point)))
23750 (goto-char (org-element-property :begin prev))
23751 (while (and (setq prev (org-element-property :parent prev))
23752 (<= (org-element-property :end prev) beg))
23753 (goto-char (org-element-property :begin prev)))))))))))
23755 (defun org-up-element ()
23756 "Move to upper element."
23757 (interactive)
23758 (if (org-with-limited-levels (org-at-heading-p))
23759 (unless (org-up-heading-safe) (user-error "No surrounding element"))
23760 (let* ((elem (org-element-at-point))
23761 (parent (org-element-property :parent elem)))
23762 (if parent (goto-char (org-element-property :begin parent))
23763 (if (org-with-limited-levels (org-before-first-heading-p))
23764 (user-error "No surrounding element")
23765 (org-with-limited-levels (org-back-to-heading)))))))
23767 (defvar org-element-greater-elements)
23768 (defun org-down-element ()
23769 "Move to inner element."
23770 (interactive)
23771 (let ((element (org-element-at-point)))
23772 (cond
23773 ((memq (org-element-type element) '(plain-list table))
23774 (goto-char (org-element-property :contents-begin element))
23775 (forward-char))
23776 ((memq (org-element-type element) org-element-greater-elements)
23777 ;; If contents are hidden, first disclose them.
23778 (when (outline-invisible-p (line-end-position)) (org-cycle))
23779 (goto-char (or (org-element-property :contents-begin element)
23780 (user-error "No content for this element"))))
23781 (t (user-error "No inner element")))))
23783 (defun org-drag-element-backward ()
23784 "Move backward element at point."
23785 (interactive)
23786 (if (org-with-limited-levels (org-at-heading-p)) (org-move-subtree-up)
23787 (let* ((elem (org-element-at-point))
23788 (prev-elem
23789 (save-excursion
23790 (goto-char (org-element-property :begin elem))
23791 (skip-chars-backward " \r\t\n")
23792 (unless (bobp)
23793 (let* ((beg (org-element-property :begin elem))
23794 (prev (org-element-at-point))
23795 (up prev))
23796 (while (and (setq up (org-element-property :parent up))
23797 (<= (org-element-property :end prev) beg))
23798 (setq prev up))
23799 prev)))))
23800 ;; Error out if no previous element or previous element is
23801 ;; a parent of the current one.
23802 (if (or (not prev-elem) (org-element-nested-p elem prev-elem))
23803 (user-error "Cannot drag element backward")
23804 (let ((pos (point)))
23805 (org-element-swap-A-B prev-elem elem)
23806 (goto-char (+ (org-element-property :begin prev-elem)
23807 (- pos (org-element-property :begin elem)))))))))
23809 (defun org-drag-element-forward ()
23810 "Move forward element at point."
23811 (interactive)
23812 (let* ((pos (point))
23813 (elem (org-element-at-point)))
23814 (when (= (point-max) (org-element-property :end elem))
23815 (user-error "Cannot drag element forward"))
23816 (goto-char (org-element-property :end elem))
23817 (let ((next-elem (org-element-at-point)))
23818 (when (or (org-element-nested-p elem next-elem)
23819 (and (eq (org-element-type next-elem) 'headline)
23820 (not (eq (org-element-type elem) 'headline))))
23821 (goto-char pos)
23822 (user-error "Cannot drag element forward"))
23823 ;; Compute new position of point: it's shifted by NEXT-ELEM
23824 ;; body's length (without final blanks) and by the length of
23825 ;; blanks between ELEM and NEXT-ELEM.
23826 (let ((size-next (- (save-excursion
23827 (goto-char (org-element-property :end next-elem))
23828 (skip-chars-backward " \r\t\n")
23829 (forward-line)
23830 ;; Small correction if buffer doesn't end
23831 ;; with a newline character.
23832 (if (and (eolp) (not (bolp))) (1+ (point)) (point)))
23833 (org-element-property :begin next-elem)))
23834 (size-blank (- (org-element-property :end elem)
23835 (save-excursion
23836 (goto-char (org-element-property :end elem))
23837 (skip-chars-backward " \r\t\n")
23838 (forward-line)
23839 (point)))))
23840 (org-element-swap-A-B elem next-elem)
23841 (goto-char (+ pos size-next size-blank))))))
23843 (defun org-drag-line-forward (arg)
23844 "Drag the line at point ARG lines forward."
23845 (interactive "p")
23846 (dotimes (n (abs arg))
23847 (let ((c (current-column)))
23848 (if (< 0 arg)
23849 (progn
23850 (beginning-of-line 2)
23851 (transpose-lines 1)
23852 (beginning-of-line 0))
23853 (transpose-lines 1)
23854 (beginning-of-line -1))
23855 (org-move-to-column c))))
23857 (defun org-drag-line-backward (arg)
23858 "Drag the line at point ARG lines backward."
23859 (interactive "p")
23860 (org-drag-line-forward (- arg)))
23862 (defun org-mark-element ()
23863 "Put point at beginning of this element, mark at end.
23865 Interactively, if this command is repeated or (in Transient Mark
23866 mode) if the mark is active, it marks the next element after the
23867 ones already marked."
23868 (interactive)
23869 (let (deactivate-mark)
23870 (if (and (org-called-interactively-p 'any)
23871 (or (and (eq last-command this-command) (mark t))
23872 (and transient-mark-mode mark-active)))
23873 (set-mark
23874 (save-excursion
23875 (goto-char (mark))
23876 (goto-char (org-element-property :end (org-element-at-point)))))
23877 (let ((element (org-element-at-point)))
23878 (end-of-line)
23879 (push-mark (org-element-property :end element) t t)
23880 (goto-char (org-element-property :begin element))))))
23882 (defun org-narrow-to-element ()
23883 "Narrow buffer to current element."
23884 (interactive)
23885 (let ((elem (org-element-at-point)))
23886 (cond
23887 ((eq (car elem) 'headline)
23888 (narrow-to-region
23889 (org-element-property :begin elem)
23890 (org-element-property :end elem)))
23891 ((memq (car elem) org-element-greater-elements)
23892 (narrow-to-region
23893 (org-element-property :contents-begin elem)
23894 (org-element-property :contents-end elem)))
23896 (narrow-to-region
23897 (org-element-property :begin elem)
23898 (org-element-property :end elem))))))
23900 (defun org-transpose-element ()
23901 "Transpose current and previous elements, keeping blank lines between.
23902 Point is moved after both elements."
23903 (interactive)
23904 (org-skip-whitespace)
23905 (let ((end (org-element-property :end (org-element-at-point))))
23906 (org-drag-element-backward)
23907 (goto-char end)))
23909 (defun org-unindent-buffer ()
23910 "Un-indent the visible part of the buffer.
23911 Relative indentation (between items, inside blocks, etc.) isn't
23912 modified."
23913 (interactive)
23914 (unless (eq major-mode 'org-mode)
23915 (user-error "Cannot un-indent a buffer not in Org mode"))
23916 (let* ((parse-tree (org-element-parse-buffer 'greater-element))
23917 unindent-tree ; For byte-compiler.
23918 (unindent-tree
23919 (function
23920 (lambda (contents)
23921 (mapc
23922 (lambda (element)
23923 (if (memq (org-element-type element) '(headline section))
23924 (funcall unindent-tree (org-element-contents element))
23925 (save-excursion
23926 (save-restriction
23927 (narrow-to-region
23928 (org-element-property :begin element)
23929 (org-element-property :end element))
23930 (org-do-remove-indentation)))))
23931 (reverse contents))))))
23932 (funcall unindent-tree (org-element-contents parse-tree))))
23934 (defun org-show-subtree ()
23935 "Show everything after this heading at deeper levels."
23936 (interactive)
23937 (outline-flag-region
23938 (point)
23939 (save-excursion
23940 (org-end-of-subtree t t))
23941 nil))
23943 (defun org-show-entry ()
23944 "Show the body directly following this heading.
23945 Show the heading too, if it is currently invisible."
23946 (interactive)
23947 (save-excursion
23948 (condition-case nil
23949 (progn
23950 (org-back-to-heading t)
23951 (outline-flag-region
23952 (max (point-min) (1- (point)))
23953 (save-excursion
23954 (if (re-search-forward
23955 (concat "[\r\n]\\(" org-outline-regexp "\\)") nil t)
23956 (match-beginning 1)
23957 (point-max)))
23958 nil)
23959 (org-cycle-hide-drawers 'children))
23960 (error nil))))
23962 (defun org-make-options-regexp (kwds &optional extra)
23963 "Make a regular expression for keyword lines."
23964 (concat
23965 "^#\\+\\("
23966 (mapconcat 'regexp-quote kwds "\\|")
23967 (if extra (concat "\\|" extra))
23968 "\\):[ \t]*\\(.*\\)"))
23970 ;; Make isearch reveal the necessary context
23971 (defun org-isearch-end ()
23972 "Reveal context after isearch exits."
23973 (when isearch-success ; only if search was successful
23974 (if (featurep 'xemacs)
23975 ;; Under XEmacs, the hook is run in the correct place,
23976 ;; we directly show the context.
23977 (org-show-context 'isearch)
23978 ;; In Emacs the hook runs *before* restoring the overlays.
23979 ;; So we have to use a one-time post-command-hook to do this.
23980 ;; (Emacs 22 has a special variable, see function `org-mode')
23981 (unless (and (boundp 'isearch-mode-end-hook-quit)
23982 isearch-mode-end-hook-quit)
23983 ;; Only when the isearch was not quitted.
23984 (org-add-hook 'post-command-hook 'org-isearch-post-command
23985 'append 'local)))
23986 (org-fix-ellipsis-at-bol)))
23988 (defun org-isearch-post-command ()
23989 "Remove self from hook, and show context."
23990 (remove-hook 'post-command-hook 'org-isearch-post-command 'local)
23991 (org-show-context 'isearch))
23994 ;;;; Integration with and fixes for other packages
23996 ;;; Imenu support
23998 (defvar org-imenu-markers nil
23999 "All markers currently used by Imenu.")
24000 (make-variable-buffer-local 'org-imenu-markers)
24002 (defun org-imenu-new-marker (&optional pos)
24003 "Return a new marker for use by Imenu, and remember the marker."
24004 (let ((m (make-marker)))
24005 (move-marker m (or pos (point)))
24006 (push m org-imenu-markers)
24009 (defun org-imenu-get-tree ()
24010 "Produce the index for Imenu."
24011 (mapc (lambda (x) (move-marker x nil)) org-imenu-markers)
24012 (setq org-imenu-markers nil)
24013 (let* ((n org-imenu-depth)
24014 (re (concat "^" (org-get-limited-outline-regexp)))
24015 (subs (make-vector (1+ n) nil))
24016 (last-level 0)
24017 m level head0 head)
24018 (save-excursion
24019 (save-restriction
24020 (widen)
24021 (goto-char (point-max))
24022 (while (re-search-backward re nil t)
24023 (setq level (org-reduced-level (funcall outline-level)))
24024 (when (and (<= level n)
24025 (looking-at org-complex-heading-regexp)
24026 (setq head0 (org-match-string-no-properties 4)))
24027 (setq head (org-link-display-format head0)
24028 m (org-imenu-new-marker))
24029 (org-add-props head nil 'org-imenu-marker m 'org-imenu t)
24030 (if (>= level last-level)
24031 (push (cons head m) (aref subs level))
24032 (push (cons head (aref subs (1+ level))) (aref subs level))
24033 (loop for i from (1+ level) to n do (aset subs i nil)))
24034 (setq last-level level)))))
24035 (aref subs 1)))
24037 (eval-after-load "imenu"
24038 '(progn
24039 (add-hook 'imenu-after-jump-hook
24040 (lambda ()
24041 (if (derived-mode-p 'org-mode)
24042 (org-show-context 'org-goto))))))
24044 (defun org-link-display-format (link)
24045 "Replace a link with its the description.
24046 If there is no description, use the link target."
24047 (save-match-data
24048 (if (string-match org-bracket-link-analytic-regexp link)
24049 (replace-match (if (match-end 5)
24050 (match-string 5 link)
24051 (concat (match-string 1 link)
24052 (match-string 3 link)))
24053 nil t link)
24054 link)))
24056 (defun org-toggle-link-display ()
24057 "Toggle the literal or descriptive display of links."
24058 (interactive)
24059 (if org-descriptive-links
24060 (progn (org-remove-from-invisibility-spec '(org-link))
24061 (org-restart-font-lock)
24062 (setq org-descriptive-links nil))
24063 (progn (add-to-invisibility-spec '(org-link))
24064 (org-restart-font-lock)
24065 (setq org-descriptive-links t))))
24067 ;; Speedbar support
24069 (defvar org-speedbar-restriction-lock-overlay (make-overlay 1 1)
24070 "Overlay marking the agenda restriction line in speedbar.")
24071 (overlay-put org-speedbar-restriction-lock-overlay
24072 'face 'org-agenda-restriction-lock)
24073 (overlay-put org-speedbar-restriction-lock-overlay
24074 'help-echo "Agendas are currently limited to this item.")
24075 (org-detach-overlay org-speedbar-restriction-lock-overlay)
24077 (defun org-speedbar-set-agenda-restriction ()
24078 "Restrict future agenda commands to the location at point in speedbar.
24079 To get rid of the restriction, use \\[org-agenda-remove-restriction-lock]."
24080 (interactive)
24081 (require 'org-agenda)
24082 (let (p m tp np dir txt)
24083 (cond
24084 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24085 'org-imenu t))
24086 (setq m (get-text-property p 'org-imenu-marker))
24087 (with-current-buffer (marker-buffer m)
24088 (goto-char m)
24089 (org-agenda-set-restriction-lock 'subtree)))
24090 ((setq p (text-property-any (point-at-bol) (point-at-eol)
24091 'speedbar-function 'speedbar-find-file))
24092 (setq tp (previous-single-property-change
24093 (1+ p) 'speedbar-function)
24094 np (next-single-property-change
24095 tp 'speedbar-function)
24096 dir (speedbar-line-directory)
24097 txt (buffer-substring-no-properties (or tp (point-min))
24098 (or np (point-max))))
24099 (with-current-buffer (find-file-noselect
24100 (let ((default-directory dir))
24101 (expand-file-name txt)))
24102 (unless (derived-mode-p 'org-mode)
24103 (user-error "Cannot restrict to non-Org-mode file"))
24104 (org-agenda-set-restriction-lock 'file)))
24105 (t (user-error "Don't know how to restrict Org-mode's agenda")))
24106 (move-overlay org-speedbar-restriction-lock-overlay
24107 (point-at-bol) (point-at-eol))
24108 (setq current-prefix-arg nil)
24109 (org-agenda-maybe-redo)))
24111 (defvar speedbar-file-key-map)
24112 (declare-function speedbar-add-supported-extension "speedbar" (extension))
24113 (eval-after-load "speedbar"
24114 '(progn
24115 (speedbar-add-supported-extension ".org")
24116 (define-key speedbar-file-key-map "<" 'org-speedbar-set-agenda-restriction)
24117 (define-key speedbar-file-key-map "\C-c\C-x<" 'org-speedbar-set-agenda-restriction)
24118 (define-key speedbar-file-key-map ">" 'org-agenda-remove-restriction-lock)
24119 (define-key speedbar-file-key-map "\C-c\C-x>" 'org-agenda-remove-restriction-lock)
24120 (add-hook 'speedbar-visiting-tag-hook
24121 (lambda () (and (derived-mode-p 'org-mode) (org-show-context 'org-goto))))))
24123 ;;; Fixes and Hacks for problems with other packages
24125 (defun org-mode-flyspell-verify ()
24126 "Function used for `flyspell-generic-check-word-predicate'."
24127 (if (org-at-heading-p)
24128 ;; At a headline or an inlinetask, check title only. This is
24129 ;; faster than relying on `org-element-at-point'.
24130 (and (save-excursion (beginning-of-line)
24131 (and (let ((case-fold-search t))
24132 (not (looking-at "\\*+ END[ \t]*$")))
24133 (looking-at org-complex-heading-regexp)))
24134 (match-beginning 4)
24135 (>= (point) (match-beginning 4))
24136 (or (not (match-beginning 5))
24137 (< (point) (match-beginning 5))))
24138 (let* ((element (org-element-at-point))
24139 (post-affiliated (org-element-property :post-affiliated element))
24140 (object-check
24141 (function
24142 ;; Non-nil if checks can be done for object at point.
24143 (lambda ()
24144 (let ((object (save-excursion
24145 (when (org-looking-at-p "\\>") (backward-char))
24146 (org-element-context element))))
24147 (case (org-element-type object)
24148 ;; Prevent checks in links due to keybinding conflict
24149 ;; with Flyspell.
24150 ((code entity export-snippet inline-babel-call
24151 inline-src-block line-break latex-fragment link macro
24152 statistics-cookie target timestamp verbatim)
24153 nil)
24154 (footnote-reference
24155 ;; Only in inline footnotes, within the definition.
24156 (and (eq (org-element-property :type object) 'inline)
24157 (< (save-excursion
24158 (goto-char (org-element-property :begin object))
24159 (search-forward ":" nil t 2))
24160 (point))))
24161 (otherwise t)))))))
24162 (cond
24163 ;; Ignore checks in all affiliated keywords but captions.
24164 ((and post-affiliated (< (point) post-affiliated))
24165 (and (save-excursion
24166 (beginning-of-line)
24167 (let ((case-fold-search t)) (looking-at "[ \t]*#\\+CAPTION:")))
24168 (> (point) (match-end 0))
24169 (funcall object-check)))
24170 ;; Ignore checks in LOGBOOK (or equivalent) drawer.
24171 ((and org-log-into-drawer
24172 (let ((log (or (org-string-nw-p org-log-into-drawer) "LOGBOOK"))
24173 (parent element))
24174 (while (and parent (not (eq (org-element-type parent) 'drawer)))
24175 (setq parent (org-element-property :parent parent)))
24176 (and parent
24177 (eq (compare-strings
24178 log nil nil
24179 (org-element-property :drawer-name parent) nil nil t)
24180 t))))
24181 nil)
24183 (case (org-element-type element)
24184 ((comment quote-section) t)
24185 (comment-block
24186 ;; Allow checks between block markers, not on them.
24187 (and (> (line-beginning-position)
24188 (org-element-property :post-affiliated element))
24189 (save-excursion
24190 (end-of-line)
24191 (skip-chars-forward " \r\t\n")
24192 (< (point) (org-element-property :end element)))))
24193 ;; Arbitrary list of keywords where checks are meaningful.
24194 ;; Make sure point is on the value part of the element.
24195 (keyword
24196 (and (member (org-element-property :key element)
24197 '("DESCRIPTION" "TITLE"))
24198 (< (save-excursion
24199 (beginning-of-line) (search-forward ":") (point))
24200 (point))))
24201 ;; Check is globally allowed in paragraphs verse blocks and
24202 ;; table rows (after affiliated keywords) but some objects
24203 ;; must not be affected.
24204 ((paragraph table-row verse-block)
24205 (and (>= (point) (org-element-property :contents-begin element))
24206 (< (point) (org-element-property :contents-end element))
24207 (funcall object-check)))))))))
24208 (put 'org-mode 'flyspell-mode-predicate 'org-mode-flyspell-verify)
24210 (defun org-remove-flyspell-overlays-in (beg end)
24211 "Remove flyspell overlays in region."
24212 (and (org-bound-and-true-p flyspell-mode)
24213 (fboundp 'flyspell-delete-region-overlays)
24214 (flyspell-delete-region-overlays beg end)))
24216 (defvar flyspell-delayed-commands)
24217 (eval-after-load "flyspell"
24218 '(add-to-list 'flyspell-delayed-commands 'org-self-insert-command))
24220 ;; Make `bookmark-jump' shows the jump location if it was hidden.
24221 (eval-after-load "bookmark"
24222 '(if (boundp 'bookmark-after-jump-hook)
24223 ;; We can use the hook
24224 (add-hook 'bookmark-after-jump-hook 'org-bookmark-jump-unhide)
24225 ;; Hook not available, use advice
24226 (defadvice bookmark-jump (after org-make-visible activate)
24227 "Make the position visible."
24228 (org-bookmark-jump-unhide))))
24230 ;; Make sure saveplace shows the location if it was hidden
24231 (eval-after-load "saveplace"
24232 '(defadvice save-place-find-file-hook (after org-make-visible activate)
24233 "Make the position visible."
24234 (org-bookmark-jump-unhide)))
24236 ;; Make sure ecb shows the location if it was hidden
24237 (eval-after-load "ecb"
24238 '(defadvice ecb-method-clicked (after esf/org-show-context activate)
24239 "Make hierarchy visible when jumping into location from ECB tree buffer."
24240 (if (derived-mode-p 'org-mode)
24241 (org-show-context))))
24243 (defun org-bookmark-jump-unhide ()
24244 "Unhide the current position, to show the bookmark location."
24245 (and (derived-mode-p 'org-mode)
24246 (or (outline-invisible-p)
24247 (save-excursion (goto-char (max (point-min) (1- (point))))
24248 (outline-invisible-p)))
24249 (org-show-context 'bookmark-jump)))
24251 ;; Make session.el ignore our circular variable
24252 (defvar session-globals-exclude)
24253 (eval-after-load "session"
24254 '(add-to-list 'session-globals-exclude 'org-mark-ring))
24256 ;;;; Finish up
24258 (provide 'org)
24260 (run-hooks 'org-load-hook)
24262 ;;; org.el ends here