org-capture.el 74.7 KB
Newer Older
Rasmus's avatar
Rasmus committed
1
;;; org-capture.el --- Fast note taking in Org       -*- lexical-binding: t; -*-
2

Paul Eggert's avatar
Paul Eggert committed
3
;; Copyright (C) 2010-2020 Free Software Foundation, Inc.
4 5 6

;; Author: Carsten Dominik <carsten at orgmode dot org>
;; Keywords: outlines, hypermedia, calendar, wp
Rasmus's avatar
Rasmus committed
7
;; Homepage: https://orgmode.org
8 9 10 11 12 13 14 15 16 17 18 19 20 21
;;
;; This file is part of GNU Emacs.
;;
;; GNU Emacs is free software: you can redistribute it and/or modify
;; it under the terms of the GNU General Public License as published by
;; the Free Software Foundation, either version 3 of the License, or
;; (at your option) any later version.

;; GNU Emacs is distributed in the hope that it will be useful,
;; but WITHOUT ANY WARRANTY; without even the implied warranty of
;; MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
;; GNU General Public License for more details.

;; You should have received a copy of the GNU General Public License
22
;; along with GNU Emacs.  If not, see <https://www.gnu.org/licenses/>.
23 24 25 26
;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;
;;
;;; Commentary:

Bastien Guerry's avatar
Bastien Guerry committed
27 28
;; This file contains an alternative implementation of the functionality
;; that used to be provided by org-remember.el.  The implementation is more
29 30 31 32
;; streamlined, can produce more target types (e.g. plain list items or
;; table lines).  Also, it does not use a temporary buffer for editing
;; the captured entry - instead it uses an indirect buffer that visits
;; the new entry already in the target buffer (this was an idea by Samuel
Bastien Guerry's avatar
Bastien Guerry committed
33 34
;; Wales).  John Wiegley's excellent `remember.el' is not needed anymore
;; for this implementation, even though we borrow heavily from its ideas.
35 36 37 38 39 40 41 42 43 44 45 46 47 48 49

;; This implementation heavily draws on ideas by James TD Smith and
;; Samuel Wales, and, of cause, uses John Wiegley's remember.el as inspiration.

;;; TODO

;; - find a clever way to not always insert an annotation maybe a
;;   predicate function that can check for conditions for %a to be
;;   used.  This could be one of the properties.

;; - Should there be plist members that arrange for properties to be
;;   asked for, like James proposed in his RFC?

;;; Code:

Rasmus's avatar
Rasmus committed
50
(require 'cl-lib)
51 52
(require 'org)

Rasmus's avatar
Rasmus committed
53
(declare-function org-at-encrypted-entry-p "org-crypt" ())
Bastien's avatar
Bastien committed
54
(declare-function org-at-table-p "org-table" (&optional table-type))
Rasmus's avatar
Rasmus committed
55 56
(declare-function org-clock-update-mode-line "org-clock" (&optional refresh))
(declare-function org-datetree-find-date-create "org-datetree" (date &optional keep-restriction))
57
(declare-function org-decrypt-entry "org-crypt" ())
Bastien's avatar
Bastien committed
58 59 60
(declare-function org-element-at-point "org-element" ())
(declare-function org-element-lineage "org-element" (datum &optional types with-self))
(declare-function org-element-property "org-element" (property element))
Rasmus's avatar
Rasmus committed
61
(declare-function org-encrypt-entry "org-crypt" ())
Bastien's avatar
Bastien committed
62 63
(declare-function org-insert-link "ol" (&optional complete-file link-location default-description))
(declare-function org-link-make-string "ol" (link &optional description))
Rasmus's avatar
Rasmus committed
64
(declare-function org-table-analyze "org-table" ())
Rasmus's avatar
Rasmus committed
65
(declare-function org-table-current-dline "org-table" ())
Bastien's avatar
Bastien committed
66
(declare-function org-table-fix-formulas "org-table" (key replace &optional limit delta remove))
Rasmus's avatar
Rasmus committed
67
(declare-function org-table-goto-line "org-table" (N))
68

Bastien's avatar
Bastien committed
69
(defvar dired-buffers)
Rasmus's avatar
Rasmus committed
70
(defvar org-end-time-was-given)
71 72
(defvar org-remember-default-headline)
(defvar org-remember-templates)
Bastien's avatar
Bastien committed
73 74
(defvar org-store-link-plist)
(defvar org-table-border-regexp)
Rasmus's avatar
Rasmus committed
75
(defvar org-table-current-begin-pos)
Bastien's avatar
Bastien committed
76 77 78 79
(defvar org-table-dataline-regexp)
(defvar org-table-fix-formulas-confirm)
(defvar org-table-hline-regexp)
(defvar org-table-hlines)
80 81 82 83 84 85 86 87 88 89 90

(defvar org-capture-clock-was-started nil
  "Internal flag, noting if the clock was started.")

(defvar org-capture-last-stored-marker (make-marker)
  "Marker pointing to the entry most recently stored with `org-capture'.")

;; The following variable is scoped dynamically by org-protocol
;; to indicate that the link properties have already been stored
(defvar org-capture-link-is-already-stored nil)

Rasmus's avatar
Rasmus committed
91 92 93
(defvar org-capture-is-refiling nil
  "Non-nil when capture process is refiling an entry.")

Rasmus's avatar
Rasmus committed
94 95 96 97 98 99
(defvar org-capture--prompt-history-table (make-hash-table :test #'equal)
  "Hash table for all history lists per prompt.")

(defvar org-capture--prompt-history nil
  "History list for prompt placeholders.")

100 101 102 103 104
(defgroup org-capture nil
  "Options concerning capturing new entries."
  :tag "Org Capture"
  :group 'org)

Rasmus's avatar
Rasmus committed
105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134
(defun org-capture-upgrade-templates (templates)
  "Update the template list to the new format.
TEMPLATES is a template list, as in `org-capture-templates'. The
new format unifies all the date/week tree targets into one that
also allows for an optional outline path to specify a target."
  (let ((modified-templates
	 (mapcar
	  (lambda (entry)
	    (pcase entry
	      ;; Match templates with an obsolete "tree" target type. Replace
	      ;; it with common `file+olp-datetree'.  Add new properties
	      ;; (i.e., `:time-prompt' and `:tree-type') if needed.
	      (`(,key ,desc ,type (file+datetree . ,path) ,tpl . ,props)
	       `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl ,@props))
	      (`(,key ,desc ,type (file+datetree+prompt . ,path) ,tpl . ,props)
	       `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl
		      :time-prompt t ,@props))
	      (`(,key ,desc ,type (file+weektree . ,path) ,tpl . ,props)
	       `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl
		      :tree-type week ,@props))
	      (`(,key ,desc ,type (file+weektree+prompt . ,path) ,tpl . ,props)
	       `(,key ,desc ,type (file+olp+datetree ,@path) ,tpl
		      :tree-type week :time-prompt t ,@props))
	      ;; Other templates are left unchanged.
	      (_ entry)))
	  templates)))
    (unless (equal modified-templates templates)
      (message "Deprecated date/weektree capture templates changed to `file+olp+datetree'."))
    modified-templates))

135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156
(defcustom org-capture-templates nil
  "Templates for the creation of new entries.

Each entry is a list with the following items:

keys         The keys that will select the template, as a string, characters
             only, for example \"a\" for a template to be selected with a
             single key, or \"bt\" for selection with two keys.  When using
             several keys, keys using the same prefix key must be together
             in the list and preceded by a 2-element entry explaining the
             prefix key, for example

                     (\"b\" \"Templates for marking stuff to buy\")

             The \"C\" key is used by default for quick access to the
             customization of the template variable.  But if you want to use
             that key for a template, you can.

description  A short string describing the template, will be shown during
             selection.

type         The type of entry.  Valid types are:
Rasmus's avatar
Rasmus committed
157 158 159
               entry       an Org node, with a headline.  Will be filed
                           as the child of the target entry or as a
                           top-level entry.
160 161 162 163
               item        a plain list item, will be placed in the
                           first plain list at the target
                           location.
               checkitem   a checkbox item.  This differs from the
164
                           plain list item only in so far as it uses a
165 166 167 168 169
                           different default template.
               table-line  a new line in the first table at target location.
               plain       text to be inserted as it is.

target       Specification of where the captured item should be placed.
Rasmus's avatar
Rasmus committed
170
             In Org files, targets usually define a node.  Entries will
171 172 173
             become children of this node, other types will be added to the
             table or list in the body of this node.

174 175
             Most target specifications contain a file name.  If that file
             name is the empty string, it defaults to `org-default-notes-file'.
Rasmus's avatar
Rasmus committed
176 177
             A file can also be given as a variable or as a function called
             with no argument.  When an absolute path is not specified for a
Rasmus's avatar
Rasmus committed
178
             target, it is taken as relative to `org-directory'.
179

180 181 182 183 184
             Valid values are:

             (file \"path/to/file\")
                 Text will be placed at the beginning or end of that file

Rasmus's avatar
Rasmus committed
185
             (id \"id of existing Org entry\")
186 187 188 189 190 191
                 File as child of this entry, or in the body of the entry

             (file+headline \"path/to/file\" \"node headline\")
                 Fast configuration if the target heading is unique in the file

             (file+olp \"path/to/file\" \"Level 1 heading\" \"Level 2\" ...)
Rasmus's avatar
Rasmus committed
192
                 For non-unique headings, the full outline path is safer
193 194 195 196

             (file+regexp  \"path/to/file\" \"regexp to find location\")
                 File to the entry matching regexp

Rasmus's avatar
Rasmus committed
197 198 199 200 201 202
             (file+olp+datetree \"path/to/file\" \"Level 1 heading\" ...)
                 Will create a heading in a date tree for today's date.
                 If no heading is given, the tree will be on top level.
                 To prompt for date instead of using TODAY, use the
                 :time-prompt property.  To create a week-tree, use the
                 :tree-type property.
Rasmus's avatar
Rasmus committed
203

204 205 206 207 208 209 210
             (file+function \"path/to/file\" function-finding-location)
                 A function to find the right location in the file

             (clock)
                File to the entry that is currently being clocked

             (function function-finding-location)
Rasmus's avatar
Rasmus committed
211 212
                Most general way: write your own function which both visits
                the file and moves point to the right location
213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236

template     The template for creating the capture item.  If you leave this
             empty, an appropriate default template will be used.  See below
             for more details.  Instead of a string, this may also be one of

                 (file \"/path/to/template-file\")
                 (function function-returning-the-template)

             in order to get a template from a file, or dynamically
             from a function.

The rest of the entry is a property list of additional options.  Recognized
properties are:

 :prepend            Normally newly captured information will be appended at
                     the target location (last child, last table line,
                     last list item...).  Setting this property will
                     change that.

 :immediate-finish   When set, do not offer to edit the information, just
                     file it away immediately.  This makes sense if the
                     template only needs information that can be added
                     automatically.

Bastien Guerry's avatar
Bastien Guerry committed
237 238
 :jump-to-captured   When set, jump to the captured entry when finished.

239 240 241 242
 :empty-lines        Set this to the number of lines the should be inserted
                     before and after the new item.  Default 0, only common
                     other value is 1.

243 244 245 246 247 248 249 250
 :empty-lines-before Set this to the number of lines the should be inserted
                     before the new item.  Overrides :empty-lines for the
                     number lines inserted before.

 :empty-lines-after  Set this to the number of lines the should be inserted
                     after the new item.  Overrides :empty-lines for the
                     number of lines inserted after.

251 252
 :clock-in           Start the clock in this item.

253 254
 :clock-keep         Keep the clock running when filing the captured entry.

255
 :clock-resume       Start the interrupted clock when finishing the capture.
256
                     Note that :clock-keep has precedence over :clock-resume.
257
                     When setting both to t, the current clock will run and
258
                     the previous one will not be resumed.
259

Rasmus's avatar
Rasmus committed
260 261 262 263 264
 :time-prompt        Prompt for a date/time to be used for date/week trees
                     and when filling the template.

 :tree-type          When `week', make a week tree instead of the month tree.

265 266 267 268 269
 :unnarrowed         Do not narrow the target buffer, simply show the
                     full buffer.  Default is to narrow it so that you
                     only see the new stuff.

 :table-line-pos     Specification of the location in the table where the
270 271 272
                     new line should be inserted.  It should be a string like
                     \"II-3\", meaning that the new line should become the
                     third line before the second horizontal separator line.
273

274 275 276 277
 :kill-buffer        If the target file was not yet visited by a buffer when
                     capture was invoked, kill the buffer again after capture
                     is finalized.

Bastien's avatar
Bastien committed
278 279
 :no-save            Do not save the target file after finishing the capture.

280
The template defines the text to be inserted.  Often this is an
Rasmus's avatar
Rasmus committed
281
Org mode entry (so the first line should start with a star) that
282 283
will be filed as a child of the target headline.  It can also be
freely formatted text.  Furthermore, the following %-escapes will
Rasmus's avatar
Rasmus committed
284
be replaced with content and expanded:
285

Rasmus's avatar
Rasmus committed
286 287 288 289
  %[pathname] Insert the contents of the file given by
              `pathname'.  These placeholders are expanded at the very
              beginning of the process so they can be used to extend the
              current template.
Bastien Guerry's avatar
Bastien Guerry committed
290
  %(sexp)     Evaluate elisp `(sexp)' and replace it with the results.
Rasmus's avatar
Rasmus committed
291 292 293 294
              Only placeholders pre-existing within the template, or
              introduced with %[pathname] are expanded this way.  Since this
              happens after expanding non-interactive %-escapes, those can
              be used to fill the expression.
295
  %<...>      The result of format-time-string on the ... format specification.
Rasmus's avatar
Rasmus committed
296 297 298 299
  %t          Time stamp, date only.  The time stamp is the current time,
              except when called from agendas with `\\[org-agenda-capture]' or
              with `org-capture-use-agenda-date' set.
  %T          Time stamp as above, with date and time.
300
  %u, %U      Like the above, but inactive time stamps.
Bastien's avatar
Bastien committed
301 302 303 304
  %i          Initial content, copied from the active region.  If
              there is text before %i on the same line, such as
              indentation, and %i is not inside a %(sexp), that prefix
              will be added before every line in the inserted text.
305 306 307 308 309 310 311
  %a          Annotation, normally the link created with `org-store-link'.
  %A          Like %a, but prompt for the description part.
  %l          Like %a, but only insert the literal link.
  %c          Current kill ring head.
  %x          Content of the X clipboard.
  %k          Title of currently clocked task.
  %K          Link to currently clocked task.
Bastien Guerry's avatar
Bastien Guerry committed
312
  %n          User name (taken from the variable `user-full-name').
313 314 315 316 317 318
  %f          File visited by current buffer when org-capture was called.
  %F          Full path of the file or directory visited by current buffer.
  %:keyword   Specific information for certain link types, see below.
  %^g         Prompt for tags, with completion on tags in target file.
  %^G         Prompt for tags, with completion on all tags in all agenda files.
  %^t         Like %t, but prompt for date.  Similarly %^T, %^u, %^U.
Rasmus's avatar
Rasmus committed
319 320
              You may define a prompt like: %^{Please specify birthday}t.
              The default date is that of %t, see above.
321 322 323 324
  %^C         Interactive selection of which kill or clip to use.
  %^L         Like %^C, but insert as link.
  %^{prop}p   Prompt the user for a value for property `prop'.
  %^{prompt}  Prompt the user for a string and replace this sequence with it.
325 326
              A default value and a completion table ca be specified like this:
              %^{prompt|default|completion2|completion3|...}.
327
  %?          After completing the template, position cursor here.
Rasmus's avatar
Rasmus committed
328 329
  %\\1 ... %\\N Insert the text entered at the nth %^{prompt}, where N
              is a number, starting from 1.
330

331 332 333
Apart from these general escapes, you can access information specific to
the link type that is created.  For example, calling `org-capture' in emails
or in Gnus will record the author and the subject of the message, which you
334
can access with \"%:from\" and \"%:subject\", respectively.  Here is a
335 336
complete list of what is recorded for each link type.

337 338 339
Link type               |  Available information
------------------------+------------------------------------------------------
bbdb                    |  %:type %:name %:company
340 341
vm, wl, mh, mew, rmail, |  %:type %:subject %:message-id
gnus                    |  %:from %:fromname %:fromaddress
342 343
                        |  %:to   %:toname   %:toaddress
                        |  %:fromto (either \"to NAME\" or \"from NAME\")
344
                        |  %:date %:date-timestamp (as active timestamp)
345 346
                        |  %:date-timestamp-inactive (as inactive timestamp)
gnus                    |  %:group, for messages also all email fields
Rasmus's avatar
Rasmus committed
347
eww, w3, w3m            |  %:type %:url
348
info                    |  %:type %:file %:node
Rasmus's avatar
Rasmus committed
349 350 351 352
calendar                |  %:type %:date

When you need to insert a literal percent sign in the template,
you can escape ambiguous cases with a backward slash, e.g., \\%i."
353
  :group 'org-capture
354
  :version "24.1"
Rasmus's avatar
Rasmus committed
355
  :set (lambda (s v) (set s (org-capture-upgrade-templates v)))
356
  :type
Rasmus's avatar
Rasmus committed
357 358 359 360 361 362
  (let ((file-variants '(choice :tag "Filename       "
				(file :tag "Literal")
				(function :tag "Function")
				(variable :tag "Variable")
				(sexp :tag "Form"))))
  `(repeat
363
    (choice :value ("" "" entry (file "~/org/notes.org") "")
364 365 366 367 368 369 370 371 372 373 374 375 376 377 378
	    (list :tag "Multikey description"
		  (string :tag "Keys       ")
		  (string :tag "Description"))
	    (list :tag "Template entry"
		  (string :tag "Keys           ")
		  (string :tag "Description    ")
		  (choice :tag "Capture Type   " :value entry
			  (const :tag "Org entry" entry)
			  (const :tag "Plain list item" item)
			  (const :tag "Checkbox item" checkitem)
			  (const :tag "Plain text" plain)
			  (const :tag "Table line" table-line))
		  (choice :tag "Target location"
			  (list :tag "File"
				(const :format "" file)
Rasmus's avatar
Rasmus committed
379
				,file-variants)
380 381 382 383 384
			  (list :tag "ID"
				(const :format "" id)
				(string :tag "  ID"))
			  (list :tag "File & Headline"
				(const :format "" file+headline)
Rasmus's avatar
Rasmus committed
385
				,file-variants
386 387 388
				(string :tag "  Headline"))
			  (list :tag "File & Outline path"
				(const :format "" file+olp)
Rasmus's avatar
Rasmus committed
389
				,file-variants
390 391 392 393
				(repeat :tag "Outline path" :inline t
					(string :tag "Headline")))
			  (list :tag "File & Regexp"
				(const :format "" file+regexp)
Rasmus's avatar
Rasmus committed
394
				,file-variants
395
				(regexp :tag "  Regexp"))
Rasmus's avatar
Rasmus committed
396 397 398 399 400
			  (list :tag "File [ & Outline path ] & Date tree"
				(const :format "" file+olp+datetree)
				,file-variants
				(option (repeat :tag "Outline path" :inline t
						(string :tag "Headline"))))
401 402
			  (list :tag "File & function"
				(const :format "" file+function)
Rasmus's avatar
Rasmus committed
403
				,file-variants
404 405 406 407 408 409
				(sexp :tag "  Function"))
			  (list :tag "Current clocking task"
				(const :format "" clock))
			  (list :tag "Function"
				(const :format "" function)
				(sexp :tag "  Function")))
Rasmus's avatar
Rasmus committed
410
		  (choice :tag "Template       "
411 412 413 414 415 416 417 418 419 420 421
			  (string)
			  (list :tag "File"
				(const :format "" file)
				(file :tag "Template file"))
			  (list :tag "Function"
				(const :format "" function)
				(function :tag "Template function")))
		  (plist :inline t
			 ;; Give the most common options as checkboxes
			 :options (((const :format "%v " :prepend) (const t))
				   ((const :format "%v " :immediate-finish) (const t))
Bastien Guerry's avatar
Bastien Guerry committed
422
				   ((const :format "%v " :jump-to-captured) (const t))
423
				   ((const :format "%v " :empty-lines) (const 1))
Bastien Guerry's avatar
Bastien Guerry committed
424 425
				   ((const :format "%v " :empty-lines-before) (const 1))
				   ((const :format "%v " :empty-lines-after) (const 1))
426 427 428
				   ((const :format "%v " :clock-in) (const t))
				   ((const :format "%v " :clock-keep) (const t))
				   ((const :format "%v " :clock-resume) (const t))
Rasmus's avatar
Rasmus committed
429 430
				   ((const :format "%v " :time-prompt) (const t))
				   ((const :format "%v " :tree-type) (const week))
431
				   ((const :format "%v " :unnarrowed) (const t))
Rasmus's avatar
Rasmus committed
432
				   ((const :format "%v " :table-line-pos) (string))
Rasmus's avatar
Rasmus committed
433
				   ((const :format "%v " :kill-buffer) (const t)))))))))
434 435

(defcustom org-capture-before-finalize-hook nil
436
  "Hook that is run right before a capture process is finalized.
Bastien Guerry's avatar
Bastien Guerry committed
437 438
The capture buffer is still current when this hook runs and it is
widened to the entire buffer."
439
  :group 'org-capture
440
  :version "24.1"
441 442
  :type 'hook)

Carsten Dominik's avatar
Carsten Dominik committed
443 444
(defcustom org-capture-after-finalize-hook nil
  "Hook that is run right after a capture process is finalized.
445 446 447 448 449 450 451 452
Suitable for window cleanup."
  :group 'org-capture
  :version "24.1"
  :type 'hook)

(defcustom org-capture-prepare-finalize-hook nil
  "Hook that is run before the finalization starts.
The capture buffer is current and still narrowed."
Carsten Dominik's avatar
Carsten Dominik committed
453
  :group 'org-capture
454
  :version "24.1"
Carsten Dominik's avatar
Carsten Dominik committed
455 456
  :type 'hook)

457 458 459 460 461 462 463
(defcustom org-capture-bookmark t
  "When non-nil, add a bookmark pointing at the last stored
position when capturing."
  :group 'org-capture
  :version "24.3"
  :type 'boolean)

464 465 466 467
;;; The property list for keeping information about the capture process

(defvar org-capture-plist nil
  "Plist for the current capture process, global, to avoid having to pass it.")
468

469 470
(defvar org-capture-current-plist nil
  "Local variable holding the plist in a capture buffer.
471 472 473 474 475 476 477 478 479
This is used to store the plist for use when finishing a capture process
because another such process might have changed the global variable by then.

Each time a new capture buffer has been set up, the global `org-capture-plist'
is copied to this variable, which is local in the indirect buffer.")

(defvar org-capture-clock-keep nil
  "Local variable to store the value of the :clock-keep parameter.
This is needed in case org-capture-finalize is called interactively.")
480 481

(defun org-capture-put (&rest stuff)
482
  "Add properties to the capture property list `org-capture-plist'."
483 484 485 486
  (while stuff
    (setq org-capture-plist (plist-put org-capture-plist
				       (pop stuff) (pop stuff)))))
(defun org-capture-get (prop &optional local)
487 488 489 490
  "Get properties from the capture property list `org-capture-plist'.
When LOCAL is set, use the local variable `org-capture-current-plist',
this is necessary after initialization of the capture process,
to avoid conflicts with other active capture processes."
491 492 493 494
  (plist-get (if local org-capture-current-plist org-capture-plist) prop))

;;; The minor mode

Bastien's avatar
Bastien committed
495 496 497 498 499 500
(defvar org-capture-mode-map
  (let ((map (make-sparse-keymap)))
    (define-key map "\C-c\C-c" #'org-capture-finalize)
    (define-key map "\C-c\C-k" #'org-capture-kill)
    (define-key map "\C-c\C-w" #'org-capture-refile)
    map)
501
  "Keymap for `org-capture-mode', a minor mode.
Rasmus's avatar
Rasmus committed
502
Use this map to set additional keybindings for when Org mode is used
503
for a capture buffer.")
504 505

(defvar org-capture-mode-hook nil
Bastien's avatar
Bastien committed
506
  "Hook for the `org-capture-mode' minor mode.")
507 508

(define-minor-mode org-capture-mode
509 510 511
  "Minor mode for special key bindings in a capture buffer.

Turning on this mode runs the normal hook `org-capture-mode-hook'."
Bastien's avatar
Bastien committed
512
  nil " Cap" org-capture-mode-map
Rasmus's avatar
Rasmus committed
513 514
  (setq-local
   header-line-format
Paul Eggert's avatar
Paul Eggert committed
515
   (substitute-command-keys
Rasmus's avatar
Rasmus committed
516 517 518
    "\\<org-capture-mode-map>Capture buffer.  Finish \
`\\[org-capture-finalize]', refile `\\[org-capture-refile]', \
abort `\\[org-capture-kill]'.")))
519 520 521

;;; The main commands

522 523
(defvar org-capture-initial nil)
(defvar org-capture-entry nil)
524 525

;;;###autoload
526
(defun org-capture-string (string &optional keys)
Bastien Guerry's avatar
Bastien Guerry committed
527
  "Capture STRING with the template selected by KEYS."
528 529 530 531 532 533 534 535 536 537 538 539
  (interactive "sInitial text: \n")
  (let ((org-capture-initial string)
	(org-capture-entry (org-capture-select-template keys)))
    (org-capture)))

(defcustom org-capture-templates-contexts nil
  "Alist of capture templates and valid contexts.

For example, if you have a capture template \"c\" and you want
this template to be accessible only from `message-mode' buffers,
use this:

Rasmus's avatar
Rasmus committed
540
   \\='((\"c\" ((in-mode . \"message-mode\"))))
541 542 543 544 545 546 547

Here are the available contexts definitions:

      in-file: command displayed only in matching files
      in-mode: command displayed only in matching modes
  not-in-file: command not displayed in matching files
  not-in-mode: command not displayed in matching modes
Bastien Guerry's avatar
Bastien Guerry committed
548 549
    in-buffer: command displayed only in matching buffers
not-in-buffer: command not displayed in matching buffers
550 551 552 553 554
   [function]: a custom function taking no argument

If you define several checks, the agenda command will be
accessible if there is at least one valid check.

Rasmus's avatar
Rasmus committed
555 556
You can also bind a key to another capture template depending on
contextual rules.
557

Rasmus's avatar
Rasmus committed
558
    \\='((\"c\" \"d\" ((in-mode . \"message-mode\"))))
559

560
Here it means: in `message-mode buffers', use \"c\" as the
561
key for the capture template otherwise associated with \"d\".
562
\(The template originally associated with \"d\" is not displayed
563 564 565 566 567 568 569 570 571 572 573 574
to avoid duplicates.)"
  :version "24.3"
  :group 'org-capture
  :type '(repeat (list :tag "Rule"
		       (string :tag "        Capture key")
		       (string :tag "Replace by template")
		       (repeat :tag "Available when"
			      (choice
			       (cons :tag "Condition"
				     (choice
				      (const :tag "In file" in-file)
				      (const :tag "Not in file" not-in-file)
Bastien Guerry's avatar
Bastien Guerry committed
575 576
				      (const :tag "In buffer" in-buffer)
				      (const :tag "Not in buffer" not-in-buffer)
577 578 579 580 581 582 583
				      (const :tag "In mode" in-mode)
				      (const :tag "Not in mode" not-in-mode))
				     (regexp))
			       (function :tag "Custom function"))))))

(defcustom org-capture-use-agenda-date nil
  "Non-nil means use the date at point when capturing from agendas.
Rasmus's avatar
Rasmus committed
584 585
When nil, you can still capture using the date at point with
`\\[org-agenda-capture]'."
586 587 588 589
  :group 'org-capture
  :version "24.3"
  :type 'boolean)

590 591 592 593
;;;###autoload
(defun org-capture (&optional goto keys)
  "Capture something.
\\<org-capture-mode-map>
Rasmus's avatar
Rasmus committed
594 595 596 597 598 599 600 601 602 603 604 605 606 607
This will let you select a template from `org-capture-templates', and
then file the newly captured information.  The text is immediately
inserted at the target location, and an indirect buffer is shown where
you can edit it.  Pressing `\\[org-capture-finalize]' brings you back to the \
previous
state of Emacs, so that you can continue your work.

When called interactively with a `\\[universal-argument]' prefix argument \
GOTO, don't
capture anything, just go to the file/headline where the selected
template stores its notes.

With a `\\[universal-argument] \\[universal-argument]' prefix argument, go to \
the last note stored.
608 609 610

When called with a `C-0' (zero) prefix, insert a template at point.

Rasmus's avatar
Rasmus committed
611 612 613
When called with a `C-1' (one) prefix, force prompting for a date when
a datetree entry is made.

Bastien Guerry's avatar
Bastien Guerry committed
614
ELisp programs can set KEYS to a string associated with a template
615 616 617 618
in `org-capture-templates'.  In this case, interactive selection
will be bypassed.

If `org-capture-use-agenda-date' is non-nil, capturing from the
Bastien Guerry's avatar
Bastien Guerry committed
619 620 621
agenda will use the date at point as the default date.  Then, a
`C-1' prefix will tell the capture process to use the HH:MM time
of the day at point (if any) or the current HH:MM time."
622
  (interactive "P")
623 624 625
  (when (and org-capture-use-agenda-date
	     (eq major-mode 'org-agenda-mode))
    (setq org-overriding-default-time
Bastien Guerry's avatar
Bastien Guerry committed
626
	  (org-get-cursor-date (equal goto 1))))
627 628 629 630 631 632 633 634
  (cond
   ((equal goto '(4)) (org-capture-goto-target))
   ((equal goto '(16)) (org-capture-goto-last-stored))
   (t
    (let* ((orig-buf (current-buffer))
	   (annotation (if (and (boundp 'org-capture-link-is-already-stored)
				org-capture-link-is-already-stored)
			   (plist-get org-store-link-plist :annotation)
635
			 (ignore-errors (org-store-link nil))))
636 637 638 639 640
	   (entry (or org-capture-entry (org-capture-select-template keys)))
	   initial)
      (setq initial (or org-capture-initial
			(and (org-region-active-p)
			     (buffer-substring (point) (mark)))))
641 642 643 644 645
      (when (stringp initial)
	(remove-text-properties 0 (length initial) '(read-only t) initial))
      (when (stringp annotation)
	(remove-text-properties 0 (length annotation)
				'(read-only t) annotation))
646 647 648 649
      (cond
       ((equal entry "C")
	(customize-variable 'org-capture-templates))
       ((equal entry "q")
Rasmus's avatar
Rasmus committed
650
	(user-error "Abort"))
651 652 653
       (t
	(org-capture-set-plist entry)
	(org-capture-get-template)
654 655 656 657 658 659 660 661 662 663
	(org-capture-put :original-buffer orig-buf
			 :original-file (or (buffer-file-name orig-buf)
					    (and (featurep 'dired)
						 (car (rassq orig-buf
							     dired-buffers))))
			 :original-file-nondirectory
			 (and (buffer-file-name orig-buf)
			      (file-name-nondirectory
			       (buffer-file-name orig-buf)))
			 :annotation annotation
Bastien Guerry's avatar
Bastien Guerry committed
664 665
			 :initial initial
			 :return-to-wconf (current-window-configuration)
Bastien's avatar
Bastien committed
666 667 668
			 :default-time (or org-overriding-default-time
					   (org-current-time)))
	(org-capture-set-target-location (and (equal goto 0) 'here))
669 670 671 672
	(condition-case error
	    (org-capture-put :template (org-capture-fill-template))
	  ((error quit)
	   (if (get-buffer "*Capture*") (kill-buffer "*Capture*"))
Bastien's avatar
Bastien committed
673
	   (error "Capture abort: %s" (error-message-string error))))
674

675
	(setq org-capture-clock-keep (org-capture-get :clock-keep))
Bastien's avatar
Bastien committed
676 677 678 679 680
	(condition-case error
	    (org-capture-place-template
	     (eq (car (org-capture-get :target)) 'function))
	  ((error quit)
	   (when (and (buffer-base-buffer (current-buffer))
Rasmus's avatar
Rasmus committed
681
		      (string-prefix-p "CAPTURE-" (buffer-name)))
Bastien's avatar
Bastien committed
682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697
	     (kill-buffer (current-buffer)))
	   (set-window-configuration (org-capture-get :return-to-wconf))
	   (error "Capture template `%s': %s"
		  (org-capture-get :key)
		  (error-message-string error))))
	(when (and (derived-mode-p 'org-mode) (org-capture-get :clock-in))
	  (condition-case nil
	      (progn
		(when (org-clock-is-active)
		  (org-capture-put :interrupted-clock
				   (copy-marker org-clock-marker)))
		(org-clock-in)
		(setq-local org-capture-clock-was-started t))
	    (error "Could not start the clock in this capture buffer")))
	(when (org-capture-get :immediate-finish)
	  (org-capture-finalize))))))))
698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716

(defun org-capture-get-template ()
  "Get the template from a file or a function if necessary."
  (let ((txt (org-capture-get :template)) file)
    (cond
     ((and (listp txt) (eq (car txt) 'file))
      (if (file-exists-p
	   (setq file (expand-file-name (nth 1 txt) org-directory)))
	  (setq txt (org-file-contents file))
	(setq txt (format "* Template file %s not found" (nth 1 txt)))))
     ((and (listp txt) (eq (car txt) 'function))
      (if (fboundp (nth 1 txt))
	  (setq txt (funcall (nth 1 txt)))
	(setq txt (format "* Template function %s not found" (nth 1 txt)))))
     ((not txt) (setq txt ""))
     ((stringp txt))
     (t (setq txt "* Invalid capture template")))
    (org-capture-put :template txt)))

Carsten Dominik's avatar
Carsten Dominik committed
717 718 719 720 721
(defun org-capture-finalize (&optional stay-with-capture)
  "Finalize the capture process.
With prefix argument STAY-WITH-CAPTURE, jump to the location of the
captured item after finalizing."
  (interactive "P")
Bastien Guerry's avatar
Bastien Guerry committed
722 723
  (when (org-capture-get :jump-to-captured)
    (setq stay-with-capture t))
724 725
  (unless (and org-capture-mode
	       (buffer-base-buffer (current-buffer)))
Rasmus's avatar
Rasmus committed
726
    (error "This does not seem to be a capture buffer for Org mode"))
727

728 729
  (run-hooks 'org-capture-prepare-finalize-hook)

730 731
  ;; Did we start the clock in this capture buffer?
  (when (and org-capture-clock-was-started
Rasmus's avatar
Rasmus committed
732 733 734
	     org-clock-marker
	     (eq (marker-buffer org-clock-marker) (buffer-base-buffer))
	     (>= org-clock-marker (point-min))
735
	     (< org-clock-marker (point-max)))
Rasmus's avatar
Rasmus committed
736 737 738 739 740 741 742 743 744 745 746 747 748 749
    ;; Looks like the clock we started is still running.
    (if org-capture-clock-keep
	;; User may have completed clocked heading from the template.
	;; Refresh clock mode line.
	(org-clock-update-mode-line t)
      ;; Clock out.  Possibly resume interrupted clock.
      (let (org-log-note-clock-out) (org-clock-out))
      (when (and (org-capture-get :clock-resume 'local)
		 (markerp (org-capture-get :interrupted-clock 'local))
		 (buffer-live-p (marker-buffer
				 (org-capture-get :interrupted-clock 'local))))
	(let ((clock-in-task (org-capture-get :interrupted-clock 'local)))
	  (org-with-point-at clock-in-task (org-clock-in)))
	(message "Interrupted clock has been resumed"))))
750

Bastien's avatar
Bastien committed
751
  (let ((abort-note nil))
752 753
    ;; Store the size of the capture buffer
    (org-capture-put :captured-entry-size (- (point-max) (point-min)))
754
    (widen)
755 756
    ;; Store the insertion point in the target buffer
    (org-capture-put :insertion-point (point))
757 758

    (if org-note-abort
Bastien's avatar
Bastien committed
759 760 761 762 763
	(let ((beg (org-capture-get :begin-marker 'local))
	      (end (org-capture-get :end-marker 'local)))
	  (if (not (and beg end)) (setq abort-note 'dirty)
	    (setq abort-note t)
	    (org-with-wide-buffer (kill-region beg end))))
764 765

      ;; Postprocessing:  Update Statistics cookies, do the sorting
766
      (when (derived-mode-p 'org-mode)
767 768 769 770 771 772 773 774
	(save-excursion
	  (when (ignore-errors (org-back-to-heading))
	    (org-update-parent-todo-statistics)
	    (org-update-checkbox-count)))
	;; FIXME Here we should do the sorting
	;; If we have added a table line, maybe recompute?
	(when (and (eq (org-capture-get :type 'local) 'table-line)
		   (org-at-table-p))
Bastien's avatar
Bastien committed
775 776 777 778 779 780 781 782 783 784 785 786 787 788 789
	  (if (not (org-table-get-stored-formulas)) (org-table-align)
	    ;; Adjust formulas, if necessary.  We assume a non-nil
	    ;; `:immediate-finish' means that no confirmation is
	    ;; required.  Else, obey `org-table-fix-formulas-confirm'.
	    ;;
	    ;; The delta required to fix formulas depends on the
	    ;; number of rows inserted by the template.
	    (when (or (org-capture-get :immediate-finish)
		      (not org-table-fix-formulas-confirm)
		      (funcall org-table-fix-formulas-confirm "Fix formulas? "))
	      (org-table-fix-formulas
	       "@" nil (1- (org-table-current-dline))
	       (count-lines (org-capture-get :begin-marker 'local)
			    (org-capture-get :end-marker 'local))))
	    (org-table-recalculate 'all)))) ;FIXME: should we iterate?
790 791 792
      ;; Store this place as the last one where we stored something
      ;; Do the marking in the base buffer, so that it makes sense after
      ;; the indirect buffer has been killed.
Rasmus's avatar
Rasmus committed
793
      (org-capture-store-last-position)
794 795

      ;; Run the hook
796
      (run-hooks 'org-capture-before-finalize-hook))
797

798 799 800 801 802
    (when (org-capture-get :decrypted)
      (save-excursion
	(goto-char (org-capture-get :decrypted))
	(org-encrypt-entry)))

Bastien's avatar
Bastien committed
803 804
    (unless (org-capture-get :no-save) (save-buffer))

805 806 807 808 809
    (let ((return-wconf (org-capture-get :return-to-wconf 'local))
	  (new-buffer (org-capture-get :new-buffer 'local))
	  (kill-buffer (org-capture-get :kill-buffer 'local))
	  (base-buffer (buffer-base-buffer (current-buffer))))

810
      ;; Kill the indirect buffer
811
      (kill-buffer (current-buffer))
812

813 814 815 816 817 818
      ;; Narrow back the target buffer to its previous state
      (with-current-buffer (org-capture-get :buffer)
        (let ((reg (org-capture-get :initial-target-region))
	      (pos (org-capture-get :initial-target-position))
	      (ipt (org-capture-get :insertion-point))
	      (size (org-capture-get :captured-entry-size)))
Bastien Guerry's avatar
Bastien Guerry committed
819 820
	  (if (not reg)
	      (widen)
821 822 823 824 825 826 827 828 829 830 831 832 833 834
	    (cond ((< ipt (car reg))
		   ;; insertion point is before the narrowed region
		   (narrow-to-region (+ size (car reg)) (+ size (cdr reg))))
		  ((> ipt (cdr reg))
		   ;; insertion point is after the narrowed region
		   (narrow-to-region (car reg) (cdr reg)))
		  (t
		   ;; insertion point is within the narrowed region
		   (narrow-to-region (car reg) (+ size (cdr reg)))))
	    ;; now place back the point at its original position
	    (if (< ipt (car reg))
		(goto-char (+ size pos))
	      (goto-char (if (< ipt pos) (+ size pos) pos))))))

835 836 837 838 839
      ;; Kill the target buffer if that is desired
      (when (and base-buffer new-buffer kill-buffer)
	(with-current-buffer base-buffer (save-buffer))
	(kill-buffer base-buffer))

840 841
      ;; Restore the window configuration before capture
      (set-window-configuration return-wconf))
Carsten Dominik's avatar
Carsten Dominik committed
842 843 844 845 846

    (run-hooks 'org-capture-after-finalize-hook)
    ;; Special cases
    (cond
     (abort-note
Rasmus's avatar
Rasmus committed
847 848 849 850 851 852
      (cl-case abort-note
	(clean
	 (message "Capture process aborted and target buffer cleaned up"))
	(dirty
	 (error "Capture process aborted, but target buffer could not be \
cleaned up correctly"))))
Carsten Dominik's avatar
Carsten Dominik committed
853 854 855 856
     (stay-with-capture
      (org-capture-goto-last-stored)))
    ;; Return if we did store something
    (not abort-note)))
857 858 859 860

(defun org-capture-refile ()
  "Finalize the current capture and then refile the entry.
Refiling is done from the base buffer, because the indirect buffer is then
861
already gone.  Any prefix argument will be passed to the refile command."
862 863
  (interactive)
  (unless (eq (org-capture-get :type 'local) 'entry)
Rasmus's avatar
Rasmus committed
864 865 866 867 868
    (user-error "Refiling from a capture buffer makes only sense \
for `entry'-type templates"))
  (let* ((base (or (buffer-base-buffer) (current-buffer)))
	 (pos (make-marker))
	 (org-capture-is-refiling t)
Rasmus's avatar
Rasmus committed
869 870
	 (kill-buffer (org-capture-get :kill-buffer 'local))
	 (jump-to-captured (org-capture-get :jump-to-captured 'local)))
Rasmus's avatar
Rasmus committed
871 872 873 874 875
    ;; Since `org-capture-finalize' may alter buffer contents (e.g.,
    ;; empty lines) around entry, use a marker to refer to the
    ;; headline to be refiled.  Place the marker in the base buffer,
    ;; as the current indirect one is going to be killed.
    (set-marker pos (save-excursion (org-back-to-heading t) (point)) base)
Rasmus's avatar
Rasmus committed
876 877 878 879
    ;; `org-capture-finalize' calls `org-capture-goto-last-stored' too
    ;; early.  We want to wait for the refiling to be over, so we
    ;; control when the latter function is called.
    (org-capture-put :kill-buffer nil :jump-to-captured nil)
Bastien's avatar
Bastien committed
880 881 882 883 884 885 886 887 888
    (org-capture-finalize)
    (save-window-excursion
      (with-current-buffer base
	(org-with-point-at pos
	  (call-interactively 'org-refile))))
    (when kill-buffer
      (with-current-buffer base (save-buffer))
      (kill-buffer base))
    (when jump-to-captured (org-capture-goto-last-stored))))
889 890 891 892

(defun org-capture-kill ()
  "Abort the current capture process."
  (interactive)
893 894
  ;; FIXME: This does not do the right thing, we need to remove the
  ;; new stuff by hand it is easy: undo, then kill the buffer
895 896
  (let ((org-note-abort t)
	(org-capture-before-finalize-hook nil))
897 898 899
    (org-capture-finalize)))

(defun org-capture-goto-last-stored ()
900
  "Go to the location where the last capture note was stored."
901 902
  (interactive)
  (org-goto-marker-or-bmk org-capture-last-stored-marker
Rasmus's avatar
Rasmus committed
903 904
			  (plist-get org-bookmark-names-plist
				 :last-capture))
905 906 907 908
  (message "This is the last note stored by a capture process"))

;;; Supporting functions for handling the process

909 910 911 912 913
(defun org-capture-put-target-region-and-position ()
  "Store the initial region with `org-capture-put'."
  (org-capture-put
   :initial-target-region
   ;; Check if the buffer is currently narrowed
Rasmus's avatar
Rasmus committed
914
   (when (org-buffer-narrowed-p)
915 916 917 918
     (cons (point-min) (point-max))))
  ;; store the current point
  (org-capture-put :initial-target-position (point)))

919
(defvar org-time-was-given) ; dynamically scoped parameter
920
(defun org-capture-set-target-location (&optional target)
921 922
  "Find TARGET buffer and position.
Store them in the capture property list."
Rasmus's avatar
Rasmus committed
923
  (let ((target-entry-p t))
924
    (save-excursion
Rasmus's avatar
Rasmus committed
925
      (pcase (or target (org-capture-get :target))
Bastien's avatar
Bastien committed
926 927
	(`here
	 (org-capture-put :exact-position (point) :insert-here t))
Rasmus's avatar
Rasmus committed
928 929 930 931 932 933 934 935 936
	(`(file ,path)
	 (set-buffer (org-capture-target-buffer path))
	 (org-capture-put-target-region-and-position)
	 (widen)
	 (setq target-entry-p nil))
	(`(id ,id)
	 (pcase (org-id-find id)
	   (`(,path . ,position)
	    (set-buffer (org-capture-target-buffer path))
937 938
	    (widen)
	    (org-capture-put-target-region-and-position)
Rasmus's avatar
Rasmus committed
939 940 941 942
	    (goto-char position))
	   (_ (error "Cannot find target ID \"%s\"" id))))
	(`(file+headline ,path ,headline)
	 (set-buffer (org-capture-target-buffer path))
Rasmus's avatar
Rasmus committed
943 944 945 946
	 ;; Org expects the target file to be in Org mode, otherwise
	 ;; it throws an error.  However, the default notes files
	 ;; should work out of the box.  In this case, we switch it to
	 ;; Org mode.
Rasmus's avatar
Rasmus committed
947
	 (unless (derived-mode-p 'org-mode)
Rasmus's avatar
Rasmus committed
948 949 950 951
	   (org-display-warning
	    (format "Capture requirement: switching buffer %S to Org mode"
		    (current-buffer)))
	   (org-mode))
Rasmus's avatar
Rasmus committed
952 953 954 955 956 957
	 (org-capture-put-target-region-and-position)
	 (widen)
	 (goto-char (point-min))
	 (if (re-search-forward (format org-complex-heading-regexp-format
					(regexp-quote headline))
				nil t)
Rasmus's avatar
Rasmus committed
958
	     (beginning-of-line)
Rasmus's avatar
Rasmus committed
959
	   (goto-char (point-max))
Rasmus's avatar
Rasmus committed
960
	   (unless (bolp) (insert "\n"))
Rasmus's avatar
Rasmus committed
961 962 963 964 965 966 967 968 969 970 971 972 973 974 975 976 977 978 979 980 981 982 983 984 985 986 987 988 989 990 991 992 993 994 995 996 997 998 999 1000 1001 1002 1003 1004 1005 1006 1007 1008 1009 1010 1011 1012
	   (insert "* " headline "\n")
	   (beginning-of-line 0)))
	(`(file+olp ,path . ,outline-path)
	 (let ((m (org-find-olp (cons (org-capture-expand-file path)
				      outline-path))))
	   (set-buffer (marker-buffer m))
	   (org-capture-put-target-region-and-position)
	   (widen)
	   (goto-char m)
	   (set-marker m nil)))
	(`(file+regexp ,path ,regexp)
	 (set-buffer (org-capture-target-buffer path))
	 (org-capture-put-target-region-and-position)
	 (widen)
	 (goto-char (point-min))
	 (if (not (re-search-forward regexp nil t))
	     (error "No match for target regexp in file %s" path)
	   (goto-char (if (org-capture-get :prepend)
			  (match-beginning 0)
			(match-end 0)))
	   (org-capture-put :exact-position (point))
	   (setq target-entry-p
		 (and (derived-mode-p 'org-mode) (org-at-heading-p)))))
	(`(file+olp+datetree ,path . ,outline-path)
	 (let ((m (if outline-path
		      (org-find-olp (cons (org-capture-expand-file path)
					  outline-path))
		    (set-buffer (org-capture-target-buffer path))
		    (point-marker))))
	   (set-buffer (marker-buffer m))
	   (org-capture-put-target-region-and-position)
	   (widen)
	   (goto-char m)
	   (set-marker m nil)
	   (require 'org-datetree)
	   (org-capture-put-target-region-and-position)
	   (widen)
	   ;; Make a date/week tree entry, with the current date (or
	   ;; yesterday, if we are extending dates for a couple of hours)
	   (funcall
	    (if (eq (org-capture-get :tree-type) 'week)
		#'org-datetree-find-iso-week-create
	      #'org-datetree-find-date-create)
	    (calendar-gregorian-from-absolute
	     (cond
	      (org-overriding-default-time
	       ;; Use the overriding default time.
	       (time-to-days org-overriding-default-time))
	      ((or (org-capture-get :time-prompt)
		   (equal current-prefix-arg 1))
	       ;; Prompt for date.
	       (let ((prompt-time (org-read-date
Bastien's avatar
Bastien committed
1013
				   nil t nil "Date for tree entry:")))
Rasmus's avatar
Rasmus committed
1014 1015 1016 1017 1018 1019 1020
		 (org-capture-put
		  :default-time
		  (cond ((and (or (not (boundp 'org-time-was-given))
				  (not org-time-was-given))
			      (not (= (time-to-days prompt-time) (org-today))))
			 ;; Use 00:00 when no time is given for another
			 ;; date than today?
Bastien's avatar
Bastien committed
1021 1022
			 (apply #'encode-time 0 0
				org-extend-today-until
Paul Eggert's avatar
Paul Eggert committed
1023
				(cl-cdddr (decode-time prompt-time))))
1024
			((string-match "\\([^ ]+\\)-[^ ]+[ ]+\\(.*\\)"
Rasmus's avatar
Rasmus committed
1025 1026 1027 1028 1029 1030 1031 1032 1033 1034 1035 1036 1037 1038 1039
				       org-read-date-final-answer)
			 ;; Replace any time range by its start.
			 (apply #'encode-time
				(org-read-date-analyze
				 (replace-match "\\1 \\2" nil nil
						org-read-date-final-answer)
				 prompt-time (decode-time prompt-time))))
			(t prompt-time)))
		 (time-to-days prompt-time)))
	      (t
	       ;; Current date, possibly corrected for late night
	       ;; workers.
	       (org-today))))
	    ;; the following is the keep-restriction argument for
	    ;; org-datetree-find-date-create
Bastien's avatar
Bastien committed
1040
	    (when outline-path 'subtree-at-point))))
Rasmus's avatar
Rasmus committed
1041 1042 1043 1044 1045 1046 1047 1048 1049 1050 1051 1052 1053 1054 1055 1056 1057 1058 1059 1060 1061 1062 1063 1064 1065
	(`(file+function ,path ,function)
	 (set-buffer (org-capture-target-buffer path))
	 (org-capture-put-target-region-and-position)
	 (widen)
	 (funcall function)
	 (org-capture-put :exact-position (point))
	 (setq target-entry-p
	       (and (derived-mode-p 'org-mode) (org-at-heading-p))))
	(`(function ,fun)
	 (funcall fun)
	 (org-capture-put :exact-position (point))
	 (setq target-entry-p
	       (and (derived-mode-p 'org-mode) (org-at-heading-p))))
	(`(clock)
	 (if (and (markerp org-clock-hd-marker)
		  (marker-buffer org-clock-hd-marker))
	     (progn (set-buffer (marker-buffer org-clock-hd-marker))
		    (org-capture-put-target-region-and-position)
		    (widen)
		    (goto-char org-clock-hd-marker))
	   (error "No running clock that could be used as capture target")))
	(target (error "Invalid capture target specification: %S" target)))

      (org-capture-put :buffer (current-buffer)
		       :pos (point)
1066
		       :target-entry-p target-entry-p
Rasmus's avatar
Rasmus committed
1067 1068 1069 1070 1071 1072
		       :decrypted
		       (and (featurep 'org-crypt)
			    (org-at-encrypted-entry-p)
			    (save-excursion
			      (org-decrypt-entry)
			      (and (org-back-to-heading t) (point))))))))
1073

1074
(defun org-capture-expand-file (file)
Rasmus's avatar
Rasmus committed
1075
  "Expand functions, symbols and file names for FILE.
1076
When FILE is a function, call it.  When it is a form, evaluate
Rasmus's avatar
Rasmus committed
1077
it.  When it is a variable, return its value.  When it is
Rasmus's avatar
Rasmus committed
1078 1079 1080 1081
a string, treat it as a file name, possibly expanding it
according to `org-directory', and return it.  If it is the empty
string, however, return `org-default-notes-file'.  In any other
case, raise an error."
Rasmus's avatar
Rasmus committed
1082 1083 1084 1085 1086 1087 1088
  (let ((location (cond ((equal file "") org-default-notes-file)
			((stringp file) (expand-file-name file org-directory))
			((functionp file) (funcall file))
			((and (symbolp file) (boundp file)) (symbol-value file))
			(t nil))))
    (or (org-string-nw-p location)
	(error "Invalid file location: %S" location))))
1089

1090
(defun org-capture-target-buffer (file)
Rasmus's avatar
Rasmus committed
1091 1092 1093
  "Get a buffer for FILE.
FILE is a generalized file location, as handled by
`org-capture-expand-file'."
Rasmus's avatar
Rasmus committed
1094
  (let ((file (org-capture-expand-file file)))
Rasmus's avatar
Rasmus committed
1095 1096 1097
    (or (org-find-base-buffer-visiting file)
	(progn (org-capture-put :new-buffer t)
	       (find-file-noselect file)))))
1098

Bastien Guerry's avatar
Bastien Guerry committed
1099 1100 1101 1102 1103 1104
(defun org-capture-place-template (&optional inhibit-wconf-store)
  "Insert the template at the target location, and display the buffer.
When `inhibit-wconf-store', don't store the window configuration, as it
may have been stored before."
  (unless inhibit-wconf-store
    (org-capture-put :return-to-wconf (current-window-configuration)))
1105 1106 1107
  (delete-other-windows)
  (org-switch-to-buffer-other-window
   (org-capture-get-indirect-buffer (org-capture-get :buffer) "CAPTURE"))
1108
  (widen)
Bastien's avatar
Bastien committed
1109
  (org-show-all)
1110
  (goto-char (org-capture-get :pos))
Rasmus's avatar
Rasmus committed
1111 1112 1113 1114 1115 1116 1117
  (setq-local outline-level 'org-outline-level)
  (pcase (org-capture-get :type)
    ((or `nil `entry) (org-capture-place-entry))
    (`table-line (org-capture-place-table-line))
    (`plain (org-capture-place-plain-text))
    (`item (org-capture-place-item))
    (`checkitem (org-capture-place-item)))
1118
  (org-capture-mode 1)
Rasmus's avatar
Rasmus committed
1119
  (setq-local org-capture-current-plist org-capture-plist))
1120 1121 1122

(defun org-capture-place-entry ()
  "Place the template as a new Org entry."
Bastien's avatar
Bastien committed
1123 1124 1125 1126
  (let ((template (org-capture-get :template))
	(reversed? (org-capture-get :prepend))
	(exact-position (org-capture-get :exact-position))
	(insert-here? (org-capture-get :insert-here))
Rasmus's avatar
Rasmus committed
1127
	(level 1))
Bastien's avatar
Bastien committed
1128 1129
    (org-capture-verify-tree template)
    (when exact-position (goto-char exact-position))
Rasmus's avatar
Rasmus committed
1130
    (cond
Bastien's avatar
Bastien committed
1131 1132
     ;; Force insertion at point.
     ((org-capture-get :insert-here) nil)
Rasmus's avatar
Rasmus committed
1133 1134 1135 1136 1137
     ;; Insert as a child of the current entry.
     ((org-capture-get :target-entry-p)
      (setq level (org-get-valid-level
		   (if (org-at-heading-p) (org-outline-level) 1)
		   1))
Rasmus's avatar
Rasmus committed
1138
      (if reversed? (outline-next-heading) (org-end-of-subtree t t)))
Rasmus's avatar
Rasmus committed
1139 1140 1141 1142 1143 1144
     ;; Insert as a top-level entry at the beginning of the file.
     (reversed?
      (goto-char (point-min))
      (unless (org-at-heading-p) (outline-next-heading)))
     ;; Otherwise, insert as a top-level entry at the end of the file.
     (t (goto-char (point-max))))
Bastien's avatar
Bastien committed
1145 1146 1147 1148 1149 1150 1151 1152 1153 1154 1155 1156 1157 1158 1159 1160
    (let ((origin (point)))
      (unless (bolp) (insert "\n"))
      (org-capture-empty-lines-before)
      (let ((beg (point)))
	(save-restriction
	  (when insert-here? (narrow-to-region beg beg))
	  (org-paste-subtree level template 'for-yank))
	(org-capture-position-for-last-stored beg)
	(let ((end (if (org-at-heading-p) (line-end-position 0) (point))))
	  (org-capture-empty-lines-after)
	  (unless (org-at-heading-p) (outline-next-heading))
	  (org-capture-mark-kill-region origin (point))
	  (org-capture-narrow beg end)
	  (when (or (search-backward "%?" beg t)
		    (search-forward "%?" end t))
	    (replace-match "")))))))
1161 1162 1163

(defun org-capture-place-item ()
  "Place the template as a new plain list item."
Bastien's avatar
Bastien committed
1164 1165 1166 1167 1168 1169 1170 1171 1172 1173 1174 1175 1176 1177 1178 1179 1180 1181 1182 1183 1184 1185 1186 1187 1188 1189 1190 1191 1192 1193 1194 1195 1196 1197 1198 1199 1200 1201 1202 1203 1204 1205 1206 1207 1208 1209 1210 1211 1212 1213 1214 1215 1216 1217 1218 1219 1220 1221 1222 1223 1224 1225 1226 1227 1228 1229 1230 1231 1232 1233 1234 1235 1236 1237 1238 1239 1240 1241 1242 1243 1244 1245 1246 1247 1248 1249 1250 1251 1252 1253 1254 1255 1256 1257 1258 1259 1260 1261 1262 1263 1264 1265 1266 1267 1268 1269 1270 1271 1272 1273 1274
  (let ((prepend? (org-capture-get :prepend))
	(template (org-remove-indentation (org-capture-get :template)))
	item)
    ;; Make template suitable for insertion.  In particular, add
    ;; a main bullet if it is missing.
    (unless (string-match-p (concat "\\`" (org-item-re)) template)
      (setq template (concat "- " (mapconcat #'identity
					     (split-string template "\n")
					     "\n  "))))
    ;; Delimit the area where we should look for a plain list.
    (pcase-let ((`(,beg . ,end)
		 (cond ((org-capture-get :exact-position)
			;; User gave a specific position.  Start
			;; looking for lists from here.
			(org-with-point-at (org-capture-get :exact-position)
			  (cons (line-beginning-position)
				(if (org-capture-get :insert-here)
				    (line-beginning-position)
				  (org-entry-end-position)))))
		       ((org-capture-get :target-entry-p)
			;; At a heading, limit search to its body.
			(cons (line-beginning-position 2)
			      (org-entry-end-position)))
		       (t
			;; Table is not necessarily under a heading.
			;; Search whole buffer.
			(cons (point-min) (point-max))))))
      ;; Find the first plain list in the delimited area.
      (goto-char beg)
      (let ((item-regexp (org-item-beginning-re)))
	(catch :found
	  (while (re-search-forward item-regexp end t)
	    (when (setq item (org-element-lineage
			      (org-element-at-point) '(plain-list) t))
	      (goto-char (org-element-property (if prepend? :post-affiliated
						 :contents-end)
					       item))
	      (throw :found t)))
	  ;; No list found.  Move to the location when to insert
	  ;; template.  Skip planning info and properties drawers, if
	  ;; any.
	  (goto-char (cond ((org-capture-get :insert-here) beg)
			   ((not prepend?) end)
			   ((org-before-first-heading-p) beg)
			   (t (max (save-excursion
				     (org-end-of-meta-data)
				     (point))
				   beg)))))))
    ;; Insert template.
    (let ((origin (point)))
      (unless (bolp) (insert "\n"))
      ;; When a new list is created, always obey to `:empty-lines' and
      ;; friends.
      ;;
      ;; When capturing in an existing list, do not change blank lines
      ;; above or below the list; consider it to be a stable
      ;; structure.  However, we can control how many blank lines
      ;; separate items.  So obey to `:empty-lines' between items as
      ;; long as it does not insert more than one empty line.  In the
      ;; specific case of empty lines above, it means we only obey the
      ;; parameter when appending an item.
      (unless (and item prepend?)
	(org-capture-empty-lines-before
	 (and item
	      (not prepend?)
	      (min 1 (or (org-capture-get :empty-lines-before)
			 (org-capture-get :empty-lines)
			 0)))))
      (org-capture-position-for-last-stored (point))
      (let ((beg (line-beginning-position))
	    (end (progn
		   (insert (org-trim template) "\n")
		   (point-marker))))
	(when item
	  (let ((i (save-excursion
		     (goto-char (org-element-property :post-affiliated item))
		     (current-indentation))))
	    (save-excursion
	      (goto-char beg)
	      (save-excursion
		(while (< (point) end)
		  (indent-to i)
		  (forward-line)))
	      ;; Pre-pending an item could change the type of the list
	      ;; if there is a mismatch.  In this situation,
	      ;; prioritize the existing list.
	      (when prepend?
		(let ((ordered? (eq 'ordered (org-element-property :type item))))
		  (when (org-xor ordered?
				 (string-match-p "\\`[A-Za-z0-9]\\([.)]\\)"
						 template))
		    (org-cycle-list-bullet (if ordered? "1." "-")))))
	      ;; Eventually repair the list for proper indentation and
	      ;; bullets.
	      (org-list-repair))))
	;; Limit number of empty lines.  See above for details.
	(unless (and item (not prepend?))
	  (org-capture-empty-lines-after
	   (and item
		prepend?
		(min 1 (or (org-capture-get :empty-lines-after)
			   (org-capture-get :empty-lines)
			   0)))))
	(org-capture-mark-kill-region origin (point))
	;; ITEM always end with a newline character.  Make sure we do
	;; not narrow at the beginning of the next line, possibly
	;; altering its structure (e.g., when it is a headline).
	(org-capture-narrow beg (1- end))
	(when (or (search-backward "%?" beg t)
		  (search-forward "%?" end t))
	  (replace-match ""))))))
1275 1276 1277 1278

(defun org-capture-place-table-line ()
  "Place the template as a table line."
  (require 'org-table)
Bastien's avatar
Bastien committed
1279 1280 1281 1282 1283 1284 1285
  (let ((text
	 (pcase (org-trim (org-capture-get :template))
	   ((pred (string-match-p org-table-border-regexp))
	    "| %?Bad template |")
	   (text (concat text "\n"))))
	(table-line-pos (org-capture-get :table-line-pos))
	beg end)
1286 1287
    (cond
     ((org-capture-get :exact-position)
Bastien's avatar
Bastien committed
1288 1289 1290 1291 1292 1293 1294
      (org-with-point-at (org-capture-get :exact-position)
	(setq beg (line-beginning-position))
	(setq end (if (org-capture-get :insert-here) beg
		    (org-entry-end-position)))))
     ((not (org-capture-get :target-entry-p))
      ;; Table is not necessarily under a heading.  Find first table
      ;; in the buffer.
1295 1296
      (setq beg (point-min) end (point-max)))
     (t
Bastien's avatar
Bastien committed
1297 1298 1299 1300 1301 1302 1303 1304 1305 1306 1307 1308 1309 1310 1311 1312 1313
      ;; We are at a heading, limit search to the body.
      (setq beg (line-beginning-position 2))
      (setq end (save-excursion (outline-next-heading) (point)))))
    (goto-char beg)
    ;; Narrow to the table, possibly creating one if necessary.
    (catch :found
      (while (re-search-forward org-table-dataline-regexp end t)
	(pcase (org-element-lineage (org-element-at-point) '(table) t)
	  (`nil nil)
	  ((pred (lambda (e) (eq 'table.el (org-element-property :type e))))
	   nil)
	  (table
	   (goto-char (org-element-property :contents-end table))
	   (narrow-to-region (org-element-property :post-affiliated table)
			     (point))
	   (throw :found t))))
      ;; No table found.  Create it with an empty header.
1314
      (goto-char end)
Bastien's avatar
Bastien committed
1315 1316 1317 1318 1319
      (unless (bolp) (insert "\n"))
      (let ((origin (point)))
	(insert "|   |\n|---|\n")
	(narrow-to-region origin (point))))
    ;; In the current table, find the appropriate location for TEXT.
1320
    (cond
Bastien's avatar
Bastien committed
1321
     ((org-capture-get :insert-here) nil)
1322
     ((and table-line-pos
Bastien's avatar
Bastien committed
1323
	   (string-match "\\(I+\\)\\([-+][0-9]+\\)" table-line-pos))
1324
      (goto-char (point-min))
Bastien's avatar
Bastien committed
1325 1326 1327 1328 1329 1330 1331 1332
      (let ((line
	     (condition-case _
		 (progn
		   (save-match-data (org-table-analyze))
		   (aref org-table-hlines
			 (- (match-end 1) (match-beginning 1))))
	       (error
		(error "Invalid table line specification %S" table-line-pos))))
Rasmus's avatar
Rasmus committed
1333
	    (delta (string-to-number (match-string 2 table-line-pos))))
Bastien's avatar
Bastien committed
1334 1335
	(forward-line (+ line delta (if (< delta 0) 0 -1)))
	(forward-line)))		;insert below
1336 1337
     ((org-capture-get :prepend)
      (goto-char (point-min))
Bastien's avatar
Bastien committed
1338 1339 1340 1341
      (cond
       ((not (re-search-forward org-table-hline-regexp nil t)))
       ((re-search-forward org-table-dataline-regexp nil t) (beginning-of-line))
       (t (goto-char (org-table-end)))))
1342
     (t
Bastien's avatar
Bastien committed
1343 1344 1345 1346 1347 1348 1349 1350 1351 1352 1353 1354 1355 1356 1357 1358
      (goto-char (org-table-end))))
    ;; Insert text and position point according to template.
    (let ((origin (point)))
      (unless (bolp) (insert "\n"))
      (let ((beg (point))
	    (end (save-excursion
		   (insert text)
		   (point))))
	(org-capture-position-for-last-stored 'table-line)
	(org-capture-mark-kill-region origin end)
	;; TEXT is guaranteed to end with a newline character.  Ignore
	;; it when narrowing so as to not alter data on the next line.
	(org-capture-narrow beg (1- end))
	(when (or (search-backward "%?" beg t)
		  (search-forward "%?" end t))
	  (replace-match ""))))))
1359 1360

(defun org-capture-place-plain-text ()
1361 1362 1363 1364 1365
  "Place the template plainly.
If the target locator points at an Org node, place the template into
the text of the entry, before the first child.  If not, place the
template at the beginning or end of the file.
Of course, if exact position has been required, just put it there."
Bastien's avatar
Bastien committed
1366 1367 1368 1369 1370 1371 1372 1373 1374 1375 1376 1377 1378 1379 1380
  (cond
   ((org-capture-get :exact-position)
    (goto-char (org-capture-get :exact-position)))
   ((org-capture-get :target-entry-p)
    ;; Place the text into this entry.
    (if (org-capture-get :prepend)
	;; Skip meta data and drawers.
	(org-end-of-meta-data t)
      ;; Go to end of the entry text, before the next headline.
      (outline-next-heading)))
   (t
    ;; Beginning or end of file.
    (goto-char (if (org-capture-get :prepend) (point-min) (point-max)))))
  (let ((origin (point)))
    (unless (bolp) (insert "\n"))
1381
    (org-capture-empty-lines-before)
Bastien's avatar
Bastien committed
1382 1383 1384 1385 1386 1387 1388 1389 1390 1391 1392 1393 1394 1395
    (org-capture-position-for-last-stored (point))
    (let ((beg (point)))
      (insert (org-capture-get :template))
      (unless (bolp) (insert "\n"))
      ;; Ignore the final newline character so as to not alter data
      ;; after inserted text.  Yet, if the template is empty, make
      ;; sure END matches BEG instead of pointing before it.
      (let ((end (max beg (1- (point)))))
	(org-capture-empty-lines-after)
	(org-capture-mark-kill-region origin (point))
	(org-capture-narrow beg end)
	(when (or (search-backward "%?" beg t)
		  (search-forward "%?" end t))
	  (replace-match ""))))))
1396 1397 1398

(defun org-capture-mark-kill-region (beg end)
  "Mark the region that will have to be killed when aborting capture."
Rasmus's avatar
Rasmus committed
1399 1400
  (let ((m1 (copy-marker beg))
	(m2 (copy-marker end t)))
1401 1402 1403 1404 1405 1406 1407 1408 1409 1410 1411 1412 1413 1414 1415 1416 1417
    (org-capture-put :begin-marker m1)
    (org-capture-put :end-marker m2)))

(defun org-capture-position-for-last-stored (where)
  "Memorize the position that should later become the position of last capture."
  (cond
   ((integerp where)
    (org-capture-put :position-for-last-stored
		     (move-marker (make-marker) where
				  (or (buffer-base-buffer (current-buffer))
				      (current-buffer)))))
   ((eq where 'table-line)
    (org-capture-put :position-for-last-stored
		     (list 'table-line
			   (org-table-current-dline))))
   (t (error "This should not happen"))))

Rasmus's avatar
Rasmus committed
1418 1419
(defun org-capture-store-last-position ()
  "Store the last-captured position."
1420 1421 1422 1423 1424 1425 1426 1427 1428 1429 1430 1431
  (let* ((where (org-capture-get :position-for-last-stored 'local))
	 (pos (cond
	       ((markerp where)
		(prog1 (marker-position where)
		  (move-marker where nil)))
	       ((and (listp where) (eq (car where) 'table-line))
		(if (org-at-table-p)
		    (save-excursion
		      (org-table-goto-line (nth 1 where))
		      (point-at-bol))
		  (point))))))
    (with-current-buffer (buffer-base-buffer (current-buffer))
Rasmus's avatar
Rasmus committed
1432 1433 1434 1435 1436
      (org-with-point-at pos
	(when org-capture-bookmark
	  (let ((bookmark (plist-get org-bookmark-names-plist :last-capture)))
	    (when bookmark (with-demoted-errors (bookmark-set bookmark)))))
	(move-marker org-capture-last-stored-marker (point))))))
1437 1438 1439 1440 1441 1442 1443 1444

(defun org-capture-narrow (beg end)
  "Narrow, unless configuration says not to narrow."
  (unless (org-capture-get :unnarrowed)
    (narrow-to-region beg end)
    (goto-char beg)))

(defun org-capture-empty-lines-before (&optional n)
Bastien Guerry's avatar
Bastien Guerry committed
1445
  "Set the correct number of empty lines before the insertion point.
1446
Point will be after the empty lines, so insertion can directly be done."
1447 1448
  (setq n (or n (org-capture-get :empty-lines-before)
	      (org-capture-get :empty-lines) 0))
1449 1450 1451
  (let ((pos (point)))
    (org-back-over-empty-lines)
    (delete-region (point) pos)
Bastien's avatar
Bastien committed
1452
    (when (> n 0) (newline n))))
1453 1454

(defun org-capture-empty-lines-after (&optional n)
Bastien Guerry's avatar
Bastien Guerry committed
1455
  "Set the correct number of empty lines after the inserted string.
1456
Point will remain at the first line after the inserted text."
1457 1458
  (setq n (or n (org-capture-get :empty-lines-after)
	      (org-capture-get :empty-lines) 0))
1459 1460 1461
  (org-back-over-empty-lines)
  (while (looking-at "[ \t]*\n") (replace-match ""))
  (let ((pos (point)))
Bastien's avatar
Bastien committed
1462
    (when (> n 0) (newline n))
1463 1464 1465
    (goto-char pos)))

(defvar org-clock-marker) ; Defined in org.el
1466

1467 1468 1469 1470 1471 1472 1473 1474 1475 1476 1477 1478 1479 1480 1481 1482 1483 1484 1485 1486
(defun org-capture-set-plist (entry)
  "Initialize the property list from the template definition."
  (setq org-capture-plist (copy-sequence (nthcdr 5 entry)))
  (org-capture-put :key (car entry) :description (nth 1 entry)
		   :target (nth 3 entry))
  (let ((txt (nth 4 entry)) (type (or (nth 2 entry) 'entry)))
    (when (or (not txt) (and (stringp txt) (not (string-match "\\S-" txt))))
      ;; The template may be empty or omitted for special types.
      ;; Here we insert the default templates for such cases.
      (cond
       ((eq type 'item) (setq txt "- %?"))
       ((eq type 'checkitem) (setq txt "- [ ] %?"))
       ((eq type 'table-line) (setq txt "| %? |"))
       ((member type '(nil entry)) (setq txt "* %?\n  %a"))))
    (org-capture-put :template txt :type type)))

(defun org-capture-goto-target (&optional template-key)
  "Go to the target location of a capture template.
The user is queried for the template."
  (interactive)
Rasmus's avatar
Rasmus committed
1487 1488
  (let ((entry (org-capture-select-template template-key)))
    (unless entry (error "No capture template selected"))
1489 1490
    (org-capture-set-plist entry)
    (org-capture-set-target-location)
Rasmus's avatar
Rasmus committed
1491
    (pop-to-buffer-same-window (org-capture-get :buffer))
1492 1493 1494 1495 1496 1497 1498 1499 1500
    (goto-char (org-capture-get :pos))))

(defun org-capture-get-indirect-buffer (&optional buffer prefix)
  "Make an indirect buffer for a capture process.
Use PREFIX as a prefix for the name of the indirect buffer."
  (setq buffer (or buffer (current-buffer)))
  (let ((n 1) (base (buffer-name buffer)) bname)
    (setq bname (concat prefix "-" base))
    (while (buffer-live-p (get-buffer bname))
Rasmus's avatar
Rasmus committed
1501
      (setq bname (concat prefix "-" (number-to-string (cl-incf n)) "-" base)))
1502 1503
    (condition-case nil
        (make-indirect-buffer buffer bname 'clone)
Bastien Guerry's avatar
Bastien Guerry committed
1504 1505 1506 1507
      (error
       (let ((buf (make-indirect-buffer buffer bname)))
	 (with-current-buffer buf (org-mode))
	 buf)))))
1508

1509
(defun org-capture-verify-tree (tree)
1510
  "Throw error if TREE is not a valid tree."
1511 1512 1513
  (unless (org-kill-is-subtree-p tree)
    (error "Template is not a valid Org entry or tree")))

Bastien Guerry's avatar
Bastien Guerry committed
1514
;;; The template code
1515 1516 1517
(defun org-capture-select-template (&optional keys)
  "Select a capture template.
Lisp programs can force the template by setting KEYS to a string."
1518
  (let ((org-capture-templates
Bastien Guerry's avatar